Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DAX

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.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly config

The resolved configuration of DAXClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

Methods

createCluster

createParameterGroup

createSubnetGroup

decreaseReplicationFactor

deleteCluster

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

    Parameters

    Returns Promise<DeleteClusterCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: DeleteClusterCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeleteClusterCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

deleteParameterGroup

deleteSubnetGroup

describeClusters

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

    Parameters

    Returns Promise<DescribeClustersCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: DescribeClustersCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DescribeClustersCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

describeDefaultParameters

describeEvents

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

    Parameters

    Returns Promise<DescribeEventsCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: DescribeEventsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DescribeEventsCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

describeParameterGroups

describeParameters

describeSubnetGroups

destroy

  • destroy(): void
  • Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

    Returns void

increaseReplicationFactor

listTags

rebootNode

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

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

    Parameters

    Returns Promise<RebootNodeCommandOutput>

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

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

    Parameters

    Returns void

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

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

    Parameters

    Returns void

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

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

    Parameters

    • args: RebootNodeCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<RebootNodeCommandOutput>

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

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

    Parameters

    Returns void

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

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

    Parameters

    Returns void

send

tagResource

untagResource

updateCluster

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

    Parameters

    Returns Promise<UpdateClusterCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: UpdateClusterCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<UpdateClusterCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

updateParameterGroup

updateSubnetGroup