CfnSubnet¶
-
class
aws_cdk.aws_ec2.
CfnSubnet
(scope, id, *, vpc_id, assign_ipv6_address_on_creation=None, availability_zone=None, availability_zone_id=None, cidr_block=None, enable_dns64=None, ipv6_cidr_block=None, ipv6_native=None, map_public_ip_on_launch=None, outpost_arn=None, private_dns_name_options_on_launch=None, tags=None)¶ Bases:
aws_cdk.core.CfnResource
A CloudFormation
AWS::EC2::Subnet
.Specifies a subnet for a VPC.
When you create each subnet, you provide the VPC ID and IPv4 CIDR block for the subnet. After you create a subnet, you can’t change its CIDR block. The size of the subnet’s IPv4 CIDR block can be the same as a VPC’s IPv4 CIDR block, or a subset of a VPC’s IPv4 CIDR block. If you create more than one subnet in a VPC, the subnets’ CIDR blocks must not overlap. The smallest IPv4 subnet (and VPC) you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses).
If you’ve associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length.
- CloudformationResource
AWS::EC2::Subnet
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-subnet.html
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ec2 as ec2 # private_dns_name_options_on_launch: Any cfn_subnet = ec2.CfnSubnet(self, "MyCfnSubnet", vpc_id="vpcId", # the properties below are optional assign_ipv6_address_on_creation=False, availability_zone="availabilityZone", availability_zone_id="availabilityZoneId", cidr_block="cidrBlock", enable_dns64=False, ipv6_cidr_block="ipv6CidrBlock", ipv6_native=False, map_public_ip_on_launch=False, outpost_arn="outpostArn", private_dns_name_options_on_launch=private_dns_name_options_on_launch, tags=[CfnTag( key="key", value="value" )] )
Create a new
AWS::EC2::Subnet
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
vpc_id (
str
) – The ID of the VPC the subnet is in. If you update this property, you must also update theCidrBlock
property.assign_ipv6_address_on_creation (
Union
[bool
,IResolvable
,None
]) – Indicates whether a network interface created in this subnet receives an IPv6 address. The default value isfalse
. If you specifyAssignIpv6AddressOnCreation
, you must also specifyIpv6CidrBlock
.availability_zone (
Optional
[str
]) – The Availability Zone of the subnet. If you update this property, you must also update theCidrBlock
property.availability_zone_id (
Optional
[str
]) – The AZ ID of the subnet.cidr_block (
Optional
[str
]) – The IPv4 CIDR block assigned to the subnet. If you update this property, we create a new subnet, and then delete the existing one.enable_dns64 (
Union
[bool
,IResolvable
,None
]) – 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 .ipv6_cidr_block (
Optional
[str
]) – The IPv6 CIDR block. If you specifyAssignIpv6AddressOnCreation
, you must also specifyIpv6CidrBlock
.ipv6_native (
Union
[bool
,IResolvable
,None
]) – Indicates whether this is an IPv6 only subnet. For more information, see Subnet basics in the Amazon Virtual Private Cloud User Guide .map_public_ip_on_launch (
Union
[bool
,IResolvable
,None
]) – Indicates whether instances launched in this subnet receive a public IPv4 address. The default value isfalse
.outpost_arn (
Optional
[str
]) – The Amazon Resource Name (ARN) of the Outpost.private_dns_name_options_on_launch (
Optional
[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 .tags (
Optional
[Sequence
[CfnTag
]]) – Any tags assigned to the subnet.
Methods
-
add_deletion_override
(path)¶ Syntactic sugar for
addOverride(path, undefined)
.- Parameters
path (
str
) – The path of the value to delete.- Return type
None
-
add_depends_on
(target)¶ 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.
- Parameters
target (
CfnResource
) –- Return type
None
-
add_metadata
(key, value)¶ Add a value to the CloudFormation Resource Metadata.
- Parameters
key (
str
) –value (
Any
) –
- See
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.
- Return type
None
-
add_override
(path, value)¶ Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
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:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
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.- Parameters
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type
None
-
add_property_deletion_override
(property_path)¶ Adds an override that deletes the value of a property from the resource definition.
- Parameters
property_path (
str
) – The path to the property.- Return type
None
-
add_property_override
(property_path, value)¶ Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type
None
-
apply_removal_policy
(policy=None, *, apply_to_update_replace_policy=None, default=None)¶ 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
).- Parameters
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type
None
-
get_att
(attribute_name)¶ 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.- Parameters
attribute_name (
str
) – The name of the attribute.- Return type
-
get_metadata
(key)¶ Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters
key (
str
) –- See
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.
- Return type
Any
-
inspect
(inspector)¶ Examines the CloudFormation resource and discloses attributes.
- Parameters
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type
None
-
override_logical_id
(new_logical_id)¶ Overrides the auto-generated logical ID with a specific ID.
- Parameters
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type
None
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
- Returns
a string representation of this resource
Attributes
-
CFN_RESOURCE_TYPE_NAME
= 'AWS::EC2::Subnet'¶
-
assign_ipv6_address_on_creation
¶ 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 specifyIpv6CidrBlock
.- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
attr_availability_zone
¶ .
{ "Fn::GetAtt" : [ "mySubnet", "AvailabilityZone" ] }
- CloudformationAttribute
AvailabilityZone
- Type
The Availability Zone of this subnet. For example
- Return type
str
-
attr_ipv6_cidr_blocks
¶ The IPv6 CIDR blocks that are associated with the subnet, such as
[ 2001:db8:1234:1a00::/64 ]
.- CloudformationAttribute
Ipv6CidrBlocks
- Return type
List
[str
]
-
attr_network_acl_association_id
¶ The ID of the network ACL that is associated with the subnet’s VPC, such as
acl-5fb85d36
.- CloudformationAttribute
NetworkAclAssociationId
- Return type
str
-
attr_outpost_arn
¶ The Amazon Resource Name (ARN) of the Outpost.
- CloudformationAttribute
OutpostArn
- Return type
str
-
attr_subnet_id
¶ The ID of the subnet.
- CloudformationAttribute
SubnetId
- Return type
str
-
attr_vpc_id
¶ The ID of the subnet’s VPC, such as
vpc-11ad4878
.- CloudformationAttribute
VpcId
- Return type
str
-
availability_zone
¶ The Availability Zone of the subnet.
If you update this property, you must also update the
CidrBlock
property.- Link
- Return type
Optional
[str
]
-
availability_zone_id
¶ The AZ ID of the subnet.
- Link
- Return type
Optional
[str
]
-
cfn_options
¶ Options for this resource, such as condition, update policy etc.
- Return type
-
cfn_resource_type
¶ AWS resource type.
- Return type
str
-
cidr_block
¶ The IPv4 CIDR block assigned to the subnet.
If you update this property, we create a new subnet, and then delete the existing one.
- Link
- Return type
Optional
[str
]
-
creation_stack
¶ return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- Return type
List
[str
]
-
enable_dns64
¶ 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 .
- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
ipv6_cidr_block
¶ The IPv6 CIDR block.
If you specify
AssignIpv6AddressOnCreation
, you must also specifyIpv6CidrBlock
.- Link
- Return type
Optional
[str
]
-
ipv6_native
¶ Indicates whether this is an IPv6 only subnet.
For more information, see Subnet basics in the Amazon Virtual Private Cloud User Guide .
- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
logical_id
¶ 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)
.- Return type
str
- Returns
the logical ID as a stringified token. This value will only get resolved during synthesis.
-
map_public_ip_on_launch
¶ Indicates whether instances launched in this subnet receive a public IPv4 address.
The default value is
false
.- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
node
¶ The construct tree node associated with this construct.
- Return type
-
outpost_arn
¶ The Amazon Resource Name (ARN) of the Outpost.
- Link
- Return type
Optional
[str
]
-
private_dns_name_options_on_launch
¶ 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 .
-
ref
¶ 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 })
.- Return type
str
-
stack
¶ The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- Return type
Any tags assigned to the subnet.
-
vpc_id
¶ The ID of the VPC the subnet is in.
If you update this property, you must also update the
CidrBlock
property.
Static Methods
-
classmethod
is_cfn_element
(x)¶ Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters
x (
Any
) –- Return type
bool
- Returns
The construct as a stack element or undefined if it is not a stack element.
-
classmethod
is_cfn_resource
(construct)¶ Check whether the given construct is a CfnResource.
- Parameters
construct (
IConstruct
) –- Return type
bool
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool