You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.MemoryDB

Inherits:
AWS.Service show all
Identifier:
memorydb
API Version:
2021-01-01
Defined in:
(unknown)

Overview

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

Service Description

MemoryDB for Redis is a fully managed, Redis-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures. MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis, a popular open source data store, enabling you to leverage Redis’ flexible and friendly data structures, APIs, and commands.

Sending a Request Using MemoryDB

var memorydb = new AWS.MemoryDB();
memorydb.batchUpdateCluster(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 MemoryDB object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var memorydb = new AWS.MemoryDB({apiVersion: '2021-01-01'});

You can also set the API version globally in AWS.config.apiVersions using the memorydb service identifier:

AWS.config.apiVersions = {
  memorydb: '2021-01-01',
  // other service API versions
};

var memorydb = new AWS.MemoryDB();

Version:

  • 2021-01-01

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.MemoryDB(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a MemoryDB object

var memorydb = new AWS.MemoryDB({apiVersion: '2021-01-01'});

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|AWS.Endpoint) —

    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' or an Endpoint object.

  • 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.MemoryDB.region for more information.

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.MemoryDB.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.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets 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 error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • 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.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.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

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

Apply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates.

Service Reference:

Examples:

Calling the batchUpdateCluster operation

var params = {
  ClusterNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  ServiceUpdate: {
    ServiceUpdateNameToApply: 'STRING_VALUE'
  }
};
memorydb.batchUpdateCluster(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 cluster names to apply the updates.

    • ServiceUpdate — (map)

      The unique ID of the service update

      • ServiceUpdateNameToApply — (String)

        The unique ID of the service update

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:

      • ProcessedClusters — (Array<map>)

        The list of clusters that have been updated.

        • Name — (String)

          The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.

        • Description — (String)

          A description of the cluster

        • Status — (String)

          The status of the cluster. For example, Available, Updating, Creating.

        • PendingUpdates — (map)

          A group of settings that are currently being applied.

          • Resharding — (map)

            The status of an online resharding operation.

            • SlotMigration — (map)

              The status of the online resharding slot migration

              • ProgressPercentage — (Float)

                The percentage of the slot migration that is complete.

          • ACLs — (map)

            A list of ACLs associated with the cluster that are being updated

            • ACLToApply — (String)

              A list of ACLs pending to be applied.

          • ServiceUpdates — (Array<map>)

            A list of service updates being applied to the cluster

            • ServiceUpdateName — (String)

              The unique ID of the service update

            • Status — (String)

              The status of the service update

              Possible values include:
              • "available"
              • "in-progress"
              • "complete"
              • "scheduled"
        • NumberOfShards — (Integer)

          The number of shards in the cluster

        • Shards — (Array<map>)

          A list of shards that are members of the cluster.

          • Name — (String)

            The name of the shard

          • Status — (String)

            The current state of this replication group - creating, available, modifying, deleting.

          • Slots — (String)

            The keyspace for this shard.

          • Nodes — (Array<map>)

            A list containing information about individual nodes within the shard

            • Name — (String)

              The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.

            • Status — (String)

              The status of the service update on the node

            • AvailabilityZone — (String)

              The Availability Zone in which the node resides

            • CreateTime — (Date)

              The date and time when the node was created.

            • Endpoint — (map)

              The hostname for connecting to this node.

              • Address — (String)

                The DNS hostname of the node.

              • Port — (Integer)

                The port number that the engine is listening on.

          • NumberOfNodes — (Integer)

            The number of nodes in the shard

        • AvailabilityMode — (String)

          Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).

          Possible values include:
          • "singleaz"
          • "multiaz"
        • ClusterEndpoint — (map)

          The cluster's configuration endpoint

          • Address — (String)

            The DNS hostname of the node.

          • Port — (Integer)

            The port number that the engine is listening on.

        • NodeType — (String)

          The cluster's node type

        • EngineVersion — (String)

          The Redis engine version used by the cluster

        • EnginePatchVersion — (String)

          The Redis engine patch version used by the cluster

        • ParameterGroupName — (String)

          The name of the parameter group used by the cluster

        • ParameterGroupStatus — (String)

          The status of the parameter group used by the cluster, for example 'active' or 'applying'.

        • SecurityGroups — (Array<map>)

          A list of security groups used by the cluster

          • SecurityGroupId — (String)

            The identifier of the security group.

          • Status — (String)

            The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.

        • SubnetGroupName — (String)

          The name of the subnet group used by the cluster

        • TLSEnabled — (Boolean)

          A flag to indicate if In-transit encryption is enabled

        • KmsKeyId — (String)

          The ID of the KMS key used to encrypt the cluster

        • ARN — (String)

          The Amazon Resource Name (ARN) of the cluster.

        • SnsTopicArn — (String)

          The Amazon Resource Name (ARN) of the SNS notification topic

        • SnsTopicStatus — (String)

          The SNS topic must be in Active status to receive notifications

        • SnapshotRetentionLimit — (Integer)

          The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

        • MaintenanceWindow — (String)

          Specifies the weekly time range during which maintenance on the 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.

        • SnapshotWindow — (String)

          The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

        • ACLName — (String)

          The name of the Access Control List associated with this cluster.

        • AutoMinorVersionUpgrade — (Boolean)

          When set to true, the cluster will automatically receive minor engine version upgrades after launch.

      • UnprocessedClusters — (Array<map>)

        The list of clusters where updates have not been applied.

        • ClusterName — (String)

          The name of the cluster

        • ErrorType — (String)

          The error type associated with the update failure

        • ErrorMessage — (String)

          The error message associated with the update failure

Returns:

  • (AWS.Request) —

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

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

Makes a copy of an existing snapshot.

Service Reference:

Examples:

Calling the copySnapshot operation

var params = {
  SourceSnapshotName: 'STRING_VALUE', /* required */
  TargetSnapshotName: 'STRING_VALUE', /* required */
  KmsKeyId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TargetBucket: 'STRING_VALUE'
};
memorydb.copySnapshot(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: {}) —
    • SourceSnapshotName — (String)

      The name of an existing snapshot from which to make a copy.

    • TargetSnapshotName — (String)

      A name for the snapshot copy. MemoryDB does not permit overwriting a snapshot, therefore this name must be unique within its context - MemoryDB or an Amazon S3 bucket if exporting.

    • TargetBucket — (String)

      The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access. When using this parameter to export a snapshot, be sure MemoryDB has the needed permissions to this S3 bucket. For more information, see Step 2: Grant MemoryDB Access to Your Amazon S3 Bucket.

    • KmsKeyId — (String)

      The ID of the KMS key used to encrypt the target snapshot.

    • Tags — (Array<map>)

      A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

      • Key — (String)

        The key for the tag. May not be null.

      • Value — (String)

        The tag's value. May 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:

      • Snapshot — (map)

        Represents a copy of an entire cluster as of the time when the snapshot was taken.

        • Name — (String)

          The name of the snapshot

        • Status — (String)

          The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

        • Source — (String)

          Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

        • KmsKeyId — (String)

          The ID of the KMS key used to encrypt the snapshot.

        • ARN — (String)

          The ARN (Amazon Resource Name) of the snapshot.

        • ClusterConfiguration — (map)

          The configuration of the cluster from which the snapshot was taken

          • Name — (String)

            The name of the cluster

          • Description — (String)

            The description of the cluster configuration

          • NodeType — (String)

            The node type used for the cluster

          • EngineVersion — (String)

            The Redis engine version used by the cluster

          • MaintenanceWindow — (String)

            The specified maintenance window for the cluster

          • TopicArn — (String)

            The Amazon Resource Name (ARN) of the SNS notification topic for the cluster

          • Port — (Integer)

            The port used by the cluster

          • ParameterGroupName — (String)

            The name of parameter group used by the cluster

          • SubnetGroupName — (String)

            The name of the subnet group used by the cluster

          • VpcId — (String)

            The ID of the VPC the cluster belongs to

          • SnapshotRetentionLimit — (Integer)

            The snapshot retention limit set by the cluster

          • SnapshotWindow — (String)

            The snapshot window set by the cluster

          • NumShards — (Integer)

            The number of shards in the cluster

          • Shards — (Array<map>)

            The list of shards in the cluster

            • Name — (String)

              The name of the shard

            • Configuration — (map)

              The configuration details of the shard

              • Slots — (String)

                A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.

              • ReplicaCount — (Integer)

                The number of read replica nodes in this shard.

            • Size — (String)

              The size of the shard's snapshot

            • SnapshotCreationTime — (Date)

              The date and time that the shard's snapshot was created

Returns:

  • (AWS.Request) —

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

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

Creates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs).

