AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: AWS.AppMesh

Inherits:
AWS.Service show all
Identifier:
appmesh
API Version:
2019-01-25
Defined in:
(unknown)

Overview

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

Service Description

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

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

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

Sending a Request Using AppMesh

var appmesh = new AWS.AppMesh();
appmesh.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: '2019-01-25'});

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

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

var appmesh = new AWS.AppMesh();

Version:

  • 2019-01-25

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a AppMesh object

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

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

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

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.AppMesh.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.AppMesh.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.AppMesh.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

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

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • 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

endpointAWS.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 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 services, virtual nodes, virtual routers, and routes to distribute traffic between the applications in your mesh.

Service Reference:

Examples:

Calling the createMesh operation

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

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

      If a token is not provided, the SDK will use a version 4 UUID.
    • meshName — (String)

      The name to use for the service mesh.

    • spec — (map)

      The service mesh specification to apply.

      • egressFilter — (map)

        The egress filter rules for the service mesh.

        • typerequired — (String)

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

          Possible values include:
          • "ALLOW_ALL"
          • "DROP_ALL"
    • tags — (Array<map>)

      Optional metadata that you can apply to the service mesh to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

      • keyrequired — (String)

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

      • value — (String)

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

Callback (callback):

  • function(err, data) { ... }

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

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

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

      • mesh — (map)

        The full description of your service mesh following the create call.

        • meshNamerequired — (String)

          The name of the service mesh.

        • metadatarequired — (map)

          The associated metadata for the service mesh.

          • arnrequired — (String)

            The full Amazon Resource Name (ARN) for the resource.

          • createdAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was created.

          • lastUpdatedAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was last updated.

          • uidrequired — (String)

            The unique identifier for the resource.

          • versionrequired — (Integer)

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

        • specrequired — (map)

          The associated specification for the service mesh.

          • egressFilter — (map)

            The egress filter rules for the service mesh.

            • typerequired — (String)

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

              Possible values include:
              • "ALLOW_ALL"
              • "DROP_ALL"
        • statusrequired — (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 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 service name is my-service.local and you want the route to match requests to my-service.local/metrics, 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:

Examples:

Calling the createRoute operation

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

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

      If a token is not provided, the SDK will use a version 4 UUID.
    • meshName — (String)

      The name of the service mesh to create the route in.

    • routeName — (String)

      The name to use for the route.

    • spec — (map)

      The route specification to apply.

      • grpcRoute — (map)

        An object that represents the specification of a GRPC route.

        • actionrequired — (map)

          An object that represents the action to take if a match is determined.

          • weightedTargetsrequired — (Array<map>)

            An object that represents the targets that traffic is routed to when a request matches the route.

            • virtualNoderequired — (String)

              The virtual node to associate with the weighted target.

            • weightrequired — (Integer)

              The relative weight of the weighted target.

        • matchrequired — (map)

          An object that represents the criteria for determining a request match.

          • metadata — (Array<map>)

            An object that represents the data to match from the request.

            • invert — (Boolean)

              Specify True to match anything except the match criteria. The default value is False.

            • match — (map)

              An object that represents the data to match from the request.

              • exact — (String)

                The value sent by the client must match the specified value exactly.

              • prefix — (String)

                The value sent by the client must begin with the specified characters.

              • range — (map)

                An object that represents the range of values to match on.

                • endrequired — (Integer)

                  The end of the range.

                • startrequired — (Integer)

                  The start of the range.

              • regex — (String)

                The value sent by the client must include the specified characters.

              • suffix — (String)

                The value sent by the client must end with the specified characters.

            • namerequired — (String)

              The name of the route.

          • methodName — (String)

            The method name to match from the request. If you specify a name, you must also specify a serviceName.

          • serviceName — (String)

            The fully qualified domain name for the service to match from the request.

        • retryPolicy — (map)

          An object that represents a retry policy.

          • grpcRetryEvents — (Array<String>)

            Specify at least one of the valid values.

          • httpRetryEvents — (Array<String>)

            Specify at least one of the following values.

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

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

            • client-error – HTTP status code 409

            • stream-error – Retry on refused stream

          • maxRetriesrequired — (Integer)

            The maximum number of retry attempts.

          • perRetryTimeoutrequired — (map)

            An object that represents a duration of time.

            • unit — (String)

              A unit of time.

              Possible values include:
              • "ms"
              • "s"
            • value — (Integer)

              A number of time units.

          • tcpRetryEvents — (Array<String>)

            Specify a valid value.

      • http2Route — (map)

        An object that represents the specification of an HTTP2 route.

        • actionrequired — (map)

          An object that represents the action to take if a match is determined.

          • weightedTargetsrequired — (Array<map>)

            An object that represents the targets that traffic is routed to when a request matches the route.

            • virtualNoderequired — (String)

              The virtual node to associate with the weighted target.

            • weightrequired — (Integer)

              The relative weight of the weighted target.

        • matchrequired — (map)

          An object that represents the criteria for determining a request match.

          • headers — (Array<map>)

            An object that represents the client request headers to match on.

            • invert — (Boolean)

              Specify True to match anything except the match criteria. The default value is False.

            • match — (map)

              The HeaderMatchMethod object.

              • exact — (String)

                The value sent by the client must match the specified value exactly.

              • prefix — (String)

                The value sent by the client must begin with the specified characters.

              • range — (map)

                An object that represents the range of values to match on.

                • endrequired — (Integer)

                  The end of the range.

                • startrequired — (Integer)

                  The start of the range.

              • regex — (String)

                The value sent by the client must include the specified characters.

              • suffix — (String)

                The value sent by the client must end with the specified characters.

            • namerequired — (String)

              A name for the HTTP header in the client request that will be matched on.

          • method — (String)

            The client request method to match on. Specify only one.

            Possible values include:
            • "CONNECT"
            • "DELETE"
            • "GET"
            • "HEAD"
            • "OPTIONS"
            • "PATCH"
            • "POST"
            • "PUT"
            • "TRACE"
          • prefixrequired — (String)

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

          • scheme — (String)

            The client request scheme to match on. Specify only one.

            Possible values include:
            • "http"
            • "https"
        • retryPolicy — (map)

          An object that represents a retry policy.

          • httpRetryEvents — (Array<String>)

            Specify at least one of the following values.

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

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

            • client-error – HTTP status code 409

            • stream-error – Retry on refused stream

          • maxRetriesrequired — (Integer)

            The maximum number of retry attempts.

          • perRetryTimeoutrequired — (map)

            An object that represents a duration of time.

            • unit — (String)

              A unit of time.

              Possible values include:
              • "ms"
              • "s"
            • value — (Integer)

              A number of time units.

          • tcpRetryEvents — (Array<String>)

            Specify a valid value.

      • httpRoute — (map)

        An object that represents the specification of an HTTP route.

        • actionrequired — (map)

          An object that represents the action to take if a match is determined.

          • weightedTargetsrequired — (Array<map>)

            An object that represents the targets that traffic is routed to when a request matches the route.

            • virtualNoderequired — (String)

              The virtual node to associate with the weighted target.

            • weightrequired — (Integer)

              The relative weight of the weighted target.

        • matchrequired — (map)

          An object that represents the criteria for determining a request match.

          • headers — (Array<map>)

            An object that represents the client request headers to match on.

            • invert — (Boolean)

              Specify True to match anything except the match criteria. The default value is False.

            • match — (map)

              The HeaderMatchMethod object.

              • exact — (String)

                The value sent by the client must match the specified value exactly.

              • prefix — (String)

                The value sent by the client must begin with the specified characters.

              • range — (map)

                An object that represents the range of values to match on.

                • endrequired — (Integer)

                  The end of the range.

                • startrequired — (Integer)

                  The start of the range.

              • regex — (String)

                The value sent by the client must include the specified characters.

              • suffix — (String)

                The value sent by the client must end with the specified characters.

            • namerequired — (String)

              A name for the HTTP header in the client request that will be matched on.

          • method — (String)

            The client request method to match on. Specify only one.

            Possible values include:
            • "CONNECT"
            • "DELETE"
            • "GET"
            • "HEAD"
            • "OPTIONS"
            • "PATCH"
            • "POST"
            • "PUT"
            • "TRACE"
          • prefixrequired — (String)

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

          • scheme — (String)

            The client request scheme to match on. Specify only one.

            Possible values include:
            • "http"
            • "https"
        • retryPolicy — (map)

          An object that represents a retry policy.

          • httpRetryEvents — (Array<String>)

            Specify at least one of the following values.

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

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

            • client-error – HTTP status code 409

            • stream-error – Retry on refused stream

          • maxRetriesrequired — (Integer)

            The maximum number of retry attempts.

          • perRetryTimeoutrequired — (map)

            An object that represents a duration of time.

            • unit — (String)

              A unit of time.

              Possible values include:
              • "ms"
              • "s"
            • value — (Integer)

              A number of time units.

          • tcpRetryEvents — (Array<String>)

            Specify a valid value.

      • priority — (Integer)

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

      • tcpRoute — (map)

        An object that represents the specification of a TCP route.

        • actionrequired — (map)

          The action to take if a match is determined.

          • weightedTargetsrequired — (Array<map>)

            An object that represents the targets that traffic is routed to when a request matches the route.

            • virtualNoderequired — (String)

              The virtual node to associate with the weighted target.

            • weightrequired — (Integer)

              The relative weight of the weighted target.

    • tags — (Array<map>)

      Optional metadata that you can apply to the route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

      • keyrequired — (String)

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

      • value — (String)

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

    • virtualRouterName — (String)

      The name of the virtual router in which to create the route.

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.

        • meshNamerequired — (String)

          The name of the service mesh that the route resides in.

        • metadatarequired — (map)

          The associated metadata for the route.

          • arnrequired — (String)

            The full Amazon Resource Name (ARN) for the resource.

          • createdAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was created.

          • lastUpdatedAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was last updated.

          • uidrequired — (String)

            The unique identifier for the resource.

          • versionrequired — (Integer)

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

        • routeNamerequired — (String)

          The name of the route.

        • specrequired — (map)

          The specifications of the route.

          • grpcRoute — (map)

            An object that represents the specification of a GRPC route.

            • actionrequired — (map)

              An object that represents the action to take if a match is determined.

              • weightedTargetsrequired — (Array<map>)

                An object that represents the targets that traffic is routed to when a request matches the route.

                • virtualNoderequired — (String)

                  The virtual node to associate with the weighted target.

                • weightrequired — (Integer)

                  The relative weight of the weighted target.

            • matchrequired — (map)

              An object that represents the criteria for determining a request match.

              • metadata — (Array<map>)

                An object that represents the data to match from the request.

                • invert — (Boolean)

                  Specify True to match anything except the match criteria. The default value is False.

                • match — (map)

                  An object that represents the data to match from the request.

                  • exact — (String)

                    The value sent by the client must match the specified value exactly.

                  • prefix — (String)

                    The value sent by the client must begin with the specified characters.

                  • range — (map)

                    An object that represents the range of values to match on.

                    • endrequired — (Integer)

                      The end of the range.

                    • startrequired — (Integer)

                      The start of the range.

                  • regex — (String)

                    The value sent by the client must include the specified characters.

                  • suffix — (String)

                    The value sent by the client must end with the specified characters.

                • namerequired — (String)

                  The name of the route.

              • methodName — (String)

                The method name to match from the request. If you specify a name, you must also specify a serviceName.

              • serviceName — (String)

                The fully qualified domain name for the service to match from the request.

            • retryPolicy — (map)

              An object that represents a retry policy.

              • grpcRetryEvents — (Array<String>)

                Specify at least one of the valid values.

              • httpRetryEvents — (Array<String>)

                Specify at least one of the following values.

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

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

                • client-error – HTTP status code 409

                • stream-error – Retry on refused stream

              • maxRetriesrequired — (Integer)

                The maximum number of retry attempts.

              • perRetryTimeoutrequired — (map)

                An object that represents a duration of time.

                • unit — (String)

                  A unit of time.

                  Possible values include:
                  • "ms"
                  • "s"
                • value — (Integer)

                  A number of time units.

              • tcpRetryEvents — (Array<String>)

                Specify a valid value.

          • http2Route — (map)

            An object that represents the specification of an HTTP2 route.

            • actionrequired — (map)

              An object that represents the action to take if a match is determined.

              • weightedTargetsrequired — (Array<map>)

                An object that represents the targets that traffic is routed to when a request matches the route.

                • virtualNoderequired — (String)

                  The virtual node to associate with the weighted target.

                • weightrequired — (Integer)

                  The relative weight of the weighted target.

            • matchrequired — (map)

              An object that represents the criteria for determining a request match.

              • headers — (Array<map>)

                An object that represents the client request headers to match on.

                • invert — (Boolean)

                  Specify True to match anything except the match criteria. The default value is False.

                • match — (map)

                  The HeaderMatchMethod object.

                  • exact — (String)

                    The value sent by the client must match the specified value exactly.

                  • prefix — (String)

                    The value sent by the client must begin with the specified characters.

                  • range — (map)

                    An object that represents the range of values to match on.

                    • endrequired — (Integer)

                      The end of the range.

                    • startrequired — (Integer)

                      The start of the range.

                  • regex — (String)

                    The value sent by the client must include the specified characters.

                  • suffix — (String)

                    The value sent by the client must end with the specified characters.

                • namerequired — (String)

                  A name for the HTTP header in the client request that will be matched on.

              • method — (String)

                The client request method to match on. Specify only one.

                Possible values include:
                • "CONNECT"
                • "DELETE"
                • "GET"
                • "HEAD"
                • "OPTIONS"
                • "PATCH"
                • "POST"
                • "PUT"
                • "TRACE"
              • prefixrequired — (String)

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

              • scheme — (String)

                The client request scheme to match on. Specify only one.

                Possible values include:
                • "http"
                • "https"
            • retryPolicy — (map)

              An object that represents a retry policy.

              • httpRetryEvents — (Array<String>)

                Specify at least one of the following values.

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

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

                • client-error – HTTP status code 409

                • stream-error – Retry on refused stream

              • maxRetriesrequired — (Integer)

                The maximum number of retry attempts.

              • perRetryTimeoutrequired — (map)

                An object that represents a duration of time.

                • unit — (String)

                  A unit of time.

                  Possible values include:
                  • "ms"
                  • "s"
                • value — (Integer)

                  A number of time units.

              • tcpRetryEvents — (Array<String>)

                Specify a valid value.

          • httpRoute — (map)

            An object that represents the specification of an HTTP route.

            • actionrequired — (map)

              An object that represents the action to take if a match is determined.

              • weightedTargetsrequired — (Array<map>)

                An object that represents the targets that traffic is routed to when a request matches the route.

                • virtualNoderequired — (String)

                  The virtual node to associate with the weighted target.

                • weightrequired — (Integer)

                  The relative weight of the weighted target.

            • matchrequired — (map)

              An object that represents the criteria for determining a request match.

              • headers — (Array<map>)

                An object that represents the client request headers to match on.

                • invert — (Boolean)

                  Specify True to match anything except the match criteria. The default value is False.

                • match — (map)

                  The HeaderMatchMethod object.

                  • exact — (String)

                    The value sent by the client must match the specified value exactly.

                  • prefix — (String)

                    The value sent by the client must begin with the specified characters.

                  • range — (map)

                    An object that represents the range of values to match on.

                    • endrequired — (Integer)

                      The end of the range.

                    • startrequired — (Integer)

                      The start of the range.

                  • regex — (String)

                    The value sent by the client must include the specified characters.

                  • suffix — (String)

                    The value sent by the client must end with the specified characters.

                • namerequired — (String)

                  A name for the HTTP header in the client request that will be matched on.

              • method — (String)

                The client request method to match on. Specify only one.

                Possible values include:
                • "CONNECT"
                • "DELETE"
                • "GET"
                • "HEAD"
                • "OPTIONS"
                • "PATCH"
                • "POST"
                • "PUT"
                • "TRACE"
              • prefixrequired — (String)

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

              • scheme — (String)

                The client request scheme to match on. Specify only one.

                Possible values include:
                • "http"
                • "https"
            • retryPolicy — (map)

              An object that represents a retry policy.

              • httpRetryEvents — (Array<String>)

                Specify at least one of the following values.

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

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

                • client-error – HTTP status code 409

                • stream-error – Retry on refused stream

              • maxRetriesrequired — (Integer)

                The maximum number of retry attempts.

              • perRetryTimeoutrequired — (map)

                An object that represents a duration of time.

                • unit — (String)

                  A unit of time.

                  Possible values include:
                  • "ms"
                  • "s"
                • value — (Integer)

                  A number of time units.

              • tcpRetryEvents — (Array<String>)

                Specify a valid value.

          • priority — (Integer)

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

          • tcpRoute — (map)

            An object that represents the specification of a TCP route.

            • actionrequired — (map)

              The action to take if a match is determined.

              • weightedTargetsrequired — (Array<map>)

                An object that represents the targets that traffic is routed to when a request matches the route.

                • virtualNoderequired — (String)

                  The virtual node to associate with the weighted target.

                • weightrequired — (Integer)

                  The relative weight of the weighted target.

        • statusrequired — (map)

          The status of the route.

          • statusrequired — (String)

            The current status for the route.

            Possible values include:
            • "ACTIVE"
            • "DELETED"
            • "INACTIVE"
        • virtualRouterNamerequired — (String)

          The virtual router that the route is associated with.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Creates a virtual node within a service mesh.

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

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:

Examples:

Calling the createVirtualNode operation

var params = {
  meshName: 'STRING_VALUE', /* required */
  spec: { /* required */
    backends: [
      {
        virtualService: {
          virtualServiceName: 'STRING_VALUE' /* required */
        }
      },
      /* more items */
    ],
    listeners: [
      {
        portMapping: { /* required */
          port: 'NUMBER_VALUE', /* required */
          protocol: grpc | http | http2 | tcp /* required */
        },
        healthCheck: {
          healthyThreshold: 'NUMBER_VALUE', /* required */
          intervalMillis: 'NUMBER_VALUE', /* required */
          protocol: grpc | http | http2 | tcp, /* required */
          timeoutMillis: 'NUMBER_VALUE', /* required */
          unhealthyThreshold: 'NUMBER_VALUE', /* required */
          path: 'STRING_VALUE',
          port: 'NUMBER_VALUE'
        }
      },
      /* more items */
    ],
    logging: {
      accessLog: {
        file: {
          path: 'STRING_VALUE' /* required */
        }
      }
    },
    serviceDiscovery: {
      awsCloudMap: {
        namespaceName: 'STRING_VALUE', /* required */
        serviceName: 'STRING_VALUE', /* required */
        attributes: [
          {
            key: 'STRING_VALUE', /* required */
            value: 'STRING_VALUE' /* required */
          },
          /* more items */
        ]
      },
      dns: {
        hostname: 'STRING_VALUE' /* required */
      }
    }
  },
  virtualNodeName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
appmesh.createVirtualNode(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

      If a token is not provided, the SDK will use a version 4 UUID.
    • meshName — (String)

      The name of the service mesh to create the virtual node in.

    • spec — (map)

      The virtual node specification to apply.

      • backends — (Array<map>)

        The backends that the virtual node is expected to send outbound traffic to.

        • virtualService — (map)

          Specifies a virtual service to use as a backend for a virtual node.

          • virtualServiceNamerequired — (String)

            The name of the virtual service that is acting as a virtual node backend.

      • listeners — (Array<map>)

        The listeners that the virtual node is expected to receive inbound traffic from. You can specify one listener.

        • healthCheck — (map)

          The health check information for the listener.

          • healthyThresholdrequired — (Integer)

            The number of consecutive successful health checks that must occur before declaring listener healthy.

          • intervalMillisrequired — (Integer)

            The time period in milliseconds between each health check execution.

          • path — (String)

            The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, 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.

          • protocolrequired — (String)

            The protocol for the health check request.

            Possible values include:
            • "grpc"
            • "http"
            • "http2"
            • "tcp"
          • timeoutMillisrequired — (Integer)

            The amount of time to wait when receiving a response from the health check, in milliseconds.

          • unhealthyThresholdrequired — (Integer)

            The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

        • portMappingrequired — (map)

          The port mapping information for the listener.

          • portrequired — (Integer)

            The port used for the port mapping.

          • protocolrequired — (String)

            The protocol used for the port mapping. Specify one protocol.

            Possible values include:
            • "grpc"
            • "http"
            • "http2"
            • "tcp"
      • logging — (map)

        The inbound and outbound access logging information for the virtual node.

        • accessLog — (map)

          The access log configuration for a virtual node.

          • file — (map)

            The file object to send virtual node access logs to.

            • pathrequired — (String)

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

              Note: The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.
      • serviceDiscovery — (map)

        The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter.

        • awsCloudMap — (map)

          Specifies any AWS Cloud Map information for the virtual node.

          • attributes — (Array<map>)

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

            • keyrequired — (String)

              The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

            • valuerequired — (String)

              The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

          • namespaceNamerequired — (String)

            The name of the AWS Cloud Map namespace to use.

          • serviceNamerequired — (String)

            The name of the AWS Cloud Map service to use.

        • dns — (map)

          Specifies the DNS information for the virtual node.

          • hostnamerequired — (String)

            Specifies the DNS service discovery hostname for the virtual node.

    • tags — (Array<map>)

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

      • keyrequired — (String)

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

      • value — (String)

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

    • virtualNodeName — (String)

      The name to use for the virtual node.

Callback (callback):

  • function(err, data) { ... }

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

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

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

      • virtualNode — (map)

        The full description of your virtual node following the create call.

        • meshNamerequired — (String)

          The name of the service mesh that the virtual node resides in.

        • metadatarequired — (map)

          The associated metadata for the virtual node.

          • arnrequired — (String)

            The full Amazon Resource Name (ARN) for the resource.

          • createdAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was created.

          • lastUpdatedAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was last updated.

          • uidrequired — (String)

            The unique identifier for the resource.

          • versionrequired — (Integer)

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

        • specrequired — (map)

          The specifications of the virtual node.

          • backends — (Array<map>)

            The backends that the virtual node is expected to send outbound traffic to.

            • virtualService — (map)

              Specifies a virtual service to use as a backend for a virtual node.

              • virtualServiceNamerequired — (String)

                The name of the virtual service that is acting as a virtual node backend.

          • listeners — (Array<map>)

            The listeners that the virtual node is expected to receive inbound traffic from. You can specify one listener.

            • healthCheck — (map)

              The health check information for the listener.

              • healthyThresholdrequired — (Integer)

                The number of consecutive successful health checks that must occur before declaring listener healthy.

              • intervalMillisrequired — (Integer)

                The time period in milliseconds between each health check execution.

              • path — (String)

                The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, 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.

              • protocolrequired — (String)

                The protocol for the health check request.

                Possible values include:
                • "grpc"
                • "http"
                • "http2"
                • "tcp"
              • timeoutMillisrequired — (Integer)

                The amount of time to wait when receiving a response from the health check, in milliseconds.

              • unhealthyThresholdrequired — (Integer)

                The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

            • portMappingrequired — (map)

              The port mapping information for the listener.

              • portrequired — (Integer)

                The port used for the port mapping.

              • protocolrequired — (String)

                The protocol used for the port mapping. Specify one protocol.

                Possible values include:
                • "grpc"
                • "http"
                • "http2"
                • "tcp"
          • logging — (map)

            The inbound and outbound access logging information for the virtual node.

            • accessLog — (map)

              The access log configuration for a virtual node.

              • file — (map)

                The file object to send virtual node access logs to.

                • pathrequired — (String)

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

                  Note: The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.
          • serviceDiscovery — (map)

            The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter.

            • awsCloudMap — (map)

              Specifies any AWS Cloud Map information for the virtual node.

              • attributes — (Array<map>)

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

                • keyrequired — (String)

                  The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

                • valuerequired — (String)

                  The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

              • namespaceNamerequired — (String)

                The name of the AWS Cloud Map namespace to use.

              • serviceNamerequired — (String)

                The name of the AWS Cloud Map service to use.

            • dns — (map)

              Specifies the DNS information for the virtual node.

              • hostnamerequired — (String)

                Specifies the DNS service discovery hostname for the virtual node.

        • statusrequired — (map)

          The current status for the virtual node.

          • statusrequired — (String)

            The current status of the virtual node.

            Possible values include:
            • "ACTIVE"
            • "DELETED"
            • "INACTIVE"
        • virtualNodeNamerequired — (String)

          The name of the virtual node.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Creates a virtual router within a service mesh.

Any inbound traffic that your virtual router expects should be specified as a listener.

Virtual routers handle traffic for one or more virtual services within your mesh. After you create your virtual router, create and associate routes for your virtual router that direct incoming requests to different virtual nodes.

Service Reference:

Examples:

Calling the createVirtualRouter operation

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

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

      If a token is not provided, the SDK will use a version 4 UUID.
    • meshName — (String)

      The name of the service mesh to create the virtual router in.

    • spec — (map)

      The virtual router specification to apply.

      • listeners — (Array<map>)

        The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.

        • portMappingrequired — (map)

          An object that represents a port mapping.

          • portrequired — (Integer)

            The port used for the port mapping.

          • protocolrequired — (String)

            The protocol used for the port mapping. Specify one protocol.

            Possible values include:
            • "grpc"
            • "http"
            • "http2"
            • "tcp"
    • tags — (Array<map>)

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

      • keyrequired — (String)

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

      • value — (String)

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

    • virtualRouterName — (String)

      The name to use for the virtual router.

Callback (callback):

  • function(err, data) { ... }

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

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

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

      • virtualRouter — (map)

        The full description of your virtual router following the create call.

        • meshNamerequired — (String)

          The name of the service mesh that the virtual router resides in.

        • metadatarequired — (map)

          The associated metadata for the virtual router.

          • arnrequired — (String)

            The full Amazon Resource Name (ARN) for the resource.

          • createdAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was created.

          • lastUpdatedAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was last updated.

          • uidrequired — (String)

            The unique identifier for the resource.

          • versionrequired — (Integer)

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

        • specrequired — (map)

          The specifications of the virtual router.

          • listeners — (Array<map>)

            The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.

            • portMappingrequired — (map)

              An object that represents a port mapping.

              • portrequired — (Integer)

                The port used for the port mapping.

              • protocolrequired — (String)

                The protocol used for the port mapping. Specify one protocol.

                Possible values include:
                • "grpc"
                • "http"
                • "http2"
                • "tcp"
        • statusrequired — (map)

          The current status of the virtual router.

          • statusrequired — (String)

            The current status of the virtual router.

            Possible values include:
            • "ACTIVE"
            • "DELETED"
            • "INACTIVE"
        • virtualRouterNamerequired — (String)

          The name of the virtual router.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Creates a virtual service within a service mesh.

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

Service Reference:

Examples:

Calling the createVirtualService operation

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

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

      If a token is not provided, the SDK will use a version 4 UUID.
    • meshName — (String)

      The name of the service mesh to create the virtual service in.

    • spec — (map)

      The virtual service specification to apply.

      • provider — (map)

        The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.

        • virtualNode — (map)

          The virtual node associated with a virtual service.

          • virtualNodeNamerequired — (String)

            The name of the virtual node that is acting as a service provider.

        • virtualRouter — (map)

          The virtual router associated with a virtual service.

          • virtualRouterNamerequired — (String)

            The name of the virtual router that is acting as a service provider.

    • tags — (Array<map>)

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

      • keyrequired — (String)

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

      • value — (String)

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

    • virtualServiceName — (String)

      The name to use for the virtual service.

Callback (callback):

  • function(err, data) { ... }

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

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

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

      • virtualService — (map)

        The full description of your virtual service following the create call.

        • meshNamerequired — (String)

          The name of the service mesh that the virtual service resides in.

        • metadatarequired — (map)

          An object that represents metadata for a resource.

          • arnrequired — (String)

            The full Amazon Resource Name (ARN) for the resource.

          • createdAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was created.

          • lastUpdatedAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was last updated.

          • uidrequired — (String)

            The unique identifier for the resource.

          • versionrequired — (Integer)

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

        • specrequired — (map)

          The specifications of the virtual service.

          • provider — (map)

            The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.

            • virtualNode — (map)

              The virtual node associated with a virtual service.

              • virtualNodeNamerequired — (String)

                The name of the virtual node that is acting as a service provider.

            • virtualRouter — (map)

              The virtual router associated with a virtual service.

              • virtualRouterNamerequired — (String)

                The name of the virtual router that is acting as a service provider.

        • statusrequired — (map)

          The current status of the virtual service.

          • statusrequired — (String)

            The current status of the virtual service.

            Possible values include:
            • "ACTIVE"
            • "DELETED"
            • "INACTIVE"
        • virtualServiceNamerequired — (String)

          The name of the virtual service.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deletes an existing service mesh.

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

Service Reference:

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.

        • meshNamerequired — (String)

          The name of the service mesh.

        • metadatarequired — (map)

          The associated metadata for the service mesh.

          • arnrequired — (String)

            The full Amazon Resource Name (ARN) for the resource.

          • createdAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was created.

          • lastUpdatedAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was last updated.

          • uidrequired — (String)

            The unique identifier for the resource.

          • versionrequired — (Integer)

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

        • specrequired — (map)

          The associated specification for the service mesh.

          • egressFilter — (map)

            The egress filter rules for the service mesh.

            • typerequired — (String)

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

              Possible values include:
              • "ALLOW_ALL"
              • "DROP_ALL"
        • statusrequired — (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:

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 to delete the route in.

    • routeName — (String)

      The name of the route to delete.

    • virtualRouterName — (String)

      The name of the virtual router to delete the route in.

Callback (callback):

  • function(err, data) { ... }

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

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

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

      • route — (map)

        The route that was deleted.

        • meshNamerequired — (String)

          The name of the service mesh that the route resides in.

        • metadatarequired — (map)

          The associated metadata for the route.

          • arnrequired — (String)

            The full Amazon Resource Name (ARN) for the resource.

          • createdAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was created.

          • lastUpdatedAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was last updated.

          • uidrequired — (String)

            The unique identifier for the resource.

          • versionrequired — (Integer)

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

        • routeNamerequired — (String)

          The name of the route.

        • specrequired — (map)

          The specifications of the route.

          • grpcRoute — (map)

            An object that represents the specification of a GRPC route.

            • actionrequired — (map)

              An object that represents the action to take if a match is determined.

              • weightedTargetsrequired — (Array<map>)

                An object that represents the targets that traffic is routed to when a request matches the route.

                • virtualNoderequired — (String)

                  The virtual node to associate with the weighted target.

                • weightrequired — (Integer)

                  The relative weight of the weighted target.

            • matchrequired — (map)

              An object that represents the criteria for determining a request match.

              • metadata — (Array<map>)

                An object that represents the data to match from the request.

                • invert — (Boolean)

                  Specify True to match anything except the match criteria. The default value is False.

                • match — (map)

                  An object that represents the data to match from the request.

                  • exact — (String)

                    The value sent by the client must match the specified value exactly.

                  • prefix — (String)

                    The value sent by the client must begin with the specified characters.

                  • range — (map)

                    An object that represents the range of values to match on.

                    • endrequired — (Integer)

                      The end of the range.

                    • startrequired — (Integer)

                      The start of the range.

                  • regex — (String)

                    The value sent by the client must include the specified characters.

                  • suffix — (String)

                    The value sent by the client must end with the specified characters.

                • namerequired — (String)

                  The name of the route.

              • methodName — (String)

                The method name to match from the request. If you specify a name, you must also specify a serviceName.

              • serviceName — (String)

                The fully qualified domain name for the service to match from the request.

            • retryPolicy — (map)

              An object that represents a retry policy.

              • grpcRetryEvents — (Array<String>)

                Specify at least one of the valid values.

              • httpRetryEvents — (Array<String>)

                Specify at least one of the following values.

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

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

                • client-error – HTTP status code 409

                • stream-error – Retry on refused stream

              • maxRetriesrequired — (Integer)

                The maximum number of retry attempts.

              • perRetryTimeoutrequired — (map)

                An object that represents a duration of time.

                • unit — (String)

                  A unit of time.

                  Possible values include:
                  • "ms"
                  • "s"
                • value — (Integer)

                  A number of time units.

              • tcpRetryEvents — (Array<String>)

                Specify a valid value.

          • http2Route — (map)

            An object that represents the specification of an HTTP2 route.

            • actionrequired — (map)

              An object that represents the action to take if a match is determined.

              • weightedTargetsrequired — (Array<map>)

                An object that represents the targets that traffic is routed to when a request matches the route.

                • virtualNoderequired — (String)

                  The virtual node to associate with the weighted target.

                • weightrequired — (Integer)

                  The relative weight of the weighted target.

            • matchrequired — (map)

              An object that represents the criteria for determining a request match.

              • headers — (Array<map>)

                An object that represents the client request headers to match on.

                • invert — (Boolean)

                  Specify True to match anything except the match criteria. The default value is False.

                • match — (map)

                  The HeaderMatchMethod object.

                  • exact — (String)

                    The value sent by the client must match the specified value exactly.

                  • prefix — (String)

                    The value sent by the client must begin with the specified characters.

                  • range — (map)

                    An object that represents the range of values to match on.

                    • endrequired — (Integer)

                      The end of the range.

                    • startrequired — (Integer)

                      The start of the range.

                  • regex — (String)

                    The value sent by the client must include the specified characters.

                  • suffix — (String)

                    The value sent by the client must end with the specified characters.

                • namerequired — (String)

                  A name for the HTTP header in the client request that will be matched on.

              • method — (String)

                The client request method to match on. Specify only one.

                Possible values include:
                • "CONNECT"
                • "DELETE"
                • "GET"
                • "HEAD"
                • "OPTIONS"
                • "PATCH"
                • "POST"
                • "PUT"
                • "TRACE"
              • prefixrequired — (String)

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

              • scheme — (String)

                The client request scheme to match on. Specify only one.

                Possible values include:
                • "http"
                • "https"
            • retryPolicy — (map)

              An object that represents a retry policy.

              • httpRetryEvents — (Array<String>)

                Specify at least one of the following values.

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

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

                • client-error – HTTP status code 409

                • stream-error – Retry on refused stream

              • maxRetriesrequired — (Integer)

                The maximum number of retry attempts.

              • perRetryTimeoutrequired — (map)

                An object that represents a duration of time.

                • unit — (String)

                  A unit of time.

                  Possible values include:
                  • "ms"
                  • "s"
                • value — (Integer)

                  A number of time units.

              • tcpRetryEvents — (Array<String>)

                Specify a valid value.

          • httpRoute — (map)

            An object that represents the specification of an HTTP route.

            • actionrequired — (map)

              An object that represents the action to take if a match is determined.

              • weightedTargetsrequired — (Array<map>)

                An object that represents the targets that traffic is routed to when a request matches the route.

                • virtualNoderequired — (String)

                  The virtual node to associate with the weighted target.

                • weightrequired — (Integer)

                  The relative weight of the weighted target.

            • matchrequired — (map)

              An object that represents the criteria for determining a request match.

              • headers — (Array<map>)

                An object that represents the client request headers to match on.

                • invert — (Boolean)

                  Specify True to match anything except the match criteria. The default value is False.

                • match — (map)

                  The HeaderMatchMethod object.

                  • exact — (String)

                    The value sent by the client must match the specified value exactly.

                  • prefix — (String)

                    The value sent by the client must begin with the specified characters.

                  • range — (map)

                    An object that represents the range of values to match on.

                    • endrequired — (Integer)

                      The end of the range.

                    • startrequired — (Integer)

                      The start of the range.

                  • regex — (String)

                    The value sent by the client must include the specified characters.

                  • suffix — (String)

                    The value sent by the client must end with the specified characters.

                • namerequired — (String)

                  A name for the HTTP header in the client request that will be matched on.

              • method — (String)

                The client request method to match on. Specify only one.

                Possible values include:
                • "CONNECT"
                • "DELETE"
                • "GET"
                • "HEAD"
                • "OPTIONS"
                • "PATCH"
                • "POST"
                • "PUT"
                • "TRACE"
              • prefixrequired — (String)

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

              • scheme — (String)

                The client request scheme to match on. Specify only one.

                Possible values include:
                • "http"
                • "https"
            • retryPolicy — (map)

              An object that represents a retry policy.

              • httpRetryEvents — (Array<String>)

                Specify at least one of the following values.

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

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

                • client-error – HTTP status code 409

                • stream-error – Retry on refused stream

              • maxRetriesrequired — (Integer)

                The maximum number of retry attempts.

              • perRetryTimeoutrequired — (map)

                An object that represents a duration of time.

                • unit — (String)

                  A unit of time.

                  Possible values include:
                  • "ms"
                  • "s"
                • value — (Integer)

                  A number of time units.

              • tcpRetryEvents — (Array<String>)

                Specify a valid value.

          • priority — (Integer)

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

          • tcpRoute — (map)

            An object that represents the specification of a TCP route.

            • actionrequired — (map)

              The action to take if a match is determined.

              • weightedTargetsrequired — (Array<map>)

                An object that represents the targets that traffic is routed to when a request matches the route.

                • virtualNoderequired — (String)

                  The virtual node to associate with the weighted target.

                • weightrequired — (Integer)

                  The relative weight of the weighted target.

        • statusrequired — (map)

          The status of the route.

          • statusrequired — (String)

            The current status for the route.

            Possible values include:
            • "ACTIVE"
            • "DELETED"
            • "INACTIVE"
        • virtualRouterNamerequired — (String)

          The virtual router that the route is associated with.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deletes an existing virtual node.

You must delete any virtual services that list a virtual node as a service provider before you can delete the virtual node itself.

Service Reference:

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 to delete the virtual node in.

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

        • meshNamerequired — (String)

          The name of the service mesh that the virtual node resides in.

        • metadatarequired — (map)

          The associated metadata for the virtual node.

          • arnrequired — (String)

            The full Amazon Resource Name (ARN) for the resource.

          • createdAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was created.

          • lastUpdatedAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was last updated.

          • uidrequired — (String)

            The unique identifier for the resource.

          • versionrequired — (Integer)

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

        • specrequired — (map)

          The specifications of the virtual node.

          • backends — (Array<map>)

            The backends that the virtual node is expected to send outbound traffic to.

            • virtualService — (map)

              Specifies a virtual service to use as a backend for a virtual node.

              • virtualServiceNamerequired — (String)

                The name of the virtual service that is acting as a virtual node backend.

          • listeners — (Array<map>)

            The listeners that the virtual node is expected to receive inbound traffic from. You can specify one listener.

            • healthCheck — (map)

              The health check information for the listener.

              • healthyThresholdrequired — (Integer)

                The number of consecutive successful health checks that must occur before declaring listener healthy.

              • intervalMillisrequired — (Integer)

                The time period in milliseconds between each health check execution.

              • path — (String)

                The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, 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.

              • protocolrequired — (String)

                The protocol for the health check request.

                Possible values include:
                • "grpc"
                • "http"
                • "http2"
                • "tcp"
              • timeoutMillisrequired — (Integer)

                The amount of time to wait when receiving a response from the health check, in milliseconds.

              • unhealthyThresholdrequired — (Integer)

                The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

            • portMappingrequired — (map)

              The port mapping information for the listener.

              • portrequired — (Integer)

                The port used for the port mapping.

              • protocolrequired — (String)

                The protocol used for the port mapping. Specify one protocol.

                Possible values include:
                • "grpc"
                • "http"
                • "http2"
                • "tcp"
          • logging — (map)

            The inbound and outbound access logging information for the virtual node.

            • accessLog — (map)

              The access log configuration for a virtual node.

              • file — (map)

                The file object to send virtual node access logs to.

                • pathrequired — (String)

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

                  Note: The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.
          • serviceDiscovery — (map)

            The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter.

            • awsCloudMap — (map)

              Specifies any AWS Cloud Map information for the virtual node.

              • attributes — (Array<map>)

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

                • keyrequired — (String)

                  The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

                • valuerequired — (String)

                  The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

              • namespaceNamerequired — (String)

                The name of the AWS Cloud Map namespace to use.

              • serviceNamerequired — (String)

                The name of the AWS Cloud Map service to use.

            • dns — (map)

              Specifies the DNS information for the virtual node.

              • hostnamerequired — (String)

                Specifies the DNS service discovery hostname for the virtual node.

        • statusrequired — (map)

          The current status for the virtual node.

          • statusrequired — (String)

            The current status of the virtual node.

            Possible values include:
            • "ACTIVE"
            • "DELETED"
            • "INACTIVE"
        • virtualNodeNamerequired — (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:

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 to delete the virtual router in.

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

        • meshNamerequired — (String)

          The name of the service mesh that the virtual router resides in.

        • metadatarequired — (map)

          The associated metadata for the virtual router.

          • arnrequired — (String)

            The full Amazon Resource Name (ARN) for the resource.

          • createdAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was created.

          • lastUpdatedAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was last updated.

          • uidrequired — (String)

            The unique identifier for the resource.

          • versionrequired — (Integer)

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

        • specrequired — (map)

          The specifications of the virtual router.

          • listeners — (Array<map>)

            The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.

            • portMappingrequired — (map)

              An object that represents a port mapping.

              • portrequired — (Integer)

                The port used for the port mapping.

              • protocolrequired — (String)

                The protocol used for the port mapping. Specify one protocol.

                Possible values include:
                • "grpc"
                • "http"
                • "http2"
                • "tcp"
        • statusrequired — (map)

          The current status of the virtual router.

          • statusrequired — (String)

            The current status of the virtual router.

            Possible values include:
            • "ACTIVE"
            • "DELETED"
            • "INACTIVE"
        • virtualRouterNamerequired — (String)

          The name of the virtual router.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deletes an existing virtual service.

Service Reference:

Examples:

Calling the deleteVirtualService operation

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

Parameters:

  • params (Object) (defaults to: {})
    • meshName — (String)

      The name of the service mesh to delete the virtual service in.

    • virtualServiceName — (String)

      The name of the virtual service to delete.

Callback (callback):

  • function(err, data) { ... }

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

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

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

      • virtualService — (map)

        The virtual service that was deleted.

        • meshNamerequired — (String)

          The name of the service mesh that the virtual service resides in.

        • metadatarequired — (map)

          An object that represents metadata for a resource.

          • arnrequired — (String)

            The full Amazon Resource Name (ARN) for the resource.

          • createdAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was created.

          • lastUpdatedAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was last updated.

          • uidrequired — (String)

            The unique identifier for the resource.

          • versionrequired — (Integer)

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

        • specrequired — (map)

          The specifications of the virtual service.

          • provider — (map)

            The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.

            • virtualNode — (map)

              The virtual node associated with a virtual service.

              • virtualNodeNamerequired — (String)

                The name of the virtual node that is acting as a service provider.

            • virtualRouter — (map)

              The virtual router associated with a virtual service.

              • virtualRouterNamerequired — (String)

                The name of the virtual router that is acting as a service provider.

        • statusrequired — (map)

          The current status of the virtual service.

          • statusrequired — (String)

            The current status of the virtual service.

            Possible values include:
            • "ACTIVE"
            • "DELETED"
            • "INACTIVE"
        • virtualServiceNamerequired — (String)

          The name of the virtual service.

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:

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.

        • meshNamerequired — (String)

          The name of the service mesh.

        • metadatarequired — (map)

          The associated metadata for the service mesh.

          • arnrequired — (String)

            The full Amazon Resource Name (ARN) for the resource.

          • createdAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was created.

          • lastUpdatedAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was last updated.

          • uidrequired — (String)

            The unique identifier for the resource.

          • versionrequired — (Integer)

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

        • specrequired — (map)

          The associated specification for the service mesh.

          • egressFilter — (map)

            The egress filter rules for the service mesh.

            • typerequired — (String)

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

              Possible values include:
              • "ALLOW_ALL"
              • "DROP_ALL"
        • statusrequired — (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:

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 that the route resides in.

    • routeName — (String)

      The name of the route to describe.

    • virtualRouterName — (String)

      The name of the virtual router that the route is associated with.

Callback (callback):

  • function(err, data) { ... }

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

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

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

      • route — (map)

        The full description of your route.

        • meshNamerequired — (String)

          The name of the service mesh that the route resides in.

        • metadatarequired — (map)

          The associated metadata for the route.

          • arnrequired — (String)

            The full Amazon Resource Name (ARN) for the resource.

          • createdAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was created.

          • lastUpdatedAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was last updated.

          • uidrequired — (String)

            The unique identifier for the resource.

          • versionrequired — (Integer)

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

        • routeNamerequired — (String)

          The name of the route.

        • specrequired — (map)

          The specifications of the route.

          • grpcRoute — (map)

            An object that represents the specification of a GRPC route.

            • actionrequired — (map)

              An object that represents the action to take if a match is determined.

              • weightedTargetsrequired — (Array<map>)

                An object that represents the targets that traffic is routed to when a request matches the route.

                • virtualNoderequired — (String)

                  The virtual node to associate with the weighted target.

                • weightrequired — (Integer)

                  The relative weight of the weighted target.

            • matchrequired — (map)

              An object that represents the criteria for determining a request match.

              • metadata — (Array<map>)

                An object that represents the data to match from the request.

                • invert — (Boolean)

                  Specify True to match anything except the match criteria. The default value is False.

                • match — (map)

                  An object that represents the data to match from the request.

                  • exact — (String)

                    The value sent by the client must match the specified value exactly.

                  • prefix — (String)

                    The value sent by the client must begin with the specified characters.

                  • range — (map)

                    An object that represents the range of values to match on.

                    • endrequired — (Integer)

                      The end of the range.

                    • startrequired — (Integer)

                      The start of the range.

                  • regex — (String)

                    The value sent by the client must include the specified characters.

                  • suffix — (String)

                    The value sent by the client must end with the specified characters.

                • namerequired — (String)

                  The name of the route.

              • methodName — (String)

                The method name to match from the request. If you specify a name, you must also specify a serviceName.

              • serviceName — (String)

                The fully qualified domain name for the service to match from the request.

            • retryPolicy — (map)

              An object that represents a retry policy.

              • grpcRetryEvents — (Array<String>)

                Specify at least one of the valid values.

              • httpRetryEvents — (Array<String>)

                Specify at least one of the following values.

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

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

                • client-error – HTTP status code 409

                • stream-error – Retry on refused stream

              • maxRetriesrequired — (Integer)

                The maximum number of retry attempts.

              • perRetryTimeoutrequired — (map)

                An object that represents a duration of time.

                • unit — (String)

                  A unit of time.

                  Possible values include:
                  • "ms"
                  • "s"
                • value — (Integer)

                  A number of time units.

              • tcpRetryEvents — (Array<String>)

                Specify a valid value.

          • http2Route — (map)

            An object that represents the specification of an HTTP2 route.

            • actionrequired — (map)

              An object that represents the action to take if a match is determined.

              • weightedTargetsrequired — (Array<map>)

                An object that represents the targets that traffic is routed to when a request matches the route.

                • virtualNoderequired — (String)

                  The virtual node to associate with the weighted target.

                • weightrequired — (Integer)

                  The relative weight of the weighted target.

            • matchrequired — (map)

              An object that represents the criteria for determining a request match.

              • headers — (Array<map>)

                An object that represents the client request headers to match on.

                • invert — (Boolean)

                  Specify True to match anything except the match criteria. The default value is False.

                • match — (map)

                  The HeaderMatchMethod object.

                  • exact — (String)

                    The value sent by the client must match the specified value exactly.

                  • prefix — (String)

                    The value sent by the client must begin with the specified characters.

                  • range — (map)

                    An object that represents the range of values to match on.

                    • endrequired — (Integer)

                      The end of the range.

                    • startrequired — (Integer)

                      The start of the range.

                  • regex — (String)

                    The value sent by the client must include the specified characters.

                  • suffix — (String)

                    The value sent by the client must end with the specified characters.

                • namerequired — (String)

                  A name for the HTTP header in the client request that will be matched on.

              • method — (String)

                The client request method to match on. Specify only one.

                Possible values include:
                • "CONNECT"
                • "DELETE"
                • "GET"
                • "HEAD"
                • "OPTIONS"
                • "PATCH"
                • "POST"
                • "PUT"
                • "TRACE"
              • prefixrequired — (String)

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

              • scheme — (String)

                The client request scheme to match on. Specify only one.

                Possible values include:
                • "http"
                • "https"
            • retryPolicy — (map)

              An object that represents a retry policy.

              • httpRetryEvents — (Array<String>)

                Specify at least one of the following values.

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

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

                • client-error – HTTP status code 409

                • stream-error – Retry on refused stream

              • maxRetriesrequired — (Integer)

                The maximum number of retry attempts.

              • perRetryTimeoutrequired — (map)

                An object that represents a duration of time.

                • unit — (String)

                  A unit of time.

                  Possible values include:
                  • "ms"
                  • "s"
                • value — (Integer)

                  A number of time units.

              • tcpRetryEvents — (Array<String>)

                Specify a valid value.

          • httpRoute — (map)

            An object that represents the specification of an HTTP route.

            • actionrequired — (map)

              An object that represents the action to take if a match is determined.

              • weightedTargetsrequired — (Array<map>)

                An object that represents the targets that traffic is routed to when a request matches the route.

                • virtualNoderequired — (String)

                  The virtual node to associate with the weighted target.

                • weightrequired — (Integer)

                  The relative weight of the weighted target.

            • matchrequired — (map)

              An object that represents the criteria for determining a request match.

              • headers — (Array<map>)

                An object that represents the client request headers to match on.

                • invert — (Boolean)

                  Specify True to match anything except the match criteria. The default value is False.

                • match — (map)

                  The HeaderMatchMethod object.

                  • exact — (String)

                    The value sent by the client must match the specified value exactly.

                  • prefix — (String)

                    The value sent by the client must begin with the specified characters.

                  • range — (map)

                    An object that represents the range of values to match on.

                    • endrequired — (Integer)

                      The end of the range.

                    • startrequired — (Integer)

                      The start of the range.

                  • regex — (String)

                    The value sent by the client must include the specified characters.

                  • suffix — (String)

                    The value sent by the client must end with the specified characters.

                • namerequired — (String)

                  A name for the HTTP header in the client request that will be matched on.

              • method — (String)

                The client request method to match on. Specify only one.

                Possible values include:
                • "CONNECT"
                • "DELETE"
                • "GET"
                • "HEAD"
                • "OPTIONS"
                • "PATCH"
                • "POST"
                • "PUT"
                • "TRACE"
              • prefixrequired — (String)

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

              • scheme — (String)

                The client request scheme to match on. Specify only one.

                Possible values include:
                • "http"
                • "https"
            • retryPolicy — (map)

              An object that represents a retry policy.

              • httpRetryEvents — (Array<String>)

                Specify at least one of the following values.

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

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

                • client-error – HTTP status code 409

                • stream-error – Retry on refused stream

              • maxRetriesrequired — (Integer)

                The maximum number of retry attempts.

              • perRetryTimeoutrequired — (map)

                An object that represents a duration of time.

                • unit — (String)

                  A unit of time.

                  Possible values include:
                  • "ms"
                  • "s"
                • value — (Integer)

                  A number of time units.

              • tcpRetryEvents — (Array<String>)

                Specify a valid value.

          • priority — (Integer)

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

          • tcpRoute — (map)

            An object that represents the specification of a TCP route.

            • actionrequired — (map)

              The action to take if a match is determined.

              • weightedTargetsrequired — (Array<map>)

                An object that represents the targets that traffic is routed to when a request matches the route.

                • virtualNoderequired — (String)

                  The virtual node to associate with the weighted target.

                • weightrequired — (Integer)

                  The relative weight of the weighted target.

        • statusrequired — (map)

          The status of the route.

          • statusrequired — (String)

            The current status for the route.

            Possible values include:
            • "ACTIVE"
            • "DELETED"
            • "INACTIVE"
        • virtualRouterNamerequired — (String)

          The virtual router that the route is associated with.

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:

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 that the virtual node resides in.

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

        • meshNamerequired — (String)

          The name of the service mesh that the virtual node resides in.

        • metadatarequired — (map)

          The associated metadata for the virtual node.

          • arnrequired — (String)

            The full Amazon Resource Name (ARN) for the resource.

          • createdAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was created.

          • lastUpdatedAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was last updated.

          • uidrequired — (String)

            The unique identifier for the resource.

          • versionrequired — (Integer)

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

        • specrequired — (map)

          The specifications of the virtual node.

          • backends — (Array<map>)

            The backends that the virtual node is expected to send outbound traffic to.

            • virtualService — (map)

              Specifies a virtual service to use as a backend for a virtual node.

              • virtualServiceNamerequired — (String)

                The name of the virtual service that is acting as a virtual node backend.

          • listeners — (Array<map>)

            The listeners that the virtual node is expected to receive inbound traffic from. You can specify one listener.

            • healthCheck — (map)

              The health check information for the listener.

              • healthyThresholdrequired — (Integer)

                The number of consecutive successful health checks that must occur before declaring listener healthy.

              • intervalMillisrequired — (Integer)

                The time period in milliseconds between each health check execution.

              • path — (String)

                The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, 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.

              • protocolrequired — (String)

                The protocol for the health check request.

                Possible values include:
                • "grpc"
                • "http"
                • "http2"
                • "tcp"
              • timeoutMillisrequired — (Integer)

                The amount of time to wait when receiving a response from the health check, in milliseconds.

              • unhealthyThresholdrequired — (Integer)

                The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

            • portMappingrequired — (map)

              The port mapping information for the listener.

              • portrequired — (Integer)

                The port used for the port mapping.

              • protocolrequired — (String)

                The protocol used for the port mapping. Specify one protocol.

                Possible values include:
                • "grpc"
                • "http"
                • "http2"
                • "tcp"
          • logging — (map)

            The inbound and outbound access logging information for the virtual node.

            • accessLog — (map)

              The access log configuration for a virtual node.

              • file — (map)

                The file object to send virtual node access logs to.

                • pathrequired — (String)

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

                  Note: The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.
          • serviceDiscovery — (map)

            The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter.

            • awsCloudMap — (map)

              Specifies any AWS Cloud Map information for the virtual node.

              • attributes — (Array<map>)

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

                • keyrequired — (String)

                  The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

                • valuerequired — (String)

                  The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

              • namespaceNamerequired — (String)

                The name of the AWS Cloud Map namespace to use.

              • serviceNamerequired — (String)

                The name of the AWS Cloud Map service to use.

            • dns — (map)

              Specifies the DNS information for the virtual node.

              • hostnamerequired — (String)

                Specifies the DNS service discovery hostname for the virtual node.

        • statusrequired — (map)

          The current status for the virtual node.

          • statusrequired — (String)

            The current status of the virtual node.

            Possible values include:
            • "ACTIVE"
            • "DELETED"
            • "INACTIVE"
        • virtualNodeNamerequired — (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:

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 that the virtual router resides in.

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

        • meshNamerequired — (String)

          The name of the service mesh that the virtual router resides in.

        • metadatarequired — (map)

          The associated metadata for the virtual router.

          • arnrequired — (String)

            The full Amazon Resource Name (ARN) for the resource.

          • createdAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was created.

          • lastUpdatedAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was last updated.

          • uidrequired — (String)

            The unique identifier for the resource.

          • versionrequired — (Integer)

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

        • specrequired — (map)

          The specifications of the virtual router.

          • listeners — (Array<map>)

            The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.

            • portMappingrequired — (map)

              An object that represents a port mapping.

              • portrequired — (Integer)

                The port used for the port mapping.

              • protocolrequired — (String)

                The protocol used for the port mapping. Specify one protocol.

                Possible values include:
                • "grpc"
                • "http"
                • "http2"
                • "tcp"
        • statusrequired — (map)

          The current status of the virtual router.

          • statusrequired — (String)

            The current status of the virtual router.

            Possible values include:
            • "ACTIVE"
            • "DELETED"
            • "INACTIVE"
        • virtualRouterNamerequired — (String)

          The name of the virtual router.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Describes an existing virtual service.

Service Reference:

Examples:

Calling the describeVirtualService operation

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

Parameters:

  • params (Object) (defaults to: {})
    • meshName — (String)

      The name of the service mesh that the virtual service resides in.

    • virtualServiceName — (String)

      The name of the virtual service to describe.

Callback (callback):

  • function(err, data) { ... }

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

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

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

      • virtualService — (map)

        The full description of your virtual service.

        • meshNamerequired — (String)

          The name of the service mesh that the virtual service resides in.

        • metadatarequired — (map)

          An object that represents metadata for a resource.

          • arnrequired — (String)

            The full Amazon Resource Name (ARN) for the resource.

          • createdAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was created.

          • lastUpdatedAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was last updated.

          • uidrequired — (String)

            The unique identifier for the resource.

          • versionrequired — (Integer)

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

        • specrequired — (map)

          The specifications of the virtual service.

          • provider — (map)

            The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.

            • virtualNode — (map)

              The virtual node associated with a virtual service.

              • virtualNodeNamerequired — (String)

                The name of the virtual node that is acting as a service provider.

            • virtualRouter — (map)

              The virtual router associated with a virtual service.

              • virtualRouterNamerequired — (String)

                The name of the virtual router that is acting as a service provider.

        • statusrequired — (map)

          The current status of the virtual service.

          • statusrequired — (String)

            The current status of the virtual service.

            Possible values include:
            • "ACTIVE"
            • "DELETED"
            • "INACTIVE"
        • virtualServiceNamerequired — (String)

          The name of the virtual service.

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:

Examples:

Calling the listMeshes operation

var params = {
  limit: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
appmesh.listMeshes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • limit — (Integer)

      The maximum number of results returned by ListMeshes in paginated output. When you use this parameter, ListMeshes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListMeshes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListMeshes returns up to 100 results and a nextToken value if applicable.

    • nextToken — (String)

      The nextToken value returned from a previous paginated ListMeshes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

      Note: This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Callback (callback):

  • function(err, data) { ... }

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

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

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

      • meshes — (Array<map>)

        The list of existing service meshes.

        • arnrequired — (String)

          The full Amazon Resource Name (ARN) of the service mesh.

        • meshNamerequired — (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, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Returns a list of existing routes in a service mesh.

Service Reference:

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 results returned by ListRoutes in paginated output. When you use this parameter, ListRoutes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListRoutes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListRoutes returns up to 100 results and a nextToken value if applicable.

    • meshName — (String)

      The name of the service mesh to list routes in.

    • nextToken — (String)

      The nextToken value returned from a previous paginated ListRoutes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

    • virtualRouterName — (String)

      The name of the virtual router to list routes in.

Callback (callback):

  • function(err, data) { ... }

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

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

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

      • nextToken — (String)

        The nextToken value to include in a future ListRoutes request. When the results of a ListRoutes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

      • routes — (Array<map>)

        The list of existing routes for the specified service mesh and virtual router.

        • arnrequired — (String)

          The full Amazon Resource Name (ARN) for the route.

        • meshNamerequired — (String)

          The name of the service mesh that the route resides in.

        • routeNamerequired — (String)

          The name of the route.

        • virtualRouterNamerequired — (String)

          The virtual router that the route is associated with.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

List the tags for an App Mesh resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

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

Parameters:

  • params (Object) (defaults to: {})
    • limit — (Integer)

      The maximum number of tag results returned by ListTagsForResource in paginated output. When this parameter is used, ListTagsForResource returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListTagsForResource request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListTagsForResource returns up to 100 results and a nextToken value if applicable.

    • nextToken — (String)

      The nextToken value returned from a previous paginated ListTagsForResource request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

    • resourceArn — (String)

      The Amazon Resource Name (ARN) that identifies the resource to list the tags for.

Callback (callback):

  • function(err, data) { ... }

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

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

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

      • nextToken — (String)

        The nextToken value to include in a future ListTagsForResource request. When the results of a ListTagsForResource request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

      • tags — (Array<map>)

        The tags for the resource.

        • keyrequired — (String)

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

        • value — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Returns a list of existing virtual nodes.

Service Reference:

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 results returned by ListVirtualNodes in paginated output. When you use this parameter, ListVirtualNodes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualNodes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualNodes returns up to 100 results and a nextToken value if applicable.

    • meshName — (String)

      The name of the service mesh to list virtual nodes in.

    • nextToken — (String)

      The nextToken value returned from a previous paginated ListVirtualNodes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Callback (callback):

  • function(err, data) { ... }

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

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

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

      • nextToken — (String)

        The nextToken value to include in a future ListVirtualNodes request. When the results of a ListVirtualNodes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

      • virtualNodes — (Array<map>)

        The list of existing virtual nodes for the specified service mesh.

        • arnrequired — (String)

          The full Amazon Resource Name (ARN) for the virtual node.

        • meshNamerequired — (String)

          The name of the service mesh that the virtual node resides in.

        • virtualNodeNamerequired — (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:

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 results returned by ListVirtualRouters in paginated output. When you use this parameter, ListVirtualRouters returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualRouters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualRouters returns up to 100 results and a nextToken value if applicable.

    • meshName — (String)

      The name of the service mesh to list virtual routers in.

    • nextToken — (String)

      The nextToken value returned from a previous paginated ListVirtualRouters request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Callback (callback):

  • function(err, data) { ... }

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

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

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

      • nextToken — (String)

        The nextToken value to include in a future ListVirtualRouters request. When the results of a ListVirtualRouters request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

      • virtualRouters — (Array<map>)

        The list of existing virtual routers for the specified service mesh.

        • arnrequired — (String)

          The full Amazon Resource Name (ARN) for the virtual router.

        • meshNamerequired — (String)

          The name of the service mesh that the virtual router resides in.

        • virtualRouterNamerequired — (String)

          The name of the virtual router.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the listVirtualServices operation

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

Parameters:

  • params (Object) (defaults to: {})
    • limit — (Integer)

      The maximum number of results returned by ListVirtualServices in paginated output. When you use this parameter, ListVirtualServices returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualServices request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualServices returns up to 100 results and a nextToken value if applicable.

    • meshName — (String)

      The name of the service mesh to list virtual services in.

    • nextToken — (String)

      The nextToken value returned from a previous paginated ListVirtualServices request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Callback (callback):

  • function(err, data) { ... }

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

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

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

      • nextToken — (String)

        The nextToken value to include in a future ListVirtualServices request. When the results of a ListVirtualServices request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

      • virtualServices — (Array<map>)

        The list of existing virtual services for the specified service mesh.

        • arnrequired — (String)

          The full Amazon Resource Name (ARN) for the virtual service.

        • meshNamerequired — (String)

          The name of the service mesh that the virtual service resides in.

        • virtualServiceNamerequired — (String)

          The name of the virtual service.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: [ /* required */
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
appmesh.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource to add tags to.

    • tags — (Array<map>)

      The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

      • keyrequired — (String)

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

      • value — (String)

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

Callback (callback):

  • function(err, data) { ... }

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

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deletes specified tags from a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
appmesh.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource to delete tags from.

    • tagKeys — (Array<String>)

      The keys of the tags to be removed.

Callback (callback):

  • function(err, data) { ... }

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

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Updates an existing service mesh.

Service Reference:

Examples:

Calling the updateMesh operation

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

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

      If a token is not provided, the SDK will use a version 4 UUID.
    • meshName — (String)

      The name of the service mesh to update.

    • spec — (map)

      The service mesh specification to apply.

      • egressFilter — (map)

        The egress filter rules for the service mesh.

        • typerequired — (String)

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

          Possible values include:
          • "ALLOW_ALL"
          • "DROP_ALL"

Callback (callback):

  • function(err, data) { ... }

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

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

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

      • mesh — (map)

        An object that represents a service mesh returned by a describe operation.

        • meshNamerequired — (String)

          The name of the service mesh.

        • metadatarequired — (map)

          The associated metadata for the service mesh.

          • arnrequired — (String)

            The full Amazon Resource Name (ARN) for the resource.

          • createdAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was created.

          • lastUpdatedAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was last updated.

          • uidrequired — (String)

            The unique identifier for the resource.

          • versionrequired — (Integer)

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

        • specrequired — (map)

          The associated specification for the service mesh.

          • egressFilter — (map)

            The egress filter rules for the service mesh.

            • typerequired — (String)

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

              Possible values include:
              • "ALLOW_ALL"
              • "DROP_ALL"
        • statusrequired — (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.

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

Updates an existing route for a specified service mesh and virtual router.

Service Reference:

Examples:

Calling the updateRoute operation

var params = {
  meshName: 'STRING_VALUE', /* required */
  routeName: 'STRING_VALUE', /* required */
  spec: { /* required */
    grpcRoute: {
      action: { /* required */
        weightedTargets: [ /* required */
          {
            virtualNode: 'STRING_VALUE', /* required */
            weight: 'NUMBER_VALUE' /* required */
          },
          /* more items */
        ]
      },
      match: { /* required */
        metadata: [
          {
            name: 'STRING_VALUE', /* required */
            invert: true || false,
            match: {
              exact: 'STRING_VALUE',
              prefix: 'STRING_VALUE',
              range: {
                end: 'NUMBER_VALUE', /* required */
                start: 'NUMBER_VALUE' /* required */
              },
              regex: 'STRING_VALUE',
              suffix: 'STRING_VALUE'
            }
          },
          /* more items */
        ],
        methodName: 'STRING_VALUE',
        serviceName: 'STRING_VALUE'
      },
      retryPolicy: {
        maxRetries: 'NUMBER_VALUE', /* required */
        perRetryTimeout: { /* required */
          unit: ms | s,
          value: 'NUMBER_VALUE'
        },
        grpcRetryEvents: [
          cancelled | deadline-exceeded | internal | resource-exhausted | unavailable,
          /* more items */
        ],
        httpRetryEvents: [
          'STRING_VALUE',
          /* more items */
        ],
        tcpRetryEvents: [
          connection-error,
          /* more items */
        ]
      }
    },
    http2Route: {
      action: { /* required */
        weightedTargets: [ /* required */
          {
            virtualNode: 'STRING_VALUE', /* required */
            weight: 'NUMBER_VALUE' /* required */
          },
          /* more items */
        ]
      },
      match: { /* required */
        prefix: 'STRING_VALUE', /* required */
        headers: [
          {
            name: 'STRING_VALUE', /* required */
            invert: true || false,
            match: {
              exact: 'STRING_VALUE',
              prefix: 'STRING_VALUE',
              range: {
                end: 'NUMBER_VALUE', /* required */
                start: 'NUMBER_VALUE' /* required */
              },
              regex: 'STRING_VALUE',
              suffix: 'STRING_VALUE'
            }
          },
          /* more items */
        ],
        method: CONNECT | DELETE | GET | HEAD | OPTIONS | PATCH | POST | PUT | TRACE,
        scheme: http | https
      },
      retryPolicy: {
        maxRetries: 'NUMBER_VALUE', /* required */
        perRetryTimeout: { /* required */
          unit: ms | s,
          value: 'NUMBER_VALUE'
        },
        httpRetryEvents: [
          'STRING_VALUE',
          /* more items */
        ],
        tcpRetryEvents: [
          connection-error,
          /* more items */
        ]
      }
    },
    httpRoute: {
      action: { /* required */
        weightedTargets: [ /* required */
          {
            virtualNode: 'STRING_VALUE', /* required */
            weight: 'NUMBER_VALUE' /* required */
          },
          /* more items */
        ]
      },
      match: { /* required */
        prefix: 'STRING_VALUE', /* required */
        headers: [
          {
            name: 'STRING_VALUE', /* required */
            invert: true || false,
            match: {
              exact: 'STRING_VALUE',
              prefix: 'STRING_VALUE',
              range: {
                end: 'NUMBER_VALUE', /* required */
                start: 'NUMBER_VALUE' /* required */
              },
              regex: 'STRING_VALUE',
              suffix: 'STRING_VALUE'
            }
          },
          /* more items */
        ],
        method: CONNECT | DELETE | GET | HEAD | OPTIONS | PATCH | POST | PUT | TRACE,
        scheme: http | https
      },
      retryPolicy: {
        maxRetries: 'NUMBER_VALUE', /* required */
        perRetryTimeout: { /* required */
          unit: ms | s,
          value: 'NUMBER_VALUE'
        },
        httpRetryEvents: [
          'STRING_VALUE',
          /* more items */
        ],
        tcpRetryEvents: [
          connection-error,
          /* more items */
        ]
      }
    },
    priority: 'NUMBER_VALUE',
    tcpRoute: {
      action: { /* required */
        weightedTargets: [ /* required */
          {
            virtualNode: 'STRING_VALUE', /* required */
            weight: 'NUMBER_VALUE' /* required */
          },
          /* more items */
        ]
      }
    }
  },
  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 that the route resides in.

    • routeName — (String)

      The name of the route to update.

    • spec — (map)

      The new route specification to apply. This overwrites the existing data.

      • grpcRoute — (map)

        An object that represents the specification of a GRPC route.

        • actionrequired — (map)

          An object that represents the action to take if a match is determined.

          • weightedTargetsrequired — (Array<map>)

            An object that represents the targets that traffic is routed to when a request matches the route.

            • virtualNoderequired — (String)

              The virtual node to associate with the weighted target.

            • weightrequired — (Integer)

              The relative weight of the weighted target.

        • matchrequired — (map)

          An object that represents the criteria for determining a request match.

          • metadata — (Array<map>)

            An object that represents the data to match from the request.

            • invert — (Boolean)

              Specify True to match anything except the match criteria. The default value is False.

            • match — (map)

              An object that represents the data to match from the request.

              • exact — (String)

                The value sent by the client must match the specified value exactly.

              • prefix — (String)

                The value sent by the client must begin with the specified characters.

              • range — (map)

                An object that represents the range of values to match on.

                • endrequired — (Integer)

                  The end of the range.

                • startrequired — (Integer)

                  The start of the range.

              • regex — (String)

                The value sent by the client must include the specified characters.

              • suffix — (String)

                The value sent by the client must end with the specified characters.

            • namerequired — (String)

              The name of the route.

          • methodName — (String)

            The method name to match from the request. If you specify a name, you must also specify a serviceName.

          • serviceName — (String)

            The fully qualified domain name for the service to match from the request.

        • retryPolicy — (map)

          An object that represents a retry policy.

          • grpcRetryEvents — (Array<String>)

            Specify at least one of the valid values.

          • httpRetryEvents — (Array<String>)

            Specify at least one of the following values.

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

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

            • client-error – HTTP status code 409

            • stream-error – Retry on refused stream

          • maxRetriesrequired — (Integer)

            The maximum number of retry attempts.

          • perRetryTimeoutrequired — (map)

            An object that represents a duration of time.

            • unit — (String)

              A unit of time.

              Possible values include:
              • "ms"
              • "s"
            • value — (Integer)

              A number of time units.

          • tcpRetryEvents — (Array<String>)

            Specify a valid value.

      • http2Route — (map)

        An object that represents the specification of an HTTP2 route.

        • actionrequired — (map)

          An object that represents the action to take if a match is determined.

          • weightedTargetsrequired — (Array<map>)

            An object that represents the targets that traffic is routed to when a request matches the route.

            • virtualNoderequired — (String)

              The virtual node to associate with the weighted target.

            • weightrequired — (Integer)

              The relative weight of the weighted target.

        • matchrequired — (map)

          An object that represents the criteria for determining a request match.

          • headers — (Array<map>)

            An object that represents the client request headers to match on.

            • invert — (Boolean)

              Specify True to match anything except the match criteria. The default value is False.

            • match — (map)

              The HeaderMatchMethod object.

              • exact — (String)

                The value sent by the client must match the specified value exactly.

              • prefix — (String)

                The value sent by the client must begin with the specified characters.

              • range — (map)

                An object that represents the range of values to match on.

                • endrequired — (Integer)

                  The end of the range.

                • startrequired — (Integer)

                  The start of the range.

              • regex — (String)

                The value sent by the client must include the specified characters.

              • suffix — (String)

                The value sent by the client must end with the specified characters.

            • namerequired — (String)

              A name for the HTTP header in the client request that will be matched on.

          • method — (String)

            The client request method to match on. Specify only one.

            Possible values include:
            • "CONNECT"
            • "DELETE"
            • "GET"
            • "HEAD"
            • "OPTIONS"
            • "PATCH"
            • "POST"
            • "PUT"
            • "TRACE"
          • prefixrequired — (String)

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

          • scheme — (String)

            The client request scheme to match on. Specify only one.

            Possible values include:
            • "http"
            • "https"
        • retryPolicy — (map)

          An object that represents a retry policy.

          • httpRetryEvents — (Array<String>)

            Specify at least one of the following values.

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

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

            • client-error – HTTP status code 409

            • stream-error – Retry on refused stream

          • maxRetriesrequired — (Integer)

            The maximum number of retry attempts.

          • perRetryTimeoutrequired — (map)

            An object that represents a duration of time.

            • unit — (String)

              A unit of time.

              Possible values include:
              • "ms"
              • "s"
            • value — (Integer)

              A number of time units.

          • tcpRetryEvents — (Array<String>)

            Specify a valid value.

      • httpRoute — (map)

        An object that represents the specification of an HTTP route.

        • actionrequired — (map)

          An object that represents the action to take if a match is determined.

          • weightedTargetsrequired — (Array<map>)

            An object that represents the targets that traffic is routed to when a request matches the route.

            • virtualNoderequired — (String)

              The virtual node to associate with the weighted target.

            • weightrequired — (Integer)

              The relative weight of the weighted target.

        • matchrequired — (map)

          An object that represents the criteria for determining a request match.

          • headers — (Array<map>)

            An object that represents the client request headers to match on.

            • invert — (Boolean)

              Specify True to match anything except the match criteria. The default value is False.

            • match — (map)

              The HeaderMatchMethod object.

              • exact — (String)

                The value sent by the client must match the specified value exactly.

              • prefix — (String)

                The value sent by the client must begin with the specified characters.

              • range — (map)

                An object that represents the range of values to match on.

                • endrequired — (Integer)

                  The end of the range.

                • startrequired — (Integer)

                  The start of the range.

              • regex — (String)

                The value sent by the client must include the specified characters.

              • suffix — (String)

                The value sent by the client must end with the specified characters.

            • namerequired — (String)

              A name for the HTTP header in the client request that will be matched on.

          • method — (String)

            The client request method to match on. Specify only one.

            Possible values include:
            • "CONNECT"
            • "DELETE"
            • "GET"
            • "HEAD"
            • "OPTIONS"
            • "PATCH"
            • "POST"
            • "PUT"
            • "TRACE"
          • prefixrequired — (String)

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

          • scheme — (String)

            The client request scheme to match on. Specify only one.

            Possible values include:
            • "http"
            • "https"
        • retryPolicy — (map)

          An object that represents a retry policy.

          • httpRetryEvents — (Array<String>)

            Specify at least one of the following values.

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

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

            • client-error – HTTP status code 409

            • stream-error – Retry on refused stream

          • maxRetriesrequired — (Integer)

            The maximum number of retry attempts.

          • perRetryTimeoutrequired — (map)

            An object that represents a duration of time.

            • unit — (String)

              A unit of time.

              Possible values include:
              • "ms"
              • "s"
            • value — (Integer)

              A number of time units.

          • tcpRetryEvents — (Array<String>)

            Specify a valid value.

      • priority — (Integer)

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

      • tcpRoute — (map)

        An object that represents the specification of a TCP route.

        • actionrequired — (map)

          The action to take if a match is determined.

          • weightedTargetsrequired — (Array<map>)

            An object that represents the targets that traffic is routed to when a request matches the route.

            • virtualNoderequired — (String)

              The virtual node to associate with the weighted target.

            • weightrequired — (Integer)

              The relative weight of the weighted target.

    • virtualRouterName — (String)

      The name of the virtual router that the route is associated with.

Callback (callback):

  • function(err, data) { ... }

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

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

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

      • route — (map)

        A full description of the route that was updated.

        • meshNamerequired — (String)

          The name of the service mesh that the route resides in.

        • metadatarequired — (map)

          The associated metadata for the route.

          • arnrequired — (String)

            The full Amazon Resource Name (ARN) for the resource.

          • createdAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was created.

          • lastUpdatedAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was last updated.

          • uidrequired — (String)

            The unique identifier for the resource.

          • versionrequired — (Integer)

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

        • routeNamerequired — (String)

          The name of the route.

        • specrequired — (map)

          The specifications of the route.

          • grpcRoute — (map)

            An object that represents the specification of a GRPC route.

            • actionrequired — (map)

              An object that represents the action to take if a match is determined.

              • weightedTargetsrequired — (Array<map>)

                An object that represents the targets that traffic is routed to when a request matches the route.

                • virtualNoderequired — (String)

                  The virtual node to associate with the weighted target.

                • weightrequired — (Integer)

                  The relative weight of the weighted target.

            • matchrequired — (map)

              An object that represents the criteria for determining a request match.

              • metadata — (Array<map>)

                An object that represents the data to match from the request.

                • invert — (Boolean)

                  Specify True to match anything except the match criteria. The default value is False.

                • match — (map)

                  An object that represents the data to match from the request.

                  • exact — (String)

                    The value sent by the client must match the specified value exactly.

                  • prefix — (String)

                    The value sent by the client must begin with the specified characters.

                  • range — (map)

                    An object that represents the range of values to match on.

                    • endrequired — (Integer)

                      The end of the range.

                    • startrequired — (Integer)

                      The start of the range.

                  • regex — (String)

                    The value sent by the client must include the specified characters.

                  • suffix — (String)

                    The value sent by the client must end with the specified characters.

                • namerequired — (String)

                  The name of the route.

              • methodName — (String)

                The method name to match from the request. If you specify a name, you must also specify a serviceName.

              • serviceName — (String)

                The fully qualified domain name for the service to match from the request.

            • retryPolicy — (map)

              An object that represents a retry policy.

              • grpcRetryEvents — (Array<String>)

                Specify at least one of the valid values.

              • httpRetryEvents — (Array<String>)

                Specify at least one of the following values.

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

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

                • client-error – HTTP status code 409

                • stream-error – Retry on refused stream

              • maxRetriesrequired — (Integer)

                The maximum number of retry attempts.

              • perRetryTimeoutrequired — (map)

                An object that represents a duration of time.

                • unit — (String)

                  A unit of time.

                  Possible values include:
                  • "ms"
                  • "s"
                • value — (Integer)

                  A number of time units.

              • tcpRetryEvents — (Array<String>)

                Specify a valid value.

          • http2Route — (map)

            An object that represents the specification of an HTTP2 route.

            • actionrequired — (map)

              An object that represents the action to take if a match is determined.

              • weightedTargetsrequired — (Array<map>)

                An object that represents the targets that traffic is routed to when a request matches the route.

                • virtualNoderequired — (String)

                  The virtual node to associate with the weighted target.

                • weightrequired — (Integer)

                  The relative weight of the weighted target.

            • matchrequired — (map)

              An object that represents the criteria for determining a request match.

              • headers — (Array<map>)

                An object that represents the client request headers to match on.

                • invert — (Boolean)

                  Specify True to match anything except the match criteria. The default value is False.

                • match — (map)

                  The HeaderMatchMethod object.

                  • exact — (String)

                    The value sent by the client must match the specified value exactly.

                  • prefix — (String)

                    The value sent by the client must begin with the specified characters.

                  • range — (map)

                    An object that represents the range of values to match on.

                    • endrequired — (Integer)

                      The end of the range.

                    • startrequired — (Integer)

                      The start of the range.

                  • regex — (String)

                    The value sent by the client must include the specified characters.

                  • suffix — (String)

                    The value sent by the client must end with the specified characters.

                • namerequired — (String)

                  A name for the HTTP header in the client request that will be matched on.

              • method — (String)

                The client request method to match on. Specify only one.

                Possible values include:
                • "CONNECT"
                • "DELETE"
                • "GET"
                • "HEAD"
                • "OPTIONS"
                • "PATCH"
                • "POST"
                • "PUT"
                • "TRACE"
              • prefixrequired — (String)

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

              • scheme — (String)

                The client request scheme to match on. Specify only one.

                Possible values include:
                • "http"
                • "https"
            • retryPolicy — (map)

              An object that represents a retry policy.

              • httpRetryEvents — (Array<String>)

                Specify at least one of the following values.

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

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

                • client-error – HTTP status code 409

                • stream-error – Retry on refused stream

              • maxRetriesrequired — (Integer)

                The maximum number of retry attempts.

              • perRetryTimeoutrequired — (map)

                An object that represents a duration of time.

                • unit — (String)

                  A unit of time.

                  Possible values include:
                  • "ms"
                  • "s"
                • value — (Integer)

                  A number of time units.

              • tcpRetryEvents — (Array<String>)

                Specify a valid value.

          • httpRoute — (map)

            An object that represents the specification of an HTTP route.

            • actionrequired — (map)

              An object that represents the action to take if a match is determined.

              • weightedTargetsrequired — (Array<map>)

                An object that represents the targets that traffic is routed to when a request matches the route.

                • virtualNoderequired — (String)

                  The virtual node to associate with the weighted target.

                • weightrequired — (Integer)

                  The relative weight of the weighted target.

            • matchrequired — (map)

              An object that represents the criteria for determining a request match.

              • headers — (Array<map>)

                An object that represents the client request headers to match on.

                • invert — (Boolean)

                  Specify True to match anything except the match criteria. The default value is False.

                • match — (map)

                  The HeaderMatchMethod object.

                  • exact — (String)

                    The value sent by the client must match the specified value exactly.

                  • prefix — (String)

                    The value sent by the client must begin with the specified characters.

                  • range — (map)

                    An object that represents the range of values to match on.

                    • endrequired — (Integer)

                      The end of the range.

                    • startrequired — (Integer)

                      The start of the range.

                  • regex — (String)

                    The value sent by the client must include the specified characters.

                  • suffix — (String)

                    The value sent by the client must end with the specified characters.

                • namerequired — (String)

                  A name for the HTTP header in the client request that will be matched on.

              • method — (String)

                The client request method to match on. Specify only one.

                Possible values include:
                • "CONNECT"
                • "DELETE"
                • "GET"
                • "HEAD"
                • "OPTIONS"
                • "PATCH"
                • "POST"
                • "PUT"
                • "TRACE"
              • prefixrequired — (String)

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

              • scheme — (String)

                The client request scheme to match on. Specify only one.

                Possible values include:
                • "http"
                • "https"
            • retryPolicy — (map)

              An object that represents a retry policy.

              • httpRetryEvents — (Array<String>)

                Specify at least one of the following values.

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

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

                • client-error – HTTP status code 409

                • stream-error – Retry on refused stream

              • maxRetriesrequired — (Integer)

                The maximum number of retry attempts.

              • perRetryTimeoutrequired — (map)

                An object that represents a duration of time.

                • unit — (String)

                  A unit of time.

                  Possible values include:
                  • "ms"
                  • "s"
                • value — (Integer)

                  A number of time units.

              • tcpRetryEvents — (Array<String>)

                Specify a valid value.

          • priority — (Integer)

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

          • tcpRoute — (map)

            An object that represents the specification of a TCP route.

            • actionrequired — (map)

              The action to take if a match is determined.

              • weightedTargetsrequired — (Array<map>)

                An object that represents the targets that traffic is routed to when a request matches the route.

                • virtualNoderequired — (String)

                  The virtual node to associate with the weighted target.

                • weightrequired — (Integer)

                  The relative weight of the weighted target.

        • statusrequired — (map)

          The status of the route.

          • statusrequired — (String)

            The current status for the route.

            Possible values include:
            • "ACTIVE"
            • "DELETED"
            • "INACTIVE"
        • virtualRouterNamerequired — (String)

          The virtual router that the route is associated with.

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:

Examples:

Calling the updateVirtualNode operation

var params = {
  meshName: 'STRING_VALUE', /* required */
  spec: { /* required */
    backends: [
      {
        virtualService: {
          virtualServiceName: 'STRING_VALUE' /* required */
        }
      },
      /* more items */
    ],
    listeners: [
      {
        portMapping: { /* required */
          port: 'NUMBER_VALUE', /* required */
          protocol: grpc | http | http2 | tcp /* required */
        },
        healthCheck: {
          healthyThreshold: 'NUMBER_VALUE', /* required */
          intervalMillis: 'NUMBER_VALUE', /* required */
          protocol: grpc | http | http2 | tcp, /* required */
          timeoutMillis: 'NUMBER_VALUE', /* required */
          unhealthyThreshold: 'NUMBER_VALUE', /* required */
          path: 'STRING_VALUE',
          port: 'NUMBER_VALUE'
        }
      },
      /* more items */
    ],
    logging: {
      accessLog: {
        file: {
          path: 'STRING_VALUE' /* required */
        }
      }
    },
    serviceDiscovery: {
      awsCloudMap: {
        namespaceName: 'STRING_VALUE', /* required */
        serviceName: 'STRING_VALUE', /* required */
        attributes: [
          {
            key: 'STRING_VALUE', /* required */
            value: 'STRING_VALUE' /* required */
          },
          /* more items */
        ]
      },
      dns: {
        hostname: 'STRING_VALUE' /* required */
      }
    }
  },
  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 that the virtual node resides in.

    • spec — (map)

      The new virtual node specification to apply. This overwrites the existing data.

      • backends — (Array<map>)

        The backends that the virtual node is expected to send outbound traffic to.

        • virtualService — (map)

          Specifies a virtual service to use as a backend for a virtual node.

          • virtualServiceNamerequired — (String)

            The name of the virtual service that is acting as a virtual node backend.

      • listeners — (Array<map>)

        The listeners that the virtual node is expected to receive inbound traffic from. You can specify one listener.

        • healthCheck — (map)

          The health check information for the listener.

          • healthyThresholdrequired — (Integer)

            The number of consecutive successful health checks that must occur before declaring listener healthy.

          • intervalMillisrequired — (Integer)

            The time period in milliseconds between each health check execution.

          • path — (String)

            The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, 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.

          • protocolrequired — (String)

            The protocol for the health check request.

            Possible values include:
            • "grpc"
            • "http"
            • "http2"
            • "tcp"
          • timeoutMillisrequired — (Integer)

            The amount of time to wait when receiving a response from the health check, in milliseconds.

          • unhealthyThresholdrequired — (Integer)

            The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

        • portMappingrequired — (map)

          The port mapping information for the listener.

          • portrequired — (Integer)

            The port used for the port mapping.

          • protocolrequired — (String)

            The protocol used for the port mapping. Specify one protocol.

            Possible values include:
            • "grpc"
            • "http"
            • "http2"
            • "tcp"
      • logging — (map)

        The inbound and outbound access logging information for the virtual node.

        • accessLog — (map)

          The access log configuration for a virtual node.

          • file — (map)

            The file object to send virtual node access logs to.

            • pathrequired — (String)

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

              Note: The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.
      • serviceDiscovery — (map)

        The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter.

        • awsCloudMap — (map)

          Specifies any AWS Cloud Map information for the virtual node.

          • attributes — (Array<map>)

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

            • keyrequired — (String)

              The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

            • valuerequired — (String)

              The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

          • namespaceNamerequired — (String)

            The name of the AWS Cloud Map namespace to use.

          • serviceNamerequired — (String)

            The name of the AWS Cloud Map service to use.

        • dns — (map)

          Specifies the DNS information for the virtual node.

          • hostnamerequired — (String)

            Specifies the DNS service discovery hostname for the 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.

        • meshNamerequired — (String)

          The name of the service mesh that the virtual node resides in.

        • metadatarequired — (map)

          The associated metadata for the virtual node.

          • arnrequired — (String)

            The full Amazon Resource Name (ARN) for the resource.

          • createdAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was created.

          • lastUpdatedAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was last updated.

          • uidrequired — (String)

            The unique identifier for the resource.

          • versionrequired — (Integer)

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

        • specrequired — (map)

          The specifications of the virtual node.

          • backends — (Array<map>)

            The backends that the virtual node is expected to send outbound traffic to.

            • virtualService — (map)

              Specifies a virtual service to use as a backend for a virtual node.

              • virtualServiceNamerequired — (String)

                The name of the virtual service that is acting as a virtual node backend.

          • listeners — (Array<map>)

            The listeners that the virtual node is expected to receive inbound traffic from. You can specify one listener.

            • healthCheck — (map)

              The health check information for the listener.

              • healthyThresholdrequired — (Integer)

                The number of consecutive successful health checks that must occur before declaring listener healthy.

              • intervalMillisrequired — (Integer)

                The time period in milliseconds between each health check execution.

              • path — (String)

                The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, 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.

              • protocolrequired — (String)

                The protocol for the health check request.

                Possible values include:
                • "grpc"
                • "http"
                • "http2"
                • "tcp"
              • timeoutMillisrequired — (Integer)

                The amount of time to wait when receiving a response from the health check, in milliseconds.

              • unhealthyThresholdrequired — (Integer)

                The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

            • portMappingrequired — (map)

              The port mapping information for the listener.

              • portrequired — (Integer)

                The port used for the port mapping.

              • protocolrequired — (String)

                The protocol used for the port mapping. Specify one protocol.

                Possible values include:
                • "grpc"
                • "http"
                • "http2"
                • "tcp"
          • logging — (map)

            The inbound and outbound access logging information for the virtual node.

            • accessLog — (map)

              The access log configuration for a virtual node.

              • file — (map)

                The file object to send virtual node access logs to.

                • pathrequired — (String)

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

                  Note: The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.
          • serviceDiscovery — (map)

            The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter.

            • awsCloudMap — (map)

              Specifies any AWS Cloud Map information for the virtual node.

              • attributes — (Array<map>)

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

                • keyrequired — (String)

                  The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

                • valuerequired — (String)

                  The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

              • namespaceNamerequired — (String)

                The name of the AWS Cloud Map namespace to use.

              • serviceNamerequired — (String)

                The name of the AWS Cloud Map service to use.

            • dns — (map)

              Specifies the DNS information for the virtual node.

              • hostnamerequired — (String)

                Specifies the DNS service discovery hostname for the virtual node.

        • statusrequired — (map)

          The current status for the virtual node.

          • statusrequired — (String)

            The current status of the virtual node.

            Possible values include:
            • "ACTIVE"
            • "DELETED"
            • "INACTIVE"
        • virtualNodeNamerequired — (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:

Examples:

Calling the updateVirtualRouter operation

var params = {
  meshName: 'STRING_VALUE', /* required */
  spec: { /* required */
    listeners: [
      {
        portMapping: { /* required */
          port: 'NUMBER_VALUE', /* required */
          protocol: grpc | http | http2 | tcp /* required */
        }
      },
      /* 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 that the virtual router resides in.

    • spec — (map)

      The new virtual router specification to apply. This overwrites the existing data.

      • listeners — (Array<map>)

        The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.

        • portMappingrequired — (map)

          An object that represents a port mapping.

          • portrequired — (Integer)

            The port used for the port mapping.

          • protocolrequired — (String)

            The protocol used for the port mapping. Specify one protocol.

            Possible values include:
            • "grpc"
            • "http"
            • "http2"
            • "tcp"
    • 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.

        • meshNamerequired — (String)

          The name of the service mesh that the virtual router resides in.

        • metadatarequired — (map)

          The associated metadata for the virtual router.

          • arnrequired — (String)

            The full Amazon Resource Name (ARN) for the resource.

          • createdAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was created.

          • lastUpdatedAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was last updated.

          • uidrequired — (String)

            The unique identifier for the resource.

          • versionrequired — (Integer)

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

        • specrequired — (map)

          The specifications of the virtual router.

          • listeners — (Array<map>)

            The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.

            • portMappingrequired — (map)

              An object that represents a port mapping.

              • portrequired — (Integer)

                The port used for the port mapping.

              • protocolrequired — (String)

                The protocol used for the port mapping. Specify one protocol.

                Possible values include:
                • "grpc"
                • "http"
                • "http2"
                • "tcp"
        • statusrequired — (map)

          The current status of the virtual router.

          • statusrequired — (String)

            The current status of the virtual router.

            Possible values include:
            • "ACTIVE"
            • "DELETED"
            • "INACTIVE"
        • virtualRouterNamerequired — (String)

          The name of the virtual router.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Updates an existing virtual service in a specified service mesh.

Service Reference:

Examples:

Calling the updateVirtualService operation

var params = {
  meshName: 'STRING_VALUE', /* required */
  spec: { /* required */
    provider: {
      virtualNode: {
        virtualNodeName: 'STRING_VALUE' /* required */
      },
      virtualRouter: {
        virtualRouterName: 'STRING_VALUE' /* required */
      }
    }
  },
  virtualServiceName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
appmesh.updateVirtualService(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

      If a token is not provided, the SDK will use a version 4 UUID.
    • meshName — (String)

      The name of the service mesh that the virtual service resides in.

    • spec — (map)

      The new virtual service specification to apply. This overwrites the existing data.

      • provider — (map)

        The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.

        • virtualNode — (map)

          The virtual node associated with a virtual service.

          • virtualNodeNamerequired — (String)

            The name of the virtual node that is acting as a service provider.

        • virtualRouter — (map)

          The virtual router associated with a virtual service.

          • virtualRouterNamerequired — (String)

            The name of the virtual router that is acting as a service provider.

    • virtualServiceName — (String)

      The name of the virtual service to update.

Callback (callback):

  • function(err, data) { ... }

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

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

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

      • virtualService — (map)

        A full description of the virtual service that was updated.

        • meshNamerequired — (String)

          The name of the service mesh that the virtual service resides in.

        • metadatarequired — (map)

          An object that represents metadata for a resource.

          • arnrequired — (String)

            The full Amazon Resource Name (ARN) for the resource.

          • createdAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was created.

          • lastUpdatedAtrequired — (Date)

            The Unix epoch timestamp in seconds for when the resource was last updated.

          • uidrequired — (String)

            The unique identifier for the resource.

          • versionrequired — (Integer)

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

        • specrequired — (map)

          The specifications of the virtual service.

          • provider — (map)

            The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.

            • virtualNode — (map)

              The virtual node associated with a virtual service.

              • virtualNodeNamerequired — (String)

                The name of the virtual node that is acting as a service provider.

            • virtualRouter — (map)

              The virtual router associated with a virtual service.

              • virtualRouterNamerequired — (String)

                The name of the virtual router that is acting as a service provider.

        • statusrequired — (map)

          The current status of the virtual service.

          • statusrequired — (String)

            The current status of the virtual service.

            Possible values include:
            • "ACTIVE"
            • "DELETED"
            • "INACTIVE"
        • virtualServiceNamerequired — (String)

          The name of the virtual service.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.