software.amazon.awscdk.services.apigateway

Class VpcLink.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.VpcLink.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<VpcLink>

Enclosing class:

VpcLink

@Stability(value=Stable)
public static final class VpcLink.Builder
extends Object
implements software.amazon.jsii.Builder<VpcLink>

A fluent builder for VpcLink.

Method Summary

Modifier and Type	Method and Description
VpcLink	build()
static VpcLink.Builder	create(software.constructs.Construct scope, String id)
VpcLink.Builder	description(String description) The description of the VPC link.
VpcLink.Builder	targets(List<? extends INetworkLoadBalancer> targets) The network load balancers of the VPC targeted by the VPC link.
VpcLink.Builder	vpcLinkName(String vpcLinkName) The name used to label and identify the VPC link.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static VpcLink.Builder create(software.constructs.Construct scope,
                                                              String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of VpcLink.Builder.

description

@Stability(value=Stable)
public VpcLink.Builder description(String description)

The description of the VPC link.

Default: no description

Parameters:

description - The description of the VPC link. This parameter is required.

Returns:

this

targets

@Stability(value=Stable)
public VpcLink.Builder targets(List<? extends INetworkLoadBalancer> targets)

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

Parameters:

targets - The network load balancers of the VPC targeted by the VPC link. This parameter is required.

Returns:

this

vpcLinkName

@Stability(value=Stable)
public VpcLink.Builder vpcLinkName(String vpcLinkName)

The name used to label and identify the VPC link.

Default: - automatically generated name

Parameters:

vpcLinkName - The name used to label and identify the VPC link. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public VpcLink build()

Specified by:

build in interface software.amazon.jsii.Builder<VpcLink>