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 (2018-10-01)

Inherits:

AWS.Service

Object
AWS.Service
AWS.AppMesh_20181001

show all

Identifier:: appmesh

API Version:: 2018-10-01

Defined in:: (unknown)

Overview

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

Service Description

AWS App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and control containerized 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 ECS (using the Amazon EC2 launch type), Amazon EKS, and Kubernetes on AWS.

Note: App Mesh supports containerized microservice applications that use service discovery naming for their components. To use App Mesh, you must have a containerized application running on Amazon EC2 instances, hosted in either Amazon ECS, Amazon EKS, or Kubernetes on AWS. For more information about service discovery on Amazon ECS, see Service Discovery in the Amazon Elastic Container Service Developer Guide. Kubernetes kube-dns is 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.createMesh(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: '2018-10-01'});

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

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

var appmesh = new AWS.AppMesh();

Version:

2018-10-01

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

createMesh(params = {}, callback) ⇒ AWS.Request
Creates a new service mesh.
createRoute(params = {}, callback) ⇒ AWS.Request
Creates a new route that is associated with a virtual router.

You can use the prefix parameter in your route specification for path-based routing of requests.
createVirtualNode(params = {}, callback) ⇒ AWS.Request
Creates a new virtual node within a service mesh.

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

Virtual routers handle traffic for one or more service names within your mesh.
deleteMesh(params = {}, callback) ⇒ AWS.Request
Deletes an existing service mesh.

You must delete all resources (routes, virtual routers, virtual nodes) in the service mesh before you can delete the mesh itself.
.
deleteRoute(params = {}, callback) ⇒ AWS.Request
Deletes an existing route.

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

.
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.
.
describeMesh(params = {}, callback) ⇒ AWS.Request
Describes an existing service mesh.

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

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

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

.
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.

.
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.

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

.
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.

.

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: '2018-10-01'});

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_20181001.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.AppMesh_20181001.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.AppMesh_20181001.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

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

Creates a new service mesh. A service mesh is a logical boundary for network traffic between the services that reside within it.

After you create your service mesh, you can create virtual nodes, virtual routers, and routes to distribute traffic between the applications in your mesh.

Service Reference:

CreateMesh

Examples:

Calling the createMesh operation

