Package software.amazon.awscdk.services.apigatewayv2

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.808Z")
@Stability(Stable)
public interface VpcLinkProps
extends software.amazon.jsii.JsiiSerializable

Properties for a VpcLink.

Example:

 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 import software.amazon.awscdk.aws_apigatewayv2_integrations.HttpAlbIntegration;
 Vpc vpc = new Vpc(this, "VPC");
 ApplicationLoadBalancer alb = ApplicationLoadBalancer.Builder.create(this, "AppLoadBalancer").vpc(vpc).build();
 VpcLink vpcLink = VpcLink.Builder.create(this, "VpcLink").vpc(vpc).build();
 // Creating an HTTP ALB Integration:
 HttpAlbIntegration albIntegration = HttpAlbIntegration.Builder.create("ALBIntegration", alb.getListeners()[0]).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 List<ISecurityGroupRef>	getSecurityGroups()	A list of security groups for the VPC link.
default SubnetSelection	getSubnets()	A list of subnets for the VPC link.
IVpc	getVpc()	The VPC in which the private resources reside.
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

getVpc

@Stability(Stable)
@NotNull
IVpc getVpc()

The VPC in which the private resources reside.

getSecurityGroups

@Stability(Stable)
@Nullable
default List<ISecurityGroupRef> getSecurityGroups()

A list of security groups for the VPC link.

Default: - no security groups. Use `addSecurityGroups` to add security groups

getSubnets

@Stability(Stable)
@Nullable
default SubnetSelection getSubnets()

A list of subnets for the VPC link.

Default: - private subnets of the provided VPC. Use `addSubnets` to add more subnets

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