ec2-replace-route

Description

Replaces an existing route within a route table in a VPC. For more information about route tables, go to Route Tables in the Amazon Virtual Private Cloud User Guide.

The short version of this command is ec2reprt.

Syntax

ec2-replace-route route_table_id -r cidr {-g gateway_id | -i instance_id | -n, --network-interface NETWORKINTERFACE}

Options

Name	Description	Required
`route_table_id`	The ID of the route table where the route will be replaced. Type: String Default: None Example: rtb-5da34634	Yes
`-r, --cidr` `cidr`	The CIDR address block used for the destination match. Routing decisions are based on the most specific match. Type: String Default: None Example: -r 0.0.0.0/0	Yes
`-g, --gateway` `gateway_id`	The ID of a gateway in your VPC. Type: String Default: None Condition: You must provide one of the following: a gateway ID, instance ID, or a network interface ID. Example: -g igw-68a34601	Conditional
`-i, --instance` `instance_id`	The ID of a NAT instance in your VPC. Type: String Default: None Condition: You must provide one of the following: a gateway ID, instance ID, or a network interface ID. Example: -i i-a7c871e3	Conditional
`-n, --network-interface` `NETWORKINTERFACE`	The network interface associated with the route. Type: String Default: None Condition: You must provide one of the following: a gateway ID, instance ID, or a network interface. Example: -n eni-5b729933	Conditional

Common Options

Option	Description
`--region` `REGION`	Overrides the Region specified in the `EC2_URL` environment variable and the URL specified by the `-U` option. Default: The `EC2_URL` environment variable, or `us-east-1` if the environment variable is not set. Example: `--region eu-west-1`
`-U, --url` `URL`	`URL` is the uniform resource locator of the Amazon EC2 web service entry point. Default: The `EC2_URL` environment variable, or https://ec2.amazonaws.com if the environment variable is not set. Example: `-U https://ec2.amazonaws.com`
`-K, --private-key` `EC2-PRIVATE-KEY`	The private key to use when constructing requests to Amazon EC2. Default: The value of the `EC2_PRIVATE_KEY` environment variable. Example: `-K pk-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem`
`-C, --cert` `EC2-CERT`	The X.509 certificate to use when constructing requests to Amazon EC2. Default: The value of the `EC2_CERT` environment variable. Example: `-C cert-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem`
`--connection-timeout` `TIMEOUT`	Specifies a connection timeout (in seconds). Example: --connection-timeout 30
`--request-timeout` `TIMEOUT`	Specifies a request timeout (in seconds). Example: --request-timeout 45
`-v, --verbose`	Displays verbose output by showing the SOAP request and response on the command line. This is particularly useful if you are building tools to talk directly to our SOAP API.
`-H, --headers`	Displays column headers in the output.
`--show-empty-fields`	Shows empty columns as `(nil)`.
`--hide-tags`	Do not display tags for tagged resources.
`--debug`	Prints internal debugging information. This is useful to assist us when troubleshooting problems.
`-?, --help, -h`	Displays Help.
`-`	If `-` is specified as an argument to one of the parameters, a list of arguments is read from standard input. This is useful for piping the output of one command into the input of another. Example: `ec2-describe-instances \| grep stopped \| cut -f 2 \| ec2-start-instances -`

Output

The command returns a table that contains the following information:

Boolean true or false

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example replaces a route in the route table with ID rtb-e4ad488d. The new route matches the CIDR 10.0.0.0/8 and sends it to the virtual private gateway with ID vgw-1d00376e.

PROMPT> ec2-replace-route rtb-e4ad488d -r 10.0.0.0/8 -g vgw-1d00376e 
RETURN 	true