interface VpcLinkProps

Language	Type name
.NET	Amazon.CDK.AWS.Apigatewayv2.VpcLinkProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#VpcLinkProps
Java	software.amazon.awscdk.services.apigatewayv2.VpcLinkProps
Python	aws_cdk.aws_apigatewayv2.VpcLinkProps
TypeScript (source)	aws-cdk-lib » aws_apigatewayv2 » VpcLinkProps

Properties for a VpcLink.

Example

import * as ec2 from 'aws-cdk-lib/aws-ec2';
import * as elb from 'aws-cdk-lib/aws-elasticloadbalancingv2';
import { HttpAlbIntegration } from 'aws-cdk-lib/aws-apigatewayv2-integrations';

const vpc = new ec2.Vpc(this, 'VPC');
const alb = new elb.ApplicationLoadBalancer(this, 'AppLoadBalancer', { vpc });

const vpcLink = new apigwv2.VpcLink(this, 'VpcLink', { vpc });

// Creating an HTTP ALB Integration:
const albIntegration = new HttpAlbIntegration('ALBIntegration', alb.listeners[0], {});

Properties

Name	Type	Description
vpc	IVpc	The VPC in which the private resources reside.
securityGroups?	ISecurityGroupRef[]	A list of security groups for the VPC link.
subnets?	SubnetSelection	A list of subnets for the VPC link.
vpcLinkName?	string	The name used to label and identify the VPC link.

---

vpc

Type: IVpc

The VPC in which the private resources reside.

---

securityGroups?

Type: ISecurityGroupRef[] (optional, default: no security groups. Use addSecurityGroups to add security groups)

A list of security groups for the VPC link.

---

subnets?

Type: SubnetSelection (optional, default: private subnets of the provided VPC. Use addSubnets to add more subnets)

A list of subnets for the VPC link.

---

vpcLinkName?

Type: string (optional, default: automatically generated name)

The name used to label and identify the VPC link.