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

DAXClient
- DAX

Constructors

constructor

new DAX(configuration: DAXClientConfig): DAX
Parameters
- configuration: DAXClientConfig
Returns DAX
Inherited from DAXClient.constructor
- Defined in ../../../../../clients/client-dax/src/DAXClient.ts:319

Properties

`Readonly` config

config: DAXClientResolvedConfig

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

middlewareStack

middlewareStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>

Methods

createCluster

createCluster(args: CreateClusterCommandInput, options?: HttpHandlerOptions): Promise<CreateClusterCommandOutput>
Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.
Parameters
- args: CreateClusterCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<CreateClusterCommandOutput>
- Defined in ../../../../../clients/client-dax/src/DAX.ts:111
createCluster(args: CreateClusterCommandInput, cb: ((err: any, data?: CreateClusterCommandOutput) => void)): void
Parameters
- args: CreateClusterCommandInput
- cb: ((err: any, data?: CreateClusterCommandOutput) => void)
  - - (err: any, data?: CreateClusterCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateClusterCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:115
createCluster(args: CreateClusterCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: CreateClusterCommandOutput) => void)): void
Parameters
- args: CreateClusterCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: CreateClusterCommandOutput) => void)
  - - (err: any, data?: CreateClusterCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateClusterCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:119

createParameterGroup

createParameterGroup(args: CreateParameterGroupCommandInput, options?: HttpHandlerOptions): Promise<CreateParameterGroupCommandOutput>
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.
Parameters
- args: CreateParameterGroupCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<CreateParameterGroupCommandOutput>
- Defined in ../../../../../clients/client-dax/src/DAX.ts:144
createParameterGroup(args: CreateParameterGroupCommandInput, cb: ((err: any, data?: CreateParameterGroupCommandOutput) => void)): void
Parameters
- args: CreateParameterGroupCommandInput
- cb: ((err: any, data?: CreateParameterGroupCommandOutput) => void)
  - - (err: any, data?: CreateParameterGroupCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateParameterGroupCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:148
createParameterGroup(args: CreateParameterGroupCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: CreateParameterGroupCommandOutput) => void)): void
Parameters
- args: CreateParameterGroupCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: CreateParameterGroupCommandOutput) => void)
  - - (err: any, data?: CreateParameterGroupCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateParameterGroupCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:152

createSubnetGroup

createSubnetGroup(args: CreateSubnetGroupCommandInput, options?: HttpHandlerOptions): Promise<CreateSubnetGroupCommandOutput>
Creates a new subnet group.
Parameters
- args: CreateSubnetGroupCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<CreateSubnetGroupCommandOutput>
- Defined in ../../../../../clients/client-dax/src/DAX.ts:176
createSubnetGroup(args: CreateSubnetGroupCommandInput, cb: ((err: any, data?: CreateSubnetGroupCommandOutput) => void)): void
Parameters
- args: CreateSubnetGroupCommandInput
- cb: ((err: any, data?: CreateSubnetGroupCommandOutput) => void)
  - - (err: any, data?: CreateSubnetGroupCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateSubnetGroupCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:180
createSubnetGroup(args: CreateSubnetGroupCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: CreateSubnetGroupCommandOutput) => void)): void
Parameters
- args: CreateSubnetGroupCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: CreateSubnetGroupCommandOutput) => void)
  - - (err: any, data?: CreateSubnetGroupCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: CreateSubnetGroupCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:184

decreaseReplicationFactor

decreaseReplicationFactor(args: DecreaseReplicationFactorCommandInput, options?: HttpHandlerOptions): Promise<DecreaseReplicationFactorCommandOutput>
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.
Parameters
- args: DecreaseReplicationFactorCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DecreaseReplicationFactorCommandOutput>
- Defined in ../../../../../clients/client-dax/src/DAX.ts:211
decreaseReplicationFactor(args: DecreaseReplicationFactorCommandInput, cb: ((err: any, data?: DecreaseReplicationFactorCommandOutput) => void)): void
Parameters
- args: DecreaseReplicationFactorCommandInput
- cb: ((err: any, data?: DecreaseReplicationFactorCommandOutput) => void)
  - - (err: any, data?: DecreaseReplicationFactorCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DecreaseReplicationFactorCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:215
decreaseReplicationFactor(args: DecreaseReplicationFactorCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DecreaseReplicationFactorCommandOutput) => void)): void
Parameters
- args: DecreaseReplicationFactorCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DecreaseReplicationFactorCommandOutput) => void)
  - - (err: any, data?: DecreaseReplicationFactorCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DecreaseReplicationFactorCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:219

deleteCluster

deleteCluster(args: DeleteClusterCommandInput, options?: HttpHandlerOptions): 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
- args: DeleteClusterCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DeleteClusterCommandOutput>
- Defined in ../../../../../clients/client-dax/src/DAX.ts:247
deleteCluster(args: DeleteClusterCommandInput, cb: ((err: any, data?: DeleteClusterCommandOutput) => void)): void
Parameters
- args: DeleteClusterCommandInput
- cb: ((err: any, data?: DeleteClusterCommandOutput) => void)
  - - (err: any, data?: DeleteClusterCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteClusterCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:251
deleteCluster(args: DeleteClusterCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DeleteClusterCommandOutput) => void)): void
Parameters
- args: DeleteClusterCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DeleteClusterCommandOutput) => void)
  - - (err: any, data?: DeleteClusterCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteClusterCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:255

deleteParameterGroup

deleteParameterGroup(args: DeleteParameterGroupCommandInput, options?: HttpHandlerOptions): Promise<DeleteParameterGroupCommandOutput>
Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters.
Parameters
- args: DeleteParameterGroupCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DeleteParameterGroupCommandOutput>
- Defined in ../../../../../clients/client-dax/src/DAX.ts:280
deleteParameterGroup(args: DeleteParameterGroupCommandInput, cb: ((err: any, data?: DeleteParameterGroupCommandOutput) => void)): void
Parameters
- args: DeleteParameterGroupCommandInput
- cb: ((err: any, data?: DeleteParameterGroupCommandOutput) => void)
  - - (err: any, data?: DeleteParameterGroupCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteParameterGroupCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:284
deleteParameterGroup(args: DeleteParameterGroupCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DeleteParameterGroupCommandOutput) => void)): void
Parameters
- args: DeleteParameterGroupCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DeleteParameterGroupCommandOutput) => void)
  - - (err: any, data?: DeleteParameterGroupCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteParameterGroupCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:288

deleteSubnetGroup

deleteSubnetGroup(args: DeleteSubnetGroupCommandInput, options?: HttpHandlerOptions): Promise<DeleteSubnetGroupCommandOutput>
Deletes a subnet group.

You cannot delete a subnet group if it is associated with any DAX clusters.
Parameters
- args: DeleteSubnetGroupCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DeleteSubnetGroupCommandOutput>
- Defined in ../../../../../clients/client-dax/src/DAX.ts:316
deleteSubnetGroup(args: DeleteSubnetGroupCommandInput, cb: ((err: any, data?: DeleteSubnetGroupCommandOutput) => void)): void
Parameters
- args: DeleteSubnetGroupCommandInput
- cb: ((err: any, data?: DeleteSubnetGroupCommandOutput) => void)
  - - (err: any, data?: DeleteSubnetGroupCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteSubnetGroupCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:320
deleteSubnetGroup(args: DeleteSubnetGroupCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DeleteSubnetGroupCommandOutput) => void)): void
Parameters
- args: DeleteSubnetGroupCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DeleteSubnetGroupCommandOutput) => void)
  - - (err: any, data?: DeleteSubnetGroupCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DeleteSubnetGroupCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:324

describeClusters

describeClusters(args: DescribeClustersCommandInput, options?: HttpHandlerOptions): 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
- args: DescribeClustersCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DescribeClustersCommandOutput>
- Defined in ../../../../../clients/client-dax/src/DAX.ts:360
describeClusters(args: DescribeClustersCommandInput, cb: ((err: any, data?: DescribeClustersCommandOutput) => void)): void
Parameters
- args: DescribeClustersCommandInput
- cb: ((err: any, data?: DescribeClustersCommandOutput) => void)
  - - (err: any, data?: DescribeClustersCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeClustersCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:364
describeClusters(args: DescribeClustersCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DescribeClustersCommandOutput) => void)): void
Parameters
- args: DescribeClustersCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DescribeClustersCommandOutput) => void)
  - - (err: any, data?: DescribeClustersCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeClustersCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:368

describeDefaultParameters

describeDefaultParameters(args: DescribeDefaultParametersCommandInput, options?: HttpHandlerOptions): Promise<DescribeDefaultParametersCommandOutput>
Returns the default system parameter information for the DAX caching software.
Parameters
- args: DescribeDefaultParametersCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DescribeDefaultParametersCommandOutput>
- Defined in ../../../../../clients/client-dax/src/DAX.ts:393
describeDefaultParameters(args: DescribeDefaultParametersCommandInput, cb: ((err: any, data?: DescribeDefaultParametersCommandOutput) => void)): void
Parameters
- args: DescribeDefaultParametersCommandInput
- cb: ((err: any, data?: DescribeDefaultParametersCommandOutput) => void)
  - - (err: any, data?: DescribeDefaultParametersCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeDefaultParametersCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:397
describeDefaultParameters(args: DescribeDefaultParametersCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DescribeDefaultParametersCommandOutput) => void)): void
Parameters
- args: DescribeDefaultParametersCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DescribeDefaultParametersCommandOutput) => void)
  - - (err: any, data?: DescribeDefaultParametersCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeDefaultParametersCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:401

describeEvents

describeEvents(args: DescribeEventsCommandInput, options?: HttpHandlerOptions): 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
- args: DescribeEventsCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DescribeEventsCommandOutput>
- Defined in ../../../../../clients/client-dax/src/DAX.ts:429
describeEvents(args: DescribeEventsCommandInput, cb: ((err: any, data?: DescribeEventsCommandOutput) => void)): void
Parameters
- args: DescribeEventsCommandInput
- cb: ((err: any, data?: DescribeEventsCommandOutput) => void)
  - - (err: any, data?: DescribeEventsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeEventsCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:433
describeEvents(args: DescribeEventsCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DescribeEventsCommandOutput) => void)): void
Parameters
- args: DescribeEventsCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DescribeEventsCommandOutput) => void)
  - - (err: any, data?: DescribeEventsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeEventsCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:437

describeParameterGroups

describeParameterGroups(args: DescribeParameterGroupsCommandInput, options?: HttpHandlerOptions): Promise<DescribeParameterGroupsCommandOutput>
Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group.
Parameters
- args: DescribeParameterGroupsCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DescribeParameterGroupsCommandOutput>
- Defined in ../../../../../clients/client-dax/src/DAX.ts:462
describeParameterGroups(args: DescribeParameterGroupsCommandInput, cb: ((err: any, data?: DescribeParameterGroupsCommandOutput) => void)): void
Parameters
- args: DescribeParameterGroupsCommandInput
- cb: ((err: any, data?: DescribeParameterGroupsCommandOutput) => void)
  - - (err: any, data?: DescribeParameterGroupsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeParameterGroupsCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:466
describeParameterGroups(args: DescribeParameterGroupsCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DescribeParameterGroupsCommandOutput) => void)): void
Parameters
- args: DescribeParameterGroupsCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DescribeParameterGroupsCommandOutput) => void)
  - - (err: any, data?: DescribeParameterGroupsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeParameterGroupsCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:470

describeParameters

describeParameters(args: DescribeParametersCommandInput, options?: HttpHandlerOptions): Promise<DescribeParametersCommandOutput>
Returns the detailed parameter list for a particular parameter group.
Parameters
- args: DescribeParametersCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DescribeParametersCommandOutput>
- Defined in ../../../../../clients/client-dax/src/DAX.ts:494
describeParameters(args: DescribeParametersCommandInput, cb: ((err: any, data?: DescribeParametersCommandOutput) => void)): void
Parameters
- args: DescribeParametersCommandInput
- cb: ((err: any, data?: DescribeParametersCommandOutput) => void)
  - - (err: any, data?: DescribeParametersCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeParametersCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:498
describeParameters(args: DescribeParametersCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DescribeParametersCommandOutput) => void)): void
Parameters
- args: DescribeParametersCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DescribeParametersCommandOutput) => void)
  - - (err: any, data?: DescribeParametersCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeParametersCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:502

describeSubnetGroups

describeSubnetGroups(args: DescribeSubnetGroupsCommandInput, options?: HttpHandlerOptions): Promise<DescribeSubnetGroupsCommandOutput>
Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.
Parameters
- args: DescribeSubnetGroupsCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<DescribeSubnetGroupsCommandOutput>
- Defined in ../../../../../clients/client-dax/src/DAX.ts:527
describeSubnetGroups(args: DescribeSubnetGroupsCommandInput, cb: ((err: any, data?: DescribeSubnetGroupsCommandOutput) => void)): void
Parameters
- args: DescribeSubnetGroupsCommandInput
- cb: ((err: any, data?: DescribeSubnetGroupsCommandOutput) => void)
  - - (err: any, data?: DescribeSubnetGroupsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeSubnetGroupsCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:531
describeSubnetGroups(args: DescribeSubnetGroupsCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: DescribeSubnetGroupsCommandOutput) => void)): void
Parameters
- args: DescribeSubnetGroupsCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: DescribeSubnetGroupsCommandOutput) => void)
  - - (err: any, data?: DescribeSubnetGroupsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: DescribeSubnetGroupsCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:535

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
Inherited from DAXClient.destroy
- Defined in ../../../../../clients/client-dax/src/DAXClient.ts:344

increaseReplicationFactor

increaseReplicationFactor(args: IncreaseReplicationFactorCommandInput, options?: HttpHandlerOptions): Promise<IncreaseReplicationFactorCommandOutput>
Adds one or more nodes to a DAX cluster.
Parameters
- args: IncreaseReplicationFactorCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<IncreaseReplicationFactorCommandOutput>
- Defined in ../../../../../clients/client-dax/src/DAX.ts:559
increaseReplicationFactor(args: IncreaseReplicationFactorCommandInput, cb: ((err: any, data?: IncreaseReplicationFactorCommandOutput) => void)): void
Parameters
- args: IncreaseReplicationFactorCommandInput
- cb: ((err: any, data?: IncreaseReplicationFactorCommandOutput) => void)
  - - (err: any, data?: IncreaseReplicationFactorCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: IncreaseReplicationFactorCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:563
increaseReplicationFactor(args: IncreaseReplicationFactorCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: IncreaseReplicationFactorCommandOutput) => void)): void
Parameters
- args: IncreaseReplicationFactorCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: IncreaseReplicationFactorCommandOutput) => void)
  - - (err: any, data?: IncreaseReplicationFactorCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: IncreaseReplicationFactorCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:567

listTags

listTags(args: ListTagsCommandInput, options?: HttpHandlerOptions): Promise<ListTagsCommandOutput>
List all of the tags for a DAX cluster. You can call ListTags up to 10 times per second, per account.
Parameters
- args: ListTagsCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<ListTagsCommandOutput>
- Defined in ../../../../../clients/client-dax/src/DAX.ts:592
listTags(args: ListTagsCommandInput, cb: ((err: any, data?: ListTagsCommandOutput) => void)): void
Parameters
- args: ListTagsCommandInput
- cb: ((err: any, data?: ListTagsCommandOutput) => void)
  - - (err: any, data?: ListTagsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListTagsCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:593
listTags(args: ListTagsCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: ListTagsCommandOutput) => void)): void
Parameters
- args: ListTagsCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: ListTagsCommandOutput) => void)
  - - (err: any, data?: ListTagsCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: ListTagsCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:594

rebootNode

rebootNode(args: RebootNodeCommandInput, options?: HttpHandlerOptions): 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
- args: RebootNodeCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<RebootNodeCommandOutput>
- Defined in ../../../../../clients/client-dax/src/DAX.ts:624
rebootNode(args: RebootNodeCommandInput, cb: ((err: any, data?: RebootNodeCommandOutput) => void)): void
Parameters
- args: RebootNodeCommandInput
- cb: ((err: any, data?: RebootNodeCommandOutput) => void)
  - - (err: any, data?: RebootNodeCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: RebootNodeCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:625
rebootNode(args: RebootNodeCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: RebootNodeCommandOutput) => void)): void
Parameters
- args: RebootNodeCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: RebootNodeCommandOutput) => void)
  - - (err: any, data?: RebootNodeCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: RebootNodeCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:626

send

send<InputType, OutputType>(command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<HttpHandlerOptions>>, options?: HttpHandlerOptions): Promise<OutputType>
Type Parameters
- InputType extends ServiceInputTypes
- OutputType extends ServiceOutputTypes
Parameters
- command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<HttpHandlerOptions>>
- Optional options: HttpHandlerOptions
Returns Promise<OutputType>
Inherited from DAXClient.send
- Defined in ../../../../../packages/smithy-client/dist-types/client.d.ts:25
send<InputType, OutputType>(command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<HttpHandlerOptions>>, cb: ((err: any, data?: OutputType) => void)): void
Type Parameters
- InputType extends ServiceInputTypes
- OutputType extends ServiceOutputTypes
Parameters
- command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<HttpHandlerOptions>>
- cb: ((err: any, data?: OutputType) => void)
  - - (err: any, data?: OutputType): void
    - Parameters
      
      err: any
      
      Optional data: OutputType
      
      Returns void
Returns void
Inherited from DAXClient.send
- Defined in ../../../../../packages/smithy-client/dist-types/client.d.ts:26
send<InputType, OutputType>(command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<HttpHandlerOptions>>, options: HttpHandlerOptions, cb: ((err: any, data?: OutputType) => void)): void
Type Parameters
- InputType extends ServiceInputTypes
- OutputType extends ServiceOutputTypes
Parameters
- command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<HttpHandlerOptions>>
- options: HttpHandlerOptions
- cb: ((err: any, data?: OutputType) => void)
  - - (err: any, data?: OutputType): void
    - Parameters
      
      err: any
      
      Optional data: OutputType
      
      Returns void
Returns void
Inherited from DAXClient.send
- Defined in ../../../../../packages/smithy-client/dist-types/client.d.ts:27

tagResource

tagResource(args: TagResourceCommandInput, options?: HttpHandlerOptions): Promise<TagResourceCommandOutput>
Associates a set of tags with a DAX resource. You can call TagResource up to 5 times per second, per account.
Parameters
- args: TagResourceCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<TagResourceCommandOutput>
- Defined in ../../../../../clients/client-dax/src/DAX.ts:651
tagResource(args: TagResourceCommandInput, cb: ((err: any, data?: TagResourceCommandOutput) => void)): void
Parameters
- args: TagResourceCommandInput
- cb: ((err: any, data?: TagResourceCommandOutput) => void)
  - - (err: any, data?: TagResourceCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: TagResourceCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:652
tagResource(args: TagResourceCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: TagResourceCommandOutput) => void)): void
Parameters
- args: TagResourceCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: TagResourceCommandOutput) => void)
  - - (err: any, data?: TagResourceCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: TagResourceCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:653

untagResource

untagResource(args: UntagResourceCommandInput, options?: HttpHandlerOptions): Promise<UntagResourceCommandOutput>
Removes the association of tags from a DAX resource. You can call UntagResource up to 5 times per second, per account.
Parameters
- args: UntagResourceCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<UntagResourceCommandOutput>
- Defined in ../../../../../clients/client-dax/src/DAX.ts:678
untagResource(args: UntagResourceCommandInput, cb: ((err: any, data?: UntagResourceCommandOutput) => void)): void
Parameters
- args: UntagResourceCommandInput
- cb: ((err: any, data?: UntagResourceCommandOutput) => void)
  - - (err: any, data?: UntagResourceCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UntagResourceCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:682
untagResource(args: UntagResourceCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: UntagResourceCommandOutput) => void)): void
Parameters
- args: UntagResourceCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: UntagResourceCommandOutput) => void)
  - - (err: any, data?: UntagResourceCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UntagResourceCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:686

updateCluster

updateCluster(args: UpdateClusterCommandInput, options?: HttpHandlerOptions): 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
- args: UpdateClusterCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<UpdateClusterCommandOutput>
- Defined in ../../../../../clients/client-dax/src/DAX.ts:712
updateCluster(args: UpdateClusterCommandInput, cb: ((err: any, data?: UpdateClusterCommandOutput) => void)): void
Parameters
- args: UpdateClusterCommandInput
- cb: ((err: any, data?: UpdateClusterCommandOutput) => void)
  - - (err: any, data?: UpdateClusterCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateClusterCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:716
updateCluster(args: UpdateClusterCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: UpdateClusterCommandOutput) => void)): void
Parameters
- args: UpdateClusterCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: UpdateClusterCommandOutput) => void)
  - - (err: any, data?: UpdateClusterCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateClusterCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:720

updateParameterGroup

updateParameterGroup(args: UpdateParameterGroupCommandInput, options?: HttpHandlerOptions): Promise<UpdateParameterGroupCommandOutput>
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.
Parameters
- args: UpdateParameterGroupCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<UpdateParameterGroupCommandOutput>
- Defined in ../../../../../clients/client-dax/src/DAX.ts:746
updateParameterGroup(args: UpdateParameterGroupCommandInput, cb: ((err: any, data?: UpdateParameterGroupCommandOutput) => void)): void
Parameters
- args: UpdateParameterGroupCommandInput
- cb: ((err: any, data?: UpdateParameterGroupCommandOutput) => void)
  - - (err: any, data?: UpdateParameterGroupCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateParameterGroupCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:750
updateParameterGroup(args: UpdateParameterGroupCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: UpdateParameterGroupCommandOutput) => void)): void
Parameters
- args: UpdateParameterGroupCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: UpdateParameterGroupCommandOutput) => void)
  - - (err: any, data?: UpdateParameterGroupCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateParameterGroupCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:754

updateSubnetGroup

updateSubnetGroup(args: UpdateSubnetGroupCommandInput, options?: HttpHandlerOptions): Promise<UpdateSubnetGroupCommandOutput>
Modifies an existing subnet group.
Parameters
- args: UpdateSubnetGroupCommandInput
- Optional options: HttpHandlerOptions
Returns Promise<UpdateSubnetGroupCommandOutput>
- Defined in ../../../../../clients/client-dax/src/DAX.ts:778
updateSubnetGroup(args: UpdateSubnetGroupCommandInput, cb: ((err: any, data?: UpdateSubnetGroupCommandOutput) => void)): void
Parameters
- args: UpdateSubnetGroupCommandInput
- cb: ((err: any, data?: UpdateSubnetGroupCommandOutput) => void)
  - - (err: any, data?: UpdateSubnetGroupCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateSubnetGroupCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:782
updateSubnetGroup(args: UpdateSubnetGroupCommandInput, options: HttpHandlerOptions, cb: ((err: any, data?: UpdateSubnetGroupCommandOutput) => void)): void
Parameters
- args: UpdateSubnetGroupCommandInput
- options: HttpHandlerOptions
- cb: ((err: any, data?: UpdateSubnetGroupCommandOutput) => void)
  - - (err: any, data?: UpdateSubnetGroupCommandOutput): void
    - Parameters
      
      err: any
      
      Optional data: UpdateSubnetGroupCommandOutput
      
      Returns void
Returns void
- Defined in ../../../../../clients/client-dax/src/DAX.ts:786

Class DAX

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: DAXClientConfig

Returns DAX

Properties

Readonly config

middlewareStack

Methods

createCluster

Parameters

args: CreateClusterCommandInput

Optional options: HttpHandlerOptions

Returns Promise<CreateClusterCommandOutput>

Parameters

args: CreateClusterCommandInput

cb: ((err: any, data?: CreateClusterCommandOutput) => void)

Parameters

err: any

Optional data: CreateClusterCommandOutput

Returns void

Returns void

Parameters

args: CreateClusterCommandInput

options: HttpHandlerOptions

cb: ((err: any, data?: CreateClusterCommandOutput) => void)

Parameters

err: any

Optional data: CreateClusterCommandOutput

Returns void

Returns void

createParameterGroup

Parameters

args: CreateParameterGroupCommandInput

Optional options: HttpHandlerOptions

Returns Promise<CreateParameterGroupCommandOutput>

Parameters

args: CreateParameterGroupCommandInput

cb: ((err: any, data?: CreateParameterGroupCommandOutput) => void)

Parameters

err: any

Optional data: CreateParameterGroupCommandOutput

Returns void

Returns void

Parameters

args: CreateParameterGroupCommandInput

options: HttpHandlerOptions

cb: ((err: any, data?: CreateParameterGroupCommandOutput) => void)

Parameters

err: any

Optional data: CreateParameterGroupCommandOutput

Returns void

Returns void

createSubnetGroup

Parameters

args: CreateSubnetGroupCommandInput

Optional options: HttpHandlerOptions

Returns Promise<CreateSubnetGroupCommandOutput>

Parameters

args: CreateSubnetGroupCommandInput

cb: ((err: any, data?: CreateSubnetGroupCommandOutput) => void)

Parameters

err: any

Optional data: CreateSubnetGroupCommandOutput

Returns void

Returns void

Parameters

args: CreateSubnetGroupCommandInput

options: HttpHandlerOptions

cb: ((err: any, data?: CreateSubnetGroupCommandOutput) => void)

Parameters

err: any

Optional data: CreateSubnetGroupCommandOutput

Returns void

`Readonly` config

`Optional` options: HttpHandlerOptions

`Optional` data: CreateClusterCommandOutput

`Optional` data: CreateClusterCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: CreateParameterGroupCommandOutput

`Optional` data: CreateParameterGroupCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: CreateSubnetGroupCommandOutput

`Optional` data: CreateSubnetGroupCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DecreaseReplicationFactorCommandOutput

`Optional` data: DecreaseReplicationFactorCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DeleteClusterCommandOutput

`Optional` data: DeleteClusterCommandOutput

`Optional` options: HttpHandlerOptions

`Optional` data: DeleteParameterGroupCommandOutput

`Optional` data: DeleteParameterGroupCommandOutput