EC2 / Client / create_transit_gateway_prefix_list_reference

create_transit_gateway_prefix_list_reference#

EC2.Client.create_transit_gateway_prefix_list_reference(**kwargs)#

Creates a reference (route) to a prefix list in a specified transit gateway route table.

See also: AWS API Documentation

Request Syntax

response = client.create_transit_gateway_prefix_list_reference(
    TransitGatewayRouteTableId='string',
    PrefixListId='string',
    TransitGatewayAttachmentId='string',
    Blackhole=True|False,
    DryRun=True|False
)
Parameters:

  • TransitGatewayRouteTableId (string) –

    [REQUIRED]

    The ID of the transit gateway route table.

  • PrefixListId (string) –

    [REQUIRED]

    The ID of the prefix list that is used for destination matches.

  • TransitGatewayAttachmentId (string) – The ID of the attachment to which traffic is routed.

  • Blackhole (boolean) – Indicates whether to drop traffic that matches this route.

  • 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

{
    'TransitGatewayPrefixListReference': {
        'TransitGatewayRouteTableId': 'string',
        'PrefixListId': 'string',
        'PrefixListOwnerId': 'string',
        'State': 'pending'|'available'|'modifying'|'deleting',
        'Blackhole': True|False,
        'TransitGatewayAttachment': {
            'TransitGatewayAttachmentId': 'string',
            'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering',
            'ResourceId': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • TransitGatewayPrefixListReference (dict) –

      Information about the prefix list reference.

      • TransitGatewayRouteTableId (string) –

        The ID of the transit gateway route table.

      • PrefixListId (string) –

        The ID of the prefix list.

      • PrefixListOwnerId (string) –

        The ID of the prefix list owner.

      • State (string) –

        The state of the prefix list reference.

      • Blackhole (boolean) –

        Indicates whether traffic that matches this route is dropped.

      • TransitGatewayAttachment (dict) –

        Information about the transit gateway attachment.

        • TransitGatewayAttachmentId (string) –

          The ID of the attachment.

        • ResourceType (string) –

          The resource type. Note that the tgw-peering resource type has been deprecated.

        • ResourceId (string) –

          The ID of the resource.