Show / Hide Table of Contents

Class Monitor

Manages a V2 monitor resource within OpenStack.

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
public MyStack()
{
    var monitor1 = new OpenStack.LoadBalancer.Monitor("monitor1", new OpenStack.LoadBalancer.MonitorArgs
    {
        Delay = 20,
        MaxRetries = 5,
        PoolId = openstack_lb_pool_v2.Pool_1.Id,
        Timeout = 10,
        Type = "PING",
    });
}

}
Inheritance
System.Object
Resource
CustomResource
Monitor
Inherited Members
CustomResource.Id
Resource.GetResourceType()
Resource.GetResourceName()
Resource.Urn
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.OpenStack.LoadBalancer
Assembly: Pulumi.OpenStack.dll
Syntax
public class Monitor : CustomResource

Constructors

View Source

Monitor(String, MonitorArgs, CustomResourceOptions)

Create a Monitor resource with the given unique name, arguments, and options.

Declaration
public Monitor(string name, MonitorArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource

MonitorArgs args

The arguments used to populate this resource's properties

CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

AdminStateUp

The administrative state of the monitor. A valid value is true (UP) or false (DOWN).

Declaration
public Output<bool?> AdminStateUp { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

Delay

The time, in seconds, between sending probes to members.

Declaration
public Output<int> Delay { get; }
Property Value
Type Description
Output<System.Int32>
View Source

ExpectedCodes

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".

Declaration
public Output<string> ExpectedCodes { get; }
Property Value
Type Description
Output<System.String>
View Source

HttpMethod

Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to "GET".

Declaration
public Output<string> HttpMethod { get; }
Property Value
Type Description
Output<System.String>
View Source

MaxRetries

Number of permissible ping failures before changing the member's status to INACTIVE. Must be a number between 1 and 10.

Declaration
public Output<int> MaxRetries { get; }
Property Value
Type Description
Output<System.Int32>
View Source

MaxRetriesDown

Number of permissible ping failures befor changing the member's status to ERROR. Must be a number between 1 and 10 (supported only in Octavia). Changing this updates the max_retries_down of the existing monitor.

Declaration
public Output<int> MaxRetriesDown { get; }
Property Value
Type Description
Output<System.Int32>
View Source

Name

The Name of the Monitor.

Declaration
public Output<string> Name { get; }
Property Value
Type Description
Output<System.String>
View Source

PoolId

The id of the pool that this monitor will be assigned to.

Declaration
public Output<string> PoolId { get; }
Property Value
Type Description
Output<System.String>
View Source

Region

The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new monitor.

Declaration
public Output<string> Region { get; }
Property Value
Type Description
Output<System.String>
View Source

TenantId

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.

Declaration
public Output<string> TenantId { get; }
Property Value
Type Description
Output<System.String>
View Source

Timeout

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.

Declaration
public Output<int> Timeout { get; }
Property Value
Type Description
Output<System.Int32>
View Source

Type

The type of probe, which is PING, TCP, HTTP, HTTPS, TLS-HELLO or UDP-CONNECT (supported only in Octavia), that is sent by the load balancer to verify the member state. Changing this creates a new monitor.

Declaration
public Output<string> Type { get; }
Property Value
Type Description
Output<System.String>
View Source

UrlPath

Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS.

Declaration
public Output<string> UrlPath { get; }
Property Value
Type Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, MonitorState, CustomResourceOptions)

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

Declaration
public static Monitor Get(string name, Input<string> id, MonitorState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.

Input<System.String> id

The unique provider ID of the resource to lookup.

MonitorState state

Any extra arguments used during the lookup.

CustomResourceOptions options

A bag of options that control this resource's behavior

Returns
Type Description
Monitor
  • View Source
Back to top Copyright 2016-2020, Pulumi Corporation.