connect_peers

Creates, updates, deletes, gets or lists a connect_peers resource.

Overview

Name	connect_peers
Type	Resource
Id	aws.networkmanager.connect_peers

Fields

The following fields are returned by SELECT queries:

get_connect_peer

Name	Datatype	Description
configuration	object	The configuration of the Connect peer.
connect_attachment_id	string	The ID of the attachment to connect. (pattern: <code>^attachment-([0-9a-f]{8,17})$</code>)
connect_peer_id	string	The ID of the Connect peer. (pattern: <code>^connect-peer-([0-9a-f]{8,17})$</code>)
core_network_id	string	The ID of a core network. (pattern: <code>^core-network-([0-9a-f]{8,17})$</code>)
created_at	string (date-time)	The timestamp when the Connect peer was created.
edge_location	string	The Connect peer Regions where edges are located. (pattern: <code>[\s\S]*</code>)
last_modification_errors	array	Describes the error associated with the attachment request.
state	string	The state of the Connect peer. (CREATING, FAILED, AVAILABLE, DELETING)
subnet_arn	string	The subnet ARN for the Connect peer. This only applies only when the protocol is NO_ENCAP. (pattern: <code>^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:subnet/subnet-[0-9a-f]{8,17}$|^$</code>)
tags	array	The list of key-value tags associated with the Connect peer.

list_connect_peers

Name	Datatype	Description
connect_attachment_id	string	The ID of a Connect peer attachment. (pattern: <code>^attachment-([0-9a-f]{8,17})$</code>)
connect_peer_id	string	The ID of a Connect peer. (pattern: <code>^connect-peer-([0-9a-f]{8,17})$</code>)
connect_peer_state	string	The state of a Connect peer. (CREATING, FAILED, AVAILABLE, DELETING)
core_network_id	string	The ID of a core network. (pattern: <code>^core-network-([0-9a-f]{8,17})$</code>)
created_at	string (date-time)	The timestamp when a Connect peer was created.
edge_location	string	The Region where the edge is located. (pattern: <code>[\s\S]*</code>)
subnet_arn	string	The subnet ARN for the Connect peer summary. (pattern: <code>^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:subnet/subnet-[0-9a-f]{8,17}$|^$</code>)
tags	array	The list of key-value tags associated with the Connect peer summary.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_connect_peer	select	connect_peer_id, region		Returns information about a core network Connect peer.
list_connect_peers	select	region	coreNetworkId, connectAttachmentId, maxResults, nextToken	Returns a list of core network Connect peers.
create_connect_peer	insert	region, ConnectAttachmentId, PeerAddress		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).
associate_connect_peer	update	global_network_id, region, ConnectPeerId, DeviceId		Associates a core network Connect peer with a device and optionally, with a link. If you specify a link, it must be associated with the specified device. You can only associate core network Connect peers that have been created on a core network Connect attachment on a core network.
associate_transit_gateway_connect_peer	update	global_network_id, region, TransitGatewayConnectPeerArn, DeviceId		Associates a transit gateway Connect peer with a device, and optionally, with a link. If you specify a link, it must be associated with the specified device. You can only associate transit gateway Connect peers that have been created on a transit gateway that's registered in your global network. You cannot associate a transit gateway Connect peer with more than one device and link.
disassociate_connect_peer	update	global_network_id, connect_peer_id, region		Disassociates a core network Connect peer from a device and a link.
disassociate_transit_gateway_connect_peer	update	global_network_id, transit_gateway_connect_peer_arn, region		Disassociates a transit gateway Connect peer from a device and link.
delete_connect_peer	delete	connect_peer_id, region		Deletes a Connect peer.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
connect_peer_id	string	The ID of the deleted Connect peer.
global_network_id	string	The ID of the global network.
region	string	AWS region (default: us-east-1)
transit_gateway_connect_peer_arn	string	The Amazon Resource Name (ARN) of the transit gateway Connect peer.
connectAttachmentId	string	The ID of the attachment.
coreNetworkId	string	The ID of a core network.
maxResults	integer	The maximum number of results to return.
nextToken	string	The token for the next page of results.

