peerings

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

Overview

Name	peerings
Type	Resource
Id	aws.networkmanager.peerings

Fields

The following fields are returned by SELECT queries:

list_peerings

Name	Datatype	Description
core_network_arn	string	The ARN of a core network. (pattern: <code>[\s\S]*</code>)
core_network_id	string	The ID of the core network for the peering request. (pattern: <code>^core-network-([0-9a-f]{8,17})$</code>)
created_at	string (date-time)	The timestamp when the attachment peer was created.
edge_location	string	The edge location for the peer. (pattern: <code>[\s\S]*</code>)
last_modification_errors	array	Describes the error associated with the Connect peer request.
owner_account_id	string	The ID of the account owner. (pattern: <code>[\s\S]*</code>)
peering_id	string	The ID of the peering attachment. (pattern: <code>^peering-([0-9a-f]{8,17})$</code>)
peering_type	string	The type of peering. This will be TRANSIT_GATEWAY. (TRANSIT_GATEWAY)
resource_arn	string	The resource ARN of the peer. (pattern: <code>[\s\S]*</code>)
state	string	The current state of the peering connection. (CREATING, FAILED, AVAILABLE, DELETING)
tags	array	The list of key-value tags associated with the peering.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_peerings	select	region	coreNetworkId, peeringType, edgeLocation, state, maxResults, nextToken	Lists the peerings for a core network.
delete_peering	delete	peering_id, region		Deletes an existing peering connection.

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
peering_id	string	The ID of the peering connection to delete.
region	string	AWS region (default: us-east-1)
coreNetworkId	string	The ID of a core network.
edgeLocation	string	Returns a list edge locations for the
maxResults	integer	The maximum number of results to return.
nextToken	string	The token for the next page of results.
peeringType	string	Returns a list of a peering requests.
state	string	Returns a list of the peering request states.

SELECT examples

list_peerings

Lists the peerings for a core network.

SELECT
core_network_arn,
core_network_id,
created_at,
edge_location,
last_modification_errors,
owner_account_id,
peering_id,
peering_type,
resource_arn,
state,
tags
FROM aws.networkmanager.peerings
WHERE region = '{{ region }}' -- required
AND coreNetworkId = '{{ coreNetworkId }}'
AND peeringType = '{{ peeringType }}'
AND edgeLocation = '{{ edgeLocation }}'
AND state = '{{ state }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

DELETE examples

delete_peering

Deletes an existing peering connection.

DELETE FROM aws.networkmanager.peerings
WHERE peering_id = '{{ peering_id }}' --required
AND region = '{{ region }}' --required
;