Class: AWS.MemoryDB

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 OSS 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

      • DataTiering — (String)

        Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

        Possible values include:
        • "true"
        • "false"

Returns:

• (AWS.Request) —

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

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.

var params = {
  ACLName: 'STRING_VALUE', /* required */
  ClusterName: 'STRING_VALUE', /* required */
  NodeType: 'STRING_VALUE', /* required */
  AutoMinorVersionUpgrade: true || false,
  DataTiering: 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.

    Valid values for ddd are:

    • sun

    • mon

    • tue

    • wed

    • thu

    • fri

    • sat

    Example: sun:23:00-mon:01:30

  • 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 OSS engine to be used for the cluster.

  • AutoMinorVersionUpgrade — (Boolean)

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

  • DataTiering — (Boolean)

    Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

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 OSS engine version used by the cluster

      • EnginePatchVersion — (String)

        The Redis OSS 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.

      • DataTiering — (String)

        Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

        Possible values include:
        • "true"
        • "false"

Returns:

• (AWS.Request) —

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

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.

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 OSS 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

      • DataTiering — (String)

        Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

        Possible values include:
        • "true"
        • "false"

Returns:

• (AWS.Request) —

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

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.

var params = {
  AccessString: 'STRING_VALUE', /* required */
  AuthenticationMode: { /* required */
    Passwords: [
      'STRING_VALUE',
      /* more items */
    ],
    Type: password | iam
  },
  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"
      • "iam"
    • 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"
          • "iam"
        • 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.

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.

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 OSS engine version used by the cluster

      • EnginePatchVersion — (String)

        The Redis OSS 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.

      • DataTiering — (String)

        Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

        Possible values include:
        • "true"
        • "false"

Returns:

• (AWS.Request) —

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

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.

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 OSS 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

      • DataTiering — (String)

        Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

        Possible values include:
        • "true"
        • "false"

Returns:

• (AWS.Request) —

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

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.

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"
          • "iam"
        • 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.

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.

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 OSS engine version used by the cluster

      • EnginePatchVersion — (String)

        The Redis OSS 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.

      • DataTiering — (String)

        Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

        Possible values include:
        • "true"
        • "false"

Returns:

• (AWS.Request) —

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

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

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.

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.

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.

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

    The reserved node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

  • ReservedNodesOfferingId — (String)

    The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

  • NodeType — (String)

    The node type filter value. Use this parameter to show only those reservations matching the specified node type. For more information, see Supported node types.

  • Duration — (String)

    The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

  • OfferingType — (String)

    The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid values: "All Upfront"|"Partial Upfront"| "No Upfront"

  • MaxResults — (Integer)

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

  • NextToken — (String)

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

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 marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • ReservedNodes — (Array<map>)

      Returns information about reserved nodes for this account, or about a specified reserved node.

      • ReservationId — (String)

        A customer-specified identifier to track this reservation.

      • ReservedNodesOfferingId — (String)

        The ID of the reserved node offering to purchase.

      • NodeType — (String)

        The node type for the reserved nodes.

      • StartTime — (Date)

        The time the reservation started.

      • Duration — (Integer)

        The duration of the reservation in seconds.

      • FixedPrice — (Float)

        The fixed price charged for this reserved node.

      • NodeCount — (Integer)

        The number of nodes that have been reserved.

      • OfferingType — (String)

        The offering type of this reserved node.

      • State — (String)

        The state of the reserved node.

      • RecurringCharges — (Array<map>)

        The recurring price charged to run this reserved node.

        • RecurringChargeAmount — (Float)

          The amount of the recurring charge to run this reserved node.

        • RecurringChargeFrequency — (String)

          The frequency of the recurring price charged to run this reserved node.

      • ARN — (String)

        The Amazon Resource Name (ARN) of the reserved node.

Returns:

• (AWS.Request) —

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

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

    The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

  • NodeType — (String)

    The node type for the reserved nodes. For more information, see Supported node types.

  • Duration — (String)

    Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.

  • OfferingType — (String)

    The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid values: "All Upfront"|"Partial Upfront"| "No Upfront"

  • MaxResults — (Integer)

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

  • NextToken — (String)

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

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 marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • ReservedNodesOfferings — (Array<map>)

      Lists available reserved node offerings.

      • ReservedNodesOfferingId — (String)

        The offering identifier.

      • NodeType — (String)

        The node type for the reserved nodes. For more information, see Supported node types.

      • Duration — (Integer)

        The duration of the reservation in seconds.

      • FixedPrice — (Float)

        The fixed price charged for this reserved node.

      • OfferingType — (String)

        The offering type of this reserved node.

      • RecurringCharges — (Array<map>)

        The recurring price charged to run this reserved node.

        • RecurringChargeAmount — (Float)

          The amount of the recurring charge to run this reserved node.

        • RecurringChargeFrequency — (String)

          The frequency of the recurring price charged to run this reserved node.

Returns:

• (AWS.Request) —

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

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.

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 OSS 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

      • DataTiering — (String)

        Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

        Possible values include:
        • "true"
        • "false"

Returns:

• (AWS.Request) —

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

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.

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"
          • "iam"
        • 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.

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 OSS engine version used by the cluster

      • EnginePatchVersion — (String)

        The Redis OSS 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.

      • DataTiering — (String)

        Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

        Possible values include:
        • "true"
        • "false"

Returns:

• (AWS.Request) —

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

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.

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.

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

    The ID of the reserved node offering to purchase.

  • ReservationId — (String)

    A customer-specified identifier to track this reservation.

  • NodeCount — (Integer)

    The number of node instances to reserve.

  • 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:

    • ReservedNode — (map)

      Represents the output of a PurchaseReservedNodesOffering operation.

      • ReservationId — (String)

        A customer-specified identifier to track this reservation.

      • ReservedNodesOfferingId — (String)

        The ID of the reserved node offering to purchase.

      • NodeType — (String)

        The node type for the reserved nodes.

      • StartTime — (Date)

        The time the reservation started.

      • Duration — (Integer)

        The duration of the reservation in seconds.

      • FixedPrice — (Float)

        The fixed price charged for this reserved node.

      • NodeCount — (Integer)

        The number of nodes that have been reserved.

      • OfferingType — (String)

        The offering type of this reserved node.

      • State — (String)

        The state of the reserved node.

      • RecurringCharges — (Array<map>)

        The recurring price charged to run this reserved node.

        • RecurringChargeAmount — (Float)

          The amount of the recurring charge to run this reserved node.

        • RecurringChargeFrequency — (String)

          The frequency of the recurring price charged to run this reserved node.

      • ARN — (String)

        The Amazon Resource Name (ARN) of the reserved node.

Returns:

• (AWS.Request) —

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

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.

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.

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.

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.

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)

    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.

    Valid values for ddd are:

    • sun

    • mon

    • tue

    • wed

    • thu

    • fri

    • sat

    Example: sun:23:00-mon:01:30

  • 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 OSS engine version used by the cluster

      • EnginePatchVersion — (String)

        The Redis OSS 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.

      • DataTiering — (String)

        Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

        Possible values include:
        • "true"
        • "false"

Returns:

• (AWS.Request) —

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

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.

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.

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