Package com.hashicorp.cdktf.providers.google.compute_health_check

Class ComputeHealthCheck.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static ComputeHealthCheck.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 ComputeHealthCheck.Builder.

      • connection

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

      • connection

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

      • count

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

      • dependsOn

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

      • forEach

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

      • lifecycle

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

      • provider

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

      • provisioners

        @Stability(Experimental)
public ComputeHealthCheck.Builder provisioners​(List<? extends Object> provisioners)
        Parameters:
        provisioners - This parameter is required.
        Returns:
        this

      • name

        @Stability(Stable)
public ComputeHealthCheck.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_health_check#name ComputeHealthCheck#name}

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

      • checkIntervalSec

        @Stability(Stable)
public ComputeHealthCheck.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_health_check#check_interval_sec ComputeHealthCheck#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 ComputeHealthCheck.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_health_check#description ComputeHealthCheck#description}

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

      • grpcHealthCheck

        @Stability(Stable)
public ComputeHealthCheck.Builder grpcHealthCheck​(ComputeHealthCheckGrpcHealthCheck grpcHealthCheck)
        grpc_health_check block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_health_check#grpc_health_check ComputeHealthCheck#grpc_health_check}

        Parameters:
        grpcHealthCheck - grpc_health_check block. This parameter is required.
        Returns:
        this

      • healthyThreshold

        @Stability(Stable)
public ComputeHealthCheck.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_health_check#healthy_threshold ComputeHealthCheck#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

      • http2HealthCheck

        @Stability(Stable)
public ComputeHealthCheck.Builder http2HealthCheck​(ComputeHealthCheckHttp2HealthCheck http2HealthCheck)
        http2_health_check block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_health_check#http2_health_check ComputeHealthCheck#http2_health_check}

        Parameters:
        http2HealthCheck - http2_health_check block. This parameter is required.
        Returns:
        this

      • httpHealthCheck

        @Stability(Stable)
public ComputeHealthCheck.Builder httpHealthCheck​(ComputeHealthCheckHttpHealthCheck httpHealthCheck)
        http_health_check block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_health_check#http_health_check ComputeHealthCheck#http_health_check}

        Parameters:
        httpHealthCheck - http_health_check block. This parameter is required.
        Returns:
        this

      • httpsHealthCheck

        @Stability(Stable)
public ComputeHealthCheck.Builder httpsHealthCheck​(ComputeHealthCheckHttpsHealthCheck httpsHealthCheck)
        https_health_check block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_health_check#https_health_check ComputeHealthCheck#https_health_check}

        Parameters:
        httpsHealthCheck - https_health_check block. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public ComputeHealthCheck.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_health_check#id ComputeHealthCheck#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_health_check#id ComputeHealthCheck#id}. This parameter is required.
        Returns:
        this

      • logConfig

        @Stability(Stable)
public ComputeHealthCheck.Builder logConfig​(ComputeHealthCheckLogConfig logConfig)
        log_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_health_check#log_config ComputeHealthCheck#log_config}

        Parameters:
        logConfig - log_config block. This parameter is required.
        Returns:
        this

      • project

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

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

      • sourceRegions

        @Stability(Stable)
public ComputeHealthCheck.Builder sourceRegions​(List<String> sourceRegions)
        The list of cloud regions from which health checks are performed.

        If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of Google Cloud regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: * SSL, HTTP2, and GRPC protocols are not supported. * The TCP request field is not supported. * The proxyHeader field for HTTP, HTTPS, and TCP is not supported. * The checkIntervalSec field must be at least 30. * The health check cannot be used with BackendService nor with managed instance group auto-healing. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_health_check#source_regions ComputeHealthCheck#source_regions}

        Parameters:
        sourceRegions - The list of cloud regions from which health checks are performed. This parameter is required.
        Returns:
        this

      • sslHealthCheck

        @Stability(Stable)
public ComputeHealthCheck.Builder sslHealthCheck​(ComputeHealthCheckSslHealthCheck sslHealthCheck)
        ssl_health_check block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_health_check#ssl_health_check ComputeHealthCheck#ssl_health_check}

        Parameters:
        sslHealthCheck - ssl_health_check block. This parameter is required.
        Returns:
        this

      • tcpHealthCheck

        @Stability(Stable)
public ComputeHealthCheck.Builder tcpHealthCheck​(ComputeHealthCheckTcpHealthCheck tcpHealthCheck)
        tcp_health_check block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_health_check#tcp_health_check ComputeHealthCheck#tcp_health_check}

        Parameters:
        tcpHealthCheck - tcp_health_check block. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public ComputeHealthCheck.Builder timeouts​(ComputeHealthCheckTimeouts timeouts)
        timeouts block.

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

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

      • timeoutSec

        @Stability(Stable)
public ComputeHealthCheck.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_health_check#timeout_sec ComputeHealthCheck#timeout_sec}

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

      • unhealthyThreshold

        @Stability(Stable)
public ComputeHealthCheck.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_health_check#unhealthy_threshold ComputeHealthCheck#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