Package com.hashicorp.cdktf.providers.google.compute_https_health_check

Class ComputeHttpsHealthCheck.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static ComputeHttpsHealthCheck.Builder create​(software.constructs.Construct scope,
                                                     String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of ComputeHttpsHealthCheck.Builder.

      • connection

        @Stability(Experimental)
public ComputeHttpsHealthCheck.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public ComputeHttpsHealthCheck.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public ComputeHttpsHealthCheck.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public ComputeHttpsHealthCheck.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public ComputeHttpsHealthCheck.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public ComputeHttpsHealthCheck.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public ComputeHttpsHealthCheck.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • name

        @Stability(Stable)
public ComputeHttpsHealthCheck.Builder name​(String name)
        Name of the resource.

        Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression '[a-z](%5B-a-z0-9%5D*%5Ba-z0-9%5D)?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_https_health_check#name ComputeHttpsHealthCheck#name}

        Parameters:
        name - Name of the resource. This parameter is required.
        Returns:
        this

      • checkIntervalSec

        @Stability(Stable)
public ComputeHttpsHealthCheck.Builder checkIntervalSec​(Number checkIntervalSec)
        How often (in seconds) to send a health check. The default value is 5 seconds.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_https_health_check#check_interval_sec ComputeHttpsHealthCheck#check_interval_sec}

        Parameters:
        checkIntervalSec - How often (in seconds) to send a health check. The default value is 5 seconds. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public ComputeHttpsHealthCheck.Builder description​(String description)
        An optional description of this resource. Provide this property when you create the resource.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_https_health_check#description ComputeHttpsHealthCheck#description}

        Parameters:
        description - An optional description of this resource. Provide this property when you create the resource. This parameter is required.
        Returns:
        this

      • healthyThreshold

        @Stability(Stable)
public ComputeHttpsHealthCheck.Builder healthyThreshold​(Number healthyThreshold)
        A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_https_health_check#healthy_threshold ComputeHttpsHealthCheck#healthy_threshold}

        Parameters:
        healthyThreshold - A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. This parameter is required.
        Returns:
        this

      • host

        @Stability(Stable)
public ComputeHttpsHealthCheck.Builder host​(String host)
        The value of the host header in the HTTPS health check request.

        If left empty (default value), the public IP on behalf of which this health check is performed will be used. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_https_health_check#host ComputeHttpsHealthCheck#host}

        Parameters:
        host - The value of the host header in the HTTPS health check request. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public ComputeHttpsHealthCheck.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_https_health_check#id ComputeHttpsHealthCheck#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_https_health_check#id ComputeHttpsHealthCheck#id}. This parameter is required.
        Returns:
        this

      • port

        @Stability(Stable)
public ComputeHttpsHealthCheck.Builder port​(Number port)
        The TCP port number for the HTTPS health check request. The default value is 443.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_https_health_check#port ComputeHttpsHealthCheck#port}

        Parameters:
        port - The TCP port number for the HTTPS health check request. The default value is 443. This parameter is required.
        Returns:
        this

      • project

        @Stability(Stable)
public ComputeHttpsHealthCheck.Builder project​(String project)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_https_health_check#project ComputeHttpsHealthCheck#project}.

        Parameters:
        project - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_https_health_check#project ComputeHttpsHealthCheck#project}. This parameter is required.
        Returns:
        this

      • requestPath

        @Stability(Stable)
public ComputeHttpsHealthCheck.Builder requestPath​(String requestPath)
        The request path of the HTTPS health check request. The default value is /.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_https_health_check#request_path ComputeHttpsHealthCheck#request_path}

        Parameters:
        requestPath - The request path of the HTTPS health check request. The default value is /. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public ComputeHttpsHealthCheck.Builder timeouts​(ComputeHttpsHealthCheckTimeouts timeouts)
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_https_health_check#timeouts ComputeHttpsHealthCheck#timeouts}

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this

      • timeoutSec

        @Stability(Stable)
public ComputeHttpsHealthCheck.Builder timeoutSec​(Number timeoutSec)
        How long (in seconds) to wait before claiming failure.

        The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_https_health_check#timeout_sec ComputeHttpsHealthCheck#timeout_sec}

        Parameters:
        timeoutSec - How long (in seconds) to wait before claiming failure. This parameter is required.
        Returns:
        this

      • unhealthyThreshold

        @Stability(Stable)
public ComputeHttpsHealthCheck.Builder unhealthyThreshold​(Number unhealthyThreshold)
        A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_https_health_check#unhealthy_threshold ComputeHttpsHealthCheck#unhealthy_threshold}

        Parameters:
        unhealthyThreshold - A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. This parameter is required.
        Returns:
        this