Table Of Contents

Feedback

User Guide

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

[ aws . appmesh ]

update-virtual-router

Description

Updates an existing virtual router in a specified service mesh.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-virtual-router
[--client-token <value>]
--mesh-name <value>
--spec <value>
--virtual-router-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--client-token (string)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

--mesh-name (string)

The name of the service mesh that the virtual router resides in.

--spec (structure)

The new virtual router specification to apply. This overwrites the existing data.

JSON Syntax:

{
  "listeners": [
    {
      "portMapping": {
        "port": integer,
        "protocol": "http"|"tcp"
      }
    }
    ...
  ]
}

--virtual-router-name (string)

The name of the virtual router to update.

--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.

Output

virtualRouter -> (structure)

A full description of the virtual router that was updated.

meshName -> (string)

The name of the service mesh that the virtual router resides in.

metadata -> (structure)

The associated metadata for the virtual router.

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.

spec -> (structure)

The specifications of the virtual router.

listeners -> (list)

The listeners that the virtual router is expected to receive inbound traffic from. Currently only one listener is supported per virtual router.

(structure)

An object representing a virtual router listener.

portMapping -> (structure)

An object representing a virtual node or virtual router listener port mapping.

port -> (integer)

The port used for the port mapping.

protocol -> (string)

The protocol used for the port mapping.

status -> (structure)

The current status of the virtual router.

status -> (string)

The current status of the virtual router.

virtualRouterName -> (string)

The name of the virtual router.