Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ec2 ]

replace-transit-gateway-route

Description

Replaces the specified route in the specified transit gateway route table.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  replace-transit-gateway-route
--destination-cidr-block <value>
--transit-gateway-route-table-id <value>
[--transit-gateway-attachment-id <value>]
[--blackhole | --no-blackhole]
[--dry-run | --no-dry-run]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--destination-cidr-block (string)

The CIDR range used for the destination match. Routing decisions are based on the most specific match.

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

The ID of the route table.

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

The ID of the attachment.

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

Indicates whether traffic matching this route is to be dropped.

--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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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 replace the specified route in the specified transit gateway route table

The following replace-transit-gateway-route example replaces the route in the specified transit gateway route table.

aws ec2 replace-transit-gateway-route \
    --destination-cidr-block 10.0.2.0/24 \
    --transit-gateway-attachment-id tgw-attach-09b52ccdb5EXAMPLE \
    --transit-gateway-route-table-id tgw-rtb-0a823edbdeEXAMPLE

Output:

{
    "Route": {
        "DestinationCidrBlock": "10.0.2.0/24",
        "TransitGatewayAttachments": [
            {
                "ResourceId": "vpc-4EXAMPLE",
                "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE",
                "ResourceType": "vpc"
            }
        ],
        "Type": "static",
        "State": "active"
    }
}

For more information, see Transit Gateway Route Tables in the AWS Transit Gateways Guide.

Output

Route -> (structure)

Information about the modified route.

DestinationCidrBlock -> (string)

The CIDR block used for destination matches.

PrefixListId -> (string)

The ID of the prefix list used for destination matches.

TransitGatewayAttachments -> (list)

The attachments.

(structure)

Describes a route attachment.

ResourceId -> (string)

The ID of the resource.

TransitGatewayAttachmentId -> (string)

The ID of the attachment.

ResourceType -> (string)

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

Type -> (string)

The route type.

State -> (string)

The state of the route.