Class: AWS.ServiceDiscovery
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.ServiceDiscovery
- 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
With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your microservice applications run in. When an instance becomes available, you can call the Cloud Map API to register the instance with Cloud Map. For public or private DNS namespaces, 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 collapse
-
new AWS.ServiceDiscovery(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
createHttpNamespace(params = {}, callback) ⇒ AWS.Request
Creates an HTTP namespace.
-
createPrivateDnsNamespace(params = {}, callback) ⇒ AWS.Request
Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC.
-
createPublicDnsNamespace(params = {}, callback) ⇒ AWS.Request
Creates a public namespace based on DNS, which is visible on the internet.
-
createService(params = {}, callback) ⇒ AWS.Request
Creates a service.
-
deleteNamespace(params = {}, callback) ⇒ AWS.Request
Deletes a namespace from the current account.
-
deleteService(params = {}, callback) ⇒ AWS.Request
Deletes a specified service.
-
deregisterInstance(params = {}, callback) ⇒ AWS.Request
Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified instance.
.
-
discoverInstances(params = {}, callback) ⇒ AWS.Request
Discovers registered instances for a specified namespace and service.
-
getInstance(params = {}, callback) ⇒ AWS.Request
Gets information about a specified instance.
.
-
getInstancesHealthStatus(params = {}, callback) ⇒ AWS.Request
Gets the current health status (
Healthy
,Unhealthy
, orUnknown
) of one or more instances that are associated with a specified service.Note: There's a brief delay between when you register an instance and when the health status for the instance is available.- getNamespace(params = {}, callback) ⇒ AWS.Request
Gets information about a namespace.
.
- 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.- getService(params = {}, callback) ⇒ AWS.Request
Gets the settings for a specified service.
.
- listInstances(params = {}, callback) ⇒ AWS.Request
Lists summary information about the instances that you registered by using a specified service.
.
- listNamespaces(params = {}, callback) ⇒ AWS.Request
Lists summary information about the namespaces that were created by the current account.
.
- listOperations(params = {}, callback) ⇒ AWS.Request
Lists operations that match the criteria that you specify.
.
- listServices(params = {}, callback) ⇒ AWS.Request
Lists summary information for all the services that are associated with one or more specified namespaces.
.
- listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists tags for the specified resource.
.
- 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.
- tagResource(params = {}, callback) ⇒ AWS.Request
Adds one or more tags to the specified resource.
.
- untagResource(params = {}, callback) ⇒ AWS.Request
Removes one or more tags from the specified resource.
.
- updateHttpNamespace(params = {}, callback) ⇒ AWS.Request
Updates an HTTP namespace.
.
- 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 usingHealthCheckCustomConfig
when you create a service.- updatePrivateDnsNamespace(params = {}, callback) ⇒ AWS.Request
Updates a private DNS namespace.
.
- updatePublicDnsNamespace(params = {}, callback) ⇒ AWS.Request
Updates a public DNS namespace.
.
- updateService(params = {}, callback) ⇒ AWS.Request
Submits a request to perform the following operations:
-
Update the TTL setting for existing
DnsRecords
configurations -
Add, update, or delete
HealthCheckConfig
for a specified serviceNote: You can't add, update, or delete aHealthCheckCustomConfig
configuration.
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|AWS.Endpoint)
—
The endpoint URI to send requests to. The default endpoint is built from the configured
region
. The endpoint should be a string like'https://{service}.{region}.amazonaws.com'
or an Endpoint object. -
accessKeyId
(String)
—
your AWS access key ID.
-
secretAccessKey
(String)
—
your AWS secret access key.
-
sessionToken
(AWS.Credentials)
—
the optional AWS session token to sign requests with.
-
credentials
(AWS.Credentials)
—
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
-
credentialProvider
(AWS.CredentialProviderChain)
—
the provider chain used to resolve credentials if no static
credentials
property is set. -
region
(String)
—
the region to send service requests to. See AWS.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.
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
-
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 totrue
. -
s3UsEast1RegionalEndpoint
('legacy'|'regional')
—
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to
legacy
-
s3UseArnRegion
(Boolean)
—
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to
true
-
retryDelayOptions
(map)
—
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a
retry count and error and returns the amount of time to delay in
milliseconds. If the result is a non-zero negative value, no further
retry attempts will be made. The
base
option will be ignored if this option is supplied. The function is only called for retryable errors.
-
httpOptions
(map)
—
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform
HTTP requests with. Used for connection pooling. Defaults to the global
agent (
http.globalAgent
) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment. - connectTimeout [Integer] — Sets the socket to timeout after
failing to establish a connection with the server after
connectTimeout
milliseconds. This timeout has no effect once a socket connection has been established. - timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
-
apiVersion
(String, Date)
—
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by
apiVersions
). Specify 'latest' to use the latest possible version. -
apiVersions
(map<String, String|Date>)
—
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
-
logger
(#write, #log)
—
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
-
systemClockOffset
(Number)
—
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global
AWS.config
object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds. -
signatureVersion
(String)
—
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
-
signatureCache
(Boolean)
—
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to
true
. -
dynamoDbCrc32
(Boolean)
—
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default:
true
. -
useAccelerateEndpoint
(Boolean)
—
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default:
false
. -
clientSideMonitoring
(Boolean)
—
whether to collect and publish this client's performance metrics of all its API requests.
-
endpointDiscoveryEnabled
(Boolean|undefined)
—
whether to call operations with endpoints given by service dynamically. Setting this
-
endpointCacheSize
(Number)
—
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
-
hostPrefixEnabled
(Boolean)
—
whether to marshal request parameters to the prefix of hostname. Defaults to
true
. -
stsRegionalEndpoints
('legacy'|'regional')
—
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.
Property Details
Method Details
createHttpNamespace(params = {}, callback) ⇒ AWS.Request
Creates an HTTP namespace. Service instances registered using an HTTP namespace can be discovered using a
DiscoverInstances
request but can't be discovered using DNS.For the current quota on the number of namespaces that you can create using the same account, see Cloud Map quotas in the Cloud Map Developer Guide.
Service Reference:
Examples:
CreateHttpNamespace example
/* This example creates an HTTP namespace. */ var params = { CreatorRequestId: "example-creator-request-id-0001", Description: "Example.com AWS Cloud Map HTTP Namespace", Name: "example-http.com" }; servicediscovery.createHttpNamespace(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { OperationId: "httpvoqozuhfet5kzxoxg-a-response-example" } */ });
Calling the createHttpNamespace operation
var params = { Name: 'STRING_VALUE', /* required */ CreatorRequestId: 'STRING_VALUE', Description: 'STRING_VALUE', Tags: [ { Key: 'STRING_VALUE', /* required */ Value: 'STRING_VALUE' /* required */ }, /* more items */ ] }; 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
If a token is not provided, the SDK will use a version 4 UUID.CreateHttpNamespace
requests to be retried without the risk of running the operation twice.CreatorRequestId
can be any unique string (for example, a date/time stamp).Description
— (String
)A description for the namespace.
Tags
— (Array<map>
)The tags to add to the namespace. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.
Key
— required — (String
)The key identifier, or name, of the tag.
Value
— required — (String
)The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.
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. Thedata
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.
-
(AWS.Response)
—
Returns:
createPrivateDnsNamespace(params = {}, callback) ⇒ AWS.Request
Creates a private namespace based on DNS, which is 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 servicebackend
, the resulting DNS name for the service isbackend.example.com
. Service instances that are registered using a private DNS namespace can be discovered using either aDiscoverInstances
request or using DNS. For the current quota on the number of namespaces that you can create using the same account, see Cloud Map quotas in the Cloud Map Developer Guide.Service Reference:
Examples:
Example: Create private DNS namespace
/* Example: Create private DNS namespace */ var params = { CreatorRequestId: "eedd6892-50f3-41b2-8af9-611d6e1d1a8c", Name: "example.com", Vpc: "vpc-1c56417b" }; servicediscovery.createPrivateDnsNamespace(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { OperationId: "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd" } */ });
Calling the createPrivateDnsNamespace operation
var params = { Name: 'STRING_VALUE', /* required */ Vpc: 'STRING_VALUE', /* required */ CreatorRequestId: 'STRING_VALUE', Description: 'STRING_VALUE', Properties: { DnsProperties: { /* required */ SOA: { /* required */ TTL: 'NUMBER_VALUE' /* required */ } } }, Tags: [ { Key: 'STRING_VALUE', /* required */ Value: 'STRING_VALUE' /* required */ }, /* more items */ ] }; 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, 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
If a token is not provided, the SDK will use a version 4 UUID.CreatePrivateDnsNamespace
requests to be retried without the risk of running the operation twice.CreatorRequestId
can be any unique string (for example, a date/timestamp).Description
— (String
)A description for the namespace.
Vpc
— (String
)The ID of the Amazon VPC that you want to associate the namespace with.
Tags
— (Array<map>
)The tags to add to the namespace. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.
Key
— required — (String
)The key identifier, or name, of the tag.
Value
— required — (String
)The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.
Properties
— (map
)Properties for the private DNS namespace.
DnsProperties
— required — (map
)DNS properties for the private DNS namespace.
SOA
— required — (map
)Fields for the Start of Authority (SOA) record for the hosted zone for the private DNS namespace.
TTL
— required — (Integer
)The time to live (TTL) for purposes of negative caching.
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. Thedata
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.
-
(AWS.Response)
—
Returns:
createPublicDnsNamespace(params = {}, callback) ⇒ AWS.Request
Creates a public namespace based on DNS, which is visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace
example.com
and name your servicebackend
, the resulting DNS name for the service isbackend.example.com
. You can discover instances that were registered with a public DNS namespace by using either aDiscoverInstances
request or using DNS. For the current quota on the number of namespaces that you can create using the same account, see Cloud Map quotas in the Cloud Map Developer Guide.Service Reference:
Examples:
CreatePublicDnsNamespace example
/* This example creates a public namespace based on DNS. */ var params = { CreatorRequestId: "example-creator-request-id-0003", Description: "Example.com AWS Cloud Map Public DNS Namespace", Name: "example-public-dns.com" }; servicediscovery.createPublicDnsNamespace(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { OperationId: "dns2voqozuhfet5kzxoxg-a-response-example" } */ });
Calling the createPublicDnsNamespace operation
var params = { Name: 'STRING_VALUE', /* required */ CreatorRequestId: 'STRING_VALUE', Description: 'STRING_VALUE', Properties: { DnsProperties: { /* required */ SOA: { /* required */ TTL: 'NUMBER_VALUE' /* required */ } } }, Tags: [ { Key: 'STRING_VALUE', /* required */ Value: 'STRING_VALUE' /* required */ }, /* more items */ ] }; 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
If a token is not provided, the SDK will use a version 4 UUID.CreatePublicDnsNamespace
requests to be retried without the risk of running the operation twice.CreatorRequestId
can be any unique string (for example, a date/timestamp).Description
— (String
)A description for the namespace.
Tags
— (Array<map>
)The tags to add to the namespace. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.
Key
— required — (String
)The key identifier, or name, of the tag.
Value
— required — (String
)The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.
Properties
— (map
)Properties for the public DNS namespace.
DnsProperties
— required — (map
)DNS properties for the public DNS namespace.
SOA
— required — (map
)Start of Authority (SOA) record for the hosted zone for the public DNS namespace.
TTL
— required — (Integer
)The time to live (TTL) for purposes of negative caching.
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. Thedata
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.
-
(AWS.Response)
—
Returns:
createService(params = {}, callback) ⇒ AWS.Request
Creates a service. This action 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
andAAAA
-
SRV
-
CNAME
-
-
Optionally, a health check
After you create the service, you can submit a RegisterInstance request, and Cloud Map uses the values in the configuration to create the specified entities.
For the current quota on the number of instances that you can register using the same namespace and using the same service, see Cloud Map quotas in the Cloud Map Developer Guide.
Service Reference:
Examples:
Example: Create service
/* Example: Create service */ var params = { CreatorRequestId: "567c1193-6b00-4308-bd57-ad38a8822d25", DnsConfig: { DnsRecords: [ { TTL: 60, Type: "A" } ], NamespaceId: "ns-ylexjili4cdxy3xm", RoutingPolicy: "MULTIVALUE" }, Name: "myservice", NamespaceId: "ns-ylexjili4cdxy3xm" }; servicediscovery.createService(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { Service: { Arn: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita", CreateDate: <Date Representation>, CreatorRequestId: "567c1193-6b00-4308-bd57-ad38a8822d25", DnsConfig: { DnsRecords: [ { TTL: 60, Type: "A" } ], NamespaceId: "ns-ylexjili4cdxy3xm", RoutingPolicy: "MULTIVALUE" }, Id: "srv-p5zdwlg5uvvzjita", Name: "myservice", NamespaceId: "ns-ylexjili4cdxy3xm" } } */ });
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', Tags: [ { Key: 'STRING_VALUE', /* required */ Value: 'STRING_VALUE' /* required */ }, /* more items */ ], Type: HTTP }; 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.
If you want Cloud Map to create an
SRV
record when you register an instance and you're using a system that requires a specificSRV
format, such as HAProxy, specify the following forName
:-
Start the name with an underscore (), such as
_exampleservice
. -
End the name with .protocol, such as
._tcp
.
When you register an instance, Cloud Map creates an
SRV
record and assigns a name to the record by concatenating the service name and the namespace name (for example,_exampleservice._tcp.example.com
).Note: For services that are accessible by DNS queries, you can't create multiple services with names that differ only by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be distinguished. However, if you use a namespace that's only accessible by API calls, then you can create services that with names that differ only by case.-
NamespaceId
— (String
)The ID of the namespace that you want to use to create the service. The namespace ID must be specified, but it can be specified either here or in the
DnsConfig
object.CreatorRequestId
— (String
)A unique string that identifies the request and that allows failed
If a token is not provided, the SDK will use a version 4 UUID.CreateService
requests to be retried without the risk of running the operation twice.CreatorRequestId
can be any unique string (for example, a date/timestamp).Description
— (String
)A description for the service.
DnsConfig
— (map
)A complex type that contains information about the Amazon Route 53 records that you want 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 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, specifyWEIGHTED
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 that the service includes configurations for one
A
record and a health check. 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 that the service includes configurations for one
A
record and a health check. 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.
"MULTIVALUE"
"WEIGHTED"
DnsRecords
— required — (Array<map>
)An array that contains one
DnsRecord
object for each Route 53 DNS record that you want 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. You can specify values for
Type
in the following combinations:-
A
-
AAAA
-
A
andAAAA
-
SRV
-
CNAME
If you want Cloud Map to create a Route 53 alias record when you register an instance, specify
A
orAAAA
forType
.You specify other settings, such as the IP address for
A
andAAAA
records, when you register an instance. For more information, see RegisterInstance.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 Attributes in the topic RegisterInstance.
-
You must specify
WEIGHTED
for the value ofRoutingPolicy
. -
You can't specify both
CNAME
forType
and settings forHealthCheckConfig
. If you do, the request will fail with anInvalidInput
error.
-
- SRV
-
Route 53 returns the value for an
SRV
record. The value for anSRV
record uses the following values:priority weight port service-hostname
Note the following about the values:
-
The values of
priority
andweight
are both set to1
and can't be changed. -
The value of
port
comes from the value that you specify for theAWS_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
istest
, the name of the service isbackend
, and the name of the namespace isexample.com
, the value ofservice-hostname
is the following:test.backend.example.com
-
If you specify settings for an
SRV
record, note the following:-
If you specify values for
AWS_INSTANCE_IPV4
,AWS_INSTANCE_IPV6
, or both in theRegisterInstance
request, Cloud Map automatically createsA
and/orAAAA
records that have the same name as the value ofservice-hostname
in theSRV
record. You can ignore these records. -
If you're using a system that requires a specific
SRV
format, such as HAProxy, see the Name element in the documentation aboutCreateService
for information about how to specify the correct name format.
-
"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 Amazon Web Services resource that an alias record routes traffic to. If you include theAWS_ALIAS_DNS_NAME
attribute when you submit a RegisterInstance request, theTTL
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 and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health check. If you specify settings for a health check, 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
orHealthCheckConfig
but not both.For information about the charges for health checks, see 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
forType
, don't specify a value forResourcePath
.
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 that your endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint is healthy. An example file is
/docs/route53-health-check.html
. Route 53 automatically adds the DNS name for the service. If you don't specify a value forResourcePath
, the default value is/
.If you specify
TCP
forType
, you must not specify a value forResourcePath
.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 the other way around. 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
orHealthCheckConfig
but not both.You can't add, update, or delete a
HealthCheckCustomConfig
configuration from an existing service.FailureThreshold
— (Integer
)This parameter is no longer supported and is always set to 1. Cloud Map waits for approximately 30 seconds after receiving an
UpdateInstanceCustomHealthStatus
request before changing the status of the service instance.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.Sending a second or subsequent
UpdateInstanceCustomHealthStatus
request with the same value before 30 seconds has passed doesn't accelerate the change. Cloud Map still waits30
seconds after the first request to make the change.
Tags
— (Array<map>
)The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.
Key
— required — (String
)The key identifier, or name, of the tag.
Value
— required — (String
)The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.
Type
— (String
)If present, specifies that the service instances are only discoverable using the
Possible values include:DiscoverInstances
API operation. No DNS records is registered for the service instances. The only valid value isHTTP
."HTTP"
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. Thedata
object has the following properties:Service
— (map
)A complex type that contains information about the new service.
Id
— (String
)The ID that Cloud Map assigned to the service when you created it.
Arn
— (String
)The Amazon Resource Name (ARN) that 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 are deleted aren't included in the count. The count might not reflect pending registrations and deregistrations.
DnsConfig
— (map
)A complex type that contains information about the Route 53 DNS records that you want 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 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, specifyWEIGHTED
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 that the service includes configurations for one
A
record and a health check. 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 that the service includes configurations for one
A
record and a health check. 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.
"MULTIVALUE"
"WEIGHTED"
DnsRecords
— required — (Array<map>
)An array that contains one
DnsRecord
object for each Route 53 DNS record that you want 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. You can specify values for
Type
in the following combinations:-
A
-
AAAA
-
A
andAAAA
-
SRV
-
CNAME
If you want Cloud Map to create a Route 53 alias record when you register an instance, specify
A
orAAAA
forType
.You specify other settings, such as the IP address for
A
andAAAA
records, when you register an instance. For more information, see RegisterInstance.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 Attributes in the topic RegisterInstance.
-
You must specify
WEIGHTED
for the value ofRoutingPolicy
. -
You can't specify both
CNAME
forType
and settings forHealthCheckConfig
. If you do, the request will fail with anInvalidInput
error.
-
- SRV
-
Route 53 returns the value for an
SRV
record. The value for anSRV
record uses the following values:priority weight port service-hostname
Note the following about the values:
-
The values of
priority
andweight
are both set to1
and can't be changed. -
The value of
port
comes from the value that you specify for theAWS_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
istest
, the name of the service isbackend
, and the name of the namespace isexample.com
, the value ofservice-hostname
is the following:test.backend.example.com
-
If you specify settings for an
SRV
record, note the following:-
If you specify values for
AWS_INSTANCE_IPV4
,AWS_INSTANCE_IPV6
, or both in theRegisterInstance
request, Cloud Map automatically createsA
and/orAAAA
records that have the same name as the value ofservice-hostname
in theSRV
record. You can ignore these records. -
If you're using a system that requires a specific
SRV
format, such as HAProxy, see the Name element in the documentation aboutCreateService
for information about how to specify the correct name format.
-
"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 Amazon Web Services resource that an alias record routes traffic to. If you include theAWS_ALIAS_DNS_NAME
attribute when you submit a RegisterInstance request, theTTL
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.
Type
— (String
)Describes the systems that can be used to discover the service instances.
- DNS_HTTP
-
The service instances can be discovered using either DNS queries or the
DiscoverInstances
API operation. - HTTP
-
The service instances can only be discovered using the
DiscoverInstances
API operation. - DNS
-
Reserved.
"HTTP"
"DNS_HTTP"
"DNS"
HealthCheckConfig
— (map
)Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, 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
forType
, don't specify a value forResourcePath
.
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 that your endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint is healthy. An example file is
/docs/route53-health-check.html
. Route 53 automatically adds the DNS name for the service. If you don't specify a value forResourcePath
, the default value is/
.If you specify
TCP
forType
, you must not specify a value forResourcePath
.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 the other way around. 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
orHealthCheckConfig
but not both.FailureThreshold
— (Integer
)This parameter is no longer supported and is always set to 1. Cloud Map waits for approximately 30 seconds after receiving an
UpdateInstanceCustomHealthStatus
request before changing the status of the service instance.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.Sending a second or subsequent
UpdateInstanceCustomHealthStatus
request with the same value before 30 seconds has passed doesn't accelerate the change. Cloud Map still waits30
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 value1516925490.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 running the operation twice.
CreatorRequestId
can be any unique string (for example, a date/timestamp).
-
(AWS.Response)
—
Returns:
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:
Example: Delete namespace
/* Example: Delete namespace */ var params = { Id: "ns-ylexjili4cdxy3xm" }; servicediscovery.deleteNamespace(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { OperationId: "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k98y6drk" } */ });
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. Thedata
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.
-
(AWS.Response)
—
Returns:
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:
Example: Delete service
/* Example: Delete service */ var params = { Id: "srv-p5zdwlg5uvvzjita" }; servicediscovery.deleteService(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { } */ });
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.
-
(AWS.Response)
—
Returns:
deregisterInstance(params = {}, callback) ⇒ AWS.Request
Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified instance.
Service Reference:
Examples:
Example: Deregister a service instance
/* Example: Deregister a service instance */ var params = { InstanceId: "myservice-53", ServiceId: "srv-p5zdwlg5uvvzjita" }; servicediscovery.deregisterInstance(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { OperationId: "4yejorelbukcjzpnr6tlmrghsjwpngf4-k98rnaiq" } */ });
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. Thedata
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.
-
(AWS.Response)
—
Returns:
discoverInstances(params = {}, callback) ⇒ AWS.Request
Discovers registered instances for a specified namespace and service. You can use
DiscoverInstances
to discover instances for any type of namespace. For public and private DNS namespaces, you can also use DNS queries to discover instances.Service Reference:
Examples:
Example: Discover registered instances
/* Example: Discover registered instances */ var params = { HealthStatus: "ALL", MaxResults: 10, NamespaceName: "example.com", ServiceName: "myservice" }; servicediscovery.discoverInstances(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { Instances: [ { Attributes: { "AWS_INSTANCE_IPV4": "172.2.1.3", "AWS_INSTANCE_PORT": "808" }, HealthStatus: "UNKNOWN", InstanceId: "myservice-53", NamespaceName: "example.com", ServiceName: "myservice" } ] } */ });
Calling the discoverInstances operation
var params = { NamespaceName: 'STRING_VALUE', /* required */ ServiceName: 'STRING_VALUE', /* required */ HealthStatus: HEALTHY | UNHEALTHY | ALL | HEALTHY_OR_ELSE_ALL, MaxResults: 'NUMBER_VALUE', OptionalParameters: { '<AttrKey>': 'STRING_VALUE', /* '<AttrKey>': ... */ }, 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
HttpName
name of the namespace. It's found in theHttpProperties
member of theProperties
member of the namespace.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 forMaxResults
, Cloud Map returns up to 100 instances.QueryParameters
— (map<String>
)Filters to scope the results based on custom attributes for the instance (for example,
{version=v1, az=1a}
). Only instances that match all the specified key-value pairs are returned.OptionalParameters
— (map<String>
)Opportunistic filters to scope the results based on custom attributes. If there are instances that match both the filters specified in both the
QueryParameters
parameter and this parameter, all of these instances are returned. Otherwise, the filters are ignored, and only instances that match the filters that are specified in theQueryParameters
parameter are returned.HealthStatus
— (String
)The health status of the instances that you want to discover. This parameter is ignored for services that don't have a health check configured, and all instances are returned.
- HEALTHY
-
Returns healthy instances.
- UNHEALTHY
-
Returns unhealthy instances.
- ALL
-
Returns all instances.
- HEALTHY_OR_ELSE_ALL
-
Returns healthy instances, unless none are reporting a healthy state. In that case, return all instances. This is also called failing open.
"HEALTHY"
"UNHEALTHY"
"ALL"
"HEALTHY_OR_ELSE_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. Thedata
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
HttpName
name of the namespace. It's found in theHttpProperties
member of theProperties
member of the namespace.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.
-
(AWS.Response)
—
Returns:
getInstance(params = {}, callback) ⇒ AWS.Request
Gets information about a specified instance.
Service Reference:
Examples:
GetInstance example
/* This example gets information about a specified instance. */ var params = { InstanceId: "i-abcd1234", ServiceId: "srv-e4anhexample0004" }; servicediscovery.getInstance(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { Instance: { Attributes: { "AWS_INSTANCE_IPV4": "192.0.2.44", "AWS_INSTANCE_PORT": "80", "color": "green", "region": "us-west-2", "stage": "beta" }, Id: "i-abcd1234" } } */ });
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. Thedata
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's specified by
ServiceId
includes settings for anSRV
record, the value ofInstanceId
is automatically included as part of the value for theSRV
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's unique among instances that you register by using the same service.
-
If you specify an existing
InstanceId
andServiceId
, Cloud Map updates the existing DNS records. If there's also an existing health check, 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 aListHealthChecks
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 uniqueCreatorRequestId
string every time you submit aRegisterInstance
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 Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that's associated with the load balancer. For information about how to get the DNS name, see AliasTarget->DNSName in the Route 53 API Reference.
Note the following:
-
The configuration for the service that's specified by
ServiceId
must include settings for anA
record, anAAAA
record, or both. -
In the service that's specified by
ServiceId
, the value ofRoutingPolicy
must beWEIGHTED
. -
If the service that's specified by
ServiceId
includesHealthCheckConfig
settings, Cloud Map creates 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 Amazon Web Services resources other than ELB load balancers.
-
If you specify a value for
AWS_ALIAS_DNS_NAME
, don't specify values for any of theAWS_INSTANCE
attributes.
-
- AWS_EC2_INSTANCE_ID
-
HTTP namespaces only. The Amazon EC2 instance ID for the instance. The
AWS_INSTANCE_IPV4
attribute contains the primary private IPv4 address. - AWS_INIT_HEALTH_STATUS
-
If the service configuration includes
HealthCheckCustomConfig
, you can optionally useAWS_INIT_HEALTH_STATUS
to specify the initial status of the custom health check,HEALTHY
orUNHEALTHY
. If you don't specify a value forAWS_INIT_HEALTH_STATUS
, the initial status isHEALTHY
. - 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 anCNAME
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 anA
record. If the service includes settings for anSRV
record, you must specify a value forAWS_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 anAAAA
record. If the service includes settings for anSRV
record, you must specify a value forAWS_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 or a Route 53 health check when you created the service.
-
-
(AWS.Response)
—
Returns:
getInstancesHealthStatus(params = {}, callback) ⇒ AWS.Request
Gets the current health status (
Healthy
,Unhealthy
, orUnknown
) of one or more instances that are associated with a specified service.Note: There's a brief delay between when you register an instance and when the health status for the instance is available.Service Reference:
Examples:
GetInstancesHealthStatus example
/* This example gets the current health status of one or more instances that are associate with a specified service. */ var params = { ServiceId: "srv-e4anhexample0004" }; servicediscovery.getInstancesHealthStatus(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { Status: { "i-abcd1234": "HEALTHY", "i-abcd1235": "UNHEALTHY" } } */ });
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
, 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 Cloud Map to return in the response to a
GetInstancesHealthStatus
request. If you don't specify a value forMaxResults
, 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 anotherGetInstancesHealthStatus
request to get the next group of results. Specify the value ofNextToken
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. Thedata
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 anotherGetInstancesHealthStatus
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.
-
(AWS.Response)
—
Returns:
getNamespace(params = {}, callback) ⇒ AWS.Request
Gets information about a namespace.
Service Reference:
Examples:
GetNamespace example
/* This example gets information about a specified namespace. */ var params = { Id: "ns-e4anhexample0004" }; servicediscovery.getNamespace(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { Namespace: { Arn: "arn:aws:servicediscovery:us-west-2: 123456789120:namespace/ns-e1tpmexample0001", CreateDate: <Date Representation>, CreatorRequestId: "example-creator-request-id-0001", Description: "Example.com AWS Cloud Map HTTP Namespace", Id: "ns-e1tpmexample0001", Name: "example-http.com", Properties: { DnsProperties: { }, HttpProperties: { HttpName: "example-http.com" } }, Type: "HTTP" } } */ });
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. Thedata
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 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. The methods for discovering instances depends on the value that you specify:
- HTTP
-
Instances can be discovered only programmatically, using the Cloud Map
DiscoverInstances
API. - DNS_PUBLIC
-
Instances can be discovered using public DNS queries and using the
DiscoverInstances
API. - DNS_PRIVATE
-
Instances can be discovered using DNS queries in VPCs and using the
DiscoverInstances
API.
"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 Cloud Map creates when you create a namespace.
HostedZoneId
— (String
)The ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.
SOA
— (map
)Start of Authority (SOA) record for the hosted zone.
TTL
— required — (Integer
)The time to live (TTL) for purposes of negative caching.
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 value1516925490.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 running an operation twice.
-
(AWS.Response)
—
Returns:
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:
Example: Get operation result
/* Example: Get operation result */ var params = { OperationId: "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd" }; servicediscovery.getOperation(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { Operation: { CreateDate: <Date Representation>, Id: "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd", Status: "SUCCESS", Targets: { "NAMESPACE": "ns-ylexjili4cdxy3xm" }, Type: "CREATE_NAMESPACE", UpdateDate: <Date Representation> } } */ });
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. Thedata
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's associated with the specified ID.
Possible values include:"CREATE_NAMESPACE"
"DELETE_NAMESPACE"
"UPDATE_NAMESPACE"
"UPDATE_SERVICE"
"REGISTER_INSTANCE"
"DEREGISTER_INSTANCE"
Status
— (String
)The status of the operation. Values include the following:
- SUBMITTED
-
This is the initial state that occurs immediately after you submit a request.
- PENDING
-
Cloud Map is performing the operation.
- SUCCESS
-
The operation succeeded.
- FAIL
-
The operation failed. For the failure reason, see
ErrorMessage
.
"SUBMITTED"
"PENDING"
"SUCCESS"
"FAIL"
ErrorMessage
— (String
)If the value of
Status
isFAIL
, the reason that the operation failed.ErrorCode
— (String
)The code associated with
ErrorMessage
. Values forErrorCode
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 value1516925490.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 ofUpdateDate
is accurate to milliseconds. For example, the value1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.Targets
— (map<String>
)The name of the target entity that's 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.
-
(AWS.Response)
—
Returns:
getService(params = {}, callback) ⇒ AWS.Request
Gets the settings for a specified service.
Service Reference:
Examples:
GetService Example
/* This example gets the settings for a specified service. */ var params = { Id: "srv-e4anhexample0004" }; servicediscovery.getService(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { Service: { Arn: "arn:aws:servicediscovery:us-west-2:123456789120:service/srv-e4anhexample0004", CreateDate: <Date Representation>, CreatorRequestId: "example-creator-request-id-0004", Description: "Example.com AWS Cloud Map HTTP Service", HealthCheckConfig: { FailureThreshold: 3, ResourcePath: "/", Type: "HTTPS" }, Id: "srv-e4anhexample0004", Name: "example-http-service", NamespaceId: "ns-e4anhexample0004" } } */ });
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. Thedata
object has the following properties:Service
— (map
)A complex type that contains information about the service.
Id
— (String
)The ID that Cloud Map assigned to the service when you created it.
Arn
— (String
)The Amazon Resource Name (ARN) that 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 are deleted aren't included in the count. The count might not reflect pending registrations and deregistrations.
DnsConfig
— (map
)A complex type that contains information about the Route 53 DNS records that you want 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 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, specifyWEIGHTED
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 that the service includes configurations for one
A
record and a health check. 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 that the service includes configurations for one
A
record and a health check. 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.
"MULTIVALUE"
"WEIGHTED"
DnsRecords
— required — (Array<map>
)An array that contains one
DnsRecord
object for each Route 53 DNS record that you want 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. You can specify values for
Type
in the following combinations:-
A
-
AAAA
-
A
andAAAA
-
SRV
-
CNAME
If you want Cloud Map to create a Route 53 alias record when you register an instance, specify
A
orAAAA
forType
.You specify other settings, such as the IP address for
A
andAAAA
records, when you register an instance. For more information, see RegisterInstance.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 Attributes in the topic RegisterInstance.
-
You must specify
WEIGHTED
for the value ofRoutingPolicy
. -
You can't specify both
CNAME
forType
and settings forHealthCheckConfig
. If you do, the request will fail with anInvalidInput
error.
-
- SRV
-
Route 53 returns the value for an
SRV
record. The value for anSRV
record uses the following values:priority weight port service-hostname
Note the following about the values:
-
The values of
priority
andweight
are both set to1
and can't be changed. -
The value of
port
comes from the value that you specify for theAWS_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
istest
, the name of the service isbackend
, and the name of the namespace isexample.com
, the value ofservice-hostname
is the following:test.backend.example.com
-
If you specify settings for an
SRV
record, note the following:-
If you specify values for
AWS_INSTANCE_IPV4
,AWS_INSTANCE_IPV6
, or both in theRegisterInstance
request, Cloud Map automatically createsA
and/orAAAA
records that have the same name as the value ofservice-hostname
in theSRV
record. You can ignore these records. -
If you're using a system that requires a specific
SRV
format, such as HAProxy, see the Name element in the documentation aboutCreateService
for information about how to specify the correct name format.
-
"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 Amazon Web Services resource that an alias record routes traffic to. If you include theAWS_ALIAS_DNS_NAME
attribute when you submit a RegisterInstance request, theTTL
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.
Type
— (String
)Describes the systems that can be used to discover the service instances.
- DNS_HTTP
-
The service instances can be discovered using either DNS queries or the
DiscoverInstances
API operation. - HTTP
-
The service instances can only be discovered using the
DiscoverInstances
API operation. - DNS
-
Reserved.
"HTTP"
"DNS_HTTP"
"DNS"
HealthCheckConfig
— (map
)Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, 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
forType
, don't specify a value forResourcePath
.
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 that your endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint is healthy. An example file is
/docs/route53-health-check.html
. Route 53 automatically adds the DNS name for the service. If you don't specify a value forResourcePath
, the default value is/
.If you specify
TCP
forType
, you must not specify a value forResourcePath
.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 the other way around. 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
orHealthCheckConfig
but not both.FailureThreshold
— (Integer
)This parameter is no longer supported and is always set to 1. Cloud Map waits for approximately 30 seconds after receiving an
UpdateInstanceCustomHealthStatus
request before changing the status of the service instance.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.Sending a second or subsequent
UpdateInstanceCustomHealthStatus
request with the same value before 30 seconds has passed doesn't accelerate the change. Cloud Map still waits30
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 value1516925490.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 running the operation twice.
CreatorRequestId
can be any unique string (for example, a date/timestamp).
-
(AWS.Response)
—
Returns:
listInstances(params = {}, callback) ⇒ AWS.Request
Lists summary information about the instances that you registered by using a specified service.
Service Reference:
Examples:
Example: List service instances
/* Example: List service instances */ var params = { ServiceId: "srv-qzpwvt2tfqcegapy" }; servicediscovery.listInstances(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { Instances: [ { Attributes: { "AWS_INSTANCE_IPV4": "172.2.1.3", "AWS_INSTANCE_PORT": "808" }, Id: "i-06bdabbae60f65a4e" } ] } */ });
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 anotherListInstances
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.MaxResults
— (Integer
)The maximum number of instances that you want Cloud Map to return in the response to a
ListInstances
request. If you don't specify a value forMaxResults
, 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. Thedata
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 associated 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's associated with the load balancer.
- AWS_EC2_INSTANCE_ID (HTTP namespaces only)
-
The Amazon EC2 instance ID for the instance. When the
AWS_EC2_INSTANCE_ID
attribute is specified, then theAWS_INSTANCE_IPV4
attribute contains the primary private IPv4 address. - AWS_INIT_HEALTH_STATUS
-
If the service configuration includes
HealthCheckCustomConfig
, you can optionally useAWS_INIT_HEALTH_STATUS
to specify the initial status of the custom health check,HEALTHY
orUNHEALTHY
. If you don't specify a value forAWS_INIT_HEALTH_STATUS
, the initial status isHEALTHY
. - 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 includesHealthCheckConfig
, 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 anotherListInstances
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.
-
(AWS.Response)
—
Returns:
listNamespaces(params = {}, callback) ⇒ AWS.Request
Lists summary information about the namespaces that were created by the current account.
Service Reference:
Examples:
Example: List namespaces
/* Example: List namespaces */ var params = { }; servicediscovery.listNamespaces(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { Namespaces: [ { Arn: "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-a3ccy2e7e3a7rile", CreateDate: <Date Representation>, Id: "ns-a3ccy2e7e3a7rile", Name: "local", Properties: { DnsProperties: { HostedZoneId: "Z06752353VBUDTC32S84S" }, HttpProperties: { HttpName: "local" } }, Type: "DNS_PRIVATE" }, { Arn: "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-pocfyjtrsmwtvcxx", CreateDate: <Date Representation>, Description: "My second namespace", Id: "ns-pocfyjtrsmwtvcxx", Name: "My-second-namespace", Properties: { DnsProperties: { }, HttpProperties: { HttpName: "My-second-namespace" } }, Type: "HTTP" }, { Arn: "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-ylexjili4cdxy3xm", CreateDate: <Date Representation>, Id: "ns-ylexjili4cdxy3xm", Name: "example.com", Properties: { DnsProperties: { HostedZoneId: "Z09983722P0QME1B3KC8I" }, HttpProperties: { HttpName: "example.com" } }, Type: "DNS_PRIVATE" } ] } */ });
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 anotherListNamespaces
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.Note: Cloud Map getsMaxResults
namespaces and then filters them based on the specified criteria. It's possible that no namespaces in the firstMaxResults
namespaces matched the specified criteria but that subsequent groups ofMaxResults
namespaces do contain namespaces that match the criteria.MaxResults
— (Integer
)The maximum number of namespaces that you want Cloud Map to return in the response to a
ListNamespaces
request. If you don't specify a value forMaxResults
, 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
Possible values include:TYPE
."TYPE"
Values
— required — (Array<String>
)If you specify
EQ
forCondition
, specify eitherDNS_PUBLIC
orDNS_PRIVATE
.If you specify
IN
forCondition
, you can specifyDNS_PUBLIC
,DNS_PRIVATE
, or both.Condition
— (String
)The operator that you want to use to determine whether
ListNamespaces
returns a namespace. Valid values forcondition
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
"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. Thedata
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 Cloud Map assigns to the namespace when you create it.
Name
— (String
)The name of the namespace. When you create a namespace, 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
)The properties of the namespace.
DnsProperties
— (map
)A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.
HostedZoneId
— (String
)The ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.
SOA
— (map
)Start of Authority (SOA) record for the hosted zone.
TTL
— required — (Integer
)The time to live (TTL) for purposes of negative caching.
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 anotherListNamespaces
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.Note: Cloud Map getsMaxResults
namespaces and then filters them based on the specified criteria. It's possible that no namespaces in the firstMaxResults
namespaces matched the specified criteria but that subsequent groups ofMaxResults
namespaces do contain namespaces that match the criteria.
-
(AWS.Response)
—
Returns:
listOperations(params = {}, callback) ⇒ AWS.Request
Lists operations that match the criteria that you specify.
Service Reference:
Examples:
ListOperations Example
/* This example gets the operations that have a STATUS of either PENDING or SUCCESS. */ var params = { Filters: [ { Condition: "IN", Name: "STATUS", Values: [ "PENDING", "SUCCESS" ] } ] }; servicediscovery.listOperations(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { Operations: [ { Id: "76yy8ovhpdz0plmjzbsnqgnrqvpv2qdt-kexample", Status: "SUCCESS" }, { Id: "prysnyzpji3u2ciy45nke83x2zanl7yk-dexample", Status: "SUCCESS" }, { Id: "ko4ekftir7kzlbechsh7xvcdgcpk66gh-7example", Status: "PENDING" } ] } */ });
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 anotherListOperations
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.Note: Cloud Map getsMaxResults
operations and then filters them based on the specified criteria. It's possible that no operations in the firstMaxResults
operations matched the specified criteria but that subsequent groups ofMaxResults
operations do contain operations that match the criteria.MaxResults
— (Integer
)The maximum number of items that you want Cloud Map to return in the response to a
ListOperations
request. If you don't specify a value forMaxResults
, 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
, orFAIL
. -
TYPE: Gets specified types of operation.
-
UPDATE_DATE: Gets operations that changed status during a specified date/time range.
"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
, orFAIL
. -
TYPE: Specify one or more of the following types:
CREATE_NAMESPACE
,DELETE_NAMESPACE
,UPDATE_SERVICE
,REGISTER_INSTANCE
, orDEREGISTER_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 specifyEQ
for the condition, you can specify only one value.EQ
is supported forNAMESPACE_ID
,SERVICE_ID
,STATUS
, andTYPE
.EQ
is the default condition and can be omitted. -
IN
: When you specifyIN
for the condition, you can specify a list of one or more values.IN
is supported forSTATUS
andTYPE
. 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 forUPDATE_DATE
.
"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. Thedata
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: Cloud Map is performing the operation.
-
SUCCESS: The operation succeeded.
-
FAIL: The operation failed. For the failure reason, see
ErrorMessage
.
"SUBMITTED"
"PENDING"
"SUCCESS"
"FAIL"
-
NextToken
— (String
)If the response contains
NextToken
, submit anotherListOperations
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.Note: Cloud Map getsMaxResults
operations and then filters them based on the specified criteria. It's possible that no operations in the firstMaxResults
operations matched the specified criteria but that subsequent groups ofMaxResults
operations do contain operations that match the criteria.
-
(AWS.Response)
—
Returns:
listServices(params = {}, callback) ⇒ AWS.Request
Lists summary information for all the services that are associated with one or more specified namespaces.
Service Reference:
Examples:
Example: List services
/* Example: List services */ var params = { }; servicediscovery.listServices(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { Services: [ { Arn: "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita", CreateDate: <Date Representation>, DnsConfig: { DnsRecords: [ { TTL: 60, Type: "A" } ], RoutingPolicy: "MULTIVALUE" }, Id: "srv-p5zdwlg5uvvzjita", Name: "myservice" } ] } */ });
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 anotherListServices
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.Note: Cloud Map getsMaxResults
services and then filters them based on the specified criteria. It's possible that no services in the firstMaxResults
services matched the specified criteria but that subsequent groups ofMaxResults
services do contain services that match the criteria.MaxResults
— (Integer
)The maximum number of services that you want Cloud Map to return in the response to a
ListServices
request. If you don't specify a value forMaxResults
, 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
Possible values include:NAMESPACE_ID
."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 forCondition
include the following:-
EQ
: When you specifyEQ
, specify one namespace ID forValues
.EQ
is the default condition and can be omitted. -
IN
: When you specifyIN
, specify a list of the IDs for the namespaces that you wantListServices
to return a list of services for. -
BETWEEN
: Not applicable.
"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. Thedata
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 Cloud Map assigned to the service when you created it.
Arn
— (String
)The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.
Name
— (String
)The name of the service.
Type
— (String
)Describes the systems that can be used to discover the service instances.
- DNS_HTTP
-
The service instances can be discovered using either DNS queries or the
DiscoverInstances
API operation. - HTTP
-
The service instances can only be discovered using the
DiscoverInstances
API operation. - DNS
-
Reserved.
"HTTP"
"DNS_HTTP"
"DNS"
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 are deleted aren't included in the count. The count might not reflect pending registrations and deregistrations.
DnsConfig
— (map
)Information about the Route 53 DNS records that you want 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 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, specifyWEIGHTED
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 that the service includes configurations for one
A
record and a health check. 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 that the service includes configurations for one
A
record and a health check. 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.
"MULTIVALUE"
"WEIGHTED"
DnsRecords
— required — (Array<map>
)An array that contains one
DnsRecord
object for each Route 53 DNS record that you want 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. You can specify values for
Type
in the following combinations:-
A
-
AAAA
-
A
andAAAA
-
SRV
-
CNAME
If you want Cloud Map to create a Route 53 alias record when you register an instance, specify
A
orAAAA
forType
.You specify other settings, such as the IP address for
A
andAAAA
records, when you register an instance. For more information, see RegisterInstance.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 Attributes in the topic RegisterInstance.
-
You must specify
WEIGHTED
for the value ofRoutingPolicy
. -
You can't specify both
CNAME
forType
and settings forHealthCheckConfig
. If you do, the request will fail with anInvalidInput
error.
-
- SRV
-
Route 53 returns the value for an
SRV
record. The value for anSRV
record uses the following values:priority weight port service-hostname
Note the following about the values:
-
The values of
priority
andweight
are both set to1
and can't be changed. -
The value of
port
comes from the value that you specify for theAWS_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
istest
, the name of the service isbackend
, and the name of the namespace isexample.com
, the value ofservice-hostname
is the following:test.backend.example.com
-
If you specify settings for an
SRV
record, note the following:-
If you specify values for
AWS_INSTANCE_IPV4
,AWS_INSTANCE_IPV6
, or both in theRegisterInstance
request, Cloud Map automatically createsA
and/orAAAA
records that have the same name as the value ofservice-hostname
in theSRV
record. You can ignore these records. -
If you're using a system that requires a specific
SRV
format, such as HAProxy, see the Name element in the documentation aboutCreateService
for information about how to specify the correct name format.
-
"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 Amazon Web Services resource that an alias record routes traffic to. If you include theAWS_ALIAS_DNS_NAME
attribute when you submit a RegisterInstance request, theTTL
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 and HTTP namespaces only. Settings for an optional health check. If you specify settings for a health check, Cloud Map associates the health check with the records that you specify in
DnsConfig
.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
forType
, don't specify a value forResourcePath
.
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 that your endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint is healthy. An example file is
/docs/route53-health-check.html
. Route 53 automatically adds the DNS name for the service. If you don't specify a value forResourcePath
, the default value is/
.If you specify
TCP
forType
, you must not specify a value forResourcePath
.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 the other way around. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
HealthCheckCustomConfig
— (map
)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's 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 located.
If you specify a health check configuration, you can specify either
HealthCheckCustomConfig
orHealthCheckConfig
but not both.FailureThreshold
— (Integer
)This parameter is no longer supported and is always set to 1. Cloud Map waits for approximately 30 seconds after receiving an
UpdateInstanceCustomHealthStatus
request before changing the status of the service instance.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.Sending a second or subsequent
UpdateInstanceCustomHealthStatus
request with the same value before 30 seconds has passed doesn't accelerate the change. Cloud Map still waits30
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 anotherListServices
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.Note: Cloud Map getsMaxResults
services and then filters them based on the specified criteria. It's possible that no services in the firstMaxResults
services matched the specified criteria but that subsequent groups ofMaxResults
services do contain services that match the criteria.
-
(AWS.Response)
—
Returns:
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists tags for the specified resource.
Service Reference:
Examples:
ListTagsForResource example
/* This example lists the tags of a resource. */ var params = { ResourceARN: "arn:aws:servicediscovery:us-east-1:123456789012:namespace/ns-ylexjili4cdxy3xm" }; servicediscovery.listTagsForResource(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { Tags: [ { Key: "Project", Value: "Zeta" }, { Key: "Department", Value: "Engineering" } ] } */ });
Calling the listTagsForResource operation
var params = { ResourceARN: 'STRING_VALUE' /* required */ }; servicediscovery.listTagsForResource(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
ResourceARN
— (String
)The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Tags
— (Array<map>
)The tags that are assigned to the resource.
Key
— required — (String
)The key identifier, or name, of the tag.
Value
— required — (String
)The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.
-
(AWS.Response)
—
Returns:
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's specified by
ServiceId
, a record is created or updated in the hosted zone that's 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 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 quota on the number of instances that you can register using the same namespace and using the same service, see Cloud Map quotas in the Cloud Map Developer Guide.
Service Reference:
Examples:
Example: Register Instance
/* Example: Register Instance */ var params = { Attributes: { "AWS_INSTANCE_IPV4": "172.2.1.3", "AWS_INSTANCE_PORT": "808" }, CreatorRequestId: "7a48a98a-72e6-4849-bfa7-1a458e030d7b", InstanceId: "myservice-53", ServiceId: "srv-p5zdwlg5uvvzjita" }; servicediscovery.registerInstance(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { OperationId: "4yejorelbukcjzpnr6tlmrghsjwpngf4-k95yg2u7" } */ });
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's specified by
ServiceId
includes settings for anSRV
record, the value ofInstanceId
is automatically included as part of the value for theSRV
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's unique among instances that you register by using the same service.
-
If you specify an existing
InstanceId
andServiceId
, Cloud Map updates the existing DNS records, if any. If there's also an existing health check, 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 aListHealthChecks
request, for example.
-
CreatorRequestId
— (String
)A unique string that identifies the request and that allows failed
If a token is not provided, the SDK will use a version 4 UUID.RegisterInstance
requests to be retried without the risk of executing the operation twice. You must use a uniqueCreatorRequestId
string every time you submit aRegisterInstance
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 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's 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's specified by
ServiceId
must include settings for anA
record, anAAAA
record, or both. -
In the service that's specified by
ServiceId
, the value ofRoutingPolicy
must beWEIGHTED
. -
If the service that's specified by
ServiceId
includesHealthCheckConfig
settings, Cloud Map will create the Route 53 health check, but it doesn't associate the health check with the alias record. -
Auto naming currently doesn't support creating alias records that route traffic to Amazon Web Services resources other than Elastic Load Balancing load balancers.
-
If you specify a value for
AWS_ALIAS_DNS_NAME
, don't specify values for any of theAWS_INSTANCE
attributes.
-
- AWS_EC2_INSTANCE_ID
-
HTTP namespaces only. The Amazon EC2 instance ID for the instance. If the
AWS_EC2_INSTANCE_ID
attribute is specified, then the only other attribute that can be specified isAWS_INIT_HEALTH_STATUS
. When theAWS_EC2_INSTANCE_ID
attribute is specified, then theAWS_INSTANCE_IPV4
attribute will be filled out with the primary private IPv4 address. - AWS_INIT_HEALTH_STATUS
-
If the service configuration includes
HealthCheckCustomConfig
, you can optionally useAWS_INIT_HEALTH_STATUS
to specify the initial status of the custom health check,HEALTHY
orUNHEALTHY
. If you don't specify a value forAWS_INIT_HEALTH_STATUS
, the initial status isHEALTHY
. - 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 anCNAME
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 anA
record. If the service includes settings for anSRV
record, you must specify a value forAWS_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 anAAAA
record. If the service includes settings for anSRV
record, you must specify a value forAWS_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 or a Route 53 health check 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. The total size of all provided attributes (sum of all keys and values) must not exceed 5,000 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. Thedata
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.
-
(AWS.Response)
—
Returns:
tagResource(params = {}, callback) ⇒ AWS.Request
Adds one or more tags to the specified resource.
Service Reference:
Examples:
TagResource example
/* This example adds "Department" and "Project" tags to a resource. */ var params = { ResourceARN: "arn:aws:servicediscovery:us-east-1:123456789012:namespace/ns-ylexjili4cdxy3xm", Tags: [ { Key: "Department", Value: "Engineering" }, { Key: "Project", Value: "Zeta" } ] }; servicediscovery.tagResource(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { } */ });
Calling the tagResource operation
var params = { ResourceARN: 'STRING_VALUE', /* required */ Tags: [ /* required */ { Key: 'STRING_VALUE', /* required */ Value: 'STRING_VALUE' /* required */ }, /* more items */ ] }; servicediscovery.tagResource(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
ResourceARN
— (String
)The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.
Tags
— (Array<map>
)The tags to add to the specified resource. Specifying the tag key is required. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.
Key
— required — (String
)The key identifier, or name, of the tag.
Value
— required — (String
)The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.
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.
-
(AWS.Response)
—
Returns:
untagResource(params = {}, callback) ⇒ AWS.Request
Removes one or more tags from the specified resource.
Service Reference:
Examples:
UntagResource example
/* This example removes the "Department" and "Project" tags from a resource. */ var params = { ResourceARN: "arn:aws:servicediscovery:us-east-1:123456789012:namespace/ns-ylexjili4cdxy3xm", TagKeys: [ "Project", "Department" ] }; servicediscovery.untagResource(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { } */ });
Calling the untagResource operation
var params = { ResourceARN: 'STRING_VALUE', /* required */ TagKeys: [ /* required */ 'STRING_VALUE', /* more items */ ] }; servicediscovery.untagResource(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
Parameters:
-
params
(Object)
(defaults to: {})
—
ResourceARN
— (String
)The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.
TagKeys
— (Array<String>
)The tag keys to remove from the specified resource.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateHttpNamespace(params = {}, callback) ⇒ AWS.Request
Updates an HTTP namespace.
Service Reference:
Examples:
Calling the updateHttpNamespace operation
var params = { Id: 'STRING_VALUE', /* required */ Namespace: { /* required */ Description: 'STRING_VALUE' /* required */ }, UpdaterRequestId: 'STRING_VALUE' }; servicediscovery.updateHttpNamespace(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 update.
UpdaterRequestId
— (String
)A unique string that identifies the request and that allows failed
If a token is not provided, the SDK will use a version 4 UUID.UpdateHttpNamespace
requests to be retried without the risk of running the operation twice.UpdaterRequestId
can be any unique string (for example, a date/timestamp).Namespace
— (map
)Updated properties for the the HTTP namespace.
Description
— required — (String
)An updated description for the HTTP 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. Thedata
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.
-
(AWS.Response)
—
Returns:
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 usingHealthCheckCustomConfig
when you create a service. You can't use it to change the status for Route 53 health checks, which you define usingHealthCheckConfig
.For more information, see HealthCheckCustomConfig.
Service Reference:
Examples:
UpdateInstanceCustomHealthStatus Example
/* This example submits a request to change the health status of an instance associated with a service with a custom health check to HEALTHY. */ var params = { InstanceId: "i-abcd1234", ServiceId: "srv-e4anhexample0004", Status: "HEALTHY" }; servicediscovery.updateInstanceCustomHealthStatus(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response });
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,
Possible values include:HEALTHY
orUNHEALTHY
."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.
-
(AWS.Response)
—
Returns:
updatePrivateDnsNamespace(params = {}, callback) ⇒ AWS.Request
Updates a private DNS namespace.
Service Reference:
Examples:
Calling the updatePrivateDnsNamespace operation
var params = { Id: 'STRING_VALUE', /* required */ Namespace: { /* required */ Description: 'STRING_VALUE', Properties: { DnsProperties: { /* required */ SOA: { /* required */ TTL: 'NUMBER_VALUE' /* required */ } } } }, UpdaterRequestId: 'STRING_VALUE' }; servicediscovery.updatePrivateDnsNamespace(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 update.
UpdaterRequestId
— (String
)A unique string that identifies the request and that allows failed
If a token is not provided, the SDK will use a version 4 UUID.UpdatePrivateDnsNamespace
requests to be retried without the risk of running the operation twice.UpdaterRequestId
can be any unique string (for example, a date/timestamp).Namespace
— (map
)Updated properties for the private DNS namespace.
Description
— (String
)An updated description for the private DNS namespace.
Properties
— (map
)Properties to be updated in the private DNS namespace.
DnsProperties
— required — (map
)Updated DNS properties for the private DNS namespace.
SOA
— required — (map
)Updated fields for the Start of Authority (SOA) record for the hosted zone for the private DNS namespace.
TTL
— required — (Integer
)The updated time to live (TTL) for purposes of negative caching.
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. Thedata
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.
-
(AWS.Response)
—
Returns:
updatePublicDnsNamespace(params = {}, callback) ⇒ AWS.Request
Updates a public DNS namespace.
Service Reference:
Examples:
Calling the updatePublicDnsNamespace operation
var params = { Id: 'STRING_VALUE', /* required */ Namespace: { /* required */ Description: 'STRING_VALUE', Properties: { DnsProperties: { /* required */ SOA: { /* required */ TTL: 'NUMBER_VALUE' /* required */ } } } }, UpdaterRequestId: 'STRING_VALUE' }; servicediscovery.updatePublicDnsNamespace(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 being updated.
UpdaterRequestId
— (String
)A unique string that identifies the request and that allows failed
If a token is not provided, the SDK will use a version 4 UUID.UpdatePublicDnsNamespace
requests to be retried without the risk of running the operation twice.UpdaterRequestId
can be any unique string (for example, a date/timestamp).Namespace
— (map
)Updated properties for the public DNS namespace.
Description
— (String
)An updated description for the public DNS namespace.
Properties
— (map
)Properties to be updated in the public DNS namespace.
DnsProperties
— required — (map
)Updated DNS properties for the hosted zone for the public DNS namespace.
SOA
— required — (map
)Updated fields for the Start of Authority (SOA) record for the hosted zone for the public DNS namespace.
TTL
— required — (Integer
)The updated time to live (TTL) for purposes of negative caching.
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. Thedata
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.
-
(AWS.Response)
—
Returns:
updateService(params = {}, callback) ⇒ AWS.Request
Submits a request to perform the following operations:
-
Update the TTL setting for existing
DnsRecords
configurations -
Add, update, or delete
HealthCheckConfig
for a specified serviceNote: You can't add, update, or delete aHealthCheckCustomConfig
configuration.
For public and private DNS namespaces, note the following:
-
If you omit any existing
DnsRecords
orHealthCheckConfig
configurations from anUpdateService
request, the configurations are deleted from the service. -
If you omit an existing
HealthCheckCustomConfig
configuration from anUpdateService
request, the configuration isn't deleted from the service.
When you update settings for a service, 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:
UpdateService Example
/* This example submits a request to replace the DnsConfig and HealthCheckConfig settings of a specified service. */ var params = { Id: "srv-e4anhexample0004", Service: { DnsConfig: { DnsRecords: [ { TTL: 60, Type: "A" } ] }, HealthCheckConfig: { FailureThreshold: 2, ResourcePath: "/", Type: "HTTP" } } }; servicediscovery.updateService(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response /* data = { OperationId: "m35hsdrkxwjffm3xef4bxyy6vc3ewakx-jdn3y5g5" } */ });
Calling the updateService operation
var params = { Id: 'STRING_VALUE', /* required */ Service: { /* required */ Description: 'STRING_VALUE', DnsConfig: { DnsRecords: [ /* required */ { TTL: 'NUMBER_VALUE', /* required */ Type: SRV | A | AAAA | CNAME /* required */ }, /* more items */ ] }, 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
— (map
)Information about the Route 53 DNS records that you want 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 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. You can specify values for
Type
in the following combinations:-
A
-
AAAA
-
A
andAAAA
-
SRV
-
CNAME
If you want Cloud Map to create a Route 53 alias record when you register an instance, specify
A
orAAAA
forType
.You specify other settings, such as the IP address for
A
andAAAA
records, when you register an instance. For more information, see RegisterInstance.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 Attributes in the topic RegisterInstance.
-
You must specify
WEIGHTED
for the value ofRoutingPolicy
. -
You can't specify both
CNAME
forType
and settings forHealthCheckConfig
. If you do, the request will fail with anInvalidInput
error.
-
- SRV
-
Route 53 returns the value for an
SRV
record. The value for anSRV
record uses the following values:priority weight port service-hostname
Note the following about the values:
-
The values of
priority
andweight
are both set to1
and can't be changed. -
The value of
port
comes from the value that you specify for theAWS_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
istest
, the name of the service isbackend
, and the name of the namespace isexample.com
, the value ofservice-hostname
is the following:test.backend.example.com
-
If you specify settings for an
SRV
record, note the following:-
If you specify values for
AWS_INSTANCE_IPV4
,AWS_INSTANCE_IPV6
, or both in theRegisterInstance
request, Cloud Map automatically createsA
and/orAAAA
records that have the same name as the value ofservice-hostname
in theSRV
record. You can ignore these records. -
If you're using a system that requires a specific
SRV
format, such as HAProxy, see the Name element in the documentation aboutCreateService
for information about how to specify the correct name format.
-
"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 Amazon Web Services resource that an alias record routes traffic to. If you include theAWS_ALIAS_DNS_NAME
attribute when you submit a RegisterInstance request, theTTL
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 and HTTP namespaces only. Settings for an optional health check. If you specify settings for a health check, Cloud Map associates the health check with the records that you specify in
DnsConfig
.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
forType
, don't specify a value forResourcePath
.
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 that your endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint is healthy. An example file is
/docs/route53-health-check.html
. Route 53 automatically adds the DNS name for the service. If you don't specify a value forResourcePath
, the default value is/
.If you specify
TCP
forType
, you must not specify a value forResourcePath
.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 the other way around. 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. Thedata
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.
-
(AWS.Response)
—
Returns:
Generated on Wed Nov 10 23:39:05 2021 by yard 0.9.26 (ruby-2.3.8). - getNamespace(params = {}, callback) ⇒ AWS.Request