AWS.ServiceDiscovery (aws-elixir v0.8.0) View Source

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 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.

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.

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 CreateService 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 account.

Lists operations that match the criteria that you specify.

Lists summary information for all the services that are associated with one or more specified 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.

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

Submits a request to perform the following operations

Link to this section Functions

Link to this function

create_http_namespace(client, input, options \\ [])

View Source

Creates an HTTP namespace.

Service instances registered using an HTTP namespace can be discovered using a DiscoverInstances request but can't be discovered using DNS.

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

Link to this function

create_private_dns_namespace(client, input, options \\ [])

View Source

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 account, see Cloud Map quotas in the Cloud Map Developer Guide.

Link to this function

create_public_dns_namespace(client, input, options \\ [])

View Source

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 account, see Cloud Map quotas in the Cloud Map Developer Guide.

Link to this function

create_service(client, input, options \\ [])

View Source

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.

Link to this function

delete_namespace(client, input, options \\ [])

View Source

Deletes a namespace from the current account.

If the namespace still contains one or more services, the request fails.

Link to this function

delete_service(client, input, options \\ [])

View Source

Deletes a specified service.

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

Link to this function

deregister_instance(client, input, options \\ [])

View Source

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

Link to this function

discover_instances(client, input, options \\ [])

View Source

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.

Link to this function

get_instance(client, input, options \\ [])

View Source

Gets information about a specified instance.

Link to this function

get_instances_health_status(client, input, options \\ [])

View Source

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.

Link to this function

get_namespace(client, input, options \\ [])

View Source

Gets information about a namespace.

Link to this function

get_operation(client, input, options \\ [])

View Source

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

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

Link to this function

get_service(client, input, options \\ [])

View Source

Gets the settings for a specified service.

Link to this function

list_instances(client, input, options \\ [])

View Source

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

Link to this function

list_namespaces(client, input, options \\ [])

View Source

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

Link to this function

list_operations(client, input, options \\ [])

View Source

Lists operations that match the criteria that you specify.

Link to this function

list_services(client, input, options \\ [])

View Source

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

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Lists tags for the specified resource.

Link to this function

register_instance(client, input, options \\ [])

View Source

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.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Adds one or more tags to the specified resource.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes one or more tags from the specified resource.

Link to this function

update_http_namespace(client, input, options \\ [])

View Source

Updates an HTTP namespace.

Link to this function

update_instance_custom_health_status(client, input, options \\ [])

View Source

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.

Link to this function

update_private_dns_namespace(client, input, options \\ [])

View Source

Updates a private DNS namespace.

Link to this function

update_public_dns_namespace(client, input, options \\ [])

View Source

Updates a public DNS namespace.

Link to this function

update_service(client, input, options \\ [])

View Source

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.