Package software.amazon.awscdk.services.apigatewayv2

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, IVpcLinkRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:04.354Z") @Stability(Stable) public class CfnVpcLink extends CfnResource implements IInspectable, IVpcLinkRef, 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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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)
      Create a new AWS::ApiGatewayV2::VpcLink.

      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

    • arnForVpcLink

      @Stability(Stable) @NotNull public static String arnForVpcLink(@NotNull IVpcLinkRef resource)
      Parameters:
      resource - This parameter is required.

    • fromVpcLinkId

      @Stability(Stable) @NotNull public static IVpcLinkRef fromVpcLinkId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String vpcLinkId)
      Creates a new IVpcLinkRef from a vpcLinkId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      vpcLinkId - This parameter is required.

    • isCfnVpcLink

      @Stability(Stable) @NotNull public static Boolean isCfnVpcLink(@NotNull Object x)
      Checks whether the given object is a CfnVpcLink.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull 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

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrVpcLinkId

      @Stability(Stable) @NotNull public String getAttrVpcLinkId()
      The VPC link ID.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getVpcLinkRef

      @Stability(Stable) @NotNull public VpcLinkReference getVpcLinkRef()
      A reference to a VpcLink resource.
      Specified by:
      getVpcLinkRef in interface IVpcLinkRef

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the VPC link.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the VPC link.

    • getSubnetIds

      @Stability(Stable) @NotNull public List<String> getSubnetIds()
      A list of subnet IDs to include in the VPC link.

    • setSubnetIds

      @Stability(Stable) public void setSubnetIds(@NotNull List<String> value)
      A list of subnet IDs to include in the VPC link.

    • getSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getSecurityGroupIds()
      A list of security group IDs for the VPC link.

    • setSecurityGroupIds

      @Stability(Stable) public void setSecurityGroupIds(@Nullable List<String> value)
      A list of security group IDs for the VPC link.

    • getTagsRaw

      @Stability(Stable) @Nullable public Map<String,String> getTagsRaw()
      The collection of tags.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Map<String,String> value)
      The collection of tags.