Skip to content
This repository was archived by the owner on Dec 10, 2025. It is now read-only.

healthcheck.java.md

Latest commit

 

History

History
2677 lines (1668 loc) · 120 KB

healthcheck.java.md

File metadata and controls

2677 lines (1668 loc) · 120 KB

healthcheck Submodule

Constructs

Healthcheck

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck cloudflare_healthcheck}.

Initializers 

import com.hashicorp.cdktf.providers.cloudflare.healthcheck.Healthcheck;

Healthcheck.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .address(java.lang.String)
    .name(java.lang.String)
    .zoneId(java.lang.String)
//  .checkRegions(java.util.List<java.lang.String>)
//  .consecutiveFails(java.lang.Number)
//  .consecutiveSuccesses(java.lang.Number)
//  .description(java.lang.String)
//  .httpConfig(HealthcheckHttpConfig)
//  .interval(java.lang.Number)
//  .retries(java.lang.Number)
//  .suspended(java.lang.Boolean|IResolvable)
//  .tcpConfig(HealthcheckTcpConfig)
//  .timeout(java.lang.Number)
//  .type(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection|com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number|com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner|com.hashicorp.cdktf.LocalExecProvisioner|com.hashicorp.cdktf.RemoteExecProvisioner> No description.
address java.lang.String The hostname or IP address of the origin server to run health checks on.
name java.lang.String A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.
zoneId java.lang.String Identifier.
checkRegions java.util.List<java.lang.String> A list of regions from which to run health checks. Null means Cloudflare will pick a default region.
consecutiveFails java.lang.Number The number of consecutive fails required from a health check before changing the health to unhealthy.
consecutiveSuccesses java.lang.Number The number of consecutive successes required from a health check before changing the health to healthy.
description java.lang.String A human-readable description of the health check.
httpConfig HealthcheckHttpConfig Parameters specific to an HTTP or HTTPS health check.
interval java.lang.Number The interval between each health check.
retries java.lang.Number The number of retries to attempt in case of a timeout before marking the origin as unhealthy.
suspended java.lang.Boolean|com.hashicorp.cdktf.IResolvable If suspended, no health checks are sent to the origin.
tcpConfig HealthcheckTcpConfig Parameters specific to TCP health check.
timeout java.lang.Number The timeout (in seconds) before marking the health check as failed.
type java.lang.String The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection|com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number|com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner|com.hashicorp.cdktf.LocalExecProvisioner|com.hashicorp.cdktf.RemoteExecProvisioner>
addressRequired
  • Type: java.lang.String

The hostname or IP address of the origin server to run health checks on.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#address Healthcheck#address}

nameRequired
  • Type: java.lang.String

A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#name Healthcheck#name}

zoneIdRequired
  • Type: java.lang.String

Identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#zone_id Healthcheck#zone_id}

checkRegionsOptional
  • Type: java.util.List<java.lang.String>

A list of regions from which to run health checks. Null means Cloudflare will pick a default region.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#check_regions Healthcheck#check_regions}

consecutiveFailsOptional
  • Type: java.lang.Number

The number of consecutive fails required from a health check before changing the health to unhealthy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#consecutive_fails Healthcheck#consecutive_fails}

consecutiveSuccessesOptional
  • Type: java.lang.Number

The number of consecutive successes required from a health check before changing the health to healthy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#consecutive_successes Healthcheck#consecutive_successes}

descriptionOptional
  • Type: java.lang.String

A human-readable description of the health check.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#description Healthcheck#description}

httpConfigOptional

Parameters specific to an HTTP or HTTPS health check.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#http_config Healthcheck#http_config}

intervalOptional
  • Type: java.lang.Number

The interval between each health check.

Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#interval Healthcheck#interval}

retriesOptional
  • Type: java.lang.Number

The number of retries to attempt in case of a timeout before marking the origin as unhealthy.

Retries are attempted immediately.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#retries Healthcheck#retries}

suspendedOptional
  • Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable

If suspended, no health checks are sent to the origin.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#suspended Healthcheck#suspended}

tcpConfigOptional

Parameters specific to TCP health check.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#tcp_config Healthcheck#tcp_config}

timeoutOptional
  • Type: java.lang.Number

The timeout (in seconds) before marking the health check as failed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#timeout Healthcheck#timeout}

