Package software.amazon.awscdk.services.apigateway

Class CfnVpcLink

java.lang.Object
software.amazon.jsii.JsiiObject
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.apigateway.CfnVpcLink
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.921Z") @Stability(Stable) public class CfnVpcLink extends CfnResource implements IInspectable
A CloudFormation AWS::ApiGateway::VpcLink.

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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnVpcLinkProps props)
      Create a new AWS::ApiGateway::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 Details

    • 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()

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of arbitrary tags (key-value pairs) to associate with the VPC link.

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

      The network load balancer must be owned by the same AWS account of the API owner.

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

      The network load balancer must be owned by the same AWS account of the API owner.

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