[ aws . ec2 ]

replace-route

Description

Replaces an existing route within a route table in a VPC.

You must specify either a destination CIDR block or a prefix list ID. You must also specify exactly one of the resources from the parameter list, or reset the local route to its default target.

For more information, see Route tables in the Amazon Virtual Private Cloud User Guide .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  replace-route
[--destination-cidr-block <value>]
[--destination-ipv6-cidr-block <value>]
[--destination-prefix-list-id <value>]
[--dry-run | --no-dry-run]
[--vpc-endpoint-id <value>]
[--egress-only-internet-gateway-id <value>]
[--gateway-id <value>]
[--instance-id <value>]
[--local-target | --no-local-target]
[--nat-gateway-id <value>]
[--transit-gateway-id <value>]
[--local-gateway-id <value>]
[--carrier-gateway-id <value>]
[--network-interface-id <value>]
--route-table-id <value>
[--vpc-peering-connection-id <value>]
[--core-network-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--destination-cidr-block (string)

The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.

--destination-ipv6-cidr-block (string)

The IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.

--destination-prefix-list-id (string)

The ID of the prefix list for the 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 .

--vpc-endpoint-id (string)

The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.

--egress-only-internet-gateway-id (string)

[IPv6 traffic only] The ID of an egress-only internet gateway.

--gateway-id (string)

The ID of an internet gateway or virtual private gateway.

--instance-id (string)

The ID of a NAT instance in your VPC.

--local-target | --no-local-target (boolean)

Specifies whether to reset the local route to its default target (local ).

--nat-gateway-id (string)

[IPv4 traffic only] The ID of a NAT gateway.

--transit-gateway-id (string)

The ID of a transit gateway.

--local-gateway-id (string)

The ID of the local gateway.

--carrier-gateway-id (string)

[IPv4 traffic only] The ID of a carrier gateway.

--network-interface-id (string)

The ID of a network interface.

--route-table-id (string)

The ID of the route table.

--vpc-peering-connection-id (string)

The ID of a VPC peering connection.

--core-network-arn (string)

The Amazon Resource Name (ARN) of the core network.

--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 replace a route

This example replaces the specified route in the specified route table. The new route matches the specified CIDR and sends the traffic to the specified virtual private gateway. If the command succeeds, no output is returned.

Command:

aws ec2 replace-route --route-table-id rtb-22574640 --destination-cidr-block 10.0.0.0/16 --gateway-id vgw-9a4cacf3

Output

None