virtual_gateways

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

Overview

Name	virtual_gateways
Type	Resource
Id	aws.appmesh.virtual_gateways

Fields

The following fields are returned by SELECT queries:

describe_virtual_gateway

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

list_virtual_gateways

Name	Datatype	Description
arn	string	The full Amazon Resource Name (ARN) for the resource.
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 resource 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_gateway_name	string	The name of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_virtual_gateway	select	mesh_name, virtual_gateway_name, region	meshOwner	Describes an existing virtual gateway.
list_virtual_gateways	select	mesh_name, region	limit, meshOwner, nextToken	Returns a list of existing virtual gateways in a service mesh.
create_virtual_gateway	insert	mesh_name, region, spec, virtualGatewayName	meshOwner	Creates a virtual gateway. A virtual gateway allows resources outside your mesh to communicate to resources that are inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a virtual node, which represents an Envoy running with an application, a virtual gateway represents Envoy deployed by itself. For more information about virtual gateways, see Virtual gateways.
update_virtual_gateway	update	mesh_name, virtual_gateway_name, region, spec	meshOwner	Updates an existing virtual gateway in a specified service mesh.
delete_virtual_gateway	delete	mesh_name, virtual_gateway_name, region	meshOwner	Deletes an existing virtual gateway. You cannot delete a virtual gateway if any gateway routes are associated to it.

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 gateway from.
region	string	AWS region (default: us-east-1)
virtual_gateway_name	string	The name of the virtual gateway to delete.
limit	integer	The maximum number of results returned by ListVirtualGateways in paginated output. When you use this parameter, ListVirtualGateways 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 ListVirtualGateways request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualGateways 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 ListVirtualGateways 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_gateway

Describes an existing virtual gateway.

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

list_virtual_gateways

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

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

INSERT examples

create_virtual_gateway

Creates a virtual gateway. A virtual gateway allows resources outside your mesh to communicate to resources that are inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a virtual node, which represents an Envoy running with an application, a virtual gateway represents Envoy deployed by itself. For more information about virtual gateways, see Virtual gateways.

INSERT INTO aws.appmesh.virtual_gateways (
clientToken,
spec,
tags,
virtualGatewayName,
mesh_name,
region,
meshOwner
)
SELECT 
'{{ clientToken }}',
'{{ spec }}' /* required */,
'{{ tags }}',
'{{ virtualGatewayName }}' /* required */,
'{{ mesh_name }}',
'{{ region }}',
'{{ meshOwner }}'
RETURNING
virtual_gateway
;

Manifest

# Description fields are for documentation purposes
- name: virtual_gateways
props:
  - name: mesh_name
    value: "{{ mesh_name }}"
    description: Required parameter for the virtual_gateways resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the virtual_gateways resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: spec
    description: |
      An object that represents the specification of a service mesh resource.
    value:
      backendDefaults:
        clientPolicy:
          tls:
            certificate:
              file: "{{ file }}"
              sds: "{{ sds }}"
            enforce: {{ enforce }}
            ports:
              - {{ ports }}
            validation:
              subjectAlternativeNames: "{{ subjectAlternativeNames }}"
              trust: "{{ trust }}"
      listeners:
        - connectionPool:
            grpc:
              maxRequests: {{ maxRequests }}
            http:
              maxConnections: {{ maxConnections }}
              maxPendingRequests: {{ maxPendingRequests }}
            http2:
              maxRequests: {{ maxRequests }}
          healthCheck:
            healthyThreshold: {{ healthyThreshold }}
            intervalMillis: {{ intervalMillis }}
            path: "{{ path }}"
            port: {{ port }}
            protocol: "{{ protocol }}"
            timeoutMillis: {{ timeoutMillis }}
            unhealthyThreshold: {{ unhealthyThreshold }}
          portMapping:
            port: {{ port }}
            protocol: "{{ protocol }}"
          tls:
            certificate:
              acm:
                certificateArn: "{{ certificateArn }}"
              file:
                certificateChain: "{{ certificateChain }}"
                privateKey: "{{ privateKey }}"
              sds:
                secretName: "{{ secretName }}"
            mode: "{{ mode }}"
            validation:
              subjectAlternativeNames:
                match: "{{ match }}"
              trust:
                file: "{{ file }}"
                sds: "{{ sds }}"
      logging:
        accessLog:
          file:
            format_:
              json: "{{ json }}"
              text: "{{ text }}"
            path: "{{ path }}"
  - name: tags
    value:
      - key: "{{ key }}"
        value: "{{ value }}"
  - name: virtualGatewayName
    value: "{{ virtualGatewayName }}"
  - 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_gateway

Updates an existing virtual gateway in a specified service mesh.

UPDATE aws.appmesh.virtual_gateways
SET 
clientToken = '{{ clientToken }}',
spec = '{{ spec }}'
WHERE 
mesh_name = '{{ mesh_name }}' --required
AND virtual_gateway_name = '{{ virtual_gateway_name }}' --required
AND region = '{{ region }}' --required
AND spec = '{{ spec }}' --required
AND meshOwner = '{{ meshOwner}}'
RETURNING
virtual_gateway;

DELETE examples

delete_virtual_gateway

Deletes an existing virtual gateway. You cannot delete a virtual gateway if any gateway routes are associated to it.

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