Skip to content

Latest commit

 

History

History
2671 lines (1668 loc) · 112 KB

lbTargetGroup.md

File metadata and controls

2671 lines (1668 loc) · 112 KB

lbTargetGroup Submodule

Constructs

LbTargetGroup

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group aws_lb_target_group}.

Initializers

import { lbTargetGroup } from '@cdktf/aws-cdk'

new lbTargetGroup.LbTargetGroup(scope: Construct, id: string, config?: LbTargetGroupConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config LbTargetGroupConfig No description.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configOptional

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".
putHealthCheck No description.
putStickiness No description.
resetConnectionTermination No description.
resetDeregistrationDelay No description.
resetHealthCheck No description.
resetId No description.
resetLambdaMultiValueHeadersEnabled No description.
resetLoadBalancingAlgorithmType No description.
resetName No description.
resetNamePrefix No description.
resetPort No description.
resetPreserveClientIp No description.
resetProtocol No description.
resetProtocolVersion No description.
resetProxyProtocolV2 No description.
resetSlowStart No description.
resetStickiness No description.
resetTags No description.
resetTagsAll No description.
resetTargetType No description.
resetVpcId No description.

toString
public toString(): string

Returns a string representation of this construct.

addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • 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.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


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

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

hasResourceMove
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string

providerOptional
  • Type: cdktf.TerraformProvider

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • 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.

idRequired
  • 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.

moveTargetRequired
  • Type: string

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


indexOptional
  • 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".

idRequired
  • Type: string

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


putHealthCheck
public putHealthCheck(value: LbTargetGroupHealthCheck): void
valueRequired

putStickiness
public putStickiness(value: LbTargetGroupStickiness): void
valueRequired

resetConnectionTermination
public resetConnectionTermination(): void
resetDeregistrationDelay
public resetDeregistrationDelay(): void
resetHealthCheck
public resetHealthCheck(): void
resetId
public resetId(): void
resetLambdaMultiValueHeadersEnabled
public resetLambdaMultiValueHeadersEnabled(): void
resetLoadBalancingAlgorithmType
public resetLoadBalancingAlgorithmType(): void
resetName
public resetName(): void
resetNamePrefix
public resetNamePrefix(): void
resetPort
public resetPort(): void
resetPreserveClientIp
public resetPreserveClientIp(): void
resetProtocol
public resetProtocol(): void
resetProtocolVersion
public resetProtocolVersion(): void
resetProxyProtocolV2
public resetProxyProtocolV2(): void
resetSlowStart
public resetSlowStart(): void
resetStickiness
public resetStickiness(): void
resetTags
public resetTags(): void
resetTagsAll
public resetTagsAll(): void
resetTargetType
public resetTargetType(): void
resetVpcId
public resetVpcId(): 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 LbTargetGroup resource upon running "cdktf plan ".

isConstruct
import { lbTargetGroup } from '@cdktf/aws-cdk'

lbTargetGroup.LbTargetGroup.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.


isTerraformElement
import { lbTargetGroup } from '@cdktf/aws-cdk'

lbTargetGroup.LbTargetGroup.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { lbTargetGroup } from '@cdktf/aws-cdk'

lbTargetGroup.LbTargetGroup.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { lbTargetGroup } from '@cdktf/aws-cdk'

lbTargetGroup.LbTargetGroup.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: string

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


importFromIdRequired
  • Type: string

The id of the existing LbTargetGroup that should be imported.

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


providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the LbTargetGroup 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.
arn string No description.
arnSuffix string No description.
healthCheck LbTargetGroupHealthCheckOutputReference No description.
stickiness LbTargetGroupStickinessOutputReference No description.
connectionTerminationInput boolean | cdktf.IResolvable No description.
deregistrationDelayInput string No description.
healthCheckInput LbTargetGroupHealthCheck No description.
idInput string No description.
lambdaMultiValueHeadersEnabledInput boolean | cdktf.IResolvable No description.
loadBalancingAlgorithmTypeInput string No description.
nameInput string No description.
namePrefixInput string No description.
portInput number No description.
preserveClientIpInput string No description.
protocolInput string No description.
protocolVersionInput string No description.
proxyProtocolV2Input boolean | cdktf.IResolvable No description.
slowStartInput number No description.
stickinessInput LbTargetGroupStickiness No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
targetTypeInput string No description.
vpcIdInput string No description.
connectionTermination boolean | cdktf.IResolvable No description.
deregistrationDelay string No description.
id string No description.
lambdaMultiValueHeadersEnabled boolean | cdktf.IResolvable No description.
loadBalancingAlgorithmType string No description.
name string No description.
namePrefix string No description.
port number No description.
preserveClientIp string No description.
protocol string No description.
protocolVersion string No description.
proxyProtocolV2 boolean | cdktf.IResolvable No description.
slowStart number No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: string} No description.
targetType string No description.
vpcId string No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

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

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

