loadBalancerMonitor.typescript.md

loadBalancerMonitor Submodule

Constructs

LoadBalancerMonitor

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/load_balancer_monitor cloudflare_load_balancer_monitor}.

Initializers

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

new loadBalancerMonitor.LoadBalancerMonitor(scope: Construct, id: string, config: LoadBalancerMonitorConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	LoadBalancerMonitorConfig	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: LoadBalancerMonitorConfig

---

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".
putHeader	No description.
resetAllowInsecure	No description.
resetConsecutiveDown	No description.
resetConsecutiveUp	No description.
resetDescription	No description.
resetExpectedBody	No description.
resetExpectedCodes	No description.
resetFollowRedirects	No description.
resetHeader	No description.
resetId	No description.
resetInterval	No description.
resetMethod	No description.
resetPath	No description.
resetPort	No description.
resetProbeZone	No description.
resetRetries	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".

---

putHeader

public putHeader(value: IResolvable | LoadBalancerMonitorHeader[]): void

value^Required

• Type: cdktf.IResolvable | LoadBalancerMonitorHeader[]

---

resetAllowInsecure

public resetAllowInsecure(): void

resetConsecutiveDown

public resetConsecutiveDown(): void

resetConsecutiveUp

public resetConsecutiveUp(): void

resetDescription

public resetDescription(): void

resetExpectedBody

public resetExpectedBody(): void

resetExpectedCodes

public resetExpectedCodes(): void

resetFollowRedirects

public resetFollowRedirects(): void

resetHeader

public resetHeader(): void

resetId

public resetId(): void

resetInterval

public resetInterval(): void

resetMethod

public resetMethod(): void

resetPath

public resetPath(): void

resetPort

public resetPort(): void

resetProbeZone

public resetProbeZone(): void

resetRetries

public resetRetries(): 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 LoadBalancerMonitor resource upon running "cdktf plan ".

---

isConstruct

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

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

loadBalancerMonitor.LoadBalancerMonitor.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

loadBalancerMonitor.LoadBalancerMonitor.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

loadBalancerMonitor.LoadBalancerMonitor.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a LoadBalancerMonitor 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 LoadBalancerMonitor to import.

---

importFromId^Required

• Type: string

The id of the existing LoadBalancerMonitor that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/load_balancer_monitor#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 LoadBalancerMonitor 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.
header	LoadBalancerMonitorHeaderList	No description.
modifiedOn	string	No description.
accountIdInput	string	No description.
allowInsecureInput	boolean | cdktf.IResolvable	No description.
consecutiveDownInput	number	No description.
consecutiveUpInput	number	No description.
descriptionInput	string	No description.
expectedBodyInput	string	No description.
expectedCodesInput	string	No description.
followRedirectsInput	boolean | cdktf.IResolvable	No description.
headerInput	cdktf.IResolvable | LoadBalancerMonitorHeader[]	No description.
idInput	string	No description.
intervalInput	number	No description.
methodInput	string	No description.
pathInput	string	No description.
portInput	number	No description.
probeZoneInput	string	No description.
retriesInput	number	No description.
timeoutInput	number	No description.
typeInput	string	No description.
accountId	string	No description.
allowInsecure	boolean | cdktf.IResolvable	No description.
consecutiveDown	number	No description.
consecutiveUp	number	No description.
description	string	No description.
expectedBody	string	No description.
expectedCodes	string	No description.
followRedirects	boolean | cdktf.IResolvable	No description.
id	string	No description.
interval	number	No description.
method	string	No description.
path	string	No description.
port	number	No description.
probeZone	string	No description.
retries	number	No description.
timeout	number	No description.
type	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

---

header^Required

public readonly header: LoadBalancerMonitorHeaderList;

• Type: LoadBalancerMonitorHeaderList

---

modifiedOn^Required

public readonly modifiedOn: string;

• Type: string

---

accountIdInput^Optional

public readonly accountIdInput: string;

• Type: string

---

allowInsecureInput^Optional

public readonly allowInsecureInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

consecutiveDownInput^Optional

public readonly consecutiveDownInput: number;

• Type: number

---

consecutiveUpInput^Optional

public readonly consecutiveUpInput: number;

• Type: number

---

descriptionInput^Optional

public readonly descriptionInput: string;

• Type: string

---

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 | LoadBalancerMonitorHeader[];

• Type: cdktf.IResolvable | LoadBalancerMonitorHeader[]

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

intervalInput^Optional

public readonly intervalInput: number;

• Type: number

---

methodInput^Optional

public readonly methodInput: string;

• Type: string

---

pathInput^Optional

public readonly pathInput: string;

• Type: string

---

portInput^Optional

public readonly portInput: number;

• Type: number

---

probeZoneInput^Optional

public readonly probeZoneInput: string;

• Type: string

---

retriesInput^Optional

public readonly retriesInput: number;

• Type: number

---

timeoutInput^Optional

public readonly timeoutInput: number;

• Type: number

---

typeInput^Optional

public readonly typeInput: string;

• Type: string

---

accountId^Required

public readonly accountId: string;

• Type: string

---

allowInsecure^Required

public readonly allowInsecure: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

consecutiveDown^Required

public readonly consecutiveDown: number;

• Type: number

---

consecutiveUp^Required

public readonly consecutiveUp: number;

• Type: number

---

description^Required

public readonly description: string;

• Type: string

---

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

---

id^Required

public readonly id: string;

• Type: string

---

interval^Required

public readonly interval: number;

• Type: number

---

method^Required

public readonly method: string;

• Type: string

---

path^Required

public readonly path: string;

• Type: string

---

port^Required

public readonly port: number;

• Type: number

---

probeZone^Required

public readonly probeZone: string;

• Type: string

---

retries^Required

public readonly retries: number;

• Type: number

---

timeout^Required

public readonly timeout: number;

• Type: number

---

type^Required

public readonly type: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

LoadBalancerMonitorConfig

Initializer

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

const loadBalancerMonitorConfig: loadBalancerMonitor.LoadBalancerMonitorConfig = { ... }

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.
accountId	string	The account identifier to target for the resource.
allowInsecure	boolean | cdktf.IResolvable	Do not validate the certificate when monitor use HTTPS. Only valid if type is "http" or "https".
consecutiveDown	number	To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to 0.
consecutiveUp	number	To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to 0.
description	string	Free text description.
expectedBody	string	A case-insensitive sub-string to look for in the response body.
expectedCodes	string	The expected HTTP response code or code range of the health check.
followRedirects	boolean | cdktf.IResolvable	Follow redirects if returned by the origin. Only valid if type is "http" or "https".
header	cdktf.IResolvable | LoadBalancerMonitorHeader[]	header block.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/load_balancer_monitor#id LoadBalancerMonitor#id}.
interval	number	The interval between each health check.
method	string	The method to use for the health check.
path	string	The endpoint path to health check against.
port	number	The port number to use for the healthcheck, required when creating a TCP monitor.
probeZone	string	Assign this monitor to emulate the specified zone while probing. Only valid if type is "http" or "https".
retries	number	The number of retries to attempt in case of a timeout before marking the origin as unhealthy.
timeout	number	The timeout (in seconds) before marking the health check as failed. Defaults to 5.
type	string	The protocol to use for the healthcheck. Available values: http, https, tcp, udp_icmp, icmp_ping, smtp. Defaults to http.

---

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[]

---

accountId^Required

public readonly accountId: string;

• Type: string

The account identifier to target for the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/load_balancer_monitor#account_id LoadBalancerMonitor#account_id}

---

allowInsecure^Optional

public readonly allowInsecure: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Do not validate the certificate when monitor use HTTPS. Only valid if type is "http" or "https".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/load_balancer_monitor#allow_insecure LoadBalancerMonitor#allow_insecure}

---

consecutiveDown^Optional

public readonly consecutiveDown: number;

• Type: number

To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to 0.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/load_balancer_monitor#consecutive_down LoadBalancerMonitor#consecutive_down}

---

consecutiveUp^Optional

public readonly consecutiveUp: number;

• Type: number

To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to 0.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/load_balancer_monitor#consecutive_up LoadBalancerMonitor#consecutive_up}

---

description^Optional

public readonly description: string;

• Type: string

Free text description.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/load_balancer_monitor#description LoadBalancerMonitor#description}

---

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. Only valid if type is "http" or "https".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/load_balancer_monitor#expected_body LoadBalancerMonitor#expected_body}

---

expectedCodes^Optional

public readonly expectedCodes: string;

• Type: string

The expected HTTP response code or code range of the health check.

Eg 2xx. Only valid and required if type is "http" or "https".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/load_balancer_monitor#expected_codes LoadBalancerMonitor#expected_codes}

---

followRedirects^Optional

public readonly followRedirects: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Follow redirects if returned by the origin. Only valid if type is "http" or "https".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/load_balancer_monitor#follow_redirects LoadBalancerMonitor#follow_redirects}

---

header^Optional

public readonly header: IResolvable | LoadBalancerMonitorHeader[];

• Type: cdktf.IResolvable | LoadBalancerMonitorHeader[]

header block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/load_balancer_monitor#header LoadBalancerMonitor#header}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/load_balancer_monitor#id LoadBalancerMonitor#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

---

interval^Optional

public readonly interval: number;

• Type: number

The interval between each health check.

Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations. Defaults to 60.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/load_balancer_monitor#interval LoadBalancerMonitor#interval}

---

method^Optional

public readonly method: string;

• Type: string

The method to use for the health check.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/load_balancer_monitor#method LoadBalancerMonitor#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/4.34.0/docs/resources/load_balancer_monitor#path LoadBalancerMonitor#path}

---

port^Optional

public readonly port: number;

• Type: number

The port number to use for the healthcheck, required when creating a TCP monitor.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/load_balancer_monitor#port LoadBalancerMonitor#port}

---

probeZone^Optional

public readonly probeZone: string;

• Type: string

Assign this monitor to emulate the specified zone while probing. Only valid if type is "http" or "https".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/load_balancer_monitor#probe_zone LoadBalancerMonitor#probe_zone}

---

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. Defaults to 2.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/load_balancer_monitor#retries LoadBalancerMonitor#retries}

---

timeout^Optional

public readonly timeout: number;

• Type: number

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/load_balancer_monitor#timeout LoadBalancerMonitor#timeout}

---

type^Optional

public readonly type: string;

• Type: string

The protocol to use for the healthcheck. Available values: http, https, tcp, udp_icmp, icmp_ping, smtp. Defaults to http.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/load_balancer_monitor#type LoadBalancerMonitor#type}

---

LoadBalancerMonitorHeader

Initializer

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

const loadBalancerMonitorHeader: loadBalancerMonitor.LoadBalancerMonitorHeader = { ... }

Properties

Name	Type	Description
header	string	The header name.
values	string[]	A list of values for the header.

---

header^Required

public readonly header: string;

• Type: string

The header name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/load_balancer_monitor#header LoadBalancerMonitor#header}

---

values^Required

public readonly values: string[];

• Type: string[]

A list of values for the header.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/load_balancer_monitor#values LoadBalancerMonitor#values}

---

Classes

LoadBalancerMonitorHeaderList

Initializers

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

new loadBalancerMonitor.LoadBalancerMonitorHeaderList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
wrapsSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

wrapsSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

Methods

Name	Description
allWithMapKey	Creating an iterator for this complex list.
computeFqn	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
get	No description.

---

allWithMapKey

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeName^Required

• Type: string

---

computeFqn

public computeFqn(): 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.

get

public get(index: number): LoadBalancerMonitorHeaderOutputReference

index^Required

• Type: number

the index of the item to return.

---

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.
internalValue	cdktf.IResolvable | LoadBalancerMonitorHeader[]	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

---

internalValue^Optional

public readonly internalValue: IResolvable | LoadBalancerMonitorHeader[];

• Type: cdktf.IResolvable | LoadBalancerMonitorHeader[]

---

LoadBalancerMonitorHeaderOutputReference

Initializers

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

new loadBalancerMonitor.LoadBalancerMonitorHeaderOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
complexObjectIndex	number	the index of this item in the list.
complexObjectIsFromSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

complexObjectIndex^Required

• Type: number

the index of this item in the list.

---

complexObjectIsFromSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

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.

---

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.

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.
headerInput	string	No description.
valuesInput	string[]	No description.
header	string	No description.
values	string[]	No description.
internalValue	cdktf.IResolvable | LoadBalancerMonitorHeader	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

---

headerInput^Optional

public readonly headerInput: string;

• Type: string

---

valuesInput^Optional

public readonly valuesInput: string[];

• Type: string[]

---

header^Required

public readonly header: string;

• Type: string

---

values^Required

public readonly values: string[];

• Type: string[]

---

internalValue^Optional

public readonly internalValue: IResolvable | LoadBalancerMonitorHeader;

• Type: cdktf.IResolvable | LoadBalancerMonitorHeader

---