Class: AWS.ServiceDiscovery

Inherits:
AWS.Service show all
Identifier:
servicediscovery
API Version:
2017-03-14
Defined in:
(unknown)

Overview

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

Service Description

AWS Cloud Map lets you configure public DNS, private DNS, or HTTP namespaces that your microservice applications run in. When an instance of the service becomes available, you can call the AWS Cloud Map API to register the instance with AWS Cloud Map. For public or private DNS namespaces, AWS Cloud Map automatically creates DNS records and an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service receive an answer that contains up to eight healthy records.

Sending a Request Using ServiceDiscovery

var servicediscovery = new AWS.ServiceDiscovery();
servicediscovery.createHttpNamespace(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 ServiceDiscovery object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var servicediscovery = new AWS.ServiceDiscovery({apiVersion: '2017-03-14'});

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

AWS.config.apiVersions = {
  servicediscovery: '2017-03-14',
  // other service API versions
};

var servicediscovery = new AWS.ServiceDiscovery();

Version:

  • 2017-03-14

Constructor Summary

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a ServiceDiscovery object

var servicediscovery = new AWS.ServiceDiscovery({apiVersion: '2017-03-14'});

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.ServiceDiscovery.region for more information.

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.ServiceDiscovery.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 returns the amount of time to delay in milliseconds. 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.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Creates an HTTP namespace. Service instances that you register using an HTTP namespace can be discovered using a DiscoverInstances request but can't be discovered using DNS.

For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

Service Reference:

Examples:

Calling the createHttpNamespace operation

var params = {
  Name: 'STRING_VALUE', /* required */
  CreatorRequestId: 'STRING_VALUE',
  Description: 'STRING_VALUE'
};
servicediscovery.createHttpNamespace(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: {}) —
    • Name — (String)

      The name that you want to assign to this namespace.

    • CreatorRequestId — (String)

      A unique string that identifies the request and that allows failed CreateHttpNamespace requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

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

      A description for the namespace.

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:

      • OperationId — (String)

        A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

Returns:

  • (AWS.Request) —

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

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

Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

Service Reference:

Examples:

Calling the createPrivateDnsNamespace operation

var params = {
  Name: 'STRING_VALUE', /* required */
  Vpc: 'STRING_VALUE', /* required */
  CreatorRequestId: 'STRING_VALUE',
  Description: 'STRING_VALUE'
};
servicediscovery.createPrivateDnsNamespace(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: {}) —
    • Name — (String)

      The name that you want to assign to this namespace. When you create a private DNS namespace, AWS Cloud Map automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.

    • CreatorRequestId — (String)

      A unique string that identifies the request and that allows failed CreatePrivateDnsNamespace requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

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

      A description for the namespace.

    • Vpc — (String)

      The ID of the Amazon VPC that you want to associate the namespace 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:

      • OperationId — (String)

        A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

Returns:

  • (AWS.Request) —

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

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

Creates a public namespace based on DNS, which will be visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

Service Reference:

Examples:

Calling the createPublicDnsNamespace operation

var params = {
  Name: 'STRING_VALUE', /* required */
  CreatorRequestId: 'STRING_VALUE',
  Description: 'STRING_VALUE'
};
servicediscovery.createPublicDnsNamespace(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: {}) —
    • Name — (String)

      The name that you want to assign to this namespace.

    • CreatorRequestId — (String)

      A unique string that identifies the request and that allows failed CreatePublicDnsNamespace requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

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

      A description for the namespace.

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:

      • OperationId — (String)

        A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

Returns:

  • (AWS.Request) —

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

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

Creates a service, which defines the configuration for the following entities:

  • For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53:

    • A

    • AAAA

    • A and AAAA

    • SRV

    • CNAME

  • Optionally, a health check

After you create the service, you can submit a RegisterInstance request, and AWS Cloud Map uses the values in the configuration to create the specified entities.

For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

Service Reference:

Examples:

Calling the createService operation

var params = {
  Name: 'STRING_VALUE', /* required */
  CreatorRequestId: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DnsConfig: {
    DnsRecords: [ /* required */
      {
        TTL: 'NUMBER_VALUE', /* required */
        Type: SRV | A | AAAA | CNAME /* required */
      },
      /* more items */
    ],
    NamespaceId: 'STRING_VALUE',
    RoutingPolicy: MULTIVALUE | WEIGHTED
  },
  HealthCheckConfig: {
    Type: HTTP | HTTPS | TCP, /* required */
    FailureThreshold: 'NUMBER_VALUE',
    ResourcePath: 'STRING_VALUE'
  },
  HealthCheckCustomConfig: {
    FailureThreshold: 'NUMBER_VALUE'
  },
  NamespaceId: 'STRING_VALUE'
};
servicediscovery.createService(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: {}) —
    • Name — (String)

      The name that you want to assign to the service.

    • NamespaceId — (String)

      The ID of the namespace that you want to use to create the service.

    • CreatorRequestId — (String)

      A unique string that identifies the request and that allows failed CreateService requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

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

      A description for the service.

    • DnsConfig — (map)

      A complex type that contains information about the Amazon Route 53 records that you want AWS Cloud Map to create when you register an instance.

      • NamespaceId — (String)

        The ID of the namespace to use for DNS configuration.

      • RoutingPolicy — (String)

        The routing policy that you want to apply to all Route 53 DNS records that AWS Cloud Map creates when you register an instance and specify this service.

        Note: If you want to use this service to register instances that create alias records, specify WEIGHTED for the routing policy.

        You can specify the following values:

        MULTIVALUE

        If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.

        For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.

        If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.

        For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide.

        WEIGHTED

        Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.

        For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.

        If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.

        For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.

        Possible values include:
        • "MULTIVALUE"
        • "WEIGHTED"
      • DnsRecords — required — (Array<map>)

        An array that contains one DnsRecord object for each Route 53 DNS record that you want AWS Cloud Map to create when you register an instance.

        • Type — required — (String)

          The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries.

          Note the following:

          • A, AAAA, and SRV records: You can specify settings for a maximum of one A, one AAAA, and one SRV record. You can specify them in any combination.

          • CNAME records: If you specify CNAME for Type, you can't define any other records. This is a limitation of DNS: you can't create a CNAME record and any other type of record that has the same name as a CNAME record.

          • Alias records: If you want AWS Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type.

          • All records: You specify settings other than TTL and Type when you register an instance.

          The following values are supported:

          A

          Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.

          AAAA

          Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.

          CNAME

          Route 53 returns the domain name of the resource, such as www.example.com. Note the following:

          • You specify the domain name that you want to route traffic to when you register an instance. For more information, see RegisterInstanceRequest$Attributes.

          • You must specify WEIGHTED for the value of RoutingPolicy.

          • You can't specify both CNAME for Type and settings for HealthCheckConfig. If you do, the request will fail with an InvalidInput error.

          SRV

          Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:

          priority weight port service-hostname

          Note the following about the values:

          • The values of priority and weight are both set to 1 and can't be changed.

          • The value of port comes from the value that you specify for the AWS_INSTANCE_PORT attribute when you submit a RegisterInstance request.

          • The value of service-hostname is a concatenation of the following values:

            • The value that you specify for InstanceId when you register an instance.

            • The name of the service.

            • The name of the namespace.

            For example, if the value of InstanceId is test, the name of the service is backend, and the name of the namespace is example.com, the value of service-hostname is:

            test.backend.example.com

          If you specify settings for an SRV record and if you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the RegisterInstance request, AWS Cloud Map automatically creates A and/or AAAA records that have the same name as the value of service-hostname in the SRV record. You can ignore these records.

          Possible values include:
          • "SRV"
          • "A"
          • "AAAA"
          • "CNAME"
        • TTL — required — (Integer)

          The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.

          Note: Alias records don't include a TTL because Route 53 uses the TTL for the AWS resource that an alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request, the TTL value is ignored. Always specify a TTL for the service; you can use a service to register instances that create either alias or non-alias records.
    • HealthCheckConfig — (map)

      Public DNS namespaces only. A complex type that contains settings for an optional Route 53 health check. If you specify settings for a health check, AWS Cloud Map associates the health check with all the Route 53 DNS records that you specify in DnsConfig.

      If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

      For information about the charges for health checks, see AWS Cloud Map Pricing.

      • Type — required — (String)

        The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.

        You can't change the value of Type after you create a health check.

        You can create the following types of health checks:

        • HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

        • HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

          If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

        • TCP: Route 53 tries to establish a TCP connection.

          If you specify TCP for Type, don't specify a value for ResourcePath.

        For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

        Possible values include:
        • "HTTP"
        • "HTTPS"
        • "TCP"
      • ResourcePath — (String)

        The path that you want Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath, the default value is /.

        If you specify TCP for Type, you must not specify a value for ResourcePath.

      • FailureThreshold — (Integer)

        The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

    • HealthCheckCustomConfig — (map)

      A complex type that contains information about an optional custom health check.

      If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.
      • FailureThreshold — (Integer)

        The number of 30-second intervals that you want Cloud Map to wait after receiving an UpdateInstanceCustomHealthStatus request before it changes the health status of a service instance. For example, suppose you specify a value of 2 for FailureTheshold, and then your application sends an UpdateInstanceCustomHealthStatus request. Cloud Map waits for approximately 60 seconds (2 x 30) before changing the status of the service instance based on that request.

        Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value before FailureThreshold x 30 seconds has passed doesn't accelerate the change. Cloud Map still waits FailureThreshold x 30 seconds after the first request to make the change.

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:

      • Service — (map)

        A complex type that contains information about the new service.

        • Id — (String)

          The ID that AWS Cloud Map assigned to the service when you created it.

        • Arn — (String)

          The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.

        • Name — (String)

          The name of the service.

        • NamespaceId — (String)

          The ID of the namespace that was used to create the service.

        • Description — (String)

          The description of the service.

        • InstanceCount — (Integer)

          The number of instances that are currently associated with the service. Instances that were previously associated with the service but that have been deleted are not included in the count.

        • DnsConfig — (map)

          A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.

          • NamespaceId — (String)

            The ID of the namespace to use for DNS configuration.

          • RoutingPolicy — (String)

            The routing policy that you want to apply to all Route 53 DNS records that AWS Cloud Map creates when you register an instance and specify this service.

            Note: If you want to use this service to register instances that create alias records, specify WEIGHTED for the routing policy.

            You can specify the following values:

            MULTIVALUE

            If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.

            For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.

            If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.

            For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide.

            WEIGHTED

            Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.

            For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.

            If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.

            For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.

            Possible values include:
            • "MULTIVALUE"
            • "WEIGHTED"
          • DnsRecords — required — (Array<map>)

            An array that contains one DnsRecord object for each Route 53 DNS record that you want AWS Cloud Map to create when you register an instance.

            • Type — required — (String)

              The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries.

              Note the following:

              • A, AAAA, and SRV records: You can specify settings for a maximum of one A, one AAAA, and one SRV record. You can specify them in any combination.

              • CNAME records: If you specify CNAME for Type, you can't define any other records. This is a limitation of DNS: you can't create a CNAME record and any other type of record that has the same name as a CNAME record.

              • Alias records: If you want AWS Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type.

              • All records: You specify settings other than TTL and Type when you register an instance.

              The following values are supported:

              A

              Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.

              AAAA

              Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.

              CNAME

              Route 53 returns the domain name of the resource, such as www.example.com. Note the following:

              • You specify the domain name that you want to route traffic to when you register an instance. For more information, see RegisterInstanceRequest$Attributes.

              • You must specify WEIGHTED for the value of RoutingPolicy.

              • You can't specify both CNAME for Type and settings for HealthCheckConfig. If you do, the request will fail with an InvalidInput error.

              SRV

              Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:

              priority weight port service-hostname

              Note the following about the values:

              • The values of priority and weight are both set to 1 and can't be changed.

              • The value of port comes from the value that you specify for the AWS_INSTANCE_PORT attribute when you submit a RegisterInstance request.

              • The value of service-hostname is a concatenation of the following values:

                • The value that you specify for InstanceId when you register an instance.

                • The name of the service.

                • The name of the namespace.

                For example, if the value of InstanceId is test, the name of the service is backend, and the name of the namespace is example.com, the value of service-hostname is:

                test.backend.example.com

              If you specify settings for an SRV record and if you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the RegisterInstance request, AWS Cloud Map automatically creates A and/or AAAA records that have the same name as the value of service-hostname in the SRV record. You can ignore these records.

              Possible values include:
              • "SRV"
              • "A"
              • "AAAA"
              • "CNAME"
            • TTL — required — (Integer)

              The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.

              Note: Alias records don't include a TTL because Route 53 uses the TTL for the AWS resource that an alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request, the TTL value is ignored. Always specify a TTL for the service; you can use a service to register instances that create either alias or non-alias records.
        • HealthCheckConfig — (map)

          Public DNS namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig.

          For information about the charges for health checks, see Amazon Route 53 Pricing.

          • Type — required — (String)

            The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.

            You can't change the value of Type after you create a health check.

            You can create the following types of health checks:

            • HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

            • HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

              If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

            • TCP: Route 53 tries to establish a TCP connection.

              If you specify TCP for Type, don't specify a value for ResourcePath.

            For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

            Possible values include:
            • "HTTP"
            • "HTTPS"
            • "TCP"
          • ResourcePath — (String)

            The path that you want Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath, the default value is /.

            If you specify TCP for Type, you must not specify a value for ResourcePath.

          • FailureThreshold — (Integer)

            The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

        • HealthCheckCustomConfig — (map)

          A complex type that contains information about an optional custom health check.

          If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.
          • FailureThreshold — (Integer)

            The number of 30-second intervals that you want Cloud Map to wait after receiving an UpdateInstanceCustomHealthStatus request before it changes the health status of a service instance. For example, suppose you specify a value of 2 for FailureTheshold, and then your application sends an UpdateInstanceCustomHealthStatus request. Cloud Map waits for approximately 60 seconds (2 x 30) before changing the status of the service instance based on that request.

            Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value before FailureThreshold x 30 seconds has passed doesn't accelerate the change. Cloud Map still waits FailureThreshold x 30 seconds after the first request to make the change.

        • CreateDate — (Date)

          The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • CreatorRequestId — (String)

          A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

Returns:

  • (AWS.Request) —

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

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

Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails.

Service Reference:

Examples:

Calling the deleteNamespace operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
servicediscovery.deleteNamespace(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: {}) —
    • Id — (String)

      The ID of the namespace that you want 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:

      • OperationId — (String)

        A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

Returns:

  • (AWS.Request) —

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

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

Deletes a specified service. If the service still contains one or more registered instances, the request fails.

Service Reference:

Examples:

Calling the deleteService operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
servicediscovery.deleteService(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: {}) —
    • Id — (String)

      The ID of the service that you want 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.

Returns:

  • (AWS.Request) —

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

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

Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified instance.

Service Reference:

Examples:

Calling the deregisterInstance operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ServiceId: 'STRING_VALUE' /* required */
};
servicediscovery.deregisterInstance(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: {}) —
    • ServiceId — (String)

      The ID of the service that the instance is associated with.

    • InstanceId — (String)

      The value that you specified for Id in the RegisterInstance request.

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:

      • OperationId — (String)

        A value that you can use to determine whether the request completed successfully. For more information, see GetOperation.

