MonitorV1

Manages a V1 load balancer monitor resource within OpenStack.

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
    public MyStack()
    {
        var monitor1 = new OpenStack.LoadBalancer.MonitorV1("monitor1", new OpenStack.LoadBalancer.MonitorV1Args
        {
            AdminStateUp = "true",
            Delay = 30,
            MaxRetries = 3,
            Timeout = 5,
            Type = "PING",
        });
    }

}

Coming soon!

import pulumi
import pulumi_openstack as openstack

monitor1 = openstack.loadbalancer.MonitorV1("monitor1",
    admin_state_up="true",
    delay=30,
    max_retries=3,
    timeout=5,
    type="PING")

import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const monitor1 = new openstack.loadbalancer.MonitorV1("monitor_1", {
    adminStateUp: "true",
    delay: 30,
    maxRetries: 3,
    timeout: 5,
    type: "PING",
});

Create a MonitorV1 Resource

new MonitorV1(name: string, args: MonitorV1Args, opts?: CustomResourceOptions);

def MonitorV1(resource_name, opts=None, admin_state_up=None, delay=None, expected_codes=None, http_method=None, max_retries=None, region=None, tenant_id=None, timeout=None, type=None, url_path=None, __props__=None);

func NewMonitorV1(ctx *Context, name string, args MonitorV1Args, opts ...ResourceOption) (*MonitorV1, error)

public MonitorV1(string name, MonitorV1Args args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args MonitorV1Args: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args MonitorV1Args: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args MonitorV1Args: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

MonitorV1 Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The MonitorV1 resource accepts the following input properties:

Delay int: The time, in seconds, between sending probes to members. Changing this creates a new monitor.
MaxRetries int: Number of permissible ping failures before changing the member’s status to INACTIVE. Must be a number between 1 and 10. Changing this updates the max_retries of the existing monitor.
Timeout int: Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value. Changing this updates the timeout of the existing monitor.
Type string: The type of probe, which is PING, TCP, HTTP, or HTTPS, that is sent by the monitor to verify the member state. Changing this creates a new monitor.
AdminStateUp string: The administrative state of the monitor. Acceptable values are “true” and “false”. Changing this value updates the state of the existing monitor.
ExpectedCodes string: Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S) monitor. You can either specify a single status like “200”, or a range like “200-202”. Changing this updates the expected_codes of the existing monitor.
HttpMethod string: Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to “GET”. Changing this updates the http_method of the existing monitor.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB monitor. If omitted, the region argument of the provider is used. Changing this creates a new LB monitor.
TenantId string: The owner of the monitor. Required if admin wants to create a monitor for another tenant. Changing this creates a new monitor.
UrlPath string: Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS. Changing this updates the url_path of the existing monitor.

Delay int: The time, in seconds, between sending probes to members. Changing this creates a new monitor.
MaxRetries int: Number of permissible ping failures before changing the member’s status to INACTIVE. Must be a number between 1 and 10. Changing this updates the max_retries of the existing monitor.
Timeout int: Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value. Changing this updates the timeout of the existing monitor.
Type string: The type of probe, which is PING, TCP, HTTP, or HTTPS, that is sent by the monitor to verify the member state. Changing this creates a new monitor.
AdminStateUp string: The administrative state of the monitor. Acceptable values are “true” and “false”. Changing this value updates the state of the existing monitor.
ExpectedCodes string: Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S) monitor. You can either specify a single status like “200”, or a range like “200-202”. Changing this updates the expected_codes of the existing monitor.
HttpMethod string: Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to “GET”. Changing this updates the http_method of the existing monitor.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB monitor. If omitted, the region argument of the provider is used. Changing this creates a new LB monitor.
TenantId string: The owner of the monitor. Required if admin wants to create a monitor for another tenant. Changing this creates a new monitor.
UrlPath string: Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS. Changing this updates the url_path of the existing monitor.

delay number: The time, in seconds, between sending probes to members. Changing this creates a new monitor.
maxRetries number: Number of permissible ping failures before changing the member’s status to INACTIVE. Must be a number between 1 and 10. Changing this updates the max_retries of the existing monitor.
timeout number: Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value. Changing this updates the timeout of the existing monitor.
type string: The type of probe, which is PING, TCP, HTTP, or HTTPS, that is sent by the monitor to verify the member state. Changing this creates a new monitor.
adminStateUp string: The administrative state of the monitor. Acceptable values are “true” and “false”. Changing this value updates the state of the existing monitor.
expectedCodes string: Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S) monitor. You can either specify a single status like “200”, or a range like “200-202”. Changing this updates the expected_codes of the existing monitor.
httpMethod string: Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to “GET”. Changing this updates the http_method of the existing monitor.
region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB monitor. If omitted, the region argument of the provider is used. Changing this creates a new LB monitor.
tenantId string: The owner of the monitor. Required if admin wants to create a monitor for another tenant. Changing this creates a new monitor.
urlPath string: Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS. Changing this updates the url_path of the existing monitor.

delay float: The time, in seconds, between sending probes to members. Changing this creates a new monitor.
max_retries float: Number of permissible ping failures before changing the member’s status to INACTIVE. Must be a number between 1 and 10. Changing this updates the max_retries of the existing monitor.
timeout float: Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value. Changing this updates the timeout of the existing monitor.
type str: The type of probe, which is PING, TCP, HTTP, or HTTPS, that is sent by the monitor to verify the member state. Changing this creates a new monitor.
admin_state_up str: The administrative state of the monitor. Acceptable values are “true” and “false”. Changing this value updates the state of the existing monitor.
expected_codes str: Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S) monitor. You can either specify a single status like “200”, or a range like “200-202”. Changing this updates the expected_codes of the existing monitor.
http_method str: Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to “GET”. Changing this updates the http_method of the existing monitor.
region str: The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB monitor. If omitted, the region argument of the provider is used. Changing this creates a new LB monitor.
tenant_id str: The owner of the monitor. Required if admin wants to create a monitor for another tenant. Changing this creates a new monitor.
url_path str: Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS. Changing this updates the url_path of the existing monitor.

