Package software.amazon.awscdk.services.apigateway

Interface VpcLinkProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

VpcLinkProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T10:47:11.644Z")
@Stability(Stable)
public interface VpcLinkProps
extends software.amazon.jsii.JsiiSerializable

Properties for a VpcLink.

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	Interface	Description
static final class	VpcLinkProps.Builder	A builder for VpcLinkProps
static final class	VpcLinkProps.Jsii$Proxy	An implementation for VpcLinkProps

Method Summary

Modifier and Type	Method	Description
static VpcLinkProps.Builder	builder()
default String	getDescription()	The description of the VPC link.
default List<INetworkLoadBalancer>	getTargets()	The network load balancers of the VPC targeted by the VPC link.
default String	getVpcLinkName()	The name used to label and identify the VPC link.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the VPC link.

Default: no description

getTargets

@Stability(Stable)
@Nullable
default List<INetworkLoadBalancer> getTargets()

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.

Default: - no targets. Use `addTargets` to add targets

getVpcLinkName

@Stability(Stable)
@Nullable
default String getVpcLinkName()

The name used to label and identify the VPC link.

Default: - automatically generated name

builder

@Stability(Stable)
static VpcLinkProps.Builder builder()

Returns:

a VpcLinkProps.Builder of VpcLinkProps