transit_gateway_peerings

Creates, updates, deletes or gets a transit_gateway_peering resource or lists transit_gateway_peerings in a region

Overview

Name	transit_gateway_peerings
Type	Resource
Description	AWS::NetworkManager::TransitGatewayPeering Resoruce Type.
Id	aws.networkmanager.transit_gateway_peerings

Fields

Name	Datatype	Description
core_network_id	string	The Id of the core network that you want to peer a transit gateway to.
core_network_arn	string	The ARN (Amazon Resource Name) of the core network that you want to peer a transit gateway to.
transit_gateway_arn	string	The ARN (Amazon Resource Name) of the transit gateway that you will peer to a core network
transit_gateway_peering_attachment_id	string	The ID of the TransitGatewayPeeringAttachment
peering_id	string	The Id of the transit gateway peering
state	string	The state of the transit gateway peering
edge_location	string	The location of the transit gateway peering
resource_arn	string	The ARN (Amazon Resource Name) of the resource that you will peer to a core network
owner_account_id	string	Peering owner account Id
peering_type	string	Peering type (TransitGatewayPeering)
created_at	string	The creation time of the transit gateway peering
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	CoreNetworkId, TransitGatewayArn, 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 transit_gateway_peerings in a region.

SELECT
region,
core_network_id,
core_network_arn,
transit_gateway_arn,
transit_gateway_peering_attachment_id,
peering_id,
state,
edge_location,
resource_arn,
owner_account_id,
peering_type,
created_at,
tags
FROM aws.networkmanager.transit_gateway_peerings
WHERE region = 'us-east-1';

Gets all properties from an individual transit_gateway_peering.

SELECT
region,
core_network_id,
core_network_arn,
transit_gateway_arn,
transit_gateway_peering_attachment_id,
peering_id,
state,
edge_location,
resource_arn,
owner_account_id,
peering_type,
created_at,
tags
FROM aws.networkmanager.transit_gateway_peerings
WHERE region = 'us-east-1' AND data__Identifier = '<PeeringId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.networkmanager.transit_gateway_peerings (
 CoreNetworkId,
 TransitGatewayArn,
 region
)
SELECT 
'{{ CoreNetworkId }}',
 '{{ TransitGatewayArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.networkmanager.transit_gateway_peerings (
 CoreNetworkId,
 TransitGatewayArn,
 Tags,
 region
)
SELECT 
 '{{ CoreNetworkId }}',
 '{{ TransitGatewayArn }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: transit_gateway_peering
    props:
      - name: CoreNetworkId
        value: '{{ CoreNetworkId }}'
      - name: TransitGatewayArn
        value: '{{ TransitGatewayArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.networkmanager.transit_gateway_peerings
WHERE data__Identifier = '<PeeringId>'
AND region = 'us-east-1';

Permissions

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

Create

networkmanager:CreateTransitGatewayPeering,
networkmanager:TagResource,
networkmanager:GetTransitGatewayPeering,
iam:CreateServiceLinkedRole,
ec2:CreateTransitGatewayPeeringAttachment,
ec2:AcceptTransitGatewayPeeringAttachment,
ec2:DescribeRegions

Read

networkmanager:GetTransitGatewayPeering,
networkmanager:TagResource

Update

networkmanager:TagResource,
networkmanager:UntagResource,
networkmanager:ListTagsForResource,
networkmanager:GetTransitGatewayPeering,
ec2:DescribeRegions

Delete

networkmanager:DeletePeering,
networkmanager:GetTransitGatewayPeering,
ec2:DescribeRegions

List

networkmanager:ListPeerings