Route / Action / replace

replace#

EC2.Route.replace(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = route.replace(
    DestinationPrefixListId='string',
    VpcEndpointId='string',
    LocalTarget=True|False,
    TransitGatewayId='string',
    LocalGatewayId='string',
    CarrierGatewayId='string',
    CoreNetworkArn='string',
    DryRun=True|False,
    GatewayId='string',
    DestinationIpv6CidrBlock='string',
    EgressOnlyInternetGatewayId='string',
    InstanceId='string',
    NetworkInterfaceId='string',
    VpcPeeringConnectionId='string',
    NatGatewayId='string'
)
Parameters:

  • DestinationPrefixListId (string) – The ID of the prefix list for the route.

  • VpcEndpointId (string) – The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.

  • LocalTarget (boolean) – Specifies whether to reset the local route to its default target ( local).

  • TransitGatewayId (string) – The ID of a transit gateway.

  • LocalGatewayId (string) – The ID of the local gateway.

  • CarrierGatewayId (string) – [IPv4 traffic only] The ID of a carrier gateway.

  • CoreNetworkArn (string) – The Amazon Resource Name (ARN) of the core network.

  • DryRun (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.

  • GatewayId (string) – The ID of an internet gateway or virtual private gateway.

  • DestinationIpv6CidrBlock (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.

  • EgressOnlyInternetGatewayId (string) – [IPv6 traffic only] The ID of an egress-only internet gateway.

  • InstanceId (string) – The ID of a NAT instance in your VPC.

  • NetworkInterfaceId (string) – The ID of a network interface.

  • VpcPeeringConnectionId (string) – The ID of a VPC peering connection.

  • NatGatewayId (string) – [IPv4 traffic only] The ID of a NAT gateway.

Returns:

None