class CfnSubnet (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.EC2.CfnSubnet |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnSubnet |
![]() | software.amazon.awscdk.services.ec2.CfnSubnet |
![]() | aws_cdk.aws_ec2.CfnSubnet |
![]() | aws-cdk-lib » aws_ec2 » CfnSubnet |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
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 .
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html
Example
import { KubectlV32Layer } from '@aws-cdk/lambda-layer-kubectl-v32';
declare const vpc: ec2.Vpc;
function associateSubnetWithV6Cidr(vpc: ec2.Vpc, count: number, subnet: ec2.ISubnet) {
const cfnSubnet = subnet.node.defaultChild as ec2.CfnSubnet;
cfnSubnet.ipv6CidrBlock = Fn.select(count, Fn.cidr(Fn.select(0, vpc.vpcIpv6CidrBlocks), 256, (128 - 64).toString()));
cfnSubnet.assignIpv6AddressOnCreation = true;
}
// make an ipv6 cidr
const ipv6cidr = new ec2.CfnVPCCidrBlock(this, 'CIDR6', {
vpcId: vpc.vpcId,
amazonProvidedIpv6CidrBlock: true,
});
// connect the ipv6 cidr to all vpc subnets
let subnetcount = 0;
const subnets = vpc.publicSubnets.concat(vpc.privateSubnets);
for (let subnet of subnets) {
// Wait for the ipv6 cidr to complete
subnet.node.addDependency(ipv6cidr);
associateSubnetWithV6Cidr(vpc, subnetcount, subnet);
subnetcount = subnetcount + 1;
}
const cluster = new eks.Cluster(this, 'hello-eks', {
version: eks.KubernetesVersion.V1_32,
vpc: vpc,
ipFamily: eks.IpFamily.IP_V6,
vpcSubnets: [{ subnets: vpc.publicSubnets }],
kubectlLayer: new KubectlV32Layer(this, 'kubectl'),
});
Initializer
new CfnSubnet(scope: Construct, id: string, props: CfnSubnetProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Subnet Props
Construct Props
Name | Type | Description |
---|---|---|
vpc | string | The ID of the VPC the subnet is in. |
assign | boolean | IResolvable | Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is false . |
availability | string | The Availability Zone of the subnet. |
availability | string | The AZ ID of the subnet. |
cidr | string | The IPv4 CIDR block assigned to the subnet. |
enable | boolean | IResolvable | Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. |
enable | number | Indicates the device position for local network interfaces in this subnet. |
ipv4 | string | An IPv4 IPAM pool ID for the subnet. |
ipv4 | number | An IPv4 netmask length for the subnet. |
ipv6 | string | The IPv6 CIDR block. |
ipv6 | string | An IPv6 IPAM pool ID for the subnet. |
ipv6 | boolean | IResolvable | Indicates whether this is an IPv6 only subnet. |
ipv6 | number | An IPv6 netmask length for the subnet. |
map | boolean | IResolvable | Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is false . |
outpost | string | The Amazon Resource Name (ARN) of the Outpost. |
private | 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. |
tags? | Cfn [] | 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 an IPv6 CIDR block.
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.
You must first configure a NAT gateway in a public subnet (separate from the subnet containing the IPv6-only workloads). For example, the subnet containing the NAT gateway should have a
0.0.0.0/0
route pointing to the internet gateway. For more information, see Configure DNS64 and NAT64 in the Amazon Virtual Private Cloud User Guide .
enableLniAtDeviceIndex?
Type:
number
(optional)
Indicates the device position for local network interfaces in this subnet.
For example, 1
indicates local network interfaces in this subnet are the secondary network interface (eth1).
ipv4IpamPoolId?
Type:
string
(optional)
An IPv4 IPAM pool ID for the subnet.
ipv4NetmaskLength?
Type:
number
(optional)
An IPv4 netmask length for the subnet.
ipv6CidrBlock?
Type:
string
(optional)
The IPv6 CIDR block.
If you specify AssignIpv6AddressOnCreation
, you must also specify an IPv6 CIDR block.
ipv6IpamPoolId?
Type:
string
(optional)
An IPv6 IPAM pool ID for the subnet.
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 .
ipv6NetmaskLength?
Type:
number
(optional)
An IPv6 netmask length for the subnet.
mapPublicIpOnLaunch?
Type:
boolean |
IResolvable
(optional)
Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is false
.
AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the VPC pricing page .
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:
Cfn
[]
(optional)
Any tags assigned to the subnet.
Properties
Name | Type | Description |
---|---|---|
attr | string | The Availability Zone of this subnet. |
attr | string | The Availability Zone ID of this subnet. |
attr | string | The IPv4 CIDR blocks that are associated with the subnet. |
attr | string[] | The IPv6 CIDR blocks that are associated with the subnet. |
attr | string | The ID of the network ACL that is associated with the subnet's VPC, such as acl-5fb85d36 . |
attr | string | The Amazon Resource Name (ARN) of the Outpost. |
attr | string | The ID of the subnet. |
attr | string | The ID of the subnet's VPC, such as vpc-11ad4878 . |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
tags | Tag | Tag Manager which manages the tags for this resource. |
vpc | string | The ID of the VPC the subnet is in. |
assign | boolean | IResolvable | Indicates whether a network interface created in this subnet receives an IPv6 address. |
availability | string | The Availability Zone of the subnet. |
availability | string | The AZ ID of the subnet. |
cidr | string | The IPv4 CIDR block assigned to the subnet. |
enable | boolean | IResolvable | Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. |
enable | number | Indicates the device position for local network interfaces in this subnet. |
ipv4 | string | An IPv4 IPAM pool ID for the subnet. |
ipv4 | number | An IPv4 netmask length for the subnet. |
ipv6 | string | The IPv6 CIDR block. |
ipv6 | string | An IPv6 IPAM pool ID for the subnet. |
ipv6 | boolean | IResolvable | Indicates whether this is an IPv6 only subnet. |
ipv6 | number | An IPv6 netmask length for the subnet. |
map | boolean | IResolvable | Indicates whether instances launched in this subnet receive a public IPv4 address. |
outpost | string | The Amazon Resource Name (ARN) of the Outpost. |
private | 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. |
tags | Cfn [] | Any tags assigned to the subnet. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrAvailabilityZone
Type:
string
The Availability Zone of this subnet.
For example, us-east-1a
.
attrAvailabilityZoneId
Type:
string
The Availability Zone ID of this subnet.
For example, use1-az1
.
attrCidrBlock
Type:
string
The IPv4 CIDR blocks that are associated with the subnet.
attrIpv6CidrBlocks
Type:
string[]
The IPv6 CIDR blocks that are associated with the subnet.
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:
ICfn
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:
Node
The tree node.
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:
Tag
Tag Manager which manages the tags for this resource.
vpcId
Type:
string
The ID of the VPC the subnet is in.
assignIpv6AddressOnCreation?
Type:
boolean |
IResolvable
(optional)
Indicates whether a network interface created in this subnet receives an IPv6 address.
The default value is false
.
availabilityZone?
Type:
string
(optional)
The Availability Zone of the subnet.
availabilityZoneId?
Type:
string
(optional)
The AZ ID of the subnet.
cidrBlock?
Type:
string
(optional)
The IPv4 CIDR block assigned to the subnet.
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.
enableLniAtDeviceIndex?
Type:
number
(optional)
Indicates the device position for local network interfaces in this subnet.
ipv4IpamPoolId?
Type:
string
(optional)
An IPv4 IPAM pool ID for the subnet.
ipv4NetmaskLength?
Type:
number
(optional)
An IPv4 netmask length for the subnet.
ipv6CidrBlock?
Type:
string
(optional)
The IPv6 CIDR block.
ipv6IpamPoolId?
Type:
string
(optional)
An IPv6 IPAM pool ID for the subnet.
ipv6Native?
Type:
boolean |
IResolvable
(optional)
Indicates whether this is an IPv6 only subnet.
ipv6NetmaskLength?
Type:
number
(optional)
An IPv6 netmask length for the subnet.
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.
tagsRaw?
Type:
Cfn
[]
(optional)
Any tags assigned to the subnet.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
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.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
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
- policy
Removal
Policy - options
Removal
Policy Options
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
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
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.
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
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
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.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
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 }