- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
DAXClient
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.
Installation
npm install @aws-sdk/client-dax
yarn add @aws-sdk/client-dax
pnpm add @aws-sdk/client-dax
DAXClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
CreateClusterCommand | Creates a DAX cluster. All nodes in the cluster run the same DAX caching software. |
CreateParameterGroupCommand | 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. |
CreateSubnetGroupCommand | Creates a new subnet group. |
DecreaseReplicationFactorCommand | Removes one or more nodes from a DAX cluster. You cannot use |
DeleteClusterCommand | 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. |
DeleteParameterGroupCommand | Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters. |
DeleteSubnetGroupCommand | Deletes a subnet group. You cannot delete a subnet group if it is associated with any DAX clusters. |
DescribeClustersCommand | 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. |
DescribeDefaultParametersCommand | Returns the default system parameter information for the DAX caching software. |
DescribeEventsCommand | 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. |
DescribeParameterGroupsCommand | Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group. |
DescribeParametersCommand | Returns the detailed parameter list for a particular parameter group. |
DescribeSubnetGroupsCommand | Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group. |
IncreaseReplicationFactorCommand | Adds one or more nodes to a DAX cluster. |
ListTagsCommand | List all of the tags for a DAX cluster. You can call |
RebootNodeCommand | 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. |
TagResourceCommand | Associates a set of tags with a DAX resource. You can call |
UntagResourceCommand | Removes the association of tags from a DAX resource. You can call |
UpdateClusterCommand | 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. |
UpdateParameterGroupCommand | 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. |
UpdateSubnetGroupCommand | Modifies an existing subnet group. |
DAXClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: DAXClientConfig