@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:56.676Z") public class CfnVpcLink extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnVpcLink.Builder
A fluent builder for
CfnVpcLink . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnVpcLink(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnVpcLink(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnVpcLink(Construct scope, java.lang.String id, CfnVpcLinkProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrVpcLinkId()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
Each tag element is associated with a given resource.
public java.lang.String getName()
public void setName(java.lang.String value)
public java.util.List<java.lang.String> getSubnetIds()
public void setSubnetIds(java.util.List<java.lang.String> value)
public java.util.List<java.lang.String> getSecurityGroupIds()
public void setSecurityGroupIds(java.util.List<java.lang.String> value)