ServiceDiscoveryClient Class

Member Function Documentation

ServiceDiscoveryClient::ServiceDiscoveryClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a ServiceDiscoveryClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

ServiceDiscoveryClient::ServiceDiscoveryClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads ServiceDiscoveryClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] CreatePrivateDnsNamespaceResponse *ServiceDiscoveryClient::createPrivateDnsNamespace(const CreatePrivateDnsNamespaceRequest &request)

Sends request to the ServiceDiscoveryClient service, and returns a pointer to an CreatePrivateDnsNamespaceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>example.com</code> and name your service <code>backend</code>, the resulting DNS name for the service will be <code>backend.example.com</code>. For the current limit on the number of namespaces that you can create using the same AWS account, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities-autonaming">Limits on Auto Naming</a> in the <i>Route 53 Developer

[slot] CreatePublicDnsNamespaceResponse *ServiceDiscoveryClient::createPublicDnsNamespace(const CreatePublicDnsNamespaceRequest &request)

Sends request to the ServiceDiscoveryClient service, and returns a pointer to an CreatePublicDnsNamespaceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>example.com</code> and name your service <code>backend</code>, the resulting DNS name for the service will be <code>backend.example.com</code>. For the current limit on the number of namespaces that you can create using the same AWS account, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities-autonaming">Limits on Auto Naming</a> in the <i>Route 53 Developer

[slot] CreateServiceResponse *ServiceDiscoveryClient::createService(const CreateServiceRequest &request)

Sends request to the ServiceDiscoveryClient service, and returns a pointer to an CreateServiceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a service, which defines the configuration for the following

entities> <ul> <li>

Up to three records (A, AAAA, and SRV) or one CNAME

recor> </li> <li>

Optionally, a health

chec> </li> </ul>

After you create the service, you can submit a <a>RegisterInstance</a> 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 <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities-autonaming">Limits on Auto Naming</a> in the <i>Route 53 Developer

[slot] DeleteNamespaceResponse *ServiceDiscoveryClient::deleteNamespace(const DeleteNamespaceRequest &request)

Sends request to the ServiceDiscoveryClient service, and returns a pointer to an DeleteNamespaceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteServiceResponse *ServiceDiscoveryClient::deleteService(const DeleteServiceRequest &request)

Sends request to the ServiceDiscoveryClient service, and returns a pointer to an DeleteServiceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeregisterInstanceResponse *ServiceDiscoveryClient::deregisterInstance(const DeregisterInstanceRequest &request)

Sends request to the ServiceDiscoveryClient service, and returns a pointer to an DeregisterInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the records and the health check, if any, that Amazon Route 53 created for the specified

[slot] GetInstanceResponse *ServiceDiscoveryClient::getInstance(const GetInstanceRequest &request)

Sends request to the ServiceDiscoveryClient service, and returns a pointer to an GetInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about a specified

[slot] GetInstancesHealthStatusResponse *ServiceDiscoveryClient::getInstancesHealthStatus(const GetInstancesHealthStatusRequest &request)

Sends request to the ServiceDiscoveryClient service, and returns a pointer to an GetInstancesHealthStatusResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets the current health status (<code>Healthy</code>, <code>Unhealthy</code>, or <code>Unknown</code>) of one or more instances that are associated with a specified

service> <note>

There is a brief delay between when you register an instance and when the health status for the instance is available.

[slot] GetNamespaceResponse *ServiceDiscoveryClient::getNamespace(const GetNamespaceRequest &request)

Sends request to the ServiceDiscoveryClient service, and returns a pointer to an GetNamespaceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about a

[slot] GetOperationResponse *ServiceDiscoveryClient::getOperation(const GetOperationRequest &request)

Sends request to the ServiceDiscoveryClient service, and returns a pointer to an GetOperationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets information about any operation that returns an operation ID in the response, such as a <code>CreateService</code>

request> <note>

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

[slot] GetServiceResponse *ServiceDiscoveryClient::getService(const GetServiceRequest &request)

Sends request to the ServiceDiscoveryClient service, and returns a pointer to an GetServiceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets the settings for a specified

[slot] ListInstancesResponse *ServiceDiscoveryClient::listInstances(const ListInstancesRequest &request)

Sends request to the ServiceDiscoveryClient service, and returns a pointer to an ListInstancesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListNamespacesResponse *ServiceDiscoveryClient::listNamespaces(const ListNamespacesRequest &request)

Sends request to the ServiceDiscoveryClient service, and returns a pointer to an ListNamespacesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListOperationsResponse *ServiceDiscoveryClient::listOperations(const ListOperationsRequest &request)

Sends request to the ServiceDiscoveryClient service, and returns a pointer to an ListOperationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists operations that match the criteria that you

[slot] ListServicesResponse *ServiceDiscoveryClient::listServices(const ListServicesRequest &request)

Sends request to the ServiceDiscoveryClient service, and returns a pointer to an ListServicesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] RegisterInstanceResponse *ServiceDiscoveryClient::registerInstance(const RegisterInstanceRequest &request)

Sends request to the ServiceDiscoveryClient service, and returns a pointer to an RegisterInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates or updates one or more records and optionally a health check based on the settings in a specified service. When you submit a <code>RegisterInstance</code> request, Amazon Route 53 does the

following> <ul> <li>

For each DNS record that you define in the service specified by <code>ServiceId</code>, creates or updates a record in the hosted zone that is associated with the corresponding

namespac> </li> <li>

If the service includes <code>HealthCheckConfig</code>, creates or updates a health check based on the settings in the health check

configuratio> </li> <li>

Associates the health check, if any, with each of the

record> </li> </ul> <b>

One <code>RegisterInstance</code> request must complete before you can submit another request and specify the same service ID and instance

ID> </b>

For more information, see

<a>CreateService</a>>

When Route 53 receives a DNS query for the specified DNS name, it returns the applicable

value> <ul> <li>

<b>If the health check is healthy</b>: returns all the

record> </li> <li>

<b>If the health check is unhealthy</b>: returns the applicable value for the last healthy

instanc> </li> <li>

<b>If you didn't specify a health check configuration</b>: returns all the

record> </li> </ul>

For the current limit on the number of instances that you can register using the same namespace and using the same service, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities-autonaming">Limits on Auto Naming</a> in the <i>Route 53 Developer

[slot] UpdateInstanceCustomHealthStatusResponse *ServiceDiscoveryClient::updateInstanceCustomHealthStatus(const UpdateInstanceCustomHealthStatusRequest &request)

Sends request to the ServiceDiscoveryClient service, and returns a pointer to an UpdateInstanceCustomHealthStatusResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] UpdateServiceResponse *ServiceDiscoveryClient::updateService(const UpdateServiceRequest &request)

Sends request to the ServiceDiscoveryClient service, and returns a pointer to an UpdateServiceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Submits a request to perform the following

operations> <ul> <li>

Add or delete <code>DnsRecords</code>

configuration> </li> <li>

Update the TTL setting for existing <code>DnsRecords</code>

configuration> </li> <li>

Add, update, or delete <code>HealthCheckConfig</code> for a specified

servic> </li> </ul>

You must specify all <code>DnsRecords</code> configurations (and, optionally, <code>HealthCheckConfig</code>) that you want to appear in the updated service. Any current configurations that don't appear in an <code>UpdateService</code> 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