software.amazon.awscdk.services.apigatewayv2

Class CfnVpcLink

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.apigatewayv2.CfnVpcLink

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:56.676Z")
public class CfnVpcLink
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ApiGatewayV2::VpcLink`.

The AWS::ApiGatewayV2::VpcLink resource creates a VPC link. Supported only for HTTP APIs. The VPC link status must transition from PENDING to AVAILABLE to successfully create a VPC link, which can take up to 10 minutes. To learn more, see Working with VPC Links for HTTP APIs in the API Gateway Developer Guide .

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.apigatewayv2.*;
 CfnVpcLink cfnVpcLink = CfnVpcLink.Builder.create(this, "MyCfnVpcLink")
         .name("name")
         .subnetIds(List.of("subnetIds"))
         // the properties below are optional
         .securityGroupIds(List.of("securityGroupIds"))
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnVpcLink.Builder A fluent builder for CfnVpcLink.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnVpcLink(Construct scope, java.lang.String id, CfnVpcLinkProps props) Create a new `AWS::ApiGatewayV2::VpcLink`.
protected	CfnVpcLink(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVpcLink(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrVpcLinkId()
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getName() The name of the VPC link.
java.util.List<java.lang.String>	getSecurityGroupIds() A list of security group IDs for the VPC link.
java.util.List<java.lang.String>	getSubnetIds() A list of subnet IDs to include in the VPC link.
TagManager	getTags() The collection of tags.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setName(java.lang.String value) The name of the VPC link.
void	setSecurityGroupIds(java.util.List<java.lang.String> value) A list of security group IDs for the VPC link.
void	setSubnetIds(java.util.List<java.lang.String> value) A list of subnet IDs to include in the VPC link.

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

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

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

getRef

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

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

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

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

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnVpcLink

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

CfnVpcLink

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

CfnVpcLink

public CfnVpcLink(Construct scope,
                  java.lang.String id,
                  CfnVpcLinkProps props)

Create a new `AWS::ApiGatewayV2::VpcLink`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrVpcLinkId

public java.lang.String getAttrVpcLinkId()

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The collection of tags.

Each tag element is associated with a given resource.

getName

public java.lang.String getName()

The name of the VPC link.

setName

public void setName(java.lang.String value)

The name of the VPC link.

getSubnetIds

public java.util.List<java.lang.String> getSubnetIds()

A list of subnet IDs to include in the VPC link.

setSubnetIds

public void setSubnetIds(java.util.List<java.lang.String> value)

A list of subnet IDs to include in the VPC link.

getSecurityGroupIds

public java.util.List<java.lang.String> getSecurityGroupIds()

A list of security group IDs for the VPC link.

setSecurityGroupIds

public void setSecurityGroupIds(java.util.List<java.lang.String> value)

A list of security group IDs for the VPC link.