com.amazonaws.services.servicediscovery

Class AbstractAWSServiceDiscovery

java.lang.Object

com.amazonaws.services.servicediscovery.AbstractAWSServiceDiscovery

All Implemented Interfaces:

AWSServiceDiscovery

Direct Known Subclasses:

AbstractAWSServiceDiscoveryAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSServiceDiscovery
extends Object
implements AWSServiceDiscovery

Abstract implementation of AWSServiceDiscovery. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.servicediscovery.AWSServiceDiscovery

ENDPOINT_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAWSServiceDiscovery()

Method Summary

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 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 Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified instance.
DiscoverInstancesResult	discoverInstances(DiscoverInstancesRequest request) Discovers registered instances for a specified namespace and service.
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, 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.
UpdateInstanceCustomHealthStatusResult	updateInstanceCustomHealthStatus(UpdateInstanceCustomHealthStatusRequest request) Submits a request to change the health status of a custom health check to healthy or unhealthy.
UpdateServiceResult	updateService(UpdateServiceRequest request) Submits a request to perform the following operations:

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractAWSServiceDiscovery

protected AbstractAWSServiceDiscovery()

Method Detail

createHttpNamespace

public CreateHttpNamespaceResult createHttpNamespace(CreateHttpNamespaceRequest request)

Description copied from interface: AWSServiceDiscovery

Creates an HTTP namespace. Service instances that you register using an HTTP namespace can be discovered using a DiscoverInstances request but can't be discovered using DNS.

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

Specified by:

createHttpNamespace in interface AWSServiceDiscovery

Returns:

Result of the CreateHttpNamespace operation returned by the service.

See Also:

AWS API Documentation

createPrivateDnsNamespace

public CreatePrivateDnsNamespaceResult createPrivateDnsNamespace(CreatePrivateDnsNamespaceRequest request)

Description copied from interface: AWSServiceDiscovery

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 AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

Specified by:

createPrivateDnsNamespace in interface AWSServiceDiscovery

Returns:

Result of the CreatePrivateDnsNamespace operation returned by the service.

See Also:

AWS API Documentation

createPublicDnsNamespace

public CreatePublicDnsNamespaceResult createPublicDnsNamespace(CreatePublicDnsNamespaceRequest request)

Description copied from interface: AWSServiceDiscovery

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 AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

Specified by:

createPublicDnsNamespace in interface AWSServiceDiscovery

Returns:

Result of the CreatePublicDnsNamespace operation returned by the service.

See Also:

AWS API Documentation

createService

public CreateServiceResult createService(CreateServiceRequest request)

Description copied from interface: AWSServiceDiscovery

Creates a service, which 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 AWS Cloud Map 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 AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

Specified by:

createService in interface AWSServiceDiscovery

Returns:

Result of the CreateService operation returned by the service.

See Also:

AWS API Documentation

deleteNamespace

public DeleteNamespaceResult deleteNamespace(DeleteNamespaceRequest request)

Description copied from interface: AWSServiceDiscovery

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

Specified by:

deleteNamespace in interface AWSServiceDiscovery

Returns:

Result of the DeleteNamespace operation returned by the service.

See Also:

AWS API Documentation

deleteService

public DeleteServiceResult deleteService(DeleteServiceRequest request)

Description copied from interface: AWSServiceDiscovery

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

Specified by:

deleteService in interface AWSServiceDiscovery

Returns:

Result of the DeleteService operation returned by the service.

See Also:

AWS API Documentation

deregisterInstance

public DeregisterInstanceResult deregisterInstance(DeregisterInstanceRequest request)

Description copied from interface: AWSServiceDiscovery

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

Specified by:

deregisterInstance in interface AWSServiceDiscovery

Returns:

Result of the DeregisterInstance operation returned by the service.

See Also:

AWS API Documentation

discoverInstances

public DiscoverInstancesResult discoverInstances(DiscoverInstancesRequest request)

Description copied from interface: AWSServiceDiscovery

Discovers registered instances for a specified namespace and service.

Specified by:

discoverInstances in interface AWSServiceDiscovery

Returns:

Result of the DiscoverInstances operation returned by the service.

