update-virtual-service¶
Description¶
Updates an existing virtual service in a specified service mesh.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
update-virtual-service
[--client-token <value>]
--mesh-name <value>
[--mesh-owner <value>]
--spec <value>
--virtual-service-name <value>
[--cli-input-json | --cli-input-yaml]
[--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 service 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 service specification to apply. This overwrites the existing data.
provider -> (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.
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 | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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 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.
Output¶
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 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 service.
provider -> (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.
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.