@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSServiceDiscoveryClient extends AmazonWebServiceClient implements AWSServiceDiscovery
Amazon Route 53 auto naming lets you configure public or private namespaces that your microservice applications run in. When instances of the service become available, you can call the auto naming API to register the instance, and Route 53 automatically creates up to five DNS records and an optional health check. Clients that submit DNS queries for the service receive an answer that contains up to eight healthy records.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
static AWSServiceDiscoveryClientBuilder |
builder() |
CreatePrivateDnsNamespaceResult |
createPrivateDnsNamespace(CreatePrivateDnsNamespaceRequest request)
Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC.
|
CreatePublicDnsNamespaceResult |
createPublicDnsNamespace(CreatePublicDnsNamespaceRequest request)
Creates a public namespace based on DNS, which will be visible on the internet.
|
CreateServiceResult |
createService(CreateServiceRequest request)
Creates a service, which defines the configuration for the following entities:
|
DeleteNamespaceResult |
deleteNamespace(DeleteNamespaceRequest request)
Deletes a namespace from the current account.
|
DeleteServiceResult |
deleteService(DeleteServiceRequest request)
Deletes a specified service.
|
DeregisterInstanceResult |
deregisterInstance(DeregisterInstanceRequest request)
Deletes the records and the health check, if any, that Amazon Route 53 created for the specified instance.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetInstanceResult |
getInstance(GetInstanceRequest request)
Gets information about a specified instance.
|
GetInstancesHealthStatusResult |
getInstancesHealthStatus(GetInstancesHealthStatusRequest request)
Gets the current health status (
Healthy, Unhealthy, or Unknown) of one or
more instances that are associated with a specified service. |
GetNamespaceResult |
getNamespace(GetNamespaceRequest request)
Gets information about a namespace.
|
GetOperationResult |
getOperation(GetOperationRequest request)
Gets information about any operation that returns an operation ID in the response, such as a
CreateService request. |
GetServiceResult |
getService(GetServiceRequest request)
Gets the settings for a specified service.
|
ListInstancesResult |
listInstances(ListInstancesRequest request)
Lists summary information about the instances that you registered by using a specified service.
|
ListNamespacesResult |
listNamespaces(ListNamespacesRequest request)
Lists summary information about the namespaces that were created by the current AWS account.
|
ListOperationsResult |
listOperations(ListOperationsRequest request)
Lists operations that match the criteria that you specify.
|
ListServicesResult |
listServices(ListServicesRequest request)
Lists summary information for all the services that are associated with one or more specified namespaces.
|
RegisterInstanceResult |
registerInstance(RegisterInstanceRequest request)
Creates or updates one or more records and optionally a health check based on the settings in a specified
service.
|
UpdateInstanceCustomHealthStatusResult |
updateInstanceCustomHealthStatus(UpdateInstanceCustomHealthStatusRequest request) |
UpdateServiceResult |
updateService(UpdateServiceRequest request)
Submits a request to perform the following operations:
|
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitshutdownpublic static AWSServiceDiscoveryClientBuilder builder()
public CreatePrivateDnsNamespaceResult createPrivateDnsNamespace(CreatePrivateDnsNamespaceRequest request)
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 limit on the number of namespaces that you can create using the
same AWS account, see Limits on Auto Naming in the Route 53 Developer Guide.
createPrivateDnsNamespace in interface AWSServiceDiscoverycreatePrivateDnsNamespaceRequest - InvalidInputException - One or more specified values aren't valid. For example, when you're creating a namespace, the value of
Name might not be a valid DNS name.NamespaceAlreadyExistsException - The namespace that you're trying to create already exists.ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.DuplicateRequestException - The operation is already in progress.public CreatePublicDnsNamespaceResult createPublicDnsNamespace(CreatePublicDnsNamespaceRequest request)
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 limit on the number of namespaces that you can create using the same AWS account, see Limits on Auto Naming in the Route 53 Developer Guide.
createPublicDnsNamespace in interface AWSServiceDiscoverycreatePublicDnsNamespaceRequest - InvalidInputException - One or more specified values aren't valid. For example, when you're creating a namespace, the value of
Name might not be a valid DNS name.NamespaceAlreadyExistsException - The namespace that you're trying to create already exists.ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.DuplicateRequestException - The operation is already in progress.public CreateServiceResult createService(CreateServiceRequest request)
Creates a service, which defines the configuration for the following entities:
Up to three records (A, AAAA, and SRV) or one CNAME record
Optionally, a health check
After you create the service, you can submit a RegisterInstance request, and Amazon Route 53 uses the values in the configuration to create the specified entities.
For the current limit on the number of instances that you can register using the same namespace and using the same service, see Limits on Auto Naming in the Route 53 Developer Guide.
createService in interface AWSServiceDiscoverycreateServiceRequest - InvalidInputException - One or more specified values aren't valid. For example, when you're creating a namespace, the value of
Name might not be a valid DNS name.ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.NamespaceNotFoundException - No namespace exists with the specified ID.ServiceAlreadyExistsException - The service can't be created because a service with the same name already exists.public DeleteNamespaceResult deleteNamespace(DeleteNamespaceRequest request)
Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails.
deleteNamespace in interface AWSServiceDiscoverydeleteNamespaceRequest - InvalidInputException - One or more specified values aren't valid. For example, when you're creating a namespace, the value of
Name might not be a valid DNS name.NamespaceNotFoundException - No namespace exists with the specified ID.ResourceInUseException - The specified resource can't be deleted because it contains other resources. For example, you can't
delete a service that contains any instances.DuplicateRequestException - The operation is already in progress.public DeleteServiceResult deleteService(DeleteServiceRequest request)
Deletes a specified service. If the service still contains one or more registered instances, the request fails.
deleteService in interface AWSServiceDiscoverydeleteServiceRequest - InvalidInputException - One or more specified values aren't valid. For example, when you're creating a namespace, the value of
Name might not be a valid DNS name.ServiceNotFoundException - No service exists with the specified ID.ResourceInUseException - The specified resource can't be deleted because it contains other resources. For example, you can't
delete a service that contains any instances.public DeregisterInstanceResult deregisterInstance(DeregisterInstanceRequest request)
Deletes the records and the health check, if any, that Amazon Route 53 created for the specified instance.
deregisterInstance in interface AWSServiceDiscoveryderegisterInstanceRequest - DuplicateRequestException - The operation is already in progress.InvalidInputException - One or more specified values aren't valid. For example, when you're creating a namespace, the value of
Name might not be a valid DNS name.InstanceNotFoundException - No instance exists with the specified ID, or the instance was recently registered, and information about
the instance hasn't propagated yet.ResourceInUseException - The specified resource can't be deleted because it contains other resources. For example, you can't
delete a service that contains any instances.ServiceNotFoundException - No service exists with the specified ID.public GetInstanceResult getInstance(GetInstanceRequest request)
Gets information about a specified instance.
getInstance in interface AWSServiceDiscoverygetInstanceRequest - InstanceNotFoundException - No instance exists with the specified ID, or the instance was recently registered, and information about
the instance hasn't propagated yet.InvalidInputException - One or more specified values aren't valid. For example, when you're creating a namespace, the value of
Name might not be a valid DNS name.ServiceNotFoundException - No service exists with the specified ID.public GetInstancesHealthStatusResult getInstancesHealthStatus(GetInstancesHealthStatusRequest request)
Gets the current health status (Healthy, Unhealthy, or Unknown) of one or
more instances that are associated with a specified service.
There is a brief delay between when you register an instance and when the health status for the instance is available.
getInstancesHealthStatus in interface AWSServiceDiscoverygetInstancesHealthStatusRequest - InstanceNotFoundException - No instance exists with the specified ID, or the instance was recently registered, and information about
the instance hasn't propagated yet.InvalidInputException - One or more specified values aren't valid. For example, when you're creating a namespace, the value of
Name might not be a valid DNS name.ServiceNotFoundException - No service exists with the specified ID.public GetNamespaceResult getNamespace(GetNamespaceRequest request)
Gets information about a namespace.
getNamespace in interface AWSServiceDiscoverygetNamespaceRequest - InvalidInputException - One or more specified values aren't valid. For example, when you're creating a namespace, the value of
Name might not be a valid DNS name.NamespaceNotFoundException - No namespace exists with the specified ID.public GetOperationResult getOperation(GetOperationRequest request)
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.
getOperation in interface AWSServiceDiscoverygetOperationRequest - OperationNotFoundException - No operation exists with the specified ID.public GetServiceResult getService(GetServiceRequest request)
Gets the settings for a specified service.
getService in interface AWSServiceDiscoverygetServiceRequest - InvalidInputException - One or more specified values aren't valid. For example, when you're creating a namespace, the value of
Name might not be a valid DNS name.ServiceNotFoundException - No service exists with the specified ID.public ListInstancesResult listInstances(ListInstancesRequest request)
Lists summary information about the instances that you registered by using a specified service.
listInstances in interface AWSServiceDiscoverylistInstancesRequest - ServiceNotFoundException - No service exists with the specified ID.InvalidInputException - One or more specified values aren't valid. For example, when you're creating a namespace, the value of
Name might not be a valid DNS name.public ListNamespacesResult listNamespaces(ListNamespacesRequest request)
Lists summary information about the namespaces that were created by the current AWS account.
listNamespaces in interface AWSServiceDiscoverylistNamespacesRequest - InvalidInputException - One or more specified values aren't valid. For example, when you're creating a namespace, the value of
Name might not be a valid DNS name.public ListOperationsResult listOperations(ListOperationsRequest request)
Lists operations that match the criteria that you specify.
listOperations in interface AWSServiceDiscoverylistOperationsRequest - InvalidInputException - One or more specified values aren't valid. For example, when you're creating a namespace, the value of
Name might not be a valid DNS name.public ListServicesResult listServices(ListServicesRequest request)
Lists summary information for all the services that are associated with one or more specified namespaces.
listServices in interface AWSServiceDiscoverylistServicesRequest - InvalidInputException - One or more specified values aren't valid. For example, when you're creating a namespace, the value of
Name might not be a valid DNS name.public RegisterInstanceResult registerInstance(RegisterInstanceRequest request)
Creates or updates one or more records and optionally a health check based on the settings in a specified
service. When you submit a RegisterInstance request, Amazon Route 53 does the following:
For each DNS record that you define in the service specified by ServiceId, creates or updates a
record in the hosted zone that is associated with the corresponding namespace
If the service includes HealthCheckConfig, creates or updates a health check based on the settings
in the health check configuration
Associates the health check, if any, with each of the 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 Route 53 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 limit on the number of instances that you can register using the same namespace and using the same service, see Limits on Auto Naming in the Route 53 Developer Guide.
registerInstance in interface AWSServiceDiscoveryregisterInstanceRequest - DuplicateRequestException - The operation is already in progress.InvalidInputException - One or more specified values aren't valid. For example, when you're creating a namespace, the value of
Name might not be a valid DNS name.ResourceInUseException - The specified resource can't be deleted because it contains other resources. For example, you can't
delete a service that contains any instances.ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.ServiceNotFoundException - No service exists with the specified ID.public UpdateInstanceCustomHealthStatusResult updateInstanceCustomHealthStatus(UpdateInstanceCustomHealthStatusRequest request)
updateInstanceCustomHealthStatus in interface AWSServiceDiscoveryupdateInstanceCustomHealthStatusRequest - InstanceNotFoundException - No instance exists with the specified ID, or the instance was recently registered, and information about
the instance hasn't propagated yet.ServiceNotFoundException - No service exists with the specified ID.CustomHealthNotFoundExceptionInvalidInputException - One or more specified values aren't valid. For example, when you're creating a namespace, the value of
Name might not be a valid DNS name.public UpdateServiceResult updateService(UpdateServiceRequest request)
Submits a request to perform the following operations:
Add or delete DnsRecords configurations
Update the TTL setting for existing DnsRecords configurations
Add, update, or delete HealthCheckConfig for a specified service
You must specify all DnsRecords configurations (and, optionally, HealthCheckConfig)
that you want to appear in the updated service. Any current configurations that don't appear in an
UpdateService request are deleted.
When you update the TTL setting for a service, Amazon Route 53 also updates the corresponding settings in all the records and health checks that were created by using the specified service.
updateService in interface AWSServiceDiscoveryupdateServiceRequest - DuplicateRequestException - The operation is already in progress.InvalidInputException - One or more specified values aren't valid. For example, when you're creating a namespace, the value of
Name might not be a valid DNS name.ServiceNotFoundException - No service exists with the specified ID.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AWSServiceDiscoveryrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.