Service Reference:

Examples:

Calling the createACL operation

var params = {
  ACLName: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  UserNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
memorydb.createACL(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: {}) —
    • ACLName — (String)

      The name of the Access Control List.

    • UserNames — (Array<String>)

      The list of users that belong to the Access Control List.

    • Tags — (Array<map>)

      A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

      • Key — (String)

        The key for the tag. May not be null.

      • Value — (String)

        The tag's value. May 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:

      • ACL — (map)

        The newly-created Access Control List.

        • Name — (String)

          The name of the Access Control List

        • Status — (String)

          Indicates ACL status. Can be "creating", "active", "modifying", "deleting".

        • UserNames — (Array<String>)

          The list of user names that belong to the ACL.

        • MinimumEngineVersion — (String)

          The minimum engine version supported for the ACL

        • PendingChanges — (map)

          A list of updates being applied to the ACL.

          • UserNamesToRemove — (Array<String>)

            A list of user names being removed from the ACL

          • UserNamesToAdd — (Array<String>)

            A list of users being added to the ACL

        • Clusters — (Array<String>)

          A list of clusters associated with the ACL.

        • ARN — (String)

          The Amazon Resource Name (ARN) of the ACL

Returns:

  • (AWS.Request) —

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

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

Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.

Service Reference:

Examples:

Calling the createCluster operation

var params = {
  ACLName: 'STRING_VALUE', /* required */
  ClusterName: 'STRING_VALUE', /* required */
  NodeType: 'STRING_VALUE', /* required */
  AutoMinorVersionUpgrade: true || false,
  Description: 'STRING_VALUE',
  EngineVersion: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  MaintenanceWindow: 'STRING_VALUE',
  NumReplicasPerShard: 'NUMBER_VALUE',
  NumShards: 'NUMBER_VALUE',
  ParameterGroupName: 'STRING_VALUE',
  Port: 'NUMBER_VALUE',
  SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  SnapshotArns: [
    'STRING_VALUE',
    /* more items */
  ],
  SnapshotName: 'STRING_VALUE',
  SnapshotRetentionLimit: 'NUMBER_VALUE',
  SnapshotWindow: 'STRING_VALUE',
  SnsTopicArn: 'STRING_VALUE',
  SubnetGroupName: 'STRING_VALUE',
  TLSEnabled: true || false,
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
memorydb.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 name of the cluster. This value must be unique as it also serves as the cluster identifier.

    • NodeType — (String)

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

    • ParameterGroupName — (String)

      The name of the parameter group associated with the cluster.

    • Description — (String)

      An optional description of the cluster.

    • NumShards — (Integer)

      The number of shards the cluster will contain. The default value is 1.

    • NumReplicasPerShard — (Integer)

      The number of replicas to apply to each shard. The default value is 1. The maximum is 5.

    • SubnetGroupName — (String)

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

    • SecurityGroupIds — (Array<String>)

      A list of security group names to associate with this cluster.

    • MaintenanceWindow — (String)

      Specifies the weekly time range during which maintenance on the 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.

    • Port — (Integer)

      The port number on which each of the nodes accepts connections.

    • SnsTopicArn — (String)

      The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

    • TLSEnabled — (Boolean)

      A flag to enable in-transit encryption on the cluster.

    • KmsKeyId — (String)

      The ID of the KMS key used to encrypt the cluster.

    • SnapshotArns — (Array<String>)

      A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.

    • SnapshotName — (String)

      The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.

    • SnapshotRetentionLimit — (Integer)

      The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

    • Tags — (Array<map>)

      A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.

      • Key — (String)

        The key for the tag. May not be null.

      • Value — (String)

        The tag's value. May be null.

    • SnapshotWindow — (String)

      The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.

      Example: 05:00-09:00

      If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

    • ACLName — (String)

      The name of the Access Control List to associate with the cluster.

    • EngineVersion — (String)

      The version number of the Redis engine to be used for the cluster.

    • AutoMinorVersionUpgrade — (Boolean)

      When set to true, the cluster will automatically receive minor engine version upgrades after launch.

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)

        The newly-created cluster.

        • Name — (String)

          The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.

        • Description — (String)

          A description of the cluster

        • Status — (String)

          The status of the cluster. For example, Available, Updating, Creating.

        • PendingUpdates — (map)

          A group of settings that are currently being applied.

          • Resharding — (map)

            The status of an online resharding operation.

            • SlotMigration — (map)

              The status of the online resharding slot migration

              • ProgressPercentage — (Float)

                The percentage of the slot migration that is complete.

          • ACLs — (map)

            A list of ACLs associated with the cluster that are being updated

            • ACLToApply — (String)

              A list of ACLs pending to be applied.

          • ServiceUpdates — (Array<map>)

            A list of service updates being applied to the cluster

            • ServiceUpdateName — (String)

              The unique ID of the service update

            • Status — (String)

              The status of the service update

              Possible values include:
              • "available"
              • "in-progress"
              • "complete"
              • "scheduled"
        • NumberOfShards — (Integer)

          The number of shards in the cluster

        • Shards — (Array<map>)

          A list of shards that are members of the cluster.

          • Name — (String)

            The name of the shard

          • Status — (String)

            The current state of this replication group - creating, available, modifying, deleting.

          • Slots — (String)

            The keyspace for this shard.

          • Nodes — (Array<map>)

            A list containing information about individual nodes within the shard

            • Name — (String)

              The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.

            • Status — (String)

              The status of the service update on the node

            • AvailabilityZone — (String)

              The Availability Zone in which the node resides

            • CreateTime — (Date)

              The date and time when the node was created.

            • Endpoint — (map)

              The hostname for connecting to this node.

              • Address — (String)

                The DNS hostname of the node.

              • Port — (Integer)

                The port number that the engine is listening on.

          • NumberOfNodes — (Integer)

            The number of nodes in the shard

        • AvailabilityMode — (String)

          Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).

          Possible values include:
          • "singleaz"
          • "multiaz"
        • ClusterEndpoint — (map)

          The cluster's configuration endpoint

          • Address — (String)

            The DNS hostname of the node.

          • Port — (Integer)

            The port number that the engine is listening on.

        • NodeType — (String)

          The cluster's node type

        • EngineVersion — (String)

          The Redis engine version used by the cluster

        • EnginePatchVersion — (String)

          The Redis engine patch version used by the cluster

        • ParameterGroupName — (String)

          The name of the parameter group used by the cluster

        • ParameterGroupStatus — (String)

          The status of the parameter group used by the cluster, for example 'active' or 'applying'.

        • SecurityGroups — (Array<map>)

          A list of security groups used by the cluster

          • SecurityGroupId — (String)

            The identifier of the security group.

          • Status — (String)

            The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.

        • SubnetGroupName — (String)

          The name of the subnet group used by the cluster

        • TLSEnabled — (Boolean)

          A flag to indicate if In-transit encryption is enabled

        • KmsKeyId — (String)

          The ID of the KMS key used to encrypt the cluster

        • ARN — (String)

          The Amazon Resource Name (ARN) of the cluster.

        • SnsTopicArn — (String)

          The Amazon Resource Name (ARN) of the SNS notification topic

        • SnsTopicStatus — (String)

          The SNS topic must be in Active status to receive notifications

        • SnapshotRetentionLimit — (Integer)

          The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

        • MaintenanceWindow — (String)

          Specifies the weekly time range during which maintenance on the 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.

        • SnapshotWindow — (String)

          The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

        • ACLName — (String)

          The name of the Access Control List associated with this cluster.

        • AutoMinorVersionUpgrade — (Boolean)

          When set to true, the cluster will automatically receive minor engine version upgrades after launch.

