Class CfnVpcLink
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.apigatewayv2.CfnVpcLink
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-06T23:25:03.652Z")
@Stability(Stable)
public class CfnVpcLink
extends CfnResource
implements IInspectable, ITaggable
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();
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnVpcLink
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnVpcLink
(software.amazon.jsii.JsiiObjectRef objRef) CfnVpcLink
(software.constructs.Construct scope, String id, CfnVpcLinkProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe VPC link ID.getName()
The name of the VPC link.A list of security group IDs for the VPC link.A list of subnet IDs to include in the VPC link.getTags()
Tag Manager which manages the tags for this resource.The collection of tags.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
The name of the VPC link.void
setSecurityGroupIds
(List<String> value) A list of security group IDs for the VPC link.void
setSubnetIds
(List<String> value) A list of subnet IDs to include in the VPC link.void
setTagsRaw
(Map<String, String> value) The collection of tags.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
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.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnVpcLink
protected CfnVpcLink(software.amazon.jsii.JsiiObjectRef objRef) -
CfnVpcLink
protected CfnVpcLink(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnVpcLink
@Stability(Stable) public CfnVpcLink(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnVpcLinkProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrVpcLinkId
The VPC link ID. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getName
The name of the VPC link. -
setName
The name of the VPC link. -
getSubnetIds
A list of subnet IDs to include in the VPC link. -
setSubnetIds
A list of subnet IDs to include in the VPC link. -
getSecurityGroupIds
A list of security group IDs for the VPC link. -
setSecurityGroupIds
A list of security group IDs for the VPC link. -
getTagsRaw
The collection of tags. -
setTagsRaw
The collection of tags.
-