Package software.amazon.awscdk.services.apigateway

Interface CfnVpcLinkProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVpcLinkProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-04-10T22:22:22.988Z")
@Stability(Stable)
public interface CfnVpcLinkProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnVpcLink.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 CfnVpcLinkProps cfnVpcLinkProps = CfnVpcLinkProps.builder()
         .name("name")
         .targetArns(List.of("targetArns"))
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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	CfnVpcLinkProps.Builder	A builder for CfnVpcLinkProps
static final class	CfnVpcLinkProps.Jsii$Proxy	An implementation for CfnVpcLinkProps

Method Summary

Modifier and Type	Method	Description
static CfnVpcLinkProps.Builder	builder()
default String	getDescription()	The description of the VPC link.
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.
List<String>	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

getName

@Stability(Stable)
@NotNull
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

getTargetArns

@Stability(Stable)
@NotNull
List<String> 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.

See Also:

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

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

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

builder

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

Returns:

a CfnVpcLinkProps.Builder of CfnVpcLinkProps