Returns:

  • (AWS.Request) —

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

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

Discovers registered instances for a specified namespace and service.

Service Reference:

Examples:

Calling the discoverInstances operation

var params = {
  NamespaceName: 'STRING_VALUE', /* required */
  ServiceName: 'STRING_VALUE', /* required */
  HealthStatus: HEALTHY | UNHEALTHY | ALL,
  MaxResults: 'NUMBER_VALUE',
  QueryParameters: {
    '<AttrKey>': 'STRING_VALUE',
    /* '<AttrKey>': ... */
  }
};
servicediscovery.discoverInstances(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: {}) —
    • NamespaceName — (String)

      The name of the namespace that you specified when you registered the instance.

    • ServiceName — (String)

      The name of the service that you specified when you registered the instance.

    • MaxResults — (Integer)

      The maximum number of instances that you want Cloud Map to return in the response to a DiscoverInstances request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 instances.

    • QueryParameters — (map<String>)

      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 the specified key/value pairs will be returned.

    • HealthStatus — (String)

      The health status of the instances that you want to discover.

      Possible values include:
      • "HEALTHY"
      • "UNHEALTHY"
      • "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:

      • Instances — (Array<map>)

        A complex type that contains one HttpInstanceSummary for each registered instance.

        • InstanceId — (String)

          The ID of an instance that matches the values that you specified in the request.

        • NamespaceName — (String)

          The name of the namespace that you specified when you registered the instance.

        • ServiceName — (String)

          The name of the service that you specified when you registered the instance.

        • HealthStatus — (String)

          If you configured health checking in the service, the current health status of the service instance.

          Possible values include:
          • "HEALTHY"
          • "UNHEALTHY"
          • "UNKNOWN"
        • Attributes — (map<String>)

          If you included any attributes when you registered the instance, the values of those attributes.

