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

Experimental

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

VpcV2Base L2 construct

Base class for creating a VPC (Virtual Private Cloud) in AWS.

For more information, see the {@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.Vpc.html AWS CDK Documentation on VPCs}.

Construct›Resource›VpcV2Base

implements

• IVpcV2,
• IResource,
• IVpc,
• IEnvironmentAware,
• IVPCRef,
• IConstruct,
• 1 more

  • IDependable

superclass of

• VpcV2

Stability

Experimental

Source

lib/vpc-v2-base.ts

Initializer

new VpcV2Base(scope: Construct, id: string, props?: ResourceProps)

VpcV2Base(scope: Construct, id: str, props: typing.Optional[ResourceProps] = None)

new VpcV2Base(Construct scope, String id, ResourceProps props)

new VpcV2Base(Construct scope, string id, ResourceProps? props = null)

NewVpcV2Base(Scope Construct, Id *string, Props ResourceProps)

Construct Props

accountstringaccountstraccountStringAccountstringAccount*string= the resource is in the same acco…#

The AWS account ID this resource belongs to.

default

Default: the resource is in the same account as the stack it belongs to

environmentFromArnstringenvironment_from_arnstrenvironmentFromArnStringEnvironmentFromArnstringEnvironmentFromArn*string= take environment from `account`,…#

ARN to deduce region and account from.

The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources.

Cannot be supplied together with either account or region.

default

Default: take environment from account, region parameters, or use Stack environment.

physicalNamestringphysical_namestrphysicalNameStringPhysicalNamestringPhysicalName*string= The physical name will be alloca…#

The value passed in by users to the physical name prop of the resource.

notes · default

• undefined implies that a physical name will be allocated by CloudFormation during deployment.
• a concrete value implies a specific physical name
• PhysicalName.GENERATE_IF_NEEDED is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.

Default: The physical name will be allocated by CloudFormation at deployment time

regionstringregionstrregionStringRegionstringRegion*string= the resource is in the same regi…#

The AWS region this resource belongs to.

default

Default: the resource is in the same region as the stack it belongs to

Properties

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

AZs for this VPC.

egressOnlyInternetGatewayIdstringegress_only_internet_gateway_idstregressOnlyInternetGatewayIdStringEgressOnlyInternetGatewayIdstringEgressOnlyInternetGatewayId*string#

Returns the id of the Egress Only Internet Gateway (if enabled).

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.

internetGatewayIdstringinternet_gateway_idstrinternetGatewayIdStringInternetGatewayIdstringInternetGatewayId*string#

Returns the id of the Internet Gateway (if enabled).

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 {@link https://docs.aws.amazon.com/vpc/latest/userguide/vpc-cidr-blocks.html#vpc-sizing-ipv4}.

ipv4IpamProvisionedCidrsstring[]ipv4_ipam_provisioned_cidrstyping.List[str]ipv4IpamProvisionedCidrsList<String>Ipv4IpamProvisionedCidrsstring[]Ipv4IpamProvisionedCidrs*[]*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#

Identifier of the owner for this VPC.

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#

Region for this VPC.

secondaryCidrBlockIVPCCidrBlock[]secondary_cidr_blocktyping.List[IVPCCidrBlock]secondaryCidrBlockList<IVPCCidrBlock>SecondaryCidrBlockIVPCCidrBlock[]SecondaryCidrBlock*[]IVPCCidrBlock#

Secondary IPs for the VPC, can be multiple Ipv4 or Ipv6 Ipv4 should be within RFC#1918 range.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

vpcArnstringvpc_arnstrvpcArnStringVpcArnstringVpcArn*stringrequired#

Arn of this VPC.

vpcCidrBlockstringvpc_cidr_blockstrvpcCidrBlockStringVpcCidrBlockstringVpcCidrBlock*stringrequired#

CIDR range for this VPC.

vpcIdstringvpc_idstrvpcIdStringVpcIdstringVpcId*stringrequired#

Identifier for this VPC.

vpcNamestringvpc_namestrvpcNameStringVpcNamestringVpcName*string#

VpcName to be used for tagging its components.

vpcRefVPCReferencevpc_refVPCReferencevpcRefVPCReferenceVpcRefVPCReferenceVpcRefVPCReferencerequired#

A reference to a VPC resource.

vpnGatewayIdstringvpn_gateway_idstrvpnGatewayIdStringVpnGatewayIdstringVpnGatewayId*string#

Returns the id of the VPN Gateway (if enabled).

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#

Adds a new Egress Only Internet Gateway to this VPC and defines a new route to the route table of given subnets.

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 a new Internet Gateway to this VPC.

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 the given subnet of this VPC of given subnets.

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.

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Override the cross-stack reference strength for this resource.

notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

• strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

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#

Creates peering connection role for acceptor VPC.

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 peering connection.

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

use enableVpnGatewayV2 for compatibility with VPCV2.Route

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 VPNGAtewayV2 to this VPC.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

• xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#

Returns true if the construct was created by CDK, and false otherwise.

isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#

Check whether the given construct is a Resource.

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.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

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. Use multiple with() calls if subsequent mixins should apply to added constructs.