typeOptional
  • Type: java.lang.String

The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#type Healthcheck#type}

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
putHttpConfig No description.
putTcpConfig No description.
resetCheckRegions No description.
resetConsecutiveFails No description.
resetConsecutiveSuccesses No description.
resetDescription No description.
resetHttpConfig No description.
resetInterval No description.
resetRetries No description.
resetSuspended No description.
resetTcpConfig No description.
resetTimeout No description.
resetType No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: java.lang.String

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: java.lang.String|java.lang.Number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

moveToId 
public void moveToId(java.lang.String id)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: java.lang.String

Full id of resource to move to, e.g. "aws_s3_bucket.example".

putHttpConfig 
public void putHttpConfig(HealthcheckHttpConfig value)
valueRequired
putTcpConfig 
public void putTcpConfig(HealthcheckTcpConfig value)
valueRequired
resetCheckRegions 
public void resetCheckRegions()
resetConsecutiveFails 
public void resetConsecutiveFails()
resetConsecutiveSuccesses 
public void resetConsecutiveSuccesses()
resetDescription 
public void resetDescription()
resetHttpConfig 
public void resetHttpConfig()
resetInterval 
public void resetInterval()
resetRetries 
public void resetRetries()
resetSuspended 
public void resetSuspended()
resetTcpConfig 
public void resetTcpConfig()
resetTimeout 
public void resetTimeout()
resetType 
public void resetType()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a Healthcheck resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.cloudflare.healthcheck.Healthcheck;

Healthcheck.isConstruct(java.lang.Object x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.cloudflare.healthcheck.Healthcheck;

Healthcheck.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.cloudflare.healthcheck.Healthcheck;

Healthcheck.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.cloudflare.healthcheck.Healthcheck;

Healthcheck.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),Healthcheck.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

Generates CDKTF code for importing a Healthcheck resource upon running "cdktf plan ".

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

The construct id used in the generated config for the Healthcheck to import.

importFromIdRequired
  • Type: java.lang.String

The id of the existing Healthcheck that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

? Optional instance of the provider where the Healthcheck to import is found.

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection|com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number|com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner|com.hashicorp.cdktf.LocalExecProvisioner|com.hashicorp.cdktf.RemoteExecProvisioner> No description.
createdOn java.lang.String No description.
failureReason java.lang.String No description.
httpConfig HealthcheckHttpConfigOutputReference No description.
id java.lang.String No description.
modifiedOn java.lang.String No description.
status java.lang.String No description.
tcpConfig HealthcheckTcpConfigOutputReference No description.
addressInput java.lang.String No description.
checkRegionsInput java.util.List<java.lang.String> No description.
consecutiveFailsInput java.lang.Number No description.
consecutiveSuccessesInput java.lang.Number No description.
descriptionInput java.lang.String No description.
httpConfigInput com.hashicorp.cdktf.IResolvable|HealthcheckHttpConfig No description.
intervalInput java.lang.Number No description.
nameInput java.lang.String No description.
retriesInput java.lang.Number No description.
suspendedInput java.lang.Boolean|com.hashicorp.cdktf.IResolvable No description.
tcpConfigInput com.hashicorp.cdktf.IResolvable|HealthcheckTcpConfig No description.
timeoutInput java.lang.Number No description.
typeInput java.lang.String No description.
zoneIdInput java.lang.String No description.
address java.lang.String No description.
checkRegions java.util.List<java.lang.String> No description.
consecutiveFails java.lang.Number No description.
consecutiveSuccesses java.lang.Number No description.
description java.lang.String No description.
interval java.lang.Number No description.
name java.lang.String No description.
retries java.lang.Number No description.
suspended java.lang.Boolean|com.hashicorp.cdktf.IResolvable No description.
timeout java.lang.Number No description.
type java.lang.String No description.
zoneId java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection|com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Number|TerraformCount getCount();
  • Type: java.lang.Number|com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner|com.hashicorp.cdktf.LocalExecProvisioner|com.hashicorp.cdktf.RemoteExecProvisioner>
createdOnRequired 
public java.lang.String getCreatedOn();
  • Type: java.lang.String
failureReasonRequired 
public java.lang.String getFailureReason();
  • Type: java.lang.String
httpConfigRequired 
public HealthcheckHttpConfigOutputReference getHttpConfig();
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
modifiedOnRequired 
public java.lang.String getModifiedOn();
  • Type: java.lang.String
statusRequired 
public java.lang.String getStatus();
  • Type: java.lang.String
tcpConfigRequired 
public HealthcheckTcpConfigOutputReference getTcpConfig();
addressInputOptional 
public java.lang.String getAddressInput();
  • Type: java.lang.String
checkRegionsInputOptional 
public java.util.List<java.lang.String> getCheckRegionsInput();
  • Type: java.util.List<java.lang.String>
consecutiveFailsInputOptional 
public java.lang.Number getConsecutiveFailsInput();
  • Type: java.lang.Number
consecutiveSuccessesInputOptional 
public java.lang.Number getConsecutiveSuccessesInput();
  • Type: java.lang.Number
descriptionInputOptional 
public java.lang.String getDescriptionInput();
  • Type: java.lang.String
httpConfigInputOptional 
public IResolvable|HealthcheckHttpConfig getHttpConfigInput();
intervalInputOptional 
public java.lang.Number getIntervalInput();
  • Type: java.lang.Number
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
retriesInputOptional 
public java.lang.Number getRetriesInput();
  • Type: java.lang.Number
suspendedInputOptional 
public java.lang.Boolean|IResolvable getSuspendedInput();
  • Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable
tcpConfigInputOptional 
public IResolvable|HealthcheckTcpConfig getTcpConfigInput();
timeoutInputOptional 
public java.lang.Number getTimeoutInput();
  • Type: java.lang.Number
typeInputOptional 
public java.lang.String getTypeInput();
  • Type: java.lang.String
zoneIdInputOptional 
public java.lang.String getZoneIdInput();
  • Type: java.lang.String
addressRequired 
public java.lang.String getAddress();
  • Type: java.lang.String
checkRegionsRequired 
public java.util.List<java.lang.String> getCheckRegions();
  • Type: java.util.List<java.lang.String>
consecutiveFailsRequired 
public java.lang.Number getConsecutiveFails();
  • Type: java.lang.Number
consecutiveSuccessesRequired 
public java.lang.Number getConsecutiveSuccesses();
  • Type: java.lang.Number
descriptionRequired 
public java.lang.String getDescription();
  • Type: java.lang.String
intervalRequired 
public java.lang.Number getInterval();
  • Type: java.lang.Number
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
retriesRequired 
public java.lang.Number getRetries();
  • Type: java.lang.Number
suspendedRequired 
public java.lang.Boolean|IResolvable getSuspended();
  • Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable
timeoutRequired 
public java.lang.Number getTimeout();
  • Type: java.lang.Number
typeRequired 
public java.lang.String getType();
  • Type: java.lang.String
zoneIdRequired 
public java.lang.String getZoneId();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

HealthcheckConfig

Initializer 

import com.hashicorp.cdktf.providers.cloudflare.healthcheck.HealthcheckConfig;

HealthcheckConfig.builder()
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .address(java.lang.String)
    .name(java.lang.String)
    .zoneId(java.lang.String)
//  .checkRegions(java.util.List<java.lang.String>)
//  .consecutiveFails(java.lang.Number)
//  .consecutiveSuccesses(java.lang.Number)
//  .description(java.lang.String)
//  .httpConfig(HealthcheckHttpConfig)
//  .interval(java.lang.Number)
//  .retries(java.lang.Number)
//  .suspended(java.lang.Boolean|IResolvable)
//  .tcpConfig(HealthcheckTcpConfig)
//  .timeout(java.lang.Number)
//  .type(java.lang.String)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection|com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number|com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner|com.hashicorp.cdktf.LocalExecProvisioner|com.hashicorp.cdktf.RemoteExecProvisioner> No description.
address java.lang.String The hostname or IP address of the origin server to run health checks on.
name java.lang.String A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.
zoneId java.lang.String Identifier.
checkRegions java.util.List<java.lang.String> A list of regions from which to run health checks. Null means Cloudflare will pick a default region.
consecutiveFails java.lang.Number The number of consecutive fails required from a health check before changing the health to unhealthy.
consecutiveSuccesses java.lang.Number The number of consecutive successes required from a health check before changing the health to healthy.
description java.lang.String A human-readable description of the health check.
httpConfig HealthcheckHttpConfig Parameters specific to an HTTP or HTTPS health check.
interval java.lang.Number The interval between each health check.
retries java.lang.Number The number of retries to attempt in case of a timeout before marking the origin as unhealthy.
suspended java.lang.Boolean|com.hashicorp.cdktf.IResolvable If suspended, no health checks are sent to the origin.
tcpConfig HealthcheckTcpConfig Parameters specific to TCP health check.
timeout java.lang.Number The timeout (in seconds) before marking the health check as failed.
type java.lang.String The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.
connectionOptional 
public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection|com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Number|TerraformCount getCount();
  • Type: java.lang.Number|com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner|com.hashicorp.cdktf.LocalExecProvisioner|com.hashicorp.cdktf.RemoteExecProvisioner>
