Class: AWS.DAX

Inherits:
AWS.Service show all
Identifier:
dax
API Version:
2017-04-19
Defined in:
(unknown)

Overview

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

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();

Version:

  • 2017-04-19

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.

Examples:

Constructing a DAX object

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

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.DAX.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.DAX.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.DAX.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    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.

Service Reference:

Examples:

Calling the createCluster operation

var params = {
  ClusterName: 'STRING_VALUE', /* required */
  IamRoleArn: 'STRING_VALUE', /* required */
  NodeType: 'STRING_VALUE', /* required */
  ReplicationFactor: 0, /* required */
  AvailabilityZones: [
    'STRING_VALUE',
    /* more items */
  ],
  Description: 'STRING_VALUE',
  NotificationTopicArn: 'STRING_VALUE',
  ParameterGroupName: 'STRING_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  SubnetGroupName: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
dax.createCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClusterName — (String)

      The cluster identifier. This parameter is stored as a lowercase string.

      Constraints:

      • A name must contain from 1 to 20 alphanumeric characters or hyphens.

      • The first character must be a letter.

      • A name cannot end with a hyphen or contain two consecutive hyphens.

    • NodeType — (String)

      The compute and memory capacity of the nodes in the cluster.

    • Description — (String)

      A description of the cluster.

    • ReplicationFactor — (Integer)

      The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to 2 or more.

      Note: AWS recommends that you have at least two read replicas per cluster.
    • AvailabilityZones — (Array<String>)

      The Availability Zones (AZs) in which the cluster nodes will be created. All nodes belonging to the cluster are placed in these Availability Zones. Use this parameter if you want to distribute the nodes across multiple AZs.

    • SubnetGroupName — (String)

      The name of the subnet group to be used for the replication group.

      DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

    • SecurityGroupIds — (Array<String>)

      A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

      If this parameter is not specified, DAX assigns the default VPC security group to each node.

    • PreferredMaintenanceWindow — (String)

      Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

      • sun

      • mon

      • tue

      • wed

      • thu

      • fri

      • sat

      Example: sun:05:00-sun:09:00

      Note: If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.
    • NotificationTopicArn — (String)

      The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

      Note: The Amazon SNS topic owner must be same as the DAX cluster owner.
    • IamRoleArn — (String)

      A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

    • ParameterGroupName — (String)

      The parameter group to be associated with the DAX cluster.

    • Tags — (Array<map>)

      A set of tags to associate with the DAX cluster.

      • Key — (String)

        The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.

      • Value — (String)

        The value of the tag. Tag values are case-sensitive and can be null.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        A description of the DAX cluster that you have created.

        • ClusterName — (String)

          The name of the DAX cluster.

        • Description — (String)

          The description of the cluster.

        • ClusterArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the cluster.

        • TotalNodes — (Integer)

          The total number of nodes in the cluster.

        • ActiveNodes — (Integer)

          The number of nodes in the cluster that are active (i.e., capable of serving requests).

        • NodeType — (String)

          The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

        • Status — (String)

          The current status of the cluster.

        • ClusterDiscoveryEndpoint — (map)

          The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

          • Address — (String)

            The DNS hostname of the endpoint.

          • Port — (Integer)

            The port number that applications should use to connect to the endpoint.

        • NodeIdsToRemove — (Array<String>)

          A list of nodes to be removed from the cluster.

        • Nodes — (Array<map>)

          A list of nodes that are currently in the cluster.

          • NodeId — (String)

            A system-generated identifier for the node.

          • Endpoint — (map)

            The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

            • Address — (String)

              The DNS hostname of the endpoint.

            • Port — (Integer)

              The port number that applications should use to connect to the endpoint.

          • NodeCreateTime — (Date)

            The date and time (in UNIX epoch format) when the node was launched.

          • AvailabilityZone — (String)

            The Availability Zone (AZ) in which the node has been deployed.

          • NodeStatus — (String)

            The current status of the node. For example: available.

          • ParameterGroupStatus — (String)

            The status of the parameter group associated with this node. For example, in-sync.

        • PreferredMaintenanceWindow — (String)

          A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

        • NotificationConfiguration — (map)

          Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

          • TopicArn — (String)

            The Amazon Resource Name (ARN) that identifies the topic.

          • TopicStatus — (String)

            The current state of the topic.

        • SubnetGroup — (String)

          The subnet group where the DAX cluster is running.

        • SecurityGroups — (Array<map>)

          A list of security groups, and the status of each, for the nodes in the cluster.

          • SecurityGroupIdentifier — (String)

            The unique ID for this security group.

          • Status — (String)

            The status of this security group.

        • IamRoleArn — (String)

          A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

        • ParameterGroup — (map)

          The parameter group being used by nodes in the cluster.

          • ParameterGroupName — (String)

            The name of the parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • NodeIdsToReboot — (Array<String>)

            The node IDs of one or more nodes to be rebooted.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the createParameterGroup operation

var params = {
  ParameterGroupName: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE'
};
dax.createParameterGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ParameterGroupName — (String)

      The name of the parameter group to apply to all of the clusters in this replication group.

    • Description — (String)

      A description of the parameter group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ParameterGroup — (map)

        Represents the output of a CreateParameterGroup action.

        • ParameterGroupName — (String)

          The name of the parameter group.

        • Description — (String)

          A description of the parameter group.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Creates a new subnet group.

Service Reference:

Examples:

Calling the createSubnetGroup operation

var params = {
  SubnetGroupName: 'STRING_VALUE', /* required */
  SubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Description: 'STRING_VALUE'
};
dax.createSubnetGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SubnetGroupName — (String)

      A name for the subnet group. This value is stored as a lowercase string.

    • Description — (String)

      A description for the subnet group

    • SubnetIds — (Array<String>)

      A list of VPC subnet IDs for the subnet group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SubnetGroup — (map)

        Represents the output of a CreateSubnetGroup operation.

        • SubnetGroupName — (String)

          The name of the subnet group.

        • Description — (String)

          The description of the subnet group.

        • VpcId — (String)

          The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.

        • Subnets — (Array<map>)

          A list of subnets associated with the subnet group.

          • SubnetIdentifier — (String)

            The system-assigned identifier for the subnet.

          • SubnetAvailabilityZone — (String)

            The Availability Zone (AZ) for subnet subnet.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the decreaseReplicationFactor operation

var params = {
  ClusterName: 'STRING_VALUE', /* required */
  NewReplicationFactor: 0, /* required */
  AvailabilityZones: [
    'STRING_VALUE',
    /* more items */
  ],
  NodeIdsToRemove: [
    'STRING_VALUE',
    /* more items */
  ]
};
dax.decreaseReplicationFactor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClusterName — (String)

      The name of the DAX cluster from which you want to remove nodes.

    • NewReplicationFactor — (Integer)

      The new number of nodes for the DAX cluster.

    • AvailabilityZones — (Array<String>)

      The Availability Zone(s) from which to remove nodes.

    • NodeIdsToRemove — (Array<String>)

      The unique identifiers of the nodes to be removed from the cluster.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        A description of the DAX cluster, after you have decreased its replication factor.

        • ClusterName — (String)

          The name of the DAX cluster.

        • Description — (String)

          The description of the cluster.

        • ClusterArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the cluster.

        • TotalNodes — (Integer)

          The total number of nodes in the cluster.

        • ActiveNodes — (Integer)

          The number of nodes in the cluster that are active (i.e., capable of serving requests).

        • NodeType — (String)

          The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

        • Status — (String)

          The current status of the cluster.

        • ClusterDiscoveryEndpoint — (map)

          The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

          • Address — (String)

            The DNS hostname of the endpoint.

          • Port — (Integer)

            The port number that applications should use to connect to the endpoint.

        • NodeIdsToRemove — (Array<String>)

          A list of nodes to be removed from the cluster.

        • Nodes — (Array<map>)

          A list of nodes that are currently in the cluster.

          • NodeId — (String)

            A system-generated identifier for the node.

          • Endpoint — (map)

            The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

            • Address — (String)

              The DNS hostname of the endpoint.

            • Port — (Integer)

              The port number that applications should use to connect to the endpoint.

          • NodeCreateTime — (Date)

            The date and time (in UNIX epoch format) when the node was launched.

          • AvailabilityZone — (String)

            The Availability Zone (AZ) in which the node has been deployed.

          • NodeStatus — (String)

            The current status of the node. For example: available.

          • ParameterGroupStatus — (String)

            The status of the parameter group associated with this node. For example, in-sync.

        • PreferredMaintenanceWindow — (String)

          A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

        • NotificationConfiguration — (map)

          Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

          • TopicArn — (String)

            The Amazon Resource Name (ARN) that identifies the topic.

          • TopicStatus — (String)

            The current state of the topic.

        • SubnetGroup — (String)

          The subnet group where the DAX cluster is running.

        • SecurityGroups — (Array<map>)

          A list of security groups, and the status of each, for the nodes in the cluster.

          • SecurityGroupIdentifier — (String)

            The unique ID for this security group.

          • Status — (String)

            The status of this security group.

        • IamRoleArn — (String)

          A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

        • ParameterGroup — (map)

          The parameter group being used by nodes in the cluster.

          • ParameterGroupName — (String)

            The name of the parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • NodeIdsToReboot — (Array<String>)

            The node IDs of one or more nodes to be rebooted.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the deleteCluster operation

var params = {
  ClusterName: 'STRING_VALUE' /* required */
};
dax.deleteCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClusterName — (String)

      The name of the cluster to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        A description of the DAX cluster that is being deleted.

        • ClusterName — (String)

          The name of the DAX cluster.

        • Description — (String)

          The description of the cluster.

        • ClusterArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the cluster.

        • TotalNodes — (Integer)

          The total number of nodes in the cluster.

        • ActiveNodes — (Integer)

          The number of nodes in the cluster that are active (i.e., capable of serving requests).

        • NodeType — (String)

          The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

        • Status — (String)

          The current status of the cluster.

        • ClusterDiscoveryEndpoint — (map)

          The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

          • Address — (String)

            The DNS hostname of the endpoint.

          • Port — (Integer)

            The port number that applications should use to connect to the endpoint.

        • NodeIdsToRemove — (Array<String>)

          A list of nodes to be removed from the cluster.

        • Nodes — (Array<map>)

          A list of nodes that are currently in the cluster.

          • NodeId — (String)

            A system-generated identifier for the node.

          • Endpoint — (map)

            The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

            • Address — (String)

              The DNS hostname of the endpoint.

            • Port — (Integer)

              The port number that applications should use to connect to the endpoint.

          • NodeCreateTime — (Date)

            The date and time (in UNIX epoch format) when the node was launched.

          • AvailabilityZone — (String)

            The Availability Zone (AZ) in which the node has been deployed.

          • NodeStatus — (String)

            The current status of the node. For example: available.

          • ParameterGroupStatus — (String)

            The status of the parameter group associated with this node. For example, in-sync.

        • PreferredMaintenanceWindow — (String)

          A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

        • NotificationConfiguration — (map)

          Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

          • TopicArn — (String)

            The Amazon Resource Name (ARN) that identifies the topic.

          • TopicStatus — (String)

            The current state of the topic.

        • SubnetGroup — (String)

          The subnet group where the DAX cluster is running.

        • SecurityGroups — (Array<map>)

          A list of security groups, and the status of each, for the nodes in the cluster.

          • SecurityGroupIdentifier — (String)

            The unique ID for this security group.

          • Status — (String)

            The status of this security group.

        • IamRoleArn — (String)

          A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

        • ParameterGroup — (map)

          The parameter group being used by nodes in the cluster.

          • ParameterGroupName — (String)

            The name of the parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • NodeIdsToReboot — (Array<String>)

            The node IDs of one or more nodes to be rebooted.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the deleteParameterGroup operation

var params = {
  ParameterGroupName: 'STRING_VALUE' /* required */
};
dax.deleteParameterGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ParameterGroupName — (String)

      The name of the parameter group to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeletionMessage — (String)

        A user-specified message for this action (i.e., a reason for deleting the parameter group).

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deletes a subnet group.

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

Service Reference:

Examples:

Calling the deleteSubnetGroup operation

var params = {
  SubnetGroupName: 'STRING_VALUE' /* required */
};
dax.deleteSubnetGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SubnetGroupName — (String)

      The name of the subnet group to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeletionMessage — (String)

        A user-specified message for this action (i.e., a reason for deleting the subnet group).

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the describeClusters operation

var params = {
  ClusterNames: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
dax.describeClusters(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClusterNames — (Array<String>)

      The names of the DAX clusters being described.

    • MaxResults — (Integer)

      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

      The value for MaxResults must be between 20 and 100.

    • NextToken — (String)

      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        Provides an identifier to allow retrieval of paginated results.

      • Clusters — (Array<map>)

        The descriptions of your DAX clusters, in response to a DescribeClusters request.

        • ClusterName — (String)

          The name of the DAX cluster.

        • Description — (String)

          The description of the cluster.

        • ClusterArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the cluster.

        • TotalNodes — (Integer)

          The total number of nodes in the cluster.

        • ActiveNodes — (Integer)

          The number of nodes in the cluster that are active (i.e., capable of serving requests).

        • NodeType — (String)

          The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

        • Status — (String)

          The current status of the cluster.

        • ClusterDiscoveryEndpoint — (map)

          The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

          • Address — (String)

            The DNS hostname of the endpoint.

          • Port — (Integer)

            The port number that applications should use to connect to the endpoint.

        • NodeIdsToRemove — (Array<String>)

          A list of nodes to be removed from the cluster.

        • Nodes — (Array<map>)

          A list of nodes that are currently in the cluster.

          • NodeId — (String)

            A system-generated identifier for the node.

          • Endpoint — (map)

            The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

            • Address — (String)

              The DNS hostname of the endpoint.

            • Port — (Integer)

              The port number that applications should use to connect to the endpoint.

          • NodeCreateTime — (Date)

            The date and time (in UNIX epoch format) when the node was launched.

          • AvailabilityZone — (String)

            The Availability Zone (AZ) in which the node has been deployed.

          • NodeStatus — (String)

            The current status of the node. For example: available.

          • ParameterGroupStatus — (String)

            The status of the parameter group associated with this node. For example, in-sync.

        • PreferredMaintenanceWindow — (String)

          A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

        • NotificationConfiguration — (map)

          Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

          • TopicArn — (String)

            The Amazon Resource Name (ARN) that identifies the topic.

          • TopicStatus — (String)

            The current state of the topic.

        • SubnetGroup — (String)

          The subnet group where the DAX cluster is running.

        • SecurityGroups — (Array<map>)

          A list of security groups, and the status of each, for the nodes in the cluster.

          • SecurityGroupIdentifier — (String)

            The unique ID for this security group.

          • Status — (String)

            The status of this security group.

        • IamRoleArn — (String)

          A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

        • ParameterGroup — (map)

          The parameter group being used by nodes in the cluster.

          • ParameterGroupName — (String)

            The name of the parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • NodeIdsToReboot — (Array<String>)

            The node IDs of one or more nodes to be rebooted.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the describeDefaultParameters operation

var params = {
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
dax.describeDefaultParameters(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

      The value for MaxResults must be between 20 and 100.

    • NextToken — (String)

      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        Provides an identifier to allow retrieval of paginated results.

      • Parameters — (Array<map>)

        A list of parameters. Each element in the list represents one parameter.

        • ParameterName — (String)

          The name of the parameter.

        • ParameterType — (String)

          Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.

          Possible values include:
          • "DEFAULT"
          • "NODE_TYPE_SPECIFIC"
        • ParameterValue — (String)

          The value for the parameter.

        • NodeTypeSpecificValues — (Array<map>)

          A list of node types, and specific parameter values for each node.

          • NodeType — (String)

            A node type to which the parameter value applies.

          • Value — (String)

            The parameter value for this node type.

        • Description — (String)

          A description of the parameter

        • Source — (String)

          How the parameter is defined. For example, system denotes a system-defined parameter.

        • DataType — (String)

          The data type of the parameter. For example, integer:

        • AllowedValues — (String)

          A range of values within which the parameter can be set.

        • IsModifiable — (String)

          Whether the customer is allowed to modify the parameter.

          Possible values include:
          • "TRUE"
          • "FALSE"
          • "CONDITIONAL"
        • ChangeType — (String)

          The conditions under which changes to this parameter can be applied. For example, requires-reboot indicates that a new value for this parameter will only take effect if a node is rebooted.

          Possible values include:
          • "IMMEDIATE"
          • "REQUIRES_REBOOT"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Service Reference:

Examples:

Calling the describeEvents operation

var params = {
  Duration: 0,
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 0,
  NextToken: 'STRING_VALUE',
  SourceName: 'STRING_VALUE',
  SourceType: CLUSTER | PARAMETER_GROUP | SUBNET_GROUP,
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
dax.describeEvents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SourceName — (String)

      The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

    • SourceType — (String)

      The event source to retrieve events for. If no value is specified, all events are returned.

      Possible values include:
      • "CLUSTER"
      • "PARAMETER_GROUP"
      • "SUBNET_GROUP"
    • StartTime — (Date)

      The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

    • EndTime — (Date)

      The end of the time interval for which to retrieve events, specified in ISO 8601 format.

    • Duration — (Integer)

      The number of minutes' worth of events to retrieve.

    • MaxResults — (Integer)

      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

      The value for MaxResults must be between 20 and 100.

    • NextToken — (String)

      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        Provides an identifier to allow retrieval of paginated results.

      • Events — (Array<map>)

        An array of events. Each element in the array represents one event.

        • SourceName — (String)

          The source of the event. For example, if the event occurred at the node level, the source would be the node ID.

        • SourceType — (String)

          Specifies the origin of this event - a cluster, a parameter group, a node ID, etc.

          Possible values include:
          • "CLUSTER"
          • "PARAMETER_GROUP"
          • "SUBNET_GROUP"
        • Message — (String)

          A user-defined message associated with the event.

        • Date — (Date)

          The date and time when the event occurred.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the describeParameterGroups operation

var params = {
  MaxResults: 0,
  NextToken: 'STRING_VALUE',
  ParameterGroupNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
dax.describeParameterGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ParameterGroupNames — (Array<String>)

      The names of the parameter groups.

    • MaxResults — (Integer)

      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

      The value for MaxResults must be between 20 and 100.

    • NextToken — (String)

      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        Provides an identifier to allow retrieval of paginated results.

      • ParameterGroups — (Array<map>)

        An array of parameter groups. Each element in the array represents one parameter group.

        • ParameterGroupName — (String)

          The name of the parameter group.

        • Description — (String)

          A description of the parameter group.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Returns the detailed parameter list for a particular parameter group.

Service Reference:

Examples:

Calling the describeParameters operation

var params = {
  ParameterGroupName: 'STRING_VALUE', /* required */
  MaxResults: 0,
  NextToken: 'STRING_VALUE',
  Source: 'STRING_VALUE'
};
dax.describeParameters(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ParameterGroupName — (String)

      The name of the parameter group.

    • Source — (String)

      How the parameter is defined. For example, system denotes a system-defined parameter.

    • MaxResults — (Integer)

      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

      The value for MaxResults must be between 20 and 100.

    • NextToken — (String)

      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        Provides an identifier to allow retrieval of paginated results.

      • Parameters — (Array<map>)

        A list of parameters within a parameter group. Each element in the list represents one parameter.

        • ParameterName — (String)

          The name of the parameter.

        • ParameterType — (String)

          Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.

          Possible values include:
          • "DEFAULT"
          • "NODE_TYPE_SPECIFIC"
        • ParameterValue — (String)

          The value for the parameter.

        • NodeTypeSpecificValues — (Array<map>)

          A list of node types, and specific parameter values for each node.

          • NodeType — (String)

            A node type to which the parameter value applies.

          • Value — (String)

            The parameter value for this node type.

        • Description — (String)

          A description of the parameter

        • Source — (String)

          How the parameter is defined. For example, system denotes a system-defined parameter.

        • DataType — (String)

          The data type of the parameter. For example, integer:

        • AllowedValues — (String)

          A range of values within which the parameter can be set.

        • IsModifiable — (String)

          Whether the customer is allowed to modify the parameter.

          Possible values include:
          • "TRUE"
          • "FALSE"
          • "CONDITIONAL"
        • ChangeType — (String)

          The conditions under which changes to this parameter can be applied. For example, requires-reboot indicates that a new value for this parameter will only take effect if a node is rebooted.

          Possible values include:
          • "IMMEDIATE"
          • "REQUIRES_REBOOT"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the describeSubnetGroups operation

var params = {
  MaxResults: 0,
  NextToken: 'STRING_VALUE',
  SubnetGroupNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
dax.describeSubnetGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SubnetGroupNames — (Array<String>)

      The name of the subnet group.

    • MaxResults — (Integer)

      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

      The value for MaxResults must be between 20 and 100.

    • NextToken — (String)

      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        Provides an identifier to allow retrieval of paginated results.

      • SubnetGroups — (Array<map>)

        An array of subnet groups. Each element in the array represents a single subnet group.

        • SubnetGroupName — (String)

          The name of the subnet group.

        • Description — (String)

          The description of the subnet group.

        • VpcId — (String)

          The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.

        • Subnets — (Array<map>)

          A list of subnets associated with the subnet group.

          • SubnetIdentifier — (String)

            The system-assigned identifier for the subnet.

          • SubnetAvailabilityZone — (String)

            The Availability Zone (AZ) for subnet subnet.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Adds one or more nodes to a DAX cluster.

Service Reference:

Examples:

Calling the increaseReplicationFactor operation

var params = {
  ClusterName: 'STRING_VALUE', /* required */
  NewReplicationFactor: 0, /* required */
  AvailabilityZones: [
    'STRING_VALUE',
    /* more items */
  ]
};
dax.increaseReplicationFactor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClusterName — (String)

      The name of the DAX cluster that will receive additional nodes.

    • NewReplicationFactor — (Integer)

      The new number of nodes for the DAX cluster.

    • AvailabilityZones — (Array<String>)

      The Availability Zones (AZs) in which the cluster nodes will be created. All nodes belonging to the cluster are placed in these Availability Zones. Use this parameter if you want to distribute the nodes across multiple AZs.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        A description of the DAX cluster. with its new replication factor.

        • ClusterName — (String)

          The name of the DAX cluster.

        • Description — (String)

          The description of the cluster.

        • ClusterArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the cluster.

        • TotalNodes — (Integer)

          The total number of nodes in the cluster.

        • ActiveNodes — (Integer)

          The number of nodes in the cluster that are active (i.e., capable of serving requests).

        • NodeType — (String)

          The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

        • Status — (String)

          The current status of the cluster.

        • ClusterDiscoveryEndpoint — (map)

          The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

          • Address — (String)

            The DNS hostname of the endpoint.

          • Port — (Integer)

            The port number that applications should use to connect to the endpoint.

        • NodeIdsToRemove — (Array<String>)

          A list of nodes to be removed from the cluster.

        • Nodes — (Array<map>)

          A list of nodes that are currently in the cluster.

          • NodeId — (String)

            A system-generated identifier for the node.

          • Endpoint — (map)

            The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

            • Address — (String)

              The DNS hostname of the endpoint.

            • Port — (Integer)

              The port number that applications should use to connect to the endpoint.

          • NodeCreateTime — (Date)

            The date and time (in UNIX epoch format) when the node was launched.

          • AvailabilityZone — (String)

            The Availability Zone (AZ) in which the node has been deployed.

          • NodeStatus — (String)

            The current status of the node. For example: available.

          • ParameterGroupStatus — (String)

            The status of the parameter group associated with this node. For example, in-sync.

        • PreferredMaintenanceWindow — (String)

          A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

        • NotificationConfiguration — (map)

          Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

          • TopicArn — (String)

            The Amazon Resource Name (ARN) that identifies the topic.

          • TopicStatus — (String)

            The current state of the topic.

        • SubnetGroup — (String)

          The subnet group where the DAX cluster is running.

        • SecurityGroups — (Array<map>)

          A list of security groups, and the status of each, for the nodes in the cluster.

          • SecurityGroupIdentifier — (String)

            The unique ID for this security group.

          • Status — (String)

            The status of this security group.

        • IamRoleArn — (String)

          A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

        • ParameterGroup — (map)

          The parameter group being used by nodes in the cluster.

          • ParameterGroupName — (String)

            The name of the parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • NodeIdsToReboot — (Array<String>)

            The node IDs of one or more nodes to be rebooted.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the listTags operation

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE'
};
dax.listTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceName — (String)

      The name of the DAX resource to which the tags belong.

    • NextToken — (String)

      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        A list of tags currently associated with the DAX cluster.

        • Key — (String)

          The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.

        • Value — (String)

          The value of the tag. Tag values are case-sensitive and can be null.

      • NextToken — (String)

        If this value is present, there are additional results to be displayed. To retrieve them, call ListTags again, with NextToken set to this value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the rebootNode operation

var params = {
  ClusterName: 'STRING_VALUE', /* required */
  NodeId: 'STRING_VALUE' /* required */
};
dax.rebootNode(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClusterName — (String)

      The name of the DAX cluster containing the node to be rebooted.

    • NodeId — (String)

      The system-assigned ID of the node to be rebooted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        A description of the DAX cluster after a node has been rebooted.

        • ClusterName — (String)

          The name of the DAX cluster.

        • Description — (String)

          The description of the cluster.

        • ClusterArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the cluster.

        • TotalNodes — (Integer)

          The total number of nodes in the cluster.

        • ActiveNodes — (Integer)

          The number of nodes in the cluster that are active (i.e., capable of serving requests).

        • NodeType — (String)

          The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

        • Status — (String)

          The current status of the cluster.

        • ClusterDiscoveryEndpoint — (map)

          The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

          • Address — (String)

            The DNS hostname of the endpoint.

          • Port — (Integer)

            The port number that applications should use to connect to the endpoint.

        • NodeIdsToRemove — (Array<String>)

          A list of nodes to be removed from the cluster.

        • Nodes — (Array<map>)

          A list of nodes that are currently in the cluster.

          • NodeId — (String)

            A system-generated identifier for the node.

          • Endpoint — (map)

            The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

            • Address — (String)

              The DNS hostname of the endpoint.

            • Port — (Integer)

              The port number that applications should use to connect to the endpoint.

          • NodeCreateTime — (Date)

            The date and time (in UNIX epoch format) when the node was launched.

          • AvailabilityZone — (String)

            The Availability Zone (AZ) in which the node has been deployed.

          • NodeStatus — (String)

            The current status of the node. For example: available.

          • ParameterGroupStatus — (String)

            The status of the parameter group associated with this node. For example, in-sync.

        • PreferredMaintenanceWindow — (String)

          A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

        • NotificationConfiguration — (map)

          Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

          • TopicArn — (String)

            The Amazon Resource Name (ARN) that identifies the topic.

          • TopicStatus — (String)

            The current state of the topic.

        • SubnetGroup — (String)

          The subnet group where the DAX cluster is running.

        • SecurityGroups — (Array<map>)

          A list of security groups, and the status of each, for the nodes in the cluster.

          • SecurityGroupIdentifier — (String)

            The unique ID for this security group.

          • Status — (String)

            The status of this security group.

        • IamRoleArn — (String)

          A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

        • ParameterGroup — (map)

          The parameter group being used by nodes in the cluster.

          • ParameterGroupName — (String)

            The name of the parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • NodeIdsToReboot — (Array<String>)

            The node IDs of one or more nodes to be rebooted.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
dax.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceName — (String)

      The name of the DAX resource to which tags should be added.

    • Tags — (Array<map>)

      The tags to be assigned to the DAX resource.

      • Key — (String)

        The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.

      • Value — (String)

        The value of the tag. Tag values are case-sensitive and can be null.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        The list of tags that are associated with the DAX resource.

        • Key — (String)

          The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.

        • Value — (String)

          The value of the tag. Tag values are case-sensitive and can be null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
dax.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceName — (String)

      The name of the DAX resource from which the tags should be removed.

    • TagKeys — (Array<String>)

      A list of tag keys. If the DAX cluster has any tags with these keys, then the tags are removed from the cluster.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        The tag keys that have been removed from the cluster.

        • Key — (String)

          The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.

        • Value — (String)

          The value of the tag. Tag values are case-sensitive and can be null.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the updateCluster operation

var params = {
  ClusterName: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  NotificationTopicArn: 'STRING_VALUE',
  NotificationTopicStatus: 'STRING_VALUE',
  ParameterGroupName: 'STRING_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
dax.updateCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClusterName — (String)

      The name of the DAX cluster to be modified.

    • Description — (String)

      A description of the changes being made to the cluster.

    • PreferredMaintenanceWindow — (String)

      A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

    • NotificationTopicArn — (String)

      The Amazon Resource Name (ARN) that identifies the topic.

    • NotificationTopicStatus — (String)

      The current state of the topic.

    • ParameterGroupName — (String)

      The name of a parameter group for this cluster.

    • SecurityGroupIds — (Array<String>)

      A list of user-specified security group IDs to be assigned to each node in the DAX cluster. If this parameter is not specified, DAX assigns the default VPC security group to each node.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        A description of the DAX cluster, after it has been modified.

        • ClusterName — (String)

          The name of the DAX cluster.

        • Description — (String)

          The description of the cluster.

        • ClusterArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the cluster.

        • TotalNodes — (Integer)

          The total number of nodes in the cluster.

        • ActiveNodes — (Integer)

          The number of nodes in the cluster that are active (i.e., capable of serving requests).

        • NodeType — (String)

          The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

        • Status — (String)

          The current status of the cluster.

        • ClusterDiscoveryEndpoint — (map)

          The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

          • Address — (String)

            The DNS hostname of the endpoint.

          • Port — (Integer)

            The port number that applications should use to connect to the endpoint.

        • NodeIdsToRemove — (Array<String>)

          A list of nodes to be removed from the cluster.

        • Nodes — (Array<map>)

          A list of nodes that are currently in the cluster.

          • NodeId — (String)

            A system-generated identifier for the node.

          • Endpoint — (map)

            The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

            • Address — (String)

              The DNS hostname of the endpoint.

            • Port — (Integer)

              The port number that applications should use to connect to the endpoint.

          • NodeCreateTime — (Date)

            The date and time (in UNIX epoch format) when the node was launched.

          • AvailabilityZone — (String)

            The Availability Zone (AZ) in which the node has been deployed.

          • NodeStatus — (String)

            The current status of the node. For example: available.

          • ParameterGroupStatus — (String)

            The status of the parameter group associated with this node. For example, in-sync.

        • PreferredMaintenanceWindow — (String)

          A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

        • NotificationConfiguration — (map)

          Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

          • TopicArn — (String)

            The Amazon Resource Name (ARN) that identifies the topic.

          • TopicStatus — (String)

            The current state of the topic.

        • SubnetGroup — (String)

          The subnet group where the DAX cluster is running.

        • SecurityGroups — (Array<map>)

          A list of security groups, and the status of each, for the nodes in the cluster.

          • SecurityGroupIdentifier — (String)

            The unique ID for this security group.

          • Status — (String)

            The status of this security group.

        • IamRoleArn — (String)

          A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

        • ParameterGroup — (map)

          The parameter group being used by nodes in the cluster.

          • ParameterGroupName — (String)

            The name of the parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • NodeIdsToReboot — (Array<String>)

            The node IDs of one or more nodes to be rebooted.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the updateParameterGroup operation

var params = {
  ParameterGroupName: 'STRING_VALUE', /* required */
  ParameterNameValues: [ /* required */
    {
      ParameterName: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE'
    },
    /* more items */
  ]
};
dax.updateParameterGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ParameterGroupName — (String)

      The name of the parameter group.

    • ParameterNameValues — (Array<map>)

      An array of name-value pairs for the parameters in the group. Each element in the array represents a single parameter.

      • ParameterName — (String)

        The name of the parameter.

      • ParameterValue — (String)

        The value of the parameter.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ParameterGroup — (map)

        The parameter group that has been modified.

        • ParameterGroupName — (String)

          The name of the parameter group.

        • Description — (String)

          A description of the parameter group.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Modifies an existing subnet group.

Service Reference:

Examples:

Calling the updateSubnetGroup operation

var params = {
  SubnetGroupName: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  SubnetIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
dax.updateSubnetGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SubnetGroupName — (String)

      The name of the subnet group.

    • Description — (String)

      A description of the subnet group.

    • SubnetIds — (Array<String>)

      A list of subnet IDs in the subnet group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SubnetGroup — (map)

        The subnet group that has been modified.

        • SubnetGroupName — (String)

          The name of the subnet group.

        • Description — (String)

          The description of the subnet group.

        • VpcId — (String)

          The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.

        • Subnets — (Array<map>)

          A list of subnets associated with the subnet group.

          • SubnetIdentifier — (String)

            The system-assigned identifier for the subnet.

          • SubnetAvailabilityZone — (String)

            The Availability Zone (AZ) for subnet subnet.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.