arnRequired
public readonly arn: string;
  • Type: string

arnSuffixRequired
public readonly arnSuffix: string;
  • Type: string

healthCheckRequired
public readonly healthCheck: LbTargetGroupHealthCheckOutputReference;

stickinessRequired
public readonly stickiness: LbTargetGroupStickinessOutputReference;

connectionTerminationInputOptional
public readonly connectionTerminationInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

deregistrationDelayInputOptional
public readonly deregistrationDelayInput: string;
  • Type: string

healthCheckInputOptional
public readonly healthCheckInput: LbTargetGroupHealthCheck;

idInputOptional
public readonly idInput: string;
  • Type: string

lambdaMultiValueHeadersEnabledInputOptional
public readonly lambdaMultiValueHeadersEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

loadBalancingAlgorithmTypeInputOptional
public readonly loadBalancingAlgorithmTypeInput: string;
  • Type: string

nameInputOptional
public readonly nameInput: string;
  • Type: string

namePrefixInputOptional
public readonly namePrefixInput: string;
  • Type: string

portInputOptional
public readonly portInput: number;
  • Type: number

preserveClientIpInputOptional
public readonly preserveClientIpInput: string;
  • Type: string

protocolInputOptional
public readonly protocolInput: string;
  • Type: string

protocolVersionInputOptional
public readonly protocolVersionInput: string;
  • Type: string

proxyProtocolV2InputOptional
public readonly proxyProtocolV2Input: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

slowStartInputOptional
public readonly slowStartInput: number;
  • Type: number

stickinessInputOptional
public readonly stickinessInput: LbTargetGroupStickiness;

tagsAllInputOptional
public readonly tagsAllInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

tagsInputOptional
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

targetTypeInputOptional
public readonly targetTypeInput: string;
  • Type: string

vpcIdInputOptional
public readonly vpcIdInput: string;
  • Type: string

connectionTerminationRequired
public readonly connectionTermination: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

deregistrationDelayRequired
public readonly deregistrationDelay: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

lambdaMultiValueHeadersEnabledRequired
public readonly lambdaMultiValueHeadersEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

loadBalancingAlgorithmTypeRequired
public readonly loadBalancingAlgorithmType: string;
  • Type: string

nameRequired
public readonly name: string;
  • Type: string

namePrefixRequired
public readonly namePrefix: string;
  • Type: string

portRequired
public readonly port: number;
  • Type: number

preserveClientIpRequired
public readonly preserveClientIp: string;
  • Type: string

protocolRequired
public readonly protocol: string;
  • Type: string

protocolVersionRequired
public readonly protocolVersion: string;
  • Type: string

proxyProtocolV2Required
public readonly proxyProtocolV2: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

slowStartRequired
public readonly slowStart: number;
  • Type: number

tagsRequired
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

tagsAllRequired
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

targetTypeRequired
public readonly targetType: string;
  • Type: string

vpcIdRequired
public readonly vpcId: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

LbTargetGroupConfig

Initializer

import { lbTargetGroup } from '@cdktf/aws-cdk'

const lbTargetGroupConfig: lbTargetGroup.LbTargetGroupConfig = { ... }

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.
connectionTermination boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#connection_termination LbTargetGroup#connection_termination}.
deregistrationDelay string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#deregistration_delay LbTargetGroup#deregistration_delay}.
healthCheck LbTargetGroupHealthCheck health_check block.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#id LbTargetGroup#id}.
lambdaMultiValueHeadersEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#lambda_multi_value_headers_enabled LbTargetGroup#lambda_multi_value_headers_enabled}.
loadBalancingAlgorithmType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#load_balancing_algorithm_type LbTargetGroup#load_balancing_algorithm_type}.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#name LbTargetGroup#name}.
namePrefix string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#name_prefix LbTargetGroup#name_prefix}.
port number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#port LbTargetGroup#port}.
preserveClientIp string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#preserve_client_ip LbTargetGroup#preserve_client_ip}.
protocol string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#protocol LbTargetGroup#protocol}.
protocolVersion string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#protocol_version LbTargetGroup#protocol_version}.
proxyProtocolV2 boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#proxy_protocol_v2 LbTargetGroup#proxy_protocol_v2}.
slowStart number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#slow_start LbTargetGroup#slow_start}.
stickiness LbTargetGroupStickiness stickiness block.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#tags LbTargetGroup#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#tags_all LbTargetGroup#tags_all}.
targetType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#target_type LbTargetGroup#target_type}.
vpcId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#vpc_id LbTargetGroup#vpc_id}.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

