transit_gateway_peerings

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

Overview

Name	transit_gateway_peerings
Type	Resource
Id	aws.networkmanager.transit_gateway_peerings

Fields

The following fields are returned by SELECT queries:

get_transit_gateway_peering

Name	Datatype	Description
peering	object	Describes a transit gateway peer connection.
transit_gateway_arn	string	The ARN of the transit gateway. (pattern: <code>[\s\S]*</code>)
transit_gateway_peering_attachment_id	string	The ID of the transit gateway peering attachment. (pattern: <code>^tgw-attach-([0-9a-f]{8,17})$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_transit_gateway_peering	select	peering_id, region		Returns information about a transit gateway peer.
create_transit_gateway_peering	insert	region, CoreNetworkId, TransitGatewayArn		Creates a transit gateway 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 request.
region	string	AWS region (default: us-east-1)

SELECT examples

get_transit_gateway_peering

Returns information about a transit gateway peer.

SELECT
peering,
transit_gateway_arn,
transit_gateway_peering_attachment_id
FROM aws.networkmanager.transit_gateway_peerings
WHERE peering_id = '{{ peering_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_transit_gateway_peering

Creates a transit gateway peering connection.

INSERT INTO aws.networkmanager.transit_gateway_peerings (
CoreNetworkId,
TransitGatewayArn,
Tags,
ClientToken,
region
)
SELECT 
'{{ CoreNetworkId }}' /* required */,
'{{ TransitGatewayArn }}' /* required */,
'{{ Tags }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
transit_gateway_peering
;

Manifest

# Description fields are for documentation purposes
- name: transit_gateway_peerings
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the transit_gateway_peerings resource.
  - name: CoreNetworkId
    value: "{{ CoreNetworkId }}"
  - name: TransitGatewayArn
    value: "{{ TransitGatewayArn }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: ClientToken
    value: "{{ ClientToken }}"