Returns:

  • (AWS.Request) —

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

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

Creates a new MemoryDB parameter group. A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster. For more information, see Configuring engine parameters using parameter groups.

Service Reference:

Examples:

Calling the createParameterGroup operation

var params = {
  Family: 'STRING_VALUE', /* required */
  ParameterGroupName: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
memorydb.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.

    • Family — (String)

      The name of the parameter group family that the parameter group can be used with.

    • Description — (String)

      An optional description of the parameter group.

    • Tags — (Array<map>)

      A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

      • Key — (String)

        The key for the tag. May not be null.

      • Value — (String)

        The tag's value. May 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:

      • ParameterGroup — (map)

        The newly-created parameter group.

        • Name — (String)

          The name of the parameter group

        • Family — (String)

          The name of the parameter group family that this parameter group is compatible with.

        • Description — (String)

          A description of the parameter group

        • ARN — (String)

          The Amazon Resource Name (ARN) of the parameter group

Returns:

  • (AWS.Request) —

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

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

Creates a copy of an entire cluster at a specific moment in time.

Service Reference:

Examples:

Calling the createSnapshot operation

var params = {
  ClusterName: 'STRING_VALUE', /* required */
  SnapshotName: 'STRING_VALUE', /* required */
  KmsKeyId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
memorydb.createSnapshot(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 snapshot is created from this cluster.

    • SnapshotName — (String)

      A name for the snapshot being created.

    • KmsKeyId — (String)

      The ID of the KMS key used to encrypt the snapshot.

    • Tags — (Array<map>)

      A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

      • Key — (String)

        The key for the tag. May not be null.

      • Value — (String)

        The tag's value. May 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:

      • Snapshot — (map)

        The newly-created snapshot.

        • Name — (String)

          The name of the snapshot

        • Status — (String)

          The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

        • Source — (String)

          Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

        • KmsKeyId — (String)

          The ID of the KMS key used to encrypt the snapshot.

        • ARN — (String)

          The ARN (Amazon Resource Name) of the snapshot.

        • ClusterConfiguration — (map)

          The configuration of the cluster from which the snapshot was taken

          • Name — (String)

            The name of the cluster

          • Description — (String)

            The description of the cluster configuration

          • NodeType — (String)

            The node type used for the cluster

          • EngineVersion — (String)

            The Redis engine version used by the cluster

          • MaintenanceWindow — (String)

            The specified maintenance window for the cluster

          • TopicArn — (String)

            The Amazon Resource Name (ARN) of the SNS notification topic for the cluster

          • Port — (Integer)

            The port used by the cluster

          • ParameterGroupName — (String)

            The name of parameter group used by the cluster

          • SubnetGroupName — (String)

            The name of the subnet group used by the cluster

          • VpcId — (String)

            The ID of the VPC the cluster belongs to

          • SnapshotRetentionLimit — (Integer)

            The snapshot retention limit set by the cluster

          • SnapshotWindow — (String)

            The snapshot window set by the cluster

          • NumShards — (Integer)

            The number of shards in the cluster

          • Shards — (Array<map>)

            The list of shards in the cluster

            • Name — (String)

              The name of the shard

            • Configuration — (map)

              The configuration details of the shard

              • Slots — (String)

                A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.

              • ReplicaCount — (Integer)

                The number of read replica nodes in this shard.

            • Size — (String)

              The size of the shard's snapshot

            • SnapshotCreationTime — (Date)

              The date and time that the shard's snapshot was created

Returns:

  • (AWS.Request) —

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

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

Creates a subnet group. A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment. When you create a cluster in an Amazon VPC, you must specify a subnet group. MemoryDB uses that subnet group to choose a subnet and IP addresses within that subnet to associate with your nodes. For more information, see Subnets and subnet groups.

Service Reference:

Examples:

Calling the createSubnetGroup operation

var params = {
  SubnetGroupName: 'STRING_VALUE', /* required */
  SubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Description: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
memorydb.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)

      The name of the subnet group.

    • Description — (String)

      A description for the subnet group.

    • SubnetIds — (Array<String>)

      A list of VPC subnet IDs for the subnet group.

    • Tags — (Array<map>)

      A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

      • Key — (String)

        The key for the tag. May not be null.

      • Value — (String)

        The tag's value. May 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:

      • SubnetGroup — (map)

        The newly-created subnet group

        • Name — (String)

          The name of the subnet group

        • Description — (String)

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

          • Identifier — (String)

            The unique identifier for the subnet.

          • AvailabilityZone — (map)

            The Availability Zone where the subnet resides

            • Name — (String)

              The name of the Availability Zone.

        • ARN — (String)

          The ARN (Amazon Resource Name) of the subnet group.

Returns:

  • (AWS.Request) —

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

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

Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).

Service Reference:

Examples:

Calling the createUser operation

var params = {
  AccessString: 'STRING_VALUE', /* required */
  AuthenticationMode: { /* required */
    Passwords: [
      'STRING_VALUE',
      /* more items */
    ],
    Type: password
  },
  UserName: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
memorydb.createUser(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: {}) —
    • UserName — (String)

      The name of the user. This value must be unique as it also serves as the user identifier.

    • AuthenticationMode — (map)

      Denotes the user's authentication properties, such as whether it requires a password to authenticate.

      • Type — (String)

        Indicates whether the user requires a password to authenticate. All newly-created users require a password.

        Possible values include:
        • "password"
      • Passwords — (Array<String>)

        The password(s) used for authentication

    • AccessString — (String)

      Access permissions string used for this user.

    • Tags — (Array<map>)

      A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

      • Key — (String)

        The key for the tag. May not be null.

      • Value — (String)

        The tag's value. May 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:

      • User — (map)

        The newly-created user.

        • Name — (String)

          The name of the user

        • Status — (String)

          Indicates the user status. Can be "active", "modifying" or "deleting".

        • AccessString — (String)

          Access permissions string used for this user.

        • ACLNames — (Array<String>)

          The names of the Access Control Lists to which the user belongs

        • MinimumEngineVersion — (String)

          The minimum engine version supported for the user

        • Authentication — (map)

          Denotes whether the user requires a password to authenticate.

          • Type — (String)

            Indicates whether the user requires a password to authenticate.

            Possible values include:
            • "password"
            • "no-password"
          • PasswordCount — (Integer)

            The number of passwords belonging to the user. The maximum is two.

        • ARN — (String)

          The Amazon Resource Name (ARN) of the user.

Returns:

  • (AWS.Request) —

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

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

Deletes an Access Control List. The ACL must first be disassociated from the cluster before it can be deleted. For more information, see Authenticating users with Access Contol Lists (ACLs).

Service Reference:

Examples:

Calling the deleteACL operation

var params = {
  ACLName: 'STRING_VALUE' /* required */
};
memorydb.deleteACL(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: {}) —
    • ACLName — (String)

      The name of the Access Control List 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:

      • ACL — (map)

        The Access Control List object that has been deleted.

        • Name — (String)

          The name of the Access Control List

        • Status — (String)

          Indicates ACL status. Can be "creating", "active", "modifying", "deleting".

        • UserNames — (Array<String>)

          The list of user names that belong to the ACL.

        • MinimumEngineVersion — (String)

          The minimum engine version supported for the ACL

        • PendingChanges — (map)

          A list of updates being applied to the ACL.

          • UserNamesToRemove — (Array<String>)

            A list of user names being removed from the ACL

          • UserNamesToAdd — (Array<String>)

            A list of users being added to the ACL

        • Clusters — (Array<String>)

          A list of clusters associated with the ACL.

        • ARN — (String)

          The Amazon Resource Name (ARN) of the ACL

Returns:

  • (AWS.Request) —

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

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

Deletes a cluster. It also deletes all associated nodes and node endpoints

Service Reference:

Examples:

Calling the deleteCluster operation

var params = {
  ClusterName: 'STRING_VALUE', /* required */
  FinalSnapshotName: 'STRING_VALUE'
};
memorydb.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

    • FinalSnapshotName — (String)

      The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.

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)

        The cluster object that has been deleted

        • Name — (String)

          The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.

        • Description — (String)

          A description of the cluster

        • Status — (String)

          The status of the cluster. For example, Available, Updating, Creating.

        • PendingUpdates — (map)

          A group of settings that are currently being applied.

          • Resharding — (map)

            The status of an online resharding operation.

            • SlotMigration — (map)

              The status of the online resharding slot migration

              • ProgressPercentage — (Float)

                The percentage of the slot migration that is complete.

          • ACLs — (map)

            A list of ACLs associated with the cluster that are being updated

            • ACLToApply — (String)

              A list of ACLs pending to be applied.

          • ServiceUpdates — (Array<map>)

            A list of service updates being applied to the cluster

            • ServiceUpdateName — (String)

              The unique ID of the service update

            • Status — (String)

              The status of the service update

              Possible values include:
              • "available"
              • "in-progress"
              • "complete"
              • "scheduled"
        • NumberOfShards — (Integer)

          The number of shards in the cluster

        • Shards — (Array<map>)

          A list of shards that are members of the cluster.

          • Name — (String)

            The name of the shard

          • Status — (String)

            The current state of this replication group - creating, available, modifying, deleting.

          • Slots — (String)

            The keyspace for this shard.

          • Nodes — (Array<map>)

            A list containing information about individual nodes within the shard

            • Name — (String)

              The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.

            • Status — (String)

              The status of the service update on the node

            • AvailabilityZone — (String)

              The Availability Zone in which the node resides

            • CreateTime — (Date)

              The date and time when the node was created.

            • Endpoint — (map)

              The hostname for connecting to this node.

              • Address — (String)

                The DNS hostname of the node.

              • Port — (Integer)

                The port number that the engine is listening on.

          • NumberOfNodes — (Integer)

            The number of nodes in the shard

        • AvailabilityMode — (String)

          Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).

          Possible values include:
          • "singleaz"
          • "multiaz"
        • ClusterEndpoint — (map)

          The cluster's configuration endpoint

          • Address — (String)

            The DNS hostname of the node.

          • Port — (Integer)

            The port number that the engine is listening on.

        • NodeType — (String)

          The cluster's node type

        • EngineVersion — (String)

          The Redis engine version used by the cluster

        • EnginePatchVersion — (String)

          The Redis engine patch version used by the cluster

        • ParameterGroupName — (String)

          The name of the parameter group used by the cluster

        • ParameterGroupStatus — (String)

          The status of the parameter group used by the cluster, for example 'active' or 'applying'.

        • SecurityGroups — (Array<map>)

          A list of security groups used by the cluster

          • SecurityGroupId — (String)

            The identifier of the security group.

          • Status — (String)

            The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.

        • SubnetGroupName — (String)

          The name of the subnet group used by the cluster

        • TLSEnabled — (Boolean)

          A flag to indicate if In-transit encryption is enabled

        • KmsKeyId — (String)

          The ID of the KMS key used to encrypt the cluster

        • ARN — (String)

          The Amazon Resource Name (ARN) of the cluster.

        • SnsTopicArn — (String)

          The Amazon Resource Name (ARN) of the SNS notification topic

        • SnsTopicStatus — (String)

          The SNS topic must be in Active status to receive notifications

        • SnapshotRetentionLimit — (Integer)

          The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

        • MaintenanceWindow — (String)

          Specifies the weekly time range during which maintenance on the 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.

        • SnapshotWindow — (String)

          The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

        • ACLName — (String)

          The name of the Access Control List associated with this cluster.

        • AutoMinorVersionUpgrade — (Boolean)

          When set to true, the cluster will automatically receive minor engine version upgrades after launch.

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 clusters. You cannot delete the default parameter groups in your account.

Service Reference:

Examples:

Calling the deleteParameterGroup operation

var params = {
  ParameterGroupName: 'STRING_VALUE' /* required */
};
memorydb.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:

      • ParameterGroup — (map)

        The parameter group that has been deleted.

        • Name — (String)

          The name of the parameter group

        • Family — (String)

          The name of the parameter group family that this parameter group is compatible with.

        • Description — (String)

          A description of the parameter group

        • ARN — (String)

          The Amazon Resource Name (ARN) of the parameter group

Returns:

  • (AWS.Request) —

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

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

Deletes an existing snapshot. When you receive a successful response from this operation, MemoryDB immediately begins deleting the snapshot; you cannot cancel or revert this operation.

Service Reference:

Examples:

Calling the deleteSnapshot operation

var params = {
  SnapshotName: 'STRING_VALUE' /* required */
};
memorydb.deleteSnapshot(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: {}) —
    • SnapshotName — (String)

      The name of the snapshot 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:

      • Snapshot — (map)

        The snapshot object that has been deleted.

        • Name — (String)

          The name of the snapshot

        • Status — (String)

          The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

        • Source — (String)

          Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

        • KmsKeyId — (String)

          The ID of the KMS key used to encrypt the snapshot.

        • ARN — (String)

          The ARN (Amazon Resource Name) of the snapshot.

        • ClusterConfiguration — (map)

          The configuration of the cluster from which the snapshot was taken

          • Name — (String)

            The name of the cluster

          • Description — (String)

            The description of the cluster configuration

          • NodeType — (String)

            The node type used for the cluster

          • EngineVersion — (String)

            The Redis engine version used by the cluster

          • MaintenanceWindow — (String)

            The specified maintenance window for the cluster

          • TopicArn — (String)

            The Amazon Resource Name (ARN) of the SNS notification topic for the cluster

          • Port — (Integer)

            The port used by the cluster

          • ParameterGroupName — (String)

            The name of parameter group used by the cluster

          • SubnetGroupName — (String)

            The name of the subnet group used by the cluster

          • VpcId — (String)

            The ID of the VPC the cluster belongs to

          • SnapshotRetentionLimit — (Integer)

            The snapshot retention limit set by the cluster

          • SnapshotWindow — (String)

            The snapshot window set by the cluster

          • NumShards — (Integer)

            The number of shards in the cluster

          • Shards — (Array<map>)

            The list of shards in the cluster

            • Name — (String)

              The name of the shard

            • Configuration — (map)

              The configuration details of the shard

              • Slots — (String)

                A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.

              • ReplicaCount — (Integer)

                The number of read replica nodes in this shard.

            • Size — (String)

              The size of the shard's snapshot

            • SnapshotCreationTime — (Date)

              The date and time that the shard's snapshot was created

Returns:

  • (AWS.Request) —

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

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

Deletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters.

Service Reference:

Examples:

Calling the deleteSubnetGroup operation

var params = {
  SubnetGroupName: 'STRING_VALUE' /* required */
};
memorydb.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:

      • SubnetGroup — (map)

        The subnet group object that has been deleted.

        • Name — (String)

          The name of the subnet group

        • Description — (String)

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

          • Identifier — (String)

            The unique identifier for the subnet.

          • AvailabilityZone — (map)

            The Availability Zone where the subnet resides

            • Name — (String)

              The name of the Availability Zone.

        • ARN — (String)

          The ARN (Amazon Resource Name) of the subnet group.

Returns:

  • (AWS.Request) —

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

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

Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.

Service Reference:

Examples:

Calling the deleteUser operation

var params = {
  UserName: 'STRING_VALUE' /* required */
};
memorydb.deleteUser(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: {}) —
    • UserName — (String)

      The name of the user 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:

      • User — (map)

        The user object that has been deleted.

        • Name — (String)

          The name of the user

        • Status — (String)

          Indicates the user status. Can be "active", "modifying" or "deleting".

        • AccessString — (String)

          Access permissions string used for this user.

        • ACLNames — (Array<String>)

          The names of the Access Control Lists to which the user belongs

        • MinimumEngineVersion — (String)

          The minimum engine version supported for the user

        • Authentication — (map)

          Denotes whether the user requires a password to authenticate.

          • Type — (String)

            Indicates whether the user requires a password to authenticate.

            Possible values include:
            • "password"
            • "no-password"
          • PasswordCount — (Integer)

            The number of passwords belonging to the user. The maximum is two.

        • ARN — (String)

          The Amazon Resource Name (ARN) of the user.

Returns:

  • (AWS.Request) —

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

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

Returns a list of ACLs

Service Reference:

Examples:

Calling the describeACLs operation

var params = {
  ACLName: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
memorydb.describeACLs(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: {}) —
    • ACLName — (String)

      The name of the ACL

    • MaxResults — (Integer)

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

    • NextToken — (String)

      An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

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:

      • ACLs — (Array<map>)

        The list of ACLs

        • Name — (String)

          The name of the Access Control List

        • Status — (String)

          Indicates ACL status. Can be "creating", "active", "modifying", "deleting".

        • UserNames — (Array<String>)

          The list of user names that belong to the ACL.

        • MinimumEngineVersion — (String)

          The minimum engine version supported for the ACL

        • PendingChanges — (map)

          A list of updates being applied to the ACL.

          • UserNamesToRemove — (Array<String>)

            A list of user names being removed from the ACL

          • UserNamesToAdd — (Array<String>)

            A list of users being added to the ACL

        • Clusters — (Array<String>)

          A list of clusters associated with the ACL.

        • ARN — (String)

          The Amazon Resource Name (ARN) of the ACL

      • NextToken — (String)

        If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Returns:

  • (AWS.Request) —

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

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

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.

Service Reference:

Examples:

Calling the describeClusters operation

var params = {
  ClusterName: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ShowShardDetails: true || false
};
memorydb.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: {}) —
    • ClusterName — (String)

      The name of the cluster

    • MaxResults — (Integer)

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

    • NextToken — (String)

      An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

    • ShowShardDetails — (Boolean)

      An optional flag that can be included in the request to retrieve information about the individual shard(s).

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)

        An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

      • Clusters — (Array<map>)

        A list of clusters

        • Name — (String)

          The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.

        • Description — (String)

          A description of the cluster

        • Status — (String)

          The status of the cluster. For example, Available, Updating, Creating.

        • PendingUpdates — (map)

          A group of settings that are currently being applied.

          • Resharding — (map)

            The status of an online resharding operation.

            • SlotMigration — (map)

              The status of the online resharding slot migration

              • ProgressPercentage — (Float)

                The percentage of the slot migration that is complete.

          • ACLs — (map)

            A list of ACLs associated with the cluster that are being updated

            • ACLToApply — (String)

              A list of ACLs pending to be applied.

          • ServiceUpdates — (Array<map>)

            A list of service updates being applied to the cluster

            • ServiceUpdateName — (String)

              The unique ID of the service update

            • Status — (String)

              The status of the service update

              Possible values include:
              • "available"
              • "in-progress"
              • "complete"
              • "scheduled"
        • NumberOfShards — (Integer)

          The number of shards in the cluster

        • Shards — (Array<map>)

          A list of shards that are members of the cluster.

          • Name — (String)

            The name of the shard

          • Status — (String)

            The current state of this replication group - creating, available, modifying, deleting.

          • Slots — (String)

            The keyspace for this shard.

          • Nodes — (Array<map>)

            A list containing information about individual nodes within the shard

            • Name — (String)

              The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.

            • Status — (String)

              The status of the service update on the node

            • AvailabilityZone — (String)

              The Availability Zone in which the node resides

            • CreateTime — (Date)

              The date and time when the node was created.

            • Endpoint — (map)

              The hostname for connecting to this node.

              • Address — (String)

                The DNS hostname of the node.

              • Port — (Integer)

                The port number that the engine is listening on.

          • NumberOfNodes — (Integer)

            The number of nodes in the shard

        • AvailabilityMode — (String)

          Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).

          Possible values include:
          • "singleaz"
          • "multiaz"
        • ClusterEndpoint — (map)

          The cluster's configuration endpoint

          • Address — (String)

            The DNS hostname of the node.

          • Port — (Integer)

            The port number that the engine is listening on.

        • NodeType — (String)

          The cluster's node type

        • EngineVersion — (String)

          The Redis engine version used by the cluster

        • EnginePatchVersion — (String)

          The Redis engine patch version used by the cluster

        • ParameterGroupName — (String)

          The name of the parameter group used by the cluster

        • ParameterGroupStatus — (String)

          The status of the parameter group used by the cluster, for example 'active' or 'applying'.

        • SecurityGroups — (Array<map>)

          A list of security groups used by the cluster

          • SecurityGroupId — (String)

            The identifier of the security group.

          • Status — (String)

            The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.

        • SubnetGroupName — (String)

          The name of the subnet group used by the cluster

        • TLSEnabled — (Boolean)

          A flag to indicate if In-transit encryption is enabled

        • KmsKeyId — (String)

          The ID of the KMS key used to encrypt the cluster

        • ARN — (String)

          The Amazon Resource Name (ARN) of the cluster.

        • SnsTopicArn — (String)

          The Amazon Resource Name (ARN) of the SNS notification topic

        • SnsTopicStatus — (String)

          The SNS topic must be in Active status to receive notifications

        • SnapshotRetentionLimit — (Integer)

          The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

        • MaintenanceWindow — (String)

          Specifies the weekly time range during which maintenance on the 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.

        • SnapshotWindow — (String)

          The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

        • ACLName — (String)

          The name of the Access Control List associated with this cluster.

        • AutoMinorVersionUpgrade — (Boolean)

          When set to true, the cluster will automatically receive minor engine version upgrades after launch.

