software.amazon.awscdk.services.apigateway

Class VpcLink

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.apigateway.VpcLink

All Implemented Interfaces:

IConstruct, IDependable, IResource, IVpcLink

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:42.206Z")
public class VpcLink
extends Resource
implements IVpcLink

Define a new VPC Link Specifies an API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

Example:

 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 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	Class and Description
static class	VpcLink.Builder A fluent builder for VpcLink.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.IVpcLink

IVpcLink.Jsii$Default, IVpcLink.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VpcLink(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	VpcLink(software.amazon.jsii.JsiiObjectRef objRef)
	VpcLink(software.constructs.Construct scope, java.lang.String id)
	VpcLink(software.constructs.Construct scope, java.lang.String id, VpcLinkProps props)

Method Summary

Modifier and Type	Method and Description
void	addTargets(INetworkLoadBalancer... targets)
static IVpcLink	fromVpcLinkId(software.constructs.Construct scope, java.lang.String id, java.lang.String vpcLinkId) Import a VPC Link by its Id.
java.lang.String	getVpcLinkId() Physical ID of the VpcLink resource.
protected java.util.List<java.lang.String>	validate() Validate the current construct.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

VpcLink

protected VpcLink(software.amazon.jsii.JsiiObjectRef objRef)

VpcLink

protected VpcLink(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

VpcLink

public VpcLink(software.constructs.Construct scope,
               java.lang.String id,
               VpcLinkProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

VpcLink

public VpcLink(software.constructs.Construct scope,
               java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromVpcLinkId

public static IVpcLink fromVpcLinkId(software.constructs.Construct scope,
                                     java.lang.String id,
                                     java.lang.String vpcLinkId)

Import a VPC Link by its Id.

Parameters:

scope - This parameter is required.

id - This parameter is required.

vpcLinkId - This parameter is required.

addTargets

public void addTargets(INetworkLoadBalancer... targets)

Parameters:

targets - This parameter is required.

validate

protected java.util.List<java.lang.String> validate()

Validate the current construct.

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Overrides:

validate in class Construct

Returns:

An array of validation error messages, or an empty array if the construct is valid.

getVpcLinkId

public java.lang.String getVpcLinkId()

Physical ID of the VpcLink resource.

Specified by:

getVpcLinkId in interface IVpcLink