AWS::NetworkManager::ConnectPeer - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::NetworkManager::ConnectPeer

Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance. The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

Syntax

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

JSON

{
  "Type" : "AWS::NetworkManager::ConnectPeer",
  "Properties" : {
      "BgpOptions" : BgpOptions,
      "ConnectAttachmentId" : String,
      "CoreNetworkAddress" : String,
      "InsideCidrBlocks" : [ String, ... ],
      "PeerAddress" : String,
      "SubnetArn" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::NetworkManager::ConnectPeer
Properties:
  BgpOptions: 
    BgpOptions
  ConnectAttachmentId: String
  CoreNetworkAddress: String
  InsideCidrBlocks: 
    - String
  PeerAddress: String
  SubnetArn: String
  Tags: 
    - Tag

Properties

BgpOptions

Describes the BGP options.

Required: No

Type: BgpOptions

Update requires: Replacement

ConnectAttachmentId

The ID of the attachment to connect.

Required: Yes

Type: String

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

Minimum: 0

Maximum: 50

Update requires: Replacement

CoreNetworkAddress

The IP address of a core network.

Required: No

Type: String

Pattern: [\s\S]*

Minimum: 1

Maximum: 50

Update requires: Replacement

InsideCidrBlocks

The inside IP addresses used for a Connect peer configuration.

Required: No

Type: Array of String

Update requires: Replacement

PeerAddress

The IP address of the Connect peer.

Required: Yes

Type: String

Pattern: [\s\S]*

Minimum: 1

Maximum: 50

Update requires: Replacement

SubnetArn

The subnet ARN of the Connect peer.

Required: No

Type: String

Pattern: ^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:subnet\/subnet-[0-9a-f]{8,17}$|^$

Minimum: 0

Maximum: 500

Update requires: Replacement

Tags

The list of key-value tags associated with the Connect peer.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ConnectPeerId. For example, { "Ref: "connect-peer--041e25dbc928d7e61" }.

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.

ConnectPeerId

The ID of the Connect peer.

CoreNetworkId

The core network ID.

CreatedAt

The timestamp when the Connect peer was created.

EdgeLocation

The Connect peer Regions where edges are located.

State

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