Package software.amazon.awscdk.services.apigateway

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.apigateway.CfnVpcLink
All Implemented Interfaces:
IInspectable, ITaggable, IVpcLinkRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)", date="2025-10-14T12:28:04.103Z") @Stability(Stable) public class CfnVpcLink extends CfnResource implements IInspectable, IVpcLinkRef, ITaggable
The AWS::ApiGateway::VpcLink resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC).

For more information, see vpclink:create in the Amazon API Gateway REST API Reference .

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.apigateway.*;
 CfnVpcLink cfnVpcLink = CfnVpcLink.Builder.create(this, "MyCfnVpcLink")
         .name("name")
         .targetArns(List.of("targetArns"))
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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)
      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

    • 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.

    • 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 ID for the VPC link.

      For example: abc123 .

    • 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 used to label and identify the VPC link.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name used to label and identify the VPC link.

    • getTargetArns

      @Stability(Stable) @NotNull public List<String> getTargetArns()
      The ARN of the network load balancer of the VPC targeted by the VPC link.

    • setTargetArns

      @Stability(Stable) public void setTargetArns(@NotNull List<String> value)
      The ARN of the network load balancer of the VPC targeted by the VPC link.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the VPC link.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the VPC link.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of arbitrary tags (key-value pairs) to associate with the VPC link.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of arbitrary tags (key-value pairs) to associate with the VPC link.