CfnVPC¶
-
class
aws_cdk.aws_ec2.
CfnVPC
(scope, id, *, cidr_block=None, enable_dns_hostnames=None, enable_dns_support=None, instance_tenancy=None, ipv4_ipam_pool_id=None, ipv4_netmask_length=None, tags=None)¶ Bases:
aws_cdk.core.CfnResource
A CloudFormation
AWS::EC2::VPC
.Specifies a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see Overview of VPCs and subnets in the Amazon Virtual Private Cloud User Guide .
- CloudformationResource
AWS::EC2::VPC
- ExampleMetadata
infused
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html
Example:
# cfn_template: cfn_inc.CfnInclude # using from*Attributes() # private_cfn_subnet1: ec2.CfnSubnet # private_cfn_subnet2: ec2.CfnSubnet # using from*Name() cfn_bucket = cfn_template.get_resource("Bucket") bucket = s3.Bucket.from_bucket_name(self, "L2Bucket", cfn_bucket.ref) # using from*Arn() cfn_key = cfn_template.get_resource("Key") key = kms.Key.from_key_arn(self, "L2Key", cfn_key.attr_arn) cfn_vpc = cfn_template.get_resource("Vpc") vpc = ec2.Vpc.from_vpc_attributes(self, "L2Vpc", vpc_id=cfn_vpc.ref, availability_zones=core.Fn.get_azs(), private_subnet_ids=[private_cfn_subnet1.ref, private_cfn_subnet2.ref] )
Create a new
AWS::EC2::VPC
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
cidr_block (
Optional
[str
]) – The IPv4 network range for the VPC, in CIDR notation. For example,10.0.0.0/16
. We modify the specified CIDR block to its canonical form; for example, if you specify100.68.0.18/18
, we modify it to100.68.0.0/18
. You must specify eitherCidrBlock
orIpv4IpamPoolId
.enable_dns_hostnames (
Union
[bool
,IResolvable
,None
]) – Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see DNS attributes in your VPC . You can only enable DNS hostnames if you’ve enabled DNS support.enable_dns_support (
Union
[bool
,IResolvable
,None
]) –Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range “plus two” succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see DNS attributes in your VPC .
instance_tenancy (
Optional
[str
]) – The allowed tenancy of instances launched into the VPC. -default
: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch. -dedicated
: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy ofhost
during instance launch. You cannot specify a tenancy ofdefault
during instance launch. UpdatingInstanceTenancy
requires no replacement only if you are updating its value fromdedicated
todefault
. UpdatingInstanceTenancy
fromdefault
todedicated
requires replacement.ipv4_ipam_pool_id (
Optional
[str
]) – The ID of an IPv4 IPAM pool you want to use for allocating this VPC’s CIDR. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide . You must specify eitherCidrBlock
orIpv4IpamPoolId
.ipv4_netmask_length (
Union
[int
,float
,None
]) –The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide .
tags (
Optional
[Sequence
[CfnTag
]]) – The tags for the VPC.
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::VPC'¶
-
attr_cidr_block
¶ The primary IPv4 CIDR block for the VPC.
For example, 10.0.0.0/16.
- CloudformationAttribute
CidrBlock
- Return type
str
-
attr_cidr_block_associations
¶ The association IDs of the IPv4 CIDR blocks for the VPC.
For example, [ vpc-cidr-assoc-0280ab6b ].
- CloudformationAttribute
CidrBlockAssociations
- Return type
List
[str
]
-
attr_default_network_acl
¶ The ID of the default network ACL for the VPC.
For example, acl-814dafe3.
- CloudformationAttribute
DefaultNetworkAcl
- Return type
str
-
attr_default_security_group
¶ The ID of the default security group for the VPC.
For example, sg-b178e0d3.
- CloudformationAttribute
DefaultSecurityGroup
- Return type
str
-
attr_ipv6_cidr_blocks
¶ The IPv6 CIDR blocks for the VPC.
For example, [ 2001:db8:1234:1a00::/56 ].
- CloudformationAttribute
Ipv6CidrBlocks
- Return type
List
[str
]
-
attr_vpc_id
¶ VpcId
- Type
cloudformationAttribute
- Return type
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 network range for the VPC, in CIDR notation.
For example,
10.0.0.0/16
. We modify the specified CIDR block to its canonical form; for example, if you specify100.68.0.18/18
, we modify it to100.68.0.0/18
.You must specify either
CidrBlock
orIpv4IpamPoolId
.- 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_dns_hostnames
¶ Indicates whether the instances launched in the VPC get DNS hostnames.
If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see DNS attributes in your VPC .
You can only enable DNS hostnames if you’ve enabled DNS support.
- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
enable_dns_support
¶ Indicates whether the DNS resolution is supported for the VPC.
If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range “plus two” succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see DNS attributes in your VPC .
- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
instance_tenancy
¶ The allowed tenancy of instances launched into the VPC.
default
: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch.dedicated
: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy ofhost
during instance launch. You cannot specify a tenancy ofdefault
during instance launch.
Updating
InstanceTenancy
requires no replacement only if you are updating its value fromdedicated
todefault
. UpdatingInstanceTenancy
fromdefault
todedicated
requires replacement.- Link
- Return type
Optional
[str
]
-
ipv4_ipam_pool_id
¶ The ID of an IPv4 IPAM pool you want to use for allocating this VPC’s CIDR.
For more information, see What is IPAM? in the Amazon VPC IPAM User Guide .
You must specify either
CidrBlock
orIpv4IpamPoolId
.- Link
- Return type
Optional
[str
]
-
ipv4_netmask_length
¶ The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool.
For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide .
- Link
- Return type
Union
[int
,float
,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.
-
node
¶ The construct tree node associated with this construct.
- Return type
-
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
The tags for the VPC.
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