addressRequired 
public java.lang.String getAddress();
  • Type: java.lang.String

The hostname or IP address of the origin server to run health checks on.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#address Healthcheck#address}

nameRequired 
public java.lang.String getName();
  • Type: java.lang.String

A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#name Healthcheck#name}

zoneIdRequired 
public java.lang.String getZoneId();
  • Type: java.lang.String

Identifier.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#zone_id Healthcheck#zone_id}

checkRegionsOptional 
public java.util.List<java.lang.String> getCheckRegions();
  • Type: java.util.List<java.lang.String>

A list of regions from which to run health checks. Null means Cloudflare will pick a default region.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#check_regions Healthcheck#check_regions}

consecutiveFailsOptional 
public java.lang.Number getConsecutiveFails();
  • Type: java.lang.Number

The number of consecutive fails required from a health check before changing the health to unhealthy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#consecutive_fails Healthcheck#consecutive_fails}

consecutiveSuccessesOptional 
public java.lang.Number getConsecutiveSuccesses();
  • Type: java.lang.Number

The number of consecutive successes required from a health check before changing the health to healthy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#consecutive_successes Healthcheck#consecutive_successes}

descriptionOptional 
public java.lang.String getDescription();
  • Type: java.lang.String

A human-readable description of the health check.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#description Healthcheck#description}

httpConfigOptional 
public HealthcheckHttpConfig getHttpConfig();

Parameters specific to an HTTP or HTTPS health check.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#http_config Healthcheck#http_config}

intervalOptional 
public java.lang.Number getInterval();
  • Type: java.lang.Number

The interval between each health check.

Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#interval Healthcheck#interval}

retriesOptional 
public java.lang.Number getRetries();
  • Type: java.lang.Number

The number of retries to attempt in case of a timeout before marking the origin as unhealthy.

Retries are attempted immediately.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#retries Healthcheck#retries}

suspendedOptional 
public java.lang.Boolean|IResolvable getSuspended();
  • Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable

If suspended, no health checks are sent to the origin.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#suspended Healthcheck#suspended}

tcpConfigOptional 
public HealthcheckTcpConfig getTcpConfig();

Parameters specific to TCP health check.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#tcp_config Healthcheck#tcp_config}

timeoutOptional 
public java.lang.Number getTimeout();
  • Type: java.lang.Number

The timeout (in seconds) before marking the health check as failed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#timeout Healthcheck#timeout}

typeOptional 
public java.lang.String getType();
  • Type: java.lang.String

The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#type Healthcheck#type}

HealthcheckHttpConfig

Initializer 

import com.hashicorp.cdktf.providers.cloudflare.healthcheck.HealthcheckHttpConfig;

HealthcheckHttpConfig.builder()
//  .allowInsecure(java.lang.Boolean|IResolvable)
//  .expectedBody(java.lang.String)
//  .expectedCodes(java.util.List<java.lang.String>)
//  .followRedirects(java.lang.Boolean|IResolvable)
//  .header(IResolvable|java.util.Map<java.lang.String, java.util.List<java.lang.String>>)
//  .method(java.lang.String)
//  .path(java.lang.String)
//  .port(java.lang.Number)
    .build();

Properties

