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

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.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	TransitGatewayAttachmentId, ConnectPeerConfiguration, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

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 = 'us-east-1' AND data__Identifier = '<TransitGatewayConnectPeerId>';

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 
'{{ TransitGatewayAttachmentId }}',
 '{{ ConnectPeerConfiguration }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.ec2.transit_gateway_connect_peers (
 TransitGatewayAttachmentId,
 ConnectPeerConfiguration,
 Tags,
 region
)
SELECT 
 '{{ TransitGatewayAttachmentId }}',
 '{{ ConnectPeerConfiguration }}',
 '{{ Tags }}',
 '{{ region }}';

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: TransitGatewayAttachmentId
        value: '{{ TransitGatewayAttachmentId }}'
      - name: ConnectPeerConfiguration
        value:
          TransitGatewayAddress: '{{ TransitGatewayAddress }}'
          PeerAddress: '{{ PeerAddress }}'
          InsideCidrBlocks:
            - '{{ InsideCidrBlocks[0] }}'
          Protocol: '{{ Protocol }}'
          BgpConfigurations:
            - TransitGatewayAsn: null
              PeerAsn: null
              TransitGatewayAddress: '{{ TransitGatewayAddress }}'
              PeerAddress: '{{ PeerAddress }}'
              BgpStatus: '{{ BgpStatus }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.ec2.transit_gateway_connect_peers
WHERE data__Identifier = '<TransitGatewayConnectPeerId>'
AND region = 'us-east-1';

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