Package-level declarations

Types

Link copied to clipboard

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.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Creates a service. This action defines the configuration for the following entities:

Link copied to clipboard

Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Discovers the increasing revision associated with an instance.

Link copied to clipboard

Gets information about a specified instance.

Link copied to clipboard

Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service.

Link copied to clipboard

Gets information about a namespace.

Link copied to clipboard

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

Link copied to clipboard

Gets the settings for a specified service.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Lists operations that match the criteria that you specify.

Link copied to clipboard

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

Link copied to clipboard

Lists tags for the specified resource.

Link copied to clipboard

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:

Link copied to clipboard

Adds one or more tags to the specified resource.

Link copied to clipboard

Removes one or more tags from the specified resource.

Link copied to clipboard

Updates an HTTP namespace.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

Updates a public DNS namespace.

Link copied to clipboard

Submits a request to perform the following operations:

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.