See Also:

AWS API Documentation

getInstance

public GetInstanceResult getInstance(GetInstanceRequest request)

Description copied from interface: AWSServiceDiscovery

Gets information about a specified instance.

Specified by:

getInstance in interface AWSServiceDiscovery

Returns:

Result of the GetInstance operation returned by the service.

See Also:

AWS API Documentation

getInstancesHealthStatus

public GetInstancesHealthStatusResult getInstancesHealthStatus(GetInstancesHealthStatusRequest request)

Description copied from interface: AWSServiceDiscovery

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.

Specified by:

getInstancesHealthStatus in interface AWSServiceDiscovery

Returns:

Result of the GetInstancesHealthStatus operation returned by the service.

See Also:

AWS API Documentation

getNamespace

public GetNamespaceResult getNamespace(GetNamespaceRequest request)

Description copied from interface: AWSServiceDiscovery

Gets information about a namespace.

Specified by:

getNamespace in interface AWSServiceDiscovery

Returns:

Result of the GetNamespace operation returned by the service.

See Also:

AWS API Documentation

getOperation

public GetOperationResult getOperation(GetOperationRequest request)

Description copied from interface: AWSServiceDiscovery

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.

Specified by:

getOperation in interface AWSServiceDiscovery

Returns:

Result of the GetOperation operation returned by the service.

See Also:

AWS API Documentation

getService

public GetServiceResult getService(GetServiceRequest request)

Description copied from interface: AWSServiceDiscovery

Gets the settings for a specified service.

Specified by:

getService in interface AWSServiceDiscovery

Returns:

Result of the GetService operation returned by the service.

See Also:

AWS API Documentation

listInstances

public ListInstancesResult listInstances(ListInstancesRequest request)

Description copied from interface: AWSServiceDiscovery

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

Specified by:

listInstances in interface AWSServiceDiscovery

Returns:

Result of the ListInstances operation returned by the service.

See Also:

AWS API Documentation

listNamespaces

public ListNamespacesResult listNamespaces(ListNamespacesRequest request)

Description copied from interface: AWSServiceDiscovery

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

Specified by:

listNamespaces in interface AWSServiceDiscovery

Returns:

Result of the ListNamespaces operation returned by the service.

See Also:

AWS API Documentation

listOperations

public ListOperationsResult listOperations(ListOperationsRequest request)

Description copied from interface: AWSServiceDiscovery

Lists operations that match the criteria that you specify.

Specified by:

listOperations in interface AWSServiceDiscovery

Returns:

Result of the ListOperations operation returned by the service.

See Also:

AWS API Documentation

listServices

public ListServicesResult listServices(ListServicesRequest request)

Description copied from interface: AWSServiceDiscovery

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

Specified by:

listServices in interface AWSServiceDiscovery

Returns:

Result of the ListServices operation returned by the service.

See Also:

AWS API Documentation

registerInstance

public RegisterInstanceResult registerInstance(RegisterInstanceRequest request)

Description copied from interface: 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 is specified by ServiceId, a record is created or updated in the hosted zone that is 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 AWS 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 limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

Specified by:

registerInstance in interface AWSServiceDiscovery

Returns:

Result of the RegisterInstance operation returned by the service.

See Also:

AWS API Documentation

updateInstanceCustomHealthStatus

public UpdateInstanceCustomHealthStatusResult updateInstanceCustomHealthStatus(UpdateInstanceCustomHealthStatusRequest request)

Description copied from interface: 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.

Specified by:

updateInstanceCustomHealthStatus in interface AWSServiceDiscovery

Returns:

Result of the UpdateInstanceCustomHealthStatus operation returned by the service.

See Also:

AWS API Documentation

updateService

public UpdateServiceResult updateService(UpdateServiceRequest request)

Description copied from interface: AWSServiceDiscovery

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

For public and private DNS namespaces, 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, AWS Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service.

Specified by:

updateService in interface AWSServiceDiscovery

Returns:

Result of the UpdateService operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AWSServiceDiscovery

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSServiceDiscovery

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AWSServiceDiscovery

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Specified by:

getCachedResponseMetadata in interface AWSServiceDiscovery

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.