Package software.amazon.awscdk.cfnpropertymixins.services.apigateway

Interface CfnVpcLinkMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVpcLinkMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.496Z")
@Stability(Stable)
public interface CfnVpcLinkMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnVpcLinkPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.apigateway.*;
 CfnVpcLinkMixinProps cfnVpcLinkMixinProps = CfnVpcLinkMixinProps.builder()
         .description("description")
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetArns(List.of("targetArns"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnVpcLinkMixinProps.Builder	A builder for CfnVpcLinkMixinProps
static final class	CfnVpcLinkMixinProps.Jsii$Proxy	An implementation for CfnVpcLinkMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnVpcLinkMixinProps.Builder	builder()
default String	getDescription()	The description of the VPC link.
default String	getName()	The name used to label and identify the VPC link.
default List<CfnTag>	getTags()	An array of arbitrary tags (key-value pairs) to associate with the VPC link.
default List<Object>	getTargetArns()	The ARN of the network load balancer of the VPC targeted by 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-description

getName

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

The name used to label and identify the VPC link.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-name

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-tags

getTargetArns

@Stability(Stable)
@Nullable
default List<Object> getTargetArns()

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.

Returns union: Listinvalid input: '<'either String or ILoadBalancerRef>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-targetarns

builder

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

Returns:

a CfnVpcLinkMixinProps.Builder of CfnVpcLinkMixinProps