connectionTerminationOptional
public readonly connectionTermination: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#connection_termination LbTargetGroup#connection_termination}.


deregistrationDelayOptional
public readonly deregistrationDelay: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#deregistration_delay LbTargetGroup#deregistration_delay}.


healthCheckOptional
public readonly healthCheck: LbTargetGroupHealthCheck;

health_check block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#health_check LbTargetGroup#health_check}


idOptional
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#id LbTargetGroup#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.


lambdaMultiValueHeadersEnabledOptional
public readonly lambdaMultiValueHeadersEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#lambda_multi_value_headers_enabled LbTargetGroup#lambda_multi_value_headers_enabled}.


loadBalancingAlgorithmTypeOptional
public readonly loadBalancingAlgorithmType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#load_balancing_algorithm_type LbTargetGroup#load_balancing_algorithm_type}.


nameOptional
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#name LbTargetGroup#name}.


namePrefixOptional
public readonly namePrefix: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#name_prefix LbTargetGroup#name_prefix}.


portOptional
public readonly port: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#port LbTargetGroup#port}.


preserveClientIpOptional
public readonly preserveClientIp: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#preserve_client_ip LbTargetGroup#preserve_client_ip}.


protocolOptional
public readonly protocol: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#protocol LbTargetGroup#protocol}.


protocolVersionOptional
public readonly protocolVersion: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#protocol_version LbTargetGroup#protocol_version}.


proxyProtocolV2Optional
public readonly proxyProtocolV2: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#proxy_protocol_v2 LbTargetGroup#proxy_protocol_v2}.


slowStartOptional
public readonly slowStart: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#slow_start LbTargetGroup#slow_start}.


stickinessOptional
public readonly stickiness: LbTargetGroupStickiness;

stickiness block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#stickiness LbTargetGroup#stickiness}


tagsOptional
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#tags LbTargetGroup#tags}.


tagsAllOptional
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#tags_all LbTargetGroup#tags_all}.


targetTypeOptional
public readonly targetType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#target_type LbTargetGroup#target_type}.


vpcIdOptional
public readonly vpcId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#vpc_id LbTargetGroup#vpc_id}.


LbTargetGroupHealthCheck

Initializer

import { lbTargetGroup } from '@cdktf/aws-cdk'

const lbTargetGroupHealthCheck: lbTargetGroup.LbTargetGroupHealthCheck = { ... }

Properties

Name Type Description
enabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#enabled LbTargetGroup#enabled}.
healthyThreshold number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#healthy_threshold LbTargetGroup#healthy_threshold}.
interval number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#interval LbTargetGroup#interval}.
matcher string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#matcher LbTargetGroup#matcher}.
path string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#path LbTargetGroup#path}.
port string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#port LbTargetGroup#port}.
protocol string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#protocol LbTargetGroup#protocol}.
timeout number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#timeout LbTargetGroup#timeout}.
unhealthyThreshold number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#unhealthy_threshold LbTargetGroup#unhealthy_threshold}.

enabledOptional
public readonly enabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#enabled LbTargetGroup#enabled}.


healthyThresholdOptional
public readonly healthyThreshold: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#healthy_threshold LbTargetGroup#healthy_threshold}.


intervalOptional
public readonly interval: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#interval LbTargetGroup#interval}.


matcherOptional
public readonly matcher: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#matcher LbTargetGroup#matcher}.


pathOptional
public readonly path: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#path LbTargetGroup#path}.


portOptional
public readonly port: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#port LbTargetGroup#port}.


protocolOptional
public readonly protocol: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#protocol LbTargetGroup#protocol}.


timeoutOptional
public readonly timeout: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#timeout LbTargetGroup#timeout}.


unhealthyThresholdOptional
public readonly unhealthyThreshold: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#unhealthy_threshold LbTargetGroup#unhealthy_threshold}.


LbTargetGroupStickiness

Initializer

import { lbTargetGroup } from '@cdktf/aws-cdk'

const lbTargetGroupStickiness: lbTargetGroup.LbTargetGroupStickiness = { ... }

Properties

Name Type Description
type string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#type LbTargetGroup#type}.
cookieDuration number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#cookie_duration LbTargetGroup#cookie_duration}.
cookieName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#cookie_name LbTargetGroup#cookie_name}.
enabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#enabled LbTargetGroup#enabled}.

typeRequired
public readonly type: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#type LbTargetGroup#type}.


