@aws-cdk/aws-ec2-alpha.IVpcV2

Experimental

@aws-cdk/aws-ec2-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

IVpcV2 Interface

Placeholder to see what extra props we might need, will be added to original IVPC.

IVpcV2

extends

• IVpc

implemented by

• VpcV2,
• VpcV2Base

Stability

Experimental

Source

lib/vpc-v2-base.ts

Properties

availabilityZonesstring[]availability_zonestyping.List[str]availabilityZonesList<String>AvailabilityZonesstring[]AvailabilityZones*[]*stringrequired#

AZs for this VPC.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

internetConnectivityEstablishedIDependableinternet_connectivity_establishedIDependableinternetConnectivityEstablishedIDependableInternetConnectivityEstablishedIDependableInternetConnectivityEstablishedIDependablerequired#

Dependable that can be depended upon to force internet connectivity established on the VPC.

ipv4CidrBlockstringipv4_cidr_blockstripv4CidrBlockStringIpv4CidrBlockstringIpv4CidrBlock*stringrequired#

The primary IPv4 CIDR block associated with the VPC.

Needed in order to validate the vpc range of subnet current prop vpcCidrBlock refers to the token value For more information, see the https://docs.aws.amazon.com/vpc/latest/userguide/vpc-cidr-blocks.html#vpc-sizing-ipv4.

ipv4IpamProvisionedCidrs?may be undefinedstring[]ipv4_ipam_provisioned_cidrs?may be undefinedtyping.List[str]ipv4IpamProvisionedCidrs?may be undefinedList<String>Ipv4IpamProvisionedCidrs?may be undefinedstring[]Ipv4IpamProvisionedCidrs?may be undefined*[]*string#

IPv4 CIDR provisioned under pool Required to check for overlapping CIDRs after provisioning is complete under IPAM pool.

isolatedSubnetsISubnet[]isolated_subnetstyping.List[ISubnet]isolatedSubnetsList<ISubnet>IsolatedSubnetsISubnet[]IsolatedSubnets*[]ISubnetrequired#

List of isolated subnets in this VPC.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

ownerAccountIdstringowner_account_idstrownerAccountIdStringOwnerAccountIdstringOwnerAccountId*stringrequired#

The ID of the AWS account that owns the VPC.

Default: the account id of the parent stack

privateSubnetsISubnet[]private_subnetstyping.List[ISubnet]privateSubnetsList<ISubnet>PrivateSubnetsISubnet[]PrivateSubnets*[]ISubnetrequired#

List of private subnets in this VPC.

publicSubnetsISubnet[]public_subnetstyping.List[ISubnet]publicSubnetsList<ISubnet>PublicSubnetsISubnet[]PublicSubnets*[]ISubnetrequired#

List of public subnets in this VPC.

regionstringregionstrregionStringRegionstringRegion*stringrequired#

Optional to override inferred region.

Default: current stack's environment region

secondaryCidrBlock?may be undefinedIVPCCidrBlock[]secondary_cidr_block?may be undefinedtyping.List[IVPCCidrBlock]secondaryCidrBlock?may be undefinedList<IVPCCidrBlock>SecondaryCidrBlock?may be undefinedIVPCCidrBlock[]SecondaryCidrBlock?may be undefined*[]IVPCCidrBlock#

The secondary CIDR blocks associated with the VPC.

For more information, see the https://docs.aws.amazon.com/vpc/latest/userguide/vpc-cidr-blocks.html#vpc-resize.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

vpcArnstringvpc_arnstrvpcArnStringVpcArnstringVpcArn*stringrequired#

ARN for this VPC.

vpcCidrBlockstringvpc_cidr_blockstrvpcCidrBlockStringVpcCidrBlockstringVpcCidrBlock*stringrequired#

CIDR range for this VPC.

vpcIdstringvpc_idstrvpcIdStringVpcIdstringVpcId*stringrequired#

Identifier for this VPC.

vpcName?may be undefinedstringvpc_name?may be undefinedstrvpcName?may be undefinedStringVpcName?may be undefinedstringVpcName?may be undefined*string#

