meshes

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

Overview

Name	meshes
Type	Resource
Id	aws.appmesh.meshes

Fields

The following fields are returned by SELECT queries:

describe_mesh

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

list_meshes

Name	Datatype	Description
arn	string	The full Amazon Resource Name (ARN) of the service mesh.
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.
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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_mesh	select	mesh_name, region	meshOwner	Describes an existing service mesh.
list_meshes	select	region	limit, nextToken	Returns a list of existing service meshes.
create_mesh	insert	region, meshName		Creates a service mesh. A service mesh is a logical boundary for network traffic between services that are represented by resources within the mesh. After you create your service mesh, you can create virtual services, virtual nodes, virtual routers, and routes to distribute traffic between the applications in your mesh. For more information about service meshes, see Service meshes.
update_mesh	update	mesh_name, region		Updates an existing service mesh.
delete_mesh	delete	mesh_name, region		Deletes an existing service mesh. You must delete all resources (virtual services, routes, virtual routers, and virtual nodes) in the service mesh before you can delete the mesh itself.

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.
region	string	AWS region (default: us-east-1)
limit	integer	The maximum number of results returned by ListMeshes in paginated output. When you use this parameter, ListMeshes 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 ListMeshes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListMeshes 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 ListMeshes 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. This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

SELECT examples

describe_mesh

Describes an existing service mesh.

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

list_meshes

Returns a list of existing service meshes.

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

INSERT examples

create_mesh

Creates a service mesh. A service mesh is a logical boundary for network traffic between services that are represented by resources within the mesh. After you create your service mesh, you can create virtual services, virtual nodes, virtual routers, and routes to distribute traffic between the applications in your mesh. For more information about service meshes, see Service meshes.

INSERT INTO aws.appmesh.meshes (
clientToken,
meshName,
spec,
tags,
region
)
SELECT 
'{{ clientToken }}',
'{{ meshName }}' /* required */,
'{{ spec }}',
'{{ tags }}',
'{{ region }}'
RETURNING
mesh
;

Manifest

# Description fields are for documentation purposes
- name: meshes
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the meshes resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: meshName
    value: "{{ meshName }}"
  - name: spec
    description: |
      An object that represents the specification of a service mesh.
    value:
      egressFilter:
        type_: "{{ type_ }}"
      serviceDiscovery:
        ipPreference: "{{ ipPreference }}"
  - name: tags
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

UPDATE examples

update_mesh

Updates an existing service mesh.

UPDATE aws.appmesh.meshes
SET 
clientToken = '{{ clientToken }}',
spec = '{{ spec }}'
WHERE 
mesh_name = '{{ mesh_name }}' --required
AND region = '{{ region }}' --required
RETURNING
mesh;

DELETE examples

delete_mesh

Deletes an existing service mesh. You must delete all resources (virtual services, routes, virtual routers, and virtual nodes) in the service mesh before you can delete the mesh itself.

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