View Source AWS.ServiceDiscovery (aws-elixir v1.0.4)
Cloud Map
With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your microservice applications run in.
When an instance becomes available, you can call the Cloud Map API to register the instance with Cloud Map. For public or private DNS namespaces, Cloud Map automatically creates DNS records and an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service receive an answer that contains up to eight healthy records.
Link to this section Summary
Functions
Creates an HTTP namespace.
Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC.
Creates a public namespace based on DNS, which is visible on the internet.
Creates a service.
Deletes a namespace from the current account.
Deletes a specified service.
Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified instance.
Discovers registered instances for a specified namespace and service.
Discovers the increasing revision associated with an instance.
Gets information about a specified instance.
Gets the current health status (Healthy, Unhealthy, or Unknown) of
one or more instances that are associated with a specified service.
Gets information about a namespace.
Gets information about any operation that returns an operation ID in the
response, such as a
CreateHttpNamespace request.
Gets the settings for a specified service.
Lists summary information about the instances that you registered by using a specified service.
Lists summary information about the namespaces that were created by the current Amazon Web Services account.
Lists operations that match the criteria that you specify.
Lists summary information for all the services that are associated with one or more namespaces.
Lists tags for the specified resource.
Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service.
Adds one or more tags to the specified resource.
Removes one or more tags from the specified resource.
Updates an HTTP namespace.
Submits a request to change the health status of a custom health check to healthy or unhealthy.
Updates a private DNS namespace.
Updates a public DNS namespace.
Submits a request to perform the following operations
Link to this section Functions
Creates an HTTP namespace.
Service instances registered using an HTTP namespace can be discovered using a
DiscoverInstances request but can't be discovered using DNS.
For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the Cloud Map Developer Guide.
Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC.
The
namespace defines your service naming scheme. For example, if you name your
namespace example.com
and name your service backend, the resulting DNS name for the service is
backend.example.com. Service instances that are registered using a private DNS
namespace can be
discovered using either a DiscoverInstances request or using DNS. For the
current quota on the
number of namespaces that you can create using the same Amazon Web Services
account, see Cloud Map quotas
in the
Cloud Map Developer Guide.
Creates a public namespace based on DNS, which is visible on the internet.
The namespace defines your
service naming scheme. For example, if you name your namespace example.com and
name your service
backend, the resulting DNS name for the service is backend.example.com. You
can
discover instances that were registered with a public DNS namespace by using
either a
DiscoverInstances request or using DNS. For the current quota on the number of
namespaces that you
can create using the same Amazon Web Services account, see Cloud Map quotas
in the
Cloud Map Developer Guide.
The CreatePublicDnsNamespace API operation is not supported in the Amazon Web
Services GovCloud (US)
Regions.
Creates a service.
This action defines the configuration for the following entities:
* For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53:
*A
*AAAA
*A and AAAA
*SRV
*CNAME
* Optionally, a health check
After you create the service, you can submit a RegisterInstance request, and Cloud Map uses the values in the configuration to create the specified entities.
For the current quota on the number of instances that you can register using the same namespace and using the same service, see Cloud Map quotas in the Cloud Map Developer Guide.
Deletes a namespace from the current account.
If the namespace still contains one or more services, the request fails.
Deletes a specified service.
If the service still contains one or more registered instances, the request fails.
Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified instance.
Discovers registered instances for a specified namespace and service.
You can use
DiscoverInstances to discover instances for any type of namespace.
DiscoverInstances
returns a randomized list of instances allowing customers to distribute traffic
evenly across instances. For
public and private DNS namespaces, you can also use DNS queries to discover
instances.
Discovers the increasing revision associated with an instance.
Gets information about a specified instance.
Gets the current health status (Healthy, Unhealthy, or Unknown) of
one or more instances that are associated with a specified service.
There's a brief delay between when you register an instance and when the health status for the instance is available.
Gets information about a namespace.
Gets information about any operation that returns an operation ID in the
response, such as a
CreateHttpNamespace request.
To get a list of operations that match specified criteria, see ListOperations.
Gets the settings for a specified service.
Lists summary information about the instances that you registered by using a specified service.
Lists summary information about the namespaces that were created by the current Amazon Web Services account.
Lists operations that match the criteria that you specify.
Lists summary information for all the services that are associated with one or more namespaces.
Lists tags for the specified resource.
Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service.
When you submit a RegisterInstance request, the following occurs:
*
For each DNS record that you define in the service that's specified by
ServiceId, a record
is created or updated in the hosted zone that's associated with the
corresponding namespace.
*
If the service includes HealthCheckConfig, a health check is created based on
the settings
in the health check configuration.
* The health check, if any, is associated with each of the new or updated records.
One RegisterInstance request must complete before you can submit another
request and specify
the same service ID and instance ID.
For more information, see CreateService. When Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:
*
If the health check is healthy: returns all the records
*
If the health check is unhealthy: returns the applicable value for the last healthy instance
*
If you didn't specify a health check configuration: returns all the records
For the current quota on the number of instances that you can register using the same namespace and using the same service, see Cloud Map quotas in the Cloud Map Developer Guide.
Adds one or more tags to the specified resource.
Removes one or more tags from the specified resource.
Updates an HTTP namespace.
update_instance_custom_health_status(client, input, options \\ [])
View SourceSubmits 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.
Updates a private DNS namespace.
Updates a public DNS namespace.
Submits a request to perform the following operations:
*
Update the TTL setting for existing DnsRecords configurations
*
Add, update, or delete HealthCheckConfig for a specified service
You can't add, update, or delete a HealthCheckCustomConfig configuration.
For public and private DNS namespaces, note the following:
*
If you omit any existing DnsRecords or HealthCheckConfig configurations from
an
UpdateService request, the configurations are deleted from the service.
*
If you omit an existing HealthCheckCustomConfig configuration from an
UpdateService request, the configuration isn't deleted from the service.
When you update settings for a service, Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service.