You are viewing the documentation for an older major version of the AWS SDK for JavaScript.

The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.AppMesh

Inherits:

AWS.Service

Object
AWS.Service
AWS.AppMesh

show all

Identifier:: appmesh

API Version:: 2019-01-25

Defined in:: (unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and control microservices. App Mesh standardizes how your microservices communicate, giving you end-to-end visibility and helping to ensure high availability for your applications.

App Mesh gives you consistent visibility and network traffic controls for every microservice in an application. You can use App Mesh with Amazon Web Services Fargate, Amazon ECS, Amazon EKS, Kubernetes on Amazon Web Services, and Amazon EC2.

Note: App Mesh supports microservice applications that use service discovery naming for their components. For more information about service discovery on Amazon ECS, see Service Discovery in the Amazon Elastic Container Service Developer Guide. Kubernetes kube-dns and coredns are supported. For more information, see DNS for Services and Pods in the Kubernetes documentation.

Sending a Request Using AppMesh

var appmesh = new AWS.AppMesh();
appmesh.createGatewayRoute(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the AppMesh object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var appmesh = new AWS.AppMesh({apiVersion: '2019-01-25'});

You can also set the API version globally in AWS.config.apiVersions using the appmesh service identifier:

AWS.config.apiVersions = {
  appmesh: '2019-01-25',
  // other service API versions
};

var appmesh = new AWS.AppMesh();

Version:

2019-01-25

Constructor Summary collapse

new AWS.AppMesh(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary collapse

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

createGatewayRoute(params = {}, callback) ⇒ AWS.Request
Creates a gateway route.

A gateway route is attached to a virtual gateway and routes traffic to an existing virtual service.
createMesh(params = {}, callback) ⇒ AWS.Request
Creates a service mesh.

A service mesh is a logical boundary for network traffic between services that are represented by resources within the mesh.
createRoute(params = {}, callback) ⇒ AWS.Request
Creates a route that is associated with a virtual router.

You can route several different protocols and define a retry policy for a route.
createVirtualGateway(params = {}, callback) ⇒ AWS.Request
Creates a virtual gateway.

A virtual gateway allows resources outside your mesh to communicate to resources that are inside your mesh.
createVirtualNode(params = {}, callback) ⇒ AWS.Request
Creates a virtual node within a service mesh.

A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment.
createVirtualRouter(params = {}, callback) ⇒ AWS.Request
Creates a virtual router within a service mesh.

Specify a listener for any inbound traffic that your virtual router receives.
createVirtualService(params = {}, callback) ⇒ AWS.Request
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.
deleteGatewayRoute(params = {}, callback) ⇒ AWS.Request
Deletes an existing gateway route.

.
deleteMesh(params = {}, callback) ⇒ AWS.Request
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.
.
deleteRoute(params = {}, callback) ⇒ AWS.Request
Deletes an existing route.

.
deleteVirtualGateway(params = {}, callback) ⇒ AWS.Request
Deletes an existing virtual gateway.
deleteVirtualNode(params = {}, callback) ⇒ AWS.Request
Deletes an existing virtual node.

You must delete any virtual services that list a virtual node as a service provider before you can delete the virtual node itself.
.
deleteVirtualRouter(params = {}, callback) ⇒ AWS.Request
Deletes an existing virtual router.

You must delete any routes associated with the virtual router before you can delete the router itself.
.
deleteVirtualService(params = {}, callback) ⇒ AWS.Request
Deletes an existing virtual service.

.
describeGatewayRoute(params = {}, callback) ⇒ AWS.Request
Describes an existing gateway route.

.
describeMesh(params = {}, callback) ⇒ AWS.Request
Describes an existing service mesh.

.
describeRoute(params = {}, callback) ⇒ AWS.Request
Describes an existing route.

.
describeVirtualGateway(params = {}, callback) ⇒ AWS.Request
Describes an existing virtual gateway.

.
describeVirtualNode(params = {}, callback) ⇒ AWS.Request
Describes an existing virtual node.

.
describeVirtualRouter(params = {}, callback) ⇒ AWS.Request
Describes an existing virtual router.

.
describeVirtualService(params = {}, callback) ⇒ AWS.Request
Describes an existing virtual service.

.
listGatewayRoutes(params = {}, callback) ⇒ AWS.Request
Returns a list of existing gateway routes that are associated to a virtual gateway.

.
listMeshes(params = {}, callback) ⇒ AWS.Request
Returns a list of existing service meshes.

.
listRoutes(params = {}, callback) ⇒ AWS.Request
Returns a list of existing routes in a service mesh.

.
listTagsForResource(params = {}, callback) ⇒ AWS.Request
List the tags for an App Mesh resource.

.
listVirtualGateways(params = {}, callback) ⇒ AWS.Request
Returns a list of existing virtual gateways in a service mesh.

.
listVirtualNodes(params = {}, callback) ⇒ AWS.Request
Returns a list of existing virtual nodes.

.
listVirtualRouters(params = {}, callback) ⇒ AWS.Request
Returns a list of existing virtual routers in a service mesh.

.
listVirtualServices(params = {}, callback) ⇒ AWS.Request
Returns a list of existing virtual services in a service mesh.

.
tagResource(params = {}, callback) ⇒ AWS.Request
Associates the specified tags to a resource with the specified resourceArn.
untagResource(params = {}, callback) ⇒ AWS.Request
Deletes specified tags from a resource.

.
updateGatewayRoute(params = {}, callback) ⇒ AWS.Request
Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh.

.
updateMesh(params = {}, callback) ⇒ AWS.Request
Updates an existing service mesh.

.
updateRoute(params = {}, callback) ⇒ AWS.Request
Updates an existing route for a specified service mesh and virtual router.

.
updateVirtualGateway(params = {}, callback) ⇒ AWS.Request
Updates an existing virtual gateway in a specified service mesh.

.
updateVirtualNode(params = {}, callback) ⇒ AWS.Request
Updates an existing virtual node in a specified service mesh.

.
updateVirtualRouter(params = {}, callback) ⇒ AWS.Request
Updates an existing virtual router in a specified service mesh.

.
updateVirtualService(params = {}, callback) ⇒ AWS.Request
Updates an existing virtual service in a specified service mesh.

.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.AppMesh(options = {}) ⇒ `Object`

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a AppMesh object

var appmesh = new AWS.AppMesh({apiVersion: '2019-01-25'});

Options Hash (options):

params (map) —
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
endpoint (String|AWS.Endpoint) —
The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.
accessKeyId (String) —
your AWS access key ID.
secretAccessKey (String) —
your AWS secret access key.
sessionToken (AWS.Credentials) —
the optional AWS session token to sign requests with.
credentials (AWS.Credentials) —
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
credentialProvider (AWS.CredentialProviderChain) —
the provider chain used to resolve credentials if no static credentials property is set.
region (String) —
the region to send service requests to. See AWS.AppMesh.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.AppMesh.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.AppMesh.maxRedirects for more information.
sslEnabled (Boolean) —
whether to enable SSL for requests.
paramValidation (Boolean|map) —
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
- max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
computeChecksums (Boolean) —
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
convertResponseTypes (Boolean) —
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.
correctClockSkew (Boolean) —
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.
s3ForcePathStyle (Boolean) —
whether to force path style URLs for S3 objects.
s3BucketEndpoint (Boolean) —
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.
s3DisableBodySigning (Boolean) —
whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.
s3UsEast1RegionalEndpoint ('legacy'|'regional') —
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy
s3UseArnRegion (Boolean) —
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true
retryDelayOptions (map) —
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
httpOptions (map) —
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
- connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
- timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
apiVersion (String, Date) —
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.
apiVersions (map<String, String|Date>) —
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
logger (#write, #log) —
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
systemClockOffset (Number) —
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.
signatureVersion (String) —
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
signatureCache (Boolean) —
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.
dynamoDbCrc32 (Boolean) —
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.
useAccelerateEndpoint (Boolean) —
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.
clientSideMonitoring (Boolean) —
whether to collect and publish this client's performance metrics of all its API requests.
endpointDiscoveryEnabled (Boolean|undefined) —
whether to call operations with endpoints given by service dynamically. Setting this
endpointCacheSize (Number) —
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
hostPrefixEnabled (Boolean) —
whether to marshal request parameters to the prefix of hostname. Defaults to true.
stsRegionalEndpoints ('legacy'|'regional') —
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ `AWS.Endpoint` (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

(AWS.Endpoint) —
an Endpoint object representing the endpoint URL for service requests.

Method Details

createGatewayRoute(params = {}, callback) ⇒ `AWS.Request`

Creates a gateway route.

A gateway route is attached to a virtual gateway and routes traffic to an existing virtual service. If a route matches a request, it can distribute traffic to a target virtual service.

For more information about gateway routes, see Gateway routes.

Service Reference:

CreateGatewayRoute

Examples:

Calling the createGatewayRoute operation

var params = {
  gatewayRouteName: 'STRING_VALUE', /* required */
  meshName: 'STRING_VALUE', /* required */
  spec: { /* required */
    grpcRoute: {
      action: { /* required */
        target: { /* required */
          virtualService: { /* required */
            virtualServiceName: 'STRING_VALUE' /* required */
          }
        },
        rewrite: {
          hostname: {
            defaultTargetHostname: ENABLED | DISABLED
          }
        }
      },
      match: { /* required */
        hostname: {
          exact: 'STRING_VALUE',
          suffix: 'STRING_VALUE'
        },
        metadata: [
          {
            name: 'STRING_VALUE', /* required */
            invert: true || false,
            match: {
              exact: 'STRING_VALUE',
              prefix: 'STRING_VALUE',
              range: {
                end: 'NUMBER_VALUE', /* required */
                start: 'NUMBER_VALUE' /* required */
              },
              regex: 'STRING_VALUE',
              suffix: 'STRING_VALUE'
            }
          },
          /* more items */
        ],
        serviceName: 'STRING_VALUE'
      }
    },
    http2Route: {
      action: { /* required */
        target: { /* required */
          virtualService: { /* required */
            virtualServiceName: 'STRING_VALUE' /* required */
          }
        },
        rewrite: {
          hostname: {
            defaultTargetHostname: ENABLED | DISABLED
          },
          path: {
            exact: 'STRING_VALUE'
          },
          prefix: {
            defaultPrefix: ENABLED | DISABLED,
            value: 'STRING_VALUE'
          }
        }
      },
      match: { /* required */
        headers: [
          {
            name: 'STRING_VALUE', /* required */
            invert: true || false,
            match: {
              exact: 'STRING_VALUE',
              prefix: 'STRING_VALUE',
              range: {
                end: 'NUMBER_VALUE', /* required */
                start: 'NUMBER_VALUE' /* required */
              },
              regex: 'STRING_VALUE',
              suffix: 'STRING_VALUE'
            }
          },
          /* more items */
        ],
        hostname: {
          exact: 'STRING_VALUE',
          suffix: 'STRING_VALUE'
        },
        method: GET | HEAD | POST | PUT | DELETE | CONNECT | OPTIONS | TRACE | PATCH,
        path: {
          exact: 'STRING_VALUE',
          regex: 'STRING_VALUE'
        },
        prefix: 'STRING_VALUE',
        queryParameters: [
          {
            name: 'STRING_VALUE', /* required */
            match: {
              exact: 'STRING_VALUE'
            }
          },
          /* more items */
        ]
      }
    },
    httpRoute: {
      action: { /* required */
        target: { /* required */
          virtualService: { /* required */
            virtualServiceName: 'STRING_VALUE' /* required */
          }
        },
        rewrite: {
          hostname: {
            defaultTargetHostname: ENABLED | DISABLED
          },
          path: {
            exact: 'STRING_VALUE'
          },
          prefix: {
            defaultPrefix: ENABLED | DISABLED,
            value: 'STRING_VALUE'
          }
        }
      },
      match: { /* required */
        headers: [
          {
            name: 'STRING_VALUE', /* required */
            invert: true || false,
            match: {
              exact: 'STRING_VALUE',
              prefix: 'STRING_VALUE',
              range: {
                end: 'NUMBER_VALUE', /* required */
                start: 'NUMBER_VALUE' /* required */
              },
              regex: 'STRING_VALUE',
              suffix: 'STRING_VALUE'
            }
          },
          /* more items */
        ],
        hostname: {
          exact: 'STRING_VALUE',
          suffix: 'STRING_VALUE'
        },
        method: GET | HEAD | POST | PUT | DELETE | CONNECT | OPTIONS | TRACE | PATCH,
        path: {
          exact: 'STRING_VALUE',
          regex: 'STRING_VALUE'
        },
        prefix: 'STRING_VALUE',
        queryParameters: [
          {
            name: 'STRING_VALUE', /* required */
            match: {
              exact: 'STRING_VALUE'
            }
          },
          /* more items */
        ]
      }
    },
    priority: 'NUMBER_VALUE'
  },
  virtualGatewayName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  meshOwner: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
appmesh.createGatewayRoute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- clientToken — (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.
  If a token is not provided, the SDK will use a version 4 UUID.
- gatewayRouteName — (String)
  The name to use for the gateway route.
- meshName — (String)
  The name of the service mesh to create the gateway route in.
- meshOwner — (String)
  The AWS 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.
- spec — (map)
  The gateway route specification to apply.
  - grpcRoute — (map)
    An object that represents the specification of a gRPC gateway route.
    - action — required — (map)
      An object that represents the action to take if a match is determined.
      
      rewrite — (map)
      The gateway route action to rewrite.
      
      hostname — (map)
      The host name of the gateway route to rewrite.
      
      defaultTargetHostname — (String)
      The default target host name to write to.
      Possible values include:
      
      "ENABLED"
      
      "DISABLED"
      
      target — required — (map)
      An object that represents the target that traffic is routed to when a request matches the gateway route.
      
      virtualService — required — (map)
      An object that represents a virtual service gateway route target.
      
      virtualServiceName — required — (String)
      The name of the virtual service that traffic is routed to.
    - match — required — (map)
      An object that represents the criteria for determining a request match.
      
      hostname — (map)
      The gateway route host name to be matched on.
      
      exact — (String)
      The exact host name to match on.
      
      suffix — (String)
      The specified ending characters of the host name to match on.
      
      metadata — (Array<map>)
      The gateway route metadata to be matched on.
      
      invert — (Boolean)
      Specify True to match anything except the match criteria. The default value is False.
      
      match — (map)
      The criteria for determining a metadata match.
      
      exact — (String)
      The exact method header to be matched on.
      
      prefix — (String)
      The specified beginning characters of the method header to be matched on.
      
      range — (map)
      An object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.
      
      end — required — (Integer)
      The end of the range.
      
      start — required — (Integer)
      The start of the range.
      
      regex — (String)
      The regex used to match the method header.
      
      suffix — (String)
      The specified ending characters of the method header to match on.
      
      name — required — (String)
      A name for the gateway route metadata.
      
      serviceName — (String)
      The fully qualified domain name for the service to match from the request.
  - http2Route — (map)
    An object that represents the specification of an HTTP/2 gateway route.
    - action — required — (map)
      An object that represents the action to take if a match is determined.
      
      rewrite — (map)
      The gateway route action to rewrite.
      
      hostname — (map)
      The host name to rewrite.
      
      defaultTargetHostname — (String)
      The default target host name to write to.
      Possible values include:
      
      "ENABLED"
      
      "DISABLED"
      
      path — (map)
      The path to rewrite.
      
      exact — (String)
      The exact path to rewrite.
      
      prefix — (map)
      The specified beginning characters to rewrite.
      
      defaultPrefix — (String)
      The default prefix used to replace the incoming route prefix when rewritten.
      Possible values include:
      
      "ENABLED"
      
      "DISABLED"
      
      value — (String)
      The value used to replace the incoming route prefix when rewritten.
      
      target — required — (map)
      An object that represents the target that traffic is routed to when a request matches the gateway route.
      
      virtualService — required — (map)
      An object that represents a virtual service gateway route target.
      
      virtualServiceName — required — (String)
      The name of the virtual service that traffic is routed to.
    - match — required — (map)
      An object that represents the criteria for determining a request match.
      
      headers — (Array<map>)
      The client request headers to match on.
      
      invert — (Boolean)
      Specify True to match anything except the match criteria. The default value is False.
      
      match — (map)
      An object that represents the method and value to match with the header value sent in a request. Specify one match method.
      
      exact — (String)
      The value sent by the client must match the specified value exactly.
      
      prefix — (String)
      The value sent by the client must begin with the specified characters.
      
      range — (map)
      An object that represents the range of values to match on.
      
      end — required — (Integer)
      The end of the range.
      
      start — required — (Integer)
      The start of the range.
      
      regex — (String)
      The value sent by the client must include the specified characters.
      
      suffix — (String)
      The value sent by the client must end with the specified characters.
      
      name — required — (String)
      A name for the HTTP header in the gateway route that will be matched on.
      
      hostname — (map)
      The host name to match on.
      
      exact — (String)
      The exact host name to match on.
      
      suffix — (String)
      The specified ending characters of the host name to match on.
      
      method — (String)
      The method to match on.
      Possible values include:
      
      "GET"
      
      "HEAD"
      
      "POST"
      
      "PUT"
      
      "DELETE"
      
      "CONNECT"
      
      "OPTIONS"
      
      "TRACE"
      
      "PATCH"
      
      path — (map)
      The path to match on.
      
      exact — (String)
      The exact path to match on.
      
      regex — (String)
      The regex used to match the path.
      
      prefix — (String)
      Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.
      
      queryParameters — (Array<map>)
      The query parameter to match on.
      
      match — (map)
      The query parameter to match on.
      
      exact — (String)
      The exact query parameter to match on.
      
      name — required — (String)
      A name for the query parameter that will be matched on.
  - httpRoute — (map)
    An object that represents the specification of an HTTP gateway route.
    - action — required — (map)
      An object that represents the action to take if a match is determined.
      
      rewrite — (map)
      The gateway route action to rewrite.
      
      hostname — (map)
      The host name to rewrite.
      
      defaultTargetHostname — (String)
      The default target host name to write to.
      Possible values include:
      
      "ENABLED"
      
      "DISABLED"
      
      path — (map)
      The path to rewrite.
      
      exact — (String)
      The exact path to rewrite.
      
      prefix — (map)
      The specified beginning characters to rewrite.
      
      defaultPrefix — (String)
      The default prefix used to replace the incoming route prefix when rewritten.
      Possible values include:
      
      "ENABLED"
      
      "DISABLED"
      
      value — (String)
      The value used to replace the incoming route prefix when rewritten.
      
      target — required — (map)
      An object that represents the target that traffic is routed to when a request matches the gateway route.
      
      virtualService — required — (map)
      An object that represents a virtual service gateway route target.
      
      virtualServiceName — required — (String)
      The name of the virtual service that traffic is routed to.
    - match — required — (map)
      An object that represents the criteria for determining a request match.
      
      headers — (Array<map>)
      The client request headers to match on.
      
      invert — (Boolean)
      Specify True to match anything except the match criteria. The default value is False.
      
      match — (map)
      An object that represents the method and value to match with the header value sent in a request. Specify one match method.
      
      exact — (String)
      The value sent by the client must match the specified value exactly.
      
      prefix — (String)
      The value sent by the client must begin with the specified characters.
      
      range — (map)
      An object that represents the range of values to match on.
      
      end — required — (Integer)
      The end of the range.
      
      start — required — (Integer)
      The start of the range.
      
      regex — (String)
      The value sent by the client must include the specified characters.
      
      suffix — (String)
      The value sent by the client must end with the specified characters.
      
      name — required — (String)
      A name for the HTTP header in the gateway route that will be matched on.
      
      hostname — (map)
      The host name to match on.
      
      exact — (String)
      The exact host name to match on.
      
      suffix — (String)
      The specified ending characters of the host name to match on.
      
      method — (String)
      The method to match on.
      Possible values include:
      
      "GET"
      
      "HEAD"
      
      "POST"
      
      "PUT"
      
      "DELETE"
      
      "CONNECT"
      
      "OPTIONS"
      
      "TRACE"
      
      "PATCH"
      
      path — (map)
      The path to match on.
      
      exact — (String)
      The exact path to match on.
      
      regex — (String)
      The regex used to match the path.
      
      prefix — (String)
      Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.
      
      queryParameters — (Array<map>)
      The query parameter to match on.
      
      match — (map)
      The query parameter to match on.
      
      exact — (String)
      The exact query parameter to match on.
      
      name — required — (String)
      A name for the query parameter that will be matched on.
  - priority — (Integer)
    The ordering of the gateway routes spec.
- tags — (Array<map>)
  Optional metadata that you can apply to the gateway route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
  - key — required — (String)
    One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
  - value — required — (String)
    The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
- virtualGatewayName — (String)
  The name of the virtual gateway to associate the gateway route with. If the virtual gateway is in a shared mesh, then you must be the owner of the virtual gateway resource.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - gatewayRoute — (map)
    The full description of your gateway route following the create call.
    
    gatewayRouteName — required — (String)
    The name of the gateway route.
    
    meshName — required — (String)
    The name of the service mesh that the resource resides in.
    
    metadata — required — (map)
    An object that represents metadata for a resource.
    
    arn — required — (String)
    The full Amazon Resource Name (ARN) for the resource.
    
    createdAt — required — (Date)
    The Unix epoch timestamp in seconds for when the resource was created.
    
    lastUpdatedAt — required — (Date)
    The Unix epoch timestamp in seconds for when the resource was last updated.
    
    meshOwner — required — (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 — required — (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 — required — (String)
    The unique identifier for the resource.
    
    version — required — (Integer)
    The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
    
    spec — required — (map)
    The specifications of the gateway route.
    
    grpcRoute — (map)
    An object that represents the specification of a gRPC gateway route.
    
    action — required — (map)
    An object that represents the action to take if a match is determined.
    
    rewrite — (map)
    The gateway route action to rewrite.
    
    hostname — (map)
    The host name of the gateway route to rewrite.
    
    defaultTargetHostname — (String)
    The default target host name to write to.
    Possible values include:
    
    "ENABLED"
    
    "DISABLED"
    
    target — required — (map)
    An object that represents the target that traffic is routed to when a request matches the gateway route.
    
    virtualService — required — (map)
    An object that represents a virtual service gateway route target.
    
    virtualServiceName — required — (String)
    The name of the virtual service that traffic is routed to.
    
    match — required — (map)
    An object that represents the criteria for determining a request match.
    
    hostname — (map)
    The gateway route host name to be matched on.
    
    exact — (String)
    The exact host name to match on.
    
    suffix — (String)
    The specified ending characters of the host name to match on.
    
    metadata — (Array<map>)
    The gateway route metadata to be matched on.
    
    invert — (Boolean)
    Specify True to match anything except the match criteria. The default value is False.
    
    match — (map)
    The criteria for determining a metadata match.
    
    exact — (String)
    The exact method header to be matched on.
    
    prefix — (String)
    The specified beginning characters of the method header to be matched on.
    
    range — (map)
    An object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.
    
    end — required — (Integer)
    The end of the range.
    
    start — required — (Integer)
    The start of the range.
    
    regex — (String)
    The regex used to match the method header.
    
    suffix — (String)
    The specified ending characters of the method header to match on.
    
    name — required — (String)
    A name for the gateway route metadata.
    
    serviceName — (String)
    The fully qualified domain name for the service to match from the request.
    
    http2Route — (map)
    An object that represents the specification of an HTTP/2 gateway route.
    
    action — required — (map)
    An object that represents the action to take if a match is determined.
    
    rewrite — (map)
    The gateway route action to rewrite.
    
    hostname — (map)
    The host name to rewrite.
    
    defaultTargetHostname — (String)
    The default target host name to write to.
    Possible values include:
    
    "ENABLED"
    
    "DISABLED"
    
    path — (map)
    The path to rewrite.
    
    exact — (String)
    The exact path to rewrite.
    
    prefix — (map)
    The specified beginning characters to rewrite.
    
    defaultPrefix — (String)
    The default prefix used to replace the incoming route prefix when rewritten.
    Possible values include:
    
    "ENABLED"
    
    "DISABLED"
    
    value — (String)
    The value used to replace the incoming route prefix when rewritten.
    
    target — required — (map)
    An object that represents the target that traffic is routed to when a request matches the gateway route.
    
    virtualService — required — (map)
    An object that represents a virtual service gateway route target.
    
    virtualServiceName — required — (String)
    The name of the virtual service that traffic is routed to.
    
    match — required — (map)
    An object that represents the criteria for determining a request match.
    
    headers — (Array<map>)
    The client request headers to match on.
    
    invert — (Boolean)
    Specify True to match anything except the match criteria. The default value is False.
    
    match — (map)
    An object that represents the method and value to match with the header value sent in a request. Specify one match method.
    
    exact — (String)
    The value sent by the client must match the specified value exactly.
    
    prefix — (String)
    The value sent by the client must begin with the specified characters.
    
    range — (map)
    An object that represents the range of values to match on.
    
    end — required — (Integer)
    The end of the range.
    
    start — required — (Integer)
    The start of the range.
    
    regex — (String)
    The value sent by the client must include the specified characters.
    
    suffix — (String)
    The value sent by the client must end with the specified characters.
    
    name — required — (String)
    A name for the HTTP header in the gateway route that will be matched on.
    
    hostname — (map)
    The host name to match on.
    
    exact — (String)
    The exact host name to match on.
    
    suffix — (String)
    The specified ending characters of the host name to match on.
    
    method — (String)
    The method to match on.
    Possible values include:
    
    "GET"
    
    "HEAD"
    
    "POST"
    
    "PUT"
    
    "DELETE"
    
    "CONNECT"
    
    "OPTIONS"
    
    "TRACE"
    
    "PATCH"
    
    path — (map)
    The path to match on.
    
    exact — (String)
    The exact path to match on.
    
    regex — (String)
    The regex used to match the path.
    
    prefix — (String)
    Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.
    
    queryParameters — (Array<map>)
    The query parameter to match on.
    
    match — (map)
    The query parameter to match on.
    
    exact — (String)
    The exact query parameter to match on.
    
    name — required — (String)
    A name for the query parameter that will be matched on.
    
    httpRoute — (map)
    An object that represents the specification of an HTTP gateway route.
    
    action — required — (map)
    An object that represents the action to take if a match is determined.
    
    rewrite — (map)
    The gateway route action to rewrite.
    
    hostname — (map)
    The host name to rewrite.
    
    defaultTargetHostname — (String)
    The default target host name to write to.
    Possible values include:
    
    "ENABLED"
    
    "DISABLED"
    
    path — (map)
    The path to rewrite.
    
    exact — (String)
    The exact path to rewrite.
    
    prefix — (map)
    The specified beginning characters to rewrite.
    
    defaultPrefix — (String)
    The default prefix used to replace the incoming route prefix when rewritten.
    Possible values include:
    
    "ENABLED"
    
    "DISABLED"
    
    value — (String)
    The value used to replace the incoming route prefix when rewritten.
    
    target — required — (map)
    An object that represents the target that traffic is routed to when a request matches the gateway route.
    
    virtualService — required — (map)
    An object that represents a virtual service gateway route target.
    
    virtualServiceName — required — (String)
    The name of the virtual service that traffic is routed to.
    
    match — required — (map)
    An object that represents the criteria for determining a request match.
    
    headers — (Array<map>)
    The client request headers to match on.
    
    invert — (Boolean)
    Specify True to match anything except the match criteria. The default value is False.
    
    match — (map)
    An object that represents the method and value to match with the header value sent in a request. Specify one match method.
    
    exact — (String)
    The value sent by the client must match the specified value exactly.
    
    prefix — (String)
    The value sent by the client must begin with the specified characters.
    
    range — (map)
    An object that represents the range of values to match on.
    
    end — required — (Integer)
    The end of the range.
    
    start — required — (Integer)
    The start of the range.
    
    regex — (String)
    The value sent by the client must include the specified characters.
    
    suffix — (String)
    The value sent by the client must end with the specified characters.
    
    name — required — (String)
    A name for the HTTP header in the gateway route that will be matched on.
    
    hostname — (map)
    The host name to match on.
    
    exact — (String)
    The exact host name to match on.
    
    suffix — (String)
    The specified ending characters of the host name to match on.
    
    method — (String)
    The method to match on.
    Possible values include:
    
    "GET"
    
    "HEAD"
    
    "POST"
    
    "PUT"
    
    "DELETE"
    
    "CONNECT"
    
    "OPTIONS"
    
    "TRACE"
    
    "PATCH"
    
    path — (map)
    The path to match on.
    
    exact — (String)
    The exact path to match on.
    
    regex — (String)
    The regex used to match the path.
    
    prefix — (String)
    Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.
    
    queryParameters — (Array<map>)
    The query parameter to match on.
    
    match — (map)
    The query parameter to match on.
    
    exact — (String)
    The exact query parameter to match on.
    
    name — required — (String)
    A name for the query parameter that will be matched on.
    
    priority — (Integer)
    The ordering of the gateway routes spec.
    
    status — required — (map)
    The status of the gateway route.
    
    status — required — (String)
    The current status for the gateway route.
    Possible values include:
    
    "ACTIVE"
    
    "INACTIVE"
    
    "DELETED"
    
    virtualGatewayName — required — (String)
    The virtual gateway that the gateway route is associated with.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

createMesh(params = {}, callback) ⇒ `AWS.Request`

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.

Service Reference:

CreateMesh

Examples:

Calling the createMesh operation

var params = {
  meshName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  spec: {
    egressFilter: {
      type: ALLOW_ALL | DROP_ALL /* required */
    }
  },
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
appmesh.createMesh(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- clientToken — (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.
  If a token is not provided, the SDK will use a version 4 UUID.
- meshName — (String)
  The name to use for the service mesh.
- spec — (map)
  The service mesh specification to apply.
  - egressFilter — (map)
    The egress filter rules for the service mesh.
    - type — required — (String)
      The egress filter type. By default, the type is DROP_ALL, which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to *.amazonaws.com for Amazon Web Services API calls). You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh.
      Possible values include:
      
      "ALLOW_ALL"
      
      "DROP_ALL"
- tags — (Array<map>)
  Optional metadata that you can apply to the service mesh to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
  - key — required — (String)
    One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
  - value — required — (String)
    The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - mesh — (map)
    The full description of your service mesh following the create call.
    
    meshName — required — (String)
    The name of the service mesh.
    
    metadata — required — (map)
    The associated metadata for the service mesh.
    
    arn — required — (String)
    The full Amazon Resource Name (ARN) for the resource.
    
    createdAt — required — (Date)
    The Unix epoch timestamp in seconds for when the resource was created.
    
    lastUpdatedAt — required — (Date)
    The Unix epoch timestamp in seconds for when the resource was last updated.
    
    meshOwner — required — (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 — required — (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 — required — (String)
    The unique identifier for the resource.
    
    version — required — (Integer)
    The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
    
    spec — required — (map)
    The associated specification for the service mesh.
    
    egressFilter — (map)
    The egress filter rules for the service mesh.
    
    type — required — (String)
    The egress filter type. By default, the type is DROP_ALL, which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to *.amazonaws.com for Amazon Web Services API calls). You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh.
    Possible values include:
    
    "ALLOW_ALL"
    
    "DROP_ALL"
    
    status — required — (map)
    The status of the service mesh.
    
    status — (String)
    The current mesh status.
    Possible values include:
    
    "ACTIVE"
    
    "INACTIVE"
    
    "DELETED"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

createRoute(params = {}, callback) ⇒ `AWS.Request`

Creates a route that is associated with a virtual router.

You can route several different protocols and define a retry policy for a route. Traffic can be routed to one or more virtual nodes.

For more information about routes, see Routes.

Service Reference:

CreateRoute

Examples:

Calling the createRoute operation

var params = {
  meshName: 'STRING_VALUE', /* required */
  routeName: 'STRING_VALUE', /* required */
  spec: { /* required */
    grpcRoute: {
      action: { /* required */
        weightedTargets: [ /* required */
          {
            virtualNode: 'STRING_VALUE', /* required */
            weight: 'NUMBER_VALUE' /* required */
          },
          /* more items */
        ]
      },
      match: { /* required */
        metadata: [
          {
            name: 'STRING_VALUE', /* required */
            invert: true || false,
            match: {
              exact: 'STRING_VALUE',
              prefix: 'STRING_VALUE',
              range: {
                end: 'NUMBER_VALUE', /* required */
                start: 'NUMBER_VALUE' /* required */
              },
              regex: 'STRING_VALUE',
              suffix: 'STRING_VALUE'
            }
          },
          /* more items */
        ],
        methodName: 'STRING_VALUE',
        serviceName: 'STRING_VALUE'
      },
      retryPolicy: {
        maxRetries: 'NUMBER_VALUE', /* required */
        perRetryTimeout: { /* required */
          unit: s | ms,
          value: 'NUMBER_VALUE'
        },
        grpcRetryEvents: [
          cancelled | deadline-exceeded | internal | resource-exhausted | unavailable,
          /* more items */
        ],
        httpRetryEvents: [
          'STRING_VALUE',
          /* more items */
        ],
        tcpRetryEvents: [
          connection-error,
          /* more items */
        ]
      },
      timeout: {
        idle: {
          unit: s | ms,
          value: 'NUMBER_VALUE'
        },
        perRequest: {
          unit: s | ms,
          value: 'NUMBER_VALUE'
        }
      }
    },
    http2Route: {
      action: { /* required */
        weightedTargets: [ /* required */
          {
            virtualNode: 'STRING_VALUE', /* required */
            weight: 'NUMBER_VALUE' /* required */
          },
          /* more items */
        ]
      },
      match: { /* required */
        headers: [
          {
            name: 'STRING_VALUE', /* required */
            invert: true || false,
            match: {
              exact: 'STRING_VALUE',
              prefix: 'STRING_VALUE',
              range: {
                end: 'NUMBER_VALUE', /* required */
                start: 'NUMBER_VALUE' /* required */
              },
              regex: 'STRING_VALUE',
              suffix: 'STRING_VALUE'
            }
          },
          /* more items */
        ],
        method: GET | HEAD | POST | PUT | DELETE | CONNECT | OPTIONS | TRACE | PATCH,
        path: {
          exact: 'STRING_VALUE',
          regex: 'STRING_VALUE'
        },
        prefix: 'STRING_VALUE',
        queryParameters: [
          {
            name: 'STRING_VALUE', /* required */
            match: {
              exact: 'STRING_VALUE'
            }
          },
          /* more items */
        ],
        scheme: http | https
      },
      retryPolicy: {
        maxRetries: 'NUMBER_VALUE', /* required */
        perRetryTimeout: { /* required */
          unit: s | ms,
          value: 'NUMBER_VALUE'
        },
        httpRetryEvents: [
          'STRING_VALUE',
          /* more items */
        ],
        tcpRetryEvents: [
          connection-error,
          /* more items */
        ]
      },
      timeout: {
        idle: {
          unit: s | ms,
          value: 'NUMBER_VALUE'
        },
        perRequest: {
          unit: s | ms,
          value: 'NUMBER_VALUE'
        }
      }
    },
    httpRoute: {
      action: { /* required */
        weightedTargets: [ /* required */
          {
            virtualNode: 'STRING_VALUE', /* required */
            weight: 'NUMBER_VALUE' /* required */
          },
          /* more items */
        ]
      },
      match: { /* required */
        headers: [
          {
            name: 'STRING_VALUE', /* required */
            invert: true || false,
            match: {
              exact: 'STRING_VALUE',
              prefix: 'STRING_VALUE',
              range: {
                end: 'NUMBER_VALUE', /* required */
                start: 'NUMBER_VALUE' /* required */
              },
              regex: 'STRING_VALUE',
              suffix: 'STRING_VALUE'
            }
          },
          /* more items */
        ],
        method: GET | HEAD | POST | PUT | DELETE | CONNECT | OPTIONS | TRACE | PATCH,
        path: {
          exact: 'STRING_VALUE',
          regex: 'STRING_VALUE'
        },
        prefix: 'STRING_VALUE',
        queryParameters: [
          {
            name: 'STRING_VALUE', /* required */
            match: {
              exact: 'STRING_VALUE'
            }
          },
          /* more items */
        ],
        scheme: http | https
      },
      retryPolicy: {
        maxRetries: 'NUMBER_VALUE', /* required */
        perRetryTimeout: { /* required */
          unit: s | ms,
          value: 'NUMBER_VALUE'
        },
        httpRetryEvents: [
          'STRING_VALUE',
          /* more items */
        ],
        tcpRetryEvents: [
          connection-error,
          /* more items */
        ]
      },
      timeout: {
        idle: {
          unit: s | ms,
          value: 'NUMBER_VALUE'
        },
        perRequest: {
          unit: s | ms,
          value: 'NUMBER_VALUE'
        }
      }
    },
    priority: 'NUMBER_VALUE',
    tcpRoute: {
      action: { /* required */
        weightedTargets: [ /* required */
          {
            virtualNode: 'STRING_VALUE', /* required */
            weight: 'NUMBER_VALUE' /* required */
          },
          /* more items */
        ]
      },
      timeout: {
        idle: {
          unit: s | ms,
          value: 'NUMBER_VALUE'
        }
      }
    }
  },
  virtualRouterName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  meshOwner: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
appmesh.createRoute(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- clientToken — (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.
  If a token is not provided, the SDK will use a version 4 UUID.
- meshName — (String)
  The name of the service mesh to create the route in.
- meshOwner — (String)
  The AWS 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.
- routeName — (String)
  The name to use for the route.
- spec — (map)
  The route specification to apply.
  - grpcRoute — (map)
    An object that represents the specification of a gRPC route.
    - action — required — (map)
      An object that represents the action to take if a match is determined.
      
      weightedTargets — required — (Array<map>)
      An object that represents the targets that traffic is routed to when a request matches the route.
      
      virtualNode — required — (String)
      The virtual node to associate with the weighted target.
      
      weight — required — (Integer)
      The relative weight of the weighted target.
    - match — required — (map)
      An object that represents the criteria for determining a request match.
      
      metadata — (Array<map>)
      An object that represents the data to match from the request.
      
      invert — (Boolean)
      Specify True to match anything except the match criteria. The default value is False.
      
      match — (map)
      An object that represents the data to match from the request.
      
      exact — (String)
      The value sent by the client must match the specified value exactly.
      
      prefix — (String)
      The value sent by the client must begin with the specified characters.
      
      range — (map)
      An object that represents the range of values to match on.
      
      end — required — (Integer)
      The end of the range.
      
      start — required — (Integer)
      The start of the range.
      
      regex — (String)
      The value sent by the client must include the specified characters.
      
      suffix — (String)
      The value sent by the client must end with the specified characters.
      
      name — required — (String)
      The name of the route.
      
      methodName — (String)
      The method name to match from the request. If you specify a name, you must also specify a serviceName.
      
      serviceName — (String)
      The fully qualified domain name for the service to match from the request.
    - retryPolicy — (map)
      An object that represents a retry policy.
      
      grpcRetryEvents — (Array<String>)
      Specify at least one of the valid values.
      
      httpRetryEvents — (Array<String>)
      Specify at least one of the following values.
      
      server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
      
      gateway-error – HTTP status codes 502, 503, and 504
      
      client-error – HTTP status code 409
      
      stream-error – Retry on refused stream
      
      maxRetries — required — (Integer)
      The maximum number of retry attempts.
      
      perRetryTimeout — required — (map)
      The timeout for each retry attempt.
      
      unit — (String)
      A unit of time.
      Possible values include:
      
      "s"
      
      "ms"
      
      value — (Integer)
      A number of time units.
      
      tcpRetryEvents — (Array<String>)
      Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
    - timeout — (map)
      An object that represents types of timeouts.
      
      idle — (map)
      An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
      
      unit — (String)
      A unit of time.
      Possible values include:
      
      "s"
      
      "ms"
      
      value — (Integer)
      A number of time units.
      
      perRequest — (map)
      An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
      
      unit — (String)
      A unit of time.
      Possible values include:
      
      "s"
      
      "ms"
      
      value — (Integer)
      A number of time units.
  - http2Route — (map)
    An object that represents the specification of an HTTP/2 route.
    - action — required — (map)
      An object that represents the action to take if a match is determined.
      
      weightedTargets — required — (Array<map>)
      An object that represents the targets that traffic is routed to when a request matches the route.
      
      virtualNode — required — (String)
      The virtual node to associate with the weighted target.
      
      weight — required — (Integer)
      The relative weight of the weighted target.
    - match — required — (map)
      An object that represents the criteria for determining a request match.
      
      headers — (Array<map>)
      The client request headers to match on.
      
      invert — (Boolean)
      Specify True to match anything except the match criteria. The default value is False.
      
      match — (map)
      The HeaderMatchMethod object.
      
      exact — (String)
      The value sent by the client must match the specified value exactly.
      
      prefix — (String)
      The value sent by the client must begin with the specified characters.
      
      range — (map)
      An object that represents the range of values to match on.
      
      end — required — (Integer)
      The end of the range.
      
      start — required — (Integer)
      The start of the range.
      
      regex — (String)
      The value sent by the client must include the specified characters.
      
      suffix — (String)
      The value sent by the client must end with the specified characters.
      
      name — required — (String)
      A name for the HTTP header in the client request that will be matched on.
      
      method — (String)
      The client request method to match on. Specify only one.
      Possible values include:
      
      "GET"
      
      "HEAD"
      
      "POST"
      
      "PUT"
      
      "DELETE"
      
      "CONNECT"
      
      "OPTIONS"
      
      "TRACE"
      
      "PATCH"
      
      path — (map)
      The client request path to match on.
      
      exact — (String)
      The exact path to match on.
      
      regex — (String)
      The regex used to match the path.
      
      prefix — (String)
      Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.
      
      queryParameters — (Array<map>)
      The client request query parameters to match on.
      
      match — (map)
      The query parameter to match on.
      
      exact — (String)
      The exact query parameter to match on.
      
      name — required — (String)
      A name for the query parameter that will be matched on.
      
      scheme — (String)
      The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
      Possible values include:
      
      "http"
      
      "https"
    - retryPolicy — (map)
      An object that represents a retry policy.
      
      httpRetryEvents — (Array<String>)
      Specify at least one of the following values.
      
      server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
      
      gateway-error – HTTP status codes 502, 503, and 504
      
      client-error – HTTP status code 409
      
      stream-error – Retry on refused stream
      
      maxRetries — required — (Integer)
      The maximum number of retry attempts.
      
      perRetryTimeout — required — (map)
      The timeout for each retry attempt.
      
      unit — (String)
      A unit of time.
      Possible values include:
      
      "s"
      
      "ms"
      
      value — (Integer)
      A number of time units.
      
      tcpRetryEvents — (Array<String>)
      Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
    - timeout — (map)
      An object that represents types of timeouts.
      
      idle — (map)
      An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
      
      unit — (String)
      A unit of time.
      Possible values include:
      
      "s"
      
      "ms"
      
      value — (Integer)
      A number of time units.
      
      perRequest — (map)
      An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
      
      unit — (String)
      A unit of time.
      Possible values include:
      
      "s"
      
      "ms"
      
      value — (Integer)
      A number of time units.
  - httpRoute — (map)
    An object that represents the specification of an HTTP route.
    - action — required — (map)
      An object that represents the action to take if a match is determined.
      
      weightedTargets — required — (Array<map>)
      An object that represents the targets that traffic is routed to when a request matches the route.
      
      virtualNode — required — (String)
      The virtual node to associate with the weighted target.
      
      weight — required — (Integer)
      The relative weight of the weighted target.
    - match — required — (map)
      An object that represents the criteria for determining a request match.
      
      headers — (Array<map>)
      The client request headers to match on.
      
      invert — (Boolean)
      Specify True to match anything except the match criteria. The default value is False.
      
      match — (map)
      The HeaderMatchMethod object.
      
      exact — (String)
      The value sent by the client must match the specified value exactly.
      
      prefix — (String)
      The value sent by the client must begin with the specified characters.
      
      range — (map)
      An object that represents the range of values to match on.
      
      end — required — (Integer)
      The end of the range.
      
      start — required — (Integer)
      The start of the range.
      
      regex — (String)
      The value sent by the client must include the specified characters.
      
      suffix — (String)
      The value sent by the client must end with the specified characters.
      
      name — required — (String)
      A name for the HTTP header in the client request that will be matched on.
      
      method — (String)
      The client request method to match on. Specify only one.
      Possible values include:
      
      "GET"
      
      "HEAD"
      
      "POST"
      
      "PUT"
      
      "DELETE"
      
      "CONNECT"
      
      "OPTIONS"
      
      "TRACE"
      
      "PATCH"
      
      path — (map)
      The client request path to match on.
      
      exact — (String)
      The exact path to match on.
      
      regex — (String)
      The regex used to match the path.
      
      prefix — (String)
      Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.
      
      queryParameters — (Array<map>)
      The client request query parameters to match on.
      
      match — (map)
      The query parameter to match on.
      
      exact — (String)
      The exact query parameter to match on.
      
      name — required — (String)
      A name for the query parameter that will be matched on.
      
      scheme — (String)
      The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
      Possible values include:
      
      "http"
      
      "https"
    - retryPolicy — (map)
      An object that represents a retry policy.
      
      httpRetryEvents — (Array<String>)
      Specify at least one of the following values.
      
      server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
      
      gateway-error – HTTP status codes 502, 503, and 504
      
      client-error – HTTP status code 409
      
      stream-error – Retry on refused stream
      
      maxRetries — required — (Integer)
      The maximum number of retry attempts.
      
      perRetryTimeout — required — (map)
      The timeout for each retry attempt.
      
      unit — (String)
      A unit of time.
      Possible values include:
      
      "s"
      
      "ms"
      
      value — (Integer)
      A number of time units.
      
      tcpRetryEvents — (Array<String>)
      Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
    - timeout — (map)
      An object that represents types of timeouts.
      
      idle — (map)
      An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
      
      unit — (String)
      A unit of time.
      Possible values include:
      
      "s"
      
      "ms"
      
      value — (Integer)
      A number of time units.
      
      perRequest — (map)
      An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
      
      unit — (String)
      A unit of time.
      Possible values include:
      
      "s"
      
      "ms"
      
      value — (Integer)
      A number of time units.
  - priority — (Integer)
    The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority.
  - tcpRoute — (map)
    An object that represents the specification of a TCP route.
    - action — required — (map)
      The action to take if a match is determined.
      
      weightedTargets — required — (Array<map>)
      An object that represents the targets that traffic is routed to when a request matches the route.
      
      virtualNode — required — (String)
      The virtual node to associate with the weighted target.
      
      weight — required — (Integer)
      The relative weight of the weighted target.
    - timeout — (map)
      An object that represents types of timeouts.
      
      idle — (map)
      An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
      
      unit — (String)
      A unit of time.
      Possible values include:
      
      "s"
      
      "ms"
      
      value — (Integer)
      A number of time units.
- tags — (Array<map>)
  Optional metadata that you can apply to the route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
  - key — required — (String)
    One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
  - value — required — (String)
    The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
- virtualRouterName — (String)
  The name of the virtual router in which to create the route. If the virtual router is in a shared mesh, then you must be the owner of the virtual router resource.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - route — (map)
    The full description of your mesh following the create call.
    
    meshName — required — (String)
    The name of the service mesh that the route resides in.
    
    metadata — required — (map)
    The associated metadata for the route.
    
    arn — required — (String)
    The full Amazon Resource Name (ARN) for the resource.
    
    createdAt — required — (Date)
    The Unix epoch timestamp in seconds for when the resource was created.
    
    lastUpdatedAt — required — (Date)
    The Unix epoch timestamp in seconds for when the resource was last updated.
    
    meshOwner — required — (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 — required — (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 — required — (String)
    The unique identifier for the resource.
    
    version — required — (Integer)
    The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
    
    routeName — required — (String)
    The name of the route.
    
    spec — required — (map)
    The specifications of the route.
    
    grpcRoute — (map)
    An object that represents the specification of a gRPC route.
    
    action — required — (map)
    An object that represents the action to take if a match is determined.
    
    weightedTargets — required — (Array<map>)
    An object that represents the targets that traffic is routed to when a request matches the route.
    
    virtualNode — required — (String)
    The virtual node to associate with the weighted target.
    
    weight — required — (Integer)
    The relative weight of the weighted target.
    
    match — required — (map)
    An object that represents the criteria for determining a request match.
    
    metadata — (Array<map>)
    An object that represents the data to match from the request.
    
    invert — (Boolean)
    Specify True to match anything except the match criteria. The default value is False.
    
    match — (map)
    An object that represents the data to match from the request.
    
    exact — (String)
    The value sent by the client must match the specified value exactly.
    
    prefix — (String)
    The value sent by the client must begin with the specified characters.
    
    range — (map)
    An object that represents the range of values to match on.
    
    end — required — (Integer)
    The end of the range.
    
    start — required — (Integer)
    The start of the range.
    
    regex — (String)
    The value sent by the client must include the specified characters.
    
    suffix — (String)
    The value sent by the client must end with the specified characters.
    
    name — required — (String)
    The name of the route.
    
    methodName — (String)
    The method name to match from the request. If you specify a name, you must also specify a serviceName.
    
    serviceName — (String)
    The fully qualified domain name for the service to match from the request.
    
    retryPolicy — (map)
    An object that represents a retry policy.
    
    grpcRetryEvents — (Array<String>)
    Specify at least one of the valid values.
    
    httpRetryEvents — (Array<String>)
    Specify at least one of the following values.
    
    server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
    
    gateway-error – HTTP status codes 502, 503, and 504
    
    client-error – HTTP status code 409
    
    stream-error – Retry on refused stream
    
    maxRetries — required — (Integer)
    The maximum number of retry attempts.
    
    perRetryTimeout — required — (map)
    The timeout for each retry attempt.
    
    unit — (String)
    A unit of time.
    Possible values include:
    
    "s"
    
    "ms"
    
    value — (Integer)
    A number of time units.
    
    tcpRetryEvents — (Array<String>)
    Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
    
    timeout — (map)
    An object that represents types of timeouts.
    
    idle — (map)
    An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
    
    unit — (String)
    A unit of time.
    Possible values include:
    
    "s"
    
    "ms"
    
    value — (Integer)
    A number of time units.
    
    perRequest — (map)
    An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
    
    unit — (String)
    A unit of time.
    Possible values include:
    
    "s"
    
    "ms"
    
    value — (Integer)
    A number of time units.
    
    http2Route — (map)
    An object that represents the specification of an HTTP/2 route.
    
    action — required — (map)
    An object that represents the action to take if a match is determined.
    
    weightedTargets — required — (Array<map>)
    An object that represents the targets that traffic is routed to when a request matches the route.
    
    virtualNode — required — (String)
    The virtual node to associate with the weighted target.
    
    weight — required — (Integer)
    The relative weight of the weighted target.
    
    match — required — (map)
    An object that represents the criteria for determining a request match.
    
    headers — (Array<map>)
    The client request headers to match on.
    
    invert — (Boolean)
    Specify True to match anything except the match criteria. The default value is False.
    
    match — (map)
    The HeaderMatchMethod object.
    
    exact — (String)
    The value sent by the client must match the specified value exactly.
    
    prefix — (String)
    The value sent by the client must begin with the specified characters.
    
    range — (map)
    An object that represents the range of values to match on.
    
    end — required — (Integer)
    The end of the range.
    
    start — required — (Integer)
    The start of the range.
    
    regex — (String)
    The value sent by the client must include the specified characters.
    
    suffix — (String)
    The value sent by the client must end with the specified characters.
    
    name — required — (String)
    A name for the HTTP header in the client request that will be matched on.
    
    method — (String)
    The client request method to match on. Specify only one.
    Possible values include:
    
    "GET"
    
    "HEAD"
    
    "POST"
    
    "PUT"
    
    "DELETE"
    
    "CONNECT"
    
    "OPTIONS"
    
    "TRACE"
    
    "PATCH"
    
    path — (map)
    The client request path to match on.
    
    exact — (String)
    The exact path to match on.
    
    regex — (String)
    The regex used to match the path.
    
    prefix — (String)
    Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.
    
    queryParameters — (Array<map>)
    The client request query parameters to match on.
    
    match — (map)
    The query parameter to match on.
    
    exact — (String)
    The exact query parameter to match on.
    
    name — required — (String)
    A name for the query parameter that will be matched on.
    
    scheme — (String)
    The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
    Possible values include:
    
    "http"
    
    "https"
    
    retryPolicy — (map)
    An object that represents a retry policy.
    
    httpRetryEvents — (Array<String>)
    Specify at least one of the following values.
    
    server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
    
    gateway-error – HTTP status codes 502, 503, and 504
    
    client-error – HTTP status code 409
    
    stream-error – Retry on refused stream
    
    maxRetries — required — (Integer)
    The maximum number of retry attempts.
    
    perRetryTimeout — required — (map)
    The timeout for each retry attempt.
    
    unit — (String)
    A unit of time.
    Possible values include:
    
    "s"
    
    "ms"
    
    value — (Integer)
    A number of time units.
    
    tcpRetryEvents — (Array<String>)
    Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
    
    timeout — (map)
    An object that represents types of timeouts.
    
    idle — (map)
    An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
    
    unit — (String)
    A unit of time.
    Possible values include:
    
    "s"
    
    "ms"
    
    value — (Integer)
    A number of time units.
    
    perRequest — (map)
    An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
    
    unit — (String)
    A unit of time.
    Possible values include:
    
    "s"
    
    "ms"
    
    value — (Integer)
    A number of time units.
    
    httpRoute — (map)
    An object that represents the specification of an HTTP route.
    
    action — required — (map)
    An object that represents the action to take if a match is determined.
    
    weightedTargets — required — (Array<map>)
    An object that represents the targets that traffic is routed to when a request matches the route.
    
    virtualNode — required — (String)
    The virtual node to associate with the weighted target.
    
    weight — required — (Integer)
    The relative weight of the weighted target.
    
    match — required — (map)
    An object that represents the criteria for determining a request match.
    
    headers — (Array<map>)
    The client request headers to match on.
    
    invert — (Boolean)
    Specify True to match anything except the match criteria. The default value is False.
    
    match — (map)
    The HeaderMatchMethod object.
    
    exact — (String)
    The value sent by the client must match the specified value exactly.
    
    prefix — (String)
    The value sent by the client must begin with the specified characters.
    
    range — (map)
    An object that represents the range of values to match on.
    
    end — required — (Integer)
    The end of the range.
    
    start — required — (Integer)
    The start of the range.
    
    regex — (String)
    The value sent by the client must include the specified characters.
    
    suffix — (String)
    The value sent by the client must end with the specified characters.
    
    name — required — (String)
    A name for the HTTP header in the client request that will be matched on.
    
    method — (String)
    The client request method to match on. Specify only one.
    Possible values include:
    
    "GET"
    
    "HEAD"
    
    "POST"
    
    "PUT"
    
    "DELETE"
    
    "CONNECT"
    
    "OPTIONS"
    
    "TRACE"
    
    "PATCH"
    
    path — (map)
    The client request path to match on.
    
    exact — (String)
    The exact path to match on.
    
    regex — (String)
    The regex used to match the path.
    
    prefix — (String)
    Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.
    
    queryParameters — (Array<map>)
    The client request query parameters to match on.
    
    match — (map)
    The query parameter to match on.
    
    exact — (String)
    The exact query parameter to match on.
    
    name — required — (String)
    A name for the query parameter that will be matched on.
    
    scheme — (String)
    The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
    Possible values include:
    
    "http"
    
    "https"
    
    retryPolicy — (map)
    An object that represents a retry policy.
    
    httpRetryEvents — (Array<String>)
    Specify at least one of the following values.
    
    server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
    
    gateway-error – HTTP status codes 502, 503, and 504
    
    client-error – HTTP status code 409
    
    stream-error – Retry on refused stream
    
    maxRetries — required — (Integer)
    The maximum number of retry attempts.
    
    perRetryTimeout — required — (map)
    The timeout for each retry attempt.
    
    unit — (String)
    A unit of time.
    Possible values include:
    
    "s"
    
    "ms"
    
    value — (Integer)
    A number of time units.
    
    tcpRetryEvents — (Array<String>)
    Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.
    
    timeout — (map)
    An object that represents types of timeouts.
    
    idle — (map)
    An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
    
    unit — (String)
    A unit of time.
    Possible values include:
    
    "s"
    
    "ms"
    
    value — (Integer)
    A number of time units.
    
    perRequest — (map)
    An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
    
    unit — (String)
    A unit of time.
    Possible values include:
    
    "s"
    
    "ms"
    
    value — (Integer)
    A number of time units.
    
    priority — (Integer)
    The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority.
    
    tcpRoute — (map)
    An object that represents the specification of a TCP route.
    
    action — required — (map)
    The action to take if a match is determined.
    
    weightedTargets — required — (Array<map>)
    An object that represents the targets that traffic is routed to when a request matches the route.
    
    virtualNode — required — (String)
    The virtual node to associate with the weighted target.
    
    weight — required — (Integer)
    The relative weight of the weighted target.
    
    timeout — (map)
    An object that represents types of timeouts.
    
    idle — (map)
    An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.
    
    unit — (String)
    A unit of time.
    Possible values include:
    
    "s"
    
    "ms"
    
    value — (Integer)
    A number of time units.
    
    status — required — (map)
    The status of the route.
    
    status — required — (String)
    The current status for the route.
    Possible values include:
    
    "ACTIVE"
    
    "INACTIVE"
    
    "DELETED"
    
    virtualRouterName — required — (String)
    The virtual router that the route is associated with.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

createVirtualGateway(params = {}, callback) ⇒ `AWS.Request`

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.

Service Reference:

CreateVirtualGateway

Examples:

Calling the createVirtualGateway operation

var params = {
  meshName: 'STRING_VALUE', /* required */
  spec: { /* required */
    listeners: [ /* required */
      {
        portMapping: { /* required */
          port: 'NUMBER_VALUE', /* required */
          protocol: http | http2 | grpc /* required */
        },
        connectionPool: {
          grpc: {
            maxRequests: 'NUMBER_VALUE' /* required */
          },
          http: {
            maxConnections: 'NUMBER_VALUE', /* required */
            maxPendingRequests: 'NUMBER_VALUE'
          },
          http2: {
            maxRequests: 'NUMBER_VALUE' /* required */
          }
        },
        healthCheck: {
          healthyThreshold: 'NUMBER_VALUE', /* required */
          intervalMillis: 'NUMBER_VALUE', /* required */
          protocol: http | http2 | grpc, /* required */
          timeoutMillis: 'NUMBER_VALUE', /* required */
          unhealthyThreshold: 'NUMBER_VALUE', /* required */
          path: 'STRING_VALUE',
          port: 'NUMBER_VALUE'
        },
        tls: {
          certificate: { /* required */
            acm: {
              certificateArn: 'STRING_VALUE' /* required */
            },
            file: {
              certificateChain: 'STRING_VALUE', /* required */
              privateKey: 'STRING_VALUE' /* required */
            },
            sds: {
              secretName: 'STRING_VALUE' /* required */
            }
          },
          mode: STRICT | PERMISSIVE | DISABLED, /* required */
          validation: {
            trust: { /* required */
              file: {
                certificateChain: 'STRING_VALUE' /* required */
              },
              sds: {
                secretName: 'STRING_VALUE' /* required */
              }
            },
            subjectAlternativeNames: {
              match: { /* required */
                exact: [ /* required */
                  'STRING_VALUE',
                  /* more items */
                ]
              }
            }
          }
        }
      },
      /* more items */
    ],
    backendDefaults: {
      clientPolicy: {
        tls: {
          validation: { /* required */
            trust: { /* required */
              acm: {
                certificateAuthorityArns: [ /* required */
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              file: {
                certificateChain: 'STRING_VALUE' /* required */
              },
              sds: {
                secretName: 'STRING_VALUE' /* required */
              }
            },
            subjectAlternativeNames: {
              match: { /* required */
                exact: [ /* required */
                  'STRING_VALUE',
                  /* more items */
                ]
              }
            }
          },
          certificate: {
            file: {
              certificateChain: 'STRING_VALUE', /* required */
              privateKey: 'STRING_VALUE' /* required */
            },
            sds: {
              secretName: 'STRING_VALUE' /* required */
            }
          },
          enforce: true || false,
          ports: [
            'NUMBER_VALUE',
            /* more items */
          ]
        }
      }
    },
    logging: {
      accessLog: {
        file: {
          path: 'STRING_VALUE' /* required */
        }
      }
    }
  },
  virtualGatewayName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  meshOwner: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
appmesh.createVirtualGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- clientToken — (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.
  If a token is not provided, the SDK will use a version 4 UUID.
- meshName — (String)
  The name of the service mesh to create the virtual gateway in.
- meshOwner — (String)
  The AWS 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.
- spec — (map)
  The virtual gateway specification to apply.
  - backendDefaults — (map)
    A reference to an object that represents the defaults for backends.
    - clientPolicy — (map)
      A reference to an object that represents a client policy.
      
      tls — (map)
      A reference to an object that represents a Transport Layer Security (TLS) client policy.
      
      certificate — (map)
      A reference to an object that represents a virtual gateway's client's Transport Layer Security (TLS) certificate.
      
      file — (map)
      An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS) .
      
      certificateChain — required — (String)
      The certificate chain for the certificate.
      
      privateKey — required — (String)
      The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.
      
      sds — (map)
      A reference to an object that represents a virtual gateway's client's Secret Discovery Service certificate.
      
      secretName — required — (String)
      A reference to an object that represents the name of the secret secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
      
      enforce — (Boolean)
      Whether the policy is enforced. The default is True, if a value isn't specified.
      
      ports — (Array<Integer>)
      One or more ports that the policy is enforced for.
      
      validation — required — (map)
      A reference to an object that represents a Transport Layer Security (TLS) validation context.
      
      subjectAlternativeNames — (map)
      A reference to an object that represents the SANs for a virtual gateway's listener's Transport Layer Security (TLS) validation context.
      
      match — required — (map)
      An object that represents the criteria for determining a SANs match.
      
      exact — required — (Array<String>)
      The values sent must match the specified values exactly.
      
      trust — required — (map)
      A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
      
      acm — (map)
      A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
      
      certificateAuthorityArns — required — (Array<String>)
      One or more ACM Amazon Resource Name (ARN)s.
      
      file — (map)
      An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
      
      certificateChain — required — (String)
      The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
      
      sds — (map)
      A reference to an object that represents a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
      
      secretName — required — (String)
      A reference to an object that represents the name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
  - listeners — required — (Array<map>)
    The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.
    - connectionPool — (map)
      The connection pool information for the virtual gateway listener.
      
      grpc — (map)
      An object that represents a type of connection pool.
      
      maxRequests — required — (Integer)
      Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
      
      http — (map)
      An object that represents a type of connection pool.
      
      maxConnections — required — (Integer)
      Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.
      
      maxPendingRequests — (Integer)
      Number of overflowing requests after max_connections Envoy will queue to upstream cluster.
      
      http2 — (map)
      An object that represents a type of connection pool.
      
      maxRequests — required — (Integer)
      Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.
    - healthCheck — (map)
      The health check information for the listener.
      
      healthyThreshold — required — (Integer)
      The number of consecutive successful health checks that must occur before declaring the listener healthy.
      
      intervalMillis — required — (Integer)
      The time period in milliseconds between each health check execution.
      
      path — (String)
      The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
      
      port — (Integer)
      The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
      
      protocol — required — (String)
      The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
      Possible values include:
      
      "http"
      
      "http2"
      
      "grpc"
      
      timeoutMillis — required — (Integer)
      The amount of time to wait when receiving a response from the health check, in milliseconds.
      
      unhealthyThreshold — required — (Integer)
      The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
    - portMapping — required — (map)
      The port mapping information for the listener.
      
      port — required — (Integer)
      The port used for the port mapping. Specify one protocol.
      
      protocol — required — (String)
      The protocol used for the port mapping.
      Possible values include:
      
      "http"
      
      "http2"
      
      "grpc"
    - tls — (map)
      A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.
      
      certificate — required — (map)
      An object that represents a Transport Layer Security (TLS) certificate.
      
      acm — (map)
      A reference to an object that represents an Certificate Manager certificate.
      
      certificateArn — required — (String)
      The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
      
      file — (map)
      A reference to an object that represents a local file certificate.
      
      certificateChain — required — (String)
      The certificate chain for the certificate.
      
      privateKey — required — (String)
      The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.
      
      sds — (map)
      A reference to an object that represents a virtual gateway's listener's Secret Discovery Service certificate.
      
      secretName — required — (String)
      A reference to an object that represents the name of the secret secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.
      
      mode — required — (String)
      Specify one of the following modes.
      
      STRICT – Listener only accepts connections with TLS enabled.
      
      PERMISSIVE – Listener accepts connections with or without TLS enabled.
      
      DISABLED – Listener only accepts connections without TLS.
      
      Possible values include:
      
      "STRICT"
      
      "PERMISSIVE"
      
      "DISABLED"
      
      validation — (map)
      A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context.
      
      subjectAlternativeNames — (map)
      A reference to an object that represents the SANs for a virtual gateway listener's Transport Layer Security (TLS) validation context.
      
      match — required — (map)
      An object that represents the criteria for determining a SANs match.
      
      exact — required — (Array<String>)
      The values sent must match the specified values exactly.
      
      trust — required — (map)
      A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.
      
      file — (map)
      An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
      
      certificateChain — required — (String)
      The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
      
      sds — (map)
      A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
      
      secretName — required — (String)
      A reference to an object that represents the name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

virtualGateway — (map)
The full description of your virtual gateway following the create call.

meshName — required — (String)
The name of the service mesh that the virtual gateway resides in.

metadata — required — (map)
An object that represents metadata for a resource.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

spec — required — (map)
The specifications of the virtual gateway.

backendDefaults — (map)
A reference to an object that represents the defaults for backends.

clientPolicy — (map)
A reference to an object that represents a client policy.

tls — (map)
A reference to an object that represents a Transport Layer Security (TLS) client policy.

certificate — (map)
A reference to an object that represents a virtual gateway's client's Transport Layer Security (TLS) certificate.

file — (map)
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS) .

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.

sds — (map)
A reference to an object that represents a virtual gateway's client's Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

enforce — (Boolean)
Whether the policy is enforced. The default is True, if a value isn't specified.

ports — (Array<Integer>)
One or more ports that the policy is enforced for.

validation — required — (map)
A reference to an object that represents a Transport Layer Security (TLS) validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a virtual gateway's listener's Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.

certificateAuthorityArns — required — (Array<String>)
One or more ACM Amazon Resource Name (ARN)s.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

listeners — required — (Array<map>)
The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.

connectionPool — (map)
The connection pool information for the virtual gateway listener.

grpc — (map)
An object that represents a type of connection pool.

maxRequests — required — (Integer)
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

http — (map)
An object that represents a type of connection pool.

maxConnections — required — (Integer)
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.

maxPendingRequests — (Integer)
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.

http2 — (map)
An object that represents a type of connection pool.

maxRequests — required — (Integer)
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

healthCheck — (map)
The health check information for the listener.

healthyThreshold — required — (Integer)
The number of consecutive successful health checks that must occur before declaring the listener healthy.

intervalMillis — required — (Integer)
The time period in milliseconds between each health check execution.

path — (String)
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

port — (Integer)
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

protocol — required — (String)
The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
Possible values include:

"http"

"http2"

"grpc"

timeoutMillis — required — (Integer)
The amount of time to wait when receiving a response from the health check, in milliseconds.

unhealthyThreshold — required — (Integer)
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.

portMapping — required — (map)
The port mapping information for the listener.

port — required — (Integer)
The port used for the port mapping. Specify one protocol.

protocol — required — (String)
The protocol used for the port mapping.
Possible values include:

"http"

"http2"

"grpc"

tls — (map)
A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.

certificate — required — (map)
An object that represents a Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents an Certificate Manager certificate.

certificateArn — required — (String)
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

file — (map)
A reference to an object that represents a local file certificate.

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.

sds — (map)
A reference to an object that represents a virtual gateway's listener's Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

mode — required — (String)
Specify one of the following modes.

STRICT – Listener only accepts connections with TLS enabled.

PERMISSIVE – Listener accepts connections with or without TLS enabled.

DISABLED – Listener only accepts connections without TLS.

Possible values include:

"STRICT"

"PERMISSIVE"

"DISABLED"

validation — (map)
A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a virtual gateway listener's Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

logging — (map)
An object that represents logging information.

accessLog — (map)
The access log configuration.

file — (map)
The file object to send virtual gateway access logs to.

path — required — (String)
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.

status — required — (map)
The current status of the virtual gateway.

status — required — (String)
The current status.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

virtualGatewayName — required — (String)
The name of the virtual gateway.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

createVirtualNode(params = {}, callback) ⇒ AWS.Request

Creates a virtual node within a service mesh.

A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you can specify the service discovery information for your task group, and whether the proxy running in a task group will communicate with other proxies using Transport Layer Security (TLS).

You define a listener for any inbound traffic that your virtual node expects. Any virtual service that your virtual node expects to communicate to is specified as a backend.

The response metadata for your new virtual node contains the arn that is associated with the virtual node. Set this value to the full ARN; for example, arn:aws:appmesh:us-west-2:123456789012:myMesh/default/virtualNode/myApp) as the APPMESH_RESOURCE_ARN environment variable for your task group's Envoy proxy container in your task definition or pod spec. This is then mapped to the node.id and node.cluster Envoy parameters.

Note: By default, App Mesh uses the name of the resource you specified in APPMESH_RESOURCE_ARN when Envoy is referring to itself in metrics and traces. You can override this behavior by setting the APPMESH_RESOURCE_CLUSTER environment variable with your own name.

For more information about virtual nodes, see Virtual nodes. You must be using 1.15.0 or later of the Envoy image when setting these variables. For more information aboutApp Mesh Envoy variables, see Envoy image in the AWS App Mesh User Guide.

Service Reference:

CreateVirtualNode

Examples:

Calling the createVirtualNode operation

var params = { meshName: 'STRING_VALUE', /* required */ spec: { /* required */ backendDefaults: { clientPolicy: { tls: { validation: { /* required */ trust: { /* required */ acm: { certificateAuthorityArns: [ /* required */ 'STRING_VALUE', /* more items */ ] }, file: { certificateChain: 'STRING_VALUE' /* required */ }, sds: { secretName: 'STRING_VALUE' /* required */ } }, subjectAlternativeNames: { match: { /* required */ exact: [ /* required */ 'STRING_VALUE', /* more items */ ] } } }, certificate: { file: { certificateChain: 'STRING_VALUE', /* required */ privateKey: 'STRING_VALUE' /* required */ }, sds: { secretName: 'STRING_VALUE' /* required */ } }, enforce: true || false, ports: [ 'NUMBER_VALUE', /* more items */ ] } } }, backends: [ { virtualService: { virtualServiceName: 'STRING_VALUE', /* required */ clientPolicy: { tls: { validation: { /* required */ trust: { /* required */ acm: { certificateAuthorityArns: [ /* required */ 'STRING_VALUE', /* more items */ ] }, file: { certificateChain: 'STRING_VALUE' /* required */ }, sds: { secretName: 'STRING_VALUE' /* required */ } }, subjectAlternativeNames: { match: { /* required */ exact: [ /* required */ 'STRING_VALUE', /* more items */ ] } } }, certificate: { file: { certificateChain: 'STRING_VALUE', /* required */ privateKey: 'STRING_VALUE' /* required */ }, sds: { secretName: 'STRING_VALUE' /* required */ } }, enforce: true || false, ports: [ 'NUMBER_VALUE', /* more items */ ] } } } }, /* more items */ ], listeners: [ { portMapping: { /* required */ port: 'NUMBER_VALUE', /* required */ protocol: http | tcp | http2 | grpc /* required */ }, connectionPool: { grpc: { maxRequests: 'NUMBER_VALUE' /* required */ }, http: { maxConnections: 'NUMBER_VALUE', /* required */ maxPendingRequests: 'NUMBER_VALUE' }, http2: { maxRequests: 'NUMBER_VALUE' /* required */ }, tcp: { maxConnections: 'NUMBER_VALUE' /* required */ } }, healthCheck: { healthyThreshold: 'NUMBER_VALUE', /* required */ intervalMillis: 'NUMBER_VALUE', /* required */ protocol: http | tcp | http2 | grpc, /* required */ timeoutMillis: 'NUMBER_VALUE', /* required */ unhealthyThreshold: 'NUMBER_VALUE', /* required */ path: 'STRING_VALUE', port: 'NUMBER_VALUE' }, outlierDetection: { baseEjectionDuration: { /* required */ unit: s | ms, value: 'NUMBER_VALUE' }, interval: { /* required */ unit: s | ms, value: 'NUMBER_VALUE' }, maxEjectionPercent: 'NUMBER_VALUE', /* required */ maxServerErrors: 'NUMBER_VALUE' /* required */ }, timeout: { grpc: { idle: { unit: s | ms, value: 'NUMBER_VALUE' }, perRequest: { unit: s | ms, value: 'NUMBER_VALUE' } }, http: { idle: { unit: s | ms, value: 'NUMBER_VALUE' }, perRequest: { unit: s | ms, value: 'NUMBER_VALUE' } }, http2: { idle: { unit: s | ms, value: 'NUMBER_VALUE' }, perRequest: { unit: s | ms, value: 'NUMBER_VALUE' } }, tcp: { idle: { unit: s | ms, value: 'NUMBER_VALUE' } } }, tls: { certificate: { /* required */ acm: { certificateArn: 'STRING_VALUE' /* required */ }, file: { certificateChain: 'STRING_VALUE', /* required */ privateKey: 'STRING_VALUE' /* required */ }, sds: { secretName: 'STRING_VALUE' /* required */ } }, mode: STRICT | PERMISSIVE | DISABLED, /* required */ validation: { trust: { /* required */ file: { certificateChain: 'STRING_VALUE' /* required */ }, sds: { secretName: 'STRING_VALUE' /* required */ } }, subjectAlternativeNames: { match: { /* required */ exact: [ /* required */ 'STRING_VALUE', /* more items */ ] } } } } }, /* more items */ ], logging: { accessLog: { file: { path: 'STRING_VALUE' /* required */ } } }, serviceDiscovery: { awsCloudMap: { namespaceName: 'STRING_VALUE', /* required */ serviceName: 'STRING_VALUE', /* required */ attributes: [ { key: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ] }, dns: { hostname: 'STRING_VALUE', /* required */ responseType: LOADBALANCER | ENDPOINTS } } }, virtualNodeName: 'STRING_VALUE', /* required */ clientToken: 'STRING_VALUE', meshOwner: 'STRING_VALUE', tags: [ { key: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ] }; appmesh.createVirtualNode(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

clientToken — (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.
If a token is not provided, the SDK will use a version 4 UUID.

meshName — (String)
The name of the service mesh to create the virtual node in.

meshOwner — (String)
The AWS 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.

spec — (map)
The virtual node specification to apply.

backendDefaults — (map)
A reference to an object that represents the defaults for backends.

clientPolicy — (map)
A reference to an object that represents a client policy.

tls — (map)
A reference to an object that represents a Transport Layer Security (TLS) client policy.

certificate — (map)
A reference to an object that represents a client's TLS certificate.

file — (map)
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a client's TLS Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

enforce — (Boolean)
Whether the policy is enforced. The default is True, if a value isn't specified.

ports — (Array<Integer>)
One or more ports that the policy is enforced for.

validation — required — (map)
A reference to an object that represents a TLS validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.

certificateAuthorityArns — required — (Array<String>)
One or more ACM Amazon Resource Name (ARN)s.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

backends — (Array<map>)
The backends that the virtual node is expected to send outbound traffic to.

virtualService — (map)
Specifies a virtual service to use as a backend.

clientPolicy — (map)
A reference to an object that represents the client policy for a backend.

tls — (map)
A reference to an object that represents a Transport Layer Security (TLS) client policy.

certificate — (map)
A reference to an object that represents a client's TLS certificate.

file — (map)
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a client's TLS Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

enforce — (Boolean)
Whether the policy is enforced. The default is True, if a value isn't specified.

ports — (Array<Integer>)
One or more ports that the policy is enforced for.

validation — required — (map)
A reference to an object that represents a TLS validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.

certificateAuthorityArns — required — (Array<String>)
One or more ACM Amazon Resource Name (ARN)s.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

virtualServiceName — required — (String)
The name of the virtual service that is acting as a virtual node backend.

listeners — (Array<map>)
The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.

connectionPool — (map)
The connection pool information for the listener.

grpc — (map)
An object that represents a type of connection pool.

maxRequests — required — (Integer)
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

http — (map)
An object that represents a type of connection pool.

maxConnections — required — (Integer)
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.

maxPendingRequests — (Integer)
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.

http2 — (map)
An object that represents a type of connection pool.

maxRequests — required — (Integer)
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

tcp — (map)
An object that represents a type of connection pool.

maxConnections — required — (Integer)
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.

healthCheck — (map)
The health check information for the listener.

healthyThreshold — required — (Integer)
The number of consecutive successful health checks that must occur before declaring listener healthy.

intervalMillis — required — (Integer)
The time period in milliseconds between each health check execution.

path — (String)
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

port — (Integer)
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

protocol — required — (String)
The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
Possible values include:

"http"

"tcp"

"http2"

"grpc"

timeoutMillis — required — (Integer)
The amount of time to wait when receiving a response from the health check, in milliseconds.

unhealthyThreshold — required — (Integer)
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

outlierDetection — (map)
The outlier detection information for the listener.

baseEjectionDuration — required — (map)
The base amount of time for which a host is ejected.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

interval — required — (map)
The time interval between ejection sweep analysis.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

maxEjectionPercent — required — (Integer)
Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.

maxServerErrors — required — (Integer)
Number of consecutive 5xx errors required for ejection.

portMapping — required — (map)
The port mapping information for the listener.

port — required — (Integer)
The port used for the port mapping.

protocol — required — (String)
The protocol used for the port mapping. Specify one protocol.
Possible values include:

"http"

"tcp"

"http2"

"grpc"

timeout — (map)
An object that represents timeouts for different protocols.

grpc — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

http — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

http2 — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tcp — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tls — (map)
A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.

certificate — required — (map)
A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.

certificateArn — required — (String)
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

file — (map)
A reference to an object that represents a local file certificate.

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a listener's Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

mode — required — (String)
Specify one of the following modes.

STRICT – Listener only accepts connections with TLS enabled.

PERMISSIVE – Listener accepts connections with or without TLS enabled.

DISABLED – Listener only accepts connections without TLS.

Possible values include:

"STRICT"

"PERMISSIVE"

"DISABLED"

validation — (map)
A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

logging — (map)
The inbound and outbound access logging information for the virtual node.

accessLog — (map)
The access log configuration for a virtual node.

file — (map)
The file object to send virtual node access logs to.

path — required — (String)
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.

Note: The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.

serviceDiscovery — (map)
The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a listener, then you must specify service discovery information.

awsCloudMap — (map)
Specifies any Cloud Map information for the virtual node.

attributes — (Array<map>)
A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.

key — required — (String)
The name of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.

value — required — (String)
The value of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.

namespaceName — required — (String)
The name of the Cloud Map namespace to use.

serviceName — required — (String)
The name of the Cloud Map service to use.

dns — (map)
Specifies the DNS information for the virtual node.

hostname — required — (String)
Specifies the DNS service discovery hostname for the virtual node.

responseType — (String)
Specifies the DNS response type for the virtual node.
Possible values include:

"LOADBALANCER"

"ENDPOINTS"

tags — (Array<map>)
Optional metadata that you can apply to the virtual node to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

key — required — (String)
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

value — required — (String)
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

virtualNodeName — (String)
The name to use for the virtual node.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

virtualNode — (map)
The full description of your virtual node following the create call.

meshName — required — (String)
The name of the service mesh that the virtual node resides in.

metadata — required — (map)
The associated metadata for the virtual node.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

spec — required — (map)
The specifications of the virtual node.

backendDefaults — (map)
A reference to an object that represents the defaults for backends.

clientPolicy — (map)
A reference to an object that represents a client policy.

tls — (map)
A reference to an object that represents a Transport Layer Security (TLS) client policy.

certificate — (map)
A reference to an object that represents a client's TLS certificate.

file — (map)
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a client's TLS Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

enforce — (Boolean)
Whether the policy is enforced. The default is True, if a value isn't specified.

ports — (Array<Integer>)
One or more ports that the policy is enforced for.

validation — required — (map)
A reference to an object that represents a TLS validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.

certificateAuthorityArns — required — (Array<String>)
One or more ACM Amazon Resource Name (ARN)s.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

backends — (Array<map>)
The backends that the virtual node is expected to send outbound traffic to.

virtualService — (map)
Specifies a virtual service to use as a backend.

clientPolicy — (map)
A reference to an object that represents the client policy for a backend.

tls — (map)
A reference to an object that represents a Transport Layer Security (TLS) client policy.

certificate — (map)
A reference to an object that represents a client's TLS certificate.

file — (map)
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a client's TLS Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

enforce — (Boolean)
Whether the policy is enforced. The default is True, if a value isn't specified.

ports — (Array<Integer>)
One or more ports that the policy is enforced for.

validation — required — (map)
A reference to an object that represents a TLS validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.

certificateAuthorityArns — required — (Array<String>)
One or more ACM Amazon Resource Name (ARN)s.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

virtualServiceName — required — (String)
The name of the virtual service that is acting as a virtual node backend.

listeners — (Array<map>)
The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.

connectionPool — (map)
The connection pool information for the listener.

grpc — (map)
An object that represents a type of connection pool.

maxRequests — required — (Integer)
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

http — (map)
An object that represents a type of connection pool.

maxConnections — required — (Integer)
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.

maxPendingRequests — (Integer)
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.

http2 — (map)
An object that represents a type of connection pool.

maxRequests — required — (Integer)
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

tcp — (map)
An object that represents a type of connection pool.

maxConnections — required — (Integer)
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.

healthCheck — (map)
The health check information for the listener.

healthyThreshold — required — (Integer)
The number of consecutive successful health checks that must occur before declaring listener healthy.

intervalMillis — required — (Integer)
The time period in milliseconds between each health check execution.

path — (String)
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

port — (Integer)
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

protocol — required — (String)
The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
Possible values include:

"http"

"tcp"

"http2"

"grpc"

timeoutMillis — required — (Integer)
The amount of time to wait when receiving a response from the health check, in milliseconds.

unhealthyThreshold — required — (Integer)
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

outlierDetection — (map)
The outlier detection information for the listener.

baseEjectionDuration — required — (map)
The base amount of time for which a host is ejected.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

interval — required — (map)
The time interval between ejection sweep analysis.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

maxEjectionPercent — required — (Integer)
Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.

maxServerErrors — required — (Integer)
Number of consecutive 5xx errors required for ejection.

portMapping — required — (map)
The port mapping information for the listener.

port — required — (Integer)
The port used for the port mapping.

protocol — required — (String)
The protocol used for the port mapping. Specify one protocol.
Possible values include:

"http"

"tcp"

"http2"

"grpc"

timeout — (map)
An object that represents timeouts for different protocols.

grpc — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

http — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

http2 — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tcp — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tls — (map)
A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.

certificate — required — (map)
A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.

certificateArn — required — (String)
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

file — (map)
A reference to an object that represents a local file certificate.

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a listener's Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

mode — required — (String)
Specify one of the following modes.

STRICT – Listener only accepts connections with TLS enabled.

PERMISSIVE – Listener accepts connections with or without TLS enabled.

DISABLED – Listener only accepts connections without TLS.

Possible values include:

"STRICT"

"PERMISSIVE"

"DISABLED"

validation — (map)
A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

logging — (map)
The inbound and outbound access logging information for the virtual node.

accessLog — (map)
The access log configuration for a virtual node.

file — (map)
The file object to send virtual node access logs to.

path — required — (String)
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.

Note: The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.

serviceDiscovery — (map)
The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a listener, then you must specify service discovery information.

awsCloudMap — (map)
Specifies any Cloud Map information for the virtual node.

attributes — (Array<map>)
A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.

key — required — (String)
The name of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.

value — required — (String)
The value of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.

namespaceName — required — (String)
The name of the Cloud Map namespace to use.

serviceName — required — (String)
The name of the Cloud Map service to use.

dns — (map)
Specifies the DNS information for the virtual node.

hostname — required — (String)
Specifies the DNS service discovery hostname for the virtual node.

responseType — (String)
Specifies the DNS response type for the virtual node.
Possible values include:

"LOADBALANCER"

"ENDPOINTS"

status — required — (map)
The current status for the virtual node.

status — required — (String)
The current status of the virtual node.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

virtualNodeName — required — (String)
The name of the virtual node.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

createVirtualRouter(params = {}, callback) ⇒ AWS.Request

Creates a virtual router within a service mesh.

Specify a listener for any inbound traffic that your virtual router receives. Create a virtual router for each protocol and port that you need to route. Virtual routers handle traffic for one or more virtual services within your mesh. After you create your virtual router, create and associate routes for your virtual router that direct incoming requests to different virtual nodes.

For more information about virtual routers, see Virtual routers.

Service Reference:

CreateVirtualRouter

Examples:

Calling the createVirtualRouter operation

var params = { meshName: 'STRING_VALUE', /* required */ spec: { /* required */ listeners: [ { portMapping: { /* required */ port: 'NUMBER_VALUE', /* required */ protocol: http | tcp | http2 | grpc /* required */ } }, /* more items */ ] }, virtualRouterName: 'STRING_VALUE', /* required */ clientToken: 'STRING_VALUE', meshOwner: 'STRING_VALUE', tags: [ { key: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ] }; appmesh.createVirtualRouter(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

clientToken — (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.
If a token is not provided, the SDK will use a version 4 UUID.

meshName — (String)
The name of the service mesh to create the virtual router in.

meshOwner — (String)
The AWS 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.

spec — (map)
The virtual router specification to apply.

listeners — (Array<map>)
The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.

portMapping — required — (map)
An object that represents a port mapping.

port — required — (Integer)
The port used for the port mapping.

protocol — required — (String)
The protocol used for the port mapping. Specify one protocol.
Possible values include:

"http"

"tcp"

"http2"

"grpc"

tags — (Array<map>)
Optional metadata that you can apply to the virtual router to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

key — required — (String)
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

value — required — (String)
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

virtualRouterName — (String)
The name to use for the virtual router.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

virtualRouter — (map)
The full description of your virtual router following the create call.

meshName — required — (String)
The name of the service mesh that the virtual router resides in.

metadata — required — (map)
The associated metadata for the virtual router.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

spec — required — (map)
The specifications of the virtual router.

listeners — (Array<map>)
The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.

portMapping — required — (map)
An object that represents a port mapping.

port — required — (Integer)
The port used for the port mapping.

protocol — required — (String)
The protocol used for the port mapping. Specify one protocol.
Possible values include:

"http"

"tcp"

"http2"

"grpc"

status — required — (map)
The current status of the virtual router.

status — required — (String)
The current status of the virtual router.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

virtualRouterName — required — (String)
The name of the virtual router.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

createVirtualService(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

CreateVirtualService

Examples:

Calling the createVirtualService operation

var params = { meshName: 'STRING_VALUE', /* required */ spec: { /* required */ provider: { virtualNode: { virtualNodeName: 'STRING_VALUE' /* required */ }, virtualRouter: { virtualRouterName: 'STRING_VALUE' /* required */ } } }, virtualServiceName: 'STRING_VALUE', /* required */ clientToken: 'STRING_VALUE', meshOwner: 'STRING_VALUE', tags: [ { key: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ] }; appmesh.createVirtualService(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

clientToken — (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.
If a token is not provided, the SDK will use a version 4 UUID.

meshName — (String)
The name of the service mesh to create the virtual service in.

meshOwner — (String)
The AWS 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.

spec — (map)
The virtual service specification to apply.

provider — (map)
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 — (map)
The virtual node associated with a virtual service.

virtualNodeName — required — (String)
The name of the virtual node that is acting as a service provider.

virtualRouter — (map)
The virtual router associated with a virtual service.

virtualRouterName — required — (String)
The name of the virtual router that is acting as a service provider.

tags — (Array<map>)
Optional metadata that you can apply to the virtual service to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

key — required — (String)
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

value — required — (String)
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

virtualServiceName — (String)
The name to use for the virtual service.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

virtualService — (map)
The full description of your virtual service following the create call.

meshName — required — (String)
The name of the service mesh that the virtual service resides in.

metadata — required — (map)
An object that represents metadata for a resource.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

spec — required — (map)
The specifications of the virtual service.

provider — (map)
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 — (map)
The virtual node associated with a virtual service.

virtualNodeName — required — (String)
The name of the virtual node that is acting as a service provider.

virtualRouter — (map)
The virtual router associated with a virtual service.

virtualRouterName — required — (String)
The name of the virtual router that is acting as a service provider.

status — required — (map)
The current status of the virtual service.

status — required — (String)
The current status of the virtual service.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

virtualServiceName — required — (String)
The name of the virtual service.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

deleteGatewayRoute(params = {}, callback) ⇒ AWS.Request

Deletes an existing gateway route.

Service Reference:

DeleteGatewayRoute

Examples:

Calling the deleteGatewayRoute operation

var params = { gatewayRouteName: 'STRING_VALUE', /* required */ meshName: 'STRING_VALUE', /* required */ virtualGatewayName: 'STRING_VALUE', /* required */ meshOwner: 'STRING_VALUE' }; appmesh.deleteGatewayRoute(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

gatewayRouteName — (String)
The name of the gateway route to delete.

meshName — (String)
The name of the service mesh to delete the gateway route from.

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.

virtualGatewayName — (String)
The name of the virtual gateway to delete the route from.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

gatewayRoute — (map)
The gateway route that was deleted.

gatewayRouteName — required — (String)
The name of the gateway route.

meshName — required — (String)
The name of the service mesh that the resource resides in.

metadata — required — (map)
An object that represents metadata for a resource.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

spec — required — (map)
The specifications of the gateway route.

grpcRoute — (map)
An object that represents the specification of a gRPC gateway route.

action — required — (map)
An object that represents the action to take if a match is determined.

rewrite — (map)
The gateway route action to rewrite.

hostname — (map)
The host name of the gateway route to rewrite.

defaultTargetHostname — (String)
The default target host name to write to.
Possible values include:

"ENABLED"

"DISABLED"

target — required — (map)
An object that represents the target that traffic is routed to when a request matches the gateway route.

virtualService — required — (map)
An object that represents a virtual service gateway route target.

virtualServiceName — required — (String)
The name of the virtual service that traffic is routed to.

match — required — (map)
An object that represents the criteria for determining a request match.

hostname — (map)
The gateway route host name to be matched on.

exact — (String)
The exact host name to match on.

suffix — (String)
The specified ending characters of the host name to match on.

metadata — (Array<map>)
The gateway route metadata to be matched on.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
The criteria for determining a metadata match.

exact — (String)
The exact method header to be matched on.

prefix — (String)
The specified beginning characters of the method header to be matched on.

range — (map)
An object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The regex used to match the method header.

suffix — (String)
The specified ending characters of the method header to match on.

name — required — (String)
A name for the gateway route metadata.

serviceName — (String)
The fully qualified domain name for the service to match from the request.

http2Route — (map)
An object that represents the specification of an HTTP/2 gateway route.

action — required — (map)
An object that represents the action to take if a match is determined.

rewrite — (map)
The gateway route action to rewrite.

hostname — (map)
The host name to rewrite.

defaultTargetHostname — (String)
The default target host name to write to.
Possible values include:

"ENABLED"

"DISABLED"

path — (map)
The path to rewrite.

exact — (String)
The exact path to rewrite.

prefix — (map)
The specified beginning characters to rewrite.

defaultPrefix — (String)
The default prefix used to replace the incoming route prefix when rewritten.
Possible values include:

"ENABLED"

"DISABLED"

value — (String)
The value used to replace the incoming route prefix when rewritten.

target — required — (map)
An object that represents the target that traffic is routed to when a request matches the gateway route.

virtualService — required — (map)
An object that represents a virtual service gateway route target.

virtualServiceName — required — (String)
The name of the virtual service that traffic is routed to.

match — required — (map)
An object that represents the criteria for determining a request match.

headers — (Array<map>)
The client request headers to match on.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
An object that represents the method and value to match with the header value sent in a request. Specify one match method.

exact — (String)
The value sent by the client must match the specified value exactly.

prefix — (String)
The value sent by the client must begin with the specified characters.

range — (map)
An object that represents the range of values to match on.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The value sent by the client must include the specified characters.

suffix — (String)
The value sent by the client must end with the specified characters.

name — required — (String)
A name for the HTTP header in the gateway route that will be matched on.

hostname — (map)
The host name to match on.

exact — (String)
The exact host name to match on.

suffix — (String)
The specified ending characters of the host name to match on.

method — (String)
The method to match on.
Possible values include:

"GET"

"HEAD"

"POST"

"PUT"

"DELETE"

"CONNECT"

"OPTIONS"

"TRACE"

"PATCH"

path — (map)
The path to match on.

exact — (String)
The exact path to match on.

regex — (String)
The regex used to match the path.

prefix — (String)
Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

queryParameters — (Array<map>)
The query parameter to match on.

match — (map)
The query parameter to match on.

exact — (String)
The exact query parameter to match on.

name — required — (String)
A name for the query parameter that will be matched on.

httpRoute — (map)
An object that represents the specification of an HTTP gateway route.

action — required — (map)
An object that represents the action to take if a match is determined.

rewrite — (map)
The gateway route action to rewrite.

hostname — (map)
The host name to rewrite.

defaultTargetHostname — (String)
The default target host name to write to.
Possible values include:

"ENABLED"

"DISABLED"

path — (map)
The path to rewrite.

exact — (String)
The exact path to rewrite.

prefix — (map)
The specified beginning characters to rewrite.

defaultPrefix — (String)
The default prefix used to replace the incoming route prefix when rewritten.
Possible values include:

"ENABLED"

"DISABLED"

value — (String)
The value used to replace the incoming route prefix when rewritten.

target — required — (map)
An object that represents the target that traffic is routed to when a request matches the gateway route.

virtualService — required — (map)
An object that represents a virtual service gateway route target.

virtualServiceName — required — (String)
The name of the virtual service that traffic is routed to.

match — required — (map)
An object that represents the criteria for determining a request match.

headers — (Array<map>)
The client request headers to match on.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
An object that represents the method and value to match with the header value sent in a request. Specify one match method.

exact — (String)
The value sent by the client must match the specified value exactly.

prefix — (String)
The value sent by the client must begin with the specified characters.

range — (map)
An object that represents the range of values to match on.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The value sent by the client must include the specified characters.

suffix — (String)
The value sent by the client must end with the specified characters.

name — required — (String)
A name for the HTTP header in the gateway route that will be matched on.

hostname — (map)
The host name to match on.

exact — (String)
The exact host name to match on.

suffix — (String)
The specified ending characters of the host name to match on.

method — (String)
The method to match on.
Possible values include:

"GET"

"HEAD"

"POST"

"PUT"

"DELETE"

"CONNECT"

"OPTIONS"

"TRACE"

"PATCH"

path — (map)
The path to match on.

exact — (String)
The exact path to match on.

regex — (String)
The regex used to match the path.

prefix — (String)
Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

queryParameters — (Array<map>)
The query parameter to match on.

match — (map)
The query parameter to match on.

exact — (String)
The exact query parameter to match on.

name — required — (String)
A name for the query parameter that will be matched on.

priority — (Integer)
The ordering of the gateway routes spec.

status — required — (map)
The status of the gateway route.

status — required — (String)
The current status for the gateway route.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

virtualGatewayName — required — (String)
The virtual gateway that the gateway route is associated with.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

deleteMesh(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

DeleteMesh

Examples:

Calling the deleteMesh operation

var params = { meshName: 'STRING_VALUE' /* required */ }; appmesh.deleteMesh(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

meshName — (String)
The name of the service mesh to delete.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

mesh — (map)
The service mesh that was deleted.

meshName — required — (String)
The name of the service mesh.

metadata — required — (map)
The associated metadata for the service mesh.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

spec — required — (map)
The associated specification for the service mesh.

egressFilter — (map)
The egress filter rules for the service mesh.

type — required — (String)
The egress filter type. By default, the type is DROP_ALL, which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to *.amazonaws.com for Amazon Web Services API calls). You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh.
Possible values include:

"ALLOW_ALL"

"DROP_ALL"

status — required — (map)
The status of the service mesh.

status — (String)
The current mesh status.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

deleteRoute(params = {}, callback) ⇒ AWS.Request

Deletes an existing route.

Service Reference:

DeleteRoute

Examples:

Calling the deleteRoute operation

var params = { meshName: 'STRING_VALUE', /* required */ routeName: 'STRING_VALUE', /* required */ virtualRouterName: 'STRING_VALUE', /* required */ meshOwner: 'STRING_VALUE' }; appmesh.deleteRoute(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

meshName — (String)
The name of the service mesh to delete the route in.

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.

routeName — (String)
The name of the route to delete.

virtualRouterName — (String)
The name of the virtual router to delete the route in.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

route — (map)
The route that was deleted.

meshName — required — (String)
The name of the service mesh that the route resides in.

metadata — required — (map)
The associated metadata for the route.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

routeName — required — (String)
The name of the route.

spec — required — (map)
The specifications of the route.

grpcRoute — (map)
An object that represents the specification of a gRPC route.

action — required — (map)
An object that represents the action to take if a match is determined.

weightedTargets — required — (Array<map>)
An object that represents the targets that traffic is routed to when a request matches the route.

virtualNode — required — (String)
The virtual node to associate with the weighted target.

weight — required — (Integer)
The relative weight of the weighted target.

match — required — (map)
An object that represents the criteria for determining a request match.

metadata — (Array<map>)
An object that represents the data to match from the request.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
An object that represents the data to match from the request.

exact — (String)
The value sent by the client must match the specified value exactly.

prefix — (String)
The value sent by the client must begin with the specified characters.

range — (map)
An object that represents the range of values to match on.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The value sent by the client must include the specified characters.

suffix — (String)
The value sent by the client must end with the specified characters.

name — required — (String)
The name of the route.

methodName — (String)
The method name to match from the request. If you specify a name, you must also specify a serviceName.

serviceName — (String)
The fully qualified domain name for the service to match from the request.

retryPolicy — (map)
An object that represents a retry policy.

grpcRetryEvents — (Array<String>)
Specify at least one of the valid values.

httpRetryEvents — (Array<String>)
Specify at least one of the following values.

server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511

gateway-error – HTTP status codes 502, 503, and 504

client-error – HTTP status code 409

stream-error – Retry on refused stream

maxRetries — required — (Integer)
The maximum number of retry attempts.

perRetryTimeout — required — (map)
The timeout for each retry attempt.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tcpRetryEvents — (Array<String>)
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.

timeout — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

http2Route — (map)
An object that represents the specification of an HTTP/2 route.

action — required — (map)
An object that represents the action to take if a match is determined.

weightedTargets — required — (Array<map>)
An object that represents the targets that traffic is routed to when a request matches the route.

virtualNode — required — (String)
The virtual node to associate with the weighted target.

weight — required — (Integer)
The relative weight of the weighted target.

match — required — (map)
An object that represents the criteria for determining a request match.

headers — (Array<map>)
The client request headers to match on.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
The HeaderMatchMethod object.

exact — (String)
The value sent by the client must match the specified value exactly.

prefix — (String)
The value sent by the client must begin with the specified characters.

range — (map)
An object that represents the range of values to match on.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The value sent by the client must include the specified characters.

suffix — (String)
The value sent by the client must end with the specified characters.

name — required — (String)
A name for the HTTP header in the client request that will be matched on.

method — (String)
The client request method to match on. Specify only one.
Possible values include:

"GET"

"HEAD"

"POST"

"PUT"

"DELETE"

"CONNECT"

"OPTIONS"

"TRACE"

"PATCH"

path — (map)
The client request path to match on.

exact — (String)
The exact path to match on.

regex — (String)
The regex used to match the path.

prefix — (String)
Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

queryParameters — (Array<map>)
The client request query parameters to match on.

match — (map)
The query parameter to match on.

exact — (String)
The exact query parameter to match on.

name — required — (String)
A name for the query parameter that will be matched on.

scheme — (String)
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
Possible values include:

"http"

"https"

retryPolicy — (map)
An object that represents a retry policy.

httpRetryEvents — (Array<String>)
Specify at least one of the following values.

server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511

gateway-error – HTTP status codes 502, 503, and 504

client-error – HTTP status code 409

stream-error – Retry on refused stream

maxRetries — required — (Integer)
The maximum number of retry attempts.

perRetryTimeout — required — (map)
The timeout for each retry attempt.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tcpRetryEvents — (Array<String>)
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.

timeout — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

httpRoute — (map)
An object that represents the specification of an HTTP route.

action — required — (map)
An object that represents the action to take if a match is determined.

weightedTargets — required — (Array<map>)
An object that represents the targets that traffic is routed to when a request matches the route.

virtualNode — required — (String)
The virtual node to associate with the weighted target.

weight — required — (Integer)
The relative weight of the weighted target.

match — required — (map)
An object that represents the criteria for determining a request match.

headers — (Array<map>)
The client request headers to match on.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
The HeaderMatchMethod object.

exact — (String)
The value sent by the client must match the specified value exactly.

prefix — (String)
The value sent by the client must begin with the specified characters.

range — (map)
An object that represents the range of values to match on.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The value sent by the client must include the specified characters.

suffix — (String)
The value sent by the client must end with the specified characters.

name — required — (String)
A name for the HTTP header in the client request that will be matched on.

method — (String)
The client request method to match on. Specify only one.
Possible values include:

"GET"

"HEAD"

"POST"

"PUT"

"DELETE"

"CONNECT"

"OPTIONS"

"TRACE"

"PATCH"

path — (map)
The client request path to match on.

exact — (String)
The exact path to match on.

regex — (String)
The regex used to match the path.

prefix — (String)
Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

queryParameters — (Array<map>)
The client request query parameters to match on.

match — (map)
The query parameter to match on.

exact — (String)
The exact query parameter to match on.

name — required — (String)
A name for the query parameter that will be matched on.

scheme — (String)
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
Possible values include:

"http"

"https"

retryPolicy — (map)
An object that represents a retry policy.

httpRetryEvents — (Array<String>)
Specify at least one of the following values.

server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511

gateway-error – HTTP status codes 502, 503, and 504

client-error – HTTP status code 409

stream-error – Retry on refused stream

maxRetries — required — (Integer)
The maximum number of retry attempts.

perRetryTimeout — required — (map)
The timeout for each retry attempt.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tcpRetryEvents — (Array<String>)
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.

timeout — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

priority — (Integer)
The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority.

tcpRoute — (map)
An object that represents the specification of a TCP route.

action — required — (map)
The action to take if a match is determined.

weightedTargets — required — (Array<map>)
An object that represents the targets that traffic is routed to when a request matches the route.

virtualNode — required — (String)
The virtual node to associate with the weighted target.

weight — required — (Integer)
The relative weight of the weighted target.

timeout — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

status — required — (map)
The status of the route.

status — required — (String)
The current status for the route.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

virtualRouterName — required — (String)
The virtual router that the route is associated with.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

deleteVirtualGateway(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

DeleteVirtualGateway

Examples:

Calling the deleteVirtualGateway operation

var params = { meshName: 'STRING_VALUE', /* required */ virtualGatewayName: 'STRING_VALUE', /* required */ meshOwner: 'STRING_VALUE' }; appmesh.deleteVirtualGateway(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

meshName — (String)
The name of the service mesh to delete the virtual gateway from.

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.

virtualGatewayName — (String)
The name of the virtual gateway to delete.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

virtualGateway — (map)
The virtual gateway that was deleted.

meshName — required — (String)
The name of the service mesh that the virtual gateway resides in.

metadata — required — (map)
An object that represents metadata for a resource.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

spec — required — (map)
The specifications of the virtual gateway.

backendDefaults — (map)
A reference to an object that represents the defaults for backends.

clientPolicy — (map)
A reference to an object that represents a client policy.

tls — (map)
A reference to an object that represents a Transport Layer Security (TLS) client policy.

certificate — (map)
A reference to an object that represents a virtual gateway's client's Transport Layer Security (TLS) certificate.

file — (map)
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS) .

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.

sds — (map)
A reference to an object that represents a virtual gateway's client's Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

enforce — (Boolean)
Whether the policy is enforced. The default is True, if a value isn't specified.

ports — (Array<Integer>)
One or more ports that the policy is enforced for.

validation — required — (map)
A reference to an object that represents a Transport Layer Security (TLS) validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a virtual gateway's listener's Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.

certificateAuthorityArns — required — (Array<String>)
One or more ACM Amazon Resource Name (ARN)s.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

listeners — required — (Array<map>)
The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.

connectionPool — (map)
The connection pool information for the virtual gateway listener.

grpc — (map)
An object that represents a type of connection pool.

maxRequests — required — (Integer)
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

http — (map)
An object that represents a type of connection pool.

maxConnections — required — (Integer)
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.

maxPendingRequests — (Integer)
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.

http2 — (map)
An object that represents a type of connection pool.

maxRequests — required — (Integer)
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

healthCheck — (map)
The health check information for the listener.

healthyThreshold — required — (Integer)
The number of consecutive successful health checks that must occur before declaring the listener healthy.

intervalMillis — required — (Integer)
The time period in milliseconds between each health check execution.

path — (String)
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

port — (Integer)
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

protocol — required — (String)
The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
Possible values include:

"http"

"http2"

"grpc"

timeoutMillis — required — (Integer)
The amount of time to wait when receiving a response from the health check, in milliseconds.

unhealthyThreshold — required — (Integer)
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.

portMapping — required — (map)
The port mapping information for the listener.

port — required — (Integer)
The port used for the port mapping. Specify one protocol.

protocol — required — (String)
The protocol used for the port mapping.
Possible values include:

"http"

"http2"

"grpc"

tls — (map)
A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.

certificate — required — (map)
An object that represents a Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents an Certificate Manager certificate.

certificateArn — required — (String)
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

file — (map)
A reference to an object that represents a local file certificate.

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.

sds — (map)
A reference to an object that represents a virtual gateway's listener's Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

mode — required — (String)
Specify one of the following modes.

STRICT – Listener only accepts connections with TLS enabled.

PERMISSIVE – Listener accepts connections with or without TLS enabled.

DISABLED – Listener only accepts connections without TLS.

Possible values include:

"STRICT"

"PERMISSIVE"

"DISABLED"

validation — (map)
A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a virtual gateway listener's Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

logging — (map)
An object that represents logging information.

accessLog — (map)
The access log configuration.

file — (map)
The file object to send virtual gateway access logs to.

path — required — (String)
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.

status — required — (map)
The current status of the virtual gateway.

status — required — (String)
The current status.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

virtualGatewayName — required — (String)
The name of the virtual gateway.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

deleteVirtualNode(params = {}, callback) ⇒ AWS.Request

Deletes an existing virtual node.

You must delete any virtual services that list a virtual node as a service provider before you can delete the virtual node itself.

Service Reference:

DeleteVirtualNode

Examples:

Calling the deleteVirtualNode operation

var params = { meshName: 'STRING_VALUE', /* required */ virtualNodeName: 'STRING_VALUE', /* required */ meshOwner: 'STRING_VALUE' }; appmesh.deleteVirtualNode(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

meshName — (String)
The name of the service mesh to delete the virtual node in.

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.

virtualNodeName — (String)
The name of the virtual node to delete.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

virtualNode — (map)
The virtual node that was deleted.

meshName — required — (String)
The name of the service mesh that the virtual node resides in.

metadata — required — (map)
The associated metadata for the virtual node.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

spec — required — (map)
The specifications of the virtual node.

backendDefaults — (map)
A reference to an object that represents the defaults for backends.

clientPolicy — (map)
A reference to an object that represents a client policy.

tls — (map)
A reference to an object that represents a Transport Layer Security (TLS) client policy.

certificate — (map)
A reference to an object that represents a client's TLS certificate.

file — (map)
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a client's TLS Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

enforce — (Boolean)
Whether the policy is enforced. The default is True, if a value isn't specified.

ports — (Array<Integer>)
One or more ports that the policy is enforced for.

validation — required — (map)
A reference to an object that represents a TLS validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.

certificateAuthorityArns — required — (Array<String>)
One or more ACM Amazon Resource Name (ARN)s.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

backends — (Array<map>)
The backends that the virtual node is expected to send outbound traffic to.

virtualService — (map)
Specifies a virtual service to use as a backend.

clientPolicy — (map)
A reference to an object that represents the client policy for a backend.

tls — (map)
A reference to an object that represents a Transport Layer Security (TLS) client policy.

certificate — (map)
A reference to an object that represents a client's TLS certificate.

file — (map)
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a client's TLS Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

enforce — (Boolean)
Whether the policy is enforced. The default is True, if a value isn't specified.

ports — (Array<Integer>)
One or more ports that the policy is enforced for.

validation — required — (map)
A reference to an object that represents a TLS validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.

certificateAuthorityArns — required — (Array<String>)
One or more ACM Amazon Resource Name (ARN)s.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

virtualServiceName — required — (String)
The name of the virtual service that is acting as a virtual node backend.

listeners — (Array<map>)
The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.

connectionPool — (map)
The connection pool information for the listener.

grpc — (map)
An object that represents a type of connection pool.

maxRequests — required — (Integer)
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

http — (map)
An object that represents a type of connection pool.

maxConnections — required — (Integer)
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.

maxPendingRequests — (Integer)
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.

http2 — (map)
An object that represents a type of connection pool.

maxRequests — required — (Integer)
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

tcp — (map)
An object that represents a type of connection pool.

maxConnections — required — (Integer)
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.

healthCheck — (map)
The health check information for the listener.

healthyThreshold — required — (Integer)
The number of consecutive successful health checks that must occur before declaring listener healthy.

intervalMillis — required — (Integer)
The time period in milliseconds between each health check execution.

path — (String)
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

port — (Integer)
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

protocol — required — (String)
The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
Possible values include:

"http"

"tcp"

"http2"

"grpc"

timeoutMillis — required — (Integer)
The amount of time to wait when receiving a response from the health check, in milliseconds.

unhealthyThreshold — required — (Integer)
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

outlierDetection — (map)
The outlier detection information for the listener.

baseEjectionDuration — required — (map)
The base amount of time for which a host is ejected.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

interval — required — (map)
The time interval between ejection sweep analysis.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

maxEjectionPercent — required — (Integer)
Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.

maxServerErrors — required — (Integer)
Number of consecutive 5xx errors required for ejection.

portMapping — required — (map)
The port mapping information for the listener.

port — required — (Integer)
The port used for the port mapping.

protocol — required — (String)
The protocol used for the port mapping. Specify one protocol.
Possible values include:

"http"

"tcp"

"http2"

"grpc"

timeout — (map)
An object that represents timeouts for different protocols.

grpc — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

http — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

http2 — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tcp — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tls — (map)
A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.

certificate — required — (map)
A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.

certificateArn — required — (String)
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

file — (map)
A reference to an object that represents a local file certificate.

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a listener's Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

mode — required — (String)
Specify one of the following modes.

STRICT – Listener only accepts connections with TLS enabled.

PERMISSIVE – Listener accepts connections with or without TLS enabled.

DISABLED – Listener only accepts connections without TLS.

Possible values include:

"STRICT"

"PERMISSIVE"

"DISABLED"

validation — (map)
A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

logging — (map)
The inbound and outbound access logging information for the virtual node.

accessLog — (map)
The access log configuration for a virtual node.

file — (map)
The file object to send virtual node access logs to.

path — required — (String)
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.

Note: The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.

serviceDiscovery — (map)
The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a listener, then you must specify service discovery information.

awsCloudMap — (map)
Specifies any Cloud Map information for the virtual node.

attributes — (Array<map>)
A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.

key — required — (String)
The name of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.

value — required — (String)
The value of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.

namespaceName — required — (String)
The name of the Cloud Map namespace to use.

serviceName — required — (String)
The name of the Cloud Map service to use.

dns — (map)
Specifies the DNS information for the virtual node.

hostname — required — (String)
Specifies the DNS service discovery hostname for the virtual node.

responseType — (String)
Specifies the DNS response type for the virtual node.
Possible values include:

"LOADBALANCER"

"ENDPOINTS"

status — required — (map)
The current status for the virtual node.

status — required — (String)
The current status of the virtual node.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

virtualNodeName — required — (String)
The name of the virtual node.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

deleteVirtualRouter(params = {}, callback) ⇒ AWS.Request

Deletes an existing virtual router.

You must delete any routes associated with the virtual router before you can delete the router itself.

Service Reference:

DeleteVirtualRouter

Examples:

Calling the deleteVirtualRouter operation

var params = { meshName: 'STRING_VALUE', /* required */ virtualRouterName: 'STRING_VALUE', /* required */ meshOwner: 'STRING_VALUE' }; appmesh.deleteVirtualRouter(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

meshName — (String)
The name of the service mesh to delete the virtual router in.

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.

virtualRouterName — (String)
The name of the virtual router to delete.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

virtualRouter — (map)
The virtual router that was deleted.

meshName — required — (String)
The name of the service mesh that the virtual router resides in.

metadata — required — (map)
The associated metadata for the virtual router.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

spec — required — (map)
The specifications of the virtual router.

listeners — (Array<map>)
The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.

portMapping — required — (map)
An object that represents a port mapping.

port — required — (Integer)
The port used for the port mapping.

protocol — required — (String)
The protocol used for the port mapping. Specify one protocol.
Possible values include:

"http"

"tcp"

"http2"

"grpc"

status — required — (map)
The current status of the virtual router.

status — required — (String)
The current status of the virtual router.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

virtualRouterName — required — (String)
The name of the virtual router.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

deleteVirtualService(params = {}, callback) ⇒ AWS.Request

Deletes an existing virtual service.

Service Reference:

DeleteVirtualService

Examples:

Calling the deleteVirtualService operation

var params = { meshName: 'STRING_VALUE', /* required */ virtualServiceName: 'STRING_VALUE', /* required */ meshOwner: 'STRING_VALUE' }; appmesh.deleteVirtualService(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

meshName — (String)
The name of the service mesh to delete the virtual service in.

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.

virtualServiceName — (String)
The name of the virtual service to delete.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

virtualService — (map)
The virtual service that was deleted.

meshName — required — (String)
The name of the service mesh that the virtual service resides in.

metadata — required — (map)
An object that represents metadata for a resource.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

spec — required — (map)
The specifications of the virtual service.

provider — (map)
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 — (map)
The virtual node associated with a virtual service.

virtualNodeName — required — (String)
The name of the virtual node that is acting as a service provider.

virtualRouter — (map)
The virtual router associated with a virtual service.

virtualRouterName — required — (String)
The name of the virtual router that is acting as a service provider.

status — required — (map)
The current status of the virtual service.

status — required — (String)
The current status of the virtual service.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

virtualServiceName — required — (String)
The name of the virtual service.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeGatewayRoute(params = {}, callback) ⇒ AWS.Request

Describes an existing gateway route.

Service Reference:

DescribeGatewayRoute

Examples:

Calling the describeGatewayRoute operation

var params = { gatewayRouteName: 'STRING_VALUE', /* required */ meshName: 'STRING_VALUE', /* required */ virtualGatewayName: 'STRING_VALUE', /* required */ meshOwner: 'STRING_VALUE' }; appmesh.describeGatewayRoute(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

gatewayRouteName — (String)
The name of the gateway route to describe.

meshName — (String)
The name of the service mesh that the gateway route resides in.

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.

virtualGatewayName — (String)
The name of the virtual gateway that the gateway route is associated with.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

gatewayRoute — (map)
The full description of your gateway route.

gatewayRouteName — required — (String)
The name of the gateway route.

meshName — required — (String)
The name of the service mesh that the resource resides in.

metadata — required — (map)
An object that represents metadata for a resource.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

spec — required — (map)
The specifications of the gateway route.

grpcRoute — (map)
An object that represents the specification of a gRPC gateway route.

action — required — (map)
An object that represents the action to take if a match is determined.

rewrite — (map)
The gateway route action to rewrite.

hostname — (map)
The host name of the gateway route to rewrite.

defaultTargetHostname — (String)
The default target host name to write to.
Possible values include:

"ENABLED"

"DISABLED"

target — required — (map)
An object that represents the target that traffic is routed to when a request matches the gateway route.

virtualService — required — (map)
An object that represents a virtual service gateway route target.

virtualServiceName — required — (String)
The name of the virtual service that traffic is routed to.

match — required — (map)
An object that represents the criteria for determining a request match.

hostname — (map)
The gateway route host name to be matched on.

exact — (String)
The exact host name to match on.

suffix — (String)
The specified ending characters of the host name to match on.

metadata — (Array<map>)
The gateway route metadata to be matched on.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
The criteria for determining a metadata match.

exact — (String)
The exact method header to be matched on.

prefix — (String)
The specified beginning characters of the method header to be matched on.

range — (map)
An object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The regex used to match the method header.

suffix — (String)
The specified ending characters of the method header to match on.

name — required — (String)
A name for the gateway route metadata.

serviceName — (String)
The fully qualified domain name for the service to match from the request.

http2Route — (map)
An object that represents the specification of an HTTP/2 gateway route.

action — required — (map)
An object that represents the action to take if a match is determined.

rewrite — (map)
The gateway route action to rewrite.

hostname — (map)
The host name to rewrite.

defaultTargetHostname — (String)
The default target host name to write to.
Possible values include:

"ENABLED"

"DISABLED"

path — (map)
The path to rewrite.

exact — (String)
The exact path to rewrite.

prefix — (map)
The specified beginning characters to rewrite.

defaultPrefix — (String)
The default prefix used to replace the incoming route prefix when rewritten.
Possible values include:

"ENABLED"

"DISABLED"

value — (String)
The value used to replace the incoming route prefix when rewritten.

target — required — (map)
An object that represents the target that traffic is routed to when a request matches the gateway route.

virtualService — required — (map)
An object that represents a virtual service gateway route target.

virtualServiceName — required — (String)
The name of the virtual service that traffic is routed to.

match — required — (map)
An object that represents the criteria for determining a request match.

headers — (Array<map>)
The client request headers to match on.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
An object that represents the method and value to match with the header value sent in a request. Specify one match method.

exact — (String)
The value sent by the client must match the specified value exactly.

prefix — (String)
The value sent by the client must begin with the specified characters.

range — (map)
An object that represents the range of values to match on.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The value sent by the client must include the specified characters.

suffix — (String)
The value sent by the client must end with the specified characters.

name — required — (String)
A name for the HTTP header in the gateway route that will be matched on.

hostname — (map)
The host name to match on.

exact — (String)
The exact host name to match on.

suffix — (String)
The specified ending characters of the host name to match on.

method — (String)
The method to match on.
Possible values include:

"GET"

"HEAD"

"POST"

"PUT"

"DELETE"

"CONNECT"

"OPTIONS"

"TRACE"

"PATCH"

path — (map)
The path to match on.

exact — (String)
The exact path to match on.

regex — (String)
The regex used to match the path.

prefix — (String)
Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

queryParameters — (Array<map>)
The query parameter to match on.

match — (map)
The query parameter to match on.

exact — (String)
The exact query parameter to match on.

name — required — (String)
A name for the query parameter that will be matched on.

httpRoute — (map)
An object that represents the specification of an HTTP gateway route.

action — required — (map)
An object that represents the action to take if a match is determined.

rewrite — (map)
The gateway route action to rewrite.

hostname — (map)
The host name to rewrite.

defaultTargetHostname — (String)
The default target host name to write to.
Possible values include:

"ENABLED"

"DISABLED"

path — (map)
The path to rewrite.

exact — (String)
The exact path to rewrite.

prefix — (map)
The specified beginning characters to rewrite.

defaultPrefix — (String)
The default prefix used to replace the incoming route prefix when rewritten.
Possible values include:

"ENABLED"

"DISABLED"

value — (String)
The value used to replace the incoming route prefix when rewritten.

target — required — (map)
An object that represents the target that traffic is routed to when a request matches the gateway route.

virtualService — required — (map)
An object that represents a virtual service gateway route target.

virtualServiceName — required — (String)
The name of the virtual service that traffic is routed to.

match — required — (map)
An object that represents the criteria for determining a request match.

headers — (Array<map>)
The client request headers to match on.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
An object that represents the method and value to match with the header value sent in a request. Specify one match method.

exact — (String)
The value sent by the client must match the specified value exactly.

prefix — (String)
The value sent by the client must begin with the specified characters.

range — (map)
An object that represents the range of values to match on.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The value sent by the client must include the specified characters.

suffix — (String)
The value sent by the client must end with the specified characters.

name — required — (String)
A name for the HTTP header in the gateway route that will be matched on.

hostname — (map)
The host name to match on.

exact — (String)
The exact host name to match on.

suffix — (String)
The specified ending characters of the host name to match on.

method — (String)
The method to match on.
Possible values include:

"GET"

"HEAD"

"POST"

"PUT"

"DELETE"

"CONNECT"

"OPTIONS"

"TRACE"

"PATCH"

path — (map)
The path to match on.

exact — (String)
The exact path to match on.

regex — (String)
The regex used to match the path.

prefix — (String)
Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

queryParameters — (Array<map>)
The query parameter to match on.

match — (map)
The query parameter to match on.

exact — (String)
The exact query parameter to match on.

name — required — (String)
A name for the query parameter that will be matched on.

priority — (Integer)
The ordering of the gateway routes spec.

status — required — (map)
The status of the gateway route.

status — required — (String)
The current status for the gateway route.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

virtualGatewayName — required — (String)
The virtual gateway that the gateway route is associated with.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeMesh(params = {}, callback) ⇒ AWS.Request

Describes an existing service mesh.

Service Reference:

DescribeMesh

Examples:

Calling the describeMesh operation

var params = { meshName: 'STRING_VALUE', /* required */ meshOwner: 'STRING_VALUE' }; appmesh.describeMesh(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

meshName — (String)
The name of the service mesh to describe.

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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

mesh — (map)
The full description of your service mesh.

meshName — required — (String)
The name of the service mesh.

metadata — required — (map)
The associated metadata for the service mesh.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

spec — required — (map)
The associated specification for the service mesh.

egressFilter — (map)
The egress filter rules for the service mesh.

type — required — (String)
The egress filter type. By default, the type is DROP_ALL, which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to *.amazonaws.com for Amazon Web Services API calls). You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh.
Possible values include:

"ALLOW_ALL"

"DROP_ALL"

status — required — (map)
The status of the service mesh.

status — (String)
The current mesh status.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeRoute(params = {}, callback) ⇒ AWS.Request

Describes an existing route.

Service Reference:

DescribeRoute

Examples:

Calling the describeRoute operation

var params = { meshName: 'STRING_VALUE', /* required */ routeName: 'STRING_VALUE', /* required */ virtualRouterName: 'STRING_VALUE', /* required */ meshOwner: 'STRING_VALUE' }; appmesh.describeRoute(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

meshName — (String)
The name of the service mesh that the route resides in.

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.

routeName — (String)
The name of the route to describe.

virtualRouterName — (String)
The name of the virtual router that the route is associated with.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

route — (map)
The full description of your route.

meshName — required — (String)
The name of the service mesh that the route resides in.

metadata — required — (map)
The associated metadata for the route.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

routeName — required — (String)
The name of the route.

spec — required — (map)
The specifications of the route.

grpcRoute — (map)
An object that represents the specification of a gRPC route.

action — required — (map)
An object that represents the action to take if a match is determined.

weightedTargets — required — (Array<map>)
An object that represents the targets that traffic is routed to when a request matches the route.

virtualNode — required — (String)
The virtual node to associate with the weighted target.

weight — required — (Integer)
The relative weight of the weighted target.

match — required — (map)
An object that represents the criteria for determining a request match.

metadata — (Array<map>)
An object that represents the data to match from the request.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
An object that represents the data to match from the request.

exact — (String)
The value sent by the client must match the specified value exactly.

prefix — (String)
The value sent by the client must begin with the specified characters.

range — (map)
An object that represents the range of values to match on.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The value sent by the client must include the specified characters.

suffix — (String)
The value sent by the client must end with the specified characters.

name — required — (String)
The name of the route.

methodName — (String)
The method name to match from the request. If you specify a name, you must also specify a serviceName.

serviceName — (String)
The fully qualified domain name for the service to match from the request.

retryPolicy — (map)
An object that represents a retry policy.

grpcRetryEvents — (Array<String>)
Specify at least one of the valid values.

httpRetryEvents — (Array<String>)
Specify at least one of the following values.

server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511

gateway-error – HTTP status codes 502, 503, and 504

client-error – HTTP status code 409

stream-error – Retry on refused stream

maxRetries — required — (Integer)
The maximum number of retry attempts.

perRetryTimeout — required — (map)
The timeout for each retry attempt.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tcpRetryEvents — (Array<String>)
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.

timeout — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

http2Route — (map)
An object that represents the specification of an HTTP/2 route.

action — required — (map)
An object that represents the action to take if a match is determined.

weightedTargets — required — (Array<map>)
An object that represents the targets that traffic is routed to when a request matches the route.

virtualNode — required — (String)
The virtual node to associate with the weighted target.

weight — required — (Integer)
The relative weight of the weighted target.

match — required — (map)
An object that represents the criteria for determining a request match.

headers — (Array<map>)
The client request headers to match on.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
The HeaderMatchMethod object.

exact — (String)
The value sent by the client must match the specified value exactly.

prefix — (String)
The value sent by the client must begin with the specified characters.

range — (map)
An object that represents the range of values to match on.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The value sent by the client must include the specified characters.

suffix — (String)
The value sent by the client must end with the specified characters.

name — required — (String)
A name for the HTTP header in the client request that will be matched on.

method — (String)
The client request method to match on. Specify only one.
Possible values include:

"GET"

"HEAD"

"POST"

"PUT"

"DELETE"

"CONNECT"

"OPTIONS"

"TRACE"

"PATCH"

path — (map)
The client request path to match on.

exact — (String)
The exact path to match on.

regex — (String)
The regex used to match the path.

prefix — (String)
Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

queryParameters — (Array<map>)
The client request query parameters to match on.

match — (map)
The query parameter to match on.

exact — (String)
The exact query parameter to match on.

name — required — (String)
A name for the query parameter that will be matched on.

scheme — (String)
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
Possible values include:

"http"

"https"

retryPolicy — (map)
An object that represents a retry policy.

httpRetryEvents — (Array<String>)
Specify at least one of the following values.

server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511

gateway-error – HTTP status codes 502, 503, and 504

client-error – HTTP status code 409

stream-error – Retry on refused stream

maxRetries — required — (Integer)
The maximum number of retry attempts.

perRetryTimeout — required — (map)
The timeout for each retry attempt.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tcpRetryEvents — (Array<String>)
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.

timeout — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

httpRoute — (map)
An object that represents the specification of an HTTP route.

action — required — (map)
An object that represents the action to take if a match is determined.

weightedTargets — required — (Array<map>)
An object that represents the targets that traffic is routed to when a request matches the route.

virtualNode — required — (String)
The virtual node to associate with the weighted target.

weight — required — (Integer)
The relative weight of the weighted target.

match — required — (map)
An object that represents the criteria for determining a request match.

headers — (Array<map>)
The client request headers to match on.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
The HeaderMatchMethod object.

exact — (String)
The value sent by the client must match the specified value exactly.

prefix — (String)
The value sent by the client must begin with the specified characters.

range — (map)
An object that represents the range of values to match on.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The value sent by the client must include the specified characters.

suffix — (String)
The value sent by the client must end with the specified characters.

name — required — (String)
A name for the HTTP header in the client request that will be matched on.

method — (String)
The client request method to match on. Specify only one.
Possible values include:

"GET"

"HEAD"

"POST"

"PUT"

"DELETE"

"CONNECT"

"OPTIONS"

"TRACE"

"PATCH"

path — (map)
The client request path to match on.

exact — (String)
The exact path to match on.

regex — (String)
The regex used to match the path.

prefix — (String)
Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

queryParameters — (Array<map>)
The client request query parameters to match on.

match — (map)
The query parameter to match on.

exact — (String)
The exact query parameter to match on.

name — required — (String)
A name for the query parameter that will be matched on.

scheme — (String)
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
Possible values include:

"http"

"https"

retryPolicy — (map)
An object that represents a retry policy.

httpRetryEvents — (Array<String>)
Specify at least one of the following values.

server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511

gateway-error – HTTP status codes 502, 503, and 504

client-error – HTTP status code 409

stream-error – Retry on refused stream

maxRetries — required — (Integer)
The maximum number of retry attempts.

perRetryTimeout — required — (map)
The timeout for each retry attempt.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tcpRetryEvents — (Array<String>)
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.

timeout — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

priority — (Integer)
The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority.

tcpRoute — (map)
An object that represents the specification of a TCP route.

action — required — (map)
The action to take if a match is determined.

weightedTargets — required — (Array<map>)
An object that represents the targets that traffic is routed to when a request matches the route.

virtualNode — required — (String)
The virtual node to associate with the weighted target.

weight — required — (Integer)
The relative weight of the weighted target.

timeout — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

status — required — (map)
The status of the route.

status — required — (String)
The current status for the route.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

virtualRouterName — required — (String)
The virtual router that the route is associated with.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeVirtualGateway(params = {}, callback) ⇒ AWS.Request

Describes an existing virtual gateway.

Service Reference:

DescribeVirtualGateway

Examples:

Calling the describeVirtualGateway operation

var params = { meshName: 'STRING_VALUE', /* required */ virtualGatewayName: 'STRING_VALUE', /* required */ meshOwner: 'STRING_VALUE' }; appmesh.describeVirtualGateway(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

meshName — (String)
The name of the service mesh that the gateway route resides in.

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.

virtualGatewayName — (String)
The name of the virtual gateway to describe.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

virtualGateway — (map)
The full description of your virtual gateway.

meshName — required — (String)
The name of the service mesh that the virtual gateway resides in.

metadata — required — (map)
An object that represents metadata for a resource.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

spec — required — (map)
The specifications of the virtual gateway.

backendDefaults — (map)
A reference to an object that represents the defaults for backends.

clientPolicy — (map)
A reference to an object that represents a client policy.

tls — (map)
A reference to an object that represents a Transport Layer Security (TLS) client policy.

certificate — (map)
A reference to an object that represents a virtual gateway's client's Transport Layer Security (TLS) certificate.

file — (map)
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS) .

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.

sds — (map)
A reference to an object that represents a virtual gateway's client's Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

enforce — (Boolean)
Whether the policy is enforced. The default is True, if a value isn't specified.

ports — (Array<Integer>)
One or more ports that the policy is enforced for.

validation — required — (map)
A reference to an object that represents a Transport Layer Security (TLS) validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a virtual gateway's listener's Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.

certificateAuthorityArns — required — (Array<String>)
One or more ACM Amazon Resource Name (ARN)s.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

listeners — required — (Array<map>)
The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.

connectionPool — (map)
The connection pool information for the virtual gateway listener.

grpc — (map)
An object that represents a type of connection pool.

maxRequests — required — (Integer)
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

http — (map)
An object that represents a type of connection pool.

maxConnections — required — (Integer)
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.

maxPendingRequests — (Integer)
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.

http2 — (map)
An object that represents a type of connection pool.

maxRequests — required — (Integer)
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

healthCheck — (map)
The health check information for the listener.

healthyThreshold — required — (Integer)
The number of consecutive successful health checks that must occur before declaring the listener healthy.

intervalMillis — required — (Integer)
The time period in milliseconds between each health check execution.

path — (String)
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

port — (Integer)
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

protocol — required — (String)
The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
Possible values include:

"http"

"http2"

"grpc"

timeoutMillis — required — (Integer)
The amount of time to wait when receiving a response from the health check, in milliseconds.

unhealthyThreshold — required — (Integer)
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.

portMapping — required — (map)
The port mapping information for the listener.

port — required — (Integer)
The port used for the port mapping. Specify one protocol.

protocol — required — (String)
The protocol used for the port mapping.
Possible values include:

"http"

"http2"

"grpc"

tls — (map)
A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.

certificate — required — (map)
An object that represents a Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents an Certificate Manager certificate.

certificateArn — required — (String)
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

file — (map)
A reference to an object that represents a local file certificate.

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.

sds — (map)
A reference to an object that represents a virtual gateway's listener's Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

mode — required — (String)
Specify one of the following modes.

STRICT – Listener only accepts connections with TLS enabled.

PERMISSIVE – Listener accepts connections with or without TLS enabled.

DISABLED – Listener only accepts connections without TLS.

Possible values include:

"STRICT"

"PERMISSIVE"

"DISABLED"

validation — (map)
A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a virtual gateway listener's Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

logging — (map)
An object that represents logging information.

accessLog — (map)
The access log configuration.

file — (map)
The file object to send virtual gateway access logs to.

path — required — (String)
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.

status — required — (map)
The current status of the virtual gateway.

status — required — (String)
The current status.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

virtualGatewayName — required — (String)
The name of the virtual gateway.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeVirtualNode(params = {}, callback) ⇒ AWS.Request

Describes an existing virtual node.

Service Reference:

DescribeVirtualNode

Examples:

Calling the describeVirtualNode operation

var params = { meshName: 'STRING_VALUE', /* required */ virtualNodeName: 'STRING_VALUE', /* required */ meshOwner: 'STRING_VALUE' }; appmesh.describeVirtualNode(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

meshName — (String)
The name of the service mesh that the virtual node resides in.

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.

virtualNodeName — (String)
The name of the virtual node to describe.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

virtualNode — (map)
The full description of your virtual node.

meshName — required — (String)
The name of the service mesh that the virtual node resides in.

metadata — required — (map)
The associated metadata for the virtual node.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

spec — required — (map)
The specifications of the virtual node.

backendDefaults — (map)
A reference to an object that represents the defaults for backends.

clientPolicy — (map)
A reference to an object that represents a client policy.

tls — (map)
A reference to an object that represents a Transport Layer Security (TLS) client policy.

certificate — (map)
A reference to an object that represents a client's TLS certificate.

file — (map)
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a client's TLS Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

enforce — (Boolean)
Whether the policy is enforced. The default is True, if a value isn't specified.

ports — (Array<Integer>)
One or more ports that the policy is enforced for.

validation — required — (map)
A reference to an object that represents a TLS validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.

certificateAuthorityArns — required — (Array<String>)
One or more ACM Amazon Resource Name (ARN)s.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

backends — (Array<map>)
The backends that the virtual node is expected to send outbound traffic to.

virtualService — (map)
Specifies a virtual service to use as a backend.

clientPolicy — (map)
A reference to an object that represents the client policy for a backend.

tls — (map)
A reference to an object that represents a Transport Layer Security (TLS) client policy.

certificate — (map)
A reference to an object that represents a client's TLS certificate.

file — (map)
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a client's TLS Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

enforce — (Boolean)
Whether the policy is enforced. The default is True, if a value isn't specified.

ports — (Array<Integer>)
One or more ports that the policy is enforced for.

validation — required — (map)
A reference to an object that represents a TLS validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.

certificateAuthorityArns — required — (Array<String>)
One or more ACM Amazon Resource Name (ARN)s.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

virtualServiceName — required — (String)
The name of the virtual service that is acting as a virtual node backend.

listeners — (Array<map>)
The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.

connectionPool — (map)
The connection pool information for the listener.

grpc — (map)
An object that represents a type of connection pool.

maxRequests — required — (Integer)
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

http — (map)
An object that represents a type of connection pool.

maxConnections — required — (Integer)
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.

maxPendingRequests — (Integer)
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.

http2 — (map)
An object that represents a type of connection pool.

maxRequests — required — (Integer)
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

tcp — (map)
An object that represents a type of connection pool.

maxConnections — required — (Integer)
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.

healthCheck — (map)
The health check information for the listener.

healthyThreshold — required — (Integer)
The number of consecutive successful health checks that must occur before declaring listener healthy.

intervalMillis — required — (Integer)
The time period in milliseconds between each health check execution.

path — (String)
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

port — (Integer)
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

protocol — required — (String)
The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
Possible values include:

"http"

"tcp"

"http2"

"grpc"

timeoutMillis — required — (Integer)
The amount of time to wait when receiving a response from the health check, in milliseconds.

unhealthyThreshold — required — (Integer)
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

outlierDetection — (map)
The outlier detection information for the listener.

baseEjectionDuration — required — (map)
The base amount of time for which a host is ejected.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

interval — required — (map)
The time interval between ejection sweep analysis.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

maxEjectionPercent — required — (Integer)
Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.

maxServerErrors — required — (Integer)
Number of consecutive 5xx errors required for ejection.

portMapping — required — (map)
The port mapping information for the listener.

port — required — (Integer)
The port used for the port mapping.

protocol — required — (String)
The protocol used for the port mapping. Specify one protocol.
Possible values include:

"http"

"tcp"

"http2"

"grpc"

timeout — (map)
An object that represents timeouts for different protocols.

grpc — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

http — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

http2 — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tcp — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tls — (map)
A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.

certificate — required — (map)
A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.

certificateArn — required — (String)
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

file — (map)
A reference to an object that represents a local file certificate.

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a listener's Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

mode — required — (String)
Specify one of the following modes.

STRICT – Listener only accepts connections with TLS enabled.

PERMISSIVE – Listener accepts connections with or without TLS enabled.

DISABLED – Listener only accepts connections without TLS.

Possible values include:

"STRICT"

"PERMISSIVE"

"DISABLED"

validation — (map)
A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

logging — (map)
The inbound and outbound access logging information for the virtual node.

accessLog — (map)
The access log configuration for a virtual node.

file — (map)
The file object to send virtual node access logs to.

path — required — (String)
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.

Note: The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.

serviceDiscovery — (map)
The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a listener, then you must specify service discovery information.

awsCloudMap — (map)
Specifies any Cloud Map information for the virtual node.

attributes — (Array<map>)
A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.

key — required — (String)
The name of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.

value — required — (String)
The value of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.

namespaceName — required — (String)
The name of the Cloud Map namespace to use.

serviceName — required — (String)
The name of the Cloud Map service to use.

dns — (map)
Specifies the DNS information for the virtual node.

hostname — required — (String)
Specifies the DNS service discovery hostname for the virtual node.

responseType — (String)
Specifies the DNS response type for the virtual node.
Possible values include:

"LOADBALANCER"

"ENDPOINTS"

status — required — (map)
The current status for the virtual node.

status — required — (String)
The current status of the virtual node.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

virtualNodeName — required — (String)
The name of the virtual node.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeVirtualRouter(params = {}, callback) ⇒ AWS.Request

Describes an existing virtual router.

Service Reference:

DescribeVirtualRouter

Examples:

Calling the describeVirtualRouter operation

var params = { meshName: 'STRING_VALUE', /* required */ virtualRouterName: 'STRING_VALUE', /* required */ meshOwner: 'STRING_VALUE' }; appmesh.describeVirtualRouter(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

meshName — (String)
The name of the service mesh that the virtual router resides in.

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.

virtualRouterName — (String)
The name of the virtual router to describe.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

virtualRouter — (map)
The full description of your virtual router.

meshName — required — (String)
The name of the service mesh that the virtual router resides in.

metadata — required — (map)
The associated metadata for the virtual router.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

spec — required — (map)
The specifications of the virtual router.

listeners — (Array<map>)
The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.

portMapping — required — (map)
An object that represents a port mapping.

port — required — (Integer)
The port used for the port mapping.

protocol — required — (String)
The protocol used for the port mapping. Specify one protocol.
Possible values include:

"http"

"tcp"

"http2"

"grpc"

status — required — (map)
The current status of the virtual router.

status — required — (String)
The current status of the virtual router.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

virtualRouterName — required — (String)
The name of the virtual router.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeVirtualService(params = {}, callback) ⇒ AWS.Request

Describes an existing virtual service.

Service Reference:

DescribeVirtualService

Examples:

Calling the describeVirtualService operation

var params = { meshName: 'STRING_VALUE', /* required */ virtualServiceName: 'STRING_VALUE', /* required */ meshOwner: 'STRING_VALUE' }; appmesh.describeVirtualService(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

meshName — (String)
The name of the service mesh that the virtual service resides in.

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.

virtualServiceName — (String)
The name of the virtual service to describe.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

virtualService — (map)
The full description of your virtual service.

meshName — required — (String)
The name of the service mesh that the virtual service resides in.

metadata — required — (map)
An object that represents metadata for a resource.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

spec — required — (map)
The specifications of the virtual service.

provider — (map)
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 — (map)
The virtual node associated with a virtual service.

virtualNodeName — required — (String)
The name of the virtual node that is acting as a service provider.

virtualRouter — (map)
The virtual router associated with a virtual service.

virtualRouterName — required — (String)
The name of the virtual router that is acting as a service provider.

status — required — (map)
The current status of the virtual service.

status — required — (String)
The current status of the virtual service.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

virtualServiceName — required — (String)
The name of the virtual service.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listGatewayRoutes(params = {}, callback) ⇒ AWS.Request

Returns a list of existing gateway routes that are associated to a virtual gateway.

Service Reference:

ListGatewayRoutes

Examples:

Calling the listGatewayRoutes operation

var params = { meshName: 'STRING_VALUE', /* required */ virtualGatewayName: 'STRING_VALUE', /* required */ limit: 'NUMBER_VALUE', meshOwner: 'STRING_VALUE', nextToken: 'STRING_VALUE' }; appmesh.listGatewayRoutes(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

limit — (Integer)
The maximum number of results returned by ListGatewayRoutes in paginated output. When you use this parameter, ListGatewayRoutes 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 ListGatewayRoutes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListGatewayRoutes returns up to 100 results and a nextToken value if applicable.

meshName — (String)
The name of the service mesh to list gateway routes in.

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.

nextToken — (String)
The nextToken value returned from a previous paginated ListGatewayRoutes 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.

virtualGatewayName — (String)
The name of the virtual gateway to list gateway routes in.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

gatewayRoutes — (Array<map>)
The list of existing gateway routes for the specified service mesh and virtual gateway.

arn — required — (String)
The full Amazon Resource Name (ARN) for the gateway route.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

gatewayRouteName — required — (String)
The name of the gateway route.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshName — required — (String)
The name of the service mesh that the resource resides in.

meshOwner — required — (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 — required — (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.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

virtualGatewayName — required — (String)
The virtual gateway that the gateway route is associated with.

nextToken — (String)
The nextToken value to include in a future ListGatewayRoutes request. When the results of a ListGatewayRoutes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listMeshes(params = {}, callback) ⇒ AWS.Request

Returns a list of existing service meshes.

Service Reference:

ListMeshes

Examples:

Calling the listMeshes operation

var params = { limit: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; appmesh.listMeshes(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

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.

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.

Note: 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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

meshes — (Array<map>)
The list of existing service meshes.

arn — required — (String)
The full Amazon Resource Name (ARN) of the service mesh.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshName — required — (String)
The name of the service mesh.

meshOwner — required — (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 — required — (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.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

nextToken — (String)
The nextToken value to include in a future ListMeshes request. When the results of a ListMeshes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listRoutes(params = {}, callback) ⇒ AWS.Request

Returns a list of existing routes in a service mesh.

Service Reference:

ListRoutes

Examples:

Calling the listRoutes operation

var params = { meshName: 'STRING_VALUE', /* required */ virtualRouterName: 'STRING_VALUE', /* required */ limit: 'NUMBER_VALUE', meshOwner: 'STRING_VALUE', nextToken: 'STRING_VALUE' }; appmesh.listRoutes(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

limit — (Integer)
The maximum number of results returned by ListRoutes in paginated output. When you use this parameter, ListRoutes 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 ListRoutes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListRoutes returns up to 100 results and a nextToken value if applicable.

meshName — (String)
The name of the service mesh to list routes in.

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.

nextToken — (String)
The nextToken value returned from a previous paginated ListRoutes 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.

virtualRouterName — (String)
The name of the virtual router to list routes in.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

nextToken — (String)
The nextToken value to include in a future ListRoutes request. When the results of a ListRoutes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

routes — (Array<map>)
The list of existing routes for the specified service mesh and virtual router.

arn — required — (String)
The full Amazon Resource Name (ARN) for the route.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshName — required — (String)
The name of the service mesh that the route resides in.

meshOwner — required — (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 — required — (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.

routeName — required — (String)
The name of the route.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

virtualRouterName — required — (String)
The virtual router that the route is associated with.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

List the tags for an App Mesh resource.

Service Reference:

ListTagsForResource

Examples:

Calling the listTagsForResource operation

var params = { resourceArn: 'STRING_VALUE', /* required */ limit: 'NUMBER_VALUE', nextToken: 'STRING_VALUE' }; appmesh.listTagsForResource(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

limit — (Integer)
The maximum number of tag results returned by ListTagsForResource in paginated output. When this parameter is used, ListTagsForResource 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 ListTagsForResource request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListTagsForResource returns up to 100 results and a nextToken value if applicable.

nextToken — (String)
The nextToken value returned from a previous paginated ListTagsForResource 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.

resourceArn — (String)
The Amazon Resource Name (ARN) that identifies the resource to list the tags for.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

nextToken — (String)
The nextToken value to include in a future ListTagsForResource request. When the results of a ListTagsForResource request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

tags — (Array<map>)
The tags for the resource.

key — required — (String)
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

value — required — (String)
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listVirtualGateways(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

ListVirtualGateways

Examples:

Calling the listVirtualGateways operation

var params = { meshName: 'STRING_VALUE', /* required */ limit: 'NUMBER_VALUE', meshOwner: 'STRING_VALUE', nextToken: 'STRING_VALUE' }; appmesh.listVirtualGateways(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

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.

meshName — (String)
The name of the service mesh to list virtual gateways in.

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.

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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

nextToken — (String)
The nextToken value to include in a future ListVirtualGateways request. When the results of a ListVirtualGateways request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

virtualGateways — (Array<map>)
The list of existing virtual gateways for the specified service mesh.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshName — required — (String)
The name of the service mesh that the resource resides in.

meshOwner — required — (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 — required — (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.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

virtualGatewayName — required — (String)
The name of the resource.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listVirtualNodes(params = {}, callback) ⇒ AWS.Request

Returns a list of existing virtual nodes.

Service Reference:

ListVirtualNodes

Examples:

Calling the listVirtualNodes operation

var params = { meshName: 'STRING_VALUE', /* required */ limit: 'NUMBER_VALUE', meshOwner: 'STRING_VALUE', nextToken: 'STRING_VALUE' }; appmesh.listVirtualNodes(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

limit — (Integer)
The maximum number of results returned by ListVirtualNodes in paginated output. When you use this parameter, ListVirtualNodes 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 ListVirtualNodes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualNodes returns up to 100 results and a nextToken value if applicable.

meshName — (String)
The name of the service mesh to list virtual nodes in.

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.

nextToken — (String)
The nextToken value returned from a previous paginated ListVirtualNodes 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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

nextToken — (String)
The nextToken value to include in a future ListVirtualNodes request. When the results of a ListVirtualNodes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

virtualNodes — (Array<map>)
The list of existing virtual nodes for the specified service mesh.

arn — required — (String)
The full Amazon Resource Name (ARN) for the virtual node.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshName — required — (String)
The name of the service mesh that the virtual node resides in.

meshOwner — required — (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 — required — (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.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

virtualNodeName — required — (String)
The name of the virtual node.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listVirtualRouters(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

ListVirtualRouters

Examples:

Calling the listVirtualRouters operation

var params = { meshName: 'STRING_VALUE', /* required */ limit: 'NUMBER_VALUE', meshOwner: 'STRING_VALUE', nextToken: 'STRING_VALUE' }; appmesh.listVirtualRouters(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

limit — (Integer)
The maximum number of results returned by ListVirtualRouters in paginated output. When you use this parameter, ListVirtualRouters 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 ListVirtualRouters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualRouters returns up to 100 results and a nextToken value if applicable.

meshName — (String)
The name of the service mesh to list virtual routers in.

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.

nextToken — (String)
The nextToken value returned from a previous paginated ListVirtualRouters 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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

nextToken — (String)
The nextToken value to include in a future ListVirtualRouters request. When the results of a ListVirtualRouters request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

virtualRouters — (Array<map>)
The list of existing virtual routers for the specified service mesh.

arn — required — (String)
The full Amazon Resource Name (ARN) for the virtual router.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshName — required — (String)
The name of the service mesh that the virtual router resides in.

meshOwner — required — (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 — required — (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.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

virtualRouterName — required — (String)
The name of the virtual router.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listVirtualServices(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

ListVirtualServices

Examples:

Calling the listVirtualServices operation

var params = { meshName: 'STRING_VALUE', /* required */ limit: 'NUMBER_VALUE', meshOwner: 'STRING_VALUE', nextToken: 'STRING_VALUE' }; appmesh.listVirtualServices(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

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.

meshName — (String)
The name of the service mesh to list virtual services in.

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.

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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

nextToken — (String)
The nextToken value to include in a future ListVirtualServices request. When the results of a ListVirtualServices request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

virtualServices — (Array<map>)
The list of existing virtual services for the specified service mesh.

arn — required — (String)
The full Amazon Resource Name (ARN) for the virtual service.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshName — required — (String)
The name of the service mesh that the virtual service resides in.

meshOwner — required — (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 — required — (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.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

virtualServiceName — required — (String)
The name of the virtual service.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted.

Service Reference:

TagResource

Examples:

Calling the tagResource operation

var params = { resourceArn: 'STRING_VALUE', /* required */ tags: [ /* required */ { key: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ] }; appmesh.tagResource(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

resourceArn — (String)
The Amazon Resource Name (ARN) of the resource to add tags to.

tags — (Array<map>)
The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

key — required — (String)
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

value — required — (String)
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Deletes specified tags from a resource.

Service Reference:

UntagResource

Examples:

Calling the untagResource operation

var params = { resourceArn: 'STRING_VALUE', /* required */ tagKeys: [ /* required */ 'STRING_VALUE', /* more items */ ] }; appmesh.untagResource(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

resourceArn — (String)
The Amazon Resource Name (ARN) of the resource to delete tags from.

tagKeys — (Array<String>)
The keys of the tags to be removed.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

updateGatewayRoute(params = {}, callback) ⇒ AWS.Request

Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh.

Service Reference:

UpdateGatewayRoute

Examples:

Calling the updateGatewayRoute operation

var params = { gatewayRouteName: 'STRING_VALUE', /* required */ meshName: 'STRING_VALUE', /* required */ spec: { /* required */ grpcRoute: { action: { /* required */ target: { /* required */ virtualService: { /* required */ virtualServiceName: 'STRING_VALUE' /* required */ } }, rewrite: { hostname: { defaultTargetHostname: ENABLED | DISABLED } } }, match: { /* required */ hostname: { exact: 'STRING_VALUE', suffix: 'STRING_VALUE' }, metadata: [ { name: 'STRING_VALUE', /* required */ invert: true || false, match: { exact: 'STRING_VALUE', prefix: 'STRING_VALUE', range: { end: 'NUMBER_VALUE', /* required */ start: 'NUMBER_VALUE' /* required */ }, regex: 'STRING_VALUE', suffix: 'STRING_VALUE' } }, /* more items */ ], serviceName: 'STRING_VALUE' } }, http2Route: { action: { /* required */ target: { /* required */ virtualService: { /* required */ virtualServiceName: 'STRING_VALUE' /* required */ } }, rewrite: { hostname: { defaultTargetHostname: ENABLED | DISABLED }, path: { exact: 'STRING_VALUE' }, prefix: { defaultPrefix: ENABLED | DISABLED, value: 'STRING_VALUE' } } }, match: { /* required */ headers: [ { name: 'STRING_VALUE', /* required */ invert: true || false, match: { exact: 'STRING_VALUE', prefix: 'STRING_VALUE', range: { end: 'NUMBER_VALUE', /* required */ start: 'NUMBER_VALUE' /* required */ }, regex: 'STRING_VALUE', suffix: 'STRING_VALUE' } }, /* more items */ ], hostname: { exact: 'STRING_VALUE', suffix: 'STRING_VALUE' }, method: GET | HEAD | POST | PUT | DELETE | CONNECT | OPTIONS | TRACE | PATCH, path: { exact: 'STRING_VALUE', regex: 'STRING_VALUE' }, prefix: 'STRING_VALUE', queryParameters: [ { name: 'STRING_VALUE', /* required */ match: { exact: 'STRING_VALUE' } }, /* more items */ ] } }, httpRoute: { action: { /* required */ target: { /* required */ virtualService: { /* required */ virtualServiceName: 'STRING_VALUE' /* required */ } }, rewrite: { hostname: { defaultTargetHostname: ENABLED | DISABLED }, path: { exact: 'STRING_VALUE' }, prefix: { defaultPrefix: ENABLED | DISABLED, value: 'STRING_VALUE' } } }, match: { /* required */ headers: [ { name: 'STRING_VALUE', /* required */ invert: true || false, match: { exact: 'STRING_VALUE', prefix: 'STRING_VALUE', range: { end: 'NUMBER_VALUE', /* required */ start: 'NUMBER_VALUE' /* required */ }, regex: 'STRING_VALUE', suffix: 'STRING_VALUE' } }, /* more items */ ], hostname: { exact: 'STRING_VALUE', suffix: 'STRING_VALUE' }, method: GET | HEAD | POST | PUT | DELETE | CONNECT | OPTIONS | TRACE | PATCH, path: { exact: 'STRING_VALUE', regex: 'STRING_VALUE' }, prefix: 'STRING_VALUE', queryParameters: [ { name: 'STRING_VALUE', /* required */ match: { exact: 'STRING_VALUE' } }, /* more items */ ] } }, priority: 'NUMBER_VALUE' }, virtualGatewayName: 'STRING_VALUE', /* required */ clientToken: 'STRING_VALUE', meshOwner: 'STRING_VALUE' }; appmesh.updateGatewayRoute(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

clientToken — (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.
If a token is not provided, the SDK will use a version 4 UUID.

gatewayRouteName — (String)
The name of the gateway route to update.

meshName — (String)
The name of the service mesh that the gateway route resides in.

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.

spec — (map)
The new gateway route specification to apply. This overwrites the existing data.

grpcRoute — (map)
An object that represents the specification of a gRPC gateway route.

action — required — (map)
An object that represents the action to take if a match is determined.

rewrite — (map)
The gateway route action to rewrite.

hostname — (map)
The host name of the gateway route to rewrite.

defaultTargetHostname — (String)
The default target host name to write to.
Possible values include:

"ENABLED"

"DISABLED"

target — required — (map)
An object that represents the target that traffic is routed to when a request matches the gateway route.

virtualService — required — (map)
An object that represents a virtual service gateway route target.

virtualServiceName — required — (String)
The name of the virtual service that traffic is routed to.

match — required — (map)
An object that represents the criteria for determining a request match.

hostname — (map)
The gateway route host name to be matched on.

exact — (String)
The exact host name to match on.

suffix — (String)
The specified ending characters of the host name to match on.

metadata — (Array<map>)
The gateway route metadata to be matched on.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
The criteria for determining a metadata match.

exact — (String)
The exact method header to be matched on.

prefix — (String)
The specified beginning characters of the method header to be matched on.

range — (map)
An object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The regex used to match the method header.

suffix — (String)
The specified ending characters of the method header to match on.

name — required — (String)
A name for the gateway route metadata.

serviceName — (String)
The fully qualified domain name for the service to match from the request.

http2Route — (map)
An object that represents the specification of an HTTP/2 gateway route.

action — required — (map)
An object that represents the action to take if a match is determined.

rewrite — (map)
The gateway route action to rewrite.

hostname — (map)
The host name to rewrite.

defaultTargetHostname — (String)
The default target host name to write to.
Possible values include:

"ENABLED"

"DISABLED"

path — (map)
The path to rewrite.

exact — (String)
The exact path to rewrite.

prefix — (map)
The specified beginning characters to rewrite.

defaultPrefix — (String)
The default prefix used to replace the incoming route prefix when rewritten.
Possible values include:

"ENABLED"

"DISABLED"

value — (String)
The value used to replace the incoming route prefix when rewritten.

target — required — (map)
An object that represents the target that traffic is routed to when a request matches the gateway route.

virtualService — required — (map)
An object that represents a virtual service gateway route target.

virtualServiceName — required — (String)
The name of the virtual service that traffic is routed to.

match — required — (map)
An object that represents the criteria for determining a request match.

headers — (Array<map>)
The client request headers to match on.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
An object that represents the method and value to match with the header value sent in a request. Specify one match method.

exact — (String)
The value sent by the client must match the specified value exactly.

prefix — (String)
The value sent by the client must begin with the specified characters.

range — (map)
An object that represents the range of values to match on.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The value sent by the client must include the specified characters.

suffix — (String)
The value sent by the client must end with the specified characters.

name — required — (String)
A name for the HTTP header in the gateway route that will be matched on.

hostname — (map)
The host name to match on.

exact — (String)
The exact host name to match on.

suffix — (String)
The specified ending characters of the host name to match on.

method — (String)
The method to match on.
Possible values include:

"GET"

"HEAD"

"POST"

"PUT"

"DELETE"

"CONNECT"

"OPTIONS"

"TRACE"

"PATCH"

path — (map)
The path to match on.

exact — (String)
The exact path to match on.

regex — (String)
The regex used to match the path.

prefix — (String)
Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

queryParameters — (Array<map>)
The query parameter to match on.

match — (map)
The query parameter to match on.

exact — (String)
The exact query parameter to match on.

name — required — (String)
A name for the query parameter that will be matched on.

httpRoute — (map)
An object that represents the specification of an HTTP gateway route.

action — required — (map)
An object that represents the action to take if a match is determined.

rewrite — (map)
The gateway route action to rewrite.

hostname — (map)
The host name to rewrite.

defaultTargetHostname — (String)
The default target host name to write to.
Possible values include:

"ENABLED"

"DISABLED"

path — (map)
The path to rewrite.

exact — (String)
The exact path to rewrite.

prefix — (map)
The specified beginning characters to rewrite.

defaultPrefix — (String)
The default prefix used to replace the incoming route prefix when rewritten.
Possible values include:

"ENABLED"

"DISABLED"

value — (String)
The value used to replace the incoming route prefix when rewritten.

target — required — (map)
An object that represents the target that traffic is routed to when a request matches the gateway route.

virtualService — required — (map)
An object that represents a virtual service gateway route target.

virtualServiceName — required — (String)
The name of the virtual service that traffic is routed to.

match — required — (map)
An object that represents the criteria for determining a request match.

headers — (Array<map>)
The client request headers to match on.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
An object that represents the method and value to match with the header value sent in a request. Specify one match method.

exact — (String)
The value sent by the client must match the specified value exactly.

prefix — (String)
The value sent by the client must begin with the specified characters.

range — (map)
An object that represents the range of values to match on.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The value sent by the client must include the specified characters.

suffix — (String)
The value sent by the client must end with the specified characters.

name — required — (String)
A name for the HTTP header in the gateway route that will be matched on.

hostname — (map)
The host name to match on.

exact — (String)
The exact host name to match on.

suffix — (String)
The specified ending characters of the host name to match on.

method — (String)
The method to match on.
Possible values include:

"GET"

"HEAD"

"POST"

"PUT"

"DELETE"

"CONNECT"

"OPTIONS"

"TRACE"

"PATCH"

path — (map)
The path to match on.

exact — (String)
The exact path to match on.

regex — (String)
The regex used to match the path.

prefix — (String)
Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

queryParameters — (Array<map>)
The query parameter to match on.

match — (map)
The query parameter to match on.

exact — (String)
The exact query parameter to match on.

name — required — (String)
A name for the query parameter that will be matched on.

priority — (Integer)
The ordering of the gateway routes spec.

virtualGatewayName — (String)
The name of the virtual gateway that the gateway route is associated with.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

gatewayRoute — (map)
A full description of the gateway route that was updated.

gatewayRouteName — required — (String)
The name of the gateway route.

meshName — required — (String)
The name of the service mesh that the resource resides in.

metadata — required — (map)
An object that represents metadata for a resource.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

spec — required — (map)
The specifications of the gateway route.

grpcRoute — (map)
An object that represents the specification of a gRPC gateway route.

action — required — (map)
An object that represents the action to take if a match is determined.

rewrite — (map)
The gateway route action to rewrite.

hostname — (map)
The host name of the gateway route to rewrite.

defaultTargetHostname — (String)
The default target host name to write to.
Possible values include:

"ENABLED"

"DISABLED"

target — required — (map)
An object that represents the target that traffic is routed to when a request matches the gateway route.

virtualService — required — (map)
An object that represents a virtual service gateway route target.

virtualServiceName — required — (String)
The name of the virtual service that traffic is routed to.

match — required — (map)
An object that represents the criteria for determining a request match.

hostname — (map)
The gateway route host name to be matched on.

exact — (String)
The exact host name to match on.

suffix — (String)
The specified ending characters of the host name to match on.

metadata — (Array<map>)
The gateway route metadata to be matched on.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
The criteria for determining a metadata match.

exact — (String)
The exact method header to be matched on.

prefix — (String)
The specified beginning characters of the method header to be matched on.

range — (map)
An object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The regex used to match the method header.

suffix — (String)
The specified ending characters of the method header to match on.

name — required — (String)
A name for the gateway route metadata.

serviceName — (String)
The fully qualified domain name for the service to match from the request.

http2Route — (map)
An object that represents the specification of an HTTP/2 gateway route.

action — required — (map)
An object that represents the action to take if a match is determined.

rewrite — (map)
The gateway route action to rewrite.

hostname — (map)
The host name to rewrite.

defaultTargetHostname — (String)
The default target host name to write to.
Possible values include:

"ENABLED"

"DISABLED"

path — (map)
The path to rewrite.

exact — (String)
The exact path to rewrite.

prefix — (map)
The specified beginning characters to rewrite.

defaultPrefix — (String)
The default prefix used to replace the incoming route prefix when rewritten.
Possible values include:

"ENABLED"

"DISABLED"

value — (String)
The value used to replace the incoming route prefix when rewritten.

target — required — (map)
An object that represents the target that traffic is routed to when a request matches the gateway route.

virtualService — required — (map)
An object that represents a virtual service gateway route target.

virtualServiceName — required — (String)
The name of the virtual service that traffic is routed to.

match — required — (map)
An object that represents the criteria for determining a request match.

headers — (Array<map>)
The client request headers to match on.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
An object that represents the method and value to match with the header value sent in a request. Specify one match method.

exact — (String)
The value sent by the client must match the specified value exactly.

prefix — (String)
The value sent by the client must begin with the specified characters.

range — (map)
An object that represents the range of values to match on.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The value sent by the client must include the specified characters.

suffix — (String)
The value sent by the client must end with the specified characters.

name — required — (String)
A name for the HTTP header in the gateway route that will be matched on.

hostname — (map)
The host name to match on.

exact — (String)
The exact host name to match on.

suffix — (String)
The specified ending characters of the host name to match on.

method — (String)
The method to match on.
Possible values include:

"GET"

"HEAD"

"POST"

"PUT"

"DELETE"

"CONNECT"

"OPTIONS"

"TRACE"

"PATCH"

path — (map)
The path to match on.

exact — (String)
The exact path to match on.

regex — (String)
The regex used to match the path.

prefix — (String)
Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

queryParameters — (Array<map>)
The query parameter to match on.

match — (map)
The query parameter to match on.

exact — (String)
The exact query parameter to match on.

name — required — (String)
A name for the query parameter that will be matched on.

httpRoute — (map)
An object that represents the specification of an HTTP gateway route.

action — required — (map)
An object that represents the action to take if a match is determined.

rewrite — (map)
The gateway route action to rewrite.

hostname — (map)
The host name to rewrite.

defaultTargetHostname — (String)
The default target host name to write to.
Possible values include:

"ENABLED"

"DISABLED"

path — (map)
The path to rewrite.

exact — (String)
The exact path to rewrite.

prefix — (map)
The specified beginning characters to rewrite.

defaultPrefix — (String)
The default prefix used to replace the incoming route prefix when rewritten.
Possible values include:

"ENABLED"

"DISABLED"

value — (String)
The value used to replace the incoming route prefix when rewritten.

target — required — (map)
An object that represents the target that traffic is routed to when a request matches the gateway route.

virtualService — required — (map)
An object that represents a virtual service gateway route target.

virtualServiceName — required — (String)
The name of the virtual service that traffic is routed to.

match — required — (map)
An object that represents the criteria for determining a request match.

headers — (Array<map>)
The client request headers to match on.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
An object that represents the method and value to match with the header value sent in a request. Specify one match method.

exact — (String)
The value sent by the client must match the specified value exactly.

prefix — (String)
The value sent by the client must begin with the specified characters.

range — (map)
An object that represents the range of values to match on.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The value sent by the client must include the specified characters.

suffix — (String)
The value sent by the client must end with the specified characters.

name — required — (String)
A name for the HTTP header in the gateway route that will be matched on.

hostname — (map)
The host name to match on.

exact — (String)
The exact host name to match on.

suffix — (String)
The specified ending characters of the host name to match on.

method — (String)
The method to match on.
Possible values include:

"GET"

"HEAD"

"POST"

"PUT"

"DELETE"

"CONNECT"

"OPTIONS"

"TRACE"

"PATCH"

path — (map)
The path to match on.

exact — (String)
The exact path to match on.

regex — (String)
The regex used to match the path.

prefix — (String)
Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

queryParameters — (Array<map>)
The query parameter to match on.

match — (map)
The query parameter to match on.

exact — (String)
The exact query parameter to match on.

name — required — (String)
A name for the query parameter that will be matched on.

priority — (Integer)
The ordering of the gateway routes spec.

status — required — (map)
The status of the gateway route.

status — required — (String)
The current status for the gateway route.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

virtualGatewayName — required — (String)
The virtual gateway that the gateway route is associated with.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

updateMesh(params = {}, callback) ⇒ AWS.Request

Updates an existing service mesh.

Service Reference:

UpdateMesh

Examples:

Calling the updateMesh operation

var params = { meshName: 'STRING_VALUE', /* required */ clientToken: 'STRING_VALUE', spec: { egressFilter: { type: ALLOW_ALL | DROP_ALL /* required */ } } }; appmesh.updateMesh(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

clientToken — (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.
If a token is not provided, the SDK will use a version 4 UUID.

meshName — (String)
The name of the service mesh to update.

spec — (map)
The service mesh specification to apply.

egressFilter — (map)
The egress filter rules for the service mesh.

type — required — (String)
The egress filter type. By default, the type is DROP_ALL, which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to *.amazonaws.com for Amazon Web Services API calls). You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh.
Possible values include:

"ALLOW_ALL"

"DROP_ALL"

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

mesh — (map)
An object that represents a service mesh returned by a describe operation.

meshName — required — (String)
The name of the service mesh.

metadata — required — (map)
The associated metadata for the service mesh.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

spec — required — (map)
The associated specification for the service mesh.

egressFilter — (map)
The egress filter rules for the service mesh.

type — required — (String)
The egress filter type. By default, the type is DROP_ALL, which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to *.amazonaws.com for Amazon Web Services API calls). You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh.
Possible values include:

"ALLOW_ALL"

"DROP_ALL"

status — required — (map)
The status of the service mesh.

status — (String)
The current mesh status.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

updateRoute(params = {}, callback) ⇒ AWS.Request

Updates an existing route for a specified service mesh and virtual router.

Service Reference:

UpdateRoute

Examples:

Calling the updateRoute operation

var params = { meshName: 'STRING_VALUE', /* required */ routeName: 'STRING_VALUE', /* required */ spec: { /* required */ grpcRoute: { action: { /* required */ weightedTargets: [ /* required */ { virtualNode: 'STRING_VALUE', /* required */ weight: 'NUMBER_VALUE' /* required */ }, /* more items */ ] }, match: { /* required */ metadata: [ { name: 'STRING_VALUE', /* required */ invert: true || false, match: { exact: 'STRING_VALUE', prefix: 'STRING_VALUE', range: { end: 'NUMBER_VALUE', /* required */ start: 'NUMBER_VALUE' /* required */ }, regex: 'STRING_VALUE', suffix: 'STRING_VALUE' } }, /* more items */ ], methodName: 'STRING_VALUE', serviceName: 'STRING_VALUE' }, retryPolicy: { maxRetries: 'NUMBER_VALUE', /* required */ perRetryTimeout: { /* required */ unit: s | ms, value: 'NUMBER_VALUE' }, grpcRetryEvents: [ cancelled | deadline-exceeded | internal | resource-exhausted | unavailable, /* more items */ ], httpRetryEvents: [ 'STRING_VALUE', /* more items */ ], tcpRetryEvents: [ connection-error, /* more items */ ] }, timeout: { idle: { unit: s | ms, value: 'NUMBER_VALUE' }, perRequest: { unit: s | ms, value: 'NUMBER_VALUE' } } }, http2Route: { action: { /* required */ weightedTargets: [ /* required */ { virtualNode: 'STRING_VALUE', /* required */ weight: 'NUMBER_VALUE' /* required */ }, /* more items */ ] }, match: { /* required */ headers: [ { name: 'STRING_VALUE', /* required */ invert: true || false, match: { exact: 'STRING_VALUE', prefix: 'STRING_VALUE', range: { end: 'NUMBER_VALUE', /* required */ start: 'NUMBER_VALUE' /* required */ }, regex: 'STRING_VALUE', suffix: 'STRING_VALUE' } }, /* more items */ ], method: GET | HEAD | POST | PUT | DELETE | CONNECT | OPTIONS | TRACE | PATCH, path: { exact: 'STRING_VALUE', regex: 'STRING_VALUE' }, prefix: 'STRING_VALUE', queryParameters: [ { name: 'STRING_VALUE', /* required */ match: { exact: 'STRING_VALUE' } }, /* more items */ ], scheme: http | https }, retryPolicy: { maxRetries: 'NUMBER_VALUE', /* required */ perRetryTimeout: { /* required */ unit: s | ms, value: 'NUMBER_VALUE' }, httpRetryEvents: [ 'STRING_VALUE', /* more items */ ], tcpRetryEvents: [ connection-error, /* more items */ ] }, timeout: { idle: { unit: s | ms, value: 'NUMBER_VALUE' }, perRequest: { unit: s | ms, value: 'NUMBER_VALUE' } } }, httpRoute: { action: { /* required */ weightedTargets: [ /* required */ { virtualNode: 'STRING_VALUE', /* required */ weight: 'NUMBER_VALUE' /* required */ }, /* more items */ ] }, match: { /* required */ headers: [ { name: 'STRING_VALUE', /* required */ invert: true || false, match: { exact: 'STRING_VALUE', prefix: 'STRING_VALUE', range: { end: 'NUMBER_VALUE', /* required */ start: 'NUMBER_VALUE' /* required */ }, regex: 'STRING_VALUE', suffix: 'STRING_VALUE' } }, /* more items */ ], method: GET | HEAD | POST | PUT | DELETE | CONNECT | OPTIONS | TRACE | PATCH, path: { exact: 'STRING_VALUE', regex: 'STRING_VALUE' }, prefix: 'STRING_VALUE', queryParameters: [ { name: 'STRING_VALUE', /* required */ match: { exact: 'STRING_VALUE' } }, /* more items */ ], scheme: http | https }, retryPolicy: { maxRetries: 'NUMBER_VALUE', /* required */ perRetryTimeout: { /* required */ unit: s | ms, value: 'NUMBER_VALUE' }, httpRetryEvents: [ 'STRING_VALUE', /* more items */ ], tcpRetryEvents: [ connection-error, /* more items */ ] }, timeout: { idle: { unit: s | ms, value: 'NUMBER_VALUE' }, perRequest: { unit: s | ms, value: 'NUMBER_VALUE' } } }, priority: 'NUMBER_VALUE', tcpRoute: { action: { /* required */ weightedTargets: [ /* required */ { virtualNode: 'STRING_VALUE', /* required */ weight: 'NUMBER_VALUE' /* required */ }, /* more items */ ] }, timeout: { idle: { unit: s | ms, value: 'NUMBER_VALUE' } } } }, virtualRouterName: 'STRING_VALUE', /* required */ clientToken: 'STRING_VALUE', meshOwner: 'STRING_VALUE' }; appmesh.updateRoute(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

clientToken — (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.
If a token is not provided, the SDK will use a version 4 UUID.

meshName — (String)
The name of the service mesh that the route resides in.

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.

routeName — (String)
The name of the route to update.

spec — (map)
The new route specification to apply. This overwrites the existing data.

grpcRoute — (map)
An object that represents the specification of a gRPC route.

action — required — (map)
An object that represents the action to take if a match is determined.

weightedTargets — required — (Array<map>)
An object that represents the targets that traffic is routed to when a request matches the route.

virtualNode — required — (String)
The virtual node to associate with the weighted target.

weight — required — (Integer)
The relative weight of the weighted target.

match — required — (map)
An object that represents the criteria for determining a request match.

metadata — (Array<map>)
An object that represents the data to match from the request.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
An object that represents the data to match from the request.

exact — (String)
The value sent by the client must match the specified value exactly.

prefix — (String)
The value sent by the client must begin with the specified characters.

range — (map)
An object that represents the range of values to match on.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The value sent by the client must include the specified characters.

suffix — (String)
The value sent by the client must end with the specified characters.

name — required — (String)
The name of the route.

methodName — (String)
The method name to match from the request. If you specify a name, you must also specify a serviceName.

serviceName — (String)
The fully qualified domain name for the service to match from the request.

retryPolicy — (map)
An object that represents a retry policy.

grpcRetryEvents — (Array<String>)
Specify at least one of the valid values.

httpRetryEvents — (Array<String>)
Specify at least one of the following values.

server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511

gateway-error – HTTP status codes 502, 503, and 504

client-error – HTTP status code 409

stream-error – Retry on refused stream

maxRetries — required — (Integer)
The maximum number of retry attempts.

perRetryTimeout — required — (map)
The timeout for each retry attempt.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tcpRetryEvents — (Array<String>)
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.

timeout — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

http2Route — (map)
An object that represents the specification of an HTTP/2 route.

action — required — (map)
An object that represents the action to take if a match is determined.

weightedTargets — required — (Array<map>)
An object that represents the targets that traffic is routed to when a request matches the route.

virtualNode — required — (String)
The virtual node to associate with the weighted target.

weight — required — (Integer)
The relative weight of the weighted target.

match — required — (map)
An object that represents the criteria for determining a request match.

headers — (Array<map>)
The client request headers to match on.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
The HeaderMatchMethod object.

exact — (String)
The value sent by the client must match the specified value exactly.

prefix — (String)
The value sent by the client must begin with the specified characters.

range — (map)
An object that represents the range of values to match on.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The value sent by the client must include the specified characters.

suffix — (String)
The value sent by the client must end with the specified characters.

name — required — (String)
A name for the HTTP header in the client request that will be matched on.

method — (String)
The client request method to match on. Specify only one.
Possible values include:

"GET"

"HEAD"

"POST"

"PUT"

"DELETE"

"CONNECT"

"OPTIONS"

"TRACE"

"PATCH"

path — (map)
The client request path to match on.

exact — (String)
The exact path to match on.

regex — (String)
The regex used to match the path.

prefix — (String)
Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

queryParameters — (Array<map>)
The client request query parameters to match on.

match — (map)
The query parameter to match on.

exact — (String)
The exact query parameter to match on.

name — required — (String)
A name for the query parameter that will be matched on.

scheme — (String)
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
Possible values include:

"http"

"https"

retryPolicy — (map)
An object that represents a retry policy.

httpRetryEvents — (Array<String>)
Specify at least one of the following values.

server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511

gateway-error – HTTP status codes 502, 503, and 504

client-error – HTTP status code 409

stream-error – Retry on refused stream

maxRetries — required — (Integer)
The maximum number of retry attempts.

perRetryTimeout — required — (map)
The timeout for each retry attempt.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tcpRetryEvents — (Array<String>)
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.

timeout — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

httpRoute — (map)
An object that represents the specification of an HTTP route.

action — required — (map)
An object that represents the action to take if a match is determined.

weightedTargets — required — (Array<map>)
An object that represents the targets that traffic is routed to when a request matches the route.

virtualNode — required — (String)
The virtual node to associate with the weighted target.

weight — required — (Integer)
The relative weight of the weighted target.

match — required — (map)
An object that represents the criteria for determining a request match.

headers — (Array<map>)
The client request headers to match on.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
The HeaderMatchMethod object.

exact — (String)
The value sent by the client must match the specified value exactly.

prefix — (String)
The value sent by the client must begin with the specified characters.

range — (map)
An object that represents the range of values to match on.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The value sent by the client must include the specified characters.

suffix — (String)
The value sent by the client must end with the specified characters.

name — required — (String)
A name for the HTTP header in the client request that will be matched on.

method — (String)
The client request method to match on. Specify only one.
Possible values include:

"GET"

"HEAD"

"POST"

"PUT"

"DELETE"

"CONNECT"

"OPTIONS"

"TRACE"

"PATCH"

path — (map)
The client request path to match on.

exact — (String)
The exact path to match on.

regex — (String)
The regex used to match the path.

prefix — (String)
Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

queryParameters — (Array<map>)
The client request query parameters to match on.

match — (map)
The query parameter to match on.

exact — (String)
The exact query parameter to match on.

name — required — (String)
A name for the query parameter that will be matched on.

scheme — (String)
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
Possible values include:

"http"

"https"

retryPolicy — (map)
An object that represents a retry policy.

httpRetryEvents — (Array<String>)
Specify at least one of the following values.

server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511

gateway-error – HTTP status codes 502, 503, and 504

client-error – HTTP status code 409

stream-error – Retry on refused stream

maxRetries — required — (Integer)
The maximum number of retry attempts.

perRetryTimeout — required — (map)
The timeout for each retry attempt.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tcpRetryEvents — (Array<String>)
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.

timeout — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

priority — (Integer)
The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority.

tcpRoute — (map)
An object that represents the specification of a TCP route.

action — required — (map)
The action to take if a match is determined.

weightedTargets — required — (Array<map>)
An object that represents the targets that traffic is routed to when a request matches the route.

virtualNode — required — (String)
The virtual node to associate with the weighted target.

weight — required — (Integer)
The relative weight of the weighted target.

timeout — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

virtualRouterName — (String)
The name of the virtual router that the route is associated with.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

route — (map)
A full description of the route that was updated.

meshName — required — (String)
The name of the service mesh that the route resides in.

metadata — required — (map)
The associated metadata for the route.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

routeName — required — (String)
The name of the route.

spec — required — (map)
The specifications of the route.

grpcRoute — (map)
An object that represents the specification of a gRPC route.

action — required — (map)
An object that represents the action to take if a match is determined.

weightedTargets — required — (Array<map>)
An object that represents the targets that traffic is routed to when a request matches the route.

virtualNode — required — (String)
The virtual node to associate with the weighted target.

weight — required — (Integer)
The relative weight of the weighted target.

match — required — (map)
An object that represents the criteria for determining a request match.

metadata — (Array<map>)
An object that represents the data to match from the request.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
An object that represents the data to match from the request.

exact — (String)
The value sent by the client must match the specified value exactly.

prefix — (String)
The value sent by the client must begin with the specified characters.

range — (map)
An object that represents the range of values to match on.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The value sent by the client must include the specified characters.

suffix — (String)
The value sent by the client must end with the specified characters.

name — required — (String)
The name of the route.

methodName — (String)
The method name to match from the request. If you specify a name, you must also specify a serviceName.

serviceName — (String)
The fully qualified domain name for the service to match from the request.

retryPolicy — (map)
An object that represents a retry policy.

grpcRetryEvents — (Array<String>)
Specify at least one of the valid values.

httpRetryEvents — (Array<String>)
Specify at least one of the following values.

server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511

gateway-error – HTTP status codes 502, 503, and 504

client-error – HTTP status code 409

stream-error – Retry on refused stream

maxRetries — required — (Integer)
The maximum number of retry attempts.

perRetryTimeout — required — (map)
The timeout for each retry attempt.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tcpRetryEvents — (Array<String>)
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.

timeout — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

http2Route — (map)
An object that represents the specification of an HTTP/2 route.

action — required — (map)
An object that represents the action to take if a match is determined.

weightedTargets — required — (Array<map>)
An object that represents the targets that traffic is routed to when a request matches the route.

virtualNode — required — (String)
The virtual node to associate with the weighted target.

weight — required — (Integer)
The relative weight of the weighted target.

match — required — (map)
An object that represents the criteria for determining a request match.

headers — (Array<map>)
The client request headers to match on.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
The HeaderMatchMethod object.

exact — (String)
The value sent by the client must match the specified value exactly.

prefix — (String)
The value sent by the client must begin with the specified characters.

range — (map)
An object that represents the range of values to match on.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The value sent by the client must include the specified characters.

suffix — (String)
The value sent by the client must end with the specified characters.

name — required — (String)
A name for the HTTP header in the client request that will be matched on.

method — (String)
The client request method to match on. Specify only one.
Possible values include:

"GET"

"HEAD"

"POST"

"PUT"

"DELETE"

"CONNECT"

"OPTIONS"

"TRACE"

"PATCH"

path — (map)
The client request path to match on.

exact — (String)
The exact path to match on.

regex — (String)
The regex used to match the path.

prefix — (String)
Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

queryParameters — (Array<map>)
The client request query parameters to match on.

match — (map)
The query parameter to match on.

exact — (String)
The exact query parameter to match on.

name — required — (String)
A name for the query parameter that will be matched on.

scheme — (String)
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
Possible values include:

"http"

"https"

retryPolicy — (map)
An object that represents a retry policy.

httpRetryEvents — (Array<String>)
Specify at least one of the following values.

server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511

gateway-error – HTTP status codes 502, 503, and 504

client-error – HTTP status code 409

stream-error – Retry on refused stream

maxRetries — required — (Integer)
The maximum number of retry attempts.

perRetryTimeout — required — (map)
The timeout for each retry attempt.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tcpRetryEvents — (Array<String>)
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.

timeout — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

httpRoute — (map)
An object that represents the specification of an HTTP route.

action — required — (map)
An object that represents the action to take if a match is determined.

weightedTargets — required — (Array<map>)
An object that represents the targets that traffic is routed to when a request matches the route.

virtualNode — required — (String)
The virtual node to associate with the weighted target.

weight — required — (Integer)
The relative weight of the weighted target.

match — required — (map)
An object that represents the criteria for determining a request match.

headers — (Array<map>)
The client request headers to match on.

invert — (Boolean)
Specify True to match anything except the match criteria. The default value is False.

match — (map)
The HeaderMatchMethod object.

exact — (String)
The value sent by the client must match the specified value exactly.

prefix — (String)
The value sent by the client must begin with the specified characters.

range — (map)
An object that represents the range of values to match on.

end — required — (Integer)
The end of the range.

start — required — (Integer)
The start of the range.

regex — (String)
The value sent by the client must include the specified characters.

suffix — (String)
The value sent by the client must end with the specified characters.

name — required — (String)
A name for the HTTP header in the client request that will be matched on.

method — (String)
The client request method to match on. Specify only one.
Possible values include:

"GET"

"HEAD"

"POST"

"PUT"

"DELETE"

"CONNECT"

"OPTIONS"

"TRACE"

"PATCH"

path — (map)
The client request path to match on.

exact — (String)
The exact path to match on.

regex — (String)
The regex used to match the path.

prefix — (String)
Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

queryParameters — (Array<map>)
The client request query parameters to match on.

match — (map)
The query parameter to match on.

exact — (String)
The exact query parameter to match on.

name — required — (String)
A name for the query parameter that will be matched on.

scheme — (String)
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
Possible values include:

"http"

"https"

retryPolicy — (map)
An object that represents a retry policy.

httpRetryEvents — (Array<String>)
Specify at least one of the following values.

server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511

gateway-error – HTTP status codes 502, 503, and 504

client-error – HTTP status code 409

stream-error – Retry on refused stream

maxRetries — required — (Integer)
The maximum number of retry attempts.

perRetryTimeout — required — (map)
The timeout for each retry attempt.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tcpRetryEvents — (Array<String>)
Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.

timeout — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

priority — (Integer)
The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority.

tcpRoute — (map)
An object that represents the specification of a TCP route.

action — required — (map)
The action to take if a match is determined.

weightedTargets — required — (Array<map>)
An object that represents the targets that traffic is routed to when a request matches the route.

virtualNode — required — (String)
The virtual node to associate with the weighted target.

weight — required — (Integer)
The relative weight of the weighted target.

timeout — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

status — required — (map)
The status of the route.

status — required — (String)
The current status for the route.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

virtualRouterName — required — (String)
The virtual router that the route is associated with.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

updateVirtualGateway(params = {}, callback) ⇒ AWS.Request

Updates an existing virtual gateway in a specified service mesh.

Service Reference:

UpdateVirtualGateway

Examples:

Calling the updateVirtualGateway operation

var params = { meshName: 'STRING_VALUE', /* required */ spec: { /* required */ listeners: [ /* required */ { portMapping: { /* required */ port: 'NUMBER_VALUE', /* required */ protocol: http | http2 | grpc /* required */ }, connectionPool: { grpc: { maxRequests: 'NUMBER_VALUE' /* required */ }, http: { maxConnections: 'NUMBER_VALUE', /* required */ maxPendingRequests: 'NUMBER_VALUE' }, http2: { maxRequests: 'NUMBER_VALUE' /* required */ } }, healthCheck: { healthyThreshold: 'NUMBER_VALUE', /* required */ intervalMillis: 'NUMBER_VALUE', /* required */ protocol: http | http2 | grpc, /* required */ timeoutMillis: 'NUMBER_VALUE', /* required */ unhealthyThreshold: 'NUMBER_VALUE', /* required */ path: 'STRING_VALUE', port: 'NUMBER_VALUE' }, tls: { certificate: { /* required */ acm: { certificateArn: 'STRING_VALUE' /* required */ }, file: { certificateChain: 'STRING_VALUE', /* required */ privateKey: 'STRING_VALUE' /* required */ }, sds: { secretName: 'STRING_VALUE' /* required */ } }, mode: STRICT | PERMISSIVE | DISABLED, /* required */ validation: { trust: { /* required */ file: { certificateChain: 'STRING_VALUE' /* required */ }, sds: { secretName: 'STRING_VALUE' /* required */ } }, subjectAlternativeNames: { match: { /* required */ exact: [ /* required */ 'STRING_VALUE', /* more items */ ] } } } } }, /* more items */ ], backendDefaults: { clientPolicy: { tls: { validation: { /* required */ trust: { /* required */ acm: { certificateAuthorityArns: [ /* required */ 'STRING_VALUE', /* more items */ ] }, file: { certificateChain: 'STRING_VALUE' /* required */ }, sds: { secretName: 'STRING_VALUE' /* required */ } }, subjectAlternativeNames: { match: { /* required */ exact: [ /* required */ 'STRING_VALUE', /* more items */ ] } } }, certificate: { file: { certificateChain: 'STRING_VALUE', /* required */ privateKey: 'STRING_VALUE' /* required */ }, sds: { secretName: 'STRING_VALUE' /* required */ } }, enforce: true || false, ports: [ 'NUMBER_VALUE', /* more items */ ] } } }, logging: { accessLog: { file: { path: 'STRING_VALUE' /* required */ } } } }, virtualGatewayName: 'STRING_VALUE', /* required */ clientToken: 'STRING_VALUE', meshOwner: 'STRING_VALUE' }; appmesh.updateVirtualGateway(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

clientToken — (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.
If a token is not provided, the SDK will use a version 4 UUID.

meshName — (String)
The name of the service mesh that the virtual gateway resides in.

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.

spec — (map)
The new virtual gateway specification to apply. This overwrites the existing data.

backendDefaults — (map)
A reference to an object that represents the defaults for backends.

clientPolicy — (map)
A reference to an object that represents a client policy.

tls — (map)
A reference to an object that represents a Transport Layer Security (TLS) client policy.

certificate — (map)
A reference to an object that represents a virtual gateway's client's Transport Layer Security (TLS) certificate.

file — (map)
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS) .

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.

sds — (map)
A reference to an object that represents a virtual gateway's client's Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

enforce — (Boolean)
Whether the policy is enforced. The default is True, if a value isn't specified.

ports — (Array<Integer>)
One or more ports that the policy is enforced for.

validation — required — (map)
A reference to an object that represents a Transport Layer Security (TLS) validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a virtual gateway's listener's Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.

certificateAuthorityArns — required — (Array<String>)
One or more ACM Amazon Resource Name (ARN)s.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

listeners — required — (Array<map>)
The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.

connectionPool — (map)
The connection pool information for the virtual gateway listener.

grpc — (map)
An object that represents a type of connection pool.

maxRequests — required — (Integer)
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

http — (map)
An object that represents a type of connection pool.

maxConnections — required — (Integer)
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.

maxPendingRequests — (Integer)
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.

http2 — (map)
An object that represents a type of connection pool.

maxRequests — required — (Integer)
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

healthCheck — (map)
The health check information for the listener.

healthyThreshold — required — (Integer)
The number of consecutive successful health checks that must occur before declaring the listener healthy.

intervalMillis — required — (Integer)
The time period in milliseconds between each health check execution.

path — (String)
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

port — (Integer)
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

protocol — required — (String)
The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
Possible values include:

"http"

"http2"

"grpc"

timeoutMillis — required — (Integer)
The amount of time to wait when receiving a response from the health check, in milliseconds.

unhealthyThreshold — required — (Integer)
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.

portMapping — required — (map)
The port mapping information for the listener.

port — required — (Integer)
The port used for the port mapping. Specify one protocol.

protocol — required — (String)
The protocol used for the port mapping.
Possible values include:

"http"

"http2"

"grpc"

tls — (map)
A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.

certificate — required — (map)
An object that represents a Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents an Certificate Manager certificate.

certificateArn — required — (String)
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

file — (map)
A reference to an object that represents a local file certificate.

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.

sds — (map)
A reference to an object that represents a virtual gateway's listener's Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

mode — required — (String)
Specify one of the following modes.

STRICT – Listener only accepts connections with TLS enabled.

PERMISSIVE – Listener accepts connections with or without TLS enabled.

DISABLED – Listener only accepts connections without TLS.

Possible values include:

"STRICT"

"PERMISSIVE"

"DISABLED"

validation — (map)
A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a virtual gateway listener's Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

logging — (map)
An object that represents logging information.

accessLog — (map)
The access log configuration.

file — (map)
The file object to send virtual gateway access logs to.

path — required — (String)
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.

virtualGatewayName — (String)
The name of the virtual gateway to update.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

virtualGateway — (map)
A full description of the virtual gateway that was updated.

meshName — required — (String)
The name of the service mesh that the virtual gateway resides in.

metadata — required — (map)
An object that represents metadata for a resource.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

spec — required — (map)
The specifications of the virtual gateway.

backendDefaults — (map)
A reference to an object that represents the defaults for backends.

clientPolicy — (map)
A reference to an object that represents a client policy.

tls — (map)
A reference to an object that represents a Transport Layer Security (TLS) client policy.

certificate — (map)
A reference to an object that represents a virtual gateway's client's Transport Layer Security (TLS) certificate.

file — (map)
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS) .

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.

sds — (map)
A reference to an object that represents a virtual gateway's client's Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

enforce — (Boolean)
Whether the policy is enforced. The default is True, if a value isn't specified.

ports — (Array<Integer>)
One or more ports that the policy is enforced for.

validation — required — (map)
A reference to an object that represents a Transport Layer Security (TLS) validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a virtual gateway's listener's Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.

certificateAuthorityArns — required — (Array<String>)
One or more ACM Amazon Resource Name (ARN)s.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

listeners — required — (Array<map>)
The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.

connectionPool — (map)
The connection pool information for the virtual gateway listener.

grpc — (map)
An object that represents a type of connection pool.

maxRequests — required — (Integer)
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

http — (map)
An object that represents a type of connection pool.

maxConnections — required — (Integer)
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.

maxPendingRequests — (Integer)
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.

http2 — (map)
An object that represents a type of connection pool.

maxRequests — required — (Integer)
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

healthCheck — (map)
The health check information for the listener.

healthyThreshold — required — (Integer)
The number of consecutive successful health checks that must occur before declaring the listener healthy.

intervalMillis — required — (Integer)
The time period in milliseconds between each health check execution.

path — (String)
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

port — (Integer)
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

protocol — required — (String)
The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
Possible values include:

"http"

"http2"

"grpc"

timeoutMillis — required — (Integer)
The amount of time to wait when receiving a response from the health check, in milliseconds.

unhealthyThreshold — required — (Integer)
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.

portMapping — required — (map)
The port mapping information for the listener.

port — required — (Integer)
The port used for the port mapping. Specify one protocol.

protocol — required — (String)
The protocol used for the port mapping.
Possible values include:

"http"

"http2"

"grpc"

tls — (map)
A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.

certificate — required — (map)
An object that represents a Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents an Certificate Manager certificate.

certificateArn — required — (String)
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

file — (map)
A reference to an object that represents a local file certificate.

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.

sds — (map)
A reference to an object that represents a virtual gateway's listener's Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

mode — required — (String)
Specify one of the following modes.

STRICT – Listener only accepts connections with TLS enabled.

PERMISSIVE – Listener accepts connections with or without TLS enabled.

DISABLED – Listener only accepts connections without TLS.

Possible values include:

"STRICT"

"PERMISSIVE"

"DISABLED"

validation — (map)
A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a virtual gateway listener's Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

logging — (map)
An object that represents logging information.

accessLog — (map)
The access log configuration.

file — (map)
The file object to send virtual gateway access logs to.

path — required — (String)
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.

status — required — (map)
The current status of the virtual gateway.

status — required — (String)
The current status.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

virtualGatewayName — required — (String)
The name of the virtual gateway.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

updateVirtualNode(params = {}, callback) ⇒ AWS.Request

Updates an existing virtual node in a specified service mesh.

Service Reference:

UpdateVirtualNode

Examples:

Calling the updateVirtualNode operation

var params = { meshName: 'STRING_VALUE', /* required */ spec: { /* required */ backendDefaults: { clientPolicy: { tls: { validation: { /* required */ trust: { /* required */ acm: { certificateAuthorityArns: [ /* required */ 'STRING_VALUE', /* more items */ ] }, file: { certificateChain: 'STRING_VALUE' /* required */ }, sds: { secretName: 'STRING_VALUE' /* required */ } }, subjectAlternativeNames: { match: { /* required */ exact: [ /* required */ 'STRING_VALUE', /* more items */ ] } } }, certificate: { file: { certificateChain: 'STRING_VALUE', /* required */ privateKey: 'STRING_VALUE' /* required */ }, sds: { secretName: 'STRING_VALUE' /* required */ } }, enforce: true || false, ports: [ 'NUMBER_VALUE', /* more items */ ] } } }, backends: [ { virtualService: { virtualServiceName: 'STRING_VALUE', /* required */ clientPolicy: { tls: { validation: { /* required */ trust: { /* required */ acm: { certificateAuthorityArns: [ /* required */ 'STRING_VALUE', /* more items */ ] }, file: { certificateChain: 'STRING_VALUE' /* required */ }, sds: { secretName: 'STRING_VALUE' /* required */ } }, subjectAlternativeNames: { match: { /* required */ exact: [ /* required */ 'STRING_VALUE', /* more items */ ] } } }, certificate: { file: { certificateChain: 'STRING_VALUE', /* required */ privateKey: 'STRING_VALUE' /* required */ }, sds: { secretName: 'STRING_VALUE' /* required */ } }, enforce: true || false, ports: [ 'NUMBER_VALUE', /* more items */ ] } } } }, /* more items */ ], listeners: [ { portMapping: { /* required */ port: 'NUMBER_VALUE', /* required */ protocol: http | tcp | http2 | grpc /* required */ }, connectionPool: { grpc: { maxRequests: 'NUMBER_VALUE' /* required */ }, http: { maxConnections: 'NUMBER_VALUE', /* required */ maxPendingRequests: 'NUMBER_VALUE' }, http2: { maxRequests: 'NUMBER_VALUE' /* required */ }, tcp: { maxConnections: 'NUMBER_VALUE' /* required */ } }, healthCheck: { healthyThreshold: 'NUMBER_VALUE', /* required */ intervalMillis: 'NUMBER_VALUE', /* required */ protocol: http | tcp | http2 | grpc, /* required */ timeoutMillis: 'NUMBER_VALUE', /* required */ unhealthyThreshold: 'NUMBER_VALUE', /* required */ path: 'STRING_VALUE', port: 'NUMBER_VALUE' }, outlierDetection: { baseEjectionDuration: { /* required */ unit: s | ms, value: 'NUMBER_VALUE' }, interval: { /* required */ unit: s | ms, value: 'NUMBER_VALUE' }, maxEjectionPercent: 'NUMBER_VALUE', /* required */ maxServerErrors: 'NUMBER_VALUE' /* required */ }, timeout: { grpc: { idle: { unit: s | ms, value: 'NUMBER_VALUE' }, perRequest: { unit: s | ms, value: 'NUMBER_VALUE' } }, http: { idle: { unit: s | ms, value: 'NUMBER_VALUE' }, perRequest: { unit: s | ms, value: 'NUMBER_VALUE' } }, http2: { idle: { unit: s | ms, value: 'NUMBER_VALUE' }, perRequest: { unit: s | ms, value: 'NUMBER_VALUE' } }, tcp: { idle: { unit: s | ms, value: 'NUMBER_VALUE' } } }, tls: { certificate: { /* required */ acm: { certificateArn: 'STRING_VALUE' /* required */ }, file: { certificateChain: 'STRING_VALUE', /* required */ privateKey: 'STRING_VALUE' /* required */ }, sds: { secretName: 'STRING_VALUE' /* required */ } }, mode: STRICT | PERMISSIVE | DISABLED, /* required */ validation: { trust: { /* required */ file: { certificateChain: 'STRING_VALUE' /* required */ }, sds: { secretName: 'STRING_VALUE' /* required */ } }, subjectAlternativeNames: { match: { /* required */ exact: [ /* required */ 'STRING_VALUE', /* more items */ ] } } } } }, /* more items */ ], logging: { accessLog: { file: { path: 'STRING_VALUE' /* required */ } } }, serviceDiscovery: { awsCloudMap: { namespaceName: 'STRING_VALUE', /* required */ serviceName: 'STRING_VALUE', /* required */ attributes: [ { key: 'STRING_VALUE', /* required */ value: 'STRING_VALUE' /* required */ }, /* more items */ ] }, dns: { hostname: 'STRING_VALUE', /* required */ responseType: LOADBALANCER | ENDPOINTS } } }, virtualNodeName: 'STRING_VALUE', /* required */ clientToken: 'STRING_VALUE', meshOwner: 'STRING_VALUE' }; appmesh.updateVirtualNode(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

clientToken — (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.
If a token is not provided, the SDK will use a version 4 UUID.

meshName — (String)
The name of the service mesh that the virtual node resides in.

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.

spec — (map)
The new virtual node specification to apply. This overwrites the existing data.

backendDefaults — (map)
A reference to an object that represents the defaults for backends.

clientPolicy — (map)
A reference to an object that represents a client policy.

tls — (map)
A reference to an object that represents a Transport Layer Security (TLS) client policy.

certificate — (map)
A reference to an object that represents a client's TLS certificate.

file — (map)
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a client's TLS Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

enforce — (Boolean)
Whether the policy is enforced. The default is True, if a value isn't specified.

ports — (Array<Integer>)
One or more ports that the policy is enforced for.

validation — required — (map)
A reference to an object that represents a TLS validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.

certificateAuthorityArns — required — (Array<String>)
One or more ACM Amazon Resource Name (ARN)s.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

backends — (Array<map>)
The backends that the virtual node is expected to send outbound traffic to.

virtualService — (map)
Specifies a virtual service to use as a backend.

clientPolicy — (map)
A reference to an object that represents the client policy for a backend.

tls — (map)
A reference to an object that represents a Transport Layer Security (TLS) client policy.

certificate — (map)
A reference to an object that represents a client's TLS certificate.

file — (map)
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a client's TLS Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

enforce — (Boolean)
Whether the policy is enforced. The default is True, if a value isn't specified.

ports — (Array<Integer>)
One or more ports that the policy is enforced for.

validation — required — (map)
A reference to an object that represents a TLS validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.

certificateAuthorityArns — required — (Array<String>)
One or more ACM Amazon Resource Name (ARN)s.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

virtualServiceName — required — (String)
The name of the virtual service that is acting as a virtual node backend.

listeners — (Array<map>)
The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.

connectionPool — (map)
The connection pool information for the listener.

grpc — (map)
An object that represents a type of connection pool.

maxRequests — required — (Integer)
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

http — (map)
An object that represents a type of connection pool.

maxConnections — required — (Integer)
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.

maxPendingRequests — (Integer)
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.

http2 — (map)
An object that represents a type of connection pool.

maxRequests — required — (Integer)
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

tcp — (map)
An object that represents a type of connection pool.

maxConnections — required — (Integer)
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.

healthCheck — (map)
The health check information for the listener.

healthyThreshold — required — (Integer)
The number of consecutive successful health checks that must occur before declaring listener healthy.

intervalMillis — required — (Integer)
The time period in milliseconds between each health check execution.

path — (String)
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

port — (Integer)
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

protocol — required — (String)
The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
Possible values include:

"http"

"tcp"

"http2"

"grpc"

timeoutMillis — required — (Integer)
The amount of time to wait when receiving a response from the health check, in milliseconds.

unhealthyThreshold — required — (Integer)
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

outlierDetection — (map)
The outlier detection information for the listener.

baseEjectionDuration — required — (map)
The base amount of time for which a host is ejected.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

interval — required — (map)
The time interval between ejection sweep analysis.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

maxEjectionPercent — required — (Integer)
Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.

maxServerErrors — required — (Integer)
Number of consecutive 5xx errors required for ejection.

portMapping — required — (map)
The port mapping information for the listener.

port — required — (Integer)
The port used for the port mapping.

protocol — required — (String)
The protocol used for the port mapping. Specify one protocol.
Possible values include:

"http"

"tcp"

"http2"

"grpc"

timeout — (map)
An object that represents timeouts for different protocols.

grpc — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

http — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

http2 — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tcp — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tls — (map)
A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.

certificate — required — (map)
A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.

certificateArn — required — (String)
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

file — (map)
A reference to an object that represents a local file certificate.

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a listener's Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

mode — required — (String)
Specify one of the following modes.

STRICT – Listener only accepts connections with TLS enabled.

PERMISSIVE – Listener accepts connections with or without TLS enabled.

DISABLED – Listener only accepts connections without TLS.

Possible values include:

"STRICT"

"PERMISSIVE"

"DISABLED"

validation — (map)
A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

logging — (map)
The inbound and outbound access logging information for the virtual node.

accessLog — (map)
The access log configuration for a virtual node.

file — (map)
The file object to send virtual node access logs to.

path — required — (String)
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.

Note: The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.

serviceDiscovery — (map)
The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a listener, then you must specify service discovery information.

awsCloudMap — (map)
Specifies any Cloud Map information for the virtual node.

attributes — (Array<map>)
A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.

key — required — (String)
The name of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.

value — required — (String)
The value of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.

namespaceName — required — (String)
The name of the Cloud Map namespace to use.

serviceName — required — (String)
The name of the Cloud Map service to use.

dns — (map)
Specifies the DNS information for the virtual node.

hostname — required — (String)
Specifies the DNS service discovery hostname for the virtual node.

responseType — (String)
Specifies the DNS response type for the virtual node.
Possible values include:

"LOADBALANCER"

"ENDPOINTS"

virtualNodeName — (String)
The name of the virtual node to update.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

virtualNode — (map)
A full description of the virtual node that was updated.

meshName — required — (String)
The name of the service mesh that the virtual node resides in.

metadata — required — (map)
The associated metadata for the virtual node.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

spec — required — (map)
The specifications of the virtual node.

backendDefaults — (map)
A reference to an object that represents the defaults for backends.

clientPolicy — (map)
A reference to an object that represents a client policy.

tls — (map)
A reference to an object that represents a Transport Layer Security (TLS) client policy.

certificate — (map)
A reference to an object that represents a client's TLS certificate.

file — (map)
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a client's TLS Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

enforce — (Boolean)
Whether the policy is enforced. The default is True, if a value isn't specified.

ports — (Array<Integer>)
One or more ports that the policy is enforced for.

validation — required — (map)
A reference to an object that represents a TLS validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.

certificateAuthorityArns — required — (Array<String>)
One or more ACM Amazon Resource Name (ARN)s.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

backends — (Array<map>)
The backends that the virtual node is expected to send outbound traffic to.

virtualService — (map)
Specifies a virtual service to use as a backend.

clientPolicy — (map)
A reference to an object that represents the client policy for a backend.

tls — (map)
A reference to an object that represents a Transport Layer Security (TLS) client policy.

certificate — (map)
A reference to an object that represents a client's TLS certificate.

file — (map)
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a client's TLS Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

enforce — (Boolean)
Whether the policy is enforced. The default is True, if a value isn't specified.

ports — (Array<Integer>)
One or more ports that the policy is enforced for.

validation — required — (map)
A reference to an object that represents a TLS validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.

certificateAuthorityArns — required — (Array<String>)
One or more ACM Amazon Resource Name (ARN)s.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

virtualServiceName — required — (String)
The name of the virtual service that is acting as a virtual node backend.

listeners — (Array<map>)
The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.

connectionPool — (map)
The connection pool information for the listener.

grpc — (map)
An object that represents a type of connection pool.

maxRequests — required — (Integer)
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

http — (map)
An object that represents a type of connection pool.

maxConnections — required — (Integer)
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.

maxPendingRequests — (Integer)
Number of overflowing requests after max_connections Envoy will queue to upstream cluster.

http2 — (map)
An object that represents a type of connection pool.

maxRequests — required — (Integer)
Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

tcp — (map)
An object that represents a type of connection pool.

maxConnections — required — (Integer)
Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.

healthCheck — (map)
The health check information for the listener.

healthyThreshold — required — (Integer)
The number of consecutive successful health checks that must occur before declaring listener healthy.

intervalMillis — required — (Integer)
The time period in milliseconds between each health check execution.

path — (String)
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

port — (Integer)
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

protocol — required — (String)
The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
Possible values include:

"http"

"tcp"

"http2"

"grpc"

timeoutMillis — required — (Integer)
The amount of time to wait when receiving a response from the health check, in milliseconds.

unhealthyThreshold — required — (Integer)
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

outlierDetection — (map)
The outlier detection information for the listener.

baseEjectionDuration — required — (map)
The base amount of time for which a host is ejected.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

interval — required — (map)
The time interval between ejection sweep analysis.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

maxEjectionPercent — required — (Integer)
Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.

maxServerErrors — required — (Integer)
Number of consecutive 5xx errors required for ejection.

portMapping — required — (map)
The port mapping information for the listener.

port — required — (Integer)
The port used for the port mapping.

protocol — required — (String)
The protocol used for the port mapping. Specify one protocol.
Possible values include:

"http"

"tcp"

"http2"

"grpc"

timeout — (map)
An object that represents timeouts for different protocols.

grpc — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

http — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

http2 — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

perRequest — (map)
An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tcp — (map)
An object that represents types of timeouts.

idle — (map)
An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

unit — (String)
A unit of time.
Possible values include:

"s"

"ms"

value — (Integer)
A number of time units.

tls — (map)
A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.

certificate — required — (map)
A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.

acm — (map)
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.

certificateArn — required — (String)
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

file — (map)
A reference to an object that represents a local file certificate.

certificateChain — required — (String)
The certificate chain for the certificate.

privateKey — required — (String)
The private key for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a listener's Secret Discovery Service certificate.

secretName — required — (String)
A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

mode — required — (String)
Specify one of the following modes.

STRICT – Listener only accepts connections with TLS enabled.

PERMISSIVE – Listener accepts connections with or without TLS enabled.

DISABLED – Listener only accepts connections without TLS.

Possible values include:

"STRICT"

"PERMISSIVE"

"DISABLED"

validation — (map)
A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.

subjectAlternativeNames — (map)
A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.

match — required — (map)
An object that represents the criteria for determining a SANs match.

exact — required — (Array<String>)
The values sent must match the specified values exactly.

trust — required — (map)
A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

file — (map)
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

certificateChain — required — (String)
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

sds — (map)
A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

secretName — required — (String)
A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

logging — (map)
The inbound and outbound access logging information for the virtual node.

accessLog — (map)
The access log configuration for a virtual node.

file — (map)
The file object to send virtual node access logs to.

path — required — (String)
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.

Note: The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.

serviceDiscovery — (map)
The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a listener, then you must specify service discovery information.

awsCloudMap — (map)
Specifies any Cloud Map information for the virtual node.

attributes — (Array<map>)
A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.

key — required — (String)
The name of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.

value — required — (String)
The value of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.

namespaceName — required — (String)
The name of the Cloud Map namespace to use.

serviceName — required — (String)
The name of the Cloud Map service to use.

dns — (map)
Specifies the DNS information for the virtual node.

hostname — required — (String)
Specifies the DNS service discovery hostname for the virtual node.

responseType — (String)
Specifies the DNS response type for the virtual node.
Possible values include:

"LOADBALANCER"

"ENDPOINTS"

status — required — (map)
The current status for the virtual node.

status — required — (String)
The current status of the virtual node.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

virtualNodeName — required — (String)
The name of the virtual node.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

updateVirtualRouter(params = {}, callback) ⇒ AWS.Request

Updates an existing virtual router in a specified service mesh.

Service Reference:

UpdateVirtualRouter

Examples:

Calling the updateVirtualRouter operation

var params = { meshName: 'STRING_VALUE', /* required */ spec: { /* required */ listeners: [ { portMapping: { /* required */ port: 'NUMBER_VALUE', /* required */ protocol: http | tcp | http2 | grpc /* required */ } }, /* more items */ ] }, virtualRouterName: 'STRING_VALUE', /* required */ clientToken: 'STRING_VALUE', meshOwner: 'STRING_VALUE' }; appmesh.updateVirtualRouter(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

clientToken — (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.
If a token is not provided, the SDK will use a version 4 UUID.

meshName — (String)
The name of the service mesh that the virtual router resides in.

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.

spec — (map)
The new virtual router specification to apply. This overwrites the existing data.

listeners — (Array<map>)
The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.

portMapping — required — (map)
An object that represents a port mapping.

port — required — (Integer)
The port used for the port mapping.

protocol — required — (String)
The protocol used for the port mapping. Specify one protocol.
Possible values include:

"http"

"tcp"

"http2"

"grpc"

virtualRouterName — (String)
The name of the virtual router to update.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

virtualRouter — (map)
A full description of the virtual router that was updated.

meshName — required — (String)
The name of the service mesh that the virtual router resides in.

metadata — required — (map)
The associated metadata for the virtual router.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

spec — required — (map)
The specifications of the virtual router.

listeners — (Array<map>)
The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.

portMapping — required — (map)
An object that represents a port mapping.

port — required — (Integer)
The port used for the port mapping.

protocol — required — (String)
The protocol used for the port mapping. Specify one protocol.
Possible values include:

"http"

"tcp"

"http2"

"grpc"

status — required — (map)
The current status of the virtual router.

status — required — (String)
The current status of the virtual router.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

virtualRouterName — required — (String)
The name of the virtual router.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

updateVirtualService(params = {}, callback) ⇒ AWS.Request

Updates an existing virtual service in a specified service mesh.

Service Reference:

UpdateVirtualService

Examples:

Calling the updateVirtualService operation

var params = { meshName: 'STRING_VALUE', /* required */ spec: { /* required */ provider: { virtualNode: { virtualNodeName: 'STRING_VALUE' /* required */ }, virtualRouter: { virtualRouterName: 'STRING_VALUE' /* required */ } } }, virtualServiceName: 'STRING_VALUE', /* required */ clientToken: 'STRING_VALUE', meshOwner: 'STRING_VALUE' }; appmesh.updateVirtualService(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });

Parameters:

params (Object) (defaults to: {}) —

clientToken — (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.
If a token is not provided, the SDK will use a version 4 UUID.

meshName — (String)
The name of the service mesh that the virtual service resides in.

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.

spec — (map)
The new virtual service specification to apply. This overwrites the existing data.

provider — (map)
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 — (map)
The virtual node associated with a virtual service.

virtualNodeName — required — (String)
The name of the virtual node that is acting as a service provider.

virtualRouter — (map)
The virtual router associated with a virtual service.

virtualRouterName — required — (String)
The name of the virtual router that is acting as a service provider.

virtualServiceName — (String)
The name of the virtual service to update.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

Context (this):

(AWS.Response) —
the response object containing error, data properties, and the original request object.

Parameters:

err (Error) —
the error object returned from the request. Set to null if the request is successful.

data (Object) —
the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

virtualService — (map)
A full description of the virtual service that was updated.

meshName — required — (String)
The name of the service mesh that the virtual service resides in.

metadata — required — (map)
An object that represents metadata for a resource.

arn — required — (String)
The full Amazon Resource Name (ARN) for the resource.

createdAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was created.

lastUpdatedAt — required — (Date)
The Unix epoch timestamp in seconds for when the resource was last updated.

meshOwner — required — (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 — required — (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 — required — (String)
The unique identifier for the resource.

version — required — (Integer)
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

spec — required — (map)
The specifications of the virtual service.

provider — (map)
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 — (map)
The virtual node associated with a virtual service.

virtualNodeName — required — (String)
The name of the virtual node that is acting as a service provider.

virtualRouter — (map)
The virtual router associated with a virtual service.

virtualRouterName — required — (String)
The name of the virtual router that is acting as a service provider.

status — required — (map)
The current status of the virtual service.

status — required — (String)
The current status of the virtual service.
Possible values include:

"ACTIVE"

"INACTIVE"

"DELETED"

virtualServiceName — required — (String)
The name of the virtual service.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

Generated on Wed Nov 10 23:38:59 2021 by yard 0.9.26 (ruby-2.3.8).

Class: AWS.AppMesh

Overview

Service Description

Sending a Request Using AppMesh

Locking the API Version

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

Method Summary collapse

Methods inherited from AWS.Service

Constructor Details

new AWS.AppMesh(options = {}) ⇒ Object

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

createGatewayRoute(params = {}, callback) ⇒ AWS.Request

createMesh(params = {}, callback) ⇒ AWS.Request

createRoute(params = {}, callback) ⇒ AWS.Request

createVirtualGateway(params = {}, callback) ⇒ AWS.Request

createVirtualNode(params = {}, callback) ⇒ AWS.Request

createVirtualRouter(params = {}, callback) ⇒ AWS.Request

createVirtualService(params = {}, callback) ⇒ AWS.Request

deleteGatewayRoute(params = {}, callback) ⇒ AWS.Request

deleteMesh(params = {}, callback) ⇒ AWS.Request

deleteRoute(params = {}, callback) ⇒ AWS.Request

deleteVirtualGateway(params = {}, callback) ⇒ AWS.Request

deleteVirtualNode(params = {}, callback) ⇒ AWS.Request

deleteVirtualRouter(params = {}, callback) ⇒ AWS.Request

deleteVirtualService(params = {}, callback) ⇒ AWS.Request

describeGatewayRoute(params = {}, callback) ⇒ AWS.Request

describeMesh(params = {}, callback) ⇒ AWS.Request

describeRoute(params = {}, callback) ⇒ AWS.Request

describeVirtualGateway(params = {}, callback) ⇒ AWS.Request

describeVirtualNode(params = {}, callback) ⇒ AWS.Request

describeVirtualRouter(params = {}, callback) ⇒ AWS.Request

describeVirtualService(params = {}, callback) ⇒ AWS.Request

listGatewayRoutes(params = {}, callback) ⇒ AWS.Request

listMeshes(params = {}, callback) ⇒ AWS.Request

listRoutes(params = {}, callback) ⇒ AWS.Request

listTagsForResource(params = {}, callback) ⇒ AWS.Request

listVirtualGateways(params = {}, callback) ⇒ AWS.Request

listVirtualNodes(params = {}, callback) ⇒ AWS.Request

listVirtualRouters(params = {}, callback) ⇒ AWS.Request

listVirtualServices(params = {}, callback) ⇒ AWS.Request

tagResource(params = {}, callback) ⇒ AWS.Request

untagResource(params = {}, callback) ⇒ AWS.Request

updateGatewayRoute(params = {}, callback) ⇒ AWS.Request

updateMesh(params = {}, callback) ⇒ AWS.Request

updateRoute(params = {}, callback) ⇒ AWS.Request

updateVirtualGateway(params = {}, callback) ⇒ AWS.Request

updateVirtualNode(params = {}, callback) ⇒ AWS.Request

updateVirtualRouter(params = {}, callback) ⇒ AWS.Request

updateVirtualService(params = {}, callback) ⇒ AWS.Request

new AWS.AppMesh(options = {}) ⇒ `Object`

endpoint ⇒ `AWS.Endpoint` (readwrite)

createGatewayRoute(params = {}, callback) ⇒ `AWS.Request`

createMesh(params = {}, callback) ⇒ `AWS.Request`

createRoute(params = {}, callback) ⇒ `AWS.Request`

createVirtualGateway(params = {}, callback) ⇒ `AWS.Request`

createVirtualNode(params = {}, callback) ⇒ `AWS.Request`

createVirtualRouter(params = {}, callback) ⇒ `AWS.Request`

createVirtualService(params = {}, callback) ⇒ `AWS.Request`

deleteGatewayRoute(params = {}, callback) ⇒ `AWS.Request`

deleteMesh(params = {}, callback) ⇒ `AWS.Request`

deleteRoute(params = {}, callback) ⇒ `AWS.Request`

deleteVirtualGateway(params = {}, callback) ⇒ `AWS.Request`

deleteVirtualNode(params = {}, callback) ⇒ `AWS.Request`

deleteVirtualRouter(params = {}, callback) ⇒ `AWS.Request`

deleteVirtualService(params = {}, callback) ⇒ `AWS.Request`

describeGatewayRoute(params = {}, callback) ⇒ `AWS.Request`

describeMesh(params = {}, callback) ⇒ `AWS.Request`

describeRoute(params = {}, callback) ⇒ `AWS.Request`

describeVirtualGateway(params = {}, callback) ⇒ `AWS.Request`

describeVirtualNode(params = {}, callback) ⇒ `AWS.Request`

describeVirtualRouter(params = {}, callback) ⇒ `AWS.Request`

describeVirtualService(params = {}, callback) ⇒ `AWS.Request`

listGatewayRoutes(params = {}, callback) ⇒ `AWS.Request`

listMeshes(params = {}, callback) ⇒ `AWS.Request`

listRoutes(params = {}, callback) ⇒ `AWS.Request`

listTagsForResource(params = {}, callback) ⇒ `AWS.Request`

listVirtualGateways(params = {}, callback) ⇒ `AWS.Request`

listVirtualNodes(params = {}, callback) ⇒ `AWS.Request`

listVirtualRouters(params = {}, callback) ⇒ `AWS.Request`

listVirtualServices(params = {}, callback) ⇒ `AWS.Request`

tagResource(params = {}, callback) ⇒ `AWS.Request`

untagResource(params = {}, callback) ⇒ `AWS.Request`

updateGatewayRoute(params = {}, callback) ⇒ `AWS.Request`

updateMesh(params = {}, callback) ⇒ `AWS.Request`

updateRoute(params = {}, callback) ⇒ `AWS.Request`

updateVirtualGateway(params = {}, callback) ⇒ `AWS.Request`

updateVirtualNode(params = {}, callback) ⇒ `AWS.Request`

updateVirtualRouter(params = {}, callback) ⇒ `AWS.Request`

updateVirtualService(params = {}, callback) ⇒ `AWS.Request`