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.
Updates an existing virtual service in a specified service mesh.
See also: AWS API Documentation
update-virtual-service
[--client-token <value>]
--mesh-name <value>
[--mesh-owner <value>]
--spec <value>
--virtual-service-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--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 service resides in.
--mesh-owner
(string)
The Amazon Web Services 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 service specification to apply. This overwrites the existing data.
provider -> (tagged union structure)
The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:virtualNode
,virtualRouter
.virtualNode -> (structure)
The virtual node associated with a virtual service.
virtualNodeName -> (string)
The name of the virtual node that is acting as a service provider.virtualRouter -> (structure)
The virtual router associated with a virtual service.
virtualRouterName -> (string)
The name of the virtual router that is acting as a service provider.
Shorthand Syntax:
provider={virtualNode={virtualNodeName=string},virtualRouter={virtualRouterName=string}}
JSON Syntax:
{
"provider": {
"virtualNode": {
"virtualNodeName": "string"
},
"virtualRouter": {
"virtualRouterName": "string"
}
}
}
--virtual-service-name
(string)
The name of the virtual service 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.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To update a virtual service
The following update-virtual-service
example uses a JSON input file to update a virtual service to use a virtual router provider.
aws appmesh update-virtual-service \
--cli-input-json file://update-virtual-service.json
Contents of update-virtual-service.json
:
{
"meshName": "app1",
"spec": {
"provider": {
"virtualRouter": {
"virtualRouterName": "vrServiceA"
}
}
},
"virtualServiceName": "serviceA.svc.cluster.local"
}
Output:
{
"virtualService": {
"meshName": "app1",
"metadata": {
"arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceA.svc.cluster.local",
"createdAt": 1563810859.474,
"lastUpdatedAt": 1563820257.411,
"uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
"version": 3
},
"spec": {
"provider": {
"virtualRouter": {
"virtualRouterName": "vrServiceA"
}
}
},
"status": {
"status": "ACTIVE"
},
"virtualServiceName": "serviceA.svc.cluster.local"
}
}
For more information, see Virtual Services in the AWS App Mesh User Guide.
virtualService -> (structure)
A full description of the virtual service that was updated.
meshName -> (string)
The name of the service mesh that the virtual service resides in.metadata -> (structure)
An object that represents metadata for a resource.
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 Amazon Web Services 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 Amazon Web Services 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 service.
provider -> (tagged union structure)
The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:virtualNode
,virtualRouter
.virtualNode -> (structure)
The virtual node associated with a virtual service.
virtualNodeName -> (string)
The name of the virtual node that is acting as a service provider.virtualRouter -> (structure)
The virtual router associated with a virtual service.
virtualRouterName -> (string)
The name of the virtual router that is acting as a service provider.status -> (structure)
The current status of the virtual service.
status -> (string)
The current status of the virtual service.virtualServiceName -> (string)
The name of the virtual service.