software.amazon.awscdk.services.apigatewayv2

Class VpcLink

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.apigatewayv2.VpcLink

All Implemented Interfaces:

IDependable, IResource, IVpcLink, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-19T23:09:29.960Z")
 @Stability(value=Experimental)
public class VpcLink
extends Resource
implements IVpcLink

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

Example:

 import software.amazon.awscdk.services.ec2.*;
 Vpc vpc = new Vpc(this, "VPC");
 VpcLink vpcLink = VpcLink.Builder.create(this, "VpcLink").vpc(vpc).build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VpcLink.Builder (experimental) A fluent builder for VpcLink.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IVpcLink.Jsii$Default, IVpcLink.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addSecurityGroups(ISecurityGroup... groups) (experimental) Adds the provided security groups to the vpc link.
void	addSubnets(ISubnet... subnets) (experimental) Adds the provided subnets to the vpc link.
static IVpcLink	fromVpcLinkAttributes(software.constructs.Construct scope, String id, VpcLinkAttributes attrs) (experimental) Import a VPC Link by specifying its attributes.
IVpc	getVpc() (experimental) The VPC to which this VPC Link is associated with.
String	getVpcLinkId() (experimental) Physical ID of the VpcLink resource.

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, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

VpcLink

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

VpcLink

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

VpcLink

@Stability(value=Experimental)
public VpcLink(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              VpcLinkProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromVpcLinkAttributes

@Stability(value=Experimental)
 @NotNull
public static IVpcLink fromVpcLinkAttributes(@NotNull
                                                                                      software.constructs.Construct scope,
                                                                                      @NotNull
                                                                                      String id,
                                                                                      @NotNull
                                                                                      VpcLinkAttributes attrs)

(experimental) Import a VPC Link by specifying its attributes.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addSecurityGroups

@Stability(value=Experimental)
public void addSecurityGroups(@NotNull
                                                             ISecurityGroup... groups)

(experimental) Adds the provided security groups to the vpc link.

Parameters:

groups - This parameter is required.

addSubnets

@Stability(value=Experimental)
public void addSubnets(@NotNull
                                                      ISubnet... subnets)

(experimental) Adds the provided subnets to the vpc link.

Parameters:

subnets - This parameter is required.

getVpc

@Stability(value=Experimental)
 @NotNull
public IVpc getVpc()

(experimental) The VPC to which this VPC Link is associated with.

Specified by:

getVpc in interface IVpcLink

getVpcLinkId

@Stability(value=Experimental)
 @NotNull
public String getVpcLinkId()

(experimental) Physical ID of the VpcLink resource.

Specified by:

getVpcLinkId in interface IVpcLink