software.amazon.awscdk.services.ec2

Class Vpc

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.ec2.Vpc

All Implemented Interfaces:

software.amazon.awscdk.core.IConstruct, software.amazon.awscdk.core.IDependable, software.amazon.awscdk.core.IResource, IVpc, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/0.19.0 (build 7c562bc)",
           date="2019-10-15T19:55:07.901Z")
 @Stability(value=Stable)
public class Vpc
extends software.amazon.awscdk.core.Resource
implements IVpc

Define an AWS Virtual Private Cloud. See the package-level documentation of this package for an overview of the various dimensions in which you can configure your VPC. For example: ```ts import { SubnetType, Vpc } from '@aws-cdk/aws-ec2' const vpc = new Vpc(this, 'TheVPC', { cidr: "10.0.0.0/16" }) // Iterate the private subnets const selection = vpc.selectSubnets({ subnetType: SubnetType.PRIVATE }); for (const subnet of selection.subnets) { // ... } ```

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IVpc

IVpc.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CIDR_RANGE The default CIDR range used when creating VPCs.
static List<SubnetConfiguration>	DEFAULT_SUBNETS The default subnet configuration.

Constructor Summary

Constructors

Modifier	Constructor and Description
	Vpc(software.amazon.awscdk.core.Construct scope, String id) Vpc creates a VPC that spans a whole region.
	Vpc(software.amazon.awscdk.core.Construct scope, String id, VpcProps props) Vpc creates a VPC that spans a whole region.