Returns:

  • (AWS.Request) —

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

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

Gets information about a specified instance.

Service Reference:

Examples:

Calling the getInstance operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ServiceId: 'STRING_VALUE' /* required */
};
servicediscovery.getInstance(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: {}) —
    • ServiceId — (String)

      The ID of the service that the instance is associated with.

    • InstanceId — (String)

      The ID of the instance that you want to get information about.

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:

      • Instance — (map)

        A complex type that contains information about a specified instance.

        • Id — required — (String)

          An identifier that you want to associate with the instance. Note the following:

          • If the service that is specified by ServiceId includes settings for an SRV record, the value of InstanceId is automatically included as part of the value for the SRV record. For more information, see DnsRecord$Type.

          • You can use this value to update an existing instance.

          • To register a new instance, you must specify a value that is unique among instances that you register by using the same service.

          • If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing DNS records. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates a new one.

            Note: The health check isn't deleted immediately, so it will still appear for a while if you submit a ListHealthChecks request, for example.
        • CreatorRequestId — (String)

          A unique string that identifies the request and that allows failed RegisterInstance requests to be retried without the risk of executing the operation twice. You must use a unique CreatorRequestId string every time you submit a RegisterInstance request if you're registering additional instances for the same namespace and service. CreatorRequestId can be any unique string, for example, a date/time stamp.

        • Attributes — (map<String>)

          A string map that contains the following information for the service that you specify in ServiceId:

          • The attributes that apply to the records that are defined in the service.

          • For each attribute, the applicable value.

          Supported attribute keys include the following:

          AWS_ALIAS_DNS_NAME

          If you want AWS Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see "DNSName" in the topic AliasTarget.

          Note the following:

          • The configuration for the service that is specified by ServiceId must include settings for an A record, an AAAA record, or both.

          • In the service that is specified by ServiceId, the value of RoutingPolicy must be WEIGHTED.

          • If the service that is specified by ServiceId includes HealthCheckConfig settings, AWS Cloud Map will create the health check, but it won't associate the health check with the alias record.

          • Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers.

          • If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the AWS_INSTANCE attributes.

          AWS_INSTANCE_CNAME

          If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response to DNS queries, for example, example.com.

          This value is required if the service specified by ServiceId includes settings for an CNAME record.

          AWS_INSTANCE_IPV4

          If the service configuration includes an A record, the IPv4 address that you want Route 53 to return in response to DNS queries, for example, 192.0.2.44.

          This value is required if the service specified by ServiceId includes settings for an A record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

          AWS_INSTANCE_IPV6

          If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to return in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345.

          This value is required if the service specified by ServiceId includes settings for an AAAA record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

          AWS_INSTANCE_PORT

          If the service includes an SRV record, the value that you want Route 53 to return for the port.

          If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send requests to.

          This value is required if you specified settings for an SRV record when you created the service.

Returns:

  • (AWS.Request) —

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

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

Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service.

Note: There is a brief delay between when you register an instance and when the health status for the instance is available.

Service Reference:

Examples:

Calling the getInstancesHealthStatus operation

