[ aws . ec2 ]

create-transit-gateway-prefix-list-reference

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-transit-gateway-prefix-list-reference
--transit-gateway-route-table-id <value>
--prefix-list-id <value>
[--transit-gateway-attachment-id <value>]
[--blackhole | --no-blackhole]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--transit-gateway-route-table-id (string)

The ID of the transit gateway route table.

--prefix-list-id (string)

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

--transit-gateway-attachment-id (string)

The ID of the attachment to which traffic is routed.

--blackhole | --no-blackhole (boolean)

Indicates whether to drop traffic that matches this route.

--dry-run | --no-dry-run (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 .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To create a reference to a prefix list

The following create-transit-gateway-prefix-list-reference example creates a reference to the specified prefix list in the specified transit gateway route table.

aws ec2 create-transit-gateway-prefix-list-reference \
    --transit-gateway-route-table-id tgw-rtb-0123456789abcd123 \
    --prefix-list-id pl-11111122222222333 \
    --transit-gateway-attachment-id tgw-attach-aaaaaabbbbbb11111

Output:

{
    "TransitGatewayPrefixListReference": {
        "TransitGatewayRouteTableId": "tgw-rtb-0123456789abcd123",
        "PrefixListId": "pl-11111122222222333",
        "PrefixListOwnerId": "123456789012",
        "State": "pending",
        "Blackhole": false,
        "TransitGatewayAttachment": {
            "TransitGatewayAttachmentId": "tgw-attach-aaaaaabbbbbb11111",
            "ResourceType": "vpc",
            "ResourceId": "vpc-112233445566aabbc"
        }
    }
}

For more information, see Prefix list references in the Transit Gateways Guide.

Output

TransitGatewayPrefixListReference -> (structure)

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 -> (structure)

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.