AWS::NetworkManager::ConnectPeer

NetworkManager ConnectPeer

AWS::NetworkManager::ConnectPeer Resource Type Definition.

Properties

7 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`ConnectAttachmentId`	`string`	RequiredCreate-only
`PeerAddress`	`string`	RequiredCreate-only
`BgpOptions`	`BgpOptions`	Create-onlyWrite-only
`CoreNetworkAddress`	`string`	Create-onlyWrite-only
`InsideCidrBlocks`	`Array<string>`	Create-only
`SubnetArn`	`string`	Create-onlyWrite-only
`Tags`	`Array<Tag>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Configuration`	`ConnectPeerConfiguration`	Configuration of the connect peer.
`ConnectPeerId`	`string`	The ID of the Connect peer.
`CoreNetworkId`	`string`	The ID of the core network.
`CreatedAt`	`string`	Connect peer creation time.
`EdgeLocation`	`string`	The Connect peer Regions where edges are located.
`LastModificationErrors`	`Array<string>`	Errors from the last modification of the connect peer.
`State`	`string`	State of the connect peer.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::NetworkManager::ConnectPeer

Resources:
  MyResource:
    Type: AWS::NetworkManager::ConnectPeer
    Properties:
      ConnectAttachmentId: "my-connectattachmentid"
      PeerAddress: "value"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

networkmanager:GetConnectPeernetworkmanager:CreateConnectPeernetworkmanager:TagResourceec2:DescribeRegions

read

networkmanager:GetConnectPeer

update

networkmanager:GetConnectPeernetworkmanager:ListTagsForResourcenetworkmanager:TagResourcenetworkmanager:UntagResourceec2:DescribeRegions

delete

networkmanager:GetConnectPeernetworkmanager:DeleteConnectPeerec2:DescribeRegions

list

networkmanager:ListConnectPeers

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceNetworkManager

Properties14

Required2

TaggingSupported

Primary IDConnectPeerId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

PeerAddressCoreNetworkAddressBgpOptionsInsideCidrBlocksConnectAttachmentIdSubnetArn

Related Resources

External Links

AWS Documentation