Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Openstack Provider
  3. API Docs
  4. loadbalancer
  5. Monitor
OpenStack v5.0.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-openstack

openstack.loadbalancer.Monitor

Explore with Pulumi AI

openstack logo
OpenStack v5.0.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-openstack

    Manages a V2 monitor resource within OpenStack.

    Example Usage

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

const monitor1 = new openstack.loadbalancer.Monitor("monitor_1", {
    poolId: pool1.id,
    type: "PING",
    delay: 20,
    timeout: 10,
    maxRetries: 5,
});

    import pulumi
import pulumi_openstack as openstack

monitor1 = openstack.loadbalancer.Monitor("monitor_1",
    pool_id=pool1["id"],
    type="PING",
    delay=20,
    timeout=10,
    max_retries=5)

    package main

import (
	"github.com/pulumi/pulumi-openstack/sdk/v5/go/openstack/loadbalancer"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := loadbalancer.NewMonitor(ctx, "monitor_1", &loadbalancer.MonitorArgs{
			PoolId:     pulumi.Any(pool1.Id),
			Type:       pulumi.String("PING"),
			Delay:      pulumi.Int(20),
			Timeout:    pulumi.Int(10),
			MaxRetries: pulumi.Int(5),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using OpenStack = Pulumi.OpenStack;

return await Deployment.RunAsync(() => 
{
    var monitor1 = new OpenStack.LoadBalancer.Monitor("monitor_1", new()
    {
        PoolId = pool1.Id,
        Type = "PING",
        Delay = 20,
        Timeout = 10,
        MaxRetries = 5,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openstack.loadbalancer.Monitor;
import com.pulumi.openstack.loadbalancer.MonitorArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var monitor1 = new Monitor("monitor1", MonitorArgs.builder()
            .poolId(pool1.id())
            .type("PING")
            .delay(20)
            .timeout(10)
            .maxRetries(5)
            .build());

    }
}

    resources:
  monitor1:
    type: openstack:loadbalancer:Monitor
    name: monitor_1
    properties:
      poolId: ${pool1.id}
      type: PING
      delay: 20
      timeout: 10
      maxRetries: 5

    Create Monitor Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Monitor(name: string, args: MonitorArgs, opts?: CustomResourceOptions);
    @overload
def Monitor(resource_name: str,
            args: MonitorArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Monitor(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            pool_id: Optional[str] = None,
            delay: Optional[int] = None,
            type: Optional[str] = None,
            timeout: Optional[int] = None,
            max_retries: Optional[int] = None,
            name: Optional[str] = None,
            http_version: Optional[str] = None,
            max_retries_down: Optional[int] = None,
            http_method: Optional[str] = None,
            admin_state_up: Optional[bool] = None,
            region: Optional[str] = None,
            tenant_id: Optional[str] = None,
            expected_codes: Optional[str] = None,
            domain_name: Optional[str] = None,
            url_path: Optional[str] = None)
    func NewMonitor(ctx *Context, name string, args MonitorArgs, opts ...ResourceOption) (*Monitor, error)
    public Monitor(string name, MonitorArgs args, CustomResourceOptions? opts = null)
    public Monitor(String name, MonitorArgs args)
public Monitor(String name, MonitorArgs args, CustomResourceOptions options)

    type: openstack:loadbalancer:Monitor
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args MonitorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args MonitorArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args MonitorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MonitorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MonitorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var monitorResource = new OpenStack.LoadBalancer.Monitor("monitorResource", new()
{
    PoolId = "string",
    Delay = 0,
    Type = "string",
    Timeout = 0,
    MaxRetries = 0,
    Name = "string",
    HttpVersion = "string",
    MaxRetriesDown = 0,
    HttpMethod = "string",
    AdminStateUp = false,
    Region = "string",
    TenantId = "string",
    ExpectedCodes = "string",
    DomainName = "string",
    UrlPath = "string",
});

    example, err := loadbalancer.NewMonitor(ctx, "monitorResource", &loadbalancer.MonitorArgs{
	PoolId:         pulumi.String("string"),
	Delay:          pulumi.Int(0),
	Type:           pulumi.String("string"),
	Timeout:        pulumi.Int(0),
	MaxRetries:     pulumi.Int(0),
	Name:           pulumi.String("string"),
	HttpVersion:    pulumi.String("string"),
	MaxRetriesDown: pulumi.Int(0),
	HttpMethod:     pulumi.String("string"),
	AdminStateUp:   pulumi.Bool(false),
	Region:         pulumi.String("string"),
	TenantId:       pulumi.String("string"),
	ExpectedCodes:  pulumi.String("string"),
	DomainName:     pulumi.String("string"),
	UrlPath:        pulumi.String("string"),
})

    var monitorResource = new Monitor("monitorResource", MonitorArgs.builder()
    .poolId("string")
    .delay(0)
    .type("string")
    .timeout(0)
    .maxRetries(0)
    .name("string")
    .httpVersion("string")
    .maxRetriesDown(0)
    .httpMethod("string")
    .adminStateUp(false)
    .region("string")
    .tenantId("string")
    .expectedCodes("string")
    .domainName("string")
    .urlPath("string")
    .build());

    monitor_resource = openstack.loadbalancer.Monitor("monitorResource",
    pool_id="string",
    delay=0,
    type="string",
    timeout=0,
    max_retries=0,
    name="string",
    http_version="string",
    max_retries_down=0,
    http_method="string",
    admin_state_up=False,
    region="string",
    tenant_id="string",
    expected_codes="string",
    domain_name="string",
    url_path="string")

    const monitorResource = new openstack.loadbalancer.Monitor("monitorResource", {
    poolId: "string",
    delay: 0,
    type: "string",
    timeout: 0,
    maxRetries: 0,
    name: "string",
    httpVersion: "string",
    maxRetriesDown: 0,
    httpMethod: "string",
    adminStateUp: false,
    region: "string",
    tenantId: "string",
    expectedCodes: "string",
    domainName: "string",
    urlPath: "string",
});

    type: openstack:loadbalancer:Monitor
properties:
    adminStateUp: false
    delay: 0
    domainName: string
    expectedCodes: string
    httpMethod: string
    httpVersion: string
    maxRetries: 0
    maxRetriesDown: 0
    name: string
    poolId: string
    region: string
    tenantId: string
    timeout: 0
    type: string
    urlPath: string

    Monitor Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Monitor resource accepts the following input properties:

    Delay int
    The time, in seconds, between sending probes to members.
    MaxRetries int
    Number of permissible ping failures before changing the member's status to INACTIVE. Must be a number between 1 and 10.
    PoolId string
    The id of the pool that this monitor will be assigned to.
    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.
    Type string
    The type of probe, which is PING, TCP, HTTP, HTTPS, TLS-HELLO, SCTP or UDP-CONNECT, that is sent by the loadbalancer to verify the member state. Changing this creates a new monitor.
    AdminStateUp bool
    The administrative state of the monitor. A valid value is true (UP) or false (DOWN).
    DomainName string
    The domain name to use in the HTTP host header health monitor requests. Supported in Octavia API version 2.10 or later.
    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", a list like "200, 202" or a range like "200-202". Default is "200".
    HttpMethod string
    Required for HTTP(S) types. The HTTP method that the health monitor uses for requests. One of CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, or TRACE. The default is GET.
    HttpVersion string
    Required for HTTP(S) types. The HTTP version that the health monitor uses for requests. One of 1.0 or 1.1is supported for HTTP(S) monitors. The default is1.0`. Supported in Octavia API version 2.10 or later.
    MaxRetriesDown int
    Number of permissible ping failures before changing the member's status to ERROR. Must be a number between 1 and 10. The default is 3. Changing this updates the max_retries_down of the existing monitor.
    Name string
    The Name of the Monitor.
    Region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a monitor. If omitted, the region argument of the provider is used. Changing this creates a new monitor.
    TenantId string
    Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. 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. Default is /.
    Delay int
    The time, in seconds, between sending probes to members.
    MaxRetries int
    Number of permissible ping failures before changing the member's status to INACTIVE. Must be a number between 1 and 10.
    PoolId string
    The id of the pool that this monitor will be assigned to.
    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.
    Type string
    The type of probe, which is PING, TCP, HTTP, HTTPS, TLS-HELLO, SCTP or UDP-CONNECT, that is sent by the loadbalancer to verify the member state. Changing this creates a new monitor.
    AdminStateUp bool
    The administrative state of the monitor. A valid value is true (UP) or false (DOWN).
    DomainName string
    The domain name to use in the HTTP host header health monitor requests. Supported in Octavia API version 2.10 or later.
    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", a list like "200, 202" or a range like "200-202". Default is "200".
    HttpMethod string
    Required for HTTP(S) types. The HTTP method that the health monitor uses for requests. One of CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, or TRACE. The default is GET.
    HttpVersion string
    Required for HTTP(S) types. The HTTP version that the health monitor uses for requests. One of 1.0 or 1.1is supported for HTTP(S) monitors. The default is1.0`. Supported in Octavia API version 2.10 or later.
    MaxRetriesDown int
    Number of permissible ping failures before changing the member's status to ERROR. Must be a number between 1 and 10. The default is 3. Changing this updates the max_retries_down of the existing monitor.
    Name string
    The Name of the Monitor.
    Region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a monitor. If omitted, the region argument of the provider is used. Changing this creates a new monitor.
    TenantId string
    Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. 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. Default is /.
    delay Integer
    The time, in seconds, between sending probes to members.
    maxRetries Integer
    Number of permissible ping failures before changing the member's status to INACTIVE. Must be a number between 1 and 10.
    poolId String
    The id of the pool that this monitor will be assigned to.
    timeout Integer
    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.
    type String
    The type of probe, which is PING, TCP, HTTP, HTTPS, TLS-HELLO, SCTP or UDP-CONNECT, that is sent by the loadbalancer to verify the member state. Changing this creates a new monitor.
    adminStateUp Boolean
    The administrative state of the monitor. A valid value is true (UP) or false (DOWN).
    domainName String
    The domain name to use in the HTTP host header health monitor requests. Supported in Octavia API version 2.10 or later.
    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", a list like "200, 202" or a range like "200-202". Default is "200".
    httpMethod String
    Required for HTTP(S) types. The HTTP method that the health monitor uses for requests. One of CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, or TRACE. The default is GET.
    httpVersion String
    Required for HTTP(S) types. The HTTP version that the health monitor uses for requests. One of 1.0 or 1.1is supported for HTTP(S) monitors. The default is1.0`. Supported in Octavia API version 2.10 or later.
    maxRetriesDown Integer
    Number of permissible ping failures before changing the member's status to ERROR. Must be a number between 1 and 10. The default is 3. Changing this updates the max_retries_down of the existing monitor.
    name String
    The Name of the Monitor.
    region String
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a monitor. If omitted, the region argument of the provider is used. Changing this creates a new monitor.
    tenantId String
    Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. 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. Default is /.
    delay number
    The time, in seconds, between sending probes to members.
    maxRetries number
    Number of permissible ping failures before changing the member's status to INACTIVE. Must be a number between 1 and 10.
    poolId string
    The id of the pool that this monitor will be assigned to.
    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.
    type string
    The type of probe, which is PING, TCP, HTTP, HTTPS, TLS-HELLO, SCTP or UDP-CONNECT, that is sent by the loadbalancer to verify the member state. Changing this creates a new monitor.
    adminStateUp boolean
    The administrative state of the monitor. A valid value is true (UP) or false (DOWN).
    domainName string
    The domain name to use in the HTTP host header health monitor requests. Supported in Octavia API version 2.10 or later.
    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", a list like "200, 202" or a range like "200-202". Default is "200".
    httpMethod string
    Required for HTTP(S) types. The HTTP method that the health monitor uses for requests. One of CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, or TRACE. The default is GET.
    httpVersion string
    Required for HTTP(S) types. The HTTP version that the health monitor uses for requests. One of 1.0 or 1.1is supported for HTTP(S) monitors. The default is1.0`. Supported in Octavia API version 2.10 or later.
    maxRetriesDown number
    Number of permissible ping failures before changing the member's status to ERROR. Must be a number between 1 and 10. The default is 3. Changing this updates the max_retries_down of the existing monitor.
    name string
    The Name of the Monitor.
    region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a monitor. If omitted, the region argument of the provider is used. Changing this creates a new monitor.
    tenantId string
    Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. 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. Default is /.
    delay int
    The time, in seconds, between sending probes to members.
    max_retries int
    Number of permissible ping failures before changing the member's status to INACTIVE. Must be a number between 1 and 10.
    pool_id str
    The id of the pool that this monitor will be assigned to.
    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.
    type str
    The type of probe, which is PING, TCP, HTTP, HTTPS, TLS-HELLO, SCTP or UDP-CONNECT, that is sent by the loadbalancer to verify the member state. Changing this creates a new monitor.
    admin_state_up bool
    The administrative state of the monitor. A valid value is true (UP) or false (DOWN).
    domain_name str
    The domain name to use in the HTTP host header health monitor requests. Supported in Octavia API version 2.10 or later.
    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", a list like "200, 202" or a range like "200-202". Default is "200".
    http_method str
    Required for HTTP(S) types. The HTTP method that the health monitor uses for requests. One of CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, or TRACE. The default is GET.
    http_version str
    Required for HTTP(S) types. The HTTP version that the health monitor uses for requests. One of 1.0 or 1.1is supported for HTTP(S) monitors. The default is1.0`. Supported in Octavia API version 2.10 or later.
    max_retries_down int
    Number of permissible ping failures before changing the member's status to ERROR. Must be a number between 1 and 10. The default is 3. Changing this updates the max_retries_down of the existing monitor.
    name str
    The Name of the Monitor.
    region str
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a monitor. If omitted, the region argument of the provider is used. Changing this creates a new monitor.
    tenant_id str
    Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. 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. Default is /.
    delay Number
    The time, in seconds, between sending probes to members.
    maxRetries Number
    Number of permissible ping failures before changing the member's status to INACTIVE. Must be a number between 1 and 10.
    poolId String
    The id of the pool that this monitor will be assigned to.
    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.
    type String
    The type of probe, which is PING, TCP, HTTP, HTTPS, TLS-HELLO, SCTP or UDP-CONNECT, that is sent by the loadbalancer to verify the member state. Changing this creates a new monitor.
    adminStateUp Boolean
    The administrative state of the monitor. A valid value is true (UP) or false (DOWN).
    domainName String
    The domain name to use in the HTTP host header health monitor requests. Supported in Octavia API version 2.10 or later.
    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", a list like "200, 202" or a range like "200-202". Default is "200".
    httpMethod String
    Required for HTTP(S) types. The HTTP method that the health monitor uses for requests. One of CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, or TRACE. The default is GET.
    httpVersion String
    Required for HTTP(S) types. The HTTP version that the health monitor uses for requests. One of 1.0 or 1.1is supported for HTTP(S) monitors. The default is1.0`. Supported in Octavia API version 2.10 or later.
    maxRetriesDown Number
    Number of permissible ping failures before changing the member's status to ERROR. Must be a number between 1 and 10. The default is 3. Changing this updates the max_retries_down of the existing monitor.
    name String
    The Name of the Monitor.
    region String
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a monitor. If omitted, the region argument of the provider is used. Changing this creates a new monitor.
    tenantId String
    Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. 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. Default is /.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Monitor 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 string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Monitor Resource

    Get an existing Monitor 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?: MonitorState, opts?: CustomResourceOptions): Monitor
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_state_up: Optional[bool] = None,
        delay: Optional[int] = None,
        domain_name: Optional[str] = None,
        expected_codes: Optional[str] = None,
        http_method: Optional[str] = None,
        http_version: Optional[str] = None,
        max_retries: Optional[int] = None,
        max_retries_down: Optional[int] = None,
        name: Optional[str] = None,
        pool_id: Optional[str] = None,
        region: Optional[str] = None,
        tenant_id: Optional[str] = None,
        timeout: Optional[int] = None,
        type: Optional[str] = None,
        url_path: Optional[str] = None) -> Monitor
    func GetMonitor(ctx *Context, name string, id IDInput, state *MonitorState, opts ...ResourceOption) (*Monitor, error)
    public static Monitor Get(string name, Input<string> id, MonitorState? state, CustomResourceOptions? opts = null)
    public static Monitor get(String name, Output<String> id, MonitorState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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 bool
    The administrative state of the monitor. A valid value is true (UP) or false (DOWN).
    Delay int
    The time, in seconds, between sending probes to members.
    DomainName string
    The domain name to use in the HTTP host header health monitor requests. Supported in Octavia API version 2.10 or later.
    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", a list like "200, 202" or a range like "200-202". Default is "200".
    HttpMethod string
    Required for HTTP(S) types. The HTTP method that the health monitor uses for requests. One of CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, or TRACE. The default is GET.
    HttpVersion string
    Required for HTTP(S) types. The HTTP version that the health monitor uses for requests. One of 1.0 or 1.1is supported for HTTP(S) monitors. The default is1.0`. Supported in Octavia API version 2.10 or later.
    MaxRetries int
    Number of permissible ping failures before changing the member's status to INACTIVE. Must be a number between 1 and 10.
    MaxRetriesDown int
    Number of permissible ping failures before changing the member's status to ERROR. Must be a number between 1 and 10. The default is 3. Changing this updates the max_retries_down of the existing monitor.
    Name string
    The Name of the Monitor.
    PoolId string
    The id of the pool that this monitor will be assigned to.
    Region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a monitor. If omitted, the region argument of the provider is used. Changing this creates a new monitor.
    TenantId string
    Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. 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.
    Type string
    The type of probe, which is PING, TCP, HTTP, HTTPS, TLS-HELLO, SCTP or UDP-CONNECT, that is sent by the loadbalancer 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. Default is /.
    AdminStateUp bool
    The administrative state of the monitor. A valid value is true (UP) or false (DOWN).
    Delay int
    The time, in seconds, between sending probes to members.
    DomainName string
    The domain name to use in the HTTP host header health monitor requests. Supported in Octavia API version 2.10 or later.
    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", a list like "200, 202" or a range like "200-202". Default is "200".
    HttpMethod string
    Required for HTTP(S) types. The HTTP method that the health monitor uses for requests. One of CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, or TRACE. The default is GET.
    HttpVersion string
    Required for HTTP(S) types. The HTTP version that the health monitor uses for requests. One of 1.0 or 1.1is supported for HTTP(S) monitors. The default is1.0`. Supported in Octavia API version 2.10 or later.
    MaxRetries int
    Number of permissible ping failures before changing the member's status to INACTIVE. Must be a number between 1 and 10.
    MaxRetriesDown int
    Number of permissible ping failures before changing the member's status to ERROR. Must be a number between 1 and 10. The default is 3. Changing this updates the max_retries_down of the existing monitor.
    Name string
    The Name of the Monitor.
    PoolId string
    The id of the pool that this monitor will be assigned to.
    Region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a monitor. If omitted, the region argument of the provider is used. Changing this creates a new monitor.
    TenantId string
    Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. 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.
    Type string
    The type of probe, which is PING, TCP, HTTP, HTTPS, TLS-HELLO, SCTP or UDP-CONNECT, that is sent by the loadbalancer 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. Default is /.
    adminStateUp Boolean
    The administrative state of the monitor. A valid value is true (UP) or false (DOWN).
    delay Integer
    The time, in seconds, between sending probes to members.
    domainName String
    The domain name to use in the HTTP host header health monitor requests. Supported in Octavia API version 2.10 or later.
    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", a list like "200, 202" or a range like "200-202". Default is "200".
    httpMethod String
    Required for HTTP(S) types. The HTTP method that the health monitor uses for requests. One of CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, or TRACE. The default is GET.
    httpVersion String
    Required for HTTP(S) types. The HTTP version that the health monitor uses for requests. One of 1.0 or 1.1is supported for HTTP(S) monitors. The default is1.0`. Supported in Octavia API version 2.10 or later.
    maxRetries Integer
    Number of permissible ping failures before changing the member's status to INACTIVE. Must be a number between 1 and 10.
    maxRetriesDown Integer
    Number of permissible ping failures before changing the member's status to ERROR. Must be a number between 1 and 10. The default is 3. Changing this updates the max_retries_down of the existing monitor.
    name String
    The Name of the Monitor.
    poolId String
    The id of the pool that this monitor will be assigned to.
    region String
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a monitor. If omitted, the region argument of the provider is used. Changing this creates a new monitor.
    tenantId String
    Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new monitor.
    timeout Integer
    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.
    type String
    The type of probe, which is PING, TCP, HTTP, HTTPS, TLS-HELLO, SCTP or UDP-CONNECT, that is sent by the loadbalancer 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. Default is /.
    adminStateUp boolean
    The administrative state of the monitor. A valid value is true (UP) or false (DOWN).
    delay number
    The time, in seconds, between sending probes to members.
    domainName string
    The domain name to use in the HTTP host header health monitor requests. Supported in Octavia API version 2.10 or later.
    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", a list like "200, 202" or a range like "200-202". Default is "200".
    httpMethod string
    Required for HTTP(S) types. The HTTP method that the health monitor uses for requests. One of CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, or TRACE. The default is GET.
    httpVersion string
    Required for HTTP(S) types. The HTTP version that the health monitor uses for requests. One of 1.0 or 1.1is supported for HTTP(S) monitors. The default is1.0`. Supported in Octavia API version 2.10 or later.
    maxRetries number
    Number of permissible ping failures before changing the member's status to INACTIVE. Must be a number between 1 and 10.
    maxRetriesDown number
    Number of permissible ping failures before changing the member's status to ERROR. Must be a number between 1 and 10. The default is 3. Changing this updates the max_retries_down of the existing monitor.
    name string
    The Name of the Monitor.
    poolId string
    The id of the pool that this monitor will be assigned to.
    region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a monitor. If omitted, the region argument of the provider is used. Changing this creates a new monitor.
    tenantId string
    Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. 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.
    type string
    The type of probe, which is PING, TCP, HTTP, HTTPS, TLS-HELLO, SCTP or UDP-CONNECT, that is sent by the loadbalancer 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. Default is /.
    admin_state_up bool
    The administrative state of the monitor. A valid value is true (UP) or false (DOWN).
    delay int
    The time, in seconds, between sending probes to members.
    domain_name str
    The domain name to use in the HTTP host header health monitor requests. Supported in Octavia API version 2.10 or later.
    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", a list like "200, 202" or a range like "200-202". Default is "200".
    http_method str
    Required for HTTP(S) types. The HTTP method that the health monitor uses for requests. One of CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, or TRACE. The default is GET.
    http_version str
    Required for HTTP(S) types. The HTTP version that the health monitor uses for requests. One of 1.0 or 1.1is supported for HTTP(S) monitors. The default is1.0`. Supported in Octavia API version 2.10 or later.
    max_retries int
    Number of permissible ping failures before changing the member's status to INACTIVE. Must be a number between 1 and 10.
    max_retries_down int
    Number of permissible ping failures before changing the member's status to ERROR. Must be a number between 1 and 10. The default is 3. Changing this updates the max_retries_down of the existing monitor.
    name str
    The Name of the Monitor.
    pool_id str
    The id of the pool that this monitor will be assigned to.
    region str
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a monitor. If omitted, the region argument of the provider is used. Changing this creates a new monitor.
    tenant_id str
    Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. 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.
    type str
    The type of probe, which is PING, TCP, HTTP, HTTPS, TLS-HELLO, SCTP or UDP-CONNECT, that is sent by the loadbalancer 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. Default is /.
    adminStateUp Boolean
    The administrative state of the monitor. A valid value is true (UP) or false (DOWN).
    delay Number
    The time, in seconds, between sending probes to members.
    domainName String
    The domain name to use in the HTTP host header health monitor requests. Supported in Octavia API version 2.10 or later.
    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", a list like "200, 202" or a range like "200-202". Default is "200".
    httpMethod String
    Required for HTTP(S) types. The HTTP method that the health monitor uses for requests. One of CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, or TRACE. The default is GET.
    httpVersion String
    Required for HTTP(S) types. The HTTP version that the health monitor uses for requests. One of 1.0 or 1.1is supported for HTTP(S) monitors. The default is1.0`. Supported in Octavia API version 2.10 or later.
    maxRetries Number
    Number of permissible ping failures before changing the member's status to INACTIVE. Must be a number between 1 and 10.
    maxRetriesDown Number
    Number of permissible ping failures before changing the member's status to ERROR. Must be a number between 1 and 10. The default is 3. Changing this updates the max_retries_down of the existing monitor.
    name String
    The Name of the Monitor.
    poolId String
    The id of the pool that this monitor will be assigned to.
    region String
    The region in which to obtain the V2 Networking client. A Networking client is needed to create a monitor. If omitted, the region argument of the provider is used. Changing this creates a new monitor.
    tenantId String
    Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. 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.
    type String
    The type of probe, which is PING, TCP, HTTP, HTTPS, TLS-HELLO, SCTP or UDP-CONNECT, that is sent by the loadbalancer 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. Default is /.

    Import

    Load Balancer Pool Monitor can be imported using the Monitor ID, e.g.:

    $ pulumi import openstack:loadbalancer/monitor:Monitor monitor_1 47c26fc3-2403-427a-8c79-1589bd0533c2

    In case of using OpenContrail, the import may not work properly. If you face an issue, try to import the monitor providing its parent pool ID:

    $ pulumi import openstack:loadbalancer/monitor:Monitor monitor_1 47c26fc3-2403-427a-8c79-1589bd0533c2/708bc224-0f8c-4981-ac82-97095fe051b6

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    OpenStack pulumi/pulumi-openstack
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the openstack Terraform Provider.
    openstack logo
    OpenStack v5.0.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-openstack