Package software.amazon.awscdk.services.directconnect

Class CfnDirectConnectGateway

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.directconnect.CfnDirectConnectGateway
All Implemented Interfaces:
IInspectable, IDirectConnectGatewayRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:41.937Z") @Stability(Stable) public class CfnDirectConnectGateway extends CfnResource implements IInspectable, IDirectConnectGatewayRef, ITaggableV2
Resource Type definition for AWS::DirectConnect::DirectConnectGateway.

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.directconnect.*;
 CfnDirectConnectGateway cfnDirectConnectGateway = CfnDirectConnectGateway.Builder.create(this, "MyCfnDirectConnectGateway")
         .directConnectGatewayName("directConnectGatewayName")
         // the properties below are optional
         .amazonSideAsn("amazonSideAsn")
         .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

    • CfnDirectConnectGateway

      protected CfnDirectConnectGateway(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDirectConnectGateway

      protected CfnDirectConnectGateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDirectConnectGateway

      @Stability(Stable) public CfnDirectConnectGateway(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDirectConnectGatewayProps props)
      Create a new AWS::DirectConnect::DirectConnectGateway.

      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

    • arnForDirectConnectGateway

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

    • isCfnDirectConnectGateway

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

      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.

    • getAttrDirectConnectGatewayArn

      @Stability(Stable) @NotNull public String getAttrDirectConnectGatewayArn()
      The ARN of the Direct Connect gateway.

    • getAttrDirectConnectGatewayId

      @Stability(Stable) @NotNull public String getAttrDirectConnectGatewayId()
      The ID of the Direct Connect gateway.

    • getCdkTagManager

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

    • getCfnProperties

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

    • getDirectConnectGatewayRef

      @Stability(Stable) @NotNull public DirectConnectGatewayReference getDirectConnectGatewayRef()
      A reference to a DirectConnectGateway resource.
      Specified by:
      getDirectConnectGatewayRef in interface IDirectConnectGatewayRef

    • getDirectConnectGatewayName

      @Stability(Stable) @NotNull public String getDirectConnectGatewayName()
      The name of the Direct Connect gateway.

    • setDirectConnectGatewayName

      @Stability(Stable) public void setDirectConnectGatewayName(@NotNull String value)
      The name of the Direct Connect gateway.

    • getAmazonSideAsn

      @Stability(Stable) @Nullable public String getAmazonSideAsn()
      The autonomous system number (ASN) for the Amazon side of the connection.

    • setAmazonSideAsn

      @Stability(Stable) public void setAmazonSideAsn(@Nullable String value)
      The autonomous system number (ASN) for the Amazon side of the connection.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags associated with the Direct Connect gateway.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags associated with the Direct Connect gateway.