cookieDurationOptional
public readonly cookieDuration: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#cookie_duration LbTargetGroup#cookie_duration}.


cookieNameOptional
public readonly cookieName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#cookie_name LbTargetGroup#cookie_name}.


enabledOptional
public readonly enabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/lb_target_group#enabled LbTargetGroup#enabled}.


Classes

LbTargetGroupHealthCheckOutputReference

Initializers

import { lbTargetGroup } from '@cdktf/aws-cdk'

new lbTargetGroup.LbTargetGroupHealthCheckOutputReference(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.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • 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.
resetEnabled No description.
resetHealthyThreshold No description.
resetInterval No description.
resetMatcher No description.
resetPath No description.
resetPort No description.
resetProtocol No description.
resetTimeout No description.
resetUnhealthyThreshold No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetEnabled
public resetEnabled(): void
resetHealthyThreshold
public resetHealthyThreshold(): void
resetInterval
public resetInterval(): void
resetMatcher
public resetMatcher(): void
resetPath
public resetPath(): void
resetPort
public resetPort(): void
resetProtocol
public resetProtocol(): void
resetTimeout
public resetTimeout(): void
resetUnhealthyThreshold
public resetUnhealthyThreshold(): 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.
enabledInput boolean | cdktf.IResolvable No description.
healthyThresholdInput number No description.
intervalInput number No description.
matcherInput string No description.
pathInput string No description.
portInput string No description.
protocolInput string No description.
timeoutInput number No description.
unhealthyThresholdInput number No description.
enabled boolean | cdktf.IResolvable No description.
healthyThreshold number No description.
interval number No description.
matcher string No description.
path string No description.
port string No description.
protocol string No description.
timeout number No description.
unhealthyThreshold number No description.
internalValue LbTargetGroupHealthCheck No description.

creationStackRequired
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.


fqnRequired
public readonly fqn: string;
  • Type: string

enabledInputOptional
public readonly enabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

healthyThresholdInputOptional
public readonly healthyThresholdInput: number;
  • Type: number

intervalInputOptional
public readonly intervalInput: number;
  • Type: number

matcherInputOptional
public readonly matcherInput: string;
  • Type: string

pathInputOptional
public readonly pathInput: string;
  • Type: string

portInputOptional
public readonly portInput: string;
  • Type: string

protocolInputOptional
public readonly protocolInput: string;
  • Type: string

timeoutInputOptional
public readonly timeoutInput: number;
  • Type: number

unhealthyThresholdInputOptional
public readonly unhealthyThresholdInput: number;
  • Type: number

enabledRequired
public readonly enabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

healthyThresholdRequired
public readonly healthyThreshold: number;
  • Type: number

intervalRequired
public readonly interval: number;
  • Type: number

matcherRequired
public readonly matcher: string;
  • Type: string

pathRequired
public readonly path: string;
  • Type: string

portRequired
public readonly port: string;
  • Type: string

protocolRequired
public readonly protocol: string;
  • Type: string

timeoutRequired
public readonly timeout: number;
  • Type: number

unhealthyThresholdRequired
public readonly unhealthyThreshold: number;
  • Type: number

internalValueOptional
public readonly internalValue: LbTargetGroupHealthCheck;

LbTargetGroupStickinessOutputReference

Initializers

import { lbTargetGroup } from '@cdktf/aws-cdk'

new lbTargetGroup.LbTargetGroupStickinessOutputReference(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.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • 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.
resetCookieDuration No description.
resetCookieName No description.
resetEnabled No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCookieDuration
public resetCookieDuration(): void
resetCookieName
public resetCookieName(): void
resetEnabled
public resetEnabled(): 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.
cookieDurationInput number No description.
cookieNameInput string No description.
enabledInput boolean | cdktf.IResolvable No description.
typeInput string No description.
cookieDuration number No description.
cookieName string No description.
enabled boolean | cdktf.IResolvable No description.
type string No description.
internalValue LbTargetGroupStickiness No description.

creationStackRequired
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.


fqnRequired
public readonly fqn: string;
  • Type: string

cookieDurationInputOptional
public readonly cookieDurationInput: number;
  • Type: number

cookieNameInputOptional
public readonly cookieNameInput: string;
  • Type: string

enabledInputOptional
public readonly enabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

typeInputOptional
public readonly typeInput: string;
  • Type: string

cookieDurationRequired
public readonly cookieDuration: number;
  • Type: number

cookieNameRequired
public readonly cookieName: string;
  • Type: string

enabledRequired
public readonly enabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

typeRequired
public readonly type: string;
  • Type: string

internalValueOptional
public readonly internalValue: LbTargetGroupStickiness;