Skip to content

Replaces an existing route within a route table in a VPC

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 VPC User Guide.

Usage

ec2_replace_route(DestinationPrefixListId, VpcEndpointId, LocalTarget,
  TransitGatewayId, LocalGatewayId, CarrierGatewayId, CoreNetworkArn,
  OdbNetworkArn, DryRun, RouteTableId, DestinationCidrBlock, GatewayId,
  DestinationIpv6CidrBlock, EgressOnlyInternetGatewayId, InstanceId,
  NetworkInterfaceId, VpcPeeringConnectionId, NatGatewayId)

Arguments

  • DestinationPrefixListId

    The ID of the prefix list for the route.

  • VpcEndpointId

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

  • LocalTarget

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

  • TransitGatewayId

    The ID of a transit gateway.

  • LocalGatewayId

    The ID of the local gateway.

  • CarrierGatewayId

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

  • CoreNetworkArn

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

  • OdbNetworkArn

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

  • DryRun

    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.

  • RouteTableId

    [required] The ID of the route table.

  • DestinationCidrBlock

    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.

  • GatewayId

    The ID of an internet gateway or virtual private gateway.

  • DestinationIpv6CidrBlock

    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.

  • EgressOnlyInternetGatewayId

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

  • InstanceId

    The ID of a NAT instance in your VPC.

  • NetworkInterfaceId

    The ID of a network interface.

  • VpcPeeringConnectionId

    The ID of a VPC peering connection.

  • NatGatewayId

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

Value

An empty list.

Request syntax

svc$replace_route(
  DestinationPrefixListId = "string",
  VpcEndpointId = "string",
  LocalTarget = TRUE|FALSE,
  TransitGatewayId = "string",
  LocalGatewayId = "string",
  CarrierGatewayId = "string",
  CoreNetworkArn = "string",
  OdbNetworkArn = "string",
  DryRun = TRUE|FALSE,
  RouteTableId = "string",
  DestinationCidrBlock = "string",
  GatewayId = "string",
  DestinationIpv6CidrBlock = "string",
  EgressOnlyInternetGatewayId = "string",
  InstanceId = "string",
  NetworkInterfaceId = "string",
  VpcPeeringConnectionId = "string",
  NatGatewayId = "string"
)

Examples

# This example replaces the specified route in the specified table table.
# The new route matches the specified CIDR and sends the traffic to the
# specified virtual private gateway.
svc$replace_route(
  DestinationCidrBlock = "10.0.0.0/16",
  GatewayId = "vgw-9a4cacf3",
  RouteTableId = "rtb-22574640"
)