VpcName to be used for tagging its components.

vpcRefVPCReferencevpc_refVPCReferencevpcRefVPCReferenceVpcRefVPCReferenceVpcRefVPCReferencerequired#

A reference to a VPC resource.

vpnGatewayId?may be undefinedstringvpn_gateway_id?may be undefinedstrvpnGatewayId?may be undefinedStringVpnGatewayId?may be undefinedstringVpnGatewayId?may be undefined*string#

Identifier for the VPN gateway.

Methods

addClientVpnEndpoint(id: string, options: ClientVpnEndpointOptions): ClientVpnEndpointdef add_client_vpn_endpoint(self, id: str, options: ClientVpnEndpointOptions) -> ClientVpnEndpointpublic ClientVpnEndpoint addClientVpnEndpoint(String id, ClientVpnEndpointOptions options)public ClientVpnEndpoint AddClientVpnEndpoint(string id, ClientVpnEndpointOptions options)func AddClientVpnEndpoint(Id *string, Options ClientVpnEndpointOptions) ClientVpnEndpoint#

Adds a new client VPN endpoint to this VPC.

addEgressOnlyInternetGateway(options?: EgressOnlyInternetGatewayOptions): EgressOnlyInternetGatewaydef add_egress_only_internet_gateway(self, options: typing.Optional[EgressOnlyInternetGatewayOptions] = None) -> EgressOnlyInternetGatewaypublic EgressOnlyInternetGateway addEgressOnlyInternetGateway(EgressOnlyInternetGatewayOptions options)public EgressOnlyInternetGateway AddEgressOnlyInternetGateway(EgressOnlyInternetGatewayOptions? options = null)func AddEgressOnlyInternetGateway(Options EgressOnlyInternetGatewayOptions) EgressOnlyInternetGateway#

Add an Egress only Internet Gateway to current VPC.

Can only be used for ipv6 enabled VPCs. For more information, see the https://docs.aws.amazon.com/vpc/latest/userguide/egress-only-internet-gateway-basics.html.

addFlowLog(id: string, options?: FlowLogOptions): FlowLogdef add_flow_log(self, id: str, options: typing.Optional[FlowLogOptions] = None) -> FlowLogpublic FlowLog addFlowLog(String id, FlowLogOptions options)public FlowLog AddFlowLog(string id, FlowLogOptions? options = null)func AddFlowLog(Id *string, Options FlowLogOptions) FlowLog#

Adds a new Flow Log to this VPC.

addGatewayEndpoint(id: string, options: GatewayVpcEndpointOptions): GatewayVpcEndpointdef add_gateway_endpoint(self, id: str, options: GatewayVpcEndpointOptions) -> GatewayVpcEndpointpublic GatewayVpcEndpoint addGatewayEndpoint(String id, GatewayVpcEndpointOptions options)public GatewayVpcEndpoint AddGatewayEndpoint(string id, GatewayVpcEndpointOptions options)func AddGatewayEndpoint(Id *string, Options GatewayVpcEndpointOptions) GatewayVpcEndpoint#

Adds a new gateway endpoint to this VPC.

addInterfaceEndpoint(id: string, options: InterfaceVpcEndpointOptions): InterfaceVpcEndpointdef add_interface_endpoint(self, id: str, options: InterfaceVpcEndpointOptions) -> InterfaceVpcEndpointpublic InterfaceVpcEndpoint addInterfaceEndpoint(String id, InterfaceVpcEndpointOptions options)public InterfaceVpcEndpoint AddInterfaceEndpoint(string id, InterfaceVpcEndpointOptions options)func AddInterfaceEndpoint(Id *string, Options InterfaceVpcEndpointOptions) InterfaceVpcEndpoint#

Adds a new interface endpoint to this VPC.

addInternetGateway(options?: InternetGatewayOptions): InternetGatewaydef add_internet_gateway(self, options: typing.Optional[InternetGatewayOptions] = None) -> InternetGatewaypublic InternetGateway addInternetGateway(InternetGatewayOptions options)public InternetGateway AddInternetGateway(InternetGatewayOptions? options = null)func AddInternetGateway(Options InternetGatewayOptions) InternetGateway#