SELECT examples

get_connect_peer

Returns information about a core network Connect peer.

SELECT
configuration,
connect_attachment_id,
connect_peer_id,
core_network_id,
created_at,
edge_location,
last_modification_errors,
state,
subnet_arn,
tags
FROM aws.networkmanager.connect_peers
WHERE connect_peer_id = '{{ connect_peer_id }}' -- required
AND region = '{{ region }}' -- required
;

list_connect_peers

Returns a list of core network Connect peers.

SELECT
connect_attachment_id,
connect_peer_id,
connect_peer_state,
core_network_id,
created_at,
edge_location,
subnet_arn,
tags
FROM aws.networkmanager.connect_peers
WHERE region = '{{ region }}' -- required
AND coreNetworkId = '{{ coreNetworkId }}'
AND connectAttachmentId = '{{ connectAttachmentId }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_connect_peer

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).

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

Manifest

# Description fields are for documentation purposes
- name: connect_peers
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the connect_peers resource.
  - name: ConnectAttachmentId
    value: "{{ ConnectAttachmentId }}"
  - name: CoreNetworkAddress
    value: "{{ CoreNetworkAddress }}"
  - name: PeerAddress
    value: "{{ PeerAddress }}"
  - name: BgpOptions
    description: |
      Describes the BGP options.
    value:
      PeerAsn: {{ PeerAsn }}
  - name: InsideCidrBlocks
    value:
      - "{{ InsideCidrBlocks }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: SubnetArn
    value: "{{ SubnetArn }}"

UPDATE examples

associate_connect_peer

Associates a core network Connect peer with a device and optionally, with a link. If you specify a link, it must be associated with the specified device. You can only associate core network Connect peers that have been created on a core network Connect attachment on a core network.

UPDATE aws.networkmanager.connect_peers
SET 
ConnectPeerId = '{{ ConnectPeerId }}',
DeviceId = '{{ DeviceId }}',
LinkId = '{{ LinkId }}'
WHERE 
global_network_id = '{{ global_network_id }}' --required
AND region = '{{ region }}' --required
AND ConnectPeerId = '{{ ConnectPeerId }}' --required
AND DeviceId = '{{ DeviceId }}' --required
RETURNING
connect_peer_association;

associate_transit_gateway_connect_peer

Associates a transit gateway Connect peer with a device, and optionally, with a link. If you specify a link, it must be associated with the specified device. You can only associate transit gateway Connect peers that have been created on a transit gateway that's registered in your global network. You cannot associate a transit gateway Connect peer with more than one device and link.

UPDATE aws.networkmanager.connect_peers
SET 
TransitGatewayConnectPeerArn = '{{ TransitGatewayConnectPeerArn }}',
DeviceId = '{{ DeviceId }}',
LinkId = '{{ LinkId }}'
WHERE 
global_network_id = '{{ global_network_id }}' --required
AND region = '{{ region }}' --required
AND TransitGatewayConnectPeerArn = '{{ TransitGatewayConnectPeerArn }}' --required
AND DeviceId = '{{ DeviceId }}' --required
RETURNING
transit_gateway_connect_peer_association;

disassociate_connect_peer

Disassociates a core network Connect peer from a device and a link.

UPDATE aws.networkmanager.connect_peers
SET 
-- No updatable properties
WHERE 
global_network_id = '{{ global_network_id }}' --required
AND connect_peer_id = '{{ connect_peer_id }}' --required
AND region = '{{ region }}' --required
RETURNING
connect_peer_association;

disassociate_transit_gateway_connect_peer

Disassociates a transit gateway Connect peer from a device and link.

UPDATE aws.networkmanager.connect_peers
SET 
-- No updatable properties
WHERE 
global_network_id = '{{ global_network_id }}' --required
AND transit_gateway_connect_peer_arn = '{{ transit_gateway_connect_peer_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
transit_gateway_connect_peer_association;

DELETE examples

delete_connect_peer

Deletes a Connect peer.

DELETE FROM aws.networkmanager.connect_peers
WHERE connect_peer_id = '{{ connect_peer_id }}' --required
AND region = '{{ region }}' --required
;