Table of Contents
A low-level client representing AWS Cloud Map (ServiceDiscovery)
AWS Cloud Map lets you configure public DNS, private DNS, or HTTP namespaces that your microservice applications run in. When an instance of the service becomes available, you can call the AWS Cloud Map API to register the instance with AWS Cloud Map. For public or private DNS namespaces, AWS Cloud Map automatically creates DNS records and an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service receive an answer that contains up to eight healthy records.
import boto3
client = boto3.client('servicediscovery')
These are the available methods:
Check if an operation can be paginated.
Creates an HTTP namespace. Service instances that you register using an HTTP namespace can be discovered using a DiscoverInstances request but can't be discovered using DNS.
For the current quota on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map quotas in the AWS Cloud Map Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_http_namespace(
Name='string',
CreatorRequestId='string',
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name that you want to assign to this namespace.
A unique string that identifies the request and that allows failed CreateHttpNamespace requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.
This field is autopopulated if not provided.
The tags to add to the namespace. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
A custom key-value pair associated with a resource.
The key identifier, or name, of the tag.
The string value 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.
dict
Response Syntax
{
'OperationId': 'string'
}
Response Structure
(dict) --
OperationId (string) --
A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation .
Exceptions
Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend , the resulting DNS name for the service will be backend.example.com . For the current quota on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_private_dns_namespace(
Name='string',
CreatorRequestId='string',
Description='string',
Vpc='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name that you want to assign to this namespace. When you create a private DNS namespace, AWS Cloud Map automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.
A unique string that identifies the request and that allows failed CreatePrivateDnsNamespace requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.
This field is autopopulated if not provided.
[REQUIRED]
The ID of the Amazon VPC that you want to associate the namespace with.
The tags to add to the namespace. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
A custom key-value pair associated with a resource.
The key identifier, or name, of the tag.
The string value 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.
dict
Response Syntax
{
'OperationId': 'string'
}
Response Structure
(dict) --
OperationId (string) --
A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation .
Exceptions
Creates a public namespace based on DNS, which will be visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend , the resulting DNS name for the service will be backend.example.com . For the current quota on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_public_dns_namespace(
Name='string',
CreatorRequestId='string',
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name that you want to assign to this namespace.
A unique string that identifies the request and that allows failed CreatePublicDnsNamespace requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.
This field is autopopulated if not provided.
The tags to add to the namespace. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
A custom key-value pair associated with a resource.
The key identifier, or name, of the tag.
The string value 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.
dict
Response Syntax
{
'OperationId': 'string'
}
Response Structure
(dict) --
OperationId (string) --
A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation .
Exceptions
Creates a service, which defines the configuration for the following entities:
After you create the service, you can submit a RegisterInstance request, and AWS Cloud Map uses the values in the configuration to create the specified entities.
For the current quota on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_service(
Name='string',
NamespaceId='string',
CreatorRequestId='string',
Description='string',
DnsConfig={
'NamespaceId': 'string',
'RoutingPolicy': 'MULTIVALUE'|'WEIGHTED',
'DnsRecords': [
{
'Type': 'SRV'|'A'|'AAAA'|'CNAME',
'TTL': 123
},
]
},
HealthCheckConfig={
'Type': 'HTTP'|'HTTPS'|'TCP',
'ResourcePath': 'string',
'FailureThreshold': 123
},
HealthCheckCustomConfig={
'FailureThreshold': 123
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
Type='HTTP'
)
[REQUIRED]
The name that you want to assign to the service.
If you want AWS Cloud Map to create an SRV record when you register an instance, and if you're using a system that requires a specific SRV format, such as HAProxy , specify the following for Name :
When you register an instance, AWS 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 a single DNS namespace, you cannot create two services with names that differ only by case (such as EXAMPLE and example). Otherwise, these services will have the same DNS name. However, you can create multiple HTTP services with names that differ only by case because HTTP services are case sensitive.
A unique string that identifies the request and that allows failed CreateService requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.
This field is autopopulated if not provided.
A complex type that contains information about the Amazon Route 53 records that you want AWS Cloud Map to create when you register an instance.
The ID of the namespace to use for DNS configuration.
The routing policy that you want to apply to all Route 53 DNS records that AWS Cloud Map creates when you register an instance and specify this service.
Note
If you want to use this service to register instances that create alias records, specify WEIGHTED for the routing policy.
You can specify the following values:
MULTIVALUE
If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.
For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.
For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide .
WEIGHTED
Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.
For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.
For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide .
An array that contains one DnsRecord object for each Route 53 DNS record that you want AWS Cloud Map to create when you register an instance.
A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
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:
If you want AWS Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type .
You specify other settings, such as the IP address for A and AAAA 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:
SRV
Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:
priority weight port service-hostname
Note the following about the values:
For example, if the value of InstanceId is test , the name of the service is backend , and the name of the namespace is example.com , the value of service-hostname is:
test.backend.example.com
If you specify settings for an SRV record, note the following:
The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.
Note
Alias records don't include a TTL because Route 53 uses the TTL for the AWS resource that an alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request, the TTL value is ignored. Always specify a TTL for the service; you can use a service to register instances that create either alias or non-alias records.
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, AWS Cloud Map associates the health check with all the Route 53 DNS records that you specify in DnsConfig .
Warning
If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.
For information about the charges for health checks, see AWS Cloud Map Pricing .
The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.
Warning
You can't change the value of Type after you create a health check.
You can create the following types of health checks:
Warning
If you specify HTTPS for the value of Type , the endpoint must support TLS v1.0 or later.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide .
The path that you want Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file /docs/route53-health-check.html . Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath , the default value is / .
If you specify TCP for Type , you must not specify a value for ResourcePath .
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide .
A complex type that contains information about an optional custom health check.
Warning
If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.
You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing service.
Warning
This parameter has been deprecated and is always set to 1. AWS 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 AWS 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. AWS Cloud Map still waits 30 seconds after the first request to make the change.
The tags to add to the service. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
A custom key-value pair associated with a resource.
The key identifier, or name, of the tag.
The string value 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.
dict
Response Syntax
{
'Service': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'NamespaceId': 'string',
'Description': 'string',
'InstanceCount': 123,
'DnsConfig': {
'NamespaceId': 'string',
'RoutingPolicy': 'MULTIVALUE'|'WEIGHTED',
'DnsRecords': [
{
'Type': 'SRV'|'A'|'AAAA'|'CNAME',
'TTL': 123
},
]
},
'Type': 'HTTP'|'DNS_HTTP'|'DNS',
'HealthCheckConfig': {
'Type': 'HTTP'|'HTTPS'|'TCP',
'ResourcePath': 'string',
'FailureThreshold': 123
},
'HealthCheckCustomConfig': {
'FailureThreshold': 123
},
'CreateDate': datetime(2015, 1, 1),
'CreatorRequestId': 'string'
}
}
Response Structure
(dict) --
Service (dict) --
A complex type that contains information about the new service.
Id (string) --
The ID that AWS Cloud Map assigned to the service when you created it.
Arn (string) --
The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.
Name (string) --
The name of the service.
NamespaceId (string) --
The ID of the namespace that was used to create the service.
Description (string) --
The description of the service.
InstanceCount (integer) --
The number of instances that are currently associated with the service. Instances that were previously associated with the service but that have been deleted are not included in the count. The count might not reflect pending registrations and deregistrations.
DnsConfig (dict) --
A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
NamespaceId (string) --
The ID of the namespace to use for DNS configuration.
RoutingPolicy (string) --
The routing policy that you want to apply to all Route 53 DNS records that AWS Cloud Map creates when you register an instance and specify this service.
Note
If you want to use this service to register instances that create alias records, specify WEIGHTED for the routing policy.
You can specify the following values:
MULTIVALUE
If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.
For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.
For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide .
WEIGHTED
Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.
For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.
For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide .
DnsRecords (list) --
An array that contains one DnsRecord object for each Route 53 DNS record that you want AWS Cloud Map to create when you register an instance.
(dict) --
A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
Type (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:
If you want AWS Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type .
You specify other settings, such as the IP address for A and AAAA 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:
SRV
Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:
priority weight port service-hostname
Note the following about the values:
For example, if the value of InstanceId is test , the name of the service is backend , and the name of the namespace is example.com , the value of service-hostname is:
test.backend.example.com
If you specify settings for an SRV record, note the following:
TTL (integer) --
The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.
Note
Alias records don't include a TTL because Route 53 uses the TTL for the AWS resource that an alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request, the TTL value is ignored. Always specify a TTL for the service; you can use a service to register instances that create either alias or non-alias records.
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.
HealthCheckConfig (dict) --
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, AWS Cloud Map associates the health check with the records that you specify in DnsConfig .
For information about the charges for health checks, see Amazon Route 53 Pricing .
Type (string) --
The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.
Warning
You can't change the value of Type after you create a health check.
You can create the following types of health checks:
Warning
If you specify HTTPS for the value of Type , the endpoint must support TLS v1.0 or later.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide .
ResourcePath (string) --
The path that you want Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file /docs/route53-health-check.html . Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath , the default value is / .
If you specify TCP for Type , you must not specify a value for ResourcePath .
FailureThreshold (integer) --
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide .
HealthCheckCustomConfig (dict) --
A complex type that contains information about an optional custom health check.
Warning
If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.
FailureThreshold (integer) --
Warning
This parameter has been deprecated and is always set to 1. AWS 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 AWS 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. AWS Cloud Map still waits 30 seconds after the first request to make the change.
CreateDate (datetime) --
The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
CreatorRequestId (string) --
A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.
Exceptions
Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails.
See also: AWS API Documentation
Request Syntax
response = client.delete_namespace(
Id='string'
)
[REQUIRED]
The ID of the namespace that you want to delete.
{
'OperationId': 'string'
}
Response Structure
A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation .
Exceptions
Deletes a specified service. If the service still contains one or more registered instances, the request fails.
See also: AWS API Documentation
Request Syntax
response = client.delete_service(
Id='string'
)
[REQUIRED]
The ID of the service that you want to delete.
{}
Response Structure
Exceptions
Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified instance.
See also: AWS API Documentation
Request Syntax
response = client.deregister_instance(
ServiceId='string',
InstanceId='string'
)
[REQUIRED]
The ID of the service that the instance is associated with.
[REQUIRED]
The value that you specified for Id in the RegisterInstance request.
dict
Response Syntax
{
'OperationId': 'string'
}
Response Structure
(dict) --
OperationId (string) --
A value that you can use to determine whether the request completed successfully. For more information, see GetOperation .
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.discover_instances(
NamespaceName='string',
ServiceName='string',
MaxResults=123,
QueryParameters={
'string': 'string'
},
OptionalParameters={
'string': 'string'
},
HealthStatus='HEALTHY'|'UNHEALTHY'|'ALL'
)
[REQUIRED]
The name of the namespace that you specified when you registered the instance.
[REQUIRED]
The name of the service that you specified when you registered the instance.
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 will be returned.
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, they are returned. Otherwise, these filters are ignored and only instances that match the filters specified in the QueryParameters parameter are returned.
dict
Response Syntax
{
'Instances': [
{
'InstanceId': 'string',
'NamespaceName': 'string',
'ServiceName': 'string',
'HealthStatus': 'HEALTHY'|'UNHEALTHY'|'UNKNOWN',
'Attributes': {
'string': 'string'
}
},
]
}
Response Structure
(dict) --
Instances (list) --
A complex type that contains one HttpInstanceSummary for each registered instance.
(dict) --
In a response to a DiscoverInstances request, HttpInstanceSummary contains information about one instance that matches the values that you specified in the request.
InstanceId (string) --
The ID of an instance that matches the values that you specified in the request.
NamespaceName (string) --
The name of the namespace that you specified when you registered the instance.
ServiceName (string) --
The name of the service that you specified when you registered the instance.
HealthStatus (string) --
If you configured health checking in the service, the current health status of the service instance.
Attributes (dict) --
If you included any attributes when you registered the instance, the values of those attributes.
Exceptions
Generate a presigned url given a client, its method, and arguments
The presigned url
Gets information about a specified instance.
See also: AWS API Documentation
Request Syntax
response = client.get_instance(
ServiceId='string',
InstanceId='string'
)
[REQUIRED]
The ID of the service that the instance is associated with.
[REQUIRED]
The ID of the instance that you want to get information about.
dict
Response Syntax
{
'Instance': {
'Id': 'string',
'CreatorRequestId': 'string',
'Attributes': {
'string': 'string'
}
}
}
Response Structure
(dict) --
Instance (dict) --
A complex type that contains information about a specified instance.
Id (string) --
An identifier that you want to associate with the instance. Note the following:
Note
The health check isn't deleted immediately, so it will still appear for a while if you submit a ListHealthChecks request, for example.
CreatorRequestId (string) --
A unique string that identifies the request and that allows failed RegisterInstance requests to be retried without the risk of executing the operation twice. You must use a unique CreatorRequestId string every time you submit a RegisterInstance request if you're registering additional instances for the same namespace and service. CreatorRequestId can be any unique string, for example, a date/time stamp.
Attributes (dict) --
A string map that contains the following information for the service that you specify in ServiceId :
Supported attribute keys include the following:
AWS_ALIAS_DNS_NAME
If you want AWS Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see "DNSName" in the topic AliasTarget .
Note the following:
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_INSTANCE_CNAME
If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response to DNS queries, for example, example.com .
This value is required if the service specified by ServiceId includes settings for an CNAME record.
AWS_INSTANCE_IPV4
If the service configuration includes an A record, the IPv4 address that you want Route 53 to return in response to DNS queries, for example, 192.0.2.44 .
This value is required if the service specified by ServiceId includes settings for an A record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4 , AWS_INSTANCE_IPV6 , or both.
AWS_INSTANCE_IPV6
If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to return in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345 .
This value is required if the service specified by ServiceId includes settings for an AAAA record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4 , AWS_INSTANCE_IPV6 , or both.
AWS_INSTANCE_PORT
If the service includes an SRV record, the value that you want Route 53 to return for the port.
If the service includes HealthCheckConfig , the port on the endpoint that you want Route 53 to send requests to.
This value is required if you specified settings for an SRV record or a Route 53 health check when you created the service.
Exceptions
Gets the current health status (Healthy , Unhealthy , or Unknown ) of one or more instances that are associated with a specified service.
Note
There is a brief delay between when you register an instance and when the health status for the instance is available.
See also: AWS API Documentation
Request Syntax
response = client.get_instances_health_status(
ServiceId='string',
Instances=[
'string',
],
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The ID of the service that the instance is associated with.
An array that contains the IDs of all the instances that you want to get the health status for.
If you omit Instances , AWS Cloud Map returns the health status for all the instances that are associated with the specified service.
Note
To get the IDs for the instances that you've registered by using a specified service, submit a ListInstances request.
For the first GetInstancesHealthStatus request, omit this value.
If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.
dict
Response Syntax
{
'Status': {
'string': 'HEALTHY'|'UNHEALTHY'|'UNKNOWN'
},
'NextToken': 'string'
}
Response Structure
(dict) --
Status (dict) --
A complex type that contains the IDs and the health status of the instances that you specified in the GetInstancesHealthStatus request.
NextToken (string) --
If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.
Exceptions
Gets information about a namespace.
See also: AWS API Documentation
Request Syntax
response = client.get_namespace(
Id='string'
)
[REQUIRED]
The ID of the namespace that you want to get information about.
{
'Namespace': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Type': 'DNS_PUBLIC'|'DNS_PRIVATE'|'HTTP',
'Description': 'string',
'ServiceCount': 123,
'Properties': {
'DnsProperties': {
'HostedZoneId': 'string'
},
'HttpProperties': {
'HttpName': 'string'
}
},
'CreateDate': datetime(2015, 1, 1),
'CreatorRequestId': 'string'
}
}
Response Structure
A complex type that contains information about the specified namespace.
The ID of a namespace.
The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when you create it.
The name of the namespace, such as example.com .
The type of the namespace. The methods for discovering instances depends on the value that you specify:
The description that you specify for the namespace when you create it.
The number of services that are associated with the namespace.
A complex type that contains information that's specific to the type of the namespace.
A complex type that contains the ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.
The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.
A complex type that contains the name of an HTTP namespace.
The name of an HTTP namespace.
The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
A unique string that identifies the request and that allows failed requests to be retried without the risk of executing an operation twice.
Exceptions
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 .
See also: AWS API Documentation
Request Syntax
response = client.get_operation(
OperationId='string'
)
[REQUIRED]
The ID of the operation that you want to get more information about.
{
'Operation': {
'Id': 'string',
'Type': 'CREATE_NAMESPACE'|'DELETE_NAMESPACE'|'UPDATE_SERVICE'|'REGISTER_INSTANCE'|'DEREGISTER_INSTANCE',
'Status': 'SUBMITTED'|'PENDING'|'SUCCESS'|'FAIL',
'ErrorMessage': 'string',
'ErrorCode': 'string',
'CreateDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'Targets': {
'string': 'string'
}
}
}
Response Structure
A complex type that contains information about the operation.
The ID of the operation that you want to get information about.
The name of the operation that is associated with the specified ID.
The status of the operation. Values include the following:
If the value of Status is FAIL , the reason that the operation failed.
The code associated with ErrorMessage . Values for ErrorCode include the following:
The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that the value of Status changed to the current value, in Unix date/time format and Coordinated Universal Time (UTC). The value of UpdateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The name of the target entity that is associated with the operation:
Exceptions
Create a paginator for an operation.
Gets the settings for a specified service.
See also: AWS API Documentation
Request Syntax
response = client.get_service(
Id='string'
)
[REQUIRED]
The ID of the service that you want to get settings for.
{
'Service': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'NamespaceId': 'string',
'Description': 'string',
'InstanceCount': 123,
'DnsConfig': {
'NamespaceId': 'string',
'RoutingPolicy': 'MULTIVALUE'|'WEIGHTED',
'DnsRecords': [
{
'Type': 'SRV'|'A'|'AAAA'|'CNAME',
'TTL': 123
},
]
},
'Type': 'HTTP'|'DNS_HTTP'|'DNS',
'HealthCheckConfig': {
'Type': 'HTTP'|'HTTPS'|'TCP',
'ResourcePath': 'string',
'FailureThreshold': 123
},
'HealthCheckCustomConfig': {
'FailureThreshold': 123
},
'CreateDate': datetime(2015, 1, 1),
'CreatorRequestId': 'string'
}
}
Response Structure
A complex type that contains information about the service.
The ID that AWS Cloud Map assigned to the service when you created it.
The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.
The name of the service.
The ID of the namespace that was used to create the service.
The description of the service.
The number of instances that are currently associated with the service. Instances that were previously associated with the service but that have been deleted are not included in the count. The count might not reflect pending registrations and deregistrations.
A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
The ID of the namespace to use for DNS configuration.
The routing policy that you want to apply to all Route 53 DNS records that AWS Cloud Map creates when you register an instance and specify this service.
Note
If you want to use this service to register instances that create alias records, specify WEIGHTED for the routing policy.
You can specify the following values:
MULTIVALUE
If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.
For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.
For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide .
WEIGHTED
Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.
For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.
For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide .
An array that contains one DnsRecord object for each Route 53 DNS record that you want AWS Cloud Map to create when you register an instance.
A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
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:
If you want AWS Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type .
You specify other settings, such as the IP address for A and AAAA 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:
SRV
Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:
priority weight port service-hostname
Note the following about the values:
For example, if the value of InstanceId is test , the name of the service is backend , and the name of the namespace is example.com , the value of service-hostname is:
test.backend.example.com
If you specify settings for an SRV record, note the following:
The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.
Note
Alias records don't include a TTL because Route 53 uses the TTL for the AWS resource that an alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request, the TTL value is ignored. Always specify a TTL for the service; you can use a service to register instances that create either alias or non-alias records.
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.
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, AWS Cloud Map associates the health check with the records that you specify in DnsConfig .
For information about the charges for health checks, see Amazon Route 53 Pricing .
The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.
Warning
You can't change the value of Type after you create a health check.
You can create the following types of health checks:
Warning
If you specify HTTPS for the value of Type , the endpoint must support TLS v1.0 or later.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide .
The path that you want Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file /docs/route53-health-check.html . Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath , the default value is / .
If you specify TCP for Type , you must not specify a value for ResourcePath .
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide .
A complex type that contains information about an optional custom health check.
Warning
If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.
Warning
This parameter has been deprecated and is always set to 1. AWS 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 AWS 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. AWS Cloud Map still waits 30 seconds after the first request to make the change.
The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.
Exceptions
Returns an object that can wait for some condition.
Lists summary information about the instances that you registered by using a specified service.
See also: AWS API Documentation
Request Syntax
response = client.list_instances(
ServiceId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ID of the service that you want to list instances for.
For the first ListInstances request, omit this value.
If more than MaxResults instances match the specified criteria, you can submit another ListInstances request to get the next group of results. Specify the value of NextToken from the previous response in the next request.
dict
Response Syntax
{
'Instances': [
{
'Id': 'string',
'Attributes': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Instances (list) --
Summary information about the instances that are associated with the specified service.
(dict) --
A complex type that contains information about the instances that you registered by using a specified service.
Id (string) --
The ID for an instance that you created by using a specified service.
Attributes (dict) --
A string map that contains the following information:
Supported attribute keys include the following:
NextToken (string) --
If more than MaxResults instances match the specified criteria, you can submit another ListInstances request to get the next group of results. Specify the value of NextToken from the previous response in the next request.
Exceptions
Lists summary information about the namespaces that were created by the current AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_namespaces(
NextToken='string',
MaxResults=123,
Filters=[
{
'Name': 'TYPE',
'Values': [
'string',
],
'Condition': 'EQ'|'IN'|'BETWEEN'
},
]
)
For the first ListNamespaces request, omit this value.
If the response contains NextToken , submit another ListNamespaces request to get the next group of results. Specify the value of NextToken from the previous response in the next request.
Note
AWS Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.
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 .
A complex type that identifies the namespaces that you want to list. You can choose to list public or private namespaces.
Specify TYPE .
If you specify EQ for Condition , specify either DNS_PUBLIC or DNS_PRIVATE .
If you specify IN for Condition , you can specify DNS_PUBLIC , DNS_PRIVATE , or both.
The operator that you want to use to determine whether ListNamespaces returns a namespace. Valid values for condition include:
dict
Response Syntax
{
'Namespaces': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Type': 'DNS_PUBLIC'|'DNS_PRIVATE'|'HTTP',
'Description': 'string',
'ServiceCount': 123,
'Properties': {
'DnsProperties': {
'HostedZoneId': 'string'
},
'HttpProperties': {
'HttpName': 'string'
}
},
'CreateDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Namespaces (list) --
An array that contains one NamespaceSummary object for each namespace that matches the specified filter criteria.
(dict) --
A complex type that contains information about a namespace.
Id (string) --
The ID of the namespace.
Arn (string) --
The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when you create it.
Name (string) --
The name of the namespace. When you create a namespace, AWS Cloud Map automatically creates a Route 53 hosted zone that has the same name as the namespace.
Type (string) --
The type of the namespace, either public or private.
Description (string) --
A description for the namespace.
ServiceCount (integer) --
The number of services that were created using the namespace.
Properties (dict) --
A complex type that contains information that is specific to the namespace type.
DnsProperties (dict) --
A complex type that contains the ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.
HostedZoneId (string) --
The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.
HttpProperties (dict) --
A complex type that contains the name of an HTTP namespace.
HttpName (string) --
The name of an HTTP namespace.
CreateDate (datetime) --
The date and time that the namespace was created.
NextToken (string) --
If the response contains NextToken , submit another ListNamespaces request to get the next group of results. Specify the value of NextToken from the previous response in the next request.
Note
AWS Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.
Exceptions
Lists operations that match the criteria that you specify.
See also: AWS API Documentation
Request Syntax
response = client.list_operations(
NextToken='string',
MaxResults=123,
Filters=[
{
'Name': 'NAMESPACE_ID'|'SERVICE_ID'|'STATUS'|'TYPE'|'UPDATE_DATE',
'Values': [
'string',
],
'Condition': 'EQ'|'IN'|'BETWEEN'
},
]
)
For the first ListOperations request, omit this value.
If the response contains NextToken , submit another ListOperations request to get the next group of results. Specify the value of NextToken from the previous response in the next request.
Note
AWS Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's possible that no operations in the first MaxResults operations matched the specified criteria but that subsequent groups of MaxResults operations do contain operations that match the criteria.
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 .
A complex type that lets you select the operations that you want to list.
Specify the operations that you want to get:
Specify values that are applicable to the value that you specify for Name :
The operator that you want to use to determine whether an operation matches the specified value. Valid values for condition include:
dict
Response Syntax
{
'Operations': [
{
'Id': 'string',
'Status': 'SUBMITTED'|'PENDING'|'SUCCESS'|'FAIL'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Operations (list) --
Summary information about the operations that match the specified criteria.
(dict) --
A complex type that contains information about an operation that matches the criteria that you specified in a ListOperations request.
Id (string) --
The ID for an operation.
Status (string) --
The status of the operation. Values include the following:
NextToken (string) --
If the response contains NextToken , submit another ListOperations request to get the next group of results. Specify the value of NextToken from the previous response in the next request.
Note
AWS Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's possible that no operations in the first MaxResults operations matched the specified criteria but that subsequent groups of MaxResults operations do contain operations that match the criteria.
Exceptions
Lists summary information for all the services that are associated with one or more specified namespaces.
See also: AWS API Documentation
Request Syntax
response = client.list_services(
NextToken='string',
MaxResults=123,
Filters=[
{
'Name': 'NAMESPACE_ID',
'Values': [
'string',
],
'Condition': 'EQ'|'IN'|'BETWEEN'
},
]
)
For the first ListServices request, omit this value.
If the response contains NextToken , submit another ListServices request to get the next group of results. Specify the value of NextToken from the previous response in the next request.
Note
AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's possible that no services in the first MaxResults services matched the specified criteria but that subsequent groups of MaxResults services do contain services that match the criteria.
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 .
A complex type that lets you specify the namespaces that you want to list services for.
Specify NAMESPACE_ID .
The values that are applicable to the value that you specify for Condition to filter the list of services.
The operator that you want to use to determine whether a service is returned by ListServices . Valid values for Condition include the following:
dict
Response Syntax
{
'Services': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Type': 'HTTP'|'DNS_HTTP'|'DNS',
'Description': 'string',
'InstanceCount': 123,
'DnsConfig': {
'NamespaceId': 'string',
'RoutingPolicy': 'MULTIVALUE'|'WEIGHTED',
'DnsRecords': [
{
'Type': 'SRV'|'A'|'AAAA'|'CNAME',
'TTL': 123
},
]
},
'HealthCheckConfig': {
'Type': 'HTTP'|'HTTPS'|'TCP',
'ResourcePath': 'string',
'FailureThreshold': 123
},
'HealthCheckCustomConfig': {
'FailureThreshold': 123
},
'CreateDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Services (list) --
An array that contains one ServiceSummary object for each service that matches the specified filter criteria.
(dict) --
A complex type that contains information about a specified service.
Id (string) --
The ID that AWS Cloud Map assigned to the service when you created it.
Arn (string) --
The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.
Name (string) --
The name of the service.
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.
Description (string) --
The description that you specify when you create the service.
InstanceCount (integer) --
The number of instances that are currently associated with the service. Instances that were previously associated with the service but that have been deleted are not included in the count. The count might not reflect pending registrations and deregistrations.
DnsConfig (dict) --
A complex type that contains information about the Amazon Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
NamespaceId (string) --
The ID of the namespace to use for DNS configuration.
RoutingPolicy (string) --
The routing policy that you want to apply to all Route 53 DNS records that AWS Cloud Map creates when you register an instance and specify this service.
Note
If you want to use this service to register instances that create alias records, specify WEIGHTED for the routing policy.
You can specify the following values:
MULTIVALUE
If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.
For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.
For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide .
WEIGHTED
Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.
For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.
For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide .
DnsRecords (list) --
An array that contains one DnsRecord object for each Route 53 DNS record that you want AWS Cloud Map to create when you register an instance.
(dict) --
A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
Type (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:
If you want AWS Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type .
You specify other settings, such as the IP address for A and AAAA 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:
SRV
Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:
priority weight port service-hostname
Note the following about the values:
For example, if the value of InstanceId is test , the name of the service is backend , and the name of the namespace is example.com , the value of service-hostname is:
test.backend.example.com
If you specify settings for an SRV record, note the following:
TTL (integer) --
The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.
Note
Alias records don't include a TTL because Route 53 uses the TTL for the AWS resource that an alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request, the TTL value is ignored. Always specify a TTL for the service; you can use a service to register instances that create either alias or non-alias records.
HealthCheckConfig (dict) --
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, AWS Cloud Map associates the health check with the records that you specify in DnsConfig .
Warning
If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.
Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing .
Note the following about configuring health checks.
** A and AAAA records**
If DnsConfig includes configurations for both A and AAAA records, AWS Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint that is specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA records to be unhealthy.
** CNAME records**
You can't specify settings for HealthCheckConfig when the DNSConfig includes CNAME for the value of Type . If you do, the CreateService request will fail with an InvalidInput error.
Request interval
A Route 53 health checker in each health-checking region sends a health check request to an endpoint every 30 seconds. On average, your endpoint receives a health check request about every two seconds. However, health checkers don't coordinate with one another, so you'll sometimes see several requests per second followed by a few seconds with no health checks at all.
Health checking regions
Health checkers perform checks from all Route 53 health-checking regions. For a list of the current regions, see Regions .
Alias records
When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, AWS Cloud Map creates a Route 53 alias record. Note the following:
Charges for health checks
Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing .
Type (string) --
The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.
Warning
You can't change the value of Type after you create a health check.
You can create the following types of health checks:
Warning
If you specify HTTPS for the value of Type , the endpoint must support TLS v1.0 or later.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide .
ResourcePath (string) --
The path that you want Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file /docs/route53-health-check.html . Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath , the default value is / .
If you specify TCP for Type , you must not specify a value for ResourcePath .
FailureThreshold (integer) --
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide .
HealthCheckCustomConfig (dict) --
A complex type that contains information about an optional custom health check. A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances:
Warning
If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.
To change the status of a custom health check, submit an UpdateInstanceCustomHealthStatus request. AWS Cloud Map doesn't monitor the status of the resource, it just keeps a record of the status specified in the most recent UpdateInstanceCustomHealthStatus request.
Here's how custom health checks work:
Note
AWS Cloud Map doesn't check the health of the resource directly.
FailureThreshold (integer) --
Warning
This parameter has been deprecated and is always set to 1. AWS 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 AWS 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. AWS Cloud Map still waits 30 seconds after the first request to make the change.
CreateDate (datetime) --
The date and time that the service was created.
NextToken (string) --
If the response contains NextToken , submit another ListServices request to get the next group of results. Specify the value of NextToken from the previous response in the next request.
Note
AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's possible that no services in the first MaxResults services matched the specified criteria but that subsequent groups of MaxResults services do contain services that match the criteria.
Exceptions
Lists tags for the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
The tags that are assigned to the resource.
A custom key-value pair associated with a resource.
The key identifier, or name, of the tag.
The string value 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.
Exceptions
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:
Warning
One RegisterInstance request must complete before you can submit another request and specify the same service ID and instance ID.
For more information, see CreateService .
When AWS Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:
For the current quota on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.register_instance(
ServiceId='string',
InstanceId='string',
CreatorRequestId='string',
Attributes={
'string': 'string'
}
)
[REQUIRED]
The ID of the service that you want to use for settings for the instance.
[REQUIRED]
An identifier that you want to associate with the instance. Note the following:
Note
The health check isn't deleted immediately, so it will still appear for a while if you submit a ListHealthChecks request, for example.
A unique string that identifies the request and that allows failed RegisterInstance requests to be retried without the risk of executing the operation twice. You must use a unique CreatorRequestId string every time you submit a RegisterInstance request if you're registering additional instances for the same namespace and service. CreatorRequestId can be any unique string, for example, a date/time stamp.
This field is autopopulated if not provided.
[REQUIRED]
A string map that contains the following information for the service that you specify in ServiceId :
Supported attribute keys include the following:
AWS_ALIAS_DNS_NAME
If you want AWS Cloud Map to create an Amazon Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see "DNSName" in the topic AliasTarget in the Route 53 API Reference .
Note the following:
AWS_EC2_INSTANCE_IDHTTP 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 is AWS_INIT_HEALTH_STATUS . When the AWS_EC2_INSTANCE_ID attribute is specified, then the AWS_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 use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check, HEALTHY or UNHEALTHY . If you don't specify a value for AWS_INIT_HEALTH_STATUS , the initial status is HEALTHY .
AWS_INSTANCE_CNAME
If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response to DNS queries, for example, example.com .
This value is required if the service specified by ServiceId includes settings for an CNAME record.
AWS_INSTANCE_IPV4
If the service configuration includes an A record, the IPv4 address that you want Route 53 to return in response to DNS queries, for example, 192.0.2.44 .
This value is required if the service specified by ServiceId includes settings for an A record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4 , AWS_INSTANCE_IPV6 , or both.
AWS_INSTANCE_IPV6
If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to return in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345 .
This value is required if the service specified by ServiceId includes settings for an AAAA record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4 , AWS_INSTANCE_IPV6 , or both.
AWS_INSTANCE_PORT
If the service includes an SRV record, the value that you want Route 53 to return for the port.
If the service includes HealthCheckConfig , the port on the endpoint that you want Route 53 to send requests to.
This value is required if you specified settings for an SRV record 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.
dict
Response Syntax
{
'OperationId': 'string'
}
Response Structure
(dict) --
OperationId (string) --
A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation .
Exceptions
Adds one or more tags to the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.
[REQUIRED]
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.
A custom key-value pair associated with a resource.
The key identifier, or name, of the tag.
The string value 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.
dict
Response Syntax
{}
Response Structure
Exceptions
Removes one or more tags from the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.
[REQUIRED]
The tag keys to remove from the specified resource.
dict
Response Syntax
{}
Response Structure
Exceptions
Submits a request to change the health status of a custom health check to healthy or unhealthy.
You can use UpdateInstanceCustomHealthStatus to change the status only for custom health checks, which you define using HealthCheckCustomConfig when you create a service. You can't use it to change the status for Route 53 health checks, which you define using HealthCheckConfig .
For more information, see HealthCheckCustomConfig .
See also: AWS API Documentation
Request Syntax
response = client.update_instance_custom_health_status(
ServiceId='string',
InstanceId='string',
Status='HEALTHY'|'UNHEALTHY'
)
[REQUIRED]
The ID of the service that includes the configuration for the custom health check that you want to change the status for.
[REQUIRED]
The ID of the instance that you want to change the health status for.
[REQUIRED]
The new status of the instance, HEALTHY or UNHEALTHY .
None
Exceptions
Submits a request to perform the following operations:
Note
You can't add, update, or delete a HealthCheckCustomConfig configuration.
For public and private DNS namespaces, note the following:
When you update settings for a service, AWS Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service.
See also: AWS API Documentation
Request Syntax
response = client.update_service(
Id='string',
Service={
'Description': 'string',
'DnsConfig': {
'DnsRecords': [
{
'Type': 'SRV'|'A'|'AAAA'|'CNAME',
'TTL': 123
},
]
},
'HealthCheckConfig': {
'Type': 'HTTP'|'HTTPS'|'TCP',
'ResourcePath': 'string',
'FailureThreshold': 123
}
}
)
[REQUIRED]
The ID of the service that you want to update.
[REQUIRED]
A complex type that contains the new settings for the service.
A description for the service.
A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
An array that contains one DnsRecord object for each Route 53 record that you want AWS Cloud Map to create when you register an instance.
A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
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:
If you want AWS Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type .
You specify other settings, such as the IP address for A and AAAA 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:
SRV
Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:
priority weight port service-hostname
Note the following about the values:
For example, if the value of InstanceId is test , the name of the service is backend , and the name of the namespace is example.com , the value of service-hostname is:
test.backend.example.com
If you specify settings for an SRV record, note the following:
The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.
Note
Alias records don't include a TTL because Route 53 uses the TTL for the AWS resource that an alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request, the TTL value is ignored. Always specify a TTL for the service; you can use a service to register instances that create either alias or non-alias records.
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, AWS Cloud Map associates the health check with the records that you specify in DnsConfig .
Warning
If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.
Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing .
Note the following about configuring health checks.
** A and AAAA records**
If DnsConfig includes configurations for both A and AAAA records, AWS Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint that is specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA records to be unhealthy.
** CNAME records**
You can't specify settings for HealthCheckConfig when the DNSConfig includes CNAME for the value of Type . If you do, the CreateService request will fail with an InvalidInput error.
Request interval
A Route 53 health checker in each health-checking region sends a health check request to an endpoint every 30 seconds. On average, your endpoint receives a health check request about every two seconds. However, health checkers don't coordinate with one another, so you'll sometimes see several requests per second followed by a few seconds with no health checks at all.
Health checking regions
Health checkers perform checks from all Route 53 health-checking regions. For a list of the current regions, see Regions .
Alias records
When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, AWS Cloud Map creates a Route 53 alias record. Note the following:
Charges for health checks
Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing .
The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.
Warning
You can't change the value of Type after you create a health check.
You can create the following types of health checks:
Warning
If you specify HTTPS for the value of Type , the endpoint must support TLS v1.0 or later.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide .
The path that you want Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file /docs/route53-health-check.html . Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath , the default value is / .
If you specify TCP for Type , you must not specify a value for ResourcePath .
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide .
dict
Response Syntax
{
'OperationId': 'string'
}
Response Structure
(dict) --
OperationId (string) --
A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation .
Exceptions
The available paginators are:
paginator = client.get_paginator('list_instances')
Creates an iterator that will paginate through responses from ServiceDiscovery.Client.list_instances().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ServiceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the service that you want to list instances for.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Instances': [
{
'Id': 'string',
'Attributes': {
'string': 'string'
}
},
],
}
Response Structure
(dict) --
Instances (list) --
Summary information about the instances that are associated with the specified service.
(dict) --
A complex type that contains information about the instances that you registered by using a specified service.
Id (string) --
The ID for an instance that you created by using a specified service.
Attributes (dict) --
A string map that contains the following information:
Supported attribute keys include the following:
paginator = client.get_paginator('list_namespaces')
Creates an iterator that will paginate through responses from ServiceDiscovery.Client.list_namespaces().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'TYPE',
'Values': [
'string',
],
'Condition': 'EQ'|'IN'|'BETWEEN'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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 .
A complex type that identifies the namespaces that you want to list. You can choose to list public or private namespaces.
Specify TYPE .
If you specify EQ for Condition , specify either DNS_PUBLIC or DNS_PRIVATE .
If you specify IN for Condition , you can specify DNS_PUBLIC , DNS_PRIVATE , or both.
The operator that you want to use to determine whether ListNamespaces returns a namespace. Valid values for condition include:
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Namespaces': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Type': 'DNS_PUBLIC'|'DNS_PRIVATE'|'HTTP',
'Description': 'string',
'ServiceCount': 123,
'Properties': {
'DnsProperties': {
'HostedZoneId': 'string'
},
'HttpProperties': {
'HttpName': 'string'
}
},
'CreateDate': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
Namespaces (list) --
An array that contains one NamespaceSummary object for each namespace that matches the specified filter criteria.
(dict) --
A complex type that contains information about a namespace.
Id (string) --
The ID of the namespace.
Arn (string) --
The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when you create it.
Name (string) --
The name of the namespace. When you create a namespace, AWS Cloud Map automatically creates a Route 53 hosted zone that has the same name as the namespace.
Type (string) --
The type of the namespace, either public or private.
Description (string) --
A description for the namespace.
ServiceCount (integer) --
The number of services that were created using the namespace.
Properties (dict) --
A complex type that contains information that is specific to the namespace type.
DnsProperties (dict) --
A complex type that contains the ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.
HostedZoneId (string) --
The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.
HttpProperties (dict) --
A complex type that contains the name of an HTTP namespace.
HttpName (string) --
The name of an HTTP namespace.
CreateDate (datetime) --
The date and time that the namespace was created.
paginator = client.get_paginator('list_operations')
Creates an iterator that will paginate through responses from ServiceDiscovery.Client.list_operations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'NAMESPACE_ID'|'SERVICE_ID'|'STATUS'|'TYPE'|'UPDATE_DATE',
'Values': [
'string',
],
'Condition': 'EQ'|'IN'|'BETWEEN'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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 .
A complex type that lets you select the operations that you want to list.
Specify the operations that you want to get:
Specify values that are applicable to the value that you specify for Name :
The operator that you want to use to determine whether an operation matches the specified value. Valid values for condition include:
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Operations': [
{
'Id': 'string',
'Status': 'SUBMITTED'|'PENDING'|'SUCCESS'|'FAIL'
},
],
}
Response Structure
(dict) --
Operations (list) --
Summary information about the operations that match the specified criteria.
(dict) --
A complex type that contains information about an operation that matches the criteria that you specified in a ListOperations request.
Id (string) --
The ID for an operation.
Status (string) --
The status of the operation. Values include the following:
paginator = client.get_paginator('list_services')
Creates an iterator that will paginate through responses from ServiceDiscovery.Client.list_services().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'NAMESPACE_ID',
'Values': [
'string',
],
'Condition': 'EQ'|'IN'|'BETWEEN'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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 .
A complex type that lets you specify the namespaces that you want to list services for.
Specify NAMESPACE_ID .
The values that are applicable to the value that you specify for Condition to filter the list of services.
The operator that you want to use to determine whether a service is returned by ListServices . Valid values for Condition include the following:
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Services': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Type': 'HTTP'|'DNS_HTTP'|'DNS',
'Description': 'string',
'InstanceCount': 123,
'DnsConfig': {
'NamespaceId': 'string',
'RoutingPolicy': 'MULTIVALUE'|'WEIGHTED',
'DnsRecords': [
{
'Type': 'SRV'|'A'|'AAAA'|'CNAME',
'TTL': 123
},
]
},
'HealthCheckConfig': {
'Type': 'HTTP'|'HTTPS'|'TCP',
'ResourcePath': 'string',
'FailureThreshold': 123
},
'HealthCheckCustomConfig': {
'FailureThreshold': 123
},
'CreateDate': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
Services (list) --
An array that contains one ServiceSummary object for each service that matches the specified filter criteria.
(dict) --
A complex type that contains information about a specified service.
Id (string) --
The ID that AWS Cloud Map assigned to the service when you created it.
Arn (string) --
The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.
Name (string) --
The name of the service.
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.
Description (string) --
The description that you specify when you create the service.
InstanceCount (integer) --
The number of instances that are currently associated with the service. Instances that were previously associated with the service but that have been deleted are not included in the count. The count might not reflect pending registrations and deregistrations.
DnsConfig (dict) --
A complex type that contains information about the Amazon Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
NamespaceId (string) --
The ID of the namespace to use for DNS configuration.
RoutingPolicy (string) --
The routing policy that you want to apply to all Route 53 DNS records that AWS Cloud Map creates when you register an instance and specify this service.
Note
If you want to use this service to register instances that create alias records, specify WEIGHTED for the routing policy.
You can specify the following values:
MULTIVALUE
If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.
For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.
For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide .
WEIGHTED
Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.
For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.
For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide .
DnsRecords (list) --
An array that contains one DnsRecord object for each Route 53 DNS record that you want AWS Cloud Map to create when you register an instance.
(dict) --
A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
Type (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:
If you want AWS Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type .
You specify other settings, such as the IP address for A and AAAA 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:
SRV
Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:
priority weight port service-hostname
Note the following about the values:
For example, if the value of InstanceId is test , the name of the service is backend , and the name of the namespace is example.com , the value of service-hostname is:
test.backend.example.com
If you specify settings for an SRV record, note the following:
TTL (integer) --
The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.
Note
Alias records don't include a TTL because Route 53 uses the TTL for the AWS resource that an alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request, the TTL value is ignored. Always specify a TTL for the service; you can use a service to register instances that create either alias or non-alias records.
HealthCheckConfig (dict) --
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, AWS Cloud Map associates the health check with the records that you specify in DnsConfig .
Warning
If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.
Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing .
Note the following about configuring health checks.
** A and AAAA records**
If DnsConfig includes configurations for both A and AAAA records, AWS Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint that is specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA records to be unhealthy.
** CNAME records**
You can't specify settings for HealthCheckConfig when the DNSConfig includes CNAME for the value of Type . If you do, the CreateService request will fail with an InvalidInput error.
Request interval
A Route 53 health checker in each health-checking region sends a health check request to an endpoint every 30 seconds. On average, your endpoint receives a health check request about every two seconds. However, health checkers don't coordinate with one another, so you'll sometimes see several requests per second followed by a few seconds with no health checks at all.
Health checking regions
Health checkers perform checks from all Route 53 health-checking regions. For a list of the current regions, see Regions .
Alias records
When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, AWS Cloud Map creates a Route 53 alias record. Note the following:
Charges for health checks
Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing .
Type (string) --
The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.
Warning
You can't change the value of Type after you create a health check.
You can create the following types of health checks:
Warning
If you specify HTTPS for the value of Type , the endpoint must support TLS v1.0 or later.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide .
ResourcePath (string) --
The path that you want Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file /docs/route53-health-check.html . Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath , the default value is / .
If you specify TCP for Type , you must not specify a value for ResourcePath .
FailureThreshold (integer) --
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide .
HealthCheckCustomConfig (dict) --
A complex type that contains information about an optional custom health check. A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances:
Warning
If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.
To change the status of a custom health check, submit an UpdateInstanceCustomHealthStatus request. AWS Cloud Map doesn't monitor the status of the resource, it just keeps a record of the status specified in the most recent UpdateInstanceCustomHealthStatus request.
Here's how custom health checks work:
Note
AWS Cloud Map doesn't check the health of the resource directly.
FailureThreshold (integer) --
Warning
This parameter has been deprecated and is always set to 1. AWS 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 AWS 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. AWS Cloud Map still waits 30 seconds after the first request to make the change.
CreateDate (datetime) --
The date and time that the service was created.