Vpc

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.Resource
    - - software.amazon.awscdk.services.ec2.Vpc

All Implemented Interfaces:: IConstruct, IDependable, IResource, IVpc

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:22.366Z")
public class Vpc
extends 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:

 Vpc vpc = Vpc.Builder.create(this, "TheVPC")
         .cidr("10.0.0.0/16")
         .build();
 // Iterate the private subnets
 SelectedSubnets selection = vpc.selectSubnets(SubnetSelection.builder()
         .subnetType(SubnetType.PRIVATE_WITH_NAT)
         .build());
 for (Object subnet : selection.getSubnets()) {
 }

Example:

 import software.amazon.awscdk.services.ec2.*;
 Vpc vpc = Vpc.Builder.create(this, "Vpc")
         .cidr("10.0.0.0/16")
         .build();
 VpcConnector vpcConnector = VpcConnector.Builder.create(this, "VpcConnector")
         .vpc(vpc)
         .vpcSubnets(vpc.selectSubnets(SubnetSelection.builder().subnetType(SubnetType.PUBLIC).build()))
         .vpcConnectorName("MyVpcConnector")
         .build();
 Service.Builder.create(this, "Service")
         .source(Source.fromEcrPublic(EcrPublicProps.builder()
                 .imageConfiguration(ImageConfiguration.builder().port(8000).build())
                 .imageIdentifier("public.ecr.aws/aws-containers/hello-app-runner:latest")
                 .build()))
         .vpcConnector(vpcConnector)
         .build();

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Vpc.Builder
A fluent builder for Vpc.
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IVpc
  IVpc.Jsii$Default, IVpc.Jsii$Proxy

Nested Classes
Modifier and Type	Class and Description
`static class`	`Vpc.Builder` A fluent builder for `Vpc`.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_CIDR_RANGE` The default CIDR range used when creating VPCs.
`static java.util.List<SubnetConfiguration>`	`DEFAULT_SUBNETS` The default subnet configuration.
`static java.util.List<SubnetConfiguration>`	`DEFAULT_SUBNETS_NO_NAT` The default subnet configuration if natGateways specified to be 0.

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ClientVpnEndpoint`	`addClientVpnEndpoint(java.lang.String id, ClientVpnEndpointOptions options)` Adds a new client VPN endpoint to this VPC.
`GatewayVpcEndpoint`	`addDynamoDbEndpoint(java.lang.String id)` Deprecated. use `addGatewayEndpoint()` instead
`GatewayVpcEndpoint`	`addDynamoDbEndpoint(java.lang.String id, java.util.List<SubnetSelection> subnets)` Deprecated. use `addGatewayEndpoint()` instead
`FlowLog`	`addFlowLog(java.lang.String id)` Adds a new flow log to this VPC.
`FlowLog`	`addFlowLog(java.lang.String id, FlowLogOptions options)` Adds a new flow log to this VPC.
`GatewayVpcEndpoint`	`addGatewayEndpoint(java.lang.String id, GatewayVpcEndpointOptions options)` Adds a new gateway endpoint to this VPC.
`InterfaceVpcEndpoint`	`addInterfaceEndpoint(java.lang.String id, InterfaceVpcEndpointOptions options)` Adds a new interface endpoint to this VPC.
`GatewayVpcEndpoint`	`addS3Endpoint(java.lang.String id)` Deprecated. use `addGatewayEndpoint()` instead
`GatewayVpcEndpoint`	`addS3Endpoint(java.lang.String id, java.util.List<SubnetSelection> subnets)` Deprecated. use `addGatewayEndpoint()` instead
`VpnConnection`	`addVpnConnection(java.lang.String id, VpnConnectionOptions options)` Adds a new VPN connection to this VPC.
`void`	`enableVpnGateway(EnableVpnGatewayOptions options)` Adds a VPN Gateway to this VPC.
`static IVpc`	`fromLookup(software.constructs.Construct scope, java.lang.String id, VpcLookupOptions options)` Import an existing VPC from by querying the AWS environment this stack is deployed to.
`static IVpc`	`fromVpcAttributes(software.constructs.Construct scope, java.lang.String id, VpcAttributes attrs)` Import a VPC by supplying all attributes directly.
`java.util.List<java.lang.String>`	`getAvailabilityZones()` AZs for this VPC.
`java.lang.Boolean`	`getDnsHostnamesEnabled()` Indicates if instances launched in this VPC will have public DNS hostnames.
`java.lang.Boolean`	`getDnsSupportEnabled()` Indicates if DNS support is enabled for this VPC.
`protected java.lang.Boolean`	`getIncompleteSubnetDefinition()` If this is set to true, don't error out on trying to select subnets.
`IDependable`	`getInternetConnectivityEstablished()` Dependencies for internet connectivity.
`java.lang.String`	`getInternetGatewayId()` Internet Gateway for the VPC.
`java.util.List<ISubnet>`	`getIsolatedSubnets()` List of isolated subnets in this VPC.
`protected java.util.List<IConstruct>`	`getNatDependencies()` Deprecated. - This value is no longer used.
`java.util.List<ISubnet>`	`getPrivateSubnets()` List of private subnets in this VPC.
`java.util.List<ISubnet>`	`getPublicSubnets()` List of public subnets in this VPC.
`java.lang.String`	`getVpcArn()` Arn of this VPC.
`java.lang.String`	`getVpcCidrBlock()` CIDR range for this VPC.
`java.util.List<java.lang.String>`	`getVpcCidrBlockAssociations()`
`java.lang.String`	`getVpcDefaultNetworkAcl()`
`java.lang.String`	`getVpcDefaultSecurityGroup()`
`java.lang.String`	`getVpcId()` Identifier for this VPC.
`java.util.List<java.lang.String>`	`getVpcIpv6CidrBlocks()`
`java.lang.String`	`getVpnGatewayId()` Returns the id of the VPN Gateway (if enabled).
`protected java.util.List<ISubnet>`	`selectSubnetObjects()` Return the subnets appropriate for the placement strategy.
`protected java.util.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(java.lang.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
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource
applyRemovalPolicy, getEnv, getStack

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

- Field Detail
  - DEFAULT_CIDR_RANGE
```
public static final java.lang.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
```
public static final java.util.List<SubnetConfiguration> DEFAULT_SUBNETS
```
    The default subnet configuration.
    1 Public and 1 Private subnet per AZ evenly split
  - DEFAULT_SUBNETS_NO_NAT
