aws_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.Summary
Functions
-
create_http_namespace(Client, Input)
Creates an HTTP namespace.
- create_http_namespace(Client, Input, Options)
-
create_private_dns_namespace(Client, Input)
Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC.
- create_private_dns_namespace(Client, Input, Options)
-
create_public_dns_namespace(Client, Input)
Creates a public namespace based on DNS, which will be visible on the internet.
- create_public_dns_namespace(Client, Input, Options)
-
create_service(Client, Input)
Creates a service, which defines the configuration for the following entities:.
- create_service(Client, Input, Options)
-
delete_namespace(Client, Input)
Deletes a namespace from the current account.
- delete_namespace(Client, Input, Options)
-
delete_service(Client, Input)
Deletes a specified service.
- delete_service(Client, Input, Options)
-
deregister_instance(Client, Input)
Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified instance.
- deregister_instance(Client, Input, Options)
-
discover_instances(Client, Input)
Discovers registered instances for a specified namespace and service.
- discover_instances(Client, Input, Options)
-
get_instance(Client, Input)
Gets information about a specified instance.
- get_instance(Client, Input, Options)
-
get_instances_health_status(Client, Input)
Gets the current health status (
Healthy
,Unhealthy
, orUnknown
) of one or more instances that are associated with a specified service. - get_instances_health_status(Client, Input, Options)
-
get_namespace(Client, Input)
Gets information about a namespace.
- get_namespace(Client, Input, Options)
-
get_operation(Client, Input)
Gets information about any operation that returns an operation ID in the response, such as a
CreateService
request. - get_operation(Client, Input, Options)
-
get_service(Client, Input)
Gets the settings for a specified service.
- get_service(Client, Input, Options)
-
list_instances(Client, Input)
Lists summary information about the instances that you registered by using a specified service.
- list_instances(Client, Input, Options)
-
list_namespaces(Client, Input)
Lists summary information about the namespaces that were created by the current AWS account.
- list_namespaces(Client, Input, Options)
-
list_operations(Client, Input)
Lists operations that match the criteria that you specify.
- list_operations(Client, Input, Options)
-
list_services(Client, Input)
Lists summary information for all the services that are associated with one or more specified namespaces.
- list_services(Client, Input, Options)
-
list_tags_for_resource(Client, Input)
Lists tags for the specified resource.
- list_tags_for_resource(Client, Input, Options)
-
register_instance(Client, Input)
Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service.
- register_instance(Client, Input, Options)
-
tag_resource(Client, Input)
Adds one or more tags to the specified resource.
- tag_resource(Client, Input, Options)
-
untag_resource(Client, Input)
Removes one or more tags from the specified resource.
- untag_resource(Client, Input, Options)
-
update_instance_custom_health_status(Client, Input)
Submits a request to change the health status of a custom health check to healthy or unhealthy.
- update_instance_custom_health_status(Client, Input, Options)
-
update_service(Client, Input)
Submits a request to perform the following operations:.
- update_service(Client, Input, Options)
Functions
create_http_namespace(Client, Input)
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.
create_http_namespace(Client, Input, Options)
create_private_dns_namespace(Client, Input)
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 namespaceexample.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.
create_private_dns_namespace(Client, Input, Options)
create_public_dns_namespace(Client, Input)
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 namespaceexample.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.
create_public_dns_namespace(Client, Input, Options)
create_service(Client, Input)
Creates a service, which defines the configuration for the following entities:
For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53:
A
AAAA
A
andAAAA
SRV
CNAME
Optionally, a health check
After you create the service, you can submit a RegisterInstance request, and AWS Cloud Map uses the values in the configuration to create the specified entities.
For the current 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.create_service(Client, Input, Options)
delete_namespace(Client, Input)
Deletes a namespace from the current account.
If the namespace still contains one or more services, the request fails.delete_namespace(Client, Input, Options)
delete_service(Client, Input)
Deletes a specified service.
If the service still contains one or more registered instances, the request fails.delete_service(Client, Input, Options)
deregister_instance(Client, Input)
Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified instance.
deregister_instance(Client, Input, Options)
discover_instances(Client, Input)
Discovers registered instances for a specified namespace and service.
You can useDiscoverInstances
to discover instances for any type of
namespace. For public and private DNS namespaces, you can also use DNS
queries to discover instances.
discover_instances(Client, Input, Options)
get_instance(Client, Input)
Gets information about a specified instance.
get_instance(Client, Input, Options)
get_instances_health_status(Client, Input)
Gets the current health status (Healthy
, Unhealthy
, or Unknown
)
of one or more instances that are associated with a specified service.
get_instances_health_status(Client, Input, Options)
get_namespace(Client, Input)
Gets information about a namespace.
get_namespace(Client, Input, Options)
get_operation(Client, Input)
Gets information about any operation that returns an operation ID in
the response, such as a CreateService
request.
get_operation(Client, Input, Options)
get_service(Client, Input)
Gets the settings for a specified service.
get_service(Client, Input, Options)
list_instances(Client, Input)
Lists summary information about the instances that you registered by using a specified service.
list_instances(Client, Input, Options)
list_namespaces(Client, Input)
Lists summary information about the namespaces that were created by the current AWS account.
list_namespaces(Client, Input, Options)
list_operations(Client, Input)
Lists operations that match the criteria that you specify.
list_operations(Client, Input, Options)
list_services(Client, Input)
Lists summary information for all the services that are associated with one or more specified namespaces.
list_services(Client, Input, Options)
list_tags_for_resource(Client, Input)
Lists tags for the specified resource.
list_tags_for_resource(Client, Input, Options)
register_instance(Client, Input)
Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service.
When you submit a RegisterInstance
request, the following occurs:
For each DNS record that you define in the service that is specified by
ServiceId
, a record is created or updated in the hosted zone that is associated with the corresponding namespace.If the service includes
HealthCheckConfig
, a health check is created based on the settings in the health check configuration.The health check, if any, is associated with each of the new or updated records.
One RegisterInstance
request must complete before you can
submit another request and specify the same service ID and instance ID.
For more information, see CreateService.
When AWS Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:
If the health check is healthy: returns all the records
If the health check is unhealthy: returns the applicable value for the last healthy instance
If you didn't specify a health check configuration: returns all the records
register_instance(Client, Input, Options)
tag_resource(Client, Input)
Adds one or more tags to the specified resource.
tag_resource(Client, Input, Options)
untag_resource(Client, Input)
Removes one or more tags from the specified resource.
untag_resource(Client, Input, Options)
update_instance_custom_health_status(Client, Input)
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
.
update_instance_custom_health_status(Client, Input, Options)
update_service(Client, Input)
Submits a request to perform the following operations:
Update the TTL setting for existing
DnsRecords
configurationsAdd, update, or delete
HealthCheckConfig
for a specified serviceYou can't add, update, or delete a
HealthCheckCustomConfig
configuration.
For public and private DNS namespaces, note the following:
If you omit any existing
DnsRecords
orHealthCheckConfig
configurations from anUpdateService
request, the configurations are deleted from the service.If you omit an existing
HealthCheckCustomConfig
configuration from anUpdateService
request, the configuration is not deleted from the service.