Package com.pulumi.openstack.loadbalancer

Class Monitor

  • public class Monitor
extends com.pulumi.resources.CustomResource
    Manages a V2 monitor resource within OpenStack. ## Example Usage ```java 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(openstack_lb_pool_v2.pool_1().id()) .type("PING") .delay(20) .timeout(10) .maxRetries(5) .build()); } } ``` ## Import Load Balancer Pool Monitor can be imported using the Monitor ID, e.g.: ```sh $ 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: ```sh $ pulumi import openstack:loadbalancer/monitor:Monitor monitor_1 47c26fc3-2403-427a-8c79-1589bd0533c2/708bc224-0f8c-4981-ac82-97095fe051b6 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Monitor​(java.lang.String name)  
      Monitor​(java.lang.String name, MonitorArgs args)  
      Monitor​(java.lang.String name, MonitorArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> adminStateUp()  
      com.pulumi.core.Output<java.lang.Integer> delay()  
      com.pulumi.core.Output<java.lang.String> expectedCodes()  
      static Monitor get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, MonitorState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> httpMethod()  
      com.pulumi.core.Output<java.lang.Integer> maxRetries()  
      com.pulumi.core.Output<java.lang.Integer> maxRetriesDown()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> poolId()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> tenantId()  
      com.pulumi.core.Output<java.lang.Integer> timeout()  
      com.pulumi.core.Output<java.lang.String> type()  
      com.pulumi.core.Output<java.lang.String> urlPath()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Monitor

        public Monitor​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Monitor

        public Monitor​(java.lang.String name,
               MonitorArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Monitor

        public Monitor​(java.lang.String name,
               MonitorArgs args,
               @Nullable
               com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • adminStateUp

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> adminStateUp()
        Returns:
        The administrative state of the monitor. A valid value is true (UP) or false (DOWN).

      • delay

        public com.pulumi.core.Output<java.lang.Integer> delay()
        Returns:
        The time, in seconds, between sending probes to members.

      • expectedCodes

        public com.pulumi.core.Output<java.lang.String> expectedCodes()
        Returns:
        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".

      • httpMethod

        public com.pulumi.core.Output<java.lang.String> httpMethod()
        Returns:
        Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to "GET".

      • maxRetries

        public com.pulumi.core.Output<java.lang.Integer> maxRetries()
        Returns:
        Number of permissible ping failures before changing the member's status to INACTIVE. Must be a number between 1 and 10.

      • maxRetriesDown

        public com.pulumi.core.Output<java.lang.Integer> maxRetriesDown()
        Returns:
        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.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The Name of the Monitor.

      • poolId

        public com.pulumi.core.Output<java.lang.String> poolId()
        Returns:
        The id of the pool that this monitor will be assigned to.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        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.

      • tenantId

        public com.pulumi.core.Output<java.lang.String> tenantId()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.Integer> timeout()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        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.

      • urlPath

        public com.pulumi.core.Output<java.lang.String> urlPath()
        Returns:
        Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS.

      • get

        public static Monitor get​(java.lang.String name,
                          com.pulumi.core.Output<java.lang.String> id,
                          @Nullable
                          MonitorState state,
                          @Nullable
                          com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.