AWS.DAX (aws-elixir v0.8.0) View Source

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.

Link to this section Summary

Functions

Removes one or more nodes from a DAX cluster.

Deletes a previously provisioned DAX cluster.

Deletes the specified parameter group.

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.

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

Returns events related to DAX clusters and parameter groups.

Returns a list of parameter group descriptions.

Returns the detailed parameter list for a particular parameter group.

Returns a list of subnet group descriptions.

Adds one or more nodes to a DAX cluster.

List all of the tags for a DAX cluster.

Reboots a single node of a DAX cluster.

Associates a set of tags with a DAX resource.

Removes the association of tags from a DAX resource.

Modifies the settings for a DAX cluster.

Modifies the parameters of a parameter group.

Modifies an existing subnet group.

Link to this section Functions

Link to this function

create_cluster(client, input, options \\ [])

View Source

Creates a DAX cluster.

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

Link to this function

create_parameter_group(client, input, options \\ [])

View Source

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.

Link to this function

create_subnet_group(client, input, options \\ [])

View Source

Creates a new subnet group.

Link to this function

decrease_replication_factor(client, input, options \\ [])

View Source

Removes one or more nodes from a DAX cluster.

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

Link to this function

delete_cluster(client, input, options \\ [])

View Source

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.

Link to this function

delete_parameter_group(client, input, options \\ [])

View Source

Deletes the specified parameter group.

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

Link to this function

delete_subnet_group(client, input, options \\ [])

View Source

Deletes a subnet group.

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

Link to this function

describe_clusters(client, input, options \\ [])

View Source

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.

Link to this function

describe_default_parameters(client, input, options \\ [])

View Source

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

Link to this function

describe_events(client, input, options \\ [])

View Source

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.

Link to this function

describe_parameter_groups(client, input, options \\ [])

View Source

Returns a list of parameter group descriptions.

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

Link to this function

describe_parameters(client, input, options \\ [])

View Source

Returns the detailed parameter list for a particular parameter group.

Link to this function

describe_subnet_groups(client, input, options \\ [])

View Source

Returns a list of subnet group descriptions.

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

Link to this function

increase_replication_factor(client, input, options \\ [])

View Source

Adds one or more nodes to a DAX cluster.

Link to this function

list_tags(client, input, options \\ [])

View Source

List all of the tags for a DAX cluster.

You can call ListTags up to 10 times per second, per account.

Link to this function

reboot_node(client, input, options \\ [])

View Source

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.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Associates a set of tags with a DAX resource.

You can call TagResource up to 5 times per second, per account.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes the association of tags from a DAX resource.

You can call UntagResource up to 5 times per second, per account.

Link to this function

update_cluster(client, input, options \\ [])

View Source

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.

Link to this function

update_parameter_group(client, input, options \\ [])

View Source

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.

Link to this function

update_subnet_group(client, input, options \\ [])

View Source

Modifies an existing subnet group.