Returns:

  • (AWS.Request) —

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

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

Returns a list of the available Redis engine versions.

Service Reference:

Examples:

Calling the describeEngineVersions operation

var params = {
  DefaultOnly: true || false,
  EngineVersion: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ParameterGroupFamily: 'STRING_VALUE'
};
memorydb.describeEngineVersions(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: {}) —
    • EngineVersion — (String)

      The Redis engine version

    • ParameterGroupFamily — (String)

      The name of a specific parameter group family to return details for.

    • MaxResults — (Integer)

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

    • NextToken — (String)

      An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

    • DefaultOnly — (Boolean)

      If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

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)

        An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

      • EngineVersions — (Array<map>)

        A list of engine version details. Each element in the list contains detailed information about one engine version.

        • EngineVersion — (String)

          The engine version

        • EnginePatchVersion — (String)

          The patched engine version

        • ParameterGroupFamily — (String)

          Specifies the name of the parameter group family to which the engine default parameters apply.

Returns:

  • (AWS.Request) —

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

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

Returns events related to clusters, security groups, and parameter groups. You can obtain events specific to a particular cluster, security group, 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: 'NUMBER_VALUE',
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SourceName: 'STRING_VALUE',
  SourceType: node | parameter-group | subnet-group | cluster | user | acl,
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
memorydb.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 are returned. If not specified, 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:
      • "node"
      • "parameter-group"
      • "subnet-group"
      • "cluster"
      • "user"
      • "acl"
    • StartTime — (Date)

      The beginning of the time interval to retrieve events for, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z

    • EndTime — (Date)

      The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z

    • Duration — (Integer)

      The number of minutes worth of events to retrieve.

    • MaxResults — (Integer)

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

    • NextToken — (String)

      An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

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)

        An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

      • Events — (Array<map>)

        A list of events. Each element in the list contains detailed information about one event.

        • SourceName — (String)

          The name for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster.

        • SourceType — (String)

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

          Possible values include:
          • "node"
          • "parameter-group"
          • "subnet-group"
          • "cluster"
          • "user"
          • "acl"
        • Message — (String)

          The text of 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 contains only the descriptions for that group.

