class VpcLink (construct)
Define a new VPC Link Specifies an API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
new VpcLink(scope: Construct, id: string, props?: VpcLinkProps)
|description?||The description of the VPC link.|
|targets?||The network load balancers of the VPC targeted by the VPC link.|
|vpc||The name used to label and identify the VPC link.|
(optional, default: no description)
The description of the VPC link.
(optional, default: no targets. Use
addTargets to add targets)
The network load balancers of the VPC targeted by the VPC link.
The network load balancers must be owned by the same AWS account of the API owner.
(optional, default: automatically generated name)
The name used to label and identify the VPC link.
|env||The environment this resource belongs to.|
|node||The construct tree node associated with this construct.|
|stack||The stack in which this resource is defined.|
|vpc||Physical ID of the VpcLink resource.|
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.
The construct tree node associated with this construct.
The stack in which this resource is defined.
Physical ID of the VpcLink resource.
|to||Returns a string representation of this construct.|
|protected validate()||Validate the current construct.|
|static from||Import a VPC Link by its Id.|
public addTargets(...targets: INetworkLoadBalancer): void
public toString(): string
Returns a string representation of this construct.
protected validate(): string
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
Vpc Link Id(scope, id, vpcLinkId)
public static fromVpcLinkId(scope: Construct, id: string, vpcLinkId: string): IVpcLink
Import a VPC Link by its Id.