Package software.amazon.awscdk.services.ec2

Interface CfnVPCProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVPCProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:06.043Z")
@Stability(Stable)
public interface CfnVPCProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnVPC.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnVPCProps cfnVPCProps = CfnVPCProps.builder()
         .cidrBlock("cidrBlock")
         .enableDnsHostnames(false)
         .enableDnsSupport(false)
         .instanceTenancy("instanceTenancy")
         .ipv4IpamPoolId("ipv4IpamPoolId")
         .ipv4NetmaskLength(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnVPCProps.Builder	A builder for CfnVPCProps
static final class	CfnVPCProps.Jsii$Proxy	An implementation for CfnVPCProps

Method Summary

Modifier and Type	Method	Description
static CfnVPCProps.Builder	builder()
default String	getCidrBlock()	The IPv4 network range for the VPC, in CIDR notation.
default Object	getEnableDnsHostnames()	Indicates whether the instances launched in the VPC get DNS hostnames.
default Object	getEnableDnsSupport()	Indicates whether the DNS resolution is supported for the VPC.
default String	getInstanceTenancy()	The allowed tenancy of instances launched into the VPC.
default String	getIpv4IpamPoolId()	The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR.
default 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.
default List<CfnTag>	getTags()	The tags for the VPC.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCidrBlock

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-cidrblock

getEnableDnsHostnames

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-enablednshostnames

getEnableDnsSupport

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-enablednssupport

getInstanceTenancy

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-instancetenancy

getIpv4IpamPoolId

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-ipv4ipampoolid

getIpv4NetmaskLength

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-ipv4netmasklength

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags for the VPC.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html#cfn-ec2-vpc-tags

builder

@Stability(Stable)
static CfnVPCProps.Builder builder()

Returns:

a CfnVPCProps.Builder of CfnVPCProps