protected	Vpc(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Vpc(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
GatewayVpcEndpoint	addDynamoDbEndpoint(String id) Deprecated. use `addGatewayEndpoint()` instead
GatewayVpcEndpoint	addDynamoDbEndpoint(String id, List<SubnetSelection> subnets) Deprecated. use `addGatewayEndpoint()` instead
GatewayVpcEndpoint	addGatewayEndpoint(String id, GatewayVpcEndpointOptions options) Adds a new gateway endpoint to this VPC.
InterfaceVpcEndpoint	addInterfaceEndpoint(String id, InterfaceVpcEndpointOptions options) Adds a new interface endpoint to this VPC.
GatewayVpcEndpoint	addS3Endpoint(String id) Deprecated. use `addGatewayEndpoint()` instead
GatewayVpcEndpoint	addS3Endpoint(String id, List<SubnetSelection> subnets) Deprecated. use `addGatewayEndpoint()` instead
VpnConnection	addVpnConnection(String id, VpnConnectionOptions options) Adds a new VPN connection to this VPC.
static IVpc	fromLookup(software.amazon.awscdk.core.Construct scope, String id, VpcLookupOptions options) Import an existing VPC from by querying the AWS environment this stack is deployed to.
static IVpc	fromVpcAttributes(software.amazon.awscdk.core.Construct scope, String id, VpcAttributes attrs) Import an exported VPC.
List<String>	getAvailabilityZones() AZs for this VPC.
protected Boolean	getIncompleteSubnetDefinition() If this is set to true, don't error out on trying to select subnets.
software.amazon.awscdk.core.IDependable	getInternetConnectivityEstablished() Dependencies for internet connectivity.
List<ISubnet>	getIsolatedSubnets() List of isolated subnets in this VPC.
protected List<software.amazon.awscdk.core.IConstruct>	getNatDependencies() Dependencies for NAT connectivity.
List<ISubnet>	getPrivateSubnets() List of private subnets in this VPC.
List<ISubnet>	getPublicSubnets() List of public subnets in this VPC.
String	getVpcCidrBlock()
List<String>	getVpcCidrBlockAssociations()
String	getVpcDefaultNetworkAcl()
String	getVpcDefaultSecurityGroup()
String	getVpcId() Identifier for this VPC.
List<String>	getVpcIpv6CidrBlocks()
String	getVpnGatewayId() Identifier for the VPN gateway.
protected List<ISubnet>	selectSubnetObjects() Return the subnets appropriate for the placement strategy.
protected List<ISubnet>	selectSubnetObjects(SubnetSelection selection) Return the subnets appropriate for the placement strategy.
SelectedSubnets	selectSubnets() Returns IDs of selected subnets.
SelectedSubnets	selectSubnets(SubnetSelection selection) Returns IDs of selected subnets.
protected void	setIncompleteSubnetDefinition(Boolean value) If this is set to true, don't error out on trying to select subnets.

Methods inherited from class software.amazon.awscdk.core.Resource

generatePhysicalName, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, prepare, synthesize, toString, validate

Methods inherited from class software.amazon.jsii.JsiiObject

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

DEFAULT_CIDR_RANGE

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

The default CIDR range used when creating VPCs. This can be overridden using VpcProps when creating a VPCNetwork resource. e.g. new VpcResource(this, { cidr: '192.168.0.0./16' }).

DEFAULT_SUBNETS

@Stability(value=Stable)
public static final List<SubnetConfiguration> DEFAULT_SUBNETS

The default subnet configuration. 1 Public and 1 Private subnet per AZ evenly split

Constructor Detail

Vpc

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

Vpc

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

Vpc

@Stability(value=Stable)
public Vpc(software.amazon.awscdk.core.Construct scope,
                                    String id,
                                    VpcProps props)

Vpc creates a VPC that spans a whole region. It will automatically divide the provided VPC CIDR range, and create public and private subnets per Availability Zone. Network routing for the public subnets will be configured to allow outbound access directly via an Internet Gateway. Network routing for the private subnets will be configured to allow outbound access via a set of resilient NAT Gateways (one per AZ).

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Vpc

@Stability(value=Stable)
public Vpc(software.amazon.awscdk.core.Construct scope,
                                    String id)

Vpc creates a VPC that spans a whole region. It will automatically divide the provided VPC CIDR range, and create public and private subnets per Availability Zone. Network routing for the public subnets will be configured to allow outbound access directly via an Internet Gateway. Network routing for the private subnets will be configured to allow outbound access via a set of resilient NAT Gateways (one per AZ).

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromLookup

@Stability(value=Stable)
public static IVpc fromLookup(software.amazon.awscdk.core.Construct scope,
                                                       String id,
                                                       VpcLookupOptions options)

Import an existing VPC from by querying the AWS environment this stack is deployed to. This function only needs to be used to use VPCs not defined in your CDK application. If you are looking to share a VPC between stacks, you can pass the `Vpc` object between stacks and use it as normal. See the package-level documentation of this package for constraints on importing existing VPCs. Calling this method will lead to a lookup when the CDK CLI is executed. You can therefore not use any values that will only be available at CloudFormation execution time (i.e., Tokens).

Parameters:

scope - This parameter is required.

id - This parameter is required.

options - This parameter is required.

fromVpcAttributes

@Stability(value=Stable)
public static IVpc fromVpcAttributes(software.amazon.awscdk.core.Construct scope,
                                                              String id,
                                                              VpcAttributes attrs)

Import an exported VPC.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addDynamoDbEndpoint

@Deprecated
 @Stability(value=Deprecated)
public GatewayVpcEndpoint addDynamoDbEndpoint(String id,
                                                                                        List<SubnetSelection> subnets)

Deprecated. use `addGatewayEndpoint()` instead

Adds a new DynamoDB gateway endpoint to this VPC.

Parameters:

id - This parameter is required.

subnets -

addDynamoDbEndpoint

@Deprecated
 @Stability(value=Deprecated)
public GatewayVpcEndpoint addDynamoDbEndpoint(String id)

Deprecated. use `addGatewayEndpoint()` instead

Adds a new DynamoDB gateway endpoint to this VPC.

Parameters:

id - This parameter is required.

addGatewayEndpoint

@Stability(value=Stable)
public GatewayVpcEndpoint addGatewayEndpoint(String id,
                                                                      GatewayVpcEndpointOptions options)

Adds a new gateway endpoint to this VPC.

Specified by:

addGatewayEndpoint in interface IVpc

Parameters:

id - This parameter is required.

options - This parameter is required.

addInterfaceEndpoint

@Stability(value=Stable)
public InterfaceVpcEndpoint addInterfaceEndpoint(String id,
                                                                          InterfaceVpcEndpointOptions options)

Adds a new interface endpoint to this VPC.

Specified by:

addInterfaceEndpoint in interface IVpc

Parameters:

id - This parameter is required.

options - This parameter is required.

addS3Endpoint

@Deprecated
 @Stability(value=Deprecated)
public GatewayVpcEndpoint addS3Endpoint(String id,
                                                                                  List<SubnetSelection> subnets)

Deprecated. use `addGatewayEndpoint()` instead

Adds a new S3 gateway endpoint to this VPC.

Parameters:

id - This parameter is required.

subnets -

addS3Endpoint

@Deprecated
 @Stability(value=Deprecated)
public GatewayVpcEndpoint addS3Endpoint(String id)

Deprecated. use `addGatewayEndpoint()` instead

Adds a new S3 gateway endpoint to this VPC.

Parameters:

id - This parameter is required.

addVpnConnection

@Stability(value=Stable)
public VpnConnection addVpnConnection(String id,
                                                               VpnConnectionOptions options)

Adds a new VPN connection to this VPC.

Specified by:

addVpnConnection in interface IVpc

Parameters:

id - This parameter is required.

options - This parameter is required.

selectSubnetObjects

@Stability(value=Stable)
protected List<ISubnet> selectSubnetObjects(SubnetSelection selection)

Return the subnets appropriate for the placement strategy.

Parameters:

selection -

selectSubnetObjects

@Stability(value=Stable)
protected List<ISubnet> selectSubnetObjects()

Return the subnets appropriate for the placement strategy.

selectSubnets

@Stability(value=Stable)
public SelectedSubnets selectSubnets(SubnetSelection selection)

Returns IDs of selected subnets.

Specified by:

selectSubnets in interface IVpc

Parameters:

selection -

selectSubnets

@Stability(value=Stable)
public SelectedSubnets selectSubnets()

Returns IDs of selected subnets.

Specified by:

selectSubnets in interface IVpc

getAvailabilityZones

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

AZs for this VPC.

Specified by:

getAvailabilityZones in interface IVpc

getInternetConnectivityEstablished

@Stability(value=Stable)
public software.amazon.awscdk.core.IDependable getInternetConnectivityEstablished()

Dependencies for internet connectivity.

Specified by:

getInternetConnectivityEstablished in interface IVpc

getIsolatedSubnets

@Stability(value=Stable)
public List<ISubnet> getIsolatedSubnets()

List of isolated subnets in this VPC.

Specified by:

getIsolatedSubnets in interface IVpc

getNatDependencies

@Stability(value=Stable)
protected List<software.amazon.awscdk.core.IConstruct> getNatDependencies()

Dependencies for NAT connectivity.

getPrivateSubnets

@Stability(value=Stable)
public List<ISubnet> getPrivateSubnets()

List of private subnets in this VPC.

Specified by:

getPrivateSubnets in interface IVpc

getPublicSubnets

@Stability(value=Stable)
public List<ISubnet> getPublicSubnets()

List of public subnets in this VPC.

Specified by:

getPublicSubnets in interface IVpc

getVpcCidrBlock

@Stability(value=Stable)
public String getVpcCidrBlock()

getVpcCidrBlockAssociations

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

getVpcDefaultNetworkAcl

@Stability(value=Stable)
public String getVpcDefaultNetworkAcl()

getVpcDefaultSecurityGroup

@Stability(value=Stable)
public String getVpcDefaultSecurityGroup()

getVpcId

@Stability(value=Stable)
public String getVpcId()

Identifier for this VPC.

Specified by:

getVpcId in interface IVpc

getVpcIpv6CidrBlocks

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

getVpnGatewayId

@Stability(value=Stable)
public String getVpnGatewayId()

Identifier for the VPN gateway.

Specified by:

getVpnGatewayId in interface IVpc

getIncompleteSubnetDefinition

@Stability(value=Stable)
protected Boolean getIncompleteSubnetDefinition()

If this is set to true, don't error out on trying to select subnets.

setIncompleteSubnetDefinition

@Stability(value=Stable)
protected void setIncompleteSubnetDefinition(Boolean value)

If this is set to true, don't error out on trying to select subnets.