connect_peers

Creates, updates, deletes or gets a connect_peer resource or lists connect_peers in a region

Overview

Name	connect_peers
Type	Resource
Description	AWS::NetworkManager::ConnectPeer Resource Type Definition.
Id	aws.networkmanager.connect_peers

Fields

Name	Datatype	Description
peer_address	string	The IP address of the Connect peer.
core_network_address	string	The IP address of a core network.
bgp_options	object	Bgp options for connect peer.
inside_cidr_blocks	array	The inside IP addresses used for a Connect peer configuration.
core_network_id	string	The ID of the core network.
connect_attachment_id	string	The ID of the attachment to connect.
connect_peer_id	string	The ID of the Connect peer.
edge_location	string	The Connect peer Regions where edges are located.
state	string	State of the connect peer.
created_at	string	Connect peer creation time.
configuration	object	Configuration of the connect peer.
subnet_arn	string	The subnet ARN for the connect peer.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ConnectAttachmentId, PeerAddress, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all connect_peers in a region.

SELECT
region,
peer_address,
core_network_address,
bgp_options,
inside_cidr_blocks,
core_network_id,
connect_attachment_id,
connect_peer_id,
edge_location,
state,
created_at,
configuration,
subnet_arn,
tags
FROM aws.networkmanager.connect_peers
WHERE region = 'us-east-1';

Gets all properties from an individual connect_peer.

SELECT
region,
peer_address,
core_network_address,
bgp_options,
inside_cidr_blocks,
core_network_id,
connect_attachment_id,
connect_peer_id,
edge_location,
state,
created_at,
configuration,
subnet_arn,
tags
FROM aws.networkmanager.connect_peers
WHERE region = 'us-east-1' AND data__Identifier = '<ConnectPeerId>';

INSERT example

Use the following StackQL query and manifest file to create a new connect_peer resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.networkmanager.connect_peers (
 PeerAddress,
 ConnectAttachmentId,
 region
)
SELECT 
'{{ PeerAddress }}',
 '{{ ConnectAttachmentId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.networkmanager.connect_peers (
 PeerAddress,
 CoreNetworkAddress,
 BgpOptions,
 InsideCidrBlocks,
 ConnectAttachmentId,
 SubnetArn,
 Tags,
 region
)
SELECT 
 '{{ PeerAddress }}',
 '{{ CoreNetworkAddress }}',
 '{{ BgpOptions }}',
 '{{ InsideCidrBlocks }}',
 '{{ ConnectAttachmentId }}',
 '{{ SubnetArn }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: connect_peer
    props:
      - name: PeerAddress
        value: '{{ PeerAddress }}'
      - name: CoreNetworkAddress
        value: '{{ CoreNetworkAddress }}'
      - name: BgpOptions
        value:
          PeerAsn: null
      - name: InsideCidrBlocks
        value:
          - '{{ InsideCidrBlocks[0] }}'
      - name: ConnectAttachmentId
        value: '{{ ConnectAttachmentId }}'
      - name: SubnetArn
        value: '{{ SubnetArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.networkmanager.connect_peers
WHERE data__Identifier = '<ConnectPeerId>'
AND region = 'us-east-1';

Permissions

To operate on the connect_peers resource, the following permissions are required:

Create

networkmanager:GetConnectPeer,
networkmanager:CreateConnectPeer,
networkmanager:TagResource,
ec2:DescribeRegions

Read

networkmanager:GetConnectPeer

Update

networkmanager:GetConnectPeer,
networkmanager:ListTagsForResource,
networkmanager:TagResource,
networkmanager:UntagResource,
ec2:DescribeRegions

Delete

networkmanager:GetConnectPeer,
networkmanager:DeleteConnectPeer,
ec2:DescribeRegions

List

networkmanager:ListConnectPeers