virtual_services

Creates, updates, deletes, gets or lists a virtual_services resource.

Overview

Name	virtual_services
Type	Resource
Id	aws.appmesh.virtual_services

Fields

The following fields are returned by SELECT queries:

describe_virtual_service

Name	Datatype	Description
mesh_name	string	The name of the service mesh that the virtual service resides in.
metadata	object	An object that represents metadata for a resource.
spec	object	An object that represents the specification of a virtual service.
status	object	The current status of the virtual service.
virtual_service_name	string	The name of the virtual service.

list_virtual_services

Name	Datatype	Description
arn	string	The full Amazon Resource Name (ARN) for the virtual service.
created_at	string (date-time)	The Unix epoch timestamp in seconds for when the resource was created.
last_updated_at	string (date-time)	The Unix epoch timestamp in seconds for when the resource was last updated.
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.
resource_owner	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.
version	integer (int64)	The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
virtual_service_name	string	The name of the virtual service.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_virtual_service	select	mesh_name, virtual_service_name, region	meshOwner	Describes an existing virtual service.
list_virtual_services	select	mesh_name, region	limit, meshOwner, nextToken	Returns a list of existing virtual services in a service mesh.
create_virtual_service	insert	mesh_name, region, spec, virtualServiceName	meshOwner	Creates a virtual service within a service mesh. A virtual service is an abstraction of a real service that is provided by a virtual node directly or indirectly by means of a virtual router. Dependent services call your virtual service by its virtualServiceName, and those requests are routed to the virtual node or virtual router that is specified as the provider for the virtual service. For more information about virtual services, see Virtual services.
update_virtual_service	update	mesh_name, virtual_service_name, region, spec	meshOwner	Updates an existing virtual service in a specified service mesh.
delete_virtual_service	delete	mesh_name, virtual_service_name, region	meshOwner	Deletes an existing virtual service.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
mesh_name	string	The name of the service mesh to delete the virtual service in.
region	string	AWS region (default: us-east-1)
virtual_service_name	string	The name of the virtual service to delete.
limit	integer	The maximum number of results returned by ListVirtualServices in paginated output. When you use this parameter, ListVirtualServices returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualServices request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualServices returns up to 100 results and a nextToken value if applicable.
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.
nextToken	string	The nextToken value returned from a previous paginated ListVirtualServices request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

SELECT examples

describe_virtual_service

Describes an existing virtual service.

SELECT
mesh_name,
metadata,
spec,
status,
virtual_service_name
FROM aws.appmesh.virtual_services
WHERE mesh_name = '{{ mesh_name }}' -- required
AND virtual_service_name = '{{ virtual_service_name }}' -- required
AND region = '{{ region }}' -- required
AND meshOwner = '{{ meshOwner }}'
;

list_virtual_services

Returns a list of existing virtual services in a service mesh.

SELECT
arn,
created_at,
last_updated_at,
mesh_name,
mesh_owner,
resource_owner,
version,
virtual_service_name
FROM aws.appmesh.virtual_services
WHERE mesh_name = '{{ mesh_name }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND meshOwner = '{{ meshOwner }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_virtual_service

Creates a virtual service within a service mesh. A virtual service is an abstraction of a real service that is provided by a virtual node directly or indirectly by means of a virtual router. Dependent services call your virtual service by its virtualServiceName, and those requests are routed to the virtual node or virtual router that is specified as the provider for the virtual service. For more information about virtual services, see Virtual services.

INSERT INTO aws.appmesh.virtual_services (
clientToken,
spec,
tags,
virtualServiceName,
mesh_name,
region,
meshOwner
)
SELECT 
'{{ clientToken }}',
'{{ spec }}' /* required */,
'{{ tags }}',
'{{ virtualServiceName }}' /* required */,
'{{ mesh_name }}',
'{{ region }}',
'{{ meshOwner }}'
RETURNING
virtual_service
;

Manifest

# Description fields are for documentation purposes
- name: virtual_services
props:
  - name: mesh_name
    value: "{{ mesh_name }}"
    description: Required parameter for the virtual_services resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the virtual_services resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: spec
    description: |
      An object that represents the specification of a virtual service.
    value:
      provider:
        virtualNode:
          virtualNodeName: "{{ virtualNodeName }}"
        virtualRouter:
          virtualRouterName: "{{ virtualRouterName }}"
  - name: tags
    value:
      - key: "{{ key }}"
        value: "{{ value }}"
  - name: virtualServiceName
    value: "{{ virtualServiceName }}"
  - name: meshOwner
    value: "{{ meshOwner }}"
    description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
    description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.

UPDATE examples

update_virtual_service

Updates an existing virtual service in a specified service mesh.

UPDATE aws.appmesh.virtual_services
SET 
clientToken = '{{ clientToken }}',
spec = '{{ spec }}'
WHERE 
mesh_name = '{{ mesh_name }}' --required
AND virtual_service_name = '{{ virtual_service_name }}' --required
AND region = '{{ region }}' --required
AND spec = '{{ spec }}' --required
AND meshOwner = '{{ meshOwner}}'
RETURNING
virtual_service;

DELETE examples

delete_virtual_service

Deletes an existing virtual service.

DELETE FROM aws.appmesh.virtual_services
WHERE mesh_name = '{{ mesh_name }}' --required
AND virtual_service_name = '{{ virtual_service_name }}' --required
AND region = '{{ region }}' --required
AND meshOwner = '{{ meshOwner }}'
;