aws-cdk-lib.aws_apigateway.CfnVpcLinkProps

CfnVpcLinkProps Struct

Properties for defining a CfnVpcLink.

CfnVpcLinkProps

used as props by

• CfnVpcLink

Source

Generated code

Type last changed

v2.227.0 · 21 Nov 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
const cfnVpcLinkProps: apigateway.CfnVpcLinkProps = {
  name: 'name',
  targetArns: ['targetArns'],

  // the properties below are optional
  description: 'description',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

The description of the VPC link.

namestringnamestrnameStringNamestringName*stringrequired#

The name used to label and identify the VPC link.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

An array of arbitrary tags (key-value pairs) to associate with the VPC link.

targetArnsstring | ILoadBalancerRef[]target_arnstyping.List[typing.Union[str, ILoadBalancerRef]]targetArnsList<String>TargetArnsstring[]TargetArns*[]interface{}required#

The ARN of the network load balancer of the VPC targeted by the VPC link.

The network load balancer must be owned by the same AWS account of the API owner.