Skip to content

Latest commit

 

History

History
3269 lines (2024 loc) · 136 KB

securityGroup.md

File metadata and controls

3269 lines (2024 loc) · 136 KB

securityGroup Submodule

Constructs

SecurityGroup

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

Initializers 

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

new securityGroup.SecurityGroup(scope: Construct, id: string, config?: SecurityGroupConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config SecurityGroupConfig 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".
putEgress No description.
putIngress No description.
putTimeouts No description.
resetDescription No description.
resetEgress No description.
resetId No description.
resetIngress No description.
resetName No description.
resetNamePrefix No description.
resetRevokeRulesOnDelete No description.
resetTags No description.
resetTagsAll No description.
resetTimeouts 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".

putEgress 
public putEgress(value: IResolvable | SecurityGroupEgress[]): void
valueRequired
putIngress 
public putIngress(value: IResolvable | SecurityGroupIngress[]): void
valueRequired
putTimeouts 
public putTimeouts(value: SecurityGroupTimeouts): void
valueRequired
resetDescription 
public resetDescription(): void
resetEgress 
public resetEgress(): void
resetId 
public resetId(): void
resetIngress 
public resetIngress(): void
resetName 
public resetName(): void
resetNamePrefix 
public resetNamePrefix(): void
resetRevokeRulesOnDelete 
public resetRevokeRulesOnDelete(): void
resetTags 
public resetTags(): void
resetTagsAll 
public resetTagsAll(): void
resetTimeouts 
public resetTimeouts(): 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 SecurityGroup resource upon running "cdktf plan ".
isConstruct 
import { securityGroup } from '@cdktf/aws-cdk'

securityGroup.SecurityGroup.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

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

securityGroup.SecurityGroup.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { securityGroup } from '@cdktf/aws-cdk'

securityGroup.SecurityGroup.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { securityGroup } from '@cdktf/aws-cdk'

securityGroup.SecurityGroup.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

importFromIdRequired
  • Type: string

The id of the existing SecurityGroup that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_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 SecurityGroup 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.
egress SecurityGroupEgressList No description.
ingress SecurityGroupIngressList No description.
ownerId string No description.
timeouts SecurityGroupTimeoutsOutputReference No description.
descriptionInput string No description.
egressInput cdktf.IResolvable | SecurityGroupEgress[] No description.
idInput string No description.
ingressInput cdktf.IResolvable | SecurityGroupIngress[] No description.
nameInput string No description.
namePrefixInput string No description.
revokeRulesOnDeleteInput boolean | cdktf.IResolvable No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
timeoutsInput cdktf.IResolvable | SecurityGroupTimeouts No description.
vpcIdInput string No description.
description string No description.
id string No description.
name string No description.
namePrefix string No description.
revokeRulesOnDelete boolean | cdktf.IResolvable No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: 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
egressRequired 
public readonly egress: SecurityGroupEgressList;
ingressRequired 
public readonly ingress: SecurityGroupIngressList;
ownerIdRequired 
public readonly ownerId: string;
  • Type: string
timeoutsRequired 
public readonly timeouts: SecurityGroupTimeoutsOutputReference;
descriptionInputOptional 
public readonly descriptionInput: string;
  • Type: string
egressInputOptional 
public readonly egressInput: IResolvable | SecurityGroupEgress[];
idInputOptional 
public readonly idInput: string;
  • Type: string
ingressInputOptional 
public readonly ingressInput: IResolvable | SecurityGroupIngress[];
nameInputOptional 
public readonly nameInput: string;
  • Type: string
namePrefixInputOptional 
public readonly namePrefixInput: string;
  • Type: string
revokeRulesOnDeleteInputOptional 
public readonly revokeRulesOnDeleteInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
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 | SecurityGroupTimeouts;
vpcIdInputOptional 
public readonly vpcIdInput: string;
  • Type: string
descriptionRequired 
public readonly description: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
namePrefixRequired 
public readonly namePrefix: string;
  • Type: string
revokeRulesOnDeleteRequired 
public readonly revokeRulesOnDelete: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
tagsRequired 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsAllRequired 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
vpcIdRequired 
public readonly vpcId: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

SecurityGroupConfig

Initializer 

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

const securityGroupConfig: securityGroup.SecurityGroupConfig = { ... }

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.
description string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#description SecurityGroup#description}.
egress cdktf.IResolvable | SecurityGroupEgress[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#egress SecurityGroup#egress}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#id SecurityGroup#id}.
ingress cdktf.IResolvable | SecurityGroupIngress[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#ingress SecurityGroup#ingress}.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#name SecurityGroup#name}.
namePrefix string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#name_prefix SecurityGroup#name_prefix}.
revokeRulesOnDelete boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#revoke_rules_on_delete SecurityGroup#revoke_rules_on_delete}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#tags SecurityGroup#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#tags_all SecurityGroup#tags_all}.
timeouts SecurityGroupTimeouts timeouts block.
vpcId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#vpc_id SecurityGroup#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[]
descriptionOptional 
public readonly description: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#description SecurityGroup#description}.

egressOptional 
public readonly egress: IResolvable | SecurityGroupEgress[];

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#egress SecurityGroup#egress}.

idOptional 
public readonly id: string;
  • Type: string

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

ingressOptional 
public readonly ingress: IResolvable | SecurityGroupIngress[];

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#ingress SecurityGroup#ingress}.

nameOptional 
public readonly name: string;
  • Type: string

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

revokeRulesOnDeleteOptional 
public readonly revokeRulesOnDelete: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#revoke_rules_on_delete SecurityGroup#revoke_rules_on_delete}.

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/security_group#tags SecurityGroup#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/security_group#tags_all SecurityGroup#tags_all}.

timeoutsOptional 
public readonly timeouts: SecurityGroupTimeouts;

timeouts block.

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

vpcIdOptional 
public readonly vpcId: string;
  • Type: string

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

SecurityGroupEgress

Initializer 

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

const securityGroupEgress: securityGroup.SecurityGroupEgress = { ... }

Properties

Name Type Description
cidrBlocks string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#cidr_blocks SecurityGroup#cidr_blocks}.
description string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#description SecurityGroup#description}.
fromPort number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#from_port SecurityGroup#from_port}.
ipv6CidrBlocks string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#ipv6_cidr_blocks SecurityGroup#ipv6_cidr_blocks}.
prefixListIds string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#prefix_list_ids SecurityGroup#prefix_list_ids}.
protocol string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#protocol SecurityGroup#protocol}.
securityGroups string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#security_groups SecurityGroup#security_groups}.
selfAttribute boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#self SecurityGroup#self}.
toPort number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#to_port SecurityGroup#to_port}.
cidrBlocksOptional 
public readonly cidrBlocks: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#cidr_blocks SecurityGroup#cidr_blocks}.

descriptionOptional 
public readonly description: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#description SecurityGroup#description}.

fromPortOptional 
public readonly fromPort: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#from_port SecurityGroup#from_port}.

ipv6CidrBlocksOptional 
public readonly ipv6CidrBlocks: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#ipv6_cidr_blocks SecurityGroup#ipv6_cidr_blocks}.

prefixListIdsOptional 
public readonly prefixListIds: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#prefix_list_ids SecurityGroup#prefix_list_ids}.

protocolOptional 
public readonly protocol: string;
  • Type: string

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

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

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

selfAttributeOptional 
public readonly selfAttribute: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#self SecurityGroup#self}.

toPortOptional 
public readonly toPort: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#to_port SecurityGroup#to_port}.

SecurityGroupIngress

Initializer 

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

const securityGroupIngress: securityGroup.SecurityGroupIngress = { ... }

Properties

Name Type Description
cidrBlocks string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#cidr_blocks SecurityGroup#cidr_blocks}.
description string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#description SecurityGroup#description}.
fromPort number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#from_port SecurityGroup#from_port}.
ipv6CidrBlocks string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#ipv6_cidr_blocks SecurityGroup#ipv6_cidr_blocks}.
prefixListIds string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#prefix_list_ids SecurityGroup#prefix_list_ids}.
protocol string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#protocol SecurityGroup#protocol}.
securityGroups string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#security_groups SecurityGroup#security_groups}.
selfAttribute boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#self SecurityGroup#self}.
toPort number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#to_port SecurityGroup#to_port}.
cidrBlocksOptional 
public readonly cidrBlocks: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#cidr_blocks SecurityGroup#cidr_blocks}.

descriptionOptional 
public readonly description: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#description SecurityGroup#description}.

fromPortOptional 
public readonly fromPort: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#from_port SecurityGroup#from_port}.

ipv6CidrBlocksOptional 
public readonly ipv6CidrBlocks: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#ipv6_cidr_blocks SecurityGroup#ipv6_cidr_blocks}.

prefixListIdsOptional 
public readonly prefixListIds: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#prefix_list_ids SecurityGroup#prefix_list_ids}.

protocolOptional 
public readonly protocol: string;
  • Type: string

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

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

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

selfAttributeOptional 
public readonly selfAttribute: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#self SecurityGroup#self}.

toPortOptional 
public readonly toPort: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#to_port SecurityGroup#to_port}.

SecurityGroupTimeouts

Initializer 

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

const securityGroupTimeouts: securityGroup.SecurityGroupTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#create SecurityGroup#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#delete SecurityGroup#delete}.
createOptional 
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/security_group#create SecurityGroup#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/security_group#delete SecurityGroup#delete}.

Classes

SecurityGroupEgressList

Initializers 

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

new securityGroup.SecurityGroupEgressList(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): SecurityGroupEgressOutputReference
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 | SecurityGroupEgress[] 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 | SecurityGroupEgress[];

SecurityGroupEgressOutputReference

Initializers 

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

new securityGroup.SecurityGroupEgressOutputReference(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.
resetCidrBlocks No description.
resetDescription No description.
resetFromPort No description.
resetIpv6CidrBlocks No description.
resetPrefixListIds No description.
resetProtocol No description.
resetSecurityGroups No description.
resetSelfAttribute No description.
resetToPort 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.

resetCidrBlocks 
public resetCidrBlocks(): void
resetDescription 
public resetDescription(): void
resetFromPort 
public resetFromPort(): void
resetIpv6CidrBlocks 
public resetIpv6CidrBlocks(): void
resetPrefixListIds 
public resetPrefixListIds(): void
resetProtocol 
public resetProtocol(): void
resetSecurityGroups 
public resetSecurityGroups(): void
resetSelfAttribute 
public resetSelfAttribute(): void
resetToPort 
public resetToPort(): 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.
cidrBlocksInput string[] No description.
descriptionInput string No description.
fromPortInput number No description.
ipv6CidrBlocksInput string[] No description.
prefixListIdsInput string[] No description.
protocolInput string No description.
securityGroupsInput string[] No description.
selfAttributeInput boolean | cdktf.IResolvable No description.
toPortInput number No description.
cidrBlocks string[] No description.
description string No description.
fromPort number No description.
ipv6CidrBlocks string[] No description.
prefixListIds string[] No description.
protocol string No description.
securityGroups string[] No description.
selfAttribute boolean | cdktf.IResolvable No description.
toPort number No description.
internalValue cdktf.IResolvable | SecurityGroupEgress 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
cidrBlocksInputOptional 
public readonly cidrBlocksInput: string[];
  • Type: string[]
descriptionInputOptional 
public readonly descriptionInput: string;
  • Type: string
fromPortInputOptional 
public readonly fromPortInput: number;
  • Type: number
ipv6CidrBlocksInputOptional 
public readonly ipv6CidrBlocksInput: string[];
  • Type: string[]
prefixListIdsInputOptional 
public readonly prefixListIdsInput: string[];
  • Type: string[]
protocolInputOptional 
public readonly protocolInput: string;
  • Type: string
securityGroupsInputOptional 
public readonly securityGroupsInput: string[];
  • Type: string[]
selfAttributeInputOptional 
public readonly selfAttributeInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
toPortInputOptional 
public readonly toPortInput: number;
  • Type: number
cidrBlocksRequired 
public readonly cidrBlocks: string[];
  • Type: string[]
descriptionRequired 
public readonly description: string;
  • Type: string
fromPortRequired 
public readonly fromPort: number;
  • Type: number
ipv6CidrBlocksRequired 
public readonly ipv6CidrBlocks: string[];
  • Type: string[]
prefixListIdsRequired 
public readonly prefixListIds: string[];
  • Type: string[]
protocolRequired 
public readonly protocol: string;
  • Type: string
securityGroupsRequired 
public readonly securityGroups: string[];
  • Type: string[]
selfAttributeRequired 
public readonly selfAttribute: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
toPortRequired 
public readonly toPort: number;
  • Type: number
internalValueOptional 
public readonly internalValue: IResolvable | SecurityGroupEgress;

SecurityGroupIngressList

Initializers 

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

new securityGroup.SecurityGroupIngressList(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): SecurityGroupIngressOutputReference
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 | SecurityGroupIngress[] 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 | SecurityGroupIngress[];

SecurityGroupIngressOutputReference

Initializers 

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

new securityGroup.SecurityGroupIngressOutputReference(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.
resetCidrBlocks No description.
resetDescription No description.
resetFromPort No description.
resetIpv6CidrBlocks No description.
resetPrefixListIds No description.
resetProtocol No description.
resetSecurityGroups No description.
resetSelfAttribute No description.
resetToPort 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.

resetCidrBlocks 
public resetCidrBlocks(): void
resetDescription 
public resetDescription(): void
resetFromPort 
public resetFromPort(): void
resetIpv6CidrBlocks 
public resetIpv6CidrBlocks(): void
resetPrefixListIds 
public resetPrefixListIds(): void
resetProtocol 
public resetProtocol(): void
resetSecurityGroups 
public resetSecurityGroups(): void
resetSelfAttribute 
public resetSelfAttribute(): void
resetToPort 
public resetToPort(): 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.
cidrBlocksInput string[] No description.
descriptionInput string No description.
fromPortInput number No description.
ipv6CidrBlocksInput string[] No description.
prefixListIdsInput string[] No description.
protocolInput string No description.
securityGroupsInput string[] No description.
selfAttributeInput boolean | cdktf.IResolvable No description.
toPortInput number No description.
cidrBlocks string[] No description.
description string No description.
fromPort number No description.
ipv6CidrBlocks string[] No description.
prefixListIds string[] No description.
protocol string No description.
securityGroups string[] No description.
selfAttribute boolean | cdktf.IResolvable No description.
toPort number No description.
internalValue cdktf.IResolvable | SecurityGroupIngress 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
cidrBlocksInputOptional 
public readonly cidrBlocksInput: string[];
  • Type: string[]
descriptionInputOptional 
public readonly descriptionInput: string;
  • Type: string
fromPortInputOptional 
public readonly fromPortInput: number;
  • Type: number
ipv6CidrBlocksInputOptional 
public readonly ipv6CidrBlocksInput: string[];
  • Type: string[]
prefixListIdsInputOptional 
public readonly prefixListIdsInput: string[];
  • Type: string[]
protocolInputOptional 
public readonly protocolInput: string;
  • Type: string
securityGroupsInputOptional 
public readonly securityGroupsInput: string[];
  • Type: string[]
selfAttributeInputOptional 
public readonly selfAttributeInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
toPortInputOptional 
public readonly toPortInput: number;
  • Type: number
cidrBlocksRequired 
public readonly cidrBlocks: string[];
  • Type: string[]
descriptionRequired 
public readonly description: string;
  • Type: string
fromPortRequired 
public readonly fromPort: number;
  • Type: number
ipv6CidrBlocksRequired 
public readonly ipv6CidrBlocks: string[];
  • Type: string[]
prefixListIdsRequired 
public readonly prefixListIds: string[];
  • Type: string[]
protocolRequired 
public readonly protocol: string;
  • Type: string
securityGroupsRequired 
public readonly securityGroups: string[];
  • Type: string[]
selfAttributeRequired 
public readonly selfAttribute: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
toPortRequired 
public readonly toPort: number;
  • Type: number
internalValueOptional 
public readonly internalValue: IResolvable | SecurityGroupIngress;

SecurityGroupTimeoutsOutputReference

Initializers 

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

new securityGroup.SecurityGroupTimeoutsOutputReference(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.
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

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.
create string No description.
delete string No description.
internalValue cdktf.IResolvable | SecurityGroupTimeouts 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
createRequired 
public readonly create: string;
  • Type: string
deleteRequired 
public readonly delete: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | SecurityGroupTimeouts;