Table Of Contents

Feedback

User Guide

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

[ aws . appmesh ]

delete-route

Description

Deletes an existing route.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  delete-route
--mesh-name <value>
--route-name <value>
--virtual-router-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--mesh-name (string)

The name of the service mesh to delete the route in.

--route-name (string)

The name of the route to delete.

--virtual-router-name (string)

The name of the virtual router to delete the route in.

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

The following delete-route example deletes the specified route.

aws appmesh delete-route \
    --mesh-name app1 \
    --virtual-router-name vrServiceB \
    --route-name toVnServiceB-weighted

Output:

{
    "route": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB/route/toVnServiceB-weighted",
            "createdAt": 1563811384.015,
            "lastUpdatedAt": 1563823915.936,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 3
        },
        "routeName": "toVnServiceB-weighted",
        "spec": {
            "httpRoute": {
                "action": {
                    "weightedTargets": [
                        {
                            "virtualNode": "vnServiceBv1",
                            "weight": 80
                        },
                        {
                            "virtualNode": "vnServiceBv2",
                            "weight": 20
                        }
                    ]
                },
                "match": {
                    "prefix": "/"
                }
            }
        },
        "status": {
            "status": "DELETED"
        },
        "virtualRouterName": "vrServiceB"
    }
}

For more information, see Routes in the AWS App Mesh User Guide.

Output

route -> (structure)

The route that was deleted.

meshName -> (string)

The name of the service mesh that the route resides in.

metadata -> (structure)

The associated metadata for the route.

arn -> (string)

The full Amazon Resource Name (ARN) for the resource.

createdAt -> (timestamp)

The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt -> (timestamp)

The Unix epoch timestamp in seconds for when the resource was last updated.

uid -> (string)

The unique identifier for the resource.

version -> (long)

The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

routeName -> (string)

The name of the route.

spec -> (structure)

The specifications of the route.

httpRoute -> (structure)

The HTTP routing information for the route.

action -> (structure)

The action to take if a match is determined.

weightedTargets -> (list)

The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.

(structure)

An object representing a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10.

virtualNode -> (string)

The virtual node to associate with the weighted target.

weight -> (integer)

The relative weight of the weighted target.

match -> (structure)

The criteria for determining an HTTP request match.

headers -> (list)

The client request headers to match on.

(structure)

An object representing the HTTP header in the request.

invert -> (boolean)

Specify True to match the opposite of the HeaderMatchMethod method and value. The default value is False .

match -> (structure)

The HeaderMatchMethod object.

exact -> (string)

The header value sent by the client must match the specified value exactly.

prefix -> (string)

The header value sent by the client must begin with the specified characters.

range -> (structure)

The object that specifies the range of numbers that the header value sent by the client must be included in.

end -> (long)

The end of the range.

start -> (long)

The start of the range.

regex -> (string)

The header value sent by the client must include the specified characters.

suffix -> (string)

The header value sent by the client must end with the specified characters.

name -> (string)

A name for the HTTP header in the client request that will be matched on.

method -> (string)

The client request header method to match on.

prefix -> (string)

Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .

scheme -> (string)

The client request header scheme to match on.

retryPolicy -> (structure)

An object that represents a retry policy.

httpRetryEvents -> (list)

Specify at least one of the following values.

  • server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
  • gateway-error – HTTP status codes 502, 503, and 504
  • client-error – HTTP status code 409
  • stream-error – Retry on refused stream

(string)

maxRetries -> (long)

The maximum number of retry attempts. If no value is specified, the default is 1.

perRetryTimeout -> (structure)

An object that represents the retry duration.

unit -> (string)

The unit of time between retry attempts.

value -> (long)

The duration of time between retry attempts.

tcpRetryEvents -> (list)

Specify a valid value.

(string)

priority -> (integer)

The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority.

tcpRoute -> (structure)

The TCP routing information for the route.

action -> (structure)

The action to take if a match is determined.

weightedTargets -> (list)

The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.

(structure)

An object representing a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10.

virtualNode -> (string)

The virtual node to associate with the weighted target.

weight -> (integer)

The relative weight of the weighted target.

status -> (structure)

The status of the route.

status -> (string)

The current status for the route.

virtualRouterName -> (string)

The virtual router that the route is associated with.