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,
      "Tags" : [ Tag, ... ]
    }
}

YAML

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

Properties

BgpOptions

Property description not available.

Required: No

Type: BgpOptions

Update requires: Replacement

ConnectAttachmentId

The ID of the attachment to connect.

Required: Yes

Type: String

Minimum: 0

Maximum: 50

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

Update requires: Replacement

CoreNetworkAddress

The IP address of a core network.

Required: No

Type: String

Minimum: 1

Maximum: 50

Pattern: [\s\S]*

Update requires: Replacement

InsideCidrBlocks

The inside IP addresses used for a Connect peer configuration.

Required: Yes

Type: List of String

Update requires: Replacement

PeerAddress

The IP address of the Connect peer.

Required: Yes

Type: String

Minimum: 1

Maximum: 50

Pattern: [\s\S]*

Update requires: Replacement

Tags

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

Required: No

Type: List of Tag

Update requires: No interruption

Return values

Ref

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

For more information about using the Reffunction, see Ref.

Fn::GetAtt

The Fn::GetAttintrinsic 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::GetAttintrinsic function, see Fn::GetAtt.

Configuration

Property description not available.

Configuration.BgpConfigurations

Property description not available.

Configuration.CoreNetworkAddress

Property description not available.

Configuration.InsideCidrBlocks

Property description not available.

Configuration.PeerAddress

Property description not available.

Configuration.Protocol

Property description not available.

ConnectPeerId

The ID of the Connect peer.

CoreNetworkId

The core network ID.

CreatedAt

The timestamp when the Connect peer was created.

EdgeLocation

The Region where the edge is 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.