software.amazon.awscdk.services.apigateway

Interface VpcLinkProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

VpcLinkProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:01.885Z")
 @Stability(value=Experimental)
public interface VpcLinkProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for a VpcLink.

Example:

 import software.amazon.awscdk.core.*;
 Vpc vpc = new Vpc(this, "VPC");
 NetworkLoadBalancer nlb = NetworkLoadBalancer.Builder.create(this, "NLB")
         .vpc(vpc)
         .build();
 VpcLink link = VpcLink.Builder.create(this, "link")
         .targets(List.of(nlb))
         .build();
 Integration integration = Integration.Builder.create()
         .type(IntegrationType.HTTP_PROXY)
         .options(IntegrationOptions.builder()
                 .connectionType(ConnectionType.VPC_LINK)
                 .vpcLink(link)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static VpcLinkProps.Builder	builder()
default String	getDescription() (experimental) The description of the VPC link.
default List<INetworkLoadBalancer>	getTargets() (experimental) The network load balancers of the VPC targeted by the VPC link.
default String	getVpcLinkName() (experimental) The name used to label and identify the VPC link.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDescription

@Stability(value=Experimental)
 @Nullable
default String getDescription()

(experimental) The description of the VPC link.

Default: no description

getTargets

@Stability(value=Experimental)
 @Nullable
default List<INetworkLoadBalancer> getTargets()

(experimental) The network load balancers of the VPC targeted by the VPC link.

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

Default: - no targets. Use `addTargets` to add targets

getVpcLinkName

@Stability(value=Experimental)
 @Nullable
default String getVpcLinkName()

(experimental) The name used to label and identify the VPC link.

Default: - automatically generated name

builder

@Stability(value=Experimental)
static VpcLinkProps.Builder builder()

Returns:

a VpcLinkProps.Builder of VpcLinkProps