software.amazon.awscdk.services.ec2

Class CfnVPC

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ec2.CfnVPC

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.368Z")
 @Stability(value=Stable)
public class CfnVPC
extends CfnResource
implements IInspectable

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 .

Example:

 CfnInclude cfnTemplate;
 // using from*Attributes()
 CfnSubnet privateCfnSubnet1;
 CfnSubnet privateCfnSubnet2;
 // using from*Name()
 CfnBucket cfnBucket = (CfnBucket)cfnTemplate.getResource("Bucket");
 IBucket bucket = Bucket.fromBucketName(this, "L2Bucket", cfnBucket.getRef());
 // using from*Arn()
 CfnKey cfnKey = (CfnKey)cfnTemplate.getResource("Key");
 IKey key = Key.fromKeyArn(this, "L2Key", cfnKey.getAttrArn());
 CfnVPC cfnVpc = (CfnVPC)cfnTemplate.getResource("Vpc");
 IVpc vpc = Vpc.fromVpcAttributes(this, "L2Vpc", VpcAttributes.builder()
         .vpcId(cfnVpc.getRef())
         .availabilityZones(Fn.getAzs())
         .privateSubnetIds(List.of(privateCfnSubnet1.getRef(), privateCfnSubnet2.getRef()))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnVPC.Builder A fluent builder for CfnVPC.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnVPC(software.constructs.Construct scope, String id) Create a new `AWS::EC2::VPC`.
	CfnVPC(software.constructs.Construct scope, String id, CfnVPCProps props) Create a new `AWS::EC2::VPC`.
protected	CfnVPC(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVPC(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrCidrBlock() The primary IPv4 CIDR block for the VPC.
List<String>	getAttrCidrBlockAssociations() The association IDs of the IPv4 CIDR blocks for the VPC.
String	getAttrDefaultNetworkAcl() The ID of the default network ACL for the VPC.
String	getAttrDefaultSecurityGroup() The ID of the default security group for the VPC.
List<String>	getAttrIpv6CidrBlocks() The IPv6 CIDR blocks for the VPC.
String	getAttrVpcId()
protected Map<String,Object>	getCfnProperties()
String	getCidrBlock() The IPv4 network range for the VPC, in CIDR notation.
Object	getEnableDnsHostnames() Indicates whether the instances launched in the VPC get DNS hostnames.
Object	getEnableDnsSupport() Indicates whether the DNS resolution is supported for the VPC.
String	getInstanceTenancy() The allowed tenancy of instances launched into the VPC.
String	getIpv4IpamPoolId() The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR.
Number	getIpv4NetmaskLength() The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool.
TagManager	getTags() The tags for the VPC.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCidrBlock(String value) The IPv4 network range for the VPC, in CIDR notation.
void	setEnableDnsHostnames(Boolean value) Indicates whether the instances launched in the VPC get DNS hostnames.
void	setEnableDnsHostnames(IResolvable value) Indicates whether the instances launched in the VPC get DNS hostnames.
void	setEnableDnsSupport(Boolean value) Indicates whether the DNS resolution is supported for the VPC.
void	setEnableDnsSupport(IResolvable value) Indicates whether the DNS resolution is supported for the VPC.
void	setInstanceTenancy(String value) The allowed tenancy of instances launched into the VPC.
void	setIpv4IpamPoolId(String value) The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR.
void	setIpv4NetmaskLength(Number value) The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnVPC

protected CfnVPC(software.amazon.jsii.JsiiObjectRef objRef)

CfnVPC

protected CfnVPC(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnVPC

@Stability(value=Stable)
public CfnVPC(@NotNull
                                       software.constructs.Construct scope,
                                       @NotNull
                                       String id,
                                       @Nullable
                                       CfnVPCProps props)

Create a new `AWS::EC2::VPC`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnVPC

@Stability(value=Stable)
public CfnVPC(@NotNull
                                       software.constructs.Construct scope,
                                       @NotNull
                                       String id)

Create a new `AWS::EC2::VPC`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCidrBlock

@Stability(value=Stable)
 @NotNull
public String getAttrCidrBlock()

The primary IPv4 CIDR block for the VPC.

For example, 10.0.0.0/16.

getAttrCidrBlockAssociations

@Stability(value=Stable)
 @NotNull
public List<String> getAttrCidrBlockAssociations()

The association IDs of the IPv4 CIDR blocks for the VPC.

For example, [ vpc-cidr-assoc-0280ab6b ].

getAttrDefaultNetworkAcl

@Stability(value=Stable)
 @NotNull
public String getAttrDefaultNetworkAcl()

The ID of the default network ACL for the VPC.

For example, acl-814dafe3.

getAttrDefaultSecurityGroup

@Stability(value=Stable)
 @NotNull
public String getAttrDefaultSecurityGroup()

The ID of the default security group for the VPC.

For example, sg-b178e0d3.

getAttrIpv6CidrBlocks

@Stability(value=Stable)
 @NotNull
public List<String> getAttrIpv6CidrBlocks()

The IPv6 CIDR blocks for the VPC.

For example, [ 2001:db8:1234:1a00::/56 ].

getAttrVpcId

@Stability(value=Stable)
 @NotNull
public String getAttrVpcId()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags for the VPC.

getCidrBlock

@Stability(value=Stable)
 @Nullable
public String getCidrBlock()

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 specify 100.68.0.18/18 , we modify it to 100.68.0.0/18 .

You must specify either CidrBlock or Ipv4IpamPoolId .

setCidrBlock

@Stability(value=Stable)
public void setCidrBlock(@Nullable
                                                  String value)

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 specify 100.68.0.18/18 , we modify it to 100.68.0.0/18 .

You must specify either CidrBlock or Ipv4IpamPoolId .

getEnableDnsHostnames

@Stability(value=Stable)
 @Nullable
public Object getEnableDnsHostnames()

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.

setEnableDnsHostnames

@Stability(value=Stable)
public void setEnableDnsHostnames(@Nullable
                                                           Boolean value)

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.

setEnableDnsHostnames

@Stability(value=Stable)
public void setEnableDnsHostnames(@Nullable
                                                           IResolvable value)

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.

getEnableDnsSupport

@Stability(value=Stable)
 @Nullable
public Object getEnableDnsSupport()

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 .

setEnableDnsSupport

@Stability(value=Stable)
public void setEnableDnsSupport(@Nullable
                                                         Boolean value)

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 .

setEnableDnsSupport

@Stability(value=Stable)
public void setEnableDnsSupport(@Nullable
                                                         IResolvable value)

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 .

getInstanceTenancy

@Stability(value=Stable)
 @Nullable
public String getInstanceTenancy()

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 of host during instance launch. You cannot specify a tenancy of default during instance launch.

Updating InstanceTenancy requires no replacement only if you are updating its value from dedicated to default . Updating InstanceTenancy from default to dedicated requires replacement.

setInstanceTenancy

@Stability(value=Stable)
public void setInstanceTenancy(@Nullable
                                                        String value)

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 of host during instance launch. You cannot specify a tenancy of default during instance launch.

Updating InstanceTenancy requires no replacement only if you are updating its value from dedicated to default . Updating InstanceTenancy from default to dedicated requires replacement.

getIpv4IpamPoolId

@Stability(value=Stable)
 @Nullable
public String getIpv4IpamPoolId()

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 or Ipv4IpamPoolId .

setIpv4IpamPoolId

@Stability(value=Stable)
public void setIpv4IpamPoolId(@Nullable
                                                       String value)

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 or Ipv4IpamPoolId .

getIpv4NetmaskLength

@Stability(value=Stable)
 @Nullable
public Number getIpv4NetmaskLength()

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 .

setIpv4NetmaskLength

@Stability(value=Stable)
public void setIpv4NetmaskLength(@Nullable
                                                          Number value)

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 .