var params = {
  meshName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
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.

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 — (String)
    The full Amazon Resource Name (ARN) for the resource.
    
    Note: After you create a virtual node, set this value (either the full ARN or the truncated resource name, for example, mesh/default/virtualNode/simpleapp, as the APPMESH_VIRTUAL_NODE_NAME 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. If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.
    
    createdAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was created.
    
    lastUpdatedAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was last updated.
    
    uid — (String)
    The unique identifier for the resource.
    
    version — (Integer)
    The version of the resource. Resources are created at version 1, and this version is incremented each time they are updated.
    
    status — (map)
    The status of the service mesh.
    
    status — (String)
    The current mesh status.
    Possible values include:
    
    "ACTIVE"
    
    "DELETED"
    
    "INACTIVE"

Returns:

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

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

Creates a new route that is associated with a virtual router.

You can use the prefix parameter in your route specification for path-based routing of requests. For example, if your virtual router service name is my-service.local, and you want the route to match requests to my-service.local/metrics, then your prefix should be /metrics.

If your route matches a request, you can distribute traffic to one or more target virtual nodes with relative weighting.

Service Reference:

CreateRoute

Examples:

Calling the createRoute operation

var params = {
  meshName: 'STRING_VALUE', /* required */
  routeName: 'STRING_VALUE', /* required */
  spec: { /* required */
    httpRoute: {
      action: {
        weightedTargets: [
          {
            virtualNode: 'STRING_VALUE',
            weight: 'NUMBER_VALUE'
          },
          /* more items */
        ]
      },
      match: {
        prefix: 'STRING_VALUE'
      }
    }
  },
  virtualRouterName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
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 in which to create the route.
- routeName — (String)
  The name to use for the route.
- spec — (map)
  The route specification to apply.
  - httpRoute — (map)
    The HTTP routing information for the route.
    - action — (map)
      The action to take if a match is determined.
      
      weightedTargets — (Array<map>)
      The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights with which to distribute traffic.
      
      virtualNode — (String)
      The virtual node to associate with the weighted target.
      
      weight — (Integer)
      The relative weight of the weighted target.
    - match — (map)
      The criteria for determining an HTTP request match.
      
      prefix — (String)
      Specifies the path with which to match requests. This parameter must always start with /, which by itself matches all requests to the virtual router service name. You can also match for path-based routing of requests. For example, if your virtual router service name is my-service.local, and you want the route to match requests to my-service.local/metrics, then your prefix should be /metrics.
- virtualRouterName — (String)
  The name of the virtual router in which to create the route.

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 in which the route resides.
    
    metadata — (map)
    The associated metadata for the route.
    
    arn — (String)
    The full Amazon Resource Name (ARN) for the resource.
    
    Note: After you create a virtual node, set this value (either the full ARN or the truncated resource name, for example, mesh/default/virtualNode/simpleapp, as the APPMESH_VIRTUAL_NODE_NAME 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. If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.
    
    createdAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was created.
    
    lastUpdatedAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was last updated.
    
    uid — (String)
    The unique identifier for the resource.
    
    version — (Integer)
    The version of the resource. Resources are created at version 1, and this version is incremented each time they are updated.
    
    routeName — required — (String)
    The name of the route.
    
    spec — (map)
    The specifications of the route.
    
    httpRoute — (map)
    The HTTP routing information for the route.
    
    action — (map)
    The action to take if a match is determined.
    
    weightedTargets — (Array<map>)
    The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights with which to distribute traffic.
    
    virtualNode — (String)
    The virtual node to associate with the weighted target.
    
    weight — (Integer)
    The relative weight of the weighted target.
    
    match — (map)
    The criteria for determining an HTTP request match.
    
    prefix — (String)
    Specifies the path with which to match requests. This parameter must always start with /, which by itself matches all requests to the virtual router service name. You can also match for path-based routing of requests. For example, if your virtual router service name is my-service.local, and you want the route to match requests to my-service.local/metrics, then your prefix should be /metrics.
    
    status — (map)
    The status of the route.
    
    status — (String)
    The current status for the route.
    Possible values include:
    
    "ACTIVE"
    
    "DELETED"
    
    "INACTIVE"
    
    virtualRouterName — required — (String)
    The virtual router with which the route is associated.

Returns:

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

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

Creates a new virtual node within a service mesh.

A virtual node acts as logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you must specify the DNS service discovery name for your task group.

Any inbound traffic that your virtual node expects should be specified as a listener. Any outbound traffic that your virtual node expects to reach should be 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 (either the full ARN or the truncated resource name, for example, mesh/default/virtualNode/simpleapp, as the APPMESH_VIRTUAL_NODE_NAME 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: If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.

Service Reference:

CreateVirtualNode

Examples:

Calling the createVirtualNode operation

var params = {
  meshName: 'STRING_VALUE', /* required */
  spec: { /* required */
    backends: [
      'STRING_VALUE',
      /* more items */
    ],
    listeners: [
      {
        healthCheck: {
          healthyThreshold: 'NUMBER_VALUE', /* required */
          intervalMillis: 'NUMBER_VALUE', /* required */
          protocol: http | tcp, /* required */
          timeoutMillis: 'NUMBER_VALUE', /* required */
          unhealthyThreshold: 'NUMBER_VALUE', /* required */
          path: 'STRING_VALUE',
          port: 'NUMBER_VALUE'
        },
        portMapping: {
          port: 'NUMBER_VALUE',
          protocol: http | tcp
        }
      },
      /* more items */
    ],
    serviceDiscovery: {
      dns: {
        serviceName: 'STRING_VALUE'
      }
    }
  },
  virtualNodeName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
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 in which to create the virtual node.
- spec — (map)
  The virtual node specification to apply.
  - backends — (Array<String>)
    The backends to which the virtual node is expected to send outbound traffic.
  - listeners — (Array<map>)
    The listeners from which the virtual node is expected to receive inbound traffic.
    - 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 is only required if the specified protocol is HTTP; if the protocol is TCP, then this parameter 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.
      Possible values include:
      
      "http"
      
      "tcp"
      
      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.
    - portMapping — (map)
      The port mapping information for the listener.
      
      port — (Integer)
      The port used for the port mapping.
      
      protocol — (String)
      The protocol used for the port mapping.
      Possible values include:
      
      "http"
      
      "tcp"
  - serviceDiscovery — (map)
    The service discovery information for the virtual node.
    - dns — (map)
      Specifies the DNS service name for the virtual node.
      
      serviceName — (String)
      The DNS service name for your virtual node.
- 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 in which the virtual node resides.
    
    metadata — (map)
    The associated metadata for the virtual node.
    
    arn — (String)
    The full Amazon Resource Name (ARN) for the resource.
    
    Note: After you create a virtual node, set this value (either the full ARN or the truncated resource name, for example, mesh/default/virtualNode/simpleapp, as the APPMESH_VIRTUAL_NODE_NAME 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. If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.
    
    createdAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was created.
    
    lastUpdatedAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was last updated.
    
    uid — (String)
    The unique identifier for the resource.
    
    version — (Integer)
    The version of the resource. Resources are created at version 1, and this version is incremented each time they are updated.
    
    spec — (map)
    The specifications of the virtual node.
    
    backends — (Array<String>)
    The backends to which the virtual node is expected to send outbound traffic.
    
    listeners — (Array<map>)
    The listeners from which the virtual node is expected to receive inbound traffic.
    
    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 is only required if the specified protocol is HTTP; if the protocol is TCP, then this parameter 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.
    Possible values include:
    
    "http"
    
    "tcp"
    
    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.
    
    portMapping — (map)
    The port mapping information for the listener.
    
    port — (Integer)
    The port used for the port mapping.
    
    protocol — (String)
    The protocol used for the port mapping.
    Possible values include:
    
    "http"
    
    "tcp"
    
    serviceDiscovery — (map)
    The service discovery information for the virtual node.
    
    dns — (map)
    Specifies the DNS service name for the virtual node.
    
    serviceName — (String)
    The DNS service name for your virtual node.
    
    status — (map)
    The current status for the virtual node.
    
    status — (String)
    The current status of the virtual node.
    Possible values include:
    
    "ACTIVE"
    
    "DELETED"
    
    "INACTIVE"
    
    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 new virtual router within a service mesh.

Virtual routers handle traffic for one or more service names 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.

Service Reference:

CreateVirtualRouter

Examples:

Calling the createVirtualRouter operation

var params = {
  meshName: 'STRING_VALUE', /* required */
  spec: { /* required */
    serviceNames: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  virtualRouterName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
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 in which to create the virtual router.
- spec — (map)
  The virtual router specification to apply.
  - serviceNames — (Array<String>)
    The service mesh service names to associate with the virtual router.
- 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 in which the virtual router resides.
    
    metadata — (map)
    The associated metadata for the virtual router.
    
    arn — (String)
    The full Amazon Resource Name (ARN) for the resource.
    
    Note: After you create a virtual node, set this value (either the full ARN or the truncated resource name, for example, mesh/default/virtualNode/simpleapp, as the APPMESH_VIRTUAL_NODE_NAME 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. If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.
    
    createdAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was created.
    
    lastUpdatedAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was last updated.
    
    uid — (String)
    The unique identifier for the resource.
    
    version — (Integer)
    The version of the resource. Resources are created at version 1, and this version is incremented each time they are updated.
    
    spec — (map)
    The specifications of the virtual router.
    
    serviceNames — (Array<String>)
    The service mesh service names to associate with the virtual router.
    
    status — (map)
    The current status of the virtual router.
    
    status — (String)
    The current status of the virtual router.
    Possible values include:
    
    "ACTIVE"
    
    "DELETED"
    
    "INACTIVE"
    
    virtualRouterName — required — (String)
    The name of the virtual router.

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 (routes, virtual routers, 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 — (String)
    The full Amazon Resource Name (ARN) for the resource.
    
    Note: After you create a virtual node, set this value (either the full ARN or the truncated resource name, for example, mesh/default/virtualNode/simpleapp, as the APPMESH_VIRTUAL_NODE_NAME 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. If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.
    
    createdAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was created.
    
    lastUpdatedAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was last updated.
    
    uid — (String)
    The unique identifier for the resource.
    
    version — (Integer)
    The version of the resource. Resources are created at version 1, and this version is incremented each time they are updated.
    
    status — (map)
    The status of the service mesh.
    
    status — (String)
    The current mesh status.
    Possible values include:
    
    "ACTIVE"
    
    "DELETED"
    
    "INACTIVE"

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 */
};
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 in which to delete the route.
- routeName — (String)
  The name of the route to delete.
- virtualRouterName — (String)
  The name of the virtual router in which to delete the route.

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 in which the route resides.
    
    metadata — (map)
    The associated metadata for the route.
    
    arn — (String)
    The full Amazon Resource Name (ARN) for the resource.
    
    Note: After you create a virtual node, set this value (either the full ARN or the truncated resource name, for example, mesh/default/virtualNode/simpleapp, as the APPMESH_VIRTUAL_NODE_NAME 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. If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.
    
    createdAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was created.
    
    lastUpdatedAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was last updated.
    
    uid — (String)
    The unique identifier for the resource.
    
    version — (Integer)
    The version of the resource. Resources are created at version 1, and this version is incremented each time they are updated.
    
    routeName — required — (String)
    The name of the route.
    
    spec — (map)
    The specifications of the route.
    
    httpRoute — (map)
    The HTTP routing information for the route.
    
    action — (map)
    The action to take if a match is determined.
    
    weightedTargets — (Array<map>)
    The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights with which to distribute traffic.
    
    virtualNode — (String)
    The virtual node to associate with the weighted target.
    
    weight — (Integer)
    The relative weight of the weighted target.
    
    match — (map)
    The criteria for determining an HTTP request match.
    
    prefix — (String)
    Specifies the path with which to match requests. This parameter must always start with /, which by itself matches all requests to the virtual router service name. You can also match for path-based routing of requests. For example, if your virtual router service name is my-service.local, and you want the route to match requests to my-service.local/metrics, then your prefix should be /metrics.
    
    status — (map)
    The status of the route.
    
    status — (String)
    The current status for the route.
    Possible values include:
    
    "ACTIVE"
    
    "DELETED"
    
    "INACTIVE"
    
    virtualRouterName — required — (String)
    The virtual router with which the route is associated.

Returns:

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

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

Deletes an existing virtual node.

Service Reference:

DeleteVirtualNode

Examples:

Calling the deleteVirtualNode operation

var params = {
  meshName: 'STRING_VALUE', /* required */
  virtualNodeName: 'STRING_VALUE' /* required */
};
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 in which to delete the virtual node.
- 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 in which the virtual node resides.
    
    metadata — (map)
    The associated metadata for the virtual node.
    
    arn — (String)
    The full Amazon Resource Name (ARN) for the resource.
    
    Note: After you create a virtual node, set this value (either the full ARN or the truncated resource name, for example, mesh/default/virtualNode/simpleapp, as the APPMESH_VIRTUAL_NODE_NAME 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. If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.
    
    createdAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was created.
    
    lastUpdatedAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was last updated.
    
    uid — (String)
    The unique identifier for the resource.
    
    version — (Integer)
    The version of the resource. Resources are created at version 1, and this version is incremented each time they are updated.
    
    spec — (map)
    The specifications of the virtual node.
    
    backends — (Array<String>)
    The backends to which the virtual node is expected to send outbound traffic.
    
    listeners — (Array<map>)
    The listeners from which the virtual node is expected to receive inbound traffic.
    
    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 is only required if the specified protocol is HTTP; if the protocol is TCP, then this parameter 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.
    Possible values include:
    
    "http"
    
    "tcp"
    
    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.
    
    portMapping — (map)
    The port mapping information for the listener.
    
    port — (Integer)
    The port used for the port mapping.
    
    protocol — (String)
    The protocol used for the port mapping.
    Possible values include:
    
    "http"
    
    "tcp"
    
    serviceDiscovery — (map)
    The service discovery information for the virtual node.
    
    dns — (map)
    Specifies the DNS service name for the virtual node.
    
    serviceName — (String)
    The DNS service name for your virtual node.
    
    status — (map)
    The current status for the virtual node.
    
    status — (String)
    The current status of the virtual node.
    Possible values include:
    
    "ACTIVE"
    
    "DELETED"
    
    "INACTIVE"
    
    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 */
};
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 in which to delete the virtual router.
- 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 in which the virtual router resides.
    
    metadata — (map)
    The associated metadata for the virtual router.
    
    arn — (String)
    The full Amazon Resource Name (ARN) for the resource.
    
    Note: After you create a virtual node, set this value (either the full ARN or the truncated resource name, for example, mesh/default/virtualNode/simpleapp, as the APPMESH_VIRTUAL_NODE_NAME 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. If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.
    
    createdAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was created.
    
    lastUpdatedAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was last updated.
    
    uid — (String)
    The unique identifier for the resource.
    
    version — (Integer)
    The version of the resource. Resources are created at version 1, and this version is incremented each time they are updated.
    
    spec — (map)
    The specifications of the virtual router.
    
    serviceNames — (Array<String>)
    The service mesh service names to associate with the virtual router.
    
    status — (map)
    The current status of the virtual router.
    
    status — (String)
    The current status of the virtual router.
    Possible values include:
    
    "ACTIVE"
    
    "DELETED"
    
    "INACTIVE"
    
    virtualRouterName — required — (String)
    The name of the virtual router.

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 */
};
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.

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 — (String)
    The full Amazon Resource Name (ARN) for the resource.
    
    Note: After you create a virtual node, set this value (either the full ARN or the truncated resource name, for example, mesh/default/virtualNode/simpleapp, as the APPMESH_VIRTUAL_NODE_NAME 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. If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.
    
    createdAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was created.
    
    lastUpdatedAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was last updated.
    
    uid — (String)
    The unique identifier for the resource.
    
    version — (Integer)
    The version of the resource. Resources are created at version 1, and this version is incremented each time they are updated.
    
    status — (map)
    The status of the service mesh.
    
    status — (String)
    The current mesh status.
    Possible values include:
    
    "ACTIVE"
    
    "DELETED"
    
    "INACTIVE"

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 */
};
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 in which the route resides.
- routeName — (String)
  The name of the route to describe.
- virtualRouterName — (String)
  The name of the virtual router with which the route is associated.

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 in which the route resides.
    
    metadata — (map)
    The associated metadata for the route.
    
    arn — (String)
    The full Amazon Resource Name (ARN) for the resource.
    
    Note: After you create a virtual node, set this value (either the full ARN or the truncated resource name, for example, mesh/default/virtualNode/simpleapp, as the APPMESH_VIRTUAL_NODE_NAME 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. If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.
    
    createdAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was created.
    
    lastUpdatedAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was last updated.
    
    uid — (String)
    The unique identifier for the resource.
    
    version — (Integer)
    The version of the resource. Resources are created at version 1, and this version is incremented each time they are updated.
    
    routeName — required — (String)
    The name of the route.
    
    spec — (map)
    The specifications of the route.
    
    httpRoute — (map)
    The HTTP routing information for the route.
    
    action — (map)
    The action to take if a match is determined.
    
    weightedTargets — (Array<map>)
    The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights with which to distribute traffic.
    
    virtualNode — (String)
    The virtual node to associate with the weighted target.
    
    weight — (Integer)
    The relative weight of the weighted target.
    
    match — (map)
    The criteria for determining an HTTP request match.
    
    prefix — (String)
    Specifies the path with which to match requests. This parameter must always start with /, which by itself matches all requests to the virtual router service name. You can also match for path-based routing of requests. For example, if your virtual router service name is my-service.local, and you want the route to match requests to my-service.local/metrics, then your prefix should be /metrics.
    
    status — (map)
    The status of the route.
    
    status — (String)
    The current status for the route.
    Possible values include:
    
    "ACTIVE"
    
    "DELETED"
    
    "INACTIVE"
    
    virtualRouterName — required — (String)
    The virtual router with which the route is associated.

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 */
};
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 in which the virtual node resides.
- 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 in which the virtual node resides.
    
    metadata — (map)
    The associated metadata for the virtual node.
    
    arn — (String)
    The full Amazon Resource Name (ARN) for the resource.
    
    Note: After you create a virtual node, set this value (either the full ARN or the truncated resource name, for example, mesh/default/virtualNode/simpleapp, as the APPMESH_VIRTUAL_NODE_NAME 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. If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.
    
    createdAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was created.
    
    lastUpdatedAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was last updated.
    
    uid — (String)
    The unique identifier for the resource.
    
    version — (Integer)
    The version of the resource. Resources are created at version 1, and this version is incremented each time they are updated.
    
    spec — (map)
    The specifications of the virtual node.
    
    backends — (Array<String>)
    The backends to which the virtual node is expected to send outbound traffic.
    
    listeners — (Array<map>)
    The listeners from which the virtual node is expected to receive inbound traffic.
    
    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 is only required if the specified protocol is HTTP; if the protocol is TCP, then this parameter 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.
    Possible values include:
    
    "http"
    
    "tcp"
    
    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.
    
    portMapping — (map)
    The port mapping information for the listener.
    
    port — (Integer)
    The port used for the port mapping.
    
    protocol — (String)
    The protocol used for the port mapping.
    Possible values include:
    
    "http"
    
    "tcp"
    
    serviceDiscovery — (map)
    The service discovery information for the virtual node.
    
    dns — (map)
    Specifies the DNS service name for the virtual node.
    
    serviceName — (String)
    The DNS service name for your virtual node.
    
    status — (map)
    The current status for the virtual node.
    
    status — (String)
    The current status of the virtual node.
    Possible values include:
    
    "ACTIVE"
    
    "DELETED"
    
    "INACTIVE"
    
    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 */
};
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 in which the virtual router resides.
- 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 in which the virtual router resides.
    
    metadata — (map)
    The associated metadata for the virtual router.
    
    arn — (String)
    The full Amazon Resource Name (ARN) for the resource.
    
    Note: After you create a virtual node, set this value (either the full ARN or the truncated resource name, for example, mesh/default/virtualNode/simpleapp, as the APPMESH_VIRTUAL_NODE_NAME 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. If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.
    
    createdAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was created.
    
    lastUpdatedAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was last updated.
    
    uid — (String)
    The unique identifier for the resource.
    
    version — (Integer)
    The version of the resource. Resources are created at version 1, and this version is incremented each time they are updated.
    
    spec — (map)
    The specifications of the virtual router.
    
    serviceNames — (Array<String>)
    The service mesh service names to associate with the virtual router.
    
    status — (map)
    The current status of the virtual router.
    
    status — (String)
    The current status of the virtual router.
    Possible values include:
    
    "ACTIVE"
    
    "DELETED"
    
    "INACTIVE"
    
    virtualRouterName — required — (String)
    The name of the virtual router.

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 mesh results returned by ListMeshes in paginated output. When this parameter is used, ListMeshes only returns limit results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListMeshes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then 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 only used 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 — (String)
    The full Amazon Resource Name (ARN) of the service mesh.
    
    meshName — (String)
    The name of the service mesh.
  - nextToken — (String)
    The nextToken value to include in a future ListMeshes request. When the results of a ListMeshes request exceed limit, this value can be used 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',
  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 mesh results returned by ListRoutes in paginated output. When this parameter is used, ListRoutes only returns limit results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRoutes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRoutes returns up to 100 results and a nextToken value if applicable.
- meshName — (String)
  The name of the service mesh in which to list routes.
- 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 in which to list routes.

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, this value can be used 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 — (String)
    The full Amazon Resource Name (ARN) for the route.
    
    meshName — (String)
    The name of the service mesh in which the route resides.
    
    routeName — (String)
    The name of the route.
    
    virtualRouterName — (String)
    The virtual router with which the route is associated.

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',
  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 mesh results returned by ListVirtualNodes in paginated output. When this parameter is used, ListVirtualNodes only returns limit results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListVirtualNodes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListVirtualNodes returns up to 100 results and a nextToken value if applicable.
- meshName — (String)
  The name of the service mesh in which to list virtual nodes.
- 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, this value can be used 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 — (String)
    The full Amazon Resource Name (ARN) for the virtual node.
    
    meshName — (String)
    The name of the service mesh in which the virtual node resides.
    
    virtualNodeName — (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',
  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 mesh results returned by ListVirtualRouters in paginated output. When this parameter is used, ListVirtualRouters only returns limit results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListVirtualRouters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListVirtualRouters returns up to 100 results and a nextToken value if applicable.
- meshName — (String)
  The name of the service mesh in which to list virtual routers.
- 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, this value can be used 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 — (String)
    The full Amazon Resource Name (ARN) for the virtual router.
    
    meshName — (String)
    The name of the service mesh in which the virtual router resides.
    
    virtualRouterName — (String)
    The name of the virtual router.

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 */
    httpRoute: {
      action: {
        weightedTargets: [
          {
            virtualNode: 'STRING_VALUE',
            weight: 'NUMBER_VALUE'
          },
          /* more items */
        ]
      },
      match: {
        prefix: 'STRING_VALUE'
      }
    }
  },
  virtualRouterName: 'STRING_VALUE', /* required */
  clientToken: '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 in which the route resides.
- routeName — (String)
  The name of the route to update.
- spec — (map)
  The new route specification to apply. This overwrites the existing data.
  - httpRoute — (map)
    The HTTP routing information for the route.
    - action — (map)
      The action to take if a match is determined.
      
      weightedTargets — (Array<map>)
      The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights with which to distribute traffic.
      
      virtualNode — (String)
      The virtual node to associate with the weighted target.
      
      weight — (Integer)
      The relative weight of the weighted target.
    - match — (map)
      The criteria for determining an HTTP request match.
      
      prefix — (String)
      Specifies the path with which to match requests. This parameter must always start with /, which by itself matches all requests to the virtual router service name. You can also match for path-based routing of requests. For example, if your virtual router service name is my-service.local, and you want the route to match requests to my-service.local/metrics, then your prefix should be /metrics.
- virtualRouterName — (String)
  The name of the virtual router with which the route is associated.

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 in which the route resides.
    
    metadata — (map)
    The associated metadata for the route.
    
    arn — (String)
    The full Amazon Resource Name (ARN) for the resource.
    
    Note: After you create a virtual node, set this value (either the full ARN or the truncated resource name, for example, mesh/default/virtualNode/simpleapp, as the APPMESH_VIRTUAL_NODE_NAME 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. If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.
    
    createdAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was created.
    
    lastUpdatedAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was last updated.
    
    uid — (String)
    The unique identifier for the resource.
    
    version — (Integer)
    The version of the resource. Resources are created at version 1, and this version is incremented each time they are updated.
    
    routeName — required — (String)
    The name of the route.
    
    spec — (map)
    The specifications of the route.
    
    httpRoute — (map)
    The HTTP routing information for the route.
    
    action — (map)
    The action to take if a match is determined.
    
    weightedTargets — (Array<map>)
    The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights with which to distribute traffic.
    
    virtualNode — (String)
    The virtual node to associate with the weighted target.
    
    weight — (Integer)
    The relative weight of the weighted target.
    
    match — (map)
    The criteria for determining an HTTP request match.
    
    prefix — (String)
    Specifies the path with which to match requests. This parameter must always start with /, which by itself matches all requests to the virtual router service name. You can also match for path-based routing of requests. For example, if your virtual router service name is my-service.local, and you want the route to match requests to my-service.local/metrics, then your prefix should be /metrics.
    
    status — (map)
    The status of the route.
    
    status — (String)
    The current status for the route.
    Possible values include:
    
    "ACTIVE"
    
    "DELETED"
    
    "INACTIVE"
    
    virtualRouterName — required — (String)
    The virtual router with which the route is associated.

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 */
    backends: [
      'STRING_VALUE',
      /* more items */
    ],
    listeners: [
      {
        healthCheck: {
          healthyThreshold: 'NUMBER_VALUE', /* required */
          intervalMillis: 'NUMBER_VALUE', /* required */
          protocol: http | tcp, /* required */
          timeoutMillis: 'NUMBER_VALUE', /* required */
          unhealthyThreshold: 'NUMBER_VALUE', /* required */
          path: 'STRING_VALUE',
          port: 'NUMBER_VALUE'
        },
        portMapping: {
          port: 'NUMBER_VALUE',
          protocol: http | tcp
        }
      },
      /* more items */
    ],
    serviceDiscovery: {
      dns: {
        serviceName: 'STRING_VALUE'
      }
    }
  },
  virtualNodeName: 'STRING_VALUE', /* required */
  clientToken: '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 in which the virtual node resides.
- spec — (map)
  The new virtual node specification to apply. This overwrites the existing data.
  - backends — (Array<String>)
    The backends to which the virtual node is expected to send outbound traffic.
  - listeners — (Array<map>)
    The listeners from which the virtual node is expected to receive inbound traffic.
    - 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 is only required if the specified protocol is HTTP; if the protocol is TCP, then this parameter 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.
      Possible values include:
      
      "http"
      
      "tcp"
      
      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.
    - portMapping — (map)
      The port mapping information for the listener.
      
      port — (Integer)
      The port used for the port mapping.
      
      protocol — (String)
      The protocol used for the port mapping.
      Possible values include:
      
      "http"
      
      "tcp"
  - serviceDiscovery — (map)
    The service discovery information for the virtual node.
    - dns — (map)
      Specifies the DNS service name for the virtual node.
      
      serviceName — (String)
      The DNS service name for your virtual node.
- 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 in which the virtual node resides.
    
    metadata — (map)
    The associated metadata for the virtual node.
    
    arn — (String)
    The full Amazon Resource Name (ARN) for the resource.
    
    Note: After you create a virtual node, set this value (either the full ARN or the truncated resource name, for example, mesh/default/virtualNode/simpleapp, as the APPMESH_VIRTUAL_NODE_NAME 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. If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.
    
    createdAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was created.
    
    lastUpdatedAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was last updated.
    
    uid — (String)
    The unique identifier for the resource.
    
    version — (Integer)
    The version of the resource. Resources are created at version 1, and this version is incremented each time they are updated.
    
    spec — (map)
    The specifications of the virtual node.
    
    backends — (Array<String>)
    The backends to which the virtual node is expected to send outbound traffic.
    
    listeners — (Array<map>)
    The listeners from which the virtual node is expected to receive inbound traffic.
    
    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 is only required if the specified protocol is HTTP; if the protocol is TCP, then this parameter 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.
    Possible values include:
    
    "http"
    
    "tcp"
    
    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.
    
    portMapping — (map)
    The port mapping information for the listener.
    
    port — (Integer)
    The port used for the port mapping.
    
    protocol — (String)
    The protocol used for the port mapping.
    Possible values include:
    
    "http"
    
    "tcp"
    
    serviceDiscovery — (map)
    The service discovery information for the virtual node.
    
    dns — (map)
    Specifies the DNS service name for the virtual node.
    
    serviceName — (String)
    The DNS service name for your virtual node.
    
    status — (map)
    The current status for the virtual node.
    
    status — (String)
    The current status of the virtual node.
    Possible values include:
    
    "ACTIVE"
    
    "DELETED"
    
    "INACTIVE"
    
    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 */
    serviceNames: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  virtualRouterName: 'STRING_VALUE', /* required */
  clientToken: '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 in which the virtual router resides.
- spec — (map)
  The new virtual router specification to apply. This overwrites the existing data.
  - serviceNames — (Array<String>)
    The service mesh service names to associate with the virtual router.
- 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 in which the virtual router resides.
    
    metadata — (map)
    The associated metadata for the virtual router.
    
    arn — (String)
    The full Amazon Resource Name (ARN) for the resource.
    
    Note: After you create a virtual node, set this value (either the full ARN or the truncated resource name, for example, mesh/default/virtualNode/simpleapp, as the APPMESH_VIRTUAL_NODE_NAME 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. If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.
    
    createdAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was created.
    
    lastUpdatedAt — (Date)
    The Unix epoch timestamp in seconds for when the resource was last updated.
    
    uid — (String)
    The unique identifier for the resource.
    
    version — (Integer)
    The version of the resource. Resources are created at version 1, and this version is incremented each time they are updated.
    
    spec — (map)
    The specifications of the virtual router.
    
    serviceNames — (Array<String>)
    The service mesh service names to associate with the virtual router.
    
    status — (map)
    The current status of the virtual router.
    
    status — (String)
    The current status of the virtual router.
    Possible values include:
    
    "ACTIVE"
    
    "DELETED"
    
    "INACTIVE"
    
    virtualRouterName — required — (String)
    The name of the virtual router.

Returns:

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

Class: AWS.AppMesh (2018-10-01)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

endpoint ⇒ `AWS.Endpoint` (readwrite)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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