software.amazon.awscdk.services.ec2

Interface VpcAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

VpcAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:06.760Z")
 @Stability(value=Experimental)
public interface VpcAttributes
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties that reference an external Vpc.

Example:

 IVpc vpc = Vpc.fromVpcAttributes(this, "VPC", VpcAttributes.builder()
         .vpcId("vpc-1234")
         .availabilityZones(List.of("us-east-1a", "us-east-1b"))
         // Either pass literals for all IDs
         .publicSubnetIds(List.of("s-12345", "s-67890"))
         // OR: import a list of known length
         .privateSubnetIds(Fn.importListValue("PrivateSubnetIds", 2))
         // OR: split an imported string to a list of known length
         .isolatedSubnetIds(Fn.split(",", StringParameter.valueForStringParameter(this, "MyParameter"), 2))
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static VpcAttributes.Builder	builder()
List<String>	getAvailabilityZones() (experimental) List of availability zones for the subnets in this VPC.
default List<String>	getIsolatedSubnetIds() (experimental) List of isolated subnet IDs.
default List<String>	getIsolatedSubnetNames() (experimental) List of names for the isolated subnets.
default List<String>	getIsolatedSubnetRouteTableIds() (experimental) List of IDs of routing tables for the isolated subnets.
default List<String>	getPrivateSubnetIds() (experimental) List of private subnet IDs.
default List<String>	getPrivateSubnetNames() (experimental) List of names for the private subnets.
default List<String>	getPrivateSubnetRouteTableIds() (experimental) List of IDs of routing tables for the private subnets.
default List<String>	getPublicSubnetIds() (experimental) List of public subnet IDs.
default List<String>	getPublicSubnetNames() (experimental) List of names for the public subnets.
default List<String>	getPublicSubnetRouteTableIds() (experimental) List of IDs of routing tables for the public subnets.
default String	getVpcCidrBlock() (experimental) VPC's CIDR range.
String	getVpcId() (experimental) VPC's identifier.
default String	getVpnGatewayId() (experimental) VPN gateway's identifier.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAvailabilityZones

@Stability(value=Experimental)
 @NotNull
List<String> getAvailabilityZones()

(experimental) List of availability zones for the subnets in this VPC.

getVpcId

@Stability(value=Experimental)
 @NotNull
String getVpcId()

(experimental) VPC's identifier.

getIsolatedSubnetIds

@Stability(value=Experimental)
 @Nullable
default List<String> getIsolatedSubnetIds()

(experimental) List of isolated subnet IDs.

Must be undefined or match the availability zones in length and order.

getIsolatedSubnetNames

@Stability(value=Experimental)
 @Nullable
default List<String> getIsolatedSubnetNames()

(experimental) List of names for the isolated subnets.

Must be undefined or have a name for every isolated subnet group.

getIsolatedSubnetRouteTableIds

@Stability(value=Experimental)
 @Nullable
default List<String> getIsolatedSubnetRouteTableIds()

(experimental) List of IDs of routing tables for the isolated subnets.

Must be undefined or have a name for every isolated subnet group.

getPrivateSubnetIds

@Stability(value=Experimental)
 @Nullable
default List<String> getPrivateSubnetIds()

(experimental) List of private subnet IDs.

Must be undefined or match the availability zones in length and order.

getPrivateSubnetNames

@Stability(value=Experimental)
 @Nullable
default List<String> getPrivateSubnetNames()

(experimental) List of names for the private subnets.

Must be undefined or have a name for every private subnet group.

getPrivateSubnetRouteTableIds

@Stability(value=Experimental)
 @Nullable
default List<String> getPrivateSubnetRouteTableIds()

(experimental) List of IDs of routing tables for the private subnets.

Must be undefined or have a name for every private subnet group.

getPublicSubnetIds

@Stability(value=Experimental)
 @Nullable
default List<String> getPublicSubnetIds()

(experimental) List of public subnet IDs.

Must be undefined or match the availability zones in length and order.

getPublicSubnetNames

@Stability(value=Experimental)
 @Nullable
default List<String> getPublicSubnetNames()

(experimental) List of names for the public subnets.

Must be undefined or have a name for every public subnet group.

getPublicSubnetRouteTableIds

@Stability(value=Experimental)
 @Nullable
default List<String> getPublicSubnetRouteTableIds()

(experimental) List of IDs of routing tables for the public subnets.

Must be undefined or have a name for every public subnet group.

getVpcCidrBlock

@Stability(value=Experimental)
 @Nullable
default String getVpcCidrBlock()

(experimental) VPC's CIDR range.

Default: - Retrieving the CIDR from the VPC will fail

getVpnGatewayId

@Stability(value=Experimental)
 @Nullable
default String getVpnGatewayId()

(experimental) VPN gateway's identifier.

builder

@Stability(value=Experimental)
static VpcAttributes.Builder builder()

Returns:

a VpcAttributes.Builder of VpcAttributes