Class ComputeHttpHealthCheck.Builder
- java.lang.Object
-
- com.hashicorp.cdktf.providers.google.compute_http_health_check.ComputeHttpHealthCheck.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<ComputeHttpHealthCheck>
- Enclosing class:
- ComputeHttpHealthCheck
@Stability(Stable) public static final class ComputeHttpHealthCheck.Builder extends Object implements software.amazon.jsii.Builder<ComputeHttpHealthCheck>
A fluent builder forComputeHttpHealthCheck.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ComputeHttpHealthCheckbuild()ComputeHttpHealthCheck.BuildercheckIntervalSec(Number checkIntervalSec)How often (in seconds) to send a health check.ComputeHttpHealthCheck.Builderconnection(com.hashicorp.cdktf.SSHProvisionerConnection connection)ComputeHttpHealthCheck.Builderconnection(com.hashicorp.cdktf.WinrmProvisionerConnection connection)ComputeHttpHealthCheck.Buildercount(com.hashicorp.cdktf.TerraformCount count)ComputeHttpHealthCheck.Buildercount(Number count)static ComputeHttpHealthCheck.Buildercreate(software.constructs.Construct scope, String id)ComputeHttpHealthCheck.BuilderdependsOn(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)ComputeHttpHealthCheck.Builderdescription(String description)An optional description of this resource.ComputeHttpHealthCheck.BuilderforEach(com.hashicorp.cdktf.ITerraformIterator forEach)ComputeHttpHealthCheck.BuilderhealthyThreshold(Number healthyThreshold)A so-far unhealthy instance will be marked healthy after this many consecutive successes.ComputeHttpHealthCheck.Builderhost(String host)The value of the host header in the HTTP health check request.ComputeHttpHealthCheck.Builderid(String id)Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_http_health_check#id ComputeHttpHealthCheck#id}.ComputeHttpHealthCheck.Builderlifecycle(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)ComputeHttpHealthCheck.Buildername(String name)Name of the resource.ComputeHttpHealthCheck.Builderport(Number port)The TCP port number for the HTTP health check request.ComputeHttpHealthCheck.Builderproject(String project)Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_http_health_check#project ComputeHttpHealthCheck#project}.ComputeHttpHealthCheck.Builderprovider(com.hashicorp.cdktf.TerraformProvider provider)ComputeHttpHealthCheck.Builderprovisioners(List<? extends Object> provisioners)ComputeHttpHealthCheck.BuilderrequestPath(String requestPath)The request path of the HTTP health check request.ComputeHttpHealthCheck.Buildertimeouts(ComputeHttpHealthCheckTimeouts timeouts)timeouts block.ComputeHttpHealthCheck.BuildertimeoutSec(Number timeoutSec)How long (in seconds) to wait before claiming failure.ComputeHttpHealthCheck.BuilderunhealthyThreshold(Number unhealthyThreshold)A so-far healthy instance will be marked unhealthy after this many consecutive failures.
-
-
-
Method Detail
-
create
@Stability(Stable) public static ComputeHttpHealthCheck.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
ComputeHttpHealthCheck.Builder.
-
connection
@Stability(Experimental) public ComputeHttpHealthCheck.Builder connection(com.hashicorp.cdktf.SSHProvisionerConnection connection)
- Parameters:
connection- This parameter is required.- Returns:
this
-
connection
@Stability(Experimental) public ComputeHttpHealthCheck.Builder connection(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
- Parameters:
connection- This parameter is required.- Returns:
this
-
count
@Stability(Experimental) public ComputeHttpHealthCheck.Builder count(Number count)
- Parameters:
count- This parameter is required.- Returns:
this
-
count
@Stability(Experimental) public ComputeHttpHealthCheck.Builder count(com.hashicorp.cdktf.TerraformCount count)
- Parameters:
count- This parameter is required.- Returns:
this
-
dependsOn
@Stability(Experimental) public ComputeHttpHealthCheck.Builder dependsOn(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
- Parameters:
dependsOn- This parameter is required.- Returns:
this
-
forEach
@Stability(Experimental) public ComputeHttpHealthCheck.Builder forEach(com.hashicorp.cdktf.ITerraformIterator forEach)
- Parameters:
forEach- This parameter is required.- Returns:
this
-
lifecycle
@Stability(Experimental) public ComputeHttpHealthCheck.Builder lifecycle(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
- Parameters:
lifecycle- This parameter is required.- Returns:
this
-
provider
@Stability(Experimental) public ComputeHttpHealthCheck.Builder provider(com.hashicorp.cdktf.TerraformProvider provider)
- Parameters:
provider- This parameter is required.- Returns:
this
-
provisioners
@Stability(Experimental) public ComputeHttpHealthCheck.Builder provisioners(List<? extends Object> provisioners)
- Parameters:
provisioners- This parameter is required.- Returns:
this
-
name
@Stability(Stable) public ComputeHttpHealthCheck.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_http_health_check#name ComputeHttpHealthCheck#name}
- Parameters:
name- Name of the resource. This parameter is required.- Returns:
this
-
checkIntervalSec
@Stability(Stable) public ComputeHttpHealthCheck.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_http_health_check#check_interval_sec ComputeHttpHealthCheck#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 ComputeHttpHealthCheck.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_http_health_check#description ComputeHttpHealthCheck#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 ComputeHttpHealthCheck.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_http_health_check#healthy_threshold ComputeHttpHealthCheck#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 ComputeHttpHealthCheck.Builder host(String host)
The value of the host header in the HTTP 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_http_health_check#host ComputeHttpHealthCheck#host}
- Parameters:
host- The value of the host header in the HTTP health check request. This parameter is required.- Returns:
this
-
id
@Stability(Stable) public ComputeHttpHealthCheck.Builder id(String id)
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_http_health_check#id ComputeHttpHealthCheck#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_http_health_check#id ComputeHttpHealthCheck#id}. This parameter is required.- Returns:
this
-
port
@Stability(Stable) public ComputeHttpHealthCheck.Builder port(Number port)
The TCP port number for the HTTP health check request. The default value is 80.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_http_health_check#port ComputeHttpHealthCheck#port}
- Parameters:
port- The TCP port number for the HTTP health check request. The default value is 80. This parameter is required.- Returns:
this
-
project
@Stability(Stable) public ComputeHttpHealthCheck.Builder project(String project)
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_http_health_check#project ComputeHttpHealthCheck#project}.- Parameters:
project- Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_http_health_check#project ComputeHttpHealthCheck#project}. This parameter is required.- Returns:
this
-
requestPath
@Stability(Stable) public ComputeHttpHealthCheck.Builder requestPath(String requestPath)
The request path of the HTTP 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_http_health_check#request_path ComputeHttpHealthCheck#request_path}
- Parameters:
requestPath- The request path of the HTTP health check request. The default value is /. This parameter is required.- Returns:
this
-
timeouts
@Stability(Stable) public ComputeHttpHealthCheck.Builder timeouts(ComputeHttpHealthCheckTimeouts timeouts)
timeouts block.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_http_health_check#timeouts ComputeHttpHealthCheck#timeouts}
- Parameters:
timeouts- timeouts block. This parameter is required.- Returns:
this
-
timeoutSec
@Stability(Stable) public ComputeHttpHealthCheck.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_http_health_check#timeout_sec ComputeHttpHealthCheck#timeout_sec}
- Parameters:
timeoutSec- How long (in seconds) to wait before claiming failure. This parameter is required.- Returns:
this
-
unhealthyThreshold
@Stability(Stable) public ComputeHttpHealthCheck.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_http_health_check#unhealthy_threshold ComputeHttpHealthCheck#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
-
build
@Stability(Stable) public ComputeHttpHealthCheck build()
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<ComputeHttpHealthCheck>- Returns:
- a newly built instance of
ComputeHttpHealthCheck.
-
-