transit_gateway_connect_peers

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

Overview

Name	transit_gateway_connect_peers
Type	Resource
Id	aws.ec2.transit_gateway_connect_peers

Fields

The following fields are returned by SELECT queries:

describe_transit_gateway_connect_peers

Name	Datatype	Description
connect_peer_configuration	string	The Connect peer details.
creation_time	string	The creation time.
state	string	The state of the Connect peer.
tags	string	The tags for the Connect peer.
transit_gateway_attachment_id	string	The ID of the Connect attachment.
transit_gateway_connect_peer_id	string	The ID of the Connect peer.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_transit_gateway_connect_peers	select	region	TransitGatewayConnectPeerIds, Filter, MaxResults, NextToken, DryRun	Describes one or more Connect peers.
create_transit_gateway_connect_peer	insert	TransitGatewayAttachmentId, PeerAddress, InsideCidrBlocks, region	TransitGatewayAddress, BgpOptions, TagSpecification, DryRun	Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance. The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6). For more information, see Connect peers in the Amazon Web Services Transit Gateways Guide.
delete_transit_gateway_connect_peer	delete	TransitGatewayConnectPeerId, region	DryRun	Deletes the specified 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
InsideCidrBlocks	array	The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address from the range must be configured on the appliance as the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the fd00::/8 range.
PeerAddress	string	The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.
TransitGatewayAttachmentId	string	The ID of the Connect attachment.
TransitGatewayConnectPeerId	string	The ID of the Connect peer.
region	string	AWS region (default: us-east-1)
BgpOptions	object	The BGP options for the Connect peer.
DryRun	boolean	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filter	array	One or more filters. The possible values are: state - The state of the Connect peer (pending | available | deleting | deleted). transit-gateway-attachment-id - The ID of the attachment. transit-gateway-connect-peer-id - The ID of the Connect peer.
MaxResults	integer	The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
NextToken	string	The token for the next page of results.
TagSpecification	array	The tags to apply to the Connect peer.
TransitGatewayAddress	string	The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns the first available IP address from the transit gateway CIDR block.
TransitGatewayConnectPeerIds	array	The IDs of the Connect peers.

SELECT examples

describe_transit_gateway_connect_peers

Describes one or more Connect peers.

SELECT
connect_peer_configuration,
creation_time,
state,
tags,
transit_gateway_attachment_id,
transit_gateway_connect_peer_id
FROM aws.ec2.transit_gateway_connect_peers
WHERE region = '{{ region }}' -- required
AND TransitGatewayConnectPeerIds = '{{ TransitGatewayConnectPeerIds }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

create_transit_gateway_connect_peer

Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance. The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6). For more information, see Connect peers in the Amazon Web Services Transit Gateways Guide.

INSERT INTO aws.ec2.transit_gateway_connect_peers (
TransitGatewayAttachmentId,
PeerAddress,
InsideCidrBlocks,
region,
TransitGatewayAddress,
BgpOptions,
TagSpecification,
DryRun
)
SELECT 
'{{ TransitGatewayAttachmentId }}',
'{{ PeerAddress }}',
'{{ InsideCidrBlocks }}',
'{{ region }}',
'{{ TransitGatewayAddress }}',
'{{ BgpOptions }}',
'{{ TagSpecification }}',
'{{ DryRun }}'
RETURNING
connect_peer_configuration,
creation_time,
state,
tags,
transit_gateway_attachment_id,
transit_gateway_connect_peer_id
;

Manifest

# Description fields are for documentation purposes
- name: transit_gateway_connect_peers
props:
  - name: TransitGatewayAttachmentId
    value: "{{ TransitGatewayAttachmentId }}"
    description: Required parameter for the transit_gateway_connect_peers resource.
  - name: PeerAddress
    value: "{{ PeerAddress }}"
    description: Required parameter for the transit_gateway_connect_peers resource.
  - name: InsideCidrBlocks
    value: "{{ InsideCidrBlocks }}"
    description: Required parameter for the transit_gateway_connect_peers resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the transit_gateway_connect_peers resource.
  - name: TransitGatewayAddress
    value: "{{ TransitGatewayAddress }}"
    description: The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns the first available IP address from the transit gateway CIDR block.
    description: The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns the first available IP address from the transit gateway CIDR block.
  - name: BgpOptions
    value: "{{ BgpOptions }}"
    description: The BGP options for the Connect peer.
    description: The BGP options for the Connect peer.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to apply to the Connect peer.
    description: The tags to apply to the Connect peer.
  - name: DryRun
    value: {{ DryRun }}
    description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

DELETE examples

delete_transit_gateway_connect_peer

Deletes the specified Connect peer.

DELETE FROM aws.ec2.transit_gateway_connect_peers
WHERE TransitGatewayConnectPeerId = '{{ TransitGatewayConnectPeerId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
;