Skip to content

Latest commit

 

History

History
3125 lines (1939 loc) · 117 KB

alb.md

File metadata and controls

3125 lines (1939 loc) · 117 KB

alb Submodule

Constructs

Alb

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

Initializers

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

new alb.Alb(scope: Construct, id: string, config?: AlbConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config AlbConfig 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".
putAccessLogs No description.
putSubnetMapping No description.
putTimeouts No description.
resetAccessLogs No description.
resetCustomerOwnedIpv4Pool No description.
resetDesyncMitigationMode No description.
resetDropInvalidHeaderFields No description.
resetEnableCrossZoneLoadBalancing No description.
resetEnableDeletionProtection No description.
resetEnableHttp2 No description.
resetEnableWafFailOpen No description.
resetId No description.
resetIdleTimeout No description.
resetInternal No description.
resetIpAddressType No description.
resetLoadBalancerType No description.
resetName No description.
resetNamePrefix No description.
resetSecurityGroups No description.
resetSubnetMapping No description.
resetSubnets No description.
resetTags No description.
resetTagsAll No description.
resetTimeouts 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".


putAccessLogs
public putAccessLogs(value: AlbAccessLogs): void
valueRequired

putSubnetMapping
public putSubnetMapping(value: IResolvable | AlbSubnetMapping[]): void
valueRequired

putTimeouts
public putTimeouts(value: AlbTimeouts): void
valueRequired

resetAccessLogs
public resetAccessLogs(): void
resetCustomerOwnedIpv4Pool
public resetCustomerOwnedIpv4Pool(): void
resetDesyncMitigationMode
public resetDesyncMitigationMode(): void
resetDropInvalidHeaderFields
public resetDropInvalidHeaderFields(): void
resetEnableCrossZoneLoadBalancing
public resetEnableCrossZoneLoadBalancing(): void
resetEnableDeletionProtection
public resetEnableDeletionProtection(): void
resetEnableHttp2
public resetEnableHttp2(): void
resetEnableWafFailOpen
public resetEnableWafFailOpen(): void
resetId
public resetId(): void
resetIdleTimeout
public resetIdleTimeout(): void
resetInternal
public resetInternal(): void
resetIpAddressType
public resetIpAddressType(): void
resetLoadBalancerType
public resetLoadBalancerType(): void
resetName
public resetName(): void
resetNamePrefix
public resetNamePrefix(): void
resetSecurityGroups
public resetSecurityGroups(): void
resetSubnetMapping
public resetSubnetMapping(): void
resetSubnets
public resetSubnets(): void
resetTags
public resetTags(): void
resetTagsAll
public resetTagsAll(): void
resetTimeouts
public resetTimeouts(): 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 Alb resource upon running "cdktf plan ".

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

alb.Alb.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.


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

alb.Alb.isTerraformElement(x: any)
xRequired
  • Type: any

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

alb.Alb.isTerraformResource(x: any)
xRequired
  • Type: any

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

alb.Alb.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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


importFromIdRequired
  • Type: string

The id of the existing Alb that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#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 Alb 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.
accessLogs AlbAccessLogsOutputReference No description.
arn string No description.
arnSuffix string No description.
dnsName string No description.
subnetMapping AlbSubnetMappingList No description.
timeouts AlbTimeoutsOutputReference No description.
vpcId string No description.
zoneId string No description.
accessLogsInput AlbAccessLogs No description.
customerOwnedIpv4PoolInput string No description.
desyncMitigationModeInput string No description.
dropInvalidHeaderFieldsInput boolean | cdktf.IResolvable No description.
enableCrossZoneLoadBalancingInput boolean | cdktf.IResolvable No description.
enableDeletionProtectionInput boolean | cdktf.IResolvable No description.
enableHttp2Input boolean | cdktf.IResolvable No description.
enableWafFailOpenInput boolean | cdktf.IResolvable No description.
idInput string No description.
idleTimeoutInput number No description.
internalInput boolean | cdktf.IResolvable No description.
ipAddressTypeInput string No description.
loadBalancerTypeInput string No description.
nameInput string No description.
namePrefixInput string No description.
securityGroupsInput string[] No description.
subnetMappingInput cdktf.IResolvable | AlbSubnetMapping[] No description.
subnetsInput string[] No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
timeoutsInput cdktf.IResolvable | AlbTimeouts No description.
customerOwnedIpv4Pool string No description.
desyncMitigationMode string No description.
dropInvalidHeaderFields boolean | cdktf.IResolvable No description.
enableCrossZoneLoadBalancing boolean | cdktf.IResolvable No description.
enableDeletionProtection boolean | cdktf.IResolvable No description.
enableHttp2 boolean | cdktf.IResolvable No description.
enableWafFailOpen boolean | cdktf.IResolvable No description.
id string No description.
idleTimeout number No description.
internal boolean | cdktf.IResolvable No description.
ipAddressType string No description.
loadBalancerType string No description.
name string No description.
namePrefix string No description.
securityGroups string[] No description.
subnets string[] No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: 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[]

accessLogsRequired
public readonly accessLogs: AlbAccessLogsOutputReference;

arnRequired
public readonly arn: string;
  • Type: string

arnSuffixRequired
public readonly arnSuffix: string;
  • Type: string

dnsNameRequired
public readonly dnsName: string;
  • Type: string

subnetMappingRequired
public readonly subnetMapping: AlbSubnetMappingList;

timeoutsRequired
public readonly timeouts: AlbTimeoutsOutputReference;

vpcIdRequired
public readonly vpcId: string;
  • Type: string

zoneIdRequired
public readonly zoneId: string;
  • Type: string

accessLogsInputOptional
public readonly accessLogsInput: AlbAccessLogs;

customerOwnedIpv4PoolInputOptional
public readonly customerOwnedIpv4PoolInput: string;
  • Type: string

desyncMitigationModeInputOptional
public readonly desyncMitigationModeInput: string;
  • Type: string

dropInvalidHeaderFieldsInputOptional
public readonly dropInvalidHeaderFieldsInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

enableCrossZoneLoadBalancingInputOptional
public readonly enableCrossZoneLoadBalancingInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

enableDeletionProtectionInputOptional
public readonly enableDeletionProtectionInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

enableHttp2InputOptional
public readonly enableHttp2Input: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

enableWafFailOpenInputOptional
public readonly enableWafFailOpenInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

idInputOptional
public readonly idInput: string;
  • Type: string

idleTimeoutInputOptional
public readonly idleTimeoutInput: number;
  • Type: number

internalInputOptional
public readonly internalInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

ipAddressTypeInputOptional
public readonly ipAddressTypeInput: string;
  • Type: string

loadBalancerTypeInputOptional
public readonly loadBalancerTypeInput: string;
  • Type: string

nameInputOptional
public readonly nameInput: string;
  • Type: string

namePrefixInputOptional
public readonly namePrefixInput: string;
  • Type: string

securityGroupsInputOptional
public readonly securityGroupsInput: string[];
  • Type: string[]

subnetMappingInputOptional
public readonly subnetMappingInput: IResolvable | AlbSubnetMapping[];

subnetsInputOptional
public readonly subnetsInput: string[];
  • Type: string[]

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

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

timeoutsInputOptional
public readonly timeoutsInput: IResolvable | AlbTimeouts;

customerOwnedIpv4PoolRequired
public readonly customerOwnedIpv4Pool: string;
  • Type: string

desyncMitigationModeRequired
public readonly desyncMitigationMode: string;
  • Type: string

dropInvalidHeaderFieldsRequired
public readonly dropInvalidHeaderFields: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

enableCrossZoneLoadBalancingRequired
public readonly enableCrossZoneLoadBalancing: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

enableDeletionProtectionRequired
public readonly enableDeletionProtection: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

enableHttp2Required
public readonly enableHttp2: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

enableWafFailOpenRequired
public readonly enableWafFailOpen: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

idRequired
public readonly id: string;
  • Type: string

idleTimeoutRequired
public readonly idleTimeout: number;
  • Type: number

internalRequired
public readonly internal: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

ipAddressTypeRequired
public readonly ipAddressType: string;
  • Type: string

loadBalancerTypeRequired
public readonly loadBalancerType: string;
  • Type: string

nameRequired
public readonly name: string;
  • Type: string

namePrefixRequired
public readonly namePrefix: string;
  • Type: string

securityGroupsRequired
public readonly securityGroups: string[];
  • Type: string[]

subnetsRequired
public readonly subnets: string[];
  • Type: string[]

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

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

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

AlbAccessLogs

Initializer

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

const albAccessLogs: alb.AlbAccessLogs = { ... }

Properties

Name Type Description
bucket string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#bucket Alb#bucket}.
enabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#enabled Alb#enabled}.
prefix string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#prefix Alb#prefix}.

bucketRequired
public readonly bucket: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#bucket Alb#bucket}.


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/alb#enabled Alb#enabled}.


prefixOptional
public readonly prefix: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#prefix Alb#prefix}.


AlbConfig

Initializer

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

const albConfig: alb.AlbConfig = { ... }

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.
accessLogs AlbAccessLogs access_logs block.
customerOwnedIpv4Pool string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#customer_owned_ipv4_pool Alb#customer_owned_ipv4_pool}.
desyncMitigationMode string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#desync_mitigation_mode Alb#desync_mitigation_mode}.
dropInvalidHeaderFields boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#drop_invalid_header_fields Alb#drop_invalid_header_fields}.
enableCrossZoneLoadBalancing boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#enable_cross_zone_load_balancing Alb#enable_cross_zone_load_balancing}.
enableDeletionProtection boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#enable_deletion_protection Alb#enable_deletion_protection}.
enableHttp2 boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#enable_http2 Alb#enable_http2}.
enableWafFailOpen boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#enable_waf_fail_open Alb#enable_waf_fail_open}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#id Alb#id}.
idleTimeout number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#idle_timeout Alb#idle_timeout}.
internal boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#internal Alb#internal}.
ipAddressType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#ip_address_type Alb#ip_address_type}.
loadBalancerType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#load_balancer_type Alb#load_balancer_type}.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#name Alb#name}.
namePrefix string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#name_prefix Alb#name_prefix}.
securityGroups string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#security_groups Alb#security_groups}.
subnetMapping cdktf.IResolvable | AlbSubnetMapping[] subnet_mapping block.
subnets string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#subnets Alb#subnets}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#tags Alb#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#tags_all Alb#tags_all}.
timeouts AlbTimeouts timeouts block.

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

accessLogsOptional
public readonly accessLogs: AlbAccessLogs;

access_logs block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#access_logs Alb#access_logs}


customerOwnedIpv4PoolOptional
public readonly customerOwnedIpv4Pool: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#customer_owned_ipv4_pool Alb#customer_owned_ipv4_pool}.


desyncMitigationModeOptional
public readonly desyncMitigationMode: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#desync_mitigation_mode Alb#desync_mitigation_mode}.


dropInvalidHeaderFieldsOptional
public readonly dropInvalidHeaderFields: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#drop_invalid_header_fields Alb#drop_invalid_header_fields}.


enableCrossZoneLoadBalancingOptional
public readonly enableCrossZoneLoadBalancing: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#enable_cross_zone_load_balancing Alb#enable_cross_zone_load_balancing}.


enableDeletionProtectionOptional
public readonly enableDeletionProtection: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#enable_deletion_protection Alb#enable_deletion_protection}.


enableHttp2Optional
public readonly enableHttp2: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#enable_http2 Alb#enable_http2}.


enableWafFailOpenOptional
public readonly enableWafFailOpen: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#enable_waf_fail_open Alb#enable_waf_fail_open}.


idOptional
public readonly id: string;
  • Type: string

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


idleTimeoutOptional
public readonly idleTimeout: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#idle_timeout Alb#idle_timeout}.


internalOptional
public readonly internal: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#internal Alb#internal}.


ipAddressTypeOptional
public readonly ipAddressType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#ip_address_type Alb#ip_address_type}.


loadBalancerTypeOptional
public readonly loadBalancerType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#load_balancer_type Alb#load_balancer_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/alb#name Alb#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/alb#name_prefix Alb#name_prefix}.


securityGroupsOptional
public readonly securityGroups: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#security_groups Alb#security_groups}.


subnetMappingOptional
public readonly subnetMapping: IResolvable | AlbSubnetMapping[];

subnet_mapping block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#subnet_mapping Alb#subnet_mapping}


subnetsOptional
public readonly subnets: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#subnets Alb#subnets}.


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/alb#tags Alb#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/alb#tags_all Alb#tags_all}.


timeoutsOptional
public readonly timeouts: AlbTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#timeouts Alb#timeouts}


AlbSubnetMapping

Initializer

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

const albSubnetMapping: alb.AlbSubnetMapping = { ... }

Properties

Name Type Description
subnetId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#subnet_id Alb#subnet_id}.
allocationId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#allocation_id Alb#allocation_id}.
ipv6Address string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#ipv6_address Alb#ipv6_address}.
privateIpv4Address string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#private_ipv4_address Alb#private_ipv4_address}.

subnetIdRequired
public readonly subnetId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#subnet_id Alb#subnet_id}.


allocationIdOptional
public readonly allocationId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#allocation_id Alb#allocation_id}.


ipv6AddressOptional
public readonly ipv6Address: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#ipv6_address Alb#ipv6_address}.


privateIpv4AddressOptional
public readonly privateIpv4Address: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#private_ipv4_address Alb#private_ipv4_address}.


AlbTimeouts

Initializer

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

const albTimeouts: alb.AlbTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#create Alb#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#delete Alb#delete}.
update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#update Alb#update}.

createOptional
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#create Alb#create}.


deleteOptional
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#delete Alb#delete}.


updateOptional
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/alb#update Alb#update}.


Classes

AlbAccessLogsOutputReference

Initializers

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

new alb.AlbAccessLogsOutputReference(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.
resetPrefix 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
resetPrefix
public resetPrefix(): 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.
bucketInput string No description.
enabledInput boolean | cdktf.IResolvable No description.
prefixInput string No description.
bucket string No description.
enabled boolean | cdktf.IResolvable No description.
prefix string No description.
internalValue AlbAccessLogs 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

bucketInputOptional
public readonly bucketInput: string;
  • Type: string

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

prefixInputOptional
public readonly prefixInput: string;
  • Type: string

bucketRequired
public readonly bucket: string;
  • Type: string

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

prefixRequired
public readonly prefix: string;
  • Type: string

internalValueOptional
public readonly internalValue: AlbAccessLogs;

AlbSubnetMappingList

Initializers

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

new alb.AlbSubnetMappingList(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).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


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

mapKeyAttributeNameRequired
  • Type: string

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

get
public get(index: number): AlbSubnetMappingOutputReference
indexRequired
  • 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 | AlbSubnetMapping[] 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

internalValueOptional
public readonly internalValue: IResolvable | AlbSubnetMapping[];

AlbSubnetMappingOutputReference

Initializers

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

new alb.AlbSubnetMappingOutputReference(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).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


complexObjectIndexRequired
  • Type: number

the index of this item in the list.


complexObjectIsFromSetRequired
  • 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.
resetAllocationId No description.
resetIpv6Address No description.
resetPrivateIpv4Address 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.

resetAllocationId
public resetAllocationId(): void
resetIpv6Address
public resetIpv6Address(): void
resetPrivateIpv4Address
public resetPrivateIpv4Address(): 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.
outpostId string No description.
allocationIdInput string No description.
ipv6AddressInput string No description.
privateIpv4AddressInput string No description.
subnetIdInput string No description.
allocationId string No description.
ipv6Address string No description.
privateIpv4Address string No description.
subnetId string No description.
internalValue cdktf.IResolvable | AlbSubnetMapping 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

outpostIdRequired
public readonly outpostId: string;
  • Type: string

allocationIdInputOptional
public readonly allocationIdInput: string;
  • Type: string

ipv6AddressInputOptional
public readonly ipv6AddressInput: string;
  • Type: string

privateIpv4AddressInputOptional
public readonly privateIpv4AddressInput: string;
  • Type: string

subnetIdInputOptional
public readonly subnetIdInput: string;
  • Type: string

allocationIdRequired
public readonly allocationId: string;
  • Type: string

ipv6AddressRequired
public readonly ipv6Address: string;
  • Type: string

privateIpv4AddressRequired
public readonly privateIpv4Address: string;
  • Type: string

subnetIdRequired
public readonly subnetId: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | AlbSubnetMapping;

AlbTimeoutsOutputReference

Initializers

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

new alb.AlbTimeoutsOutputReference(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.
resetCreate No description.
resetDelete No description.
resetUpdate 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.

resetCreate
public resetCreate(): void
resetDelete
public resetDelete(): void
resetUpdate
public resetUpdate(): 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.
createInput string No description.
deleteInput string No description.
updateInput string No description.
create string No description.
delete string No description.
update string No description.
internalValue cdktf.IResolvable | AlbTimeouts 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

createInputOptional
public readonly createInput: string;
  • Type: string

deleteInputOptional
public readonly deleteInput: string;
  • Type: string

updateInputOptional
public readonly updateInput: string;
  • Type: string

createRequired
public readonly create: string;
  • Type: string

deleteRequired
public readonly delete: string;
  • Type: string

updateRequired
public readonly update: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | AlbTimeouts;