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	awscc.networkmanager.connect_peers

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
connect_peer_id	string	The ID of the Connect peer.
region	string	AWS region.

For more information, see AWS::NetworkManager::ConnectPeer.

Methods

Name	Resource	Accessible by	Required Params
create_resource	connect_peers	INSERT	ConnectAttachmentId, PeerAddress, region
delete_resource	connect_peers	DELETE	Identifier, region
update_resource	connect_peers	UPDATE	Identifier, PatchDocument, region
list_resources	connect_peers_list_only	SELECT	region
get_resource	connect_peers	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.networkmanager.connect_peers
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ connect_peer_id }}';

list (identifiers only)

Lists all connect_peers in a region.

SELECT
  region,
  connect_peer_id
FROM awscc.networkmanager.connect_peers_list_only
WHERE
  region = 'us-east-1';

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 awscc.networkmanager.connect_peers (
  PeerAddress,
  ConnectAttachmentId,
  region
)
SELECT
  '{{ peer_address }}',
  '{{ connect_attachment_id }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.networkmanager.connect_peers (
  PeerAddress,
  CoreNetworkAddress,
  BgpOptions,
  InsideCidrBlocks,
  ConnectAttachmentId,
  SubnetArn,
  Tags,
  region
)
SELECT
  '{{ peer_address }}',
  '{{ core_network_address }}',
  '{{ bgp_options }}',
  '{{ inside_cidr_blocks }}',
  '{{ connect_attachment_id }}',
  '{{ subnet_arn }}',
  '{{ 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: peer_address
        value: '{{ peer_address }}'
      - name: core_network_address
        value: '{{ core_network_address }}'
      - name: bgp_options
        value:
          peer_asn: null
      - name: inside_cidr_blocks
        value:
          - '{{ inside_cidr_blocks[0] }}'
      - name: connect_attachment_id
        value: '{{ connect_attachment_id }}'
      - name: subnet_arn
        value: '{{ subnet_arn }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.networkmanager.connect_peers
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ connect_peer_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.networkmanager.connect_peers
WHERE
  Identifier = '{{ connect_peer_id }}' 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