AWS.DAX — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.DAX

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

DAX is a managed caching service engineered for Amazon DynamoDB. DAX dramatically speeds up database reads by caching frequently-accessed data from DynamoDB, so applications can access that data with sub-millisecond latency. You can create a DAX cluster easily, using the AWS Management Console. With a few simple modifications to your code, your application can begin taking advantage of the DAX cluster and realize significant improvements in read performance.

Sending a Request Using DAX

var dax = new AWS.DAX();
dax.createCluster(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the DAX object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var dax = new AWS.DAX({apiVersion: '2017-04-19'});

You can also set the API version globally in AWS.config.apiVersions using the dax service identifier:

AWS.config.apiVersions = {
  dax: '2017-04-19',
  // other service API versions
};

var dax = new AWS.DAX();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.DAX(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createCluster(params = {}, callback) ⇒ AWS.Request

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

createParameterGroup(params = {}, callback) ⇒ AWS.Request

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

createSubnetGroup(params = {}, callback) ⇒ AWS.Request

Creates a new subnet group.

decreaseReplicationFactor(params = {}, callback) ⇒ AWS.Request

Removes one or more nodes from a DAX cluster.

Note: You cannot use DecreaseReplicationFactor to remove the last node in a DAX cluster. If you need to do this, use DeleteCluster instead.

deleteCluster(params = {}, callback) ⇒ AWS.Request

Deletes a previously provisioned DAX cluster. DeleteCluster 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 action.

deleteParameterGroup(params = {}, callback) ⇒ AWS.Request

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

deleteSubnetGroup(params = {}, callback) ⇒ AWS.Request

Deletes a subnet group.

Note: You cannot delete a subnet group if it is associated with any DAX clusters.

describeClusters(params = {}, callback) ⇒ AWS.Request

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 available, the cluster is ready for use.

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

describeDefaultParameters(params = {}, callback) ⇒ AWS.Request

Returns the default system parameter information for the DAX caching software.

describeEvents(params = {}, callback) ⇒ AWS.Request

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 24 hours are returned; however, you can retrieve up to 14 days' worth of events if necessary.

describeParameterGroups(params = {}, callback) ⇒ AWS.Request

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

describeParameters(params = {}, callback) ⇒ AWS.Request

Returns the detailed parameter list for a particular parameter group.

describeSubnetGroups(params = {}, callback) ⇒ AWS.Request

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

increaseReplicationFactor(params = {}, callback) ⇒ AWS.Request

Adds one or more nodes to a DAX cluster.

listTags(params = {}, callback) ⇒ AWS.Request

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

rebootNode(params = {}, callback) ⇒ AWS.Request

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 REBOOTING.

Note: RebootNode restarts the DAX engine process and does not remove the contents of the cache.

tagResource(params = {}, callback) ⇒ AWS.Request

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

untagResource(params = {}, callback) ⇒ AWS.Request

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

updateCluster(params = {}, callback) ⇒ AWS.Request

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 values.

updateParameterGroup(params = {}, callback) ⇒ AWS.Request

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 pairs.

updateSubnetGroup(params = {}, callback) ⇒ AWS.Request

Modifies an existing subnet group.