Outputs

All input properties are implicitly available as output properties. Additionally, the MonitorV1 resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing MonitorV1 Resource

Get an existing MonitorV1 resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: MonitorV1State, opts?: CustomResourceOptions): MonitorV1

static get(resource_name, id, opts=None, admin_state_up=None, delay=None, expected_codes=None, http_method=None, max_retries=None, region=None, tenant_id=None, timeout=None, type=None, url_path=None, __props__=None);

func GetMonitorV1(ctx *Context, name string, id IDInput, state *MonitorV1State, opts ...ResourceOption) (*MonitorV1, error)

public static MonitorV1 Get(string name, Input<string> id, MonitorV1State? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AdminStateUp string: The administrative state of the monitor. Acceptable values are “true” and “false”. Changing this value updates the state of the existing monitor.
Delay int: The time, in seconds, between sending probes to members. Changing this creates a new monitor.
ExpectedCodes string: Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S) monitor. You can either specify a single status like “200”, or a range like “200-202”. Changing this updates the expected_codes of the existing monitor.
HttpMethod string: Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to “GET”. Changing this updates the http_method of the existing monitor.
MaxRetries int: Number of permissible ping failures before changing the member’s status to INACTIVE. Must be a number between 1 and 10. Changing this updates the max_retries of the existing monitor.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB monitor. If omitted, the region argument of the provider is used. Changing this creates a new LB monitor.
TenantId string: The owner of the monitor. Required if admin wants to create a monitor for another tenant. Changing this creates a new monitor.
Timeout int: Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value. Changing this updates the timeout of the existing monitor.
Type string: The type of probe, which is PING, TCP, HTTP, or HTTPS, that is sent by the monitor to verify the member state. Changing this creates a new monitor.
UrlPath string: Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS. Changing this updates the url_path of the existing monitor.

AdminStateUp string: The administrative state of the monitor. Acceptable values are “true” and “false”. Changing this value updates the state of the existing monitor.
Delay int: The time, in seconds, between sending probes to members. Changing this creates a new monitor.
ExpectedCodes string: Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S) monitor. You can either specify a single status like “200”, or a range like “200-202”. Changing this updates the expected_codes of the existing monitor.
HttpMethod string: Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to “GET”. Changing this updates the http_method of the existing monitor.
MaxRetries int: Number of permissible ping failures before changing the member’s status to INACTIVE. Must be a number between 1 and 10. Changing this updates the max_retries of the existing monitor.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB monitor. If omitted, the region argument of the provider is used. Changing this creates a new LB monitor.
TenantId string: The owner of the monitor. Required if admin wants to create a monitor for another tenant. Changing this creates a new monitor.
Timeout int: Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value. Changing this updates the timeout of the existing monitor.
Type string: The type of probe, which is PING, TCP, HTTP, or HTTPS, that is sent by the monitor to verify the member state. Changing this creates a new monitor.
UrlPath string: Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS. Changing this updates the url_path of the existing monitor.

adminStateUp string: The administrative state of the monitor. Acceptable values are “true” and “false”. Changing this value updates the state of the existing monitor.
delay number: The time, in seconds, between sending probes to members. Changing this creates a new monitor.
expectedCodes string: Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S) monitor. You can either specify a single status like “200”, or a range like “200-202”. Changing this updates the expected_codes of the existing monitor.
httpMethod string: Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to “GET”. Changing this updates the http_method of the existing monitor.
maxRetries number: Number of permissible ping failures before changing the member’s status to INACTIVE. Must be a number between 1 and 10. Changing this updates the max_retries of the existing monitor.
region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB monitor. If omitted, the region argument of the provider is used. Changing this creates a new LB monitor.
tenantId string: The owner of the monitor. Required if admin wants to create a monitor for another tenant. Changing this creates a new monitor.
timeout number: Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value. Changing this updates the timeout of the existing monitor.
type string: The type of probe, which is PING, TCP, HTTP, or HTTPS, that is sent by the monitor to verify the member state. Changing this creates a new monitor.
urlPath string: Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS. Changing this updates the url_path of the existing monitor.

admin_state_up str: The administrative state of the monitor. Acceptable values are “true” and “false”. Changing this value updates the state of the existing monitor.
delay float: The time, in seconds, between sending probes to members. Changing this creates a new monitor.
expected_codes str: Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S) monitor. You can either specify a single status like “200”, or a range like “200-202”. Changing this updates the expected_codes of the existing monitor.
http_method str: Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to “GET”. Changing this updates the http_method of the existing monitor.
max_retries float: Number of permissible ping failures before changing the member’s status to INACTIVE. Must be a number between 1 and 10. Changing this updates the max_retries of the existing monitor.
region str: The region in which to obtain the V2 Networking client. A Networking client is needed to create an LB monitor. If omitted, the region argument of the provider is used. Changing this creates a new LB monitor.
tenant_id str: The owner of the monitor. Required if admin wants to create a monitor for another tenant. Changing this creates a new monitor.
timeout float: Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value. Changing this updates the timeout of the existing monitor.
type str: The type of probe, which is PING, TCP, HTTP, or HTTPS, that is sent by the monitor to verify the member state. Changing this creates a new monitor.
url_path str: Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS. Changing this updates the url_path of the existing monitor.

Package Details

Repository: https://github.com/pulumi/pulumi-openstack
License: Apache-2.0
Notes: This Pulumi package is based on the openstack Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud