transit_gateway_connect_peers

Creates, updates, deletes or gets a transit_gateway_connect_peer resource or lists transit_gateway_connect_peers in a region

Overview

Name	transit_gateway_connect_peers
Type	Resource
Description	Resource Type definition for AWS::EC2::TransitGatewayConnectPeer
Id	awscc.ec2.transit_gateway_connect_peers

Fields

get (all properties)

Name	Datatype	Description
transit_gateway_attachment_id	string	The ID of the Connect attachment.
transit_gateway_connect_peer_id	string	The ID of the Connect peer.
state	string	The state of the Connect peer.
creation_time	string	The creation time.
▶connect_peer_configuration	object	The Connect peer details.
▶tags	array	The tags for the Connect Peer.
region	string	AWS region.

list (identifiers only)

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

For more information, see AWS::EC2::TransitGatewayConnectPeer.

Methods

Name	Resource	Accessible by	Required Params
create_resource	transit_gateway_connect_peers	INSERT	TransitGatewayAttachmentId, ConnectPeerConfiguration, region
delete_resource	transit_gateway_connect_peers	DELETE	Identifier, region
update_resource	transit_gateway_connect_peers	UPDATE	Identifier, PatchDocument, region
list_resources	transit_gateway_connect_peers_list_only	SELECT	region
get_resource	transit_gateway_connect_peers	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual transit_gateway_connect_peer.

SELECT
  region,
  transit_gateway_attachment_id,
  transit_gateway_connect_peer_id,
  state,
  creation_time,
  connect_peer_configuration,
  tags
FROM awscc.ec2.transit_gateway_connect_peers
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ transit_gateway_connect_peer_id }}';

list (identifiers only)

Lists all transit_gateway_connect_peers in a region.

SELECT
  region,
  transit_gateway_connect_peer_id
FROM awscc.ec2.transit_gateway_connect_peers_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new transit_gateway_connect_peer resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.ec2.transit_gateway_connect_peers (
  TransitGatewayAttachmentId,
  ConnectPeerConfiguration,
  region
)
SELECT
  '{{ transit_gateway_attachment_id }}',
  '{{ connect_peer_configuration }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ec2.transit_gateway_connect_peers (
  TransitGatewayAttachmentId,
  ConnectPeerConfiguration,
  Tags,
  region
)
SELECT
  '{{ transit_gateway_attachment_id }}',
  '{{ connect_peer_configuration }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: transit_gateway_connect_peer
  props:
    - name: transit_gateway_attachment_id
      value: '{{ transit_gateway_attachment_id }}'
    - name: connect_peer_configuration
      value:
        transit_gateway_address: '{{ transit_gateway_address }}'
        peer_address: '{{ peer_address }}'
        inside_cidr_blocks:
          - '{{ inside_cidr_blocks[0] }}'
        protocol: '{{ protocol }}'
        bgp_configurations:
          - transit_gateway_asn: null
            peer_asn: null
            transit_gateway_address: '{{ transit_gateway_address }}'
            peer_address: '{{ peer_address }}'
            bgp_status: '{{ bgp_status }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ec2.transit_gateway_connect_peers
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ transit_gateway_connect_peer_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.transit_gateway_connect_peers
WHERE
  Identifier = '{{ transit_gateway_connect_peer_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the transit_gateway_connect_peers resource, the following permissions are required:

Create

ec2:CreateTransitGatewayConnectPeer,
ec2:DescribeTransitGatewayConnectPeers,
ec2:CreateTags,
ec2:DescribeTags

Read

ec2:DescribeTransitGatewayConnectPeers,
ec2:DescribeTags

Update

ec2:DescribeTransitGatewayConnectPeers,
ec2:DeleteTags,
ec2:CreateTags

Delete

ec2:DeleteTransitGatewayConnectPeer,
ec2:DescribeTransitGatewayConnectPeers,
ec2:DeleteTags,
ec2:DescribeTags

List

ec2:DescribeTransitGatewayConnectPeers,
ec2:DescribeTags