Refer to the Terraform Registory for docs: aws_subnet
.
Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/subnet aws_subnet}.
import { subnet } from '@cdktf/aws-cdk'
new subnet.Subnet(scope: Construct, id: string, config: SubnetConfig)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
SubnetConfig |
No description. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: SubnetConfig
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. |
toMetadata |
No description. |
toTerraform |
Adds this resource to the terraform JSON output. |
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. |
putTimeouts |
No description. |
resetAssignIpv6AddressOnCreation |
No description. |
resetAvailabilityZone |
No description. |
resetAvailabilityZoneId |
No description. |
resetCidrBlock |
No description. |
resetCustomerOwnedIpv4Pool |
No description. |
resetEnableDns64 |
No description. |
resetEnableResourceNameDnsAaaaRecordOnLaunch |
No description. |
resetEnableResourceNameDnsARecordOnLaunch |
No description. |
resetId |
No description. |
resetIpv6CidrBlock |
No description. |
resetIpv6Native |
No description. |
resetMapCustomerOwnedIpOnLaunch |
No description. |
resetMapPublicIpOnLaunch |
No description. |
resetOutpostArn |
No description. |
resetPrivateDnsHostnameTypeOnLaunch |
No description. |
resetTags |
No description. |
resetTagsAll |
No description. |
resetTimeouts |
No description. |
public toString(): string
Returns a string representation of this construct.
public addOverride(path: string, value: any): void
- Type: string
- Type: any
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
public toMetadata(): any
public toTerraform(): any
Adds this resource to the terraform JSON output.
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public interpolationForAttribute(terraformAttribute: string): IResolvable
- Type: string
public putTimeouts(value: SubnetTimeouts): void
- Type: SubnetTimeouts
public resetAssignIpv6AddressOnCreation(): void
public resetAvailabilityZone(): void
public resetAvailabilityZoneId(): void
public resetCidrBlock(): void
public resetCustomerOwnedIpv4Pool(): void
public resetEnableDns64(): void
public resetEnableResourceNameDnsAaaaRecordOnLaunch(): void
public resetEnableResourceNameDnsARecordOnLaunch(): void
public resetId(): void
public resetIpv6CidrBlock(): void
public resetIpv6Native(): void
public resetMapCustomerOwnedIpOnLaunch(): void
public resetMapPublicIpOnLaunch(): void
public resetOutpostArn(): void
public resetPrivateDnsHostnameTypeOnLaunch(): void
public resetTags(): void
public resetTagsAll(): void
public resetTimeouts(): void
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
import { subnet } from '@cdktf/aws-cdk'
subnet.Subnet.isConstruct(x: any)
Checks if x
is a construct.
Use this method instead of instanceof
to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs
library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct
in each copy of the constructs
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.
- Type: any
Any object.
import { subnet } from '@cdktf/aws-cdk'
subnet.Subnet.isTerraformElement(x: any)
- Type: any
import { subnet } from '@cdktf/aws-cdk'
subnet.Subnet.isTerraformResource(x: any)
- Type: any
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. |
ipv6CidrBlockAssociationId |
string |
No description. |
ownerId |
string |
No description. |
timeouts |
SubnetTimeoutsOutputReference |
No description. |
assignIpv6AddressOnCreationInput |
boolean | cdktf.IResolvable |
No description. |
availabilityZoneIdInput |
string |
No description. |
availabilityZoneInput |
string |
No description. |
cidrBlockInput |
string |
No description. |
customerOwnedIpv4PoolInput |
string |
No description. |
enableDns64Input |
boolean | cdktf.IResolvable |
No description. |
enableResourceNameDnsAaaaRecordOnLaunchInput |
boolean | cdktf.IResolvable |
No description. |
enableResourceNameDnsARecordOnLaunchInput |
boolean | cdktf.IResolvable |
No description. |
idInput |
string |
No description. |
ipv6CidrBlockInput |
string |
No description. |
ipv6NativeInput |
boolean | cdktf.IResolvable |
No description. |
mapCustomerOwnedIpOnLaunchInput |
boolean | cdktf.IResolvable |
No description. |
mapPublicIpOnLaunchInput |
boolean | cdktf.IResolvable |
No description. |
outpostArnInput |
string |
No description. |
privateDnsHostnameTypeOnLaunchInput |
string |
No description. |
tagsAllInput |
{[ key: string ]: string} |
No description. |
tagsInput |
{[ key: string ]: string} |
No description. |
timeoutsInput |
cdktf.IResolvable | SubnetTimeouts |
No description. |
vpcIdInput |
string |
No description. |
assignIpv6AddressOnCreation |
boolean | cdktf.IResolvable |
No description. |
availabilityZone |
string |
No description. |
availabilityZoneId |
string |
No description. |
cidrBlock |
string |
No description. |
customerOwnedIpv4Pool |
string |
No description. |
enableDns64 |
boolean | cdktf.IResolvable |
No description. |
enableResourceNameDnsAaaaRecordOnLaunch |
boolean | cdktf.IResolvable |
No description. |
enableResourceNameDnsARecordOnLaunch |
boolean | cdktf.IResolvable |
No description. |
id |
string |
No description. |
ipv6CidrBlock |
string |
No description. |
ipv6Native |
boolean | cdktf.IResolvable |
No description. |
mapCustomerOwnedIpOnLaunch |
boolean | cdktf.IResolvable |
No description. |
mapPublicIpOnLaunch |
boolean | cdktf.IResolvable |
No description. |
outpostArn |
string |
No description. |
privateDnsHostnameTypeOnLaunch |
string |
No description. |
tags |
{[ key: string ]: string} |
No description. |
tagsAll |
{[ key: string ]: string} |
No description. |
vpcId |
string |
No description. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly cdktfStack: TerraformStack;
- Type: cdktf.TerraformStack
public readonly fqn: string;
- Type: string
public readonly friendlyUniqueId: string;
- Type: string
public readonly terraformMetaArguments: {[ key: string ]: any};
- Type: {[ key: string ]: any}
public readonly terraformResourceType: string;
- Type: string
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
- Type: cdktf.TerraformProviderGeneratorMetadata
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: string[];
- Type: string[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly arn: string;
- Type: string
public readonly ipv6CidrBlockAssociationId: string;
- Type: string
public readonly ownerId: string;
- Type: string
public readonly timeouts: SubnetTimeoutsOutputReference;
public readonly assignIpv6AddressOnCreationInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly availabilityZoneIdInput: string;
- Type: string
public readonly availabilityZoneInput: string;
- Type: string
public readonly cidrBlockInput: string;
- Type: string
public readonly customerOwnedIpv4PoolInput: string;
- Type: string
public readonly enableDns64Input: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly enableResourceNameDnsAaaaRecordOnLaunchInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly enableResourceNameDnsARecordOnLaunchInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly idInput: string;
- Type: string
public readonly ipv6CidrBlockInput: string;
- Type: string
public readonly ipv6NativeInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly mapCustomerOwnedIpOnLaunchInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly mapPublicIpOnLaunchInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly outpostArnInput: string;
- Type: string
public readonly privateDnsHostnameTypeOnLaunchInput: string;
- Type: string
public readonly tagsAllInput: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly tagsInput: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly timeoutsInput: IResolvable | SubnetTimeouts;
- Type: cdktf.IResolvable | SubnetTimeouts
public readonly vpcIdInput: string;
- Type: string
public readonly assignIpv6AddressOnCreation: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly availabilityZone: string;
- Type: string
public readonly availabilityZoneId: string;
- Type: string
public readonly cidrBlock: string;
- Type: string
public readonly customerOwnedIpv4Pool: string;
- Type: string
public readonly enableDns64: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly enableResourceNameDnsAaaaRecordOnLaunch: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly enableResourceNameDnsARecordOnLaunch: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly id: string;
- Type: string
public readonly ipv6CidrBlock: string;
- Type: string
public readonly ipv6Native: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly mapCustomerOwnedIpOnLaunch: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly mapPublicIpOnLaunch: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly outpostArn: string;
- Type: string
public readonly privateDnsHostnameTypeOnLaunch: string;
- Type: string
public readonly tags: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly tagsAll: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly vpcId: string;
- Type: string
Name | Type | Description |
---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;
- Type: string
import { subnet } from '@cdktf/aws-cdk'
const subnetConfig: subnet.SubnetConfig = { ... }
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: ITerraformDependable[];
- Type: cdktf.ITerraformDependable[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly vpcId: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/subnet#vpc_id Subnet#vpc_id}.
public readonly assignIpv6AddressOnCreation: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/subnet#assign_ipv6_address_on_creation Subnet#assign_ipv6_address_on_creation}.
public readonly availabilityZone: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/subnet#availability_zone Subnet#availability_zone}.
public readonly availabilityZoneId: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/subnet#availability_zone_id Subnet#availability_zone_id}.
public readonly cidrBlock: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/subnet#cidr_block Subnet#cidr_block}.
public readonly customerOwnedIpv4Pool: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/subnet#customer_owned_ipv4_pool Subnet#customer_owned_ipv4_pool}.
public readonly enableDns64: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/subnet#enable_dns64 Subnet#enable_dns64}.
public readonly enableResourceNameDnsAaaaRecordOnLaunch: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/subnet#enable_resource_name_dns_aaaa_record_on_launch Subnet#enable_resource_name_dns_aaaa_record_on_launch}.
public readonly enableResourceNameDnsARecordOnLaunch: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/subnet#enable_resource_name_dns_a_record_on_launch Subnet#enable_resource_name_dns_a_record_on_launch}.
public readonly id: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/subnet#id Subnet#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.
public readonly ipv6CidrBlock: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/subnet#ipv6_cidr_block Subnet#ipv6_cidr_block}.
public readonly ipv6Native: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/subnet#ipv6_native Subnet#ipv6_native}.
public readonly mapCustomerOwnedIpOnLaunch: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/subnet#map_customer_owned_ip_on_launch Subnet#map_customer_owned_ip_on_launch}.
public readonly mapPublicIpOnLaunch: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/subnet#map_public_ip_on_launch Subnet#map_public_ip_on_launch}.
public readonly outpostArn: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/subnet#outpost_arn Subnet#outpost_arn}.
public readonly privateDnsHostnameTypeOnLaunch: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/subnet#private_dns_hostname_type_on_launch Subnet#private_dns_hostname_type_on_launch}.
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/subnet#tags Subnet#tags}.
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/subnet#tags_all Subnet#tags_all}.
public readonly timeouts: SubnetTimeouts;
- Type: SubnetTimeouts
timeouts block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/subnet#timeouts Subnet#timeouts}
import { subnet } from '@cdktf/aws-cdk'
const subnetTimeouts: subnet.SubnetTimeouts = { ... }
Name | Type | Description |
---|---|---|
create |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/subnet#create Subnet#create}. |
delete |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/subnet#delete Subnet#delete}. |
public readonly create: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/subnet#create Subnet#create}.
public readonly delete: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/subnet#delete Subnet#delete}.
import { subnet } from '@cdktf/aws-cdk'
new subnet.SubnetTimeoutsOutputReference(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. |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
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. |
public computeFqn(): string
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public interpolationForAttribute(property: string): IResolvable
- Type: string
public resolve(_context: IResolveContext): any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
public toString(): string
Return a string representation of this resolvable object.
Returns a reversible string representation.
public resetCreate(): void
public resetDelete(): void
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 | SubnetTimeouts |
No description. |
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.
public readonly fqn: string;
- Type: string
public readonly createInput: string;
- Type: string
public readonly deleteInput: string;
- Type: string
public readonly create: string;
- Type: string
public readonly delete: string;
- Type: string
public readonly internalValue: IResolvable | SubnetTimeouts;
- Type: cdktf.IResolvable | SubnetTimeouts