Service Reference:

Examples:

Calling the describeParameterGroups operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ParameterGroupName: 'STRING_VALUE'
};
memorydb.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: {}) —
    • ParameterGroupName — (String)

      The name of a specific parameter group to return details for.

    • MaxResults — (Integer)

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

    • NextToken — (String)

      An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

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)

        An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

      • ParameterGroups — (Array<map>)

        A list of parameter groups. Each element in the list contains detailed information about one parameter group.

        • Name — (String)

          The name of the parameter group

        • Family — (String)

          The name of the parameter group family that this parameter group is compatible with.

        • Description — (String)

          A description of the parameter group

        • ARN — (String)

          The Amazon Resource Name (ARN) 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: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
memorydb.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)

      he name of a specific parameter group to return details for.

    • MaxResults — (Integer)

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

    • NextToken — (String)

      An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

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)

        An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

      • Parameters — (Array<map>)

        A list of parameters specific to a particular parameter group. Each element in the list contains detailed information about one parameter.

        • Name — (String)

          The name of the parameter

        • Value — (String)

          The value of the parameter

        • Description — (String)

          A description of the parameter

        • DataType — (String)

          The parameter's data type

        • AllowedValues — (String)

          The valid range of values for the parameter.

        • MinimumEngineVersion — (String)

          The earliest engine version to which the parameter can apply.

Returns:

  • (AWS.Request) —

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

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

Returns details of the service updates

Service Reference:

Examples:

Calling the describeServiceUpdates operation

var params = {
  ClusterNames: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ServiceUpdateName: 'STRING_VALUE',
  Status: [
    available | in-progress | complete | scheduled,
    /* more items */
  ]
};
memorydb.describeServiceUpdates(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: {}) —
    • ServiceUpdateName — (String)

      The unique ID of the service update to describe.

    • ClusterNames — (Array<String>)

      The list of cluster names to identify service updates to apply

    • Status — (Array<String>)

      The status(es) of the service updates to filter on

    • MaxResults — (Integer)

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

    • NextToken — (String)

      An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

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)

        An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

      • ServiceUpdates — (Array<map>)

        A list of service updates

        • ClusterName — (String)

          The name of the cluster to which the service update applies

        • ServiceUpdateName — (String)

          The unique ID of the service update

        • ReleaseDate — (Date)

          The date when the service update is initially available

        • Description — (String)

          Provides details of the service update

        • Status — (String)

          The status of the service update

          Possible values include:
          • "available"
          • "in-progress"
          • "complete"
          • "scheduled"
        • Type — (String)

          Reflects the nature of the service update

          Possible values include:
          • "security-update"
        • NodesUpdated — (String)

          A list of nodes updated by the service update

        • AutoUpdateStartDate — (Date)

          The date at which the service update will be automatically applied

Returns:

  • (AWS.Request) —

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

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

Returns information about cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cluster.

Service Reference:

Examples:

Calling the describeSnapshots operation

var params = {
  ClusterName: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ShowDetail: true || false,
  SnapshotName: 'STRING_VALUE',
  Source: 'STRING_VALUE'
};
memorydb.describeSnapshots(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)

      A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

    • SnapshotName — (String)

      A user-supplied name of the snapshot. If this parameter is specified, only this named snapshot is described.

    • Source — (String)

      If set to system, the output shows snapshots that were automatically created by MemoryDB. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

    • NextToken — (String)

      An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

    • MaxResults — (Integer)

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

    • ShowDetail — (Boolean)

      A Boolean value which if true, the shard configuration is included in the snapshot description.

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)

        An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

      • Snapshots — (Array<map>)

        A list of snapshots. Each item in the list contains detailed information about one snapshot.

        • Name — (String)

          The name of the snapshot

        • Status — (String)

          The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

        • Source — (String)

          Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

        • KmsKeyId — (String)

          The ID of the KMS key used to encrypt the snapshot.

        • ARN — (String)

          The ARN (Amazon Resource Name) of the snapshot.

        • ClusterConfiguration — (map)

          The configuration of the cluster from which the snapshot was taken

          • Name — (String)

            The name of the cluster

          • Description — (String)

            The description of the cluster configuration

          • NodeType — (String)

            The node type used for the cluster

          • EngineVersion — (String)

            The Redis engine version used by the cluster

          • MaintenanceWindow — (String)

            The specified maintenance window for the cluster

          • TopicArn — (String)

            The Amazon Resource Name (ARN) of the SNS notification topic for the cluster

          • Port — (Integer)

            The port used by the cluster

          • ParameterGroupName — (String)

            The name of parameter group used by the cluster

          • SubnetGroupName — (String)

            The name of the subnet group used by the cluster

          • VpcId — (String)

            The ID of the VPC the cluster belongs to

          • SnapshotRetentionLimit — (Integer)

            The snapshot retention limit set by the cluster

          • SnapshotWindow — (String)

            The snapshot window set by the cluster

          • NumShards — (Integer)

            The number of shards in the cluster

          • Shards — (Array<map>)

            The list of shards in the cluster

            • Name — (String)

              The name of the shard

            • Configuration — (map)

              The configuration details of the shard

              • Slots — (String)

                A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.

              • ReplicaCount — (Integer)

                The number of read replica nodes in this shard.

            • Size — (String)

              The size of the shard's snapshot

            • SnapshotCreationTime — (Date)

              The date and time that the shard's snapshot was created

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 contains only the description of that group.

Service Reference:

Examples:

Calling the describeSubnetGroups operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SubnetGroupName: 'STRING_VALUE'
};
memorydb.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: {}) —
    • SubnetGroupName — (String)

      The name of the subnet group to return details for.

    • MaxResults — (Integer)

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

    • NextToken — (String)

      An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

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)

        An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

      • SubnetGroups — (Array<map>)

        A list of subnet groups. Each element in the list contains detailed information about one group.

        • Name — (String)

          The name of the subnet group

        • Description — (String)

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

          • Identifier — (String)

            The unique identifier for the subnet.

          • AvailabilityZone — (map)

            The Availability Zone where the subnet resides

            • Name — (String)

              The name of the Availability Zone.

        • ARN — (String)

          The ARN (Amazon Resource Name) of the subnet group.

Returns:

  • (AWS.Request) —

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

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

Returns a list of users.

Service Reference:

Examples:

Calling the describeUsers operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  UserName: 'STRING_VALUE'
};
memorydb.describeUsers(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: {}) —
    • UserName — (String)

      The name of the user

    • Filters — (Array<map>)

      Filter to determine the list of users to return.

      • Name — required — (String)

        The property being filtered. For example, UserName.

      • Values — required — (Array<String>)

        The property values to filter on. For example, "user-123".

    • MaxResults — (Integer)

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

    • NextToken — (String)

      An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

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:

      • Users — (Array<map>)

        A list of users.

        • Name — (String)

          The name of the user

        • Status — (String)

          Indicates the user status. Can be "active", "modifying" or "deleting".

        • AccessString — (String)

          Access permissions string used for this user.

        • ACLNames — (Array<String>)

          The names of the Access Control Lists to which the user belongs

        • MinimumEngineVersion — (String)

          The minimum engine version supported for the user

        • Authentication — (map)

          Denotes whether the user requires a password to authenticate.

          • Type — (String)

            Indicates whether the user requires a password to authenticate.

            Possible values include:
            • "password"
            • "no-password"
          • PasswordCount — (Integer)

            The number of passwords belonging to the user. The maximum is two.

        • ARN — (String)

          The Amazon Resource Name (ARN) of the user.

      • NextToken — (String)

        An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Returns:

  • (AWS.Request) —

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

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

Used to failover a shard

Service Reference:

Examples:

Calling the failoverShard operation

