VpcLink

class aws_cdk.aws_apigatewayv2.VpcLink(scope, id, *, vpc, security_groups=None, subnets=None, vpc_link_name=None)

Bases: aws_cdk.core.Resource

(experimental) Define a new VPC Link Specifies an API Gateway VPC link for a HTTP API to access resources in an Amazon Virtual Private Cloud (VPC).

Stability

experimental

ExampleMetadata

infused

Example:

import aws_cdk.aws_ec2 as ec2


vpc = ec2.Vpc(self, "VPC")
vpc_link = apigwv2.VpcLink(self, "VpcLink", vpc=vpc)

Parameters

• scope (Construct) –

• id (str) –

• vpc (IVpc) – (experimental) The VPC in which the private resources reside.

• security_groups (Optional[Sequence[ISecurityGroup]]) – (experimental) A list of security groups for the VPC link. Default: - no security groups. Use addSecurityGroups to add security groups

• subnets (Union[SubnetSelection, Dict[str, Any], None]) – (experimental) A list of subnets for the VPC link. Default: - private subnets of the provided VPC. Use addSubnets to add more subnets

• vpc_link_name (Optional[str]) – (experimental) The name used to label and identify the VPC link. Default: - automatically generated name

Stability

experimental

Methods

add_security_groups(*groups)

(experimental) Adds the provided security groups to the vpc link.

Parameters

groups (ISecurityGroup) –

Stability

experimental

Return type

None

add_subnets(*subnets)

(experimental) Adds the provided subnets to the vpc link.

Parameters

subnets (ISubnet) –

Stability

experimental

Return type

None

apply_removal_policy(policy)

Apply the given removal policy to this resource.

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).

Parameters

policy (RemovalPolicy) –

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Return type

ResourceEnvironment

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

vpc

(experimental) The VPC to which this VPC Link is associated with.

Stability

experimental

Return type

IVpc

vpc_link_id

(experimental) Physical ID of the VpcLink resource.

Stability

experimental

Return type

str

Static Methods

classmethod from_vpc_link_attributes(scope, id, *, vpc, vpc_link_id)

(experimental) Import a VPC Link by specifying its attributes.

Parameters

• scope (Construct) –

• id (str) –

• vpc (IVpc) – (experimental) The VPC to which this VPC link is associated with.

• vpc_link_id (str) – (experimental) The VPC Link id.

Stability

experimental

Return type

IVpcLink

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool