EC2 / Client / create_transit_gateway_peering_attachment

create_transit_gateway_peering_attachment#

EC2.Client.create_transit_gateway_peering_attachment(**kwargs)#

Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The peer transit gateway can be in your account or a different Amazon Web Services account.

After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.

Request Syntax

response = client.create_transit_gateway_peering_attachment(
    TransitGatewayId='string',
    PeerTransitGatewayId='string',
    PeerAccountId='string',
    PeerRegion='string',
    Options={
        'DynamicRouting': 'enable'|'disable'
    },
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    DryRun=True|False
)

Parameters:

TransitGatewayId (string) –
[REQUIRED]

The ID of the transit gateway.
PeerTransitGatewayId (string) –
[REQUIRED]

The ID of the peer transit gateway with which to create the peering attachment.
PeerAccountId (string) –
[REQUIRED]

The ID of the Amazon Web Services account that owns the peer transit gateway.
PeerRegion (string) –
[REQUIRED]

The Region where the peer transit gateway is located.
Options (dict) –
Requests a transit gateway peering attachment.
- DynamicRouting (string) –
  
  Indicates whether dynamic routing is enabled or disabled.
TagSpecifications (list) –
The tags to apply to the transit gateway peering attachment.
- (dict) –
  
  The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
  
  Note
  The Valid Values lists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.
  - ResourceType (string) –
    
    The type of resource to tag on creation.
  - Tags (list) –
    
    The tags to apply to the resource.
    - (dict) –
      
      Describes a tag.
      - Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
      - Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
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.

Return type:

dict

Returns:

Response Syntax

{
    'TransitGatewayPeeringAttachment': {
        'TransitGatewayAttachmentId': 'string',
        'AccepterTransitGatewayAttachmentId': 'string',
        'RequesterTgwInfo': {
            'TransitGatewayId': 'string',
            'CoreNetworkId': 'string',
            'OwnerId': 'string',
            'Region': 'string'
        },
        'AccepterTgwInfo': {
            'TransitGatewayId': 'string',
            'CoreNetworkId': 'string',
            'OwnerId': 'string',
            'Region': 'string'
        },
        'Options': {
            'DynamicRouting': 'enable'|'disable'
        },
        'Status': {
            'Code': 'string',
            'Message': 'string'
        },
        'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing',
        'CreationTime': datetime(2015, 1, 1),
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) –
- TransitGatewayPeeringAttachment (dict) –
  
  The transit gateway peering attachment.
  - TransitGatewayAttachmentId (string) –
    
    The ID of the transit gateway peering attachment.
  - AccepterTransitGatewayAttachmentId (string) –
    
    The ID of the accepter transit gateway attachment.
  - RequesterTgwInfo (dict) –
    
    Information about the requester transit gateway.
    - TransitGatewayId (string) –
      
      The ID of the transit gateway.
    - CoreNetworkId (string) –
      
      The ID of the core network where the transit gateway peer is located.
    - OwnerId (string) –
      
      The ID of the Amazon Web Services account that owns the transit gateway.
    - Region (string) –
      
      The Region of the transit gateway.
  - AccepterTgwInfo (dict) –
    
    Information about the accepter transit gateway.
    - TransitGatewayId (string) –
      
      The ID of the transit gateway.
    - CoreNetworkId (string) –
      
      The ID of the core network where the transit gateway peer is located.
    - OwnerId (string) –
      
      The ID of the Amazon Web Services account that owns the transit gateway.
    - Region (string) –
      
      The Region of the transit gateway.
  - Options (dict) –
    
    Details about the transit gateway peering attachment.
    - DynamicRouting (string) –
      
      Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment.
  - Status (dict) –
    
    The status of the transit gateway peering attachment.
    - Code (string) –
      
      The status code.
    - Message (string) –
      
      The status message, if applicable.
  - State (string) –
    
    The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
  - CreationTime (datetime) –
    
    The time the transit gateway peering attachment was created.
  - Tags (list) –
    
    The tags for the transit gateway peering attachment.
    - (dict) –
      
      Describes a tag.
      - Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
      - Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.