Table Of Contents

Feedback

User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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>
[--mesh-owner <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.

--mesh-owner (string)

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with Shared Meshes .

--spec (structure)

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

JSON Syntax:

{
  "listeners": [
    {
      "portMapping": {
        "port": integer,
        "protocol": "grpc"|"http"|"http2"|"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.

Examples

To update a virtual router

The following update-virtual-router example uses a JSON input file to update a virtual router listener port.

aws appmesh update-virtual-router \
    --cli-input-json file://update-virtual-router.json

Contents of update-virtual-router.json:

{
    "meshName": "app1",
    "spec": {
        "listeners": [
            {
                "portMapping": {
                    "port": 8080,
                    "protocol": "http"
                }
            }
        ]
    },
    "virtualRouterName": "vrServiceB"
}

Output:

{
    "virtualRouter": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB",
            "createdAt": 1563810546.59,
            "lastUpdatedAt": 1563819431.352,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 2
        },
        "spec": {
            "listeners": [
                {
                    "portMapping": {
                        "port": 8080,
                        "protocol": "http"
                    }
                }
            ]
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualRouterName": "vrServiceB"
    }
}

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

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.

meshOwner -> (string)

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with Shared Meshes .

resourceOwner -> (string)

The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with Shared Meshes .

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. You can specify one listener.

(structure)

An object that represents a virtual router listener.

portMapping -> (structure)

An object that represents a port mapping.

port -> (integer)

The port used for the port mapping.

protocol -> (string)

The protocol used for the port mapping. Specify one protocol.

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.