```
public static final java.util.List<SubnetConfiguration> DEFAULT_SUBNETS_NO_NAT
```
    The default subnet configuration if natGateways specified to be 0.
    1 Public and 1 Isolated 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
```
public Vpc(software.constructs.Construct scope,
           java.lang.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
```
public Vpc(software.constructs.Construct scope,
           java.lang.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
```
public static IVpc fromLookup(software.constructs.Construct scope,
                              java.lang.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.
    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).
    The VPC information will be cached in cdk.context.json and the same VPC will be used on future runs. To refresh the lookup, you will have to evict the value from the cache using the cdk context command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for more information.
    
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    options - This parameter is required.
  - fromVpcAttributes
```
public static IVpc fromVpcAttributes(software.constructs.Construct scope,
                                     java.lang.String id,
                                     VpcAttributes attrs)
```
    Import a VPC by supplying all attributes directly.
    NOTE: using fromVpcAttributes() with deploy-time parameters (like a Fn.importValue() or CfnParameter to represent a list of subnet IDs) sometimes accidentally works. It happens to work for constructs that need a list of subnets (like AutoScalingGroup and eks.Cluster) but it does not work for constructs that need individual subnets (like Instance). See https://github.com/aws/aws-cdk/issues/4118 for more information.
    Prefer to use Vpc.fromLookup() instead.
    
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    attrs - This parameter is required.
  - addClientVpnEndpoint
```
public ClientVpnEndpoint addClientVpnEndpoint(java.lang.String id,
                                              ClientVpnEndpointOptions options)
```
    Adds a new client VPN endpoint to this VPC.
    
    Specified by:
    
    addClientVpnEndpoint in interface IVpc
    
    Parameters:
    
    id - This parameter is required.
    
    options - This parameter is required.
  - addDynamoDbEndpoint
```
@Deprecated
public GatewayVpcEndpoint addDynamoDbEndpoint(java.lang.String id,
                                                          java.util.List<SubnetSelection> subnets)
```
    Deprecated. use `addGatewayEndpoint()` instead
    
    (deprecated) Adds a new DynamoDB gateway endpoint to this VPC.
    
    Parameters:
    
    id - This parameter is required.
    
    subnets -
  - addDynamoDbEndpoint
```
@Deprecated
public GatewayVpcEndpoint addDynamoDbEndpoint(java.lang.String id)
```
    Deprecated. use `addGatewayEndpoint()` instead
    
    (deprecated) Adds a new DynamoDB gateway endpoint to this VPC.
    
    Parameters:
    
    id - This parameter is required.
  - addFlowLog
```
public FlowLog addFlowLog(java.lang.String id,
                          FlowLogOptions options)
```
    Adds a new flow log to this VPC.
    
    Specified by:
    
    addFlowLog in interface IVpc
    
    Parameters:
    
    id - This parameter is required.
    
    options -
  - addFlowLog
```
public FlowLog addFlowLog(java.lang.String id)
```
    Adds a new flow log to this VPC.
    
    Specified by:
    
    addFlowLog in interface IVpc
    
    Parameters:
    
    id - This parameter is required.
  - addGatewayEndpoint
```
public GatewayVpcEndpoint addGatewayEndpoint(java.lang.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
```
public InterfaceVpcEndpoint addInterfaceEndpoint(java.lang.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
public GatewayVpcEndpoint addS3Endpoint(java.lang.String id,
                                                    java.util.List<SubnetSelection> subnets)
```
    Deprecated. use `addGatewayEndpoint()` instead
    
    (deprecated) Adds a new S3 gateway endpoint to this VPC.
    
    Parameters:
    
    id - This parameter is required.
    
    subnets -
  - addS3Endpoint
```
@Deprecated
public GatewayVpcEndpoint addS3Endpoint(java.lang.String id)
```
    Deprecated. use `addGatewayEndpoint()` instead
    
    (deprecated) Adds a new S3 gateway endpoint to this VPC.
    
    Parameters:
    
    id - This parameter is required.
  - addVpnConnection
```
public VpnConnection addVpnConnection(java.lang.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.
  - enableVpnGateway
```
public void enableVpnGateway(EnableVpnGatewayOptions options)
```
    Adds a VPN Gateway to this VPC.
    
    Specified by:
    
    enableVpnGateway in interface IVpc
    
    Parameters:
    
    options - This parameter is required.
  - selectSubnetObjects
```
protected java.util.List<ISubnet> selectSubnetObjects(SubnetSelection selection)
```
    Return the subnets appropriate for the placement strategy.
    
    Parameters:
    
    selection -
  - selectSubnetObjects
```
protected java.util.List<ISubnet> selectSubnetObjects()
```
    Return the subnets appropriate for the placement strategy.
  - selectSubnets
```
public SelectedSubnets selectSubnets(SubnetSelection selection)
```
    Returns IDs of selected subnets.
    
    Specified by:
    
    selectSubnets in interface IVpc
    
    Parameters:
    
    selection -
  - selectSubnets
```
public SelectedSubnets selectSubnets()
```
    Returns IDs of selected subnets.
    
    Specified by:
    
    selectSubnets in interface IVpc
  - getAvailabilityZones
```
public java.util.List<java.lang.String> getAvailabilityZones()
```
    AZs for this VPC.
    
    Specified by:
    
    getAvailabilityZones in interface IVpc
  - getDnsHostnamesEnabled
```
public java.lang.Boolean getDnsHostnamesEnabled()
```
    Indicates if instances launched in this VPC will have public DNS hostnames.
  - getDnsSupportEnabled
```
public java.lang.Boolean getDnsSupportEnabled()
```
    Indicates if DNS support is enabled for this VPC.
  - getInternetConnectivityEstablished
```
public IDependable getInternetConnectivityEstablished()
```
    Dependencies for internet connectivity.
    
    Specified by:
    
    getInternetConnectivityEstablished in interface IVpc
  - getIsolatedSubnets
```
public java.util.List<ISubnet> getIsolatedSubnets()
```
    List of isolated subnets in this VPC.
    
    Specified by:
    
    getIsolatedSubnets in interface IVpc
  - getNatDependencies
```
@Deprecated
protected java.util.List<IConstruct> getNatDependencies()
```
    Deprecated. - This value is no longer used.
    
    (deprecated) Dependencies for NAT connectivity.
  - getPrivateSubnets
```
public java.util.List<ISubnet> getPrivateSubnets()
```
    List of private subnets in this VPC.
    
    Specified by:
    
    getPrivateSubnets in interface IVpc
  - getPublicSubnets
```
public java.util.List<ISubnet> getPublicSubnets()
```
    List of public subnets in this VPC.
    
    Specified by:
    
    getPublicSubnets in interface IVpc
  - getVpcArn
```
public java.lang.String getVpcArn()
```
    Arn of this VPC.
    
    Specified by:
    
    getVpcArn in interface IVpc
  - getVpcCidrBlock
```
public java.lang.String getVpcCidrBlock()
```
    CIDR range for this VPC.
    
    Specified by:
    
    getVpcCidrBlock in interface IVpc
  - getVpcCidrBlockAssociations
```
public java.util.List<java.lang.String> getVpcCidrBlockAssociations()
```
  - getVpcDefaultNetworkAcl
```
public java.lang.String getVpcDefaultNetworkAcl()
```
  - getVpcDefaultSecurityGroup
```
public java.lang.String getVpcDefaultSecurityGroup()
```
  - getVpcId
```
public java.lang.String getVpcId()
```
    Identifier for this VPC.
    
    Specified by:
    
    getVpcId in interface IVpc
  - getVpcIpv6CidrBlocks
```
public java.util.List<java.lang.String> getVpcIpv6CidrBlocks()
```
  - getInternetGatewayId
```
public java.lang.String getInternetGatewayId()
```
    Internet Gateway for the VPC.
    Note that in case the VPC is configured only with ISOLATED subnets, this attribute will be undefined.
  - getVpnGatewayId
```
public java.lang.String getVpnGatewayId()
```
    Returns the id of the VPN Gateway (if enabled).
    
    Specified by:
    
    getVpnGatewayId in interface IVpc
  - getIncompleteSubnetDefinition
```
protected java.lang.Boolean getIncompleteSubnetDefinition()
```
    If this is set to true, don't error out on trying to select subnets.
  - setIncompleteSubnetDefinition
```
protected void setIncompleteSubnetDefinition(java.lang.Boolean value)
```
    If this is set to true, don't error out on trying to select subnets.

Class Vpc

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

Field Detail

DEFAULT_CIDR_RANGE

DEFAULT_SUBNETS

DEFAULT_SUBNETS_NO_NAT

Constructor Detail

Vpc

Vpc

Vpc

Vpc

Method Detail

fromLookup

fromVpcAttributes

addClientVpnEndpoint

addDynamoDbEndpoint

addDynamoDbEndpoint

addFlowLog

addFlowLog

addGatewayEndpoint

addInterfaceEndpoint

addS3Endpoint

addS3Endpoint

addVpnConnection

enableVpnGateway

selectSubnetObjects

selectSubnetObjects

selectSubnets

selectSubnets

getAvailabilityZones

getDnsHostnamesEnabled

getDnsSupportEnabled

getInternetConnectivityEstablished

getIsolatedSubnets

getNatDependencies

getPrivateSubnets

getPublicSubnets

getVpcArn

getVpcCidrBlock

getVpcCidrBlockAssociations

getVpcDefaultNetworkAcl

getVpcDefaultSecurityGroup

getVpcId

getVpcIpv6CidrBlocks

getInternetGatewayId

getVpnGatewayId

getIncompleteSubnetDefinition

setIncompleteSubnetDefinition