Package software.amazon.awscdk.services.apigateway

Class VpcLink

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.apigateway.VpcLink

All Implemented Interfaces:

IVpcLinkRef, IEnvironmentAware, IResource, IVpcLink, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:13.764Z")
@Stability(Stable)
public class VpcLink
extends Resource
implements IVpcLink

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

Example:

 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 Vpc vpc = new Vpc(this, "VPC");
 NetworkLoadBalancer nlb = NetworkLoadBalancer.Builder.create(this, "NLB")
         .vpc(vpc)
         .build();
 VpcLink link = VpcLink.Builder.create(this, "link")
         .targets(List.of(nlb))
         .build();
 Integration integration = Integration.Builder.create()
         .type(IntegrationType.HTTP_PROXY)
         .integrationHttpMethod("ANY")
         .options(IntegrationOptions.builder()
                 .connectionType(ConnectionType.VPC_LINK)
                 .vpcLink(link)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	VpcLink.Builder	A fluent builder for VpcLink.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.IVpcLink

IVpcLink.Jsii$Default, IVpcLink.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VpcLink(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	VpcLink(software.amazon.jsii.JsiiObjectRef objRef)
	VpcLink(software.constructs.Construct scope, String id)
	VpcLink(software.constructs.Construct scope, String id, VpcLinkProps props)

Method Summary

Modifier and Type	Method	Description
void	addTargets(INetworkLoadBalancer... targets)
static IVpcLink	fromVpcLinkId(software.constructs.Construct scope, String id, String vpcLinkId)	Import a VPC Link by its Id.
String	getVpcLinkId()	Physical ID of the VpcLink resource.
VpcLinkReference	getVpcLinkRef()	A reference to a VpcLink resource.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.awscdk.services.apigateway.IVpcLink

getEnv, getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

VpcLink

protected VpcLink(software.amazon.jsii.JsiiObjectRef objRef)

VpcLink

protected VpcLink(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

VpcLink

@Stability(Stable)
public VpcLink(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 VpcLinkProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

VpcLink

@Stability(Stable)
public VpcLink(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

fromVpcLinkId

@Stability(Stable)
@NotNull
public static IVpcLink fromVpcLinkId(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String vpcLinkId)

Import a VPC Link by its Id.

Parameters:

scope - This parameter is required.

id - This parameter is required.

vpcLinkId - This parameter is required.

addTargets

@Stability(Stable)
public void addTargets(@NotNull
 INetworkLoadBalancer... targets)

Parameters:

targets - This parameter is required.

getVpcLinkId

@Stability(Stable)
@NotNull
public String getVpcLinkId()

Physical ID of the VpcLink resource.

Specified by:

getVpcLinkId in interface IVpcLink

getVpcLinkRef

@Stability(Stable)
@NotNull
public VpcLinkReference getVpcLinkRef()

A reference to a VpcLink resource.

Specified by:

getVpcLinkRef in interface IVpcLinkRef