var params = {
  ClusterName: 'STRING_VALUE', /* required */
  ShardName: 'STRING_VALUE' /* required */
};
memorydb.failoverShard(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 being failed over

    • ShardName — (String)

      The name of the shard

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)

        The cluster being failed over

        • Name — (String)

          The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.

        • Description — (String)

          A description of the cluster

        • Status — (String)

          The status of the cluster. For example, Available, Updating, Creating.

        • PendingUpdates — (map)

          A group of settings that are currently being applied.

          • Resharding — (map)

            The status of an online resharding operation.

            • SlotMigration — (map)

              The status of the online resharding slot migration

              • ProgressPercentage — (Float)

                The percentage of the slot migration that is complete.

          • ACLs — (map)

            A list of ACLs associated with the cluster that are being updated

            • ACLToApply — (String)

              A list of ACLs pending to be applied.

          • ServiceUpdates — (Array<map>)

            A list of service updates being applied to the cluster

            • ServiceUpdateName — (String)

              The unique ID of the service update

            • Status — (String)

              The status of the service update

              Possible values include:
              • "available"
              • "in-progress"
              • "complete"
              • "scheduled"
        • NumberOfShards — (Integer)

          The number of shards in the cluster

        • Shards — (Array<map>)

          A list of shards that are members of the cluster.

          • Name — (String)

            The name of the shard

          • Status — (String)

            The current state of this replication group - creating, available, modifying, deleting.

          • Slots — (String)

            The keyspace for this shard.

          • Nodes — (Array<map>)

            A list containing information about individual nodes within the shard

            • Name — (String)

              The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.

            • Status — (String)

              The status of the service update on the node

            • AvailabilityZone — (String)

              The Availability Zone in which the node resides

            • CreateTime — (Date)

              The date and time when the node was created.

            • Endpoint — (map)

              The hostname for connecting to this node.

              • Address — (String)

                The DNS hostname of the node.

              • Port — (Integer)

                The port number that the engine is listening on.

          • NumberOfNodes — (Integer)

            The number of nodes in the shard

        • AvailabilityMode — (String)

          Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).

          Possible values include:
          • "singleaz"
          • "multiaz"
        • ClusterEndpoint — (map)

          The cluster's configuration endpoint

          • Address — (String)

            The DNS hostname of the node.

          • Port — (Integer)

            The port number that the engine is listening on.

        • NodeType — (String)

          The cluster's node type

        • EngineVersion — (String)

          The Redis engine version used by the cluster

        • EnginePatchVersion — (String)

          The Redis engine patch version used by the cluster

        • ParameterGroupName — (String)

          The name of the parameter group used by the cluster

        • ParameterGroupStatus — (String)

          The status of the parameter group used by the cluster, for example 'active' or 'applying'.

        • SecurityGroups — (Array<map>)

          A list of security groups used by the cluster

          • SecurityGroupId — (String)

            The identifier of the security group.

          • Status — (String)

            The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.

        • SubnetGroupName — (String)

          The name of the subnet group used by the cluster

        • TLSEnabled — (Boolean)

          A flag to indicate if In-transit encryption is enabled

        • KmsKeyId — (String)

          The ID of the KMS key used to encrypt the cluster

        • ARN — (String)

          The Amazon Resource Name (ARN) of the cluster.

        • SnsTopicArn — (String)

          The Amazon Resource Name (ARN) of the SNS notification topic

        • SnsTopicStatus — (String)

          The SNS topic must be in Active status to receive notifications

        • SnapshotRetentionLimit — (Integer)

          The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

        • MaintenanceWindow — (String)

          Specifies the weekly time range during which maintenance on the 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.

        • SnapshotWindow — (String)

          The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

        • ACLName — (String)

          The name of the Access Control List associated with this cluster.

        • AutoMinorVersionUpgrade — (Boolean)

          When set to true, the cluster will automatically receive minor engine version upgrades after launch.

Returns:

  • (AWS.Request) —

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

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

Lists all available node types that you can scale to from your cluster's current node type. When you use the UpdateCluster operation to scale your cluster, the value of the NodeType parameter must be one of the node types returned by this operation.

Service Reference:

Examples:

Calling the listAllowedNodeTypeUpdates operation

