AWS::NetworkManager::ConnectAttachment

Creates a core network Connect attachment from a specified core network attachment.

A core network Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a core network and an appliance. A core network Connect attachment uses an existing VPC attachment as the underlying transport mechanism.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::NetworkManager::ConnectAttachment",
  "Properties" : {
      "CoreNetworkId" : String,
      "EdgeLocation" : String,
      "NetworkFunctionGroupName" : String,
      "Options" : ConnectAttachmentOptions,
      "ProposedNetworkFunctionGroupChange" : ProposedNetworkFunctionGroupChange,
      "ProposedSegmentChange" : ProposedSegmentChange,
      "Tags" : [ Tag, ... ],
      "TransportAttachmentId" : String
    }
}

YAML

Type: AWS::NetworkManager::ConnectAttachment
Properties:
  CoreNetworkId: String
  EdgeLocation: String
  NetworkFunctionGroupName: String
  Options: 
    ConnectAttachmentOptions
  ProposedNetworkFunctionGroupChange: 
    ProposedNetworkFunctionGroupChange
  ProposedSegmentChange: 
    ProposedSegmentChange
  Tags: 
    - Tag
  TransportAttachmentId: String

Properties

CoreNetworkId

The ID of the core network where the Connect attachment is located.

Required: Yes

Type: String

Update requires: Replacement

EdgeLocation

The Region where the edge is located.

Required: Yes

Type: String

Pattern: [\s\S]*

Minimum: 1

Maximum: 63

Update requires: Replacement

NetworkFunctionGroupName

The name of the network function group.

Required: No

Type: String

Pattern: [\s\S]*

Minimum: 0

Maximum: 256

Update requires: No interruption

Options

Options for connecting an attachment.

Required: Yes

Type: ConnectAttachmentOptions

Update requires: Replacement

ProposedNetworkFunctionGroupChange

Describes proposed changes to a network function group.

Required: No

Type: ProposedNetworkFunctionGroupChange

Update requires: No interruption

ProposedSegmentChange

Describes a proposed segment change. In some cases, the segment change must first be evaluated and accepted.

Required: No

Type: ProposedSegmentChange

Update requires: No interruption

Tags

The tags associated with the Connect attachment.

Required: No

Type: Array of Tag

Update requires: No interruption

TransportAttachmentId

The ID of the transport attachment.

Required: Yes

Type: String

Pattern: ^attachment-([0-9a-f]{8,17})$

Minimum: 0

Maximum: 50

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the AttachmentId. For example, { "Ref: "attachment-02767e74104a33690" }.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

AttachmentId

The ID of the Connect attachment.

AttachmentPolicyRuleNumber

The rule number associated with the attachment.

AttachmentType

The type of attachment. This will be CONNECT.

CoreNetworkArn

The ARN of the core network.

CreatedAt

The timestamp when the Connect attachment was created.

OwnerAccountId

The ID of the Connect attachment owner.

ResourceArn

The resource ARN for the Connect attachment.

SegmentName

The name of the Connect attachment's segment.

State

The state of the Connect attachment. This can be: REJECTED | PENDING_ATTACHMENT_ACCEPTANCE | CREATING | FAILED | AVAILABLE | UPDATING | PENDING_NETWORK_UPDATE | PENDING_TAG_ACCEPTANCE | DELETING.

UpdatedAt

The timestamp when the Connect attachment was last updated.