Package software.amazon.awscdk.services.networkmanager

Class CfnDirectConnectGatewayAttachment

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.networkmanager.CfnDirectConnectGatewayAttachment
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, IDirectConnectGatewayAttachmentRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:10.266Z") @Stability(Stable) public class CfnDirectConnectGatewayAttachment extends CfnResource implements IInspectable, IDirectConnectGatewayAttachmentRef, ITaggableV2
Creates an AWS Direct Connect gateway attachment.

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.networkmanager.*;
 CfnDirectConnectGatewayAttachment cfnDirectConnectGatewayAttachment = CfnDirectConnectGatewayAttachment.Builder.create(this, "MyCfnDirectConnectGatewayAttachment")
         .coreNetworkId("coreNetworkId")
         .directConnectGatewayArn("directConnectGatewayArn")
         .edgeLocations(List.of("edgeLocations"))
         // the properties below are optional
         .proposedNetworkFunctionGroupChange(ProposedNetworkFunctionGroupChangeProperty.builder()
                 .attachmentPolicyRuleNumber(123)
                 .networkFunctionGroupName("networkFunctionGroupName")
                 .tags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build())
         .proposedSegmentChange(ProposedSegmentChangeProperty.builder()
                 .attachmentPolicyRuleNumber(123)
                 .segmentName("segmentName")
                 .tags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build())
         .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

    • CfnDirectConnectGatewayAttachment

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

    • CfnDirectConnectGatewayAttachment

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

    • CfnDirectConnectGatewayAttachment

      @Stability(Stable) public CfnDirectConnectGatewayAttachment(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDirectConnectGatewayAttachmentProps 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

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

    • getAttrAttachmentId

      @Stability(Stable) @NotNull public String getAttrAttachmentId()
      Id of the attachment.

    • getAttrAttachmentPolicyRuleNumber

      @Stability(Stable) @NotNull public Number getAttrAttachmentPolicyRuleNumber()
      The policy rule number associated with the attachment.

    • getAttrAttachmentType

      @Stability(Stable) @NotNull public String getAttrAttachmentType()
      Attachment type.

    • getAttrCoreNetworkArn

      @Stability(Stable) @NotNull public String getAttrCoreNetworkArn()
      The ARN of a core network for the Direct Connect Gateway attachment.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      Creation time of the attachment.

    • getAttrLastModificationErrors

      @Stability(Stable) @NotNull public List<String> getAttrLastModificationErrors()
      Errors from the last modification of the attachment.

    • getAttrNetworkFunctionGroupName

      @Stability(Stable) @NotNull public String getAttrNetworkFunctionGroupName()
      The name of the network function group.

    • getAttrOwnerAccountId

      @Stability(Stable) @NotNull public String getAttrOwnerAccountId()
      Owner account of the attachment.

    • getAttrResourceArn

      @Stability(Stable) @NotNull public String getAttrResourceArn()
      The ARN of the Resource.

    • getAttrSegmentName

      @Stability(Stable) @NotNull public String getAttrSegmentName()
      The name of the segment attachment..

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      State of the attachment.

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      Last update time of the attachment.

    • 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

    • getDirectConnectGatewayAttachmentRef

      @Stability(Stable) @NotNull public DirectConnectGatewayAttachmentReference getDirectConnectGatewayAttachmentRef()
      A reference to a DirectConnectGatewayAttachment resource.
      Specified by:
      getDirectConnectGatewayAttachmentRef in interface IDirectConnectGatewayAttachmentRef

    • getCoreNetworkId

      @Stability(Stable) @NotNull public String getCoreNetworkId()
      The ID of a core network for the Direct Connect Gateway attachment.

    • setCoreNetworkId

      @Stability(Stable) public void setCoreNetworkId(@NotNull String value)
      The ID of a core network for the Direct Connect Gateway attachment.

    • getDirectConnectGatewayArn

      @Stability(Stable) @NotNull public String getDirectConnectGatewayArn()
      The Direct Connect gateway attachment ARN.

    • setDirectConnectGatewayArn

      @Stability(Stable) public void setDirectConnectGatewayArn(@NotNull String value)
      The Direct Connect gateway attachment ARN.

    • getEdgeLocations

      @Stability(Stable) @NotNull public List<String> getEdgeLocations()
      The Regions where the edges are located.

    • setEdgeLocations

      @Stability(Stable) public void setEdgeLocations(@NotNull List<String> value)
      The Regions where the edges are located.

    • getProposedNetworkFunctionGroupChange

      @Stability(Stable) @Nullable public Object getProposedNetworkFunctionGroupChange()
      Describes proposed changes to a network function group.

      Returns union: either IResolvable or CfnDirectConnectGatewayAttachment.ProposedNetworkFunctionGroupChangeProperty

    • setProposedNetworkFunctionGroupChange

      @Stability(Stable) public void setProposedNetworkFunctionGroupChange(@Nullable IResolvable value)
      Describes proposed changes to a network function group.

    • setProposedNetworkFunctionGroupChange

      @Stability(Stable) public void setProposedNetworkFunctionGroupChange(@Nullable CfnDirectConnectGatewayAttachment.ProposedNetworkFunctionGroupChangeProperty value)
      Describes proposed changes to a network function group.

    • getProposedSegmentChange

      @Stability(Stable) @Nullable public Object getProposedSegmentChange()
      Describes a proposed segment change.

      Returns union: either IResolvable or CfnDirectConnectGatewayAttachment.ProposedSegmentChangeProperty

    • setProposedSegmentChange

      @Stability(Stable) public void setProposedSegmentChange(@Nullable IResolvable value)
      Describes a proposed segment change.

    • setProposedSegmentChange

      @Stability(Stable) public void setProposedSegmentChange(@Nullable CfnDirectConnectGatewayAttachment.ProposedSegmentChangeProperty value)
      Describes a proposed segment change.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Tags for the attachment.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Tags for the attachment.