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

Interface ComputeHealthCheckConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    ComputeHealthCheckConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:18.425Z")
@Stability(Stable)
public interface ComputeHealthCheckConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getName

        @Stability(Stable)
@NotNull
String getName()
        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}

      • getCheckIntervalSec

        @Stability(Stable)
@Nullable
default Number getCheckIntervalSec()
        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}

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        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}

      • getGrpcHealthCheck

        @Stability(Stable)
@Nullable
default ComputeHealthCheckGrpcHealthCheck getGrpcHealthCheck()
        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}

      • getHealthyThreshold

        @Stability(Stable)
@Nullable
default Number getHealthyThreshold()
        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}

      • getHttp2HealthCheck

        @Stability(Stable)
@Nullable
default ComputeHealthCheckHttp2HealthCheck getHttp2HealthCheck()
        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}

      • getHttpHealthCheck

        @Stability(Stable)
@Nullable
default ComputeHealthCheckHttpHealthCheck getHttpHealthCheck()
        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}

      • getHttpsHealthCheck

        @Stability(Stable)
@Nullable
default ComputeHealthCheckHttpsHealthCheck getHttpsHealthCheck()
        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}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        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.

      • getLogConfig

        @Stability(Stable)
@Nullable
default ComputeHealthCheckLogConfig getLogConfig()
        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}

      • getProject

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

      • getSourceRegions

        @Stability(Stable)
@Nullable
default List<String> getSourceRegions()
        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}

      • getSslHealthCheck

        @Stability(Stable)
@Nullable
default ComputeHealthCheckSslHealthCheck getSslHealthCheck()
        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}

      • getTcpHealthCheck

        @Stability(Stable)
@Nullable
default ComputeHealthCheckTcpHealthCheck getTcpHealthCheck()
        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}

      • getTimeouts

        @Stability(Stable)
@Nullable
default ComputeHealthCheckTimeouts getTimeouts()
        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}

      • getTimeoutSec

        @Stability(Stable)
@Nullable
default Number getTimeoutSec()
        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}

      • getUnhealthyThreshold

        @Stability(Stable)
@Nullable
default Number getUnhealthyThreshold()
        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}