1.204.0

class CfnSubnet (construct)

LanguageType name
.NETAmazon.CDK.AWS.EC2.CfnSubnet
Javasoftware.amazon.awscdk.services.ec2.CfnSubnet
Pythonaws_cdk.aws_ec2.CfnSubnet
TypeScript @aws-cdk/aws-ec2 » CfnSubnet

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::EC2::Subnet.

Specifies a subnet for the specified VPC.

For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.

For more information, see Subnets for your VPC in the Amazon VPC User Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ec2 from '@aws-cdk/aws-ec2';

declare const privateDnsNameOptionsOnLaunch: any;
const cfnSubnet = new ec2.CfnSubnet(this, 'MyCfnSubnet', {
  vpcId: 'vpcId',

  // the properties below are optional
  assignIpv6AddressOnCreation: false,
  availabilityZone: 'availabilityZone',
  availabilityZoneId: 'availabilityZoneId',
  cidrBlock: 'cidrBlock',
  enableDns64: false,
  ipv6CidrBlock: 'ipv6CidrBlock',
  ipv6Native: false,
  mapPublicIpOnLaunch: false,
  outpostArn: 'outpostArn',
  privateDnsNameOptionsOnLaunch: privateDnsNameOptionsOnLaunch,
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnSubnet(scope: Construct, id: string, props: CfnSubnetProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnSubnetProps — - resource properties.

Create a new AWS::EC2::Subnet.

Construct Props

NameTypeDescription
vpcIdstringThe ID of the VPC the subnet is in.
assignIpv6AddressOnCreation?boolean | IResolvableIndicates whether a network interface created in this subnet receives an IPv6 address. The default value is false .
availabilityZone?stringThe Availability Zone of the subnet.
availabilityZoneId?stringThe AZ ID of the subnet.
cidrBlock?stringThe IPv4 CIDR block assigned to the subnet.
enableDns64?boolean | IResolvableIndicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
ipv6CidrBlock?stringThe IPv6 CIDR block.
ipv6Native?boolean | IResolvableIndicates whether this is an IPv6 only subnet.
mapPublicIpOnLaunch?boolean | IResolvableIndicates whether instances launched in this subnet receive a public IPv4 address.
outpostArn?stringThe Amazon Resource Name (ARN) of the Outpost.
privateDnsNameOptionsOnLaunch?anyThe hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled.
tags?CfnTag[]Any tags assigned to the subnet.

vpcId

Type: string

The ID of the VPC the subnet is in.

If you update this property, you must also update the CidrBlock property.

assignIpv6AddressOnCreation?

Type: boolean | IResolvable (optional)

Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is false .

If you specify AssignIpv6AddressOnCreation , you must also specify Ipv6CidrBlock .

availabilityZone?

Type: string (optional)

The Availability Zone of the subnet.

If you update this property, you must also update the CidrBlock property.

availabilityZoneId?

Type: string (optional)

The AZ ID of the subnet.

cidrBlock?

Type: string (optional)

The IPv4 CIDR block assigned to the subnet.

If you update this property, we create a new subnet, and then delete the existing one.

enableDns64?

Type: boolean | IResolvable (optional)

Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.

For more information, see DNS64 and NAT64 in the Amazon Virtual Private Cloud User Guide .

ipv6CidrBlock?

Type: string (optional)

The IPv6 CIDR block.

If you specify AssignIpv6AddressOnCreation , you must also specify Ipv6CidrBlock .

ipv6Native?

Type: boolean | IResolvable (optional)

Indicates whether this is an IPv6 only subnet.

For more information, see Subnet basics in the Amazon Virtual Private Cloud User Guide .

mapPublicIpOnLaunch?

Type: boolean | IResolvable (optional)

Indicates whether instances launched in this subnet receive a public IPv4 address.

The default value is false .

outpostArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the Outpost.

privateDnsNameOptionsOnLaunch?

Type: any (optional)

The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled.

For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide .

Available options:

  • EnableResourceNameDnsAAAARecord (true | false)
  • EnableResourceNameDnsARecord (true | false)
  • HostnameType (ip-name | resource-name)

tags?

Type: CfnTag[] (optional)

Any tags assigned to the subnet.

Properties

NameTypeDescription
attrAvailabilityZonestringThe Availability Zone of this subnet. For example:.
attrIpv6CidrBlocksstring[]The IPv6 CIDR blocks that are associated with the subnet, such as [ 2001:db8:1234:1a00::/64 ] .
attrNetworkAclAssociationIdstringThe ID of the network ACL that is associated with the subnet's VPC, such as acl-5fb85d36 .
attrOutpostArnstringThe Amazon Resource Name (ARN) of the Outpost.
attrSubnetIdstringThe ID of the subnet.
attrVpcIdstringThe ID of the subnet's VPC, such as vpc-11ad4878 .
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
logicalIdstringThe logical ID for this CloudFormation stack element.
nodeConstructNodeThe construct tree node associated with this construct.
privateDnsNameOptionsOnLaunchanyThe hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
stackStackThe stack in which this element is defined.
tagsTagManagerAny tags assigned to the subnet.
vpcIdstringThe ID of the VPC the subnet is in.
assignIpv6AddressOnCreation?boolean | IResolvableIndicates whether a network interface created in this subnet receives an IPv6 address. The default value is false .
availabilityZone?stringThe Availability Zone of the subnet.
availabilityZoneId?stringThe AZ ID of the subnet.
cidrBlock?stringThe IPv4 CIDR block assigned to the subnet.
enableDns64?boolean | IResolvableIndicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
ipv6CidrBlock?stringThe IPv6 CIDR block.
ipv6Native?boolean | IResolvableIndicates whether this is an IPv6 only subnet.
mapPublicIpOnLaunch?boolean | IResolvableIndicates whether instances launched in this subnet receive a public IPv4 address.
outpostArn?stringThe Amazon Resource Name (ARN) of the Outpost.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

attrAvailabilityZone

Type: string

The Availability Zone of this subnet. For example:.

{ "Fn::GetAtt" : [ "mySubnet", "AvailabilityZone" ] }

attrIpv6CidrBlocks

Type: string[]

The IPv6 CIDR blocks that are associated with the subnet, such as [ 2001:db8:1234:1a00::/64 ] .

attrNetworkAclAssociationId

Type: string

The ID of the network ACL that is associated with the subnet's VPC, such as acl-5fb85d36 .

attrOutpostArn

Type: string

The Amazon Resource Name (ARN) of the Outpost.

attrSubnetId

Type: string

The ID of the subnet.

attrVpcId

Type: string

The ID of the subnet's VPC, such as vpc-11ad4878 .

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: ConstructNode

The construct tree node associated with this construct.

privateDnsNameOptionsOnLaunch

Type: any

The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled.

For more information, see Amazon EC2 instance hostname types in the Amazon Elastic Compute Cloud User Guide .

Available options:

  • EnableResourceNameDnsAAAARecord (true | false)
  • EnableResourceNameDnsARecord (true | false)
  • HostnameType (ip-name | resource-name)

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Type: TagManager

Any tags assigned to the subnet.

vpcId

Type: string

The ID of the VPC the subnet is in.

If you update this property, you must also update the CidrBlock property.

assignIpv6AddressOnCreation?

Type: boolean | IResolvable (optional)

Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is false .

If you specify AssignIpv6AddressOnCreation , you must also specify Ipv6CidrBlock .

availabilityZone?

Type: string (optional)

The Availability Zone of the subnet.

If you update this property, you must also update the CidrBlock property.

availabilityZoneId?

Type: string (optional)

The AZ ID of the subnet.

cidrBlock?

Type: string (optional)

The IPv4 CIDR block assigned to the subnet.

If you update this property, we create a new subnet, and then delete the existing one.

enableDns64?

Type: boolean | IResolvable (optional)

Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.

For more information, see DNS64 and NAT64 in the Amazon Virtual Private Cloud User Guide .

ipv6CidrBlock?

Type: string (optional)

The IPv6 CIDR block.

If you specify AssignIpv6AddressOnCreation , you must also specify Ipv6CidrBlock .

ipv6Native?

Type: boolean | IResolvable (optional)

Indicates whether this is an IPv6 only subnet.

For more information, see Subnet basics in the Amazon Virtual Private Cloud User Guide .

mapPublicIpOnLaunch?

Type: boolean | IResolvable (optional)

Indicates whether instances launched in this subnet receive a public IPv4 address.

The default value is false .

outpostArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the Outpost.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependsOn(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

  • attributeName string — The name of the attribute.

Returns

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

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

toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }
← PreviousNext →