Name Type Description
allowInsecure java.lang.Boolean|com.hashicorp.cdktf.IResolvable Do not validate the certificate when the health check uses HTTPS.
expectedBody java.lang.String A case-insensitive sub-string to look for in the response body.
expectedCodes java.util.List<java.lang.String> The expected HTTP response codes (e.g. "200") or code ranges (e.g. "2xx" for all codes starting with 2) of the health check.
followRedirects java.lang.Boolean|com.hashicorp.cdktf.IResolvable Follow redirects if the origin returns a 3xx status code.
header com.hashicorp.cdktf.IResolvable|java.util.Map<java.lang.String, java.util.List<java.lang.String>> The HTTP request headers to send in the health check.
method java.lang.String The HTTP method to use for the health check. Available values: "GET", "HEAD".
path java.lang.String The endpoint path to health check against.
port java.lang.Number Port number to connect to for the health check.
allowInsecureOptional 
public java.lang.Boolean|IResolvable getAllowInsecure();
  • Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable

Do not validate the certificate when the health check uses HTTPS.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#allow_insecure Healthcheck#allow_insecure}

expectedBodyOptional 
public java.lang.String getExpectedBody();
  • Type: java.lang.String

A case-insensitive sub-string to look for in the response body.

If this string is not found, the origin will be marked as unhealthy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#expected_body Healthcheck#expected_body}

expectedCodesOptional 
public java.util.List<java.lang.String> getExpectedCodes();
  • Type: java.util.List<java.lang.String>

The expected HTTP response codes (e.g. "200") or code ranges (e.g. "2xx" for all codes starting with 2) of the health check.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#expected_codes Healthcheck#expected_codes}

followRedirectsOptional 
public java.lang.Boolean|IResolvable getFollowRedirects();
  • Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable

Follow redirects if the origin returns a 3xx status code.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#follow_redirects Healthcheck#follow_redirects}

headerOptional 
public IResolvable|java.util.Map<java.lang.String, java.util.List<java.lang.String>> getHeader();
  • Type: com.hashicorp.cdktf.IResolvable|java.util.Map<java.lang.String, java.util.List<java.lang.String>>

The HTTP request headers to send in the health check.

It is recommended you set a Host header by default. The User-Agent header cannot be overridden.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#header Healthcheck#header}

methodOptional 
public java.lang.String getMethod();
  • Type: java.lang.String

The HTTP method to use for the health check. Available values: "GET", "HEAD".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#method Healthcheck#method}

pathOptional 
public java.lang.String getPath();
  • Type: java.lang.String

The endpoint path to health check against.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#path Healthcheck#path}

portOptional 
public java.lang.Number getPort();
  • Type: java.lang.Number

Port number to connect to for the health check.

Defaults to 80 if type is HTTP or 443 if type is HTTPS.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#port Healthcheck#port}

HealthcheckTcpConfig

Initializer 

import com.hashicorp.cdktf.providers.cloudflare.healthcheck.HealthcheckTcpConfig;

HealthcheckTcpConfig.builder()
//  .method(java.lang.String)
//  .port(java.lang.Number)
    .build();

Properties

Name Type Description
method java.lang.String The TCP connection method to use for the health check. Available values: "connection_established".
port java.lang.Number Port number to connect to for the health check. Defaults to 80.
methodOptional 
public java.lang.String getMethod();
  • Type: java.lang.String

The TCP connection method to use for the health check. Available values: "connection_established".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#method Healthcheck#method}

portOptional 
public java.lang.Number getPort();
  • Type: java.lang.Number

Port number to connect to for the health check. Defaults to 80.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/5.14.0/docs/resources/healthcheck#port Healthcheck#port}

Classes

HealthcheckHttpConfigOutputReference

Initializers 

import com.hashicorp.cdktf.providers.cloudflare.healthcheck.HealthcheckHttpConfigOutputReference;

new HealthcheckHttpConfigOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetAllowInsecure No description.
resetExpectedBody No description.
resetExpectedCodes No description.
resetFollowRedirects No description.
resetHeader No description.
resetMethod No description.
resetPath No description.
resetPort No description.
computeFqn 
public java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetAllowInsecure 
public void resetAllowInsecure()
resetExpectedBody 
public void resetExpectedBody()
resetExpectedCodes 
public void resetExpectedCodes()
resetFollowRedirects 
public void resetFollowRedirects()
resetHeader 
public void resetHeader()
resetMethod 
public void resetMethod()
resetPath 
public void resetPath()
resetPort 
public void resetPort()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
allowInsecureInput java.lang.Boolean|com.hashicorp.cdktf.IResolvable No description.
expectedBodyInput java.lang.String No description.
expectedCodesInput java.util.List<java.lang.String> No description.
followRedirectsInput java.lang.Boolean|com.hashicorp.cdktf.IResolvable No description.
headerInput com.hashicorp.cdktf.IResolvable|java.util.Map<java.lang.String, java.util.List<java.lang.String>> No description.
methodInput java.lang.String No description.
pathInput java.lang.String No description.
portInput java.lang.Number No description.
allowInsecure java.lang.Boolean|com.hashicorp.cdktf.IResolvable No description.
expectedBody java.lang.String No description.
expectedCodes java.util.List<java.lang.String> No description.
followRedirects java.lang.Boolean|com.hashicorp.cdktf.IResolvable No description.
header com.hashicorp.cdktf.IResolvable|java.util.Map<java.lang.String, java.util.List<java.lang.String>> No description.
method java.lang.String No description.
path java.lang.String No description.
port java.lang.Number No description.
internalValue com.hashicorp.cdktf.IResolvable|HealthcheckHttpConfig No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
allowInsecureInputOptional 
public java.lang.Boolean|IResolvable getAllowInsecureInput();
  • Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable
expectedBodyInputOptional 
public java.lang.String getExpectedBodyInput();
  • Type: java.lang.String
expectedCodesInputOptional 
public java.util.List<java.lang.String> getExpectedCodesInput();
  • Type: java.util.List<java.lang.String>
followRedirectsInputOptional 
public java.lang.Boolean|IResolvable getFollowRedirectsInput();
  • Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable
headerInputOptional 
public IResolvable|java.util.Map<java.lang.String, java.util.List<java.lang.String>> getHeaderInput();
  • Type: com.hashicorp.cdktf.IResolvable|java.util.Map<java.lang.String, java.util.List<java.lang.String>>
methodInputOptional 
public java.lang.String getMethodInput();
  • Type: java.lang.String
pathInputOptional 
public java.lang.String getPathInput();
  • Type: java.lang.String
portInputOptional 
public java.lang.Number getPortInput();
  • Type: java.lang.Number
allowInsecureRequired 
public java.lang.Boolean|IResolvable getAllowInsecure();
  • Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable
expectedBodyRequired 
public java.lang.String getExpectedBody();
  • Type: java.lang.String
expectedCodesRequired 
public java.util.List<java.lang.String> getExpectedCodes();
  • Type: java.util.List<java.lang.String>
followRedirectsRequired 
public java.lang.Boolean|IResolvable getFollowRedirects();
  • Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable
headerRequired 
public IResolvable|java.util.Map<java.lang.String, java.util.List<java.lang.String>> getHeader();
  • Type: com.hashicorp.cdktf.IResolvable|java.util.Map<java.lang.String, java.util.List<java.lang.String>>
methodRequired 
public java.lang.String getMethod();
  • Type: java.lang.String
pathRequired 
public java.lang.String getPath();
  • Type: java.lang.String
portRequired 
public java.lang.Number getPort();
  • Type: java.lang.Number
internalValueOptional 
public IResolvable|HealthcheckHttpConfig getInternalValue();

HealthcheckTcpConfigOutputReference

Initializers 

import com.hashicorp.cdktf.providers.cloudflare.healthcheck.HealthcheckTcpConfigOutputReference;

new HealthcheckTcpConfigOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetMethod No description.
resetPort No description.
computeFqn 
public java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetMethod 
public void resetMethod()
resetPort 
public void resetPort()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
methodInput java.lang.String No description.
portInput java.lang.Number No description.
method java.lang.String No description.
port java.lang.Number No description.
internalValue com.hashicorp.cdktf.IResolvable|HealthcheckTcpConfig No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
methodInputOptional 
public java.lang.String getMethodInput();
  • Type: java.lang.String
portInputOptional 
public java.lang.Number getPortInput();
  • Type: java.lang.Number
methodRequired 
public java.lang.String getMethod();
  • Type: java.lang.String
portRequired 
public java.lang.Number getPort();
  • Type: java.lang.Number
internalValueOptional 
public IResolvable|HealthcheckTcpConfig getInternalValue();