Adds an Internet Gateway to current VPC.

For more information, see the https://docs.aws.amazon.com/vpc/latest/userguide/vpc-igw-internet-access.html.

addNatGateway(options: NatGatewayOptions): NatGatewaydef add_nat_gateway(self, options: NatGatewayOptions) -> NatGatewaypublic NatGateway addNatGateway(NatGatewayOptions options)public NatGateway AddNatGateway(NatGatewayOptions options)func AddNatGateway(Options NatGatewayOptions) NatGateway#

Adds a new NAT Gateway to VPC A NAT gateway is a Network Address Translation (NAT) service.

NAT Gateway Connectivity can be of type Public or Private. For more information, see the https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html.

addVpnConnection(id: string, options: VpnConnectionOptions): VpnConnectiondef add_vpn_connection(self, id: str, options: VpnConnectionOptions) -> VpnConnectionpublic VpnConnection addVpnConnection(String id, VpnConnectionOptions options)public VpnConnection AddVpnConnection(string id, VpnConnectionOptions options)func AddVpnConnection(Id *string, Options VpnConnectionOptions) VpnConnection#

Adds a new VPN connection to this VPC.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

createAcceptorVpcRole(requestorAccountId: string): Roledef create_acceptor_vpc_role(self, requestor_account_id: str) -> Rolepublic Role createAcceptorVpcRole(String requestorAccountId)public Role CreateAcceptorVpcRole(string requestorAccountId)func CreateAcceptorVpcRole(RequestorAccountId *string) Role#

Adds a new role to acceptor VPC account A cross account role is required for the VPC to peer with another account.

For more information, see the https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/peer-with-vpc-in-another-account.html.

createPeeringConnection(id: string, options: VPCPeeringConnectionOptions): VPCPeeringConnectiondef create_peering_connection(self, id: str, options: VPCPeeringConnectionOptions) -> VPCPeeringConnectionpublic VPCPeeringConnection createPeeringConnection(String id, VPCPeeringConnectionOptions options)public VPCPeeringConnection CreatePeeringConnection(string id, VPCPeeringConnectionOptions options)func CreatePeeringConnection(Id *string, Options VPCPeeringConnectionOptions) VPCPeeringConnection#

Creates a new peering connection A peering connection is a private virtual network established between two VPCs.

For more information, see the https://docs.aws.amazon.com/vpc/latest/peering/what-is-vpc-peering.html.

enableVpnGateway(options: EnableVpnGatewayOptions): voiddef enable_vpn_gateway(self, options: EnableVpnGatewayOptions) -> Nonepublic void enableVpnGateway(EnableVpnGatewayOptions options)public void EnableVpnGateway(EnableVpnGatewayOptions options)func EnableVpnGateway(Options EnableVpnGatewayOptions)#

Adds a VPN Gateway to this VPC.

enableVpnGatewayV2(options: VPNGatewayV2Options): VPNGatewayV2def enable_vpn_gateway_v2(self, options: VPNGatewayV2Options) -> VPNGatewayV2public VPNGatewayV2 enableVpnGatewayV2(VPNGatewayV2Options options)public VPNGatewayV2 EnableVpnGatewayV2(VPNGatewayV2Options options)func EnableVpnGatewayV2(Options VPNGatewayV2Options) VPNGatewayV2#

Adds VPN Gateway to VPC and set route propagation.

For more information, see the https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpngateway.html.

selectSubnets(selection?: SubnetSelection): SelectedSubnetsdef select_subnets(self, selection: typing.Optional[SubnetSelection] = None) -> SelectedSubnetspublic SelectedSubnets selectSubnets(SubnetSelection selection)public SelectedSubnets SelectSubnets(SubnetSelection? selection = null)func SelectSubnets(Selection SubnetSelection) SelectedSubnets#

Return information on the subnets appropriate for the given selection strategy.

Requires that at least one subnet is matched, throws a descriptive error message otherwise.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

• mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining