`healthcheck` Submodule

Constructs

Healthcheck

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

Initializers

import { healthcheck } from '@cdktf/provider-cloudflare'

new healthcheck.Healthcheck(scope: Construct, id: string, config: HealthcheckConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`HealthcheckConfig`	No description.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Required

Type: HealthcheckConfig

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 toString(): string

Returns a string representation of this construct.

`addOverride`

public addOverride(path: string, value: any): void

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

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

`newLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public resetOverrideLogicalId(): void

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

`toHclTerraform`

public toHclTerraform(): any

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

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

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

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.

`id`^Required

Type: string

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

`moveTo`

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: string

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

`index`^Optional

Type: string | number

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

`moveToId`

public moveToId(id: string): void

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

`id`^Required

Type: string

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

`putHttpConfig`

public putHttpConfig(value: HealthcheckHttpConfig): void

`value`^Required

Type: HealthcheckHttpConfig

`putTcpConfig`

public putTcpConfig(value: HealthcheckTcpConfig): void

`value`^Required

Type: HealthcheckTcpConfig

`resetCheckRegions`

public resetCheckRegions(): void

`resetConsecutiveFails`

public resetConsecutiveFails(): void

`resetConsecutiveSuccesses`

public resetConsecutiveSuccesses(): void

`resetDescription`

public resetDescription(): void

`resetHttpConfig`

public resetHttpConfig(): void

`resetInterval`

public resetInterval(): void

`resetRetries`

public resetRetries(): void

`resetSuspended`

public resetSuspended(): void

`resetTcpConfig`

public resetTcpConfig(): void

`resetTimeout`

public resetTimeout(): void

`resetType`

public resetType(): void

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 { healthcheck } from '@cdktf/provider-cloudflare'

healthcheck.Healthcheck.isConstruct(x: any)

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.

`x`^Required

Type: any

Any object.

`isTerraformElement`

import { healthcheck } from '@cdktf/provider-cloudflare'

healthcheck.Healthcheck.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { healthcheck } from '@cdktf/provider-cloudflare'

healthcheck.Healthcheck.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { healthcheck } from '@cdktf/provider-cloudflare'

healthcheck.Healthcheck.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

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

`importFromId`^Required

Type: 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

`provider`^Optional

Type: cdktf.TerraformProvider

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

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktfStack`	`cdktf.TerraformStack`	No description.
`fqn`	`string`	No description.
`friendlyUniqueId`	`string`	No description.
`terraformMetaArguments`	`{[ key: string ]: any}`	No description.
`terraformResourceType`	`string`	No description.
`terraformGeneratorMetadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`string[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`createdOn`	`string`	No description.
`failureReason`	`string`	No description.
`httpConfig`	`HealthcheckHttpConfigOutputReference`	No description.
`id`	`string`	No description.
`modifiedOn`	`string`	No description.
`status`	`string`	No description.
`tcpConfig`	`HealthcheckTcpConfigOutputReference`	No description.
`addressInput`	`string`	No description.
`checkRegionsInput`	`string[]`	No description.
`consecutiveFailsInput`	`number`	No description.
`consecutiveSuccessesInput`	`number`	No description.
`descriptionInput`	`string`	No description.
`httpConfigInput`	`cdktf.IResolvable \| HealthcheckHttpConfig`	No description.
`intervalInput`	`number`	No description.
`nameInput`	`string`	No description.
`retriesInput`	`number`	No description.
`suspendedInput`	`boolean \| cdktf.IResolvable`	No description.
`tcpConfigInput`	`cdktf.IResolvable \| HealthcheckTcpConfig`	No description.
`timeoutInput`	`number`	No description.
`typeInput`	`string`	No description.
`zoneIdInput`	`string`	No description.
`address`	`string`	No description.
`checkRegions`	`string[]`	No description.
`consecutiveFails`	`number`	No description.
`consecutiveSuccesses`	`number`	No description.
`description`	`string`	No description.
`interval`	`number`	No description.
`name`	`string`	No description.
`retries`	`number`	No description.
`suspended`	`boolean \| cdktf.IResolvable`	No description.
`timeout`	`number`	No description.
`type`	`string`	No description.
`zoneId`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktf.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`createdOn`^Required

public readonly createdOn: string;

Type: string

`failureReason`^Required

public readonly failureReason: string;

Type: string

`httpConfig`^Required

public readonly httpConfig: HealthcheckHttpConfigOutputReference;

Type: HealthcheckHttpConfigOutputReference

`id`^Required

public readonly id: string;

Type: string

`modifiedOn`^Required

public readonly modifiedOn: string;

Type: string

`status`^Required

public readonly status: string;

Type: string

`tcpConfig`^Required

public readonly tcpConfig: HealthcheckTcpConfigOutputReference;

Type: HealthcheckTcpConfigOutputReference

`addressInput`^Optional

public readonly addressInput: string;

Type: string

`checkRegionsInput`^Optional

public readonly checkRegionsInput: string[];

Type: string[]

`consecutiveFailsInput`^Optional

public readonly consecutiveFailsInput: number;

Type: number

`consecutiveSuccessesInput`^Optional

public readonly consecutiveSuccessesInput: number;

Type: number

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`httpConfigInput`^Optional

public readonly httpConfigInput: IResolvable | HealthcheckHttpConfig;

Type: cdktf.IResolvable | HealthcheckHttpConfig

`intervalInput`^Optional

public readonly intervalInput: number;

Type: number

`nameInput`^Optional

public readonly nameInput: string;

Type: string

`retriesInput`^Optional

public readonly retriesInput: number;

Type: number

`suspendedInput`^Optional

public readonly suspendedInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`tcpConfigInput`^Optional

public readonly tcpConfigInput: IResolvable | HealthcheckTcpConfig;

Type: cdktf.IResolvable | HealthcheckTcpConfig

`timeoutInput`^Optional

public readonly timeoutInput: number;

Type: number

`typeInput`^Optional

public readonly typeInput: string;

Type: string

`zoneIdInput`^Optional

public readonly zoneIdInput: string;

Type: string

`address`^Required

public readonly address: string;

Type: string

`checkRegions`^Required

public readonly checkRegions: string[];

Type: string[]

`consecutiveFails`^Required

public readonly consecutiveFails: number;

Type: number

`consecutiveSuccesses`^Required

public readonly consecutiveSuccesses: number;

Type: number

`description`^Required

public readonly description: string;

Type: string

`interval`^Required

public readonly interval: number;

Type: number

`name`^Required

public readonly name: string;

Type: string

`retries`^Required

public readonly retries: number;

Type: number

`suspended`^Required

public readonly suspended: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`timeout`^Required

public readonly timeout: number;

Type: number

`type`^Required

public readonly type: string;

Type: string

`zoneId`^Required

public readonly zoneId: string;

Type: string

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

HealthcheckConfig

Initializer

import { healthcheck } from '@cdktf/provider-cloudflare'

const healthcheckConfig: healthcheck.HealthcheckConfig = { ... }

Properties

Name	Type	Description
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`cdktf.ITerraformDependable[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`address`	`string`	The hostname or IP address of the origin server to run health checks on.
`name`	`string`	A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.
`zoneId`	`string`	Identifier.
`checkRegions`	`string[]`	A list of regions from which to run health checks. Null means Cloudflare will pick a default region.
`consecutiveFails`	`number`	The number of consecutive fails required from a health check before changing the health to unhealthy.
`consecutiveSuccesses`	`number`	The number of consecutive successes required from a health check before changing the health to healthy.
`description`	`string`	A human-readable description of the health check.
`httpConfig`	`HealthcheckHttpConfig`	Parameters specific to an HTTP or HTTPS health check.
`interval`	`number`	The interval between each health check.
`retries`	`number`	The number of retries to attempt in case of a timeout before marking the origin as unhealthy.
`suspended`	`boolean \| cdktf.IResolvable`	If suspended, no health checks are sent to the origin.
`tcpConfig`	`HealthcheckTcpConfig`	Parameters specific to TCP health check.
`timeout`	`number`	The timeout (in seconds) before marking the health check as failed.
`type`	`string`	The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktf.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`address`^Required

public readonly address: string;

Type: 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}

`name`^Required

public readonly name: string;

Type: 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}

`zoneId`^Required

public readonly zoneId: string;

Type: 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}

`checkRegions`^Optional

public readonly checkRegions: string[];

Type: 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}

`consecutiveFails`^Optional

public readonly consecutiveFails: number;

Type: 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}

`consecutiveSuccesses`^Optional

public readonly consecutiveSuccesses: number;

Type: 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}

`description`^Optional

public readonly description: string;

Type: 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}

`httpConfig`^Optional

public readonly httpConfig: HealthcheckHttpConfig;

Type: HealthcheckHttpConfig

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}

`interval`^Optional

public readonly interval: number;

Type: 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}

`retries`^Optional

public readonly retries: number;

Type: 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}

`suspended`^Optional

public readonly suspended: boolean | IResolvable;

Type: boolean | 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}

`tcpConfig`^Optional

public readonly tcpConfig: HealthcheckTcpConfig;

Type: HealthcheckTcpConfig

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}

`timeout`^Optional

public readonly timeout: number;

Type: 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}

`type`^Optional

public readonly type: string;

Type: 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 { healthcheck } from '@cdktf/provider-cloudflare'

const healthcheckHttpConfig: healthcheck.HealthcheckHttpConfig = { ... }

Properties

Name	Type	Description
`allowInsecure`	`boolean \| cdktf.IResolvable`	Do not validate the certificate when the health check uses HTTPS.
`expectedBody`	`string`	A case-insensitive sub-string to look for in the response body.
`expectedCodes`	`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`	`boolean \| cdktf.IResolvable`	Follow redirects if the origin returns a 3xx status code.
`header`	`cdktf.IResolvable \| {[ key: string ]: string[]}`	The HTTP request headers to send in the health check.
`method`	`string`	The HTTP method to use for the health check. Available values: "GET", "HEAD".
`path`	`string`	The endpoint path to health check against.
`port`	`number`	Port number to connect to for the health check.

`allowInsecure`^Optional

public readonly allowInsecure: boolean | IResolvable;

Type: boolean | 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}

`expectedBody`^Optional

public readonly expectedBody: string;

Type: 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}

`expectedCodes`^Optional

public readonly expectedCodes: string[];

Type: 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}

`followRedirects`^Optional

public readonly followRedirects: boolean | IResolvable;

Type: boolean | 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}

`header`^Optional

public readonly header: IResolvable | {[ key: string ]: string[]};

Type: cdktf.IResolvable | {[ key: string ]: 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}

`method`^Optional

public readonly method: string;

Type: 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}

`path`^Optional

public readonly path: string;

Type: 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}

`port`^Optional

public readonly port: number;

Type: 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 { healthcheck } from '@cdktf/provider-cloudflare'

const healthcheckTcpConfig: healthcheck.HealthcheckTcpConfig = { ... }

Properties

Name	Type	Description
`method`	`string`	The TCP connection method to use for the health check. Available values: "connection_established".
`port`	`number`	Port number to connect to for the health check. Defaults to 80.

`method`^Optional

public readonly method: string;

Type: 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}

`port`^Optional

public readonly port: number;

Type: 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 { healthcheck } from '@cdktf/provider-cloudflare'

new healthcheck.HealthcheckHttpConfigOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: 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 computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetAllowInsecure`

public resetAllowInsecure(): void

`resetExpectedBody`

public resetExpectedBody(): void

`resetExpectedCodes`

public resetExpectedCodes(): void

`resetFollowRedirects`

public resetFollowRedirects(): void

`resetHeader`

public resetHeader(): void

`resetMethod`

public resetMethod(): void

`resetPath`

public resetPath(): void

`resetPort`

public resetPort(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`allowInsecureInput`	`boolean \| cdktf.IResolvable`	No description.
`expectedBodyInput`	`string`	No description.
`expectedCodesInput`	`string[]`	No description.
`followRedirectsInput`	`boolean \| cdktf.IResolvable`	No description.
`headerInput`	`cdktf.IResolvable \| {[ key: string ]: string[]}`	No description.
`methodInput`	`string`	No description.
`pathInput`	`string`	No description.
`portInput`	`number`	No description.
`allowInsecure`	`boolean \| cdktf.IResolvable`	No description.
`expectedBody`	`string`	No description.
`expectedCodes`	`string[]`	No description.
`followRedirects`	`boolean \| cdktf.IResolvable`	No description.
`header`	`cdktf.IResolvable \| {[ key: string ]: string[]}`	No description.
`method`	`string`	No description.
`path`	`string`	No description.
`port`	`number`	No description.
`internalValue`	`cdktf.IResolvable \| HealthcheckHttpConfig`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: 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.

`fqn`^Required

public readonly fqn: string;

Type: string

`allowInsecureInput`^Optional

public readonly allowInsecureInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`expectedBodyInput`^Optional

public readonly expectedBodyInput: string;

Type: string

`expectedCodesInput`^Optional

public readonly expectedCodesInput: string[];

Type: string[]

`followRedirectsInput`^Optional

public readonly followRedirectsInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`headerInput`^Optional

public readonly headerInput: IResolvable | {[ key: string ]: string[]};

Type: cdktf.IResolvable | {[ key: string ]: string[]}

`methodInput`^Optional

public readonly methodInput: string;

Type: string

`pathInput`^Optional

public readonly pathInput: string;

Type: string

`portInput`^Optional

public readonly portInput: number;

Type: number

`allowInsecure`^Required

public readonly allowInsecure: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`expectedBody`^Required

public readonly expectedBody: string;

Type: string

`expectedCodes`^Required

public readonly expectedCodes: string[];

Type: string[]

`followRedirects`^Required

public readonly followRedirects: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`header`^Required

public readonly header: IResolvable | {[ key: string ]: string[]};

Type: cdktf.IResolvable | {[ key: string ]: string[]}

`method`^Required

public readonly method: string;

Type: string

`path`^Required

public readonly path: string;

Type: string

`port`^Required

public readonly port: number;

Type: number

`internalValue`^Optional

public readonly internalValue: IResolvable | HealthcheckHttpConfig;

Type: cdktf.IResolvable | HealthcheckHttpConfig

HealthcheckTcpConfigOutputReference

Initializers

import { healthcheck } from '@cdktf/provider-cloudflare'

new healthcheck.HealthcheckTcpConfigOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: 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 computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetMethod`

public resetMethod(): void

`resetPort`

public resetPort(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`methodInput`	`string`	No description.
`portInput`	`number`	No description.
`method`	`string`	No description.
`port`	`number`	No description.
`internalValue`	`cdktf.IResolvable \| HealthcheckTcpConfig`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: 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.

`fqn`^Required

public readonly fqn: string;

Type: string

`methodInput`^Optional

public readonly methodInput: string;

Type: string

`portInput`^Optional

public readonly portInput: number;

Type: number

`method`^Required

public readonly method: string;

Type: string

`port`^Required

public readonly port: number;

Type: number

`internalValue`^Optional

public readonly internalValue: IResolvable | HealthcheckTcpConfig;

Type: cdktf.IResolvable | HealthcheckTcpConfig

Uh oh!

FilesExpand file tree

healthcheck.typescript.md

Latest commit

History

healthcheck.typescript.md

File metadata and controls

healthcheck Submodule

Constructs

Healthcheck

Initializers

scopeRequired

idRequired

configRequired

Methods

toString

addOverride

pathRequired

valueRequired

overrideLogicalId

newLogicalIdRequired

resetOverrideLogicalId

toHclTerraform

toMetadata

toTerraform

addMoveTarget

moveTargetRequired

getAnyMapAttribute

terraformAttributeRequired

getBooleanAttribute

terraformAttributeRequired

getBooleanMapAttribute

terraformAttributeRequired

getListAttribute

terraformAttributeRequired

getNumberAttribute

terraformAttributeRequired

getNumberListAttribute

terraformAttributeRequired

getNumberMapAttribute

terraformAttributeRequired

getStringAttribute

terraformAttributeRequired

getStringMapAttribute

terraformAttributeRequired

hasResourceMove

importFrom

idRequired

providerOptional

interpolationForAttribute

terraformAttributeRequired

moveFromId

idRequired

moveTo

moveTargetRequired

indexOptional

moveToId

idRequired

putHttpConfig

valueRequired

putTcpConfig

valueRequired

resetCheckRegions

resetConsecutiveFails

resetConsecutiveSuccesses

resetDescription

resetHttpConfig

resetInterval

resetRetries

resetSuspended

resetTcpConfig

resetTimeout

resetType

Static Functions

isConstruct

xRequired

isTerraformElement

xRequired

isTerraformResource

xRequired

`healthcheck` Submodule

`scope`^Required

`id`^Required

`config`^Required

`toString`

`addOverride`

`path`^Required

`value`^Required

`overrideLogicalId`

`newLogicalId`^Required

`resetOverrideLogicalId`

`toHclTerraform`

`toMetadata`

`toTerraform`

`addMoveTarget`

`moveTarget`^Required

`getAnyMapAttribute`

`terraformAttribute`^Required

`getBooleanAttribute`

`terraformAttribute`^Required

`getBooleanMapAttribute`

`terraformAttribute`^Required

`getListAttribute`

`terraformAttribute`^Required

`getNumberAttribute`

`terraformAttribute`^Required

`getNumberListAttribute`

`terraformAttribute`^Required

`getNumberMapAttribute`

`terraformAttribute`^Required

`getStringAttribute`

`terraformAttribute`^Required

`getStringMapAttribute`

`terraformAttribute`^Required

`hasResourceMove`

`importFrom`

`id`^Required

`provider`^Optional

`interpolationForAttribute`

`terraformAttribute`^Required

`moveFromId`

`id`^Required

`moveTo`

`moveTarget`^Required

`index`^Optional

`moveToId`

`id`^Required

`putHttpConfig`

`value`^Required

`putTcpConfig`

`value`^Required

`resetCheckRegions`

`resetConsecutiveFails`

`resetConsecutiveSuccesses`

`resetDescription`

`resetHttpConfig`

`resetInterval`

`resetRetries`

`resetSuspended`

`resetTcpConfig`

`resetTimeout`

`resetType`

`isConstruct`

`x`^Required

`isTerraformElement`

`x`^Required

`isTerraformResource`

`x`^Required

`generateConfigForImport`

`scope`^Required

`importToId`^Required

`importFromId`^Required

`provider`^Optional

`node`^Required

`cdktfStack`^Required

`fqn`^Required

`friendlyUniqueId`^Required

`terraformMetaArguments`^Required

`terraformResourceType`^Required

`terraformGeneratorMetadata`^Optional