Table Of Contents

Feedback

User Guide

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

[ aws . appmesh ]

create-virtual-router

Description

Creates a virtual router within a service mesh.

Any inbound traffic that your virtual router expects should be specified as a listener .

Virtual routers handle traffic for one or more virtual services within your mesh. After you create your virtual router, create and associate routes for your virtual router that direct incoming requests to different virtual nodes.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-virtual-router
[--client-token <value>]
--mesh-name <value>
--spec <value>
[--tags <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 to create the virtual router in.

--spec (structure)

The virtual router specification to apply.

JSON Syntax:

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

--tags (list)

Optional metadata that you can apply to the virtual router to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--virtual-router-name (string)

The name to use for the virtual router.

--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 create a new virtual router

The following create-virtual-router example uses a JSON input file to create a virtual router with a listener for HTTP using port 80.

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

Contents of create-virtual-router.json:

{
    "meshName": "app1",
    "spec": {
        "listeners": [
            {
                "portMapping": {
                    "port": 80,
                    "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": 1563810546.59,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 1
        },
        "spec": {
            "listeners": [
                {
                    "portMapping": {
                        "port": 80,
                        "protocol": "http"
                    }
                }
            ]
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualRouterName": "vrServiceB"
    }
}

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

Output

virtualRouter -> (structure)

The full description of your virtual router following the create call.

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.