DaxClient Class

Member Function Documentation

DaxClient::DaxClient(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 DaxClient object.

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

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

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

This function overloads DaxClient().

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] CreateClusterResponse *DaxClient::createCluster(const CreateClusterRequest &request)

Sends request to the DaxClient service, and returns a pointer to an CreateClusterResponse object to track the result.

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

Creates a DAX cluster. All nodes in the cluster run the same DAX caching

[slot] CreateParameterGroupResponse *DaxClient::createParameterGroup(const CreateParameterGroupRequest &request)

Sends request to the DaxClient service, and returns a pointer to an CreateParameterGroupResponse object to track the result.

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

Creates a new parameter group. A parameter group is a collection of parameters that you apply to all of the nodes in a DAX

[slot] CreateSubnetGroupResponse *DaxClient::createSubnetGroup(const CreateSubnetGroupRequest &request)

Sends request to the DaxClient service, and returns a pointer to an CreateSubnetGroupResponse object to track the result.

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

Creates a new subnet

[slot] DecreaseReplicationFactorResponse *DaxClient::decreaseReplicationFactor(const DecreaseReplicationFactorRequest &request)

Sends request to the DaxClient service, and returns a pointer to an DecreaseReplicationFactorResponse object to track the result.

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

Removes one or more nodes from a DAX

cluster> <note>

You cannot use <code>DecreaseReplicationFactor</code> to remove the last node in a DAX cluster. If you need to do this, use <code>DeleteCluster</code>

[slot] DeleteClusterResponse *DaxClient::deleteCluster(const DeleteClusterRequest &request)

Sends request to the DaxClient service, and returns a pointer to an DeleteClusterResponse object to track the result.

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

Deletes a previously provisioned DAX cluster. <i>DeleteCluster</i> deletes all associated nodes, node endpoints and the DAX cluster itself. When you receive a successful response from this action, DAX immediately begins deleting the cluster; you cannot cancel or revert this

[slot] DeleteParameterGroupResponse *DaxClient::deleteParameterGroup(const DeleteParameterGroupRequest &request)

Sends request to the DaxClient service, and returns a pointer to an DeleteParameterGroupResponse object to track the result.

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

Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX

[slot] DeleteSubnetGroupResponse *DaxClient::deleteSubnetGroup(const DeleteSubnetGroupRequest &request)

Sends request to the DaxClient service, and returns a pointer to an DeleteSubnetGroupResponse object to track the result.

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

Deletes a subnet

group> <note>

You cannot delete a subnet group if it is associated with any DAX

[slot] DescribeClustersResponse *DaxClient::describeClusters(const DescribeClustersRequest &request)

Sends request to the DaxClient service, and returns a pointer to an DescribeClustersResponse object to track the result.

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

Returns information about all provisioned DAX clusters if no cluster identifier is specified, or about a specific DAX cluster if a cluster identifier is

supplied>

If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully

provisioned>

If the cluster is in the DELETING state, only cluster level information will be

displayed>

If nodes are currently being added to the DAX cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the DAX cluster state is <i>available</i>, the cluster is ready for

use>

If nodes are currently being removed from the DAX cluster, no endpoint information for the removed nodes is

[slot] DescribeDefaultParametersResponse *DaxClient::describeDefaultParameters(const DescribeDefaultParametersRequest &request)

Sends request to the DaxClient service, and returns a pointer to an DescribeDefaultParametersResponse object to track the result.

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

Returns the default system parameter information for the DAX caching

[slot] DescribeEventsResponse *DaxClient::describeEvents(const DescribeEventsRequest &request)

Sends request to the DaxClient service, and returns a pointer to an DescribeEventsResponse object to track the result.

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

Returns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX cluster or parameter group by providing the name as a

parameter>

By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if

[slot] DescribeParameterGroupsResponse *DaxClient::describeParameterGroups(const DescribeParameterGroupsRequest &request)

Sends request to the DaxClient service, and returns a pointer to an DescribeParameterGroupsResponse object to track the result.

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

Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that

[slot] DescribeParametersResponse *DaxClient::describeParameters(const DescribeParametersRequest &request)

Sends request to the DaxClient service, and returns a pointer to an DescribeParametersResponse object to track the result.

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

Returns the detailed parameter list for a particular parameter

[slot] DescribeSubnetGroupsResponse *DaxClient::describeSubnetGroups(const DescribeSubnetGroupsRequest &request)

Sends request to the DaxClient service, and returns a pointer to an DescribeSubnetGroupsResponse object to track the result.

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

Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that

[slot] IncreaseReplicationFactorResponse *DaxClient::increaseReplicationFactor(const IncreaseReplicationFactorRequest &request)

Sends request to the DaxClient service, and returns a pointer to an IncreaseReplicationFactorResponse object to track the result.

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

Adds one or more nodes to a DAX

[slot] ListTagsResponse *DaxClient::listTags(const ListTagsRequest &request)

Sends request to the DaxClient service, and returns a pointer to an ListTagsResponse object to track the result.

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

List all of the tags for a DAX cluster. You can call <code>ListTags</code> up to 10 times per second, per

[slot] RebootNodeResponse *DaxClient::rebootNode(const RebootNodeRequest &request)

Sends request to the DaxClient service, and returns a pointer to an RebootNodeResponse object to track the result.

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

Reboots a single node of a DAX cluster. The reboot action takes place as soon as possible. During the reboot, the node status is set to

[slot] TagResourceResponse *DaxClient::tagResource(const TagResourceRequest &request)

Sends request to the DaxClient service, and returns a pointer to an TagResourceResponse object to track the result.

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

Associates a set of tags with a DAX resource. You can call <code>TagResource</code> up to 5 times per second, per account.

[slot] UntagResourceResponse *DaxClient::untagResource(const UntagResourceRequest &request)

Sends request to the DaxClient service, and returns a pointer to an UntagResourceResponse object to track the result.

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

Removes the association of tags from a DAX resource. You can call <code>UntagResource</code> up to 5 times per second, per account.

[slot] UpdateClusterResponse *DaxClient::updateCluster(const UpdateClusterRequest &request)

Sends request to the DaxClient service, and returns a pointer to an UpdateClusterResponse object to track the result.

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

Modifies the settings for a DAX cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new

[slot] UpdateParameterGroupResponse *DaxClient::updateParameterGroup(const UpdateParameterGroupRequest &request)

Sends request to the DaxClient service, and returns a pointer to an UpdateParameterGroupResponse object to track the result.

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

Modifies the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value

[slot] UpdateSubnetGroupResponse *DaxClient::updateSubnetGroup(const UpdateSubnetGroupRequest &request)

Sends request to the DaxClient service, and returns a pointer to an UpdateSubnetGroupResponse object to track the result.

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

Modifies an existing subnet