@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSServiceDiscovery extends Object implements AWSServiceDiscovery
AWSServiceDiscovery
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
CreateHttpNamespaceResult |
createHttpNamespace(CreateHttpNamespaceRequest request)
Creates an HTTP namespace.
|
CreatePrivateDnsNamespaceResult |
createPrivateDnsNamespace(CreatePrivateDnsNamespaceRequest request)
Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC.
|
CreatePublicDnsNamespaceResult |
createPublicDnsNamespace(CreatePublicDnsNamespaceRequest request)
Creates a public namespace based on DNS, which is visible on the internet.
|
CreateServiceResult |
createService(CreateServiceRequest request)
Creates a service.
|
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 Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified
instance.
|
DiscoverInstancesResult |
discoverInstances(DiscoverInstancesRequest request)
Discovers registered instances for a specified namespace and service.
|
DiscoverInstancesRevisionResult |
discoverInstancesRevision(DiscoverInstancesRevisionRequest request)
Discovers the increasing revision associated with an 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
CreateHttpNamespace 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 Amazon Web Services 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 namespaces.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists tags for the specified resource.
|
RegisterInstanceResult |
registerInstance(RegisterInstanceRequest request)
Creates or updates one or more records and, optionally, creates a health check based on the settings in a
specified service.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds one or more tags to the specified resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags from the specified resource.
|
UpdateHttpNamespaceResult |
updateHttpNamespace(UpdateHttpNamespaceRequest request)
Updates an HTTP namespace.
|
UpdateInstanceCustomHealthStatusResult |
updateInstanceCustomHealthStatus(UpdateInstanceCustomHealthStatusRequest request)
Submits a request to change the health status of a custom health check to healthy or unhealthy.
|
UpdatePrivateDnsNamespaceResult |
updatePrivateDnsNamespace(UpdatePrivateDnsNamespaceRequest request)
Updates a private DNS namespace.
|
UpdatePublicDnsNamespaceResult |
updatePublicDnsNamespace(UpdatePublicDnsNamespaceRequest request)
Updates a public DNS namespace.
|
UpdateServiceResult |
updateService(UpdateServiceRequest request)
Submits a request to perform the following operations:
|
public CreateHttpNamespaceResult createHttpNamespace(CreateHttpNamespaceRequest request)
AWSServiceDiscovery
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.
createHttpNamespace
in interface AWSServiceDiscovery
public CreatePrivateDnsNamespaceResult createPrivateDnsNamespace(CreatePrivateDnsNamespaceRequest request)
AWSServiceDiscovery
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.
createPrivateDnsNamespace
in interface AWSServiceDiscovery
public CreatePublicDnsNamespaceResult createPublicDnsNamespace(CreatePublicDnsNamespaceRequest request)
AWSServiceDiscovery
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.
createPublicDnsNamespace
in interface AWSServiceDiscovery
public CreateServiceResult createService(CreateServiceRequest request)
AWSServiceDiscovery
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.
createService
in interface AWSServiceDiscovery
public DeleteNamespaceResult deleteNamespace(DeleteNamespaceRequest request)
AWSServiceDiscovery
Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails.
deleteNamespace
in interface AWSServiceDiscovery
public DeleteServiceResult deleteService(DeleteServiceRequest request)
AWSServiceDiscovery
Deletes a specified service. If the service still contains one or more registered instances, the request fails.
deleteService
in interface AWSServiceDiscovery
public DeregisterInstanceResult deregisterInstance(DeregisterInstanceRequest request)
AWSServiceDiscovery
Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified instance.
deregisterInstance
in interface AWSServiceDiscovery
public DiscoverInstancesResult discoverInstances(DiscoverInstancesRequest request)
AWSServiceDiscovery
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.
discoverInstances
in interface AWSServiceDiscovery
public DiscoverInstancesRevisionResult discoverInstancesRevision(DiscoverInstancesRevisionRequest request)
AWSServiceDiscovery
Discovers the increasing revision associated with an instance.
discoverInstancesRevision
in interface AWSServiceDiscovery
public GetInstanceResult getInstance(GetInstanceRequest request)
AWSServiceDiscovery
Gets information about a specified instance.
getInstance
in interface AWSServiceDiscovery
public GetInstancesHealthStatusResult getInstancesHealthStatus(GetInstancesHealthStatusRequest request)
AWSServiceDiscovery
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.
getInstancesHealthStatus
in interface AWSServiceDiscovery
public GetNamespaceResult getNamespace(GetNamespaceRequest request)
AWSServiceDiscovery
Gets information about a namespace.
getNamespace
in interface AWSServiceDiscovery
public GetOperationResult getOperation(GetOperationRequest request)
AWSServiceDiscovery
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.
getOperation
in interface AWSServiceDiscovery
public GetServiceResult getService(GetServiceRequest request)
AWSServiceDiscovery
Gets the settings for a specified service.
getService
in interface AWSServiceDiscovery
public ListInstancesResult listInstances(ListInstancesRequest request)
AWSServiceDiscovery
Lists summary information about the instances that you registered by using a specified service.
listInstances
in interface AWSServiceDiscovery
public ListNamespacesResult listNamespaces(ListNamespacesRequest request)
AWSServiceDiscovery
Lists summary information about the namespaces that were created by the current Amazon Web Services account.
listNamespaces
in interface AWSServiceDiscovery
public ListOperationsResult listOperations(ListOperationsRequest request)
AWSServiceDiscovery
Lists operations that match the criteria that you specify.
listOperations
in interface AWSServiceDiscovery
public ListServicesResult listServices(ListServicesRequest request)
AWSServiceDiscovery
Lists summary information for all the services that are associated with one or more namespaces.
listServices
in interface AWSServiceDiscovery
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSServiceDiscovery
Lists tags for the specified resource.
listTagsForResource
in interface AWSServiceDiscovery
public RegisterInstanceResult registerInstance(RegisterInstanceRequest request)
AWSServiceDiscovery
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.
registerInstance
in interface AWSServiceDiscovery
public TagResourceResult tagResource(TagResourceRequest request)
AWSServiceDiscovery
Adds one or more tags to the specified resource.
tagResource
in interface AWSServiceDiscovery
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSServiceDiscovery
Removes one or more tags from the specified resource.
untagResource
in interface AWSServiceDiscovery
public UpdateHttpNamespaceResult updateHttpNamespace(UpdateHttpNamespaceRequest request)
AWSServiceDiscovery
Updates an HTTP namespace.
updateHttpNamespace
in interface AWSServiceDiscovery
public UpdateInstanceCustomHealthStatusResult updateInstanceCustomHealthStatus(UpdateInstanceCustomHealthStatusRequest request)
AWSServiceDiscovery
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.
updateInstanceCustomHealthStatus
in interface AWSServiceDiscovery
public UpdatePrivateDnsNamespaceResult updatePrivateDnsNamespace(UpdatePrivateDnsNamespaceRequest request)
AWSServiceDiscovery
Updates a private DNS namespace.
updatePrivateDnsNamespace
in interface AWSServiceDiscovery
public UpdatePublicDnsNamespaceResult updatePublicDnsNamespace(UpdatePublicDnsNamespaceRequest request)
AWSServiceDiscovery
Updates a public DNS namespace.
updatePublicDnsNamespace
in interface AWSServiceDiscovery
public UpdateServiceResult updateService(UpdateServiceRequest request)
AWSServiceDiscovery
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.
updateService
in interface AWSServiceDiscovery
public void shutdown()
AWSServiceDiscovery
shutdown
in interface AWSServiceDiscovery
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSServiceDiscovery
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 a request.
getCachedResponseMetadata
in interface AWSServiceDiscovery
request
- The originally executed request.