var params = {
  ServiceId: 'STRING_VALUE', /* required */
  Instances: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
servicediscovery.getInstancesHealthStatus(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: {}) —
    • ServiceId — (String)

      The ID of the service that the instance is associated with.

    • Instances — (Array<String>)

      An array that contains the IDs of all the instances that you want to get the health status for.

      If you omit Instances, AWS Cloud Map returns the health status for all the instances that are associated with the specified service.

      Note: To get the IDs for the instances that you've registered by using a specified service, submit a ListInstances request.
    • MaxResults — (Integer)

      The maximum number of instances that you want AWS Cloud Map to return in the response to a GetInstancesHealthStatus request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 instances.

    • NextToken — (String)

      For the first GetInstancesHealthStatus request, omit this value.

      If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

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:

      • Status — (map<String>)

        A complex type that contains the IDs and the health status of the instances that you specified in the GetInstancesHealthStatus request.

      • NextToken — (String)

        If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

Returns:

  • (AWS.Request) —

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

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

Gets information about a namespace.

Service Reference:

Examples:

Calling the getNamespace operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
servicediscovery.getNamespace(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: {}) —
    • Id — (String)

      The ID of the namespace that you want to get information about.

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:

      • Namespace — (map)

        A complex type that contains information about the specified namespace.

        • Id — (String)

          The ID of a namespace.

        • Arn — (String)

          The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when you create it.

        • Name — (String)

          The name of the namespace, such as example.com.

        • Type — (String)

          The type of the namespace. Valid values are DNS_PUBLIC and DNS_PRIVATE.

          Possible values include:
          • "DNS_PUBLIC"
          • "DNS_PRIVATE"
          • "HTTP"
        • Description — (String)

          The description that you specify for the namespace when you create it.

        • ServiceCount — (Integer)

          The number of services that are associated with the namespace.

        • Properties — (map)

          A complex type that contains information that's specific to the type of the namespace.

          • DnsProperties — (map)

            A complex type that contains the ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.

            • HostedZoneId — (String)

              The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.

          • HttpProperties — (map)

            A complex type that contains the name of an HTTP namespace.

            • HttpName — (String)

              The name of an HTTP namespace.

        • CreateDate — (Date)

          The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • CreatorRequestId — (String)

          A unique string that identifies the request and that allows failed requests to be retried without the risk of executing an operation twice.

Returns:

  • (AWS.Request) —

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

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

Gets information about any operation that returns an operation ID in the response, such as a CreateService request.

Note: To get a list of operations that match specified criteria, see ListOperations.

Service Reference:

Examples:

Calling the getOperation operation

var params = {
  OperationId: 'STRING_VALUE' /* required */
};
servicediscovery.getOperation(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: {}) —
    • OperationId — (String)

      The ID of the operation that you want to get more information about.

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:

      • Operation — (map)

        A complex type that contains information about the operation.

        • Id — (String)

          The ID of the operation that you want to get information about.

        • Type — (String)

          The name of the operation that is associated with the specified ID.

          Possible values include:
          • "CREATE_NAMESPACE"
          • "DELETE_NAMESPACE"
          • "UPDATE_SERVICE"
          • "REGISTER_INSTANCE"
          • "DEREGISTER_INSTANCE"
        • Status — (String)

          The status of the operation. Values include the following:

          • SUBMITTED: This is the initial state immediately after you submit a request.

          • PENDING: AWS Cloud Map is performing the operation.

          • SUCCESS: The operation succeeded.

          • FAIL: The operation failed. For the failure reason, see ErrorMessage.

          Possible values include:
          • "SUBMITTED"
          • "PENDING"
          • "SUCCESS"
          • "FAIL"
        • ErrorMessage — (String)

          If the value of Status is FAIL, the reason that the operation failed.

        • ErrorCode — (String)

          The code associated with ErrorMessage. Values for ErrorCode include the following:

          • ACCESS_DENIED

          • CANNOT_CREATE_HOSTED_ZONE

          • EXPIRED_TOKEN

          • HOSTED_ZONE_NOT_FOUND

          • INTERNAL_FAILURE

          • INVALID_CHANGE_BATCH

          • THROTTLED_REQUEST

        • CreateDate — (Date)

          The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • UpdateDate — (Date)

          The date and time that the value of Status changed to the current value, in Unix date/time format and Coordinated Universal Time (UTC). The value of UpdateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • Targets — (map<String>)

          The name of the target entity that is associated with the operation:

          • NAMESPACE: The namespace ID is returned in the ResourceId property.

          • SERVICE: The service ID is returned in the ResourceId property.

          • INSTANCE: The instance ID is returned in the ResourceId property.

Returns:

  • (AWS.Request) —

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

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

Gets the settings for a specified service.

Service Reference:

Examples:

Calling the getService operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
servicediscovery.getService(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: {}) —
    • Id — (String)

      The ID of the service that you want to get settings 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:

      • Service — (map)

        A complex type that contains information about the service.

        • Id — (String)

          The ID that AWS Cloud Map assigned to the service when you created it.

        • Arn — (String)

          The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.

        • Name — (String)

          The name of the service.

        • NamespaceId — (String)

          The ID of the namespace that was used to create the service.

        • Description — (String)

          The description of the service.

        • InstanceCount — (Integer)

          The number of instances that are currently associated with the service. Instances that were previously associated with the service but that have been deleted are not included in the count.

        • DnsConfig — (map)

          A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.

          • NamespaceId — (String)

            The ID of the namespace to use for DNS configuration.

          • RoutingPolicy — (String)

            The routing policy that you want to apply to all Route 53 DNS records that AWS Cloud Map creates when you register an instance and specify this service.

            Note: If you want to use this service to register instances that create alias records, specify WEIGHTED for the routing policy.

            You can specify the following values:

            MULTIVALUE

            If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.

            For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.

            If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.

            For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide.

            WEIGHTED

            Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.

            For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.

            If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.

            For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.

            Possible values include:
            • "MULTIVALUE"
            • "WEIGHTED"
          • DnsRecords — required — (Array<map>)

            An array that contains one DnsRecord object for each Route 53 DNS record that you want AWS Cloud Map to create when you register an instance.

            • Type — required — (String)

              The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries.

              Note the following:

              • A, AAAA, and SRV records: You can specify settings for a maximum of one A, one AAAA, and one SRV record. You can specify them in any combination.

              • CNAME records: If you specify CNAME for Type, you can't define any other records. This is a limitation of DNS: you can't create a CNAME record and any other type of record that has the same name as a CNAME record.

              • Alias records: If you want AWS Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type.

              • All records: You specify settings other than TTL and Type when you register an instance.

              The following values are supported:

              A

              Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.

              AAAA

              Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.

              CNAME

              Route 53 returns the domain name of the resource, such as www.example.com. Note the following:

              • You specify the domain name that you want to route traffic to when you register an instance. For more information, see RegisterInstanceRequest$Attributes.

              • You must specify WEIGHTED for the value of RoutingPolicy.

              • You can't specify both CNAME for Type and settings for HealthCheckConfig. If you do, the request will fail with an InvalidInput error.

              SRV

              Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:

              priority weight port service-hostname

              Note the following about the values:

              • The values of priority and weight are both set to 1 and can't be changed.

              • The value of port comes from the value that you specify for the AWS_INSTANCE_PORT attribute when you submit a RegisterInstance request.

              • The value of service-hostname is a concatenation of the following values:

                • The value that you specify for InstanceId when you register an instance.

                • The name of the service.

                • The name of the namespace.

                For example, if the value of InstanceId is test, the name of the service is backend, and the name of the namespace is example.com, the value of service-hostname is:

                test.backend.example.com

              If you specify settings for an SRV record and if you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the RegisterInstance request, AWS Cloud Map automatically creates A and/or AAAA records that have the same name as the value of service-hostname in the SRV record. You can ignore these records.

              Possible values include:
              • "SRV"
              • "A"
              • "AAAA"
              • "CNAME"
            • TTL — required — (Integer)

              The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.

              Note: Alias records don't include a TTL because Route 53 uses the TTL for the AWS resource that an alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request, the TTL value is ignored. Always specify a TTL for the service; you can use a service to register instances that create either alias or non-alias records.
        • HealthCheckConfig — (map)

          Public DNS namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig.

          For information about the charges for health checks, see Amazon Route 53 Pricing.

          • Type — required — (String)

            The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.

            You can't change the value of Type after you create a health check.

            You can create the following types of health checks:

            • HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

            • HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

              If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

            • TCP: Route 53 tries to establish a TCP connection.

              If you specify TCP for Type, don't specify a value for ResourcePath.

            For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

            Possible values include:
            • "HTTP"
            • "HTTPS"
            • "TCP"
          • ResourcePath — (String)

            The path that you want Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath, the default value is /.

            If you specify TCP for Type, you must not specify a value for ResourcePath.

          • FailureThreshold — (Integer)

            The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

        • HealthCheckCustomConfig — (map)

          A complex type that contains information about an optional custom health check.

          If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.
          • FailureThreshold — (Integer)

            The number of 30-second intervals that you want Cloud Map to wait after receiving an UpdateInstanceCustomHealthStatus request before it changes the health status of a service instance. For example, suppose you specify a value of 2 for FailureTheshold, and then your application sends an UpdateInstanceCustomHealthStatus request. Cloud Map waits for approximately 60 seconds (2 x 30) before changing the status of the service instance based on that request.

            Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value before FailureThreshold x 30 seconds has passed doesn't accelerate the change. Cloud Map still waits FailureThreshold x 30 seconds after the first request to make the change.

        • CreateDate — (Date)

          The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • CreatorRequestId — (String)

          A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

Returns:

  • (AWS.Request) —

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

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

Lists summary information about the instances that you registered by using a specified service.

Service Reference:

Examples:

Calling the listInstances operation

var params = {
  ServiceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
servicediscovery.listInstances(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: {}) —
    • ServiceId — (String)

      The ID of the service that you want to list instances for.

    • NextToken — (String)

      For the first ListInstances request, omit this value.

      If more than MaxResults instances match the specified criteria, you can submit another ListInstances request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

    • MaxResults — (Integer)

      The maximum number of instances that you want AWS Cloud Map to return in the response to a ListInstances request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 instances.

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:

      • Instances — (Array<map>)

        Summary information about the instances that are associated with the specified service.

        • Id — (String)

          The ID for an instance that you created by using a specified service.

        • Attributes — (map<String>)

          A string map that contains the following information:

          • The attributes that are associate with the instance.

          • For each attribute, the applicable value.

          Supported attribute keys include the following:

          • AWS_ALIAS_DNS_NAME: For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that is associated with the load balancer.

          • AWS_INSTANCE_CNAME: For a CNAME record, the domain name that Route 53 returns in response to DNS queries, for example, example.com.

          • AWS_INSTANCE_IPV4: For an A record, the IPv4 address that Route 53 returns in response to DNS queries, for example, 192.0.2.44.

          • AWS_INSTANCE_IPV6: For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345.

          • AWS_INSTANCE_PORT: For an SRV record, the value that Route 53 returns for the port. In addition, if the service includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to.

      • NextToken — (String)

        If more than MaxResults instances match the specified criteria, you can submit another ListInstances request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

Returns:

  • (AWS.Request) —

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

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

Lists summary information about the namespaces that were created by the current AWS account.

Service Reference:

Examples:

Calling the listNamespaces operation

var params = {
  Filters: [
    {
      Name: TYPE, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Condition: EQ | IN | BETWEEN
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
servicediscovery.listNamespaces(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: {}) —
    • NextToken — (String)

      For the first ListNamespaces request, omit this value.

      If the response contains NextToken, submit another ListNamespaces request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

      Note: AWS Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.
    • MaxResults — (Integer)

      The maximum number of namespaces that you want AWS Cloud Map to return in the response to a ListNamespaces request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 namespaces.

    • Filters — (Array<map>)

      A complex type that contains specifications for the namespaces that you want to list.

      If you specify more than one filter, a namespace must match all filters to be returned by ListNamespaces.

      • Name — required — (String)

        Specify TYPE.

        Possible values include:
        • "TYPE"
      • Values — required — (Array<String>)

        If you specify EQ for Condition, specify either DNS_PUBLIC or DNS_PRIVATE.

        If you specify IN for Condition, you can specify DNS_PUBLIC, DNS_PRIVATE, or both.

      • Condition — (String)

        The operator that you want to use to determine whether ListNamespaces returns a namespace. Valid values for condition include:

        • EQ: When you specify EQ for the condition, you can choose to list only public namespaces or private namespaces, but not both. EQ is the default condition and can be omitted.

        • IN: When you specify IN for the condition, you can choose to list public namespaces, private namespaces, or both.

        • BETWEEN: Not applicable

        Possible values include:
        • "EQ"
        • "IN"
        • "BETWEEN"

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:

      • Namespaces — (Array<map>)

        An array that contains one NamespaceSummary object for each namespace that matches the specified filter criteria.

        • Id — (String)

          The ID of the namespace.

        • Arn — (String)

          The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when you create it.

        • Name — (String)

          The name of the namespace. When you create a namespace, AWS Cloud Map automatically creates a Route 53 hosted zone that has the same name as the namespace.

        • Type — (String)

          The type of the namespace, either public or private.

          Possible values include:
          • "DNS_PUBLIC"
          • "DNS_PRIVATE"
          • "HTTP"
        • Description — (String)

          A description for the namespace.

        • ServiceCount — (Integer)

          The number of services that were created using the namespace.

        • Properties — (map)

          A complex type that contains information that is specific to the namespace type.

          • DnsProperties — (map)

            A complex type that contains the ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.

            • HostedZoneId — (String)

              The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.

          • HttpProperties — (map)

            A complex type that contains the name of an HTTP namespace.

            • HttpName — (String)

              The name of an HTTP namespace.

        • CreateDate — (Date)

          The date and time that the namespace was created.

      • NextToken — (String)

        If the response contains NextToken, submit another ListNamespaces request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

        Note: AWS Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.

Returns:

  • (AWS.Request) —

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

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

Lists operations that match the criteria that you specify.

Service Reference:

Examples:

Calling the listOperations operation

var params = {
  Filters: [
    {
      Name: NAMESPACE_ID | SERVICE_ID | STATUS | TYPE | UPDATE_DATE, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Condition: EQ | IN | BETWEEN
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
servicediscovery.listOperations(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: {}) —
    • NextToken — (String)

      For the first ListOperations request, omit this value.

      If the response contains NextToken, submit another ListOperations request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

      Note: AWS Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's possible that no operations in the first MaxResults operations matched the specified criteria but that subsequent groups of MaxResults operations do contain operations that match the criteria.
    • MaxResults — (Integer)

      The maximum number of items that you want AWS Cloud Map to return in the response to a ListOperations request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 operations.

    • Filters — (Array<map>)

      A complex type that contains specifications for the operations that you want to list, for example, operations that you started between a specified start date and end date.

      If you specify more than one filter, an operation must match all filters to be returned by ListOperations.

      • Name — required — (String)

        Specify the operations that you want to get:

        • NAMESPACE_ID: Gets operations related to specified namespaces.

        • SERVICE_ID: Gets operations related to specified services.

        • STATUS: Gets operations based on the status of the operations: SUBMITTED, PENDING, SUCCEED, or FAIL.

        • TYPE: Gets specified types of operation.

        • UPDATE_DATE: Gets operations that changed status during a specified date/time range.

        Possible values include:
        • "NAMESPACE_ID"
        • "SERVICE_ID"
        • "STATUS"
        • "TYPE"
        • "UPDATE_DATE"
      • Values — required — (Array<String>)

        Specify values that are applicable to the value that you specify for Name:

        • NAMESPACE_ID: Specify one namespace ID.

        • SERVICE_ID: Specify one service ID.

        • STATUS: Specify one or more statuses: SUBMITTED, PENDING, SUCCEED, or FAIL.

        • TYPE: Specify one or more of the following types: CREATE_NAMESPACE, DELETE_NAMESPACE, UPDATE_SERVICE, REGISTER_INSTANCE, or DEREGISTER_INSTANCE.

        • UPDATE_DATE: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value.

      • Condition — (String)

        The operator that you want to use to determine whether an operation matches the specified value. Valid values for condition include:

        • EQ: When you specify EQ for the condition, you can specify only one value. EQ is supported for NAMESPACE_ID, SERVICE_ID, STATUS, and TYPE. EQ is the default condition and can be omitted.

        • IN: When you specify IN for the condition, you can specify a list of one or more values. IN is supported for STATUS and TYPE. An operation must match one of the specified values to be returned in the response.

        • BETWEEN: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value. BETWEEN is supported for UPDATE_DATE.

        Possible values include:
        • "EQ"
        • "IN"
        • "BETWEEN"

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:

      • Operations — (Array<map>)

        Summary information about the operations that match the specified criteria.

        • Id — (String)

          The ID for an operation.

        • Status — (String)

          The status of the operation. Values include the following:

          • SUBMITTED: This is the initial state immediately after you submit a request.

          • PENDING: AWS Cloud Map is performing the operation.

          • SUCCESS: The operation succeeded.

          • FAIL: The operation failed. For the failure reason, see ErrorMessage.

          Possible values include:
          • "SUBMITTED"
          • "PENDING"
          • "SUCCESS"
          • "FAIL"
      • NextToken — (String)

        If the response contains NextToken, submit another ListOperations request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

        Note: AWS Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's possible that no operations in the first MaxResults operations matched the specified criteria but that subsequent groups of MaxResults operations do contain operations that match the criteria.

Returns:

  • (AWS.Request) —

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

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

Lists summary information for all the services that are associated with one or more specified namespaces.

Service Reference:

Examples:

Calling the listServices operation

var params = {
  Filters: [
    {
      Name: NAMESPACE_ID, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Condition: EQ | IN | BETWEEN
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
servicediscovery.listServices(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: {}) —
    • NextToken — (String)

      For the first ListServices request, omit this value.

      If the response contains NextToken, submit another ListServices request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

      Note: AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's possible that no services in the first MaxResults services matched the specified criteria but that subsequent groups of MaxResults services do contain services that match the criteria.
    • MaxResults — (Integer)

      The maximum number of services that you want AWS Cloud Map to return in the response to a ListServices request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 services.

    • Filters — (Array<map>)

      A complex type that contains specifications for the namespaces that you want to list services for.

      If you specify more than one filter, an operation must match all filters to be returned by ListServices.

      • Name — required — (String)

        Specify NAMESPACE_ID.

        Possible values include:
        • "NAMESPACE_ID"
      • Values — required — (Array<String>)

        The values that are applicable to the value that you specify for Condition to filter the list of services.

      • Condition — (String)

        The operator that you want to use to determine whether a service is returned by ListServices. Valid values for Condition include the following:

        • EQ: When you specify EQ, specify one namespace ID for Values. EQ is the default condition and can be omitted.

        • IN: When you specify IN, specify a list of the IDs for the namespaces that you want ListServices to return a list of services for.

        • BETWEEN: Not applicable.

        Possible values include:
        • "EQ"
        • "IN"
        • "BETWEEN"

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:

      • Services — (Array<map>)

        An array that contains one ServiceSummary object for each service that matches the specified filter criteria.

        • Id — (String)

          The ID that AWS Cloud Map assigned to the service when you created it.

        • Arn — (String)

          The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.

        • Name — (String)

          The name of the service.

        • Description — (String)

          The description that you specify when you create the service.

        • InstanceCount — (Integer)

          The number of instances that are currently associated with the service. Instances that were previously associated with the service but that have been deleted are not included in the count.

        • DnsConfig — (map)

          A complex type that contains information about the Amazon Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.

          • NamespaceId — (String)

            The ID of the namespace to use for DNS configuration.

          • RoutingPolicy — (String)

            The routing policy that you want to apply to all Route 53 DNS records that AWS Cloud Map creates when you register an instance and specify this service.

            Note: If you want to use this service to register instances that create alias records, specify WEIGHTED for the routing policy.

            You can specify the following values:

            MULTIVALUE

            If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.

            For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.

            If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.

            For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide.

            WEIGHTED

            Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.

            For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.

            If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.

            For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.

            Possible values include:
            • "MULTIVALUE"
            • "WEIGHTED"
          • DnsRecords — required — (Array<map>)

            An array that contains one DnsRecord object for each Route 53 DNS record that you want AWS Cloud Map to create when you register an instance.

            • Type — required — (String)

              The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries.

              Note the following:

              • A, AAAA, and SRV records: You can specify settings for a maximum of one A, one AAAA, and one SRV record. You can specify them in any combination.

              • CNAME records: If you specify CNAME for Type, you can't define any other records. This is a limitation of DNS: you can't create a CNAME record and any other type of record that has the same name as a CNAME record.

              • Alias records: If you want AWS Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type.

              • All records: You specify settings other than TTL and Type when you register an instance.

              The following values are supported:

              A

              Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.

              AAAA

              Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.

              CNAME

              Route 53 returns the domain name of the resource, such as www.example.com. Note the following:

              • You specify the domain name that you want to route traffic to when you register an instance. For more information, see RegisterInstanceRequest$Attributes.

              • You must specify WEIGHTED for the value of RoutingPolicy.

              • You can't specify both CNAME for Type and settings for HealthCheckConfig. If you do, the request will fail with an InvalidInput error.

              SRV

              Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:

              priority weight port service-hostname

              Note the following about the values:

              • The values of priority and weight are both set to 1 and can't be changed.

              • The value of port comes from the value that you specify for the AWS_INSTANCE_PORT attribute when you submit a RegisterInstance request.

              • The value of service-hostname is a concatenation of the following values:

                • The value that you specify for InstanceId when you register an instance.

                • The name of the service.

                • The name of the namespace.

                For example, if the value of InstanceId is test, the name of the service is backend, and the name of the namespace is example.com, the value of service-hostname is:

                test.backend.example.com

              If you specify settings for an SRV record and if you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the RegisterInstance request, AWS Cloud Map automatically creates A and/or AAAA records that have the same name as the value of service-hostname in the SRV record. You can ignore these records.

              Possible values include:
              • "SRV"
              • "A"
              • "AAAA"
              • "CNAME"
            • TTL — required — (Integer)

              The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.

              Note: Alias records don't include a TTL because Route 53 uses the TTL for the AWS resource that an alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request, the TTL value is ignored. Always specify a TTL for the service; you can use a service to register instances that create either alias or non-alias records.
        • HealthCheckConfig — (map)

          Public DNS namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig.

          If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

          Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing.

          Note the following about configuring health checks.

          A and AAAA records

          If DnsConfig includes configurations for both A and AAAA records, AWS Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint that is specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA records to be unhealthy.

          CNAME records

          You can't specify settings for HealthCheckConfig when the DNSConfig includes CNAME for the value of Type. If you do, the CreateService request will fail with an InvalidInput error.

          Request interval

          A Route 53 health checker in each health-checking region sends a health check request to an endpoint every 30 seconds. On average, your endpoint receives a health check request about every two seconds. However, health checkers don't coordinate with one another, so you'll sometimes see several requests per second followed by a few seconds with no health checks at all.

          Health checking regions

          Health checkers perform checks from all Route 53 health-checking regions. For a list of the current regions, see Regions.

          Alias records

          When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, AWS Cloud Map creates a Route 53 alias record. Note the following:

          • Route 53 automatically sets EvaluateTargetHealth to true for alias records. When EvaluateTargetHealth is true, the alias record inherits the health of the referenced AWS resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth.

          • If you include HealthCheckConfig and then use the service to register an instance that creates an alias record, Route 53 doesn't create the health check.

          Charges for health checks

          Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing.

          • Type — required — (String)

            The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.

            You can't change the value of Type after you create a health check.

            You can create the following types of health checks:

            • HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

            • HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

              If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

            • TCP: Route 53 tries to establish a TCP connection.

              If you specify TCP for Type, don't specify a value for ResourcePath.

            For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

            Possible values include:
            • "HTTP"
            • "HTTPS"
            • "TCP"
          • ResourcePath — (String)

            The path that you want Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath, the default value is /.

            If you specify TCP for Type, you must not specify a value for ResourcePath.

          • FailureThreshold — (Integer)

            The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

        • HealthCheckCustomConfig — (map)

          A complex type that contains information about an optional custom health check. A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances:

          • You can't use a health check that is defined by HealthCheckConfig because the resource isn't available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)

          • You want to use a third-party health checker regardless of where your resources are.

          If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

          To change the status of a custom health check, submit an UpdateInstanceCustomHealthStatus request. Cloud Map doesn't monitor the status of the resource, it just keeps a record of the status specified in the most recent UpdateInstanceCustomHealthStatus request.

          Here's how custom health checks work:

          1. You create a service and specify a value for FailureThreshold.

            The failure threshold indicates the number of 30-second intervals you want AWS Cloud Map to wait between the time that your application sends an UpdateInstanceCustomHealthStatus request and the time that AWS Cloud Map stops routing internet traffic to the corresponding resource.

          2. You register an instance.

          3. You configure a third-party health checker to monitor the resource that is associated with the new instance.

            Note: AWS Cloud Map doesn't check the health of the resource directly.

          4. The third-party health-checker determines that the resource is unhealthy and notifies your application.

          5. Your application submits an UpdateInstanceCustomHealthStatus request.

          6. AWS Cloud Map waits for (FailureThreshold x 30) seconds.

          7. If another UpdateInstanceCustomHealthStatus request doesn't arrive during that time to change the status back to healthy, AWS Cloud Map stops routing traffic to the resource.

          Note the following about configuring custom health checks.

          • FailureThreshold — (Integer)

            The number of 30-second intervals that you want Cloud Map to wait after receiving an UpdateInstanceCustomHealthStatus request before it changes the health status of a service instance. For example, suppose you specify a value of 2 for FailureTheshold, and then your application sends an UpdateInstanceCustomHealthStatus request. Cloud Map waits for approximately 60 seconds (2 x 30) before changing the status of the service instance based on that request.

            Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value before FailureThreshold x 30 seconds has passed doesn't accelerate the change. Cloud Map still waits FailureThreshold x 30 seconds after the first request to make the change.

        • CreateDate — (Date)

          The date and time that the service was created.

      • NextToken — (String)

        If the response contains NextToken, submit another ListServices request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

        Note: AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's possible that no services in the first MaxResults services matched the specified criteria but that subsequent groups of MaxResults services do contain services that match the criteria.

Returns:

  • (AWS.Request) —

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

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

Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service. When you submit a RegisterInstance request, the following occurs:

  • For each DNS record that you define in the service that is specified by ServiceId, a record is created or updated in the hosted zone that is associated with the corresponding namespace.

  • If the service includes HealthCheckConfig, a health check is created based on the settings in the health check configuration.

  • The health check, if any, is associated with each of the new or updated records.

One RegisterInstance request must complete before you can submit another request and specify the same service ID and instance ID.

For more information, see CreateService.

When AWS Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:

  • If the health check is healthy: returns all the records

  • If the health check is unhealthy: returns the applicable value for the last healthy instance

  • If you didn't specify a health check configuration: returns all the records

For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

Service Reference:

Examples:

Calling the registerInstance operation

var params = {
  Attributes: { /* required */
    '<AttrKey>': 'STRING_VALUE',
    /* '<AttrKey>': ... */
  },
  InstanceId: 'STRING_VALUE', /* required */
  ServiceId: 'STRING_VALUE', /* required */
  CreatorRequestId: 'STRING_VALUE'
};
servicediscovery.registerInstance(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: {}) —
    • ServiceId — (String)

      The ID of the service that you want to use for settings for the instance.

    • InstanceId — (String)

      An identifier that you want to associate with the instance. Note the following:

      • If the service that is specified by ServiceId includes settings for an SRV record, the value of InstanceId is automatically included as part of the value for the SRV record. For more information, see DnsRecord$Type.

      • You can use this value to update an existing instance.

      • To register a new instance, you must specify a value that is unique among instances that you register by using the same service.

      • If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing DNS records, if any. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates a new one.

        Note: The health check isn't deleted immediately, so it will still appear for a while if you submit a ListHealthChecks request, for example.
    • CreatorRequestId — (String)

      A unique string that identifies the request and that allows failed RegisterInstance requests to be retried without the risk of executing the operation twice. You must use a unique CreatorRequestId string every time you submit a RegisterInstance request if you're registering additional instances for the same namespace and service. CreatorRequestId can be any unique string, for example, a date/time stamp.

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

      A string map that contains the following information for the service that you specify in ServiceId:

      • The attributes that apply to the records that are defined in the service.

      • For each attribute, the applicable value.

      Supported attribute keys include the following:

      AWS_ALIAS_DNS_NAME

      If you want AWS Cloud Map to create an Amazon Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see "DNSName" in the topic AliasTarget in the Route 53 API Reference.

      Note the following:

      • The configuration for the service that is specified by ServiceId must include settings for an A record, an AAAA record, or both.

      • In the service that is specified by ServiceId, the value of RoutingPolicy must be WEIGHTED.

      • If the service that is specified by ServiceId includes HealthCheckConfig settings, AWS Cloud Map will create the Route 53 health check, but it won't associate the health check with the alias record.

      • Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers.

      • If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the AWS_INSTANCE attributes.

      AWS_INIT_HEALTH_STATUS

      If the service configuration includes HealthCheckCustomConfig, you can optionally use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check, HEALTHY or UNHEALTHY. If you don't specify a value for AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

      AWS_INSTANCE_CNAME

      If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response to DNS queries, for example, example.com.

      This value is required if the service specified by ServiceId includes settings for an CNAME record.

      AWS_INSTANCE_IPV4

      If the service configuration includes an A record, the IPv4 address that you want Route 53 to return in response to DNS queries, for example, 192.0.2.44.

      This value is required if the service specified by ServiceId includes settings for an A record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

      AWS_INSTANCE_IPV6

      If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to return in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345.

      This value is required if the service specified by ServiceId includes settings for an AAAA record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

      AWS_INSTANCE_PORT

      If the service includes an SRV record, the value that you want Route 53 to return for the port.

      If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send requests to.

      This value is required if you specified settings for an SRV record when you created the service.

      Custom attributes

      You can add up to 30 custom attributes. For each key-value pair, the maximum length of the attribute name is 255 characters, and the maximum length of the attribute value is 1,024 characters.

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:

      • OperationId — (String)

        A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

Returns:

  • (AWS.Request) —

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

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

Submits a request to change the health status of a custom health check to healthy or unhealthy.

You can use UpdateInstanceCustomHealthStatus to change the status only for custom health checks, which you define using HealthCheckCustomConfig when you create a service. You can't use it to change the status for Route 53 health checks, which you define using HealthCheckConfig.

For more information, see HealthCheckCustomConfig.

Service Reference:

Examples:

Calling the updateInstanceCustomHealthStatus operation

var params = {
  InstanceId: 'STRING_VALUE', /* required */
  ServiceId: 'STRING_VALUE', /* required */
  Status: HEALTHY | UNHEALTHY /* required */
};
servicediscovery.updateInstanceCustomHealthStatus(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: {}) —
    • ServiceId — (String)

      The ID of the service that includes the configuration for the custom health check that you want to change the status for.

    • InstanceId — (String)

      The ID of the instance that you want to change the health status for.

    • Status — (String)

      The new status of the instance, HEALTHY or UNHEALTHY.

      Possible values include:
      • "HEALTHY"
      • "UNHEALTHY"

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.

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

Submits a request to perform the following operations:

  • Add or delete DnsRecords configurations

  • Update the TTL setting for existing DnsRecords configurations

  • Add, update, or delete HealthCheckConfig for a specified service

For public and private DNS namespaces, you must specify all DnsRecords configurations (and, optionally, HealthCheckConfig) that you want to appear in the updated service. Any current configurations that don't appear in an UpdateService request are deleted.

When you update the TTL setting for a service, AWS Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service.

Service Reference:

Examples:

Calling the updateService operation

var params = {
  Id: 'STRING_VALUE', /* required */
  Service: { /* required */
    DnsConfig: { /* required */
      DnsRecords: [ /* required */
        {
          TTL: 'NUMBER_VALUE', /* required */
          Type: SRV | A | AAAA | CNAME /* required */
        },
        /* more items */
      ]
    },
    Description: 'STRING_VALUE',
    HealthCheckConfig: {
      Type: HTTP | HTTPS | TCP, /* required */
      FailureThreshold: 'NUMBER_VALUE',
      ResourcePath: 'STRING_VALUE'
    }
  }
};
servicediscovery.updateService(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: {}) —
    • Id — (String)

      The ID of the service that you want to update.

    • Service — (map)

      A complex type that contains the new settings for the service.

      • Description — (String)

        A description for the service.

      • DnsConfig — required — (map)

        A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.

        • DnsRecords — required — (Array<map>)

          An array that contains one DnsRecord object for each Route 53 record that you want AWS Cloud Map to create when you register an instance.

          • Type — required — (String)

            The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries.

            Note the following:

            • A, AAAA, and SRV records: You can specify settings for a maximum of one A, one AAAA, and one SRV record. You can specify them in any combination.

            • CNAME records: If you specify CNAME for Type, you can't define any other records. This is a limitation of DNS: you can't create a CNAME record and any other type of record that has the same name as a CNAME record.

            • Alias records: If you want AWS Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type.

            • All records: You specify settings other than TTL and Type when you register an instance.

            The following values are supported:

            A

            Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.

            AAAA

            Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.

            CNAME

            Route 53 returns the domain name of the resource, such as www.example.com. Note the following:

            • You specify the domain name that you want to route traffic to when you register an instance. For more information, see RegisterInstanceRequest$Attributes.

            • You must specify WEIGHTED for the value of RoutingPolicy.

            • You can't specify both CNAME for Type and settings for HealthCheckConfig. If you do, the request will fail with an InvalidInput error.

            SRV

            Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:

            priority weight port service-hostname

            Note the following about the values:

            • The values of priority and weight are both set to 1 and can't be changed.

            • The value of port comes from the value that you specify for the AWS_INSTANCE_PORT attribute when you submit a RegisterInstance request.

            • The value of service-hostname is a concatenation of the following values:

              • The value that you specify for InstanceId when you register an instance.

              • The name of the service.

              • The name of the namespace.

              For example, if the value of InstanceId is test, the name of the service is backend, and the name of the namespace is example.com, the value of service-hostname is:

              test.backend.example.com

            If you specify settings for an SRV record and if you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the RegisterInstance request, AWS Cloud Map automatically creates A and/or AAAA records that have the same name as the value of service-hostname in the SRV record. You can ignore these records.

            Possible values include:
            • "SRV"
            • "A"
            • "AAAA"
            • "CNAME"
          • TTL — required — (Integer)

            The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.

            Note: Alias records don't include a TTL because Route 53 uses the TTL for the AWS resource that an alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request, the TTL value is ignored. Always specify a TTL for the service; you can use a service to register instances that create either alias or non-alias records.
      • HealthCheckConfig — (map)

        Public DNS namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig.

        If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

        Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing.

        Note the following about configuring health checks.

        A and AAAA records

        If DnsConfig includes configurations for both A and AAAA records, AWS Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint that is specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA records to be unhealthy.

        CNAME records

        You can't specify settings for HealthCheckConfig when the DNSConfig includes CNAME for the value of Type. If you do, the CreateService request will fail with an InvalidInput error.

        Request interval

        A Route 53 health checker in each health-checking region sends a health check request to an endpoint every 30 seconds. On average, your endpoint receives a health check request about every two seconds. However, health checkers don't coordinate with one another, so you'll sometimes see several requests per second followed by a few seconds with no health checks at all.

        Health checking regions

        Health checkers perform checks from all Route 53 health-checking regions. For a list of the current regions, see Regions.

        Alias records

        When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, AWS Cloud Map creates a Route 53 alias record. Note the following:

        • Route 53 automatically sets EvaluateTargetHealth to true for alias records. When EvaluateTargetHealth is true, the alias record inherits the health of the referenced AWS resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth.

        • If you include HealthCheckConfig and then use the service to register an instance that creates an alias record, Route 53 doesn't create the health check.

        Charges for health checks

        Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing.

        • Type — required — (String)

          The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.

          You can't change the value of Type after you create a health check.

          You can create the following types of health checks:

          • HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

          • HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

            If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

          • TCP: Route 53 tries to establish a TCP connection.

            If you specify TCP for Type, don't specify a value for ResourcePath.

          For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

          Possible values include:
          • "HTTP"
          • "HTTPS"
          • "TCP"
        • ResourcePath — (String)

          The path that you want Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath, the default value is /.

          If you specify TCP for Type, you must not specify a value for ResourcePath.

        • FailureThreshold — (Integer)

          The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

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:

      • OperationId — (String)

        A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

Returns:

  • (AWS.Request) —

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