var params = {
  ClusterName: 'STRING_VALUE' /* required */
};
memorydb.listAllowedNodeTypeUpdates(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 you want to scale. MemoryDB uses the cluster name to identify the current node type being used by this cluster, and from that to create a list of node types you can scale up to.

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:

      • ScaleUpNodeTypes — (Array<String>)

        A list node types which you can use to scale up your cluster.

      • ScaleDownNodeTypes — (Array<String>)

        A list node types which you can use to scale down your cluster.

Returns:

  • (AWS.Request) —

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

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

Lists all tags currently on a named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track your MemoryDB resources. For more information, see Tagging your MemoryDB resources

Service Reference:

Examples:

Calling the listTags operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
memorydb.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: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource for which you want the list of tags

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:

      • TagList — (Array<map>)

        A list of tags as key-value pairs.

        • Key — (String)

          The key for the tag. May not be null.

        • Value — (String)

          The tag's value. May be null.

Returns:

  • (AWS.Request) —

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

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

Modifies the parameters of a parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire parameter group, specify the AllParameters and ParameterGroupName parameters.

Service Reference:

Examples:

Calling the resetParameterGroup operation

var params = {
  ParameterGroupName: 'STRING_VALUE', /* required */
  AllParameters: true || false,
  ParameterNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
memorydb.resetParameterGroup(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 reset.

    • AllParameters — (Boolean)

      If true, all parameters in the parameter group are reset to their default values. If false, only the parameters listed by ParameterNames are reset to their default values.

    • ParameterNames — (Array<String>)

      An array of parameter names to reset to their default values. If AllParameters is true, do not use ParameterNames. If AllParameters is false, you must specify the name of at least one parameter to reset.

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 being reset.

        • Name — (String)

          The name of the parameter group

        • Family — (String)

          The name of the parameter group family that this parameter group is compatible with.

        • Description — (String)

          A description of the parameter group

        • ARN — (String)

          The Amazon Resource Name (ARN) of the parameter group

Returns:

  • (AWS.Request) —

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

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

A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. For more information, see Resource-level permissions.

For example, you can use cost-allocation tags to your MemoryDB resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
memorydb.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: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource to which the tags are to be added

    • Tags — (Array<map>)

      A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

      • Key — (String)

        The key for the tag. May not be null.

      • Value — (String)

        The tag's value. May 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:

      • TagList — (Array<map>)

        A list of tags as key-value pairs.

        • Key — (String)

          The key for the tag. May not be null.

        • Value — (String)

          The tag's value. May be null.

Returns:

  • (AWS.Request) —

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

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

Use this operation to remove tags on a resource

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
memorydb.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: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource to which the tags are to be removed

    • TagKeys — (Array<String>)

      The list of keys of the tags that are to be removed

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:

      • TagList — (Array<map>)

        The list of tags removed

        • Key — (String)

          The key for the tag. May not be null.

        • Value — (String)

          The tag's value. May be null.

Returns:

  • (AWS.Request) —

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

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

Changes the list of users that belong to the Access Control List.

Service Reference:

Examples:

Calling the updateACL operation

var params = {
  ACLName: 'STRING_VALUE', /* required */
  UserNamesToAdd: [
    'STRING_VALUE',
    /* more items */
  ],
  UserNamesToRemove: [
    'STRING_VALUE',
    /* more items */
  ]
};
memorydb.updateACL(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: {}) —
    • ACLName — (String)

      The name of the Access Control List

    • UserNamesToAdd — (Array<String>)

      The list of users to add to the Access Control List

    • UserNamesToRemove — (Array<String>)

      The list of users to remove from the Access Control List

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:

      • ACL — (map)

        The updated Access Control List

        • Name — (String)

          The name of the Access Control List

        • Status — (String)

          Indicates ACL status. Can be "creating", "active", "modifying", "deleting".

        • UserNames — (Array<String>)

          The list of user names that belong to the ACL.

        • MinimumEngineVersion — (String)

          The minimum engine version supported for the ACL

        • PendingChanges — (map)

          A list of updates being applied to the ACL.

          • UserNamesToRemove — (Array<String>)

            A list of user names being removed from the ACL

          • UserNamesToAdd — (Array<String>)

            A list of users being added to the ACL

        • Clusters — (Array<String>)

          A list of clusters associated with the ACL.

        • ARN — (String)

          The Amazon Resource Name (ARN) of the ACL

Returns:

  • (AWS.Request) —

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

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

Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration settings by specifying the settings and the new values.

Service Reference:

Examples:

Calling the updateCluster operation

var params = {
  ClusterName: 'STRING_VALUE', /* required */
  ACLName: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  EngineVersion: 'STRING_VALUE',
  MaintenanceWindow: 'STRING_VALUE',
  NodeType: 'STRING_VALUE',
  ParameterGroupName: 'STRING_VALUE',
  ReplicaConfiguration: {
    ReplicaCount: 'NUMBER_VALUE'
  },
  SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  ShardConfiguration: {
    ShardCount: 'NUMBER_VALUE'
  },
  SnapshotRetentionLimit: 'NUMBER_VALUE',
  SnapshotWindow: 'STRING_VALUE',
  SnsTopicArn: 'STRING_VALUE',
  SnsTopicStatus: 'STRING_VALUE'
};
memorydb.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 cluster to update

    • Description — (String)

      The description of the cluster to update

    • SecurityGroupIds — (Array<String>)

      The SecurityGroupIds to update

    • MaintenanceWindow — (String)

      The maintenance window to update

    • SnsTopicArn — (String)

      The SNS topic ARN to update

    • SnsTopicStatus — (String)

      The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

    • ParameterGroupName — (String)

      The name of the parameter group to update

    • SnapshotWindow — (String)

      The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.

    • SnapshotRetentionLimit — (Integer)

      The number of days for which MemoryDB retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

    • NodeType — (String)

      A valid node type that you want to scale this cluster up or down to.

    • EngineVersion — (String)

      The upgraded version of the engine to be run on the nodes. You can upgrade to a newer engine version, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.

    • ReplicaConfiguration — (map)

      The number of replicas that will reside in each shard

      • ReplicaCount — (Integer)

        The number of replicas to scale up or down to

    • ShardConfiguration — (map)

      The number of shards in the cluster

      • ShardCount — (Integer)

        The number of shards in the cluster

    • ACLName — (String)

      The Access Control List that is associated with 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)

        The updated cluster

        • Name — (String)

          The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.

        • Description — (String)

          A description of the cluster

        • Status — (String)

          The status of the cluster. For example, Available, Updating, Creating.

        • PendingUpdates — (map)

          A group of settings that are currently being applied.

          • Resharding — (map)

            The status of an online resharding operation.

            • SlotMigration — (map)

              The status of the online resharding slot migration

              • ProgressPercentage — (Float)

                The percentage of the slot migration that is complete.

          • ACLs — (map)

            A list of ACLs associated with the cluster that are being updated

            • ACLToApply — (String)

              A list of ACLs pending to be applied.

          • ServiceUpdates — (Array<map>)

            A list of service updates being applied to the cluster

            • ServiceUpdateName — (String)

              The unique ID of the service update

            • Status — (String)

              The status of the service update

              Possible values include:
              • "available"
              • "in-progress"
              • "complete"
              • "scheduled"
        • NumberOfShards — (Integer)

          The number of shards in the cluster

        • Shards — (Array<map>)

          A list of shards that are members of the cluster.

          • Name — (String)

            The name of the shard

          • Status — (String)

            The current state of this replication group - creating, available, modifying, deleting.

          • Slots — (String)

            The keyspace for this shard.

          • Nodes — (Array<map>)

            A list containing information about individual nodes within the shard

            • Name — (String)

              The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.

            • Status — (String)

              The status of the service update on the node

            • AvailabilityZone — (String)

              The Availability Zone in which the node resides

            • CreateTime — (Date)

              The date and time when the node was created.

            • Endpoint — (map)

              The hostname for connecting to this node.

              • Address — (String)

                The DNS hostname of the node.

              • Port — (Integer)

                The port number that the engine is listening on.

          • NumberOfNodes — (Integer)

            The number of nodes in the shard

        • AvailabilityMode — (String)

          Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).

          Possible values include:
          • "singleaz"
          • "multiaz"
        • ClusterEndpoint — (map)

          The cluster's configuration endpoint

          • Address — (String)

            The DNS hostname of the node.

          • Port — (Integer)

            The port number that the engine is listening on.

        • NodeType — (String)

          The cluster's node type

        • EngineVersion — (String)

          The Redis engine version used by the cluster

        • EnginePatchVersion — (String)

          The Redis engine patch version used by the cluster

        • ParameterGroupName — (String)

          The name of the parameter group used by the cluster

        • ParameterGroupStatus — (String)

          The status of the parameter group used by the cluster, for example 'active' or 'applying'.

        • SecurityGroups — (Array<map>)

          A list of security groups used by the cluster

          • SecurityGroupId — (String)

            The identifier of the security group.

          • Status — (String)

            The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.

        • SubnetGroupName — (String)

          The name of the subnet group used by the cluster

        • TLSEnabled — (Boolean)

          A flag to indicate if In-transit encryption is enabled

        • KmsKeyId — (String)

          The ID of the KMS key used to encrypt the cluster

        • ARN — (String)

          The Amazon Resource Name (ARN) of the cluster.

        • SnsTopicArn — (String)

          The Amazon Resource Name (ARN) of the SNS notification topic

        • SnsTopicStatus — (String)

          The SNS topic must be in Active status to receive notifications

        • SnapshotRetentionLimit — (Integer)

          The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

        • MaintenanceWindow — (String)

          Specifies the weekly time range during which maintenance on the 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.

        • SnapshotWindow — (String)

          The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

        • ACLName — (String)

          The name of the Access Control List associated with this cluster.

        • AutoMinorVersionUpgrade — (Boolean)

          When set to true, the cluster will automatically receive minor engine version upgrades after launch.

Returns:

  • (AWS.Request) —

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

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

Updates 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 */
  ]
};
memorydb.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 to update.

    • ParameterNameValues — (Array<map>)

      An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be updated per request.

      • 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 updated parameter group

        • Name — (String)

          The name of the parameter group

        • Family — (String)

          The name of the parameter group family that this parameter group is compatible with.

        • Description — (String)

          A description of the parameter group

        • ARN — (String)

          The Amazon Resource Name (ARN) of the parameter group

Returns:

  • (AWS.Request) —

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

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

Updates a subnet group. For more information, see Updating a subnet group

Service Reference:

Examples:

Calling the updateSubnetGroup operation

var params = {
  SubnetGroupName: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  SubnetIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
memorydb.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>)

      The EC2 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)

        The updated subnet group

        • Name — (String)

          The name of the subnet group

        • Description — (String)

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

          • Identifier — (String)

            The unique identifier for the subnet.

          • AvailabilityZone — (map)

            The Availability Zone where the subnet resides

            • Name — (String)

              The name of the Availability Zone.

        • ARN — (String)

          The ARN (Amazon Resource Name) of the subnet group.

Returns:

  • (AWS.Request) —

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

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

Changes user password(s) and/or access string.

Service Reference:

Examples:

Calling the updateUser operation

var params = {
  UserName: 'STRING_VALUE', /* required */
  AccessString: 'STRING_VALUE',
  AuthenticationMode: {
    Passwords: [
      'STRING_VALUE',
      /* more items */
    ],
    Type: password
  }
};
memorydb.updateUser(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: {}) —
    • UserName — (String)

      The name of the user

    • AuthenticationMode — (map)

      Denotes the user's authentication properties, such as whether it requires a password to authenticate.

      • Type — (String)

        Indicates whether the user requires a password to authenticate. All newly-created users require a password.

        Possible values include:
        • "password"
      • Passwords — (Array<String>)

        The password(s) used for authentication

    • AccessString — (String)

      Access permissions string used for this user.

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:

      • User — (map)

        The updated user

        • Name — (String)

          The name of the user

        • Status — (String)

          Indicates the user status. Can be "active", "modifying" or "deleting".

        • AccessString — (String)

          Access permissions string used for this user.

        • ACLNames — (Array<String>)

          The names of the Access Control Lists to which the user belongs

        • MinimumEngineVersion — (String)

          The minimum engine version supported for the user

        • Authentication — (map)

          Denotes whether the user requires a password to authenticate.

          • Type — (String)

            Indicates whether the user requires a password to authenticate.

            Possible values include:
            • "password"
            • "no-password"
          • PasswordCount — (Integer)

            The number of passwords belonging to the user. The maximum is two.

        • ARN — (String)

          The Amazon Resource Name (ARN) of the user.

Returns:

  • (AWS.Request) —

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