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

Class: AWS.ElastiCache

Inherits:
AWS.Service show all
Identifier:
elasticache
API Version:
2015-02-02
Defined in:
(unknown)

Overview

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

Service Description

Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.

With ElastiCache, customers get all of the benefits of a high-performance, in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.

In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.

Sending a Request Using ElastiCache

var elasticache = new AWS.ElastiCache();
elasticache.addTagsToResource(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ElastiCache object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var elasticache = new AWS.ElastiCache({apiVersion: '2015-02-02'});

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

AWS.config.apiVersions = {
  elasticache: '2015-02-02',
  // other service API versions
};

var elasticache = new AWS.ElastiCache();

Version:

  • 2015-02-02

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

cacheClusterAvailable, cacheClusterDeleted, replicationGroupAvailable, replicationGroupDeleted

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.ElastiCache(options = {}) ⇒ Object

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

Examples:

Constructing a ElastiCache object

var elasticache = new AWS.ElastiCache({apiVersion: '2015-02-02'});

Options Hash (options):

  • params (map) —

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

  • endpoint (String|AWS.Endpoint) —

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

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

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

  • credentialProvider (AWS.CredentialProviderChain) —

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

  • region (String) —

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

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

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

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

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

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

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

  • convertResponseTypes (Boolean) —

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

  • correctClockSkew (Boolean) —

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

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

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

  • s3DisableBodySigning (Boolean) —

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

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

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

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

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

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

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

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

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

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

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

  • logger (#write, #log) —

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

  • systemClockOffset (Number) —

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

  • signatureVersion (String) —

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

  • signatureCache (Boolean) —

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

  • dynamoDbCrc32 (Boolean) —

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

  • useAccelerateEndpoint (Boolean) —

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

  • clientSideMonitoring (Boolean) —

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

  • endpointDiscoveryEnabled (Boolean|undefined) —

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

  • endpointCacheSize (Number) —

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

  • hostPrefixEnabled (Boolean) —

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

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

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

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

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

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

For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.

Service Reference:

Examples:

Calling the addTagsToResource operation

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

Parameters:

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

      The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. ElastiCache resources are cluster and snapshot.

      For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.

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

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

Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.

Note: You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.

Service Reference:

Examples:

Calling the authorizeCacheSecurityGroupIngress operation

var params = {
  CacheSecurityGroupName: 'STRING_VALUE', /* required */
  EC2SecurityGroupName: 'STRING_VALUE', /* required */
  EC2SecurityGroupOwnerId: 'STRING_VALUE' /* required */
};
elasticache.authorizeCacheSecurityGroupIngress(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: {}) —
    • CacheSecurityGroupName — (String)

      The cache security group that allows network ingress.

    • EC2SecurityGroupName — (String)

      The Amazon EC2 security group to be authorized for ingress to the cache security group.

    • EC2SecurityGroupOwnerId — (String)

      The Amazon account number of the Amazon EC2 security group owner. Note that this is not the same thing as an Amazon access key ID - you must provide a valid Amazon account number for this 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:

      • CacheSecurityGroup — (map)

        Represents the output of one of the following operations:

        • AuthorizeCacheSecurityGroupIngress

        • CreateCacheSecurityGroup

        • RevokeCacheSecurityGroupIngress

        • OwnerId — (String)

          The Amazon account ID of the cache security group owner.

        • CacheSecurityGroupName — (String)

          The name of the cache security group.

        • Description — (String)

          The description of the cache security group.

        • EC2SecurityGroups — (Array<map>)

          A list of Amazon EC2 security groups that are associated with this cache security group.

          • Status — (String)

            The status of the Amazon EC2 security group.

          • EC2SecurityGroupName — (String)

            The name of the Amazon EC2 security group.

          • EC2SecurityGroupOwnerId — (String)

            The Amazon account ID of the Amazon EC2 security group owner.

        • ARN — (String)

          The ARN of the cache security group,

Returns:

  • (AWS.Request) —

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

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

Apply the service update. For more information on service updates and applying them, see Applying Service Updates.

Service Reference:

Examples:

Calling the batchApplyUpdateAction operation

var params = {
  ServiceUpdateName: 'STRING_VALUE', /* required */
  CacheClusterIds: [
    'STRING_VALUE',
    /* more items */
  ],
  ReplicationGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
elasticache.batchApplyUpdateAction(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: {}) —
    • ReplicationGroupIds — (Array<String>)

      The replication group IDs

    • CacheClusterIds — (Array<String>)

      The cache cluster IDs

    • ServiceUpdateName — (String)

      The unique ID of the service update

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • ProcessedUpdateActions — (Array<map>)

        Update actions that have been processed successfully

        • ReplicationGroupId — (String)

          The ID of the replication group

        • CacheClusterId — (String)

          The ID of the cache cluster

        • ServiceUpdateName — (String)

          The unique ID of the service update

        • UpdateActionStatus — (String)

          The status of the update action on the Redis cluster

          Possible values include:
          • "not-applied"
          • "waiting-to-start"
          • "in-progress"
          • "stopping"
          • "stopped"
          • "complete"
          • "scheduling"
          • "scheduled"
          • "not-applicable"
      • UnprocessedUpdateActions — (Array<map>)

        Update actions that haven't been processed successfully

        • ReplicationGroupId — (String)

          The replication group ID

        • CacheClusterId — (String)

          The ID of the cache cluster

        • ServiceUpdateName — (String)

          The unique ID of the service update

        • ErrorType — (String)

          The error type for requests that are not processed

        • ErrorMessage — (String)

          The error message that describes the reason the request was not processed

Returns:

  • (AWS.Request) —

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

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

Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.

Service Reference:

Examples:

Calling the batchStopUpdateAction operation

var params = {
  ServiceUpdateName: 'STRING_VALUE', /* required */
  CacheClusterIds: [
    'STRING_VALUE',
    /* more items */
  ],
  ReplicationGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
elasticache.batchStopUpdateAction(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: {}) —
    • ReplicationGroupIds — (Array<String>)

      The replication group IDs

    • CacheClusterIds — (Array<String>)

      The cache cluster IDs

    • ServiceUpdateName — (String)

      The unique ID of the service update

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • ProcessedUpdateActions — (Array<map>)

        Update actions that have been processed successfully

        • ReplicationGroupId — (String)

          The ID of the replication group

        • CacheClusterId — (String)

          The ID of the cache cluster

        • ServiceUpdateName — (String)

          The unique ID of the service update

        • UpdateActionStatus — (String)

          The status of the update action on the Redis cluster

          Possible values include:
          • "not-applied"
          • "waiting-to-start"
          • "in-progress"
          • "stopping"
          • "stopped"
          • "complete"
          • "scheduling"
          • "scheduled"
          • "not-applicable"
      • UnprocessedUpdateActions — (Array<map>)

        Update actions that haven't been processed successfully

        • ReplicationGroupId — (String)

          The replication group ID

        • CacheClusterId — (String)

          The ID of the cache cluster

        • ServiceUpdateName — (String)

          The unique ID of the service update

        • ErrorType — (String)

          The error type for requests that are not processed

        • ErrorMessage — (String)

          The error message that describes the reason the request was not processed

Returns:

  • (AWS.Request) —

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

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

Complete the migration of data.

Service Reference:

Examples:

Calling the completeMigration operation

var params = {
  ReplicationGroupId: 'STRING_VALUE', /* required */
  Force: true || false
};
elasticache.completeMigration(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: {}) —
    • ReplicationGroupId — (String)

      The ID of the replication group to which data is being migrated.

    • Force — (Boolean)

      Forces the migration to stop without ensuring that data is in sync. It is recommended to use this option only to abort the migration and not recommended when application wants to continue migration to ElastiCache.

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:

      • ReplicationGroup — (map)

        Contains all of the attributes of a specific Redis replication group.

        • ReplicationGroupId — (String)

          The identifier for the replication group.

        • Description — (String)

          The user supplied description of the replication group.

        • GlobalReplicationGroupInfo — (map)

          The name of the Global datastore and role of this replication group in the Global datastore.

          • GlobalReplicationGroupId — (String)

            The name of the Global datastore

          • GlobalReplicationGroupMemberRole — (String)

            The role of the replication group in a Global datastore. Can be primary or secondary.

        • Status — (String)

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

        • PendingModifiedValues — (map)

          A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

          • PrimaryClusterId — (String)

            The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.

          • AutomaticFailoverStatus — (String)

            Indicates the status of automatic failover for this Redis replication group.

            Possible values include:
            • "enabled"
            • "disabled"
          • Resharding — (map)

            The status of an online resharding operation.

            • SlotMigration — (map)

              Represents the progress of an online resharding operation.

              • ProgressPercentage — (Float)

                The percentage of the slot migration that is complete.

          • AuthTokenStatus — (String)

            The auth token status

            Possible values include:
            • "SETTING"
            • "ROTATING"
          • UserGroups — (map)

            The user group being modified.

            • UserGroupIdsToAdd — (Array<String>)

              The ID of the user group to add.

            • UserGroupIdsToRemove — (Array<String>)

              The ID of the user group to remove.

          • LogDeliveryConfigurations — (Array<map>)

            The log delivery configurations being modified

            • LogType — (String)

              Refers to slow-log.

              Possible values include:
              • "slow-log"
            • DestinationType — (String)

              Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

              Possible values include:
              • "cloudwatch-logs"
              • "kinesis-firehose"
            • DestinationDetails — (map)

              Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

              • CloudWatchLogsDetails — (map)

                The configuration details of the CloudWatch Logs destination.

                • LogGroup — (String)

                  The name of the CloudWatch Logs log group.

              • KinesisFirehoseDetails — (map)

                The configuration details of the Kinesis Data Firehose destination.

                • DeliveryStream — (String)

                  The name of the Kinesis Data Firehose delivery stream.

            • LogFormat — (String)

              Returns the log format, either JSON or TEXT

              Possible values include:
              • "text"
              • "json"
        • MemberClusters — (Array<String>)

          The names of all the cache clusters that are part of this replication group.

        • NodeGroups — (Array<map>)

          A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

          • NodeGroupId — (String)

            The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.

          • Status — (String)

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

          • PrimaryEndpoint — (map)

            The endpoint of the primary node in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • ReaderEndpoint — (map)

            The endpoint of the replica nodes in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • Slots — (String)

            The keyspace for this node group (shard).

          • NodeGroupMembers — (Array<map>)

            A list containing information about individual nodes within the node group (shard).

            • CacheClusterId — (String)

              The ID of the cluster to which the node belongs.

            • CacheNodeId — (String)

              The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).

            • ReadEndpoint — (map)

              The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.

              • Address — (String)

                The DNS hostname of the cache node.

              • Port — (Integer)

                The port number that the cache engine is listening on.

            • PreferredAvailabilityZone — (String)

              The name of the Availability Zone in which the node is located.

            • PreferredOutpostArn — (String)

              The outpost ARN of the node group member.

            • CurrentRole — (String)

              The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.

        • SnapshottingClusterId — (String)

          The cluster ID that is used as the daily snapshot source for the replication group.

        • AutomaticFailover — (String)

          Indicates the status of automatic failover for this Redis replication group.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
        • MultiAZ — (String)

          A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

          Possible values include:
          • "enabled"
          • "disabled"
        • ConfigurationEndpoint — (map)

          The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

          • Address — (String)

            The DNS hostname of the cache node.

          • Port — (Integer)

            The port number that the cache engine is listening on.

        • SnapshotRetentionLimit — (Integer)

          The number of days for which ElastiCache 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.

          If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

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

          Example: 05:00-09:00

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

          Note: This parameter is only valid if the Engine parameter is redis.
        • ClusterEnabled — (Boolean)

          A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

          Valid values: true | false

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for each node in the replication group.

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • AuthTokenLastModifiedDate — (Date)

          The date the auth token was last modified

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true.

          You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at-rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • MemberClustersOutpostArns — (Array<String>)

          The outpost ARNs of the replication group's member clusters.

        • KmsKeyId — (String)

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

        • ARN — (String)

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

        • UserGroupIds — (Array<String>)

          The ID of the user group associated to the replication group.

        • LogDeliveryConfigurations — (Array<map>)

          Returns the destination, format and type of the logs.

          • LogType — (String)

            Refers to slow-log.

            Possible values include:
            • "slow-log"
          • DestinationType — (String)

            Returns the destination type, either cloudwatch-logs or kinesis-firehose.

            Possible values include:
            • "cloudwatch-logs"
            • "kinesis-firehose"
          • DestinationDetails — (map)

            Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

            • CloudWatchLogsDetails — (map)

              The configuration details of the CloudWatch Logs destination.

              • LogGroup — (String)

                The name of the CloudWatch Logs log group.

            • KinesisFirehoseDetails — (map)

              The configuration details of the Kinesis Data Firehose destination.

              • DeliveryStream — (String)

                The name of the Kinesis Data Firehose delivery stream.

          • LogFormat — (String)

            Returns the log format, either JSON or TEXT.

            Possible values include:
            • "text"
            • "json"
          • Status — (String)

            Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

            Possible values include:
            • "active"
            • "enabling"
            • "modifying"
            • "disabling"
            • "error"
          • Message — (String)

            Returns an error message for the log delivery configuration.

        • ReplicationGroupCreateTime — (Date)

          The date and time when the cluster was created.

Returns:

  • (AWS.Request) —

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

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

Makes a copy of an existing snapshot.

Note: This operation is valid for Redis only.

Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication & Access Control.

You could receive the following error messages.

Error Messages

  • Error Message: The S3 bucket %s is outside of the region.

    Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

  • Error Message: The S3 bucket %s does not exist.

    Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

  • Error Message: The S3 bucket %s is not owned by the authenticated user.

    Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

  • Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.

    Solution: Contact your system administrator to get the needed permissions.

  • Error Message: The S3 bucket %s already contains an object with key %s.

    Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.

  • Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.

    Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

  • Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.

    Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

  • Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.

    Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

Service Reference:

Examples:

Calling the copySnapshot operation

var params = {
  SourceSnapshotName: 'STRING_VALUE', /* required */
  TargetSnapshotName: 'STRING_VALUE', /* required */
  KmsKeyId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TargetBucket: 'STRING_VALUE'
};
elasticache.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. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache 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 Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

      For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

    • 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 Redis cluster as of the time when the snapshot was taken.

        • SnapshotName — (String)

          The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.

        • ReplicationGroupId — (String)

          The unique identifier of the source replication group.

        • ReplicationGroupDescription — (String)

          A description of the source replication group.

        • CacheClusterId — (String)

          The user-supplied identifier of the source cluster.

        • SnapshotStatus — (String)

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

        • SnapshotSource — (String)

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

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for the source cluster.

          The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

          • General purpose:

            • Current generation:

              M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

              Note: For region availability, see Supported Node Types

              M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

              M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

              T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

              T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

            • Previous generation: (not recommended)

              T1 node types: cache.t1.micro

              M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

              M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

          • Compute optimized:

            • Previous generation: (not recommended)

              C1 node types: cache.c1.xlarge

          • Memory optimized:

            • Current generation:

              R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

              Note: For region availability, see Supported Node Types

              R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

              R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

            • Previous generation: (not recommended)

              M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

              R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

          Additional node type info

          • All current generation instance types are created in Amazon VPC by default.

          • Redis append-only files (AOF) are not supported for T1 or T2 instances.

          • Redis Multi-AZ with automatic failover is not supported on T1 instances.

          • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

        • Engine — (String)

          The name of the cache engine (memcached or redis) used by the source cluster.

        • EngineVersion — (String)

          The version of the cache engine version that is used by the source cluster.

        • NumCacheNodes — (Integer)

          The number of cache nodes in the source cluster.

          For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

        • PreferredAvailabilityZone — (String)

          The name of the Availability Zone in which the source cluster is located.

        • PreferredOutpostArn — (String)

          The ARN (Amazon Resource Name) of the preferred outpost.

        • CacheClusterCreateTime — (Date)

          The date and time when the source cluster was created.

        • PreferredMaintenanceWindow — (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

        • TopicArn — (String)

          The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.

        • Port — (Integer)

          The port number used by each cache nodes in the source cluster.

        • CacheParameterGroupName — (String)

          The cache parameter group that is associated with the source cluster.

        • CacheSubnetGroupName — (String)

          The name of the cache subnet group associated with the source cluster.

        • VpcId — (String)

          The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

        • AutoMinorVersionUpgrade — (Boolean)

          This parameter is currently disabled.

        • SnapshotRetentionLimit — (Integer)

          For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.

          For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation.

          Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

          The daily time range during which ElastiCache takes daily snapshots of the source cluster.

        • NumNodeGroups — (Integer)

          The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.

        • AutomaticFailover — (String)

          Indicates the status of automatic failover for the source Redis replication group.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
        • NodeSnapshots — (Array<map>)

          A list of the cache nodes in the source cluster.

          • CacheClusterId — (String)

            A unique identifier for the source cluster.

          • NodeGroupId — (String)

            A unique identifier for the source node group (shard).

          • CacheNodeId — (String)

            The cache node identifier for the node in the source cluster.

          • NodeGroupConfiguration — (map)

            The configuration for the source node group (shard).

            • NodeGroupId — (String)

              Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

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

              Example: "0-3999"

            • ReplicaCount — (Integer)

              The number of read replica nodes in this node group (shard).

            • PrimaryAvailabilityZone — (String)

              The Availability Zone where the primary node of this node group (shard) is launched.

            • ReplicaAvailabilityZones — (Array<String>)

              A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.

            • PrimaryOutpostArn — (String)

              The outpost ARN of the primary node.

            • ReplicaOutpostArns — (Array<String>)

              The outpost ARN of the node replicas.

          • CacheSize — (String)

            The size of the cache on the source cache node.

          • CacheNodeCreateTime — (Date)

            The date and time when the cache node was created in the source cluster.

          • SnapshotCreateTime — (Date)

            The date and time when the source node's metadata and cache data set was obtained for the snapshot.

        • KmsKeyId — (String)

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

        • ARN — (String)

          The ARN (Amazon Resource Name) of the snapshot.

Returns:

  • (AWS.Request) —

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

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

Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis.

This operation is not supported for Redis (cluster mode enabled) clusters.

Service Reference:

Examples:

Calling the createCacheCluster operation

var params = {
  CacheClusterId: 'STRING_VALUE', /* required */
  AZMode: single-az | cross-az,
  AuthToken: 'STRING_VALUE',
  AutoMinorVersionUpgrade: true || false,
  CacheNodeType: 'STRING_VALUE',
  CacheParameterGroupName: 'STRING_VALUE',
  CacheSecurityGroupNames: [
    'STRING_VALUE',
    /* more items */
  ],
  CacheSubnetGroupName: 'STRING_VALUE',
  Engine: 'STRING_VALUE',
  EngineVersion: 'STRING_VALUE',
  LogDeliveryConfigurations: [
    {
      DestinationDetails: {
        CloudWatchLogsDetails: {
          LogGroup: 'STRING_VALUE'
        },
        KinesisFirehoseDetails: {
          DeliveryStream: 'STRING_VALUE'
        }
      },
      DestinationType: cloudwatch-logs | kinesis-firehose,
      Enabled: true || false,
      LogFormat: text | json,
      LogType: slow-log
    },
    /* more items */
  ],
  NotificationTopicArn: 'STRING_VALUE',
  NumCacheNodes: 'NUMBER_VALUE',
  OutpostMode: single-outpost | cross-outpost,
  Port: 'NUMBER_VALUE',
  PreferredAvailabilityZone: 'STRING_VALUE',
  PreferredAvailabilityZones: [
    'STRING_VALUE',
    /* more items */
  ],
  PreferredMaintenanceWindow: 'STRING_VALUE',
  PreferredOutpostArn: 'STRING_VALUE',
  PreferredOutpostArns: [
    'STRING_VALUE',
    /* more items */
  ],
  ReplicationGroupId: 'STRING_VALUE',
  SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  SnapshotArns: [
    'STRING_VALUE',
    /* more items */
  ],
  SnapshotName: 'STRING_VALUE',
  SnapshotRetentionLimit: 'NUMBER_VALUE',
  SnapshotWindow: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
elasticache.createCacheCluster(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: {}) —
    • CacheClusterId — (String)

      The node group (shard) identifier. This parameter is stored as a lowercase string.

      Constraints:

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

      • The first character must be a letter.

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

    • ReplicationGroupId — (String)

      The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

      If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

      Note: This parameter is only valid if the Engine parameter is redis.
    • AZMode — (String)

      Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

      This parameter is only supported for Memcached clusters.

      If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

      Possible values include:
      • "single-az"
      • "cross-az"
    • PreferredAvailabilityZone — (String)

      The EC2 Availability Zone in which the cluster is created.

      All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

      Default: System chosen Availability Zone.

    • PreferredAvailabilityZones — (Array<String>)

      A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.

      This option is only supported on Memcached.

      Note: If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group. The number of Availability Zones listed must equal the value of NumCacheNodes.

      If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

      Default: System chosen Availability Zones.

    • NumCacheNodes — (Integer)

      The initial number of cache nodes that the cluster has.

      For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

      If you need more than 40 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.

    • CacheNodeType — (String)

      The compute and memory capacity of the nodes in the node group (shard).

      The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

      • General purpose:

        • Current generation:

          M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

          cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

          Note: For region availability, see Supported Node Types

          M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

          M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

          T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

          T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

        • Previous generation: (not recommended)

          T1 node types: cache.t1.micro

          M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

          M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

      • Compute optimized:

        • Previous generation: (not recommended)

          C1 node types: cache.c1.xlarge

      • Memory optimized:

        • Current generation:

          R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

          cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

          Note: For region availability, see Supported Node Types

          R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

          R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

        • Previous generation: (not recommended)

          M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

          R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

      Additional node type info

      • All current generation instance types are created in Amazon VPC by default.

      • Redis append-only files (AOF) are not supported for T1 or T2 instances.

      • Redis Multi-AZ with automatic failover is not supported on T1 instances.

      • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

    • Engine — (String)

      The name of the cache engine to be used for this cluster.

      Valid values for this parameter are: memcached | redis

    • EngineVersion — (String)

      The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

      Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and 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 or replication group and create it anew with the earlier engine version.

    • CacheParameterGroupName — (String)

      The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.

    • CacheSubnetGroupName — (String)

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

      Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

      If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

    • CacheSecurityGroupNames — (Array<String>)

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

      Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

    • SecurityGroupIds — (Array<String>)

      One or more VPC security groups associated with the cluster.

      Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

    • Tags — (Array<map>)

      A list of tags to be added to this resource.

      • Key — (String)

        The key for the tag. May not be null.

      • Value — (String)

        The tag's value. May be null.

    • SnapshotArns — (Array<String>)

      A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

      Note: This parameter is only valid if the Engine parameter is redis.

      Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

    • SnapshotName — (String)

      The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.

      Note: This parameter is only valid if the Engine parameter is redis.
    • PreferredMaintenanceWindow — (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:

    • Port — (Integer)

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

    • NotificationTopicArn — (String)

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

      Note: The Amazon SNS topic owner must be the same as the cluster owner.
    • AutoMinorVersionUpgrade — (Boolean)

      This parameter is currently disabled.

    • SnapshotRetentionLimit — (Integer)

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

      Note: This parameter is only valid if the Engine parameter is redis.

      Default: 0 (i.e., automatic backups are disabled for this cache cluster).

    • SnapshotWindow — (String)

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

      Example: 05:00-09:00

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

      Note: This parameter is only valid if the Engine parameter is redis.
    • AuthToken — (String)

      Reserved parameter. The password used to access a password protected server.

      Password constraints:

      • Must be only printable ASCII characters.

      • Must be at least 16 characters and no more than 128 characters in length.

      • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

      For more information, see AUTH password at http://redis.io/commands/AUTH.

    • OutpostMode — (String)

      Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.

      Possible values include:
      • "single-outpost"
      • "cross-outpost"
    • PreferredOutpostArn — (String)

      The outpost ARN in which the cache cluster is created.

    • PreferredOutpostArns — (Array<String>)

      The outpost ARNs in which the cache cluster is created.

    • LogDeliveryConfigurations — (Array<map>)

      Specifies the destination, format and type of the logs.

      • LogType — (String)

        Refers to slow-log.

        Possible values include:
        • "slow-log"
      • DestinationType — (String)

        Specify either cloudwatch-logs or kinesis-firehose as the destination type.

        Possible values include:
        • "cloudwatch-logs"
        • "kinesis-firehose"
      • DestinationDetails — (map)

        Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

        • CloudWatchLogsDetails — (map)

          The configuration details of the CloudWatch Logs destination.

          • LogGroup — (String)

            The name of the CloudWatch Logs log group.

        • KinesisFirehoseDetails — (map)

          The configuration details of the Kinesis Data Firehose destination.

          • DeliveryStream — (String)

            The name of the Kinesis Data Firehose delivery stream.

      • LogFormat — (String)

        Specifies either JSON or TEXT

        Possible values include:
        • "text"
        • "json"
      • Enabled — (Boolean)

        Specify if log delivery is enabled. Default true.

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:

      • CacheCluster — (map)

        Contains all of the attributes of a specific cluster.

        • CacheClusterId — (String)

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

        • ConfigurationEndpoint — (map)

          Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.

          Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211

          • Address — (String)

            The DNS hostname of the cache node.

          • Port — (Integer)

            The port number that the cache engine is listening on.

        • ClientDownloadLandingPage — (String)

          The URL of the web page where you can download the latest ElastiCache client library.

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for the cluster.

          The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

          • General purpose:

            • Current generation:

              M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

              Note: For region availability, see Supported Node Types

              M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

              M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

              T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

              T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

            • Previous generation: (not recommended)

              T1 node types: cache.t1.micro

              M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

              M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

          • Compute optimized:

            • Previous generation: (not recommended)

              C1 node types: cache.c1.xlarge

          • Memory optimized:

            • Current generation:

              R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

              Note: For region availability, see Supported Node Types

              R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

              R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

            • Previous generation: (not recommended)

              M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

              R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

          Additional node type info

          • All current generation instance types are created in Amazon VPC by default.

          • Redis append-only files (AOF) are not supported for T1 or T2 instances.

          • Redis Multi-AZ with automatic failover is not supported on T1 instances.

          • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

        • Engine — (String)

          The name of the cache engine (memcached or redis) to be used for this cluster.

        • EngineVersion — (String)

          The version of the cache engine that is used in this cluster.

        • CacheClusterStatus — (String)

          The current state of this cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cluster nodes, restore-failed, or snapshotting.

        • NumCacheNodes — (Integer)

          The number of cache nodes in the cluster.

          For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

        • PreferredAvailabilityZone — (String)

          The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

        • PreferredOutpostArn — (String)

          The outpost ARN in which the cache cluster is created.

        • CacheClusterCreateTime — (Date)

          The date and time when the cluster was created.

        • PreferredMaintenanceWindow — (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

        • PendingModifiedValues — (map)

          A group of settings that are applied to the cluster in the future, or that are currently being applied.

          • NumCacheNodes — (Integer)

            The new number of cache nodes for the cluster.

            For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

          • CacheNodeIdsToRemove — (Array<String>)

            A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).

          • EngineVersion — (String)

            The new cache engine version that the cluster runs.

          • CacheNodeType — (String)

            The cache node type that this cluster or replication group is scaled to.

          • AuthTokenStatus — (String)

            The auth token status

            Possible values include:
            • "SETTING"
            • "ROTATING"
          • LogDeliveryConfigurations — (Array<map>)

            The log delivery configurations being modified

            • LogType — (String)

              Refers to slow-log.

              Possible values include:
              • "slow-log"
            • DestinationType — (String)

              Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

              Possible values include:
              • "cloudwatch-logs"
              • "kinesis-firehose"
            • DestinationDetails — (map)

              Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

              • CloudWatchLogsDetails — (map)

                The configuration details of the CloudWatch Logs destination.

                • LogGroup — (String)

                  The name of the CloudWatch Logs log group.

              • KinesisFirehoseDetails — (map)

                The configuration details of the Kinesis Data Firehose destination.

                • DeliveryStream — (String)

                  The name of the Kinesis Data Firehose delivery stream.

            • LogFormat — (String)

              Returns the log format, either JSON or TEXT

              Possible values include:
              • "text"
              • "json"
        • NotificationConfiguration — (map)

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

          • TopicArn — (String)

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

          • TopicStatus — (String)

            The current state of the topic.

        • CacheSecurityGroups — (Array<map>)

          A list of cache security group elements, composed of name and status sub-elements.

          • CacheSecurityGroupName — (String)

            The name of the cache security group.

          • Status — (String)

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

        • CacheParameterGroup — (map)

          Status of the cache parameter group.

          • CacheParameterGroupName — (String)

            The name of the cache parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • CacheNodeIdsToReboot — (Array<String>)

            A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).

        • CacheSubnetGroupName — (String)

          The name of the cache subnet group associated with the cluster.

        • CacheNodes — (Array<map>)

          A list of cache nodes that are members of the cluster.

          • CacheNodeId — (String)

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

          • CacheNodeStatus — (String)

            The current state of this cache node, one of the following values: available, creating, rebooting, or deleting.

          • CacheNodeCreateTime — (Date)

            The date and time when the cache node was created.

          • Endpoint — (map)

            The hostname for connecting to this cache node.

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • ParameterGroupStatus — (String)

            The status of the parameter group applied to this cache node.

          • SourceCacheNodeId — (String)

            The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cluster.

          • CustomerAvailabilityZone — (String)

            The Availability Zone where this node was created and now resides.

          • CustomerOutpostArn — (String)

            The customer outpost ARN of the cache node.

        • AutoMinorVersionUpgrade — (Boolean)

          This parameter is currently disabled.

        • SecurityGroups — (Array<map>)

          A list of VPC Security Groups associated with the cluster.

          • SecurityGroupId — (String)

            The identifier of the cache security group.

          • Status — (String)

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

        • ReplicationGroupId — (String)

          The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.

        • SnapshotRetentionLimit — (Integer)

          The number of days for which ElastiCache 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.

          If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

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

          Example: 05:00-09:00

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • AuthTokenLastModifiedDate — (Date)

          The date the auth token was last modified

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true.

          You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at-rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • ARN — (String)

          The ARN (Amazon Resource Name) of the cache cluster.

        • ReplicationGroupLogDeliveryEnabled — (Boolean)

          A boolean value indicating whether log delivery is enabled for the replication group.

        • LogDeliveryConfigurations — (Array<map>)

          Returns the destination, format and type of the logs.

          • LogType — (String)

            Refers to slow-log.

            Possible values include:
            • "slow-log"
          • DestinationType — (String)

            Returns the destination type, either cloudwatch-logs or kinesis-firehose.

            Possible values include:
            • "cloudwatch-logs"
            • "kinesis-firehose"
          • DestinationDetails — (map)

            Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

            • CloudWatchLogsDetails — (map)

              The configuration details of the CloudWatch Logs destination.

              • LogGroup — (String)

                The name of the CloudWatch Logs log group.

            • KinesisFirehoseDetails — (map)

              The configuration details of the Kinesis Data Firehose destination.

              • DeliveryStream — (String)

                The name of the Kinesis Data Firehose delivery stream.

          • LogFormat — (String)

            Returns the log format, either JSON or TEXT.

            Possible values include:
            • "text"
            • "json"
          • Status — (String)

            Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

            Possible values include:
            • "active"
            • "enabling"
            • "modifying"
            • "disabling"
            • "error"
          • Message — (String)

            Returns an error message for the log delivery configuration.

Returns:

  • (AWS.Request) —

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

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

Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup.

A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:

Service Reference:

Examples:

Calling the createCacheParameterGroup operation

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

      A user-specified name for the cache parameter group.

    • CacheParameterGroupFamily — (String)

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

      Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x |

    • Description — (String)

      A user-specified description for the cache 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:

      • CacheParameterGroup — (map)

        Represents the output of a CreateCacheParameterGroup operation.

        • CacheParameterGroupName — (String)

          The name of the cache parameter group.

        • CacheParameterGroupFamily — (String)

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

          Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x |

        • Description — (String)

          The description for this cache parameter group.

        • IsGlobal — (Boolean)

          Indicates whether the parameter group is associated with a Global datastore

        • ARN — (String)

          The ARN (Amazon Resource Name) of the cache parameter group.

Returns:

  • (AWS.Request) —

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

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

Creates a new cache security group. Use a cache security group to control access to one or more clusters.

Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.

Service Reference:

Examples:

Calling the createCacheSecurityGroup operation

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

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

      Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word "Default".

      Example: mysecuritygroup

    • Description — (String)

      A description for the cache security 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:

      • CacheSecurityGroup — (map)

        Represents the output of one of the following operations:

        • AuthorizeCacheSecurityGroupIngress

        • CreateCacheSecurityGroup

        • RevokeCacheSecurityGroupIngress

        • OwnerId — (String)

          The Amazon account ID of the cache security group owner.

        • CacheSecurityGroupName — (String)

          The name of the cache security group.

        • Description — (String)

          The description of the cache security group.

        • EC2SecurityGroups — (Array<map>)

          A list of Amazon EC2 security groups that are associated with this cache security group.

          • Status — (String)

            The status of the Amazon EC2 security group.

          • EC2SecurityGroupName — (String)

            The name of the Amazon EC2 security group.

          • EC2SecurityGroupOwnerId — (String)

            The Amazon account ID of the Amazon EC2 security group owner.

        • ARN — (String)

          The ARN of the cache security group,

Returns:

  • (AWS.Request) —

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

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

Creates a new cache subnet group.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

Service Reference:

Examples:

Calling the createCacheSubnetGroup operation

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

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

      Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

      Example: mysubnetgroup

    • CacheSubnetGroupDescription — (String)

      A description for the cache subnet group.

    • SubnetIds — (Array<String>)

      A list of VPC subnet IDs for the cache 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:

      • CacheSubnetGroup — (map)

        Represents the output of one of the following operations:

        • CreateCacheSubnetGroup

        • ModifyCacheSubnetGroup

        • CacheSubnetGroupName — (String)

          The name of the cache subnet group.

        • CacheSubnetGroupDescription — (String)

          The description of the cache subnet group.

        • VpcId — (String)

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

        • Subnets — (Array<map>)

          A list of subnets associated with the cache subnet group.

          • SubnetIdentifier — (String)

            The unique identifier for the subnet.

          • SubnetAvailabilityZone — (map)

            The Availability Zone associated with the subnet.

            • Name — (String)

              The name of the Availability Zone.

          • SubnetOutpost — (map)

            The outpost ARN of the subnet.

            • SubnetOutpostArn — (String)

              The outpost ARN of the subnet.

        • ARN — (String)

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

Returns:

  • (AWS.Request) —

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

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

Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis, you can create cross-region read replica clusters for ElastiCache for Redis to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore.

  • The GlobalReplicationGroupIdSuffix is the name of the Global datastore.

  • The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.

Service Reference:

Examples:

Calling the createGlobalReplicationGroup operation

var params = {
  GlobalReplicationGroupIdSuffix: 'STRING_VALUE', /* required */
  PrimaryReplicationGroupId: 'STRING_VALUE', /* required */
  GlobalReplicationGroupDescription: 'STRING_VALUE'
};
elasticache.createGlobalReplicationGroup(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: {}) —
    • GlobalReplicationGroupIdSuffix — (String)

      The suffix name of a Global datastore. Amazon ElastiCache automatically applies a prefix to the Global datastore ID when it is created. Each Amazon Region has its own prefix. For instance, a Global datastore ID created in the US-West-1 region will begin with "dsdfu" along with the suffix name you provide. The suffix, combined with the auto-generated prefix, guarantees uniqueness of the Global datastore name across multiple regions.

      For a full list of Amazon Regions and their respective Global datastore iD prefixes, see Using the Amazon CLI with Global datastores .

    • GlobalReplicationGroupDescription — (String)

      Provides details of the Global datastore

    • PrimaryReplicationGroupId — (String)

      The name of the primary cluster that accepts writes and will replicate updates to the secondary 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:

      • GlobalReplicationGroup — (map)

        Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

        • The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

        • GlobalReplicationGroupId — (String)

          The name of the Global datastore

        • GlobalReplicationGroupDescription — (String)

          The optional description of the Global datastore

        • Status — (String)

          The status of the Global datastore

        • CacheNodeType — (String)

          The cache node type of the Global datastore

        • Engine — (String)

          The Elasticache engine. For Redis only.

        • EngineVersion — (String)

          The Elasticache Redis engine version.

        • Members — (Array<map>)

          The replication groups that comprise the Global datastore.

          • ReplicationGroupId — (String)

            The replication group id of the Global datastore member.

          • ReplicationGroupRegion — (String)

            The Amazon region of the Global datastore member.

          • Role — (String)

            Indicates the role of the replication group, primary or secondary.

          • AutomaticFailover — (String)

            Indicates whether automatic failover is enabled for the replication group.

            Possible values include:
            • "enabled"
            • "disabled"
            • "enabling"
            • "disabling"
          • Status — (String)

            The status of the membership of the replication group.

        • ClusterEnabled — (Boolean)

          A flag that indicates whether the Global datastore is cluster enabled.

        • GlobalNodeGroups — (Array<map>)

          Indicates the slot configuration and global identifier for each slice group.

          • GlobalNodeGroupId — (String)

            The name of the global node group

          • Slots — (String)

            The keyspace for this node group

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

        • ARN — (String)

          The ARN (Amazon Resource Name) of the global replication group.

Returns:

  • (AWS.Request) —

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

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

Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.

This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.

A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.

A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.

The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster.

To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type.

When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' scaling. For more information, see Scaling ElastiCache for Redis Clusters in the ElastiCache User Guide.

Note: This operation is valid for Redis only.

Service Reference:

Examples:

Calling the createReplicationGroup operation

var params = {
  ReplicationGroupDescription: 'STRING_VALUE', /* required */
  ReplicationGroupId: 'STRING_VALUE', /* required */
  AtRestEncryptionEnabled: true || false,
  AuthToken: 'STRING_VALUE',
  AutoMinorVersionUpgrade: true || false,
  AutomaticFailoverEnabled: true || false,
  CacheNodeType: 'STRING_VALUE',
  CacheParameterGroupName: 'STRING_VALUE',
  CacheSecurityGroupNames: [
    'STRING_VALUE',
    /* more items */
  ],
  CacheSubnetGroupName: 'STRING_VALUE',
  Engine: 'STRING_VALUE',
  EngineVersion: 'STRING_VALUE',
  GlobalReplicationGroupId: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  LogDeliveryConfigurations: [
    {
      DestinationDetails: {
        CloudWatchLogsDetails: {
          LogGroup: 'STRING_VALUE'
        },
        KinesisFirehoseDetails: {
          DeliveryStream: 'STRING_VALUE'
        }
      },
      DestinationType: cloudwatch-logs | kinesis-firehose,
      Enabled: true || false,
      LogFormat: text | json,
      LogType: slow-log
    },
    /* more items */
  ],
  MultiAZEnabled: true || false,
  NodeGroupConfiguration: [
    {
      NodeGroupId: 'STRING_VALUE',
      PrimaryAvailabilityZone: 'STRING_VALUE',
      PrimaryOutpostArn: 'STRING_VALUE',
      ReplicaAvailabilityZones: [
        'STRING_VALUE',
        /* more items */
      ],
      ReplicaCount: 'NUMBER_VALUE',
      ReplicaOutpostArns: [
        'STRING_VALUE',
        /* more items */
      ],
      Slots: 'STRING_VALUE'
    },
    /* more items */
  ],
  NotificationTopicArn: 'STRING_VALUE',
  NumCacheClusters: 'NUMBER_VALUE',
  NumNodeGroups: 'NUMBER_VALUE',
  Port: 'NUMBER_VALUE',
  PreferredCacheClusterAZs: [
    'STRING_VALUE',
    /* more items */
  ],
  PreferredMaintenanceWindow: 'STRING_VALUE',
  PrimaryClusterId: 'STRING_VALUE',
  ReplicasPerNodeGroup: 'NUMBER_VALUE',
  SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  SnapshotArns: [
    'STRING_VALUE',
    /* more items */
  ],
  SnapshotName: 'STRING_VALUE',
  SnapshotRetentionLimit: 'NUMBER_VALUE',
  SnapshotWindow: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TransitEncryptionEnabled: true || false,
  UserGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
elasticache.createReplicationGroup(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: {}) —
    • ReplicationGroupId — (String)

      The replication group identifier. This parameter is stored as a lowercase string.

      Constraints:

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

      • The first character must be a letter.

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

    • ReplicationGroupDescription — (String)

      A user-created description for the replication group.

    • GlobalReplicationGroupId — (String)

      The name of the Global datastore

    • PrimaryClusterId — (String)

      The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.

      This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.

    • AutomaticFailoverEnabled — (Boolean)

      Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

      AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

      Default: false

    • MultiAZEnabled — (Boolean)

      A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.

    • NumCacheClusters — (Integer)

      The number of clusters this replication group initially has.

      This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead.

      If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.

      The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).

    • PreferredCacheClusterAZs — (Array<String>)

      A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.

      This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.

      Note: If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group. The number of Availability Zones listed must equal the value of NumCacheClusters.

      Default: system chosen Availability Zones.

    • NumNodeGroups — (Integer)

      An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1.

      Default: 1

    • ReplicasPerNodeGroup — (Integer)

      An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.

    • NodeGroupConfiguration — (Array<map>)

      A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.

      If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.

      • NodeGroupId — (String)

        Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

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

        Example: "0-3999"

      • ReplicaCount — (Integer)

        The number of read replica nodes in this node group (shard).

      • PrimaryAvailabilityZone — (String)

        The Availability Zone where the primary node of this node group (shard) is launched.

      • ReplicaAvailabilityZones — (Array<String>)

        A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.

      • PrimaryOutpostArn — (String)

        The outpost ARN of the primary node.

      • ReplicaOutpostArns — (Array<String>)

        The outpost ARN of the node replicas.

    • CacheNodeType — (String)

      The compute and memory capacity of the nodes in the node group (shard).

      The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

      • General purpose:

        • Current generation:

          M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

          cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

          Note: For region availability, see Supported Node Types

          M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

          M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

          T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

          T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

        • Previous generation: (not recommended)

          T1 node types: cache.t1.micro

          M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

          M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

      • Compute optimized:

        • Previous generation: (not recommended)

          C1 node types: cache.c1.xlarge

      • Memory optimized:

        • Current generation:

          R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

          cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

          Note: For region availability, see Supported Node Types

          R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

          R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

        • Previous generation: (not recommended)

          M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

          R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

      Additional node type info

      • All current generation instance types are created in Amazon VPC by default.

      • Redis append-only files (AOF) are not supported for T1 or T2 instances.

      • Redis Multi-AZ with automatic failover is not supported on T1 instances.

      • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

    • Engine — (String)

      The name of the cache engine to be used for the clusters in this replication group. Must be Redis.

    • EngineVersion — (String)

      The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

      Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

    • CacheParameterGroupName — (String)

      The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

      If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

      • To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.

      • To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.

    • CacheSubnetGroupName — (String)

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

      If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

    • CacheSecurityGroupNames — (Array<String>)

      A list of cache security group names to associate with this replication group.

    • SecurityGroupIds — (Array<String>)

      One or more Amazon VPC security groups associated with this replication group.

      Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

    • 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. Tags on replication groups will be replicated to all nodes.

      • Key — (String)

        The key for the tag. May not be null.

      • Value — (String)

        The tag's value. May be null.

    • SnapshotArns — (Array<String>)

      A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.

      Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

    • SnapshotName — (String)

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

    • PreferredMaintenanceWindow — (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:

      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 member of the replication group accepts connections.

    • NotificationTopicArn — (String)

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

      Note: The Amazon SNS topic owner must be the same as the cluster owner.
    • AutoMinorVersionUpgrade — (Boolean)

      This parameter is currently disabled.

    • SnapshotRetentionLimit — (Integer)

      The number of days for which ElastiCache 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.

      Default: 0 (i.e., automatic backups are disabled for this cluster).

    • SnapshotWindow — (String)

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

      Example: 05:00-09:00

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

    • AuthToken — (String)

      Reserved parameter. The password used to access a password protected server.

      AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.

      For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

      Password constraints:

      • Must be only printable ASCII characters.

      • Must be at least 16 characters and no more than 128 characters in length.

      • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

      For more information, see AUTH password at http://redis.io/commands/AUTH.

    • TransitEncryptionEnabled — (Boolean)

      A flag that enables in-transit encryption when set to true.

      You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

      This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is being created in an Amazon VPC.

      If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup.

      Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

      Default: false

      For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

    • AtRestEncryptionEnabled — (Boolean)

      A flag that enables encryption at rest when set to true.

      You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

      Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

      Default: false

    • KmsKeyId — (String)

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

    • UserGroupIds — (Array<String>)

      The user group to associate with the replication group.

    • LogDeliveryConfigurations — (Array<map>)

      Specifies the destination, format and type of the logs.

      • LogType — (String)

        Refers to slow-log.

        Possible values include:
        • "slow-log"
      • DestinationType — (String)

        Specify either cloudwatch-logs or kinesis-firehose as the destination type.

        Possible values include:
        • "cloudwatch-logs"
        • "kinesis-firehose"
      • DestinationDetails — (map)

        Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

        • CloudWatchLogsDetails — (map)

          The configuration details of the CloudWatch Logs destination.

          • LogGroup — (String)

            The name of the CloudWatch Logs log group.

        • KinesisFirehoseDetails — (map)

          The configuration details of the Kinesis Data Firehose destination.

          • DeliveryStream — (String)

            The name of the Kinesis Data Firehose delivery stream.

      • LogFormat — (String)

        Specifies either JSON or TEXT

        Possible values include:
        • "text"
        • "json"
      • Enabled — (Boolean)

        Specify if log delivery is enabled. Default true.

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:

      • ReplicationGroup — (map)

        Contains all of the attributes of a specific Redis replication group.

        • ReplicationGroupId — (String)

          The identifier for the replication group.

        • Description — (String)

          The user supplied description of the replication group.

        • GlobalReplicationGroupInfo — (map)

          The name of the Global datastore and role of this replication group in the Global datastore.

          • GlobalReplicationGroupId — (String)

            The name of the Global datastore

          • GlobalReplicationGroupMemberRole — (String)

            The role of the replication group in a Global datastore. Can be primary or secondary.

        • Status — (String)

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

        • PendingModifiedValues — (map)

          A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

          • PrimaryClusterId — (String)

            The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.

          • AutomaticFailoverStatus — (String)

            Indicates the status of automatic failover for this Redis replication group.

            Possible values include:
            • "enabled"
            • "disabled"
          • Resharding — (map)

            The status of an online resharding operation.

            • SlotMigration — (map)

              Represents the progress of an online resharding operation.

              • ProgressPercentage — (Float)

                The percentage of the slot migration that is complete.

          • AuthTokenStatus — (String)

            The auth token status

            Possible values include:
            • "SETTING"
            • "ROTATING"
          • UserGroups — (map)

            The user group being modified.

            • UserGroupIdsToAdd — (Array<String>)

              The ID of the user group to add.

            • UserGroupIdsToRemove — (Array<String>)

              The ID of the user group to remove.

          • LogDeliveryConfigurations — (Array<map>)

            The log delivery configurations being modified

            • LogType — (String)

              Refers to slow-log.

              Possible values include:
              • "slow-log"
            • DestinationType — (String)

              Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

              Possible values include:
              • "cloudwatch-logs"
              • "kinesis-firehose"
            • DestinationDetails — (map)

              Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

              • CloudWatchLogsDetails — (map)

                The configuration details of the CloudWatch Logs destination.

                • LogGroup — (String)

                  The name of the CloudWatch Logs log group.

              • KinesisFirehoseDetails — (map)

                The configuration details of the Kinesis Data Firehose destination.

                • DeliveryStream — (String)

                  The name of the Kinesis Data Firehose delivery stream.

            • LogFormat — (String)

              Returns the log format, either JSON or TEXT

              Possible values include:
              • "text"
              • "json"
        • MemberClusters — (Array<String>)

          The names of all the cache clusters that are part of this replication group.

        • NodeGroups — (Array<map>)

          A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

          • NodeGroupId — (String)

            The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.

          • Status — (String)

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

          • PrimaryEndpoint — (map)

            The endpoint of the primary node in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • ReaderEndpoint — (map)

            The endpoint of the replica nodes in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • Slots — (String)

            The keyspace for this node group (shard).

          • NodeGroupMembers — (Array<map>)

            A list containing information about individual nodes within the node group (shard).

            • CacheClusterId — (String)

              The ID of the cluster to which the node belongs.

            • CacheNodeId — (String)

              The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).

            • ReadEndpoint — (map)

              The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.

              • Address — (String)

                The DNS hostname of the cache node.

              • Port — (Integer)

                The port number that the cache engine is listening on.

            • PreferredAvailabilityZone — (String)

              The name of the Availability Zone in which the node is located.

            • PreferredOutpostArn — (String)

              The outpost ARN of the node group member.

            • CurrentRole — (String)

              The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.

        • SnapshottingClusterId — (String)

          The cluster ID that is used as the daily snapshot source for the replication group.

        • AutomaticFailover — (String)

          Indicates the status of automatic failover for this Redis replication group.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
        • MultiAZ — (String)

          A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

          Possible values include:
          • "enabled"
          • "disabled"
        • ConfigurationEndpoint — (map)

          The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

          • Address — (String)

            The DNS hostname of the cache node.

          • Port — (Integer)

            The port number that the cache engine is listening on.

        • SnapshotRetentionLimit — (Integer)

          The number of days for which ElastiCache 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.

          If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

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

          Example: 05:00-09:00

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

          Note: This parameter is only valid if the Engine parameter is redis.
        • ClusterEnabled — (Boolean)

          A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

          Valid values: true | false

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for each node in the replication group.

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • AuthTokenLastModifiedDate — (Date)

          The date the auth token was last modified

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true.

          You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at-rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • MemberClustersOutpostArns — (Array<String>)

          The outpost ARNs of the replication group's member clusters.

        • KmsKeyId — (String)

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

        • ARN — (String)

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

        • UserGroupIds — (Array<String>)

          The ID of the user group associated to the replication group.

        • LogDeliveryConfigurations — (Array<map>)

          Returns the destination, format and type of the logs.

          • LogType — (String)

            Refers to slow-log.

            Possible values include:
            • "slow-log"
          • DestinationType — (String)

            Returns the destination type, either cloudwatch-logs or kinesis-firehose.

            Possible values include:
            • "cloudwatch-logs"
            • "kinesis-firehose"
          • DestinationDetails — (map)

            Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

            • CloudWatchLogsDetails — (map)

              The configuration details of the CloudWatch Logs destination.

              • LogGroup — (String)

                The name of the CloudWatch Logs log group.

            • KinesisFirehoseDetails — (map)

              The configuration details of the Kinesis Data Firehose destination.

              • DeliveryStream — (String)

                The name of the Kinesis Data Firehose delivery stream.

          • LogFormat — (String)

            Returns the log format, either JSON or TEXT.

            Possible values include:
            • "text"
            • "json"
          • Status — (String)

            Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

            Possible values include:
            • "active"
            • "enabling"
            • "modifying"
            • "disabling"
            • "error"
          • Message — (String)

            Returns an error message for the log delivery configuration.

        • ReplicationGroupCreateTime — (Date)

          The date and time when the cluster was created.

Returns:

  • (AWS.Request) —

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

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

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

Note: This operation is valid for Redis only.

Service Reference:

Examples:

Calling the createSnapshot operation

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

      The identifier of an existing replication group. The snapshot is created from this replication group.

    • CacheClusterId — (String)

      The identifier of an existing cluster. 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)

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

        • SnapshotName — (String)

          The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.

        • ReplicationGroupId — (String)

          The unique identifier of the source replication group.

        • ReplicationGroupDescription — (String)

          A description of the source replication group.

        • CacheClusterId — (String)

          The user-supplied identifier of the source cluster.

        • SnapshotStatus — (String)

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

        • SnapshotSource — (String)

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

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for the source cluster.

          The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

          • General purpose:

            • Current generation:

              M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

              Note: For region availability, see Supported Node Types

              M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

              M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

              T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

              T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

            • Previous generation: (not recommended)

              T1 node types: cache.t1.micro

              M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

              M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

          • Compute optimized:

            • Previous generation: (not recommended)

              C1 node types: cache.c1.xlarge

          • Memory optimized:

            • Current generation:

              R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

              Note: For region availability, see Supported Node Types

              R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

              R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

            • Previous generation: (not recommended)

              M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

              R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

          Additional node type info

          • All current generation instance types are created in Amazon VPC by default.

          • Redis append-only files (AOF) are not supported for T1 or T2 instances.

          • Redis Multi-AZ with automatic failover is not supported on T1 instances.

          • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

        • Engine — (String)

          The name of the cache engine (memcached or redis) used by the source cluster.

        • EngineVersion — (String)

          The version of the cache engine version that is used by the source cluster.

        • NumCacheNodes — (Integer)

          The number of cache nodes in the source cluster.

          For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

        • PreferredAvailabilityZone — (String)

          The name of the Availability Zone in which the source cluster is located.

        • PreferredOutpostArn — (String)

          The ARN (Amazon Resource Name) of the preferred outpost.

        • CacheClusterCreateTime — (Date)

          The date and time when the source cluster was created.

        • PreferredMaintenanceWindow — (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

        • TopicArn — (String)

          The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.

        • Port — (Integer)

          The port number used by each cache nodes in the source cluster.

        • CacheParameterGroupName — (String)

          The cache parameter group that is associated with the source cluster.

        • CacheSubnetGroupName — (String)

          The name of the cache subnet group associated with the source cluster.

        • VpcId — (String)

          The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

        • AutoMinorVersionUpgrade — (Boolean)

          This parameter is currently disabled.

        • SnapshotRetentionLimit — (Integer)

          For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.

          For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation.

          Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

          The daily time range during which ElastiCache takes daily snapshots of the source cluster.

        • NumNodeGroups — (Integer)

          The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.

        • AutomaticFailover — (String)

          Indicates the status of automatic failover for the source Redis replication group.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
        • NodeSnapshots — (Array<map>)

          A list of the cache nodes in the source cluster.

          • CacheClusterId — (String)

            A unique identifier for the source cluster.

          • NodeGroupId — (String)

            A unique identifier for the source node group (shard).

          • CacheNodeId — (String)

            The cache node identifier for the node in the source cluster.

          • NodeGroupConfiguration — (map)

            The configuration for the source node group (shard).

            • NodeGroupId — (String)

              Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

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

              Example: "0-3999"

            • ReplicaCount — (Integer)

              The number of read replica nodes in this node group (shard).

            • PrimaryAvailabilityZone — (String)

              The Availability Zone where the primary node of this node group (shard) is launched.

            • ReplicaAvailabilityZones — (Array<String>)

              A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.

            • PrimaryOutpostArn — (String)

              The outpost ARN of the primary node.

            • ReplicaOutpostArns — (Array<String>)

              The outpost ARN of the node replicas.

          • CacheSize — (String)

            The size of the cache on the source cache node.

          • CacheNodeCreateTime — (Date)

            The date and time when the cache node was created in the source cluster.

          • SnapshotCreateTime — (Date)

            The date and time when the source node's metadata and cache data set was obtained for the snapshot.

        • KmsKeyId — (String)

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

        • ARN — (String)

          The ARN (Amazon Resource Name) of the snapshot.

Returns:

  • (AWS.Request) —

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

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

For Redis engine version 6.x onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC).

Service Reference:

Examples:

Calling the createUser operation

var params = {
  AccessString: 'STRING_VALUE', /* required */
  Engine: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE', /* required */
  UserName: 'STRING_VALUE', /* required */
  NoPasswordRequired: true || false,
  Passwords: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
elasticache.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: {}) —
    • UserId — (String)

      The ID of the user.

    • UserName — (String)

      The username of the user.

    • Engine — (String)

      The current supported value is Redis.

    • Passwords — (Array<String>)

      Passwords used for this user. You can create up to two passwords for each user.

    • AccessString — (String)

      Access permissions string used for this user.

    • NoPasswordRequired — (Boolean)

      Indicates a password is not required 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:

      • UserId — (String)

        The ID of the user.

      • UserName — (String)

        The username of the user.

      • Status — (String)

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

      • Engine — (String)

        The current supported value is Redis.

      • AccessString — (String)

        Access permissions string used for this user.

      • UserGroupIds — (Array<String>)

        Returns a list of the user group IDs the user belongs to.

      • Authentication — (map)

        Denotes whether the user requires a password to authenticate.

        • Type — (String)

          Indicates whether the user requires a password to authenticate.

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

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

      • ARN — (String)

        The Amazon Resource Name (ARN) of the user.

Returns:

  • (AWS.Request) —

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

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

For Redis engine version 6.x onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC)

Service Reference:

Examples:

Calling the createUserGroup operation

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

      The ID of the user group.

    • Engine — (String)

      The current supported value is Redis.

    • UserIds — (Array<String>)

      The list of user IDs that belong to the user 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:

      • UserGroupId — (String)

        The ID of the user group.

      • Status — (String)

        Indicates user group status. Can be "creating", "active", "modifying", "deleting".

      • Engine — (String)

        The current supported value is Redis.

      • UserIds — (Array<String>)

        The list of user IDs that belong to the user group.

      • PendingChanges — (map)

        A list of updates being applied to the user group.

        • UserIdsToRemove — (Array<String>)

          The list of user IDs to remove.

        • UserIdsToAdd — (Array<String>)

          The list of user IDs to add.

      • ReplicationGroups — (Array<String>)

        A list of replication groups that the user group can access.

      • ARN — (String)

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

Returns:

  • (AWS.Request) —

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

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

Decreases the number of node groups in a Global datastore

Service Reference:

Examples:

Calling the decreaseNodeGroupsInGlobalReplicationGroup operation

var params = {
  ApplyImmediately: true || false, /* required */
  GlobalReplicationGroupId: 'STRING_VALUE', /* required */
  NodeGroupCount: 'NUMBER_VALUE', /* required */
  GlobalNodeGroupsToRemove: [
    'STRING_VALUE',
    /* more items */
  ],
  GlobalNodeGroupsToRetain: [
    'STRING_VALUE',
    /* more items */
  ]
};
elasticache.decreaseNodeGroupsInGlobalReplicationGroup(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: {}) —
    • GlobalReplicationGroupId — (String)

      The name of the Global datastore

    • NodeGroupCount — (Integer)

      The number of node groups (shards) that results from the modification of the shard configuration

    • GlobalNodeGroupsToRemove — (Array<String>)

      If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache for Redis will attempt to remove all node groups listed by GlobalNodeGroupsToRemove from the cluster.

    • GlobalNodeGroupsToRetain — (Array<String>)

      If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster. ElastiCache for Redis will attempt to retain all node groups listed by GlobalNodeGroupsToRetain from the cluster.

    • ApplyImmediately — (Boolean)

      Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.

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:

      • GlobalReplicationGroup — (map)

        Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

        • The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

        • GlobalReplicationGroupId — (String)

          The name of the Global datastore

        • GlobalReplicationGroupDescription — (String)

          The optional description of the Global datastore

        • Status — (String)

          The status of the Global datastore

        • CacheNodeType — (String)

          The cache node type of the Global datastore

        • Engine — (String)

          The Elasticache engine. For Redis only.

        • EngineVersion — (String)

          The Elasticache Redis engine version.

        • Members — (Array<map>)

          The replication groups that comprise the Global datastore.

          • ReplicationGroupId — (String)

            The replication group id of the Global datastore member.

          • ReplicationGroupRegion — (String)

            The Amazon region of the Global datastore member.

          • Role — (String)

            Indicates the role of the replication group, primary or secondary.

          • AutomaticFailover — (String)

            Indicates whether automatic failover is enabled for the replication group.

            Possible values include:
            • "enabled"
            • "disabled"
            • "enabling"
            • "disabling"
          • Status — (String)

            The status of the membership of the replication group.

        • ClusterEnabled — (Boolean)

          A flag that indicates whether the Global datastore is cluster enabled.

        • GlobalNodeGroups — (Array<map>)

          Indicates the slot configuration and global identifier for each slice group.

          • GlobalNodeGroupId — (String)

            The name of the global node group

          • Slots — (String)

            The keyspace for this node group

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

        • ARN — (String)

          The ARN (Amazon Resource Name) of the global replication group.

Returns:

  • (AWS.Request) —

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

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

Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.

Service Reference:

Examples:

Calling the decreaseReplicaCount operation

var params = {
  ApplyImmediately: true || false, /* required */
  ReplicationGroupId: 'STRING_VALUE', /* required */
  NewReplicaCount: 'NUMBER_VALUE',
  ReplicaConfiguration: [
    {
      NewReplicaCount: 'NUMBER_VALUE', /* required */
      NodeGroupId: 'STRING_VALUE', /* required */
      PreferredAvailabilityZones: [
        'STRING_VALUE',
        /* more items */
      ],
      PreferredOutpostArns: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  ReplicasToRemove: [
    'STRING_VALUE',
    /* more items */
  ]
};
elasticache.decreaseReplicaCount(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: {}) —
    • ReplicationGroupId — (String)

      The id of the replication group from which you want to remove replica nodes.

    • NewReplicaCount — (Integer)

      The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

      The minimum number of replicas in a shard or replication group is:

      • Redis (cluster mode disabled)

        • If Multi-AZ is enabled: 1

        • If Multi-AZ is not enabled: 0

      • Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

    • ReplicaConfiguration — (Array<map>)

      A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

      • NodeGroupId — required — (String)

        The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.

      • NewReplicaCount — required — (Integer)

        The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis replication group you are working with.

        The minimum number of replicas in a shard or replication group is:

        • Redis (cluster mode disabled)

          • If Multi-AZ: 1

          • If Multi-AZ: 0

        • Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

      • PreferredAvailabilityZones — (Array<String>)

        A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache for Redis selects the availability zone for each of the replicas.

      • PreferredOutpostArns — (Array<String>)

        The outpost ARNs in which the cache cluster is created.

    • ReplicasToRemove — (Array<String>)

      A list of the node ids to remove from the replication group or node group (shard).

    • ApplyImmediately — (Boolean)

      If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

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:

      • ReplicationGroup — (map)

        Contains all of the attributes of a specific Redis replication group.

        • ReplicationGroupId — (String)

          The identifier for the replication group.

        • Description — (String)

          The user supplied description of the replication group.

        • GlobalReplicationGroupInfo — (map)

          The name of the Global datastore and role of this replication group in the Global datastore.

          • GlobalReplicationGroupId — (String)

            The name of the Global datastore

          • GlobalReplicationGroupMemberRole — (String)

            The role of the replication group in a Global datastore. Can be primary or secondary.

        • Status — (String)

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

        • PendingModifiedValues — (map)

          A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

          • PrimaryClusterId — (String)

            The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.

          • AutomaticFailoverStatus — (String)

            Indicates the status of automatic failover for this Redis replication group.

            Possible values include:
            • "enabled"
            • "disabled"
          • Resharding — (map)

            The status of an online resharding operation.

            • SlotMigration — (map)

              Represents the progress of an online resharding operation.

              • ProgressPercentage — (Float)

                The percentage of the slot migration that is complete.

          • AuthTokenStatus — (String)

            The auth token status

            Possible values include:
            • "SETTING"
            • "ROTATING"
          • UserGroups — (map)

            The user group being modified.

            • UserGroupIdsToAdd — (Array<String>)

              The ID of the user group to add.

            • UserGroupIdsToRemove — (Array<String>)

              The ID of the user group to remove.

          • LogDeliveryConfigurations — (Array<map>)

            The log delivery configurations being modified

            • LogType — (String)

              Refers to slow-log.

              Possible values include:
              • "slow-log"
            • DestinationType — (String)

              Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

              Possible values include:
              • "cloudwatch-logs"
              • "kinesis-firehose"
            • DestinationDetails — (map)

              Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

              • CloudWatchLogsDetails — (map)

                The configuration details of the CloudWatch Logs destination.

                • LogGroup — (String)

                  The name of the CloudWatch Logs log group.

              • KinesisFirehoseDetails — (map)

                The configuration details of the Kinesis Data Firehose destination.

                • DeliveryStream — (String)

                  The name of the Kinesis Data Firehose delivery stream.

            • LogFormat — (String)

              Returns the log format, either JSON or TEXT

              Possible values include:
              • "text"
              • "json"
        • MemberClusters — (Array<String>)

          The names of all the cache clusters that are part of this replication group.

        • NodeGroups — (Array<map>)

          A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

          • NodeGroupId — (String)

            The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.

          • Status — (String)

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

          • PrimaryEndpoint — (map)

            The endpoint of the primary node in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • ReaderEndpoint — (map)

            The endpoint of the replica nodes in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • Slots — (String)

            The keyspace for this node group (shard).

          • NodeGroupMembers — (Array<map>)

            A list containing information about individual nodes within the node group (shard).

            • CacheClusterId — (String)

              The ID of the cluster to which the node belongs.

            • CacheNodeId — (String)

              The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).

            • ReadEndpoint — (map)

              The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.

              • Address — (String)

                The DNS hostname of the cache node.

              • Port — (Integer)

                The port number that the cache engine is listening on.

            • PreferredAvailabilityZone — (String)

              The name of the Availability Zone in which the node is located.

            • PreferredOutpostArn — (String)

              The outpost ARN of the node group member.

            • CurrentRole — (String)

              The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.

        • SnapshottingClusterId — (String)

          The cluster ID that is used as the daily snapshot source for the replication group.

        • AutomaticFailover — (String)

          Indicates the status of automatic failover for this Redis replication group.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
        • MultiAZ — (String)

          A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

          Possible values include:
          • "enabled"
          • "disabled"
        • ConfigurationEndpoint — (map)

          The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

          • Address — (String)

            The DNS hostname of the cache node.

          • Port — (Integer)

            The port number that the cache engine is listening on.

        • SnapshotRetentionLimit — (Integer)

          The number of days for which ElastiCache 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.

          If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

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

          Example: 05:00-09:00

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

          Note: This parameter is only valid if the Engine parameter is redis.
        • ClusterEnabled — (Boolean)

          A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

          Valid values: true | false

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for each node in the replication group.

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • AuthTokenLastModifiedDate — (Date)

          The date the auth token was last modified

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true.

          You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at-rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • MemberClustersOutpostArns — (Array<String>)

          The outpost ARNs of the replication group's member clusters.

        • KmsKeyId — (String)

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

        • ARN — (String)

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

        • UserGroupIds — (Array<String>)

          The ID of the user group associated to the replication group.

        • LogDeliveryConfigurations — (Array<map>)

          Returns the destination, format and type of the logs.

          • LogType — (String)

            Refers to slow-log.

            Possible values include:
            • "slow-log"
          • DestinationType — (String)

            Returns the destination type, either cloudwatch-logs or kinesis-firehose.

            Possible values include:
            • "cloudwatch-logs"
            • "kinesis-firehose"
          • DestinationDetails — (map)

            Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

            • CloudWatchLogsDetails — (map)

              The configuration details of the CloudWatch Logs destination.

              • LogGroup — (String)

                The name of the CloudWatch Logs log group.

            • KinesisFirehoseDetails — (map)

              The configuration details of the Kinesis Data Firehose destination.

              • DeliveryStream — (String)

                The name of the Kinesis Data Firehose delivery stream.

          • LogFormat — (String)

            Returns the log format, either JSON or TEXT.

            Possible values include:
            • "text"
            • "json"
          • Status — (String)

            Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

            Possible values include:
            • "active"
            • "enabling"
            • "modifying"
            • "disabling"
            • "error"
          • Message — (String)

            Returns an error message for the log delivery configuration.

        • ReplicationGroupCreateTime — (Date)

          The date and time when the cluster was created.

Returns:

  • (AWS.Request) —

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

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

Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.

This operation is not valid for:

  • Redis (cluster mode enabled) clusters

  • Redis (cluster mode disabled) clusters

  • A cluster that is the last read replica of a replication group

  • A cluster that is the primary node of a replication group

  • A node group (shard) that has Multi-AZ mode enabled

  • A cluster from a Redis (cluster mode enabled) replication group

  • A cluster that is not in the available state

Service Reference:

Examples:

Calling the deleteCacheCluster operation

var params = {
  CacheClusterId: 'STRING_VALUE', /* required */
  FinalSnapshotIdentifier: 'STRING_VALUE'
};
elasticache.deleteCacheCluster(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: {}) —
    • CacheClusterId — (String)

      The cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

    • FinalSnapshotIdentifier — (String)

      The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache 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:

      • CacheCluster — (map)

        Contains all of the attributes of a specific cluster.

        • CacheClusterId — (String)

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

        • ConfigurationEndpoint — (map)

          Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.

          Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211

          • Address — (String)

            The DNS hostname of the cache node.

          • Port — (Integer)

            The port number that the cache engine is listening on.

        • ClientDownloadLandingPage — (String)

          The URL of the web page where you can download the latest ElastiCache client library.

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for the cluster.

          The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

          • General purpose:

            • Current generation:

              M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

              Note: For region availability, see Supported Node Types

              M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

              M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

              T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

              T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

            • Previous generation: (not recommended)

              T1 node types: cache.t1.micro

              M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

              M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

          • Compute optimized:

            • Previous generation: (not recommended)

              C1 node types: cache.c1.xlarge

          • Memory optimized:

            • Current generation:

              R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

              Note: For region availability, see Supported Node Types

              R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

              R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

            • Previous generation: (not recommended)

              M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

              R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

          Additional node type info

          • All current generation instance types are created in Amazon VPC by default.

          • Redis append-only files (AOF) are not supported for T1 or T2 instances.

          • Redis Multi-AZ with automatic failover is not supported on T1 instances.

          • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

        • Engine — (String)

          The name of the cache engine (memcached or redis) to be used for this cluster.

        • EngineVersion — (String)

          The version of the cache engine that is used in this cluster.

        • CacheClusterStatus — (String)

          The current state of this cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cluster nodes, restore-failed, or snapshotting.

        • NumCacheNodes — (Integer)

          The number of cache nodes in the cluster.

          For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

        • PreferredAvailabilityZone — (String)

          The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

        • PreferredOutpostArn — (String)

          The outpost ARN in which the cache cluster is created.

        • CacheClusterCreateTime — (Date)

          The date and time when the cluster was created.

        • PreferredMaintenanceWindow — (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

        • PendingModifiedValues — (map)

          A group of settings that are applied to the cluster in the future, or that are currently being applied.

          • NumCacheNodes — (Integer)

            The new number of cache nodes for the cluster.

            For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

          • CacheNodeIdsToRemove — (Array<String>)

            A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).

          • EngineVersion — (String)

            The new cache engine version that the cluster runs.

          • CacheNodeType — (String)

            The cache node type that this cluster or replication group is scaled to.

          • AuthTokenStatus — (String)

            The auth token status

            Possible values include:
            • "SETTING"
            • "ROTATING"
          • LogDeliveryConfigurations — (Array<map>)

            The log delivery configurations being modified

            • LogType — (String)

              Refers to slow-log.

              Possible values include:
              • "slow-log"
            • DestinationType — (String)

              Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

              Possible values include:
              • "cloudwatch-logs"
              • "kinesis-firehose"
            • DestinationDetails — (map)

              Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

              • CloudWatchLogsDetails — (map)

                The configuration details of the CloudWatch Logs destination.

                • LogGroup — (String)

                  The name of the CloudWatch Logs log group.

              • KinesisFirehoseDetails — (map)

                The configuration details of the Kinesis Data Firehose destination.

                • DeliveryStream — (String)

                  The name of the Kinesis Data Firehose delivery stream.

            • LogFormat — (String)

              Returns the log format, either JSON or TEXT

              Possible values include:
              • "text"
              • "json"
        • NotificationConfiguration — (map)

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

          • TopicArn — (String)

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

          • TopicStatus — (String)

            The current state of the topic.

        • CacheSecurityGroups — (Array<map>)

          A list of cache security group elements, composed of name and status sub-elements.

          • CacheSecurityGroupName — (String)

            The name of the cache security group.

          • Status — (String)

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

        • CacheParameterGroup — (map)

          Status of the cache parameter group.

          • CacheParameterGroupName — (String)

            The name of the cache parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • CacheNodeIdsToReboot — (Array<String>)

            A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).

        • CacheSubnetGroupName — (String)

          The name of the cache subnet group associated with the cluster.

        • CacheNodes — (Array<map>)

          A list of cache nodes that are members of the cluster.

          • CacheNodeId — (String)

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

          • CacheNodeStatus — (String)

            The current state of this cache node, one of the following values: available, creating, rebooting, or deleting.

          • CacheNodeCreateTime — (Date)

            The date and time when the cache node was created.

          • Endpoint — (map)

            The hostname for connecting to this cache node.

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • ParameterGroupStatus — (String)

            The status of the parameter group applied to this cache node.

          • SourceCacheNodeId — (String)

            The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cluster.

          • CustomerAvailabilityZone — (String)

            The Availability Zone where this node was created and now resides.

          • CustomerOutpostArn — (String)

            The customer outpost ARN of the cache node.

        • AutoMinorVersionUpgrade — (Boolean)

          This parameter is currently disabled.

        • SecurityGroups — (Array<map>)

          A list of VPC Security Groups associated with the cluster.

          • SecurityGroupId — (String)

            The identifier of the cache security group.

          • Status — (String)

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

        • ReplicationGroupId — (String)

          The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.

        • SnapshotRetentionLimit — (Integer)

          The number of days for which ElastiCache 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.

          If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

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

          Example: 05:00-09:00

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • AuthTokenLastModifiedDate — (Date)

          The date the auth token was last modified

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true.

          You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at-rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • ARN — (String)

          The ARN (Amazon Resource Name) of the cache cluster.

        • ReplicationGroupLogDeliveryEnabled — (Boolean)

          A boolean value indicating whether log delivery is enabled for the replication group.

        • LogDeliveryConfigurations — (Array<map>)

          Returns the destination, format and type of the logs.

          • LogType — (String)

            Refers to slow-log.

            Possible values include:
            • "slow-log"
          • DestinationType — (String)

            Returns the destination type, either cloudwatch-logs or kinesis-firehose.

            Possible values include:
            • "cloudwatch-logs"
            • "kinesis-firehose"
          • DestinationDetails — (map)

            Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

            • CloudWatchLogsDetails — (map)

              The configuration details of the CloudWatch Logs destination.

              • LogGroup — (String)

                The name of the CloudWatch Logs log group.

            • KinesisFirehoseDetails — (map)

              The configuration details of the Kinesis Data Firehose destination.

              • DeliveryStream — (String)

                The name of the Kinesis Data Firehose delivery stream.

          • LogFormat — (String)

            Returns the log format, either JSON or TEXT.

            Possible values include:
            • "text"
            • "json"
          • Status — (String)

            Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

            Possible values include:
            • "active"
            • "enabling"
            • "modifying"
            • "disabling"
            • "error"
          • Message — (String)

            Returns an error message for the log delivery configuration.

Returns:

  • (AWS.Request) —

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

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

Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. You cannot delete the default cache parameter groups in your account.

Service Reference:

Examples:

Calling the deleteCacheParameterGroup operation

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

      The name of the cache parameter group to delete.

      Note: The specified cache security group must not be associated with any clusters.

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.

Returns:

  • (AWS.Request) —

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

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

Deletes a cache security group.

Note: You cannot delete a cache security group if it is associated with any clusters.

Service Reference:

Examples:

Calling the deleteCacheSecurityGroup operation

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

      The name of the cache security group to delete.

      Note: You cannot delete the default security 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.

Returns:

  • (AWS.Request) —

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

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

Deletes a cache subnet group.

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

Service Reference:

Examples:

Calling the deleteCacheSubnetGroup operation

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

      The name of the cache subnet group to delete.

      Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

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.

Returns:

  • (AWS.Request) —

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

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

Deleting a Global datastore is a two-step process:

  • First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.

  • Once the Global datastore contains only the primary cluster, you can use the DeleteGlobalReplicationGroup API to delete the Global datastore while retainining the primary cluster using RetainPrimaryReplicationGroup=true.

Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the primary by setting RetainPrimaryReplicationGroup=true. The primary cluster is never deleted when deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

Service Reference:

Examples:

Calling the deleteGlobalReplicationGroup operation

var params = {
  GlobalReplicationGroupId: 'STRING_VALUE', /* required */
  RetainPrimaryReplicationGroup: true || false /* required */
};
elasticache.deleteGlobalReplicationGroup(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: {}) —
    • GlobalReplicationGroupId — (String)

      The name of the Global datastore

    • RetainPrimaryReplicationGroup — (Boolean)

      The primary replication group is retained as a standalone replication 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:

      • GlobalReplicationGroup — (map)

        Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

        • The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

        • GlobalReplicationGroupId — (String)

          The name of the Global datastore

        • GlobalReplicationGroupDescription — (String)

          The optional description of the Global datastore

        • Status — (String)

          The status of the Global datastore

        • CacheNodeType — (String)

          The cache node type of the Global datastore

        • Engine — (String)

          The Elasticache engine. For Redis only.

        • EngineVersion — (String)

          The Elasticache Redis engine version.

        • Members — (Array<map>)

          The replication groups that comprise the Global datastore.

          • ReplicationGroupId — (String)

            The replication group id of the Global datastore member.

          • ReplicationGroupRegion — (String)

            The Amazon region of the Global datastore member.

          • Role — (String)

            Indicates the role of the replication group, primary or secondary.

          • AutomaticFailover — (String)

            Indicates whether automatic failover is enabled for the replication group.

            Possible values include:
            • "enabled"
            • "disabled"
            • "enabling"
            • "disabling"
          • Status — (String)

            The status of the membership of the replication group.

        • ClusterEnabled — (Boolean)

          A flag that indicates whether the Global datastore is cluster enabled.

        • GlobalNodeGroups — (Array<map>)

          Indicates the slot configuration and global identifier for each slice group.

          • GlobalNodeGroupId — (String)

            The name of the global node group

          • Slots — (String)

            The keyspace for this node group

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

        • ARN — (String)

          The ARN (Amazon Resource Name) of the global replication group.

Returns:

  • (AWS.Request) —

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

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

Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true.

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

Note: This operation is valid for Redis only.

Service Reference:

Examples:

Calling the deleteReplicationGroup operation

var params = {
  ReplicationGroupId: 'STRING_VALUE', /* required */
  FinalSnapshotIdentifier: 'STRING_VALUE',
  RetainPrimaryCluster: true || false
};
elasticache.deleteReplicationGroup(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: {}) —
    • ReplicationGroupId — (String)

      The identifier for the cluster to be deleted. This parameter is not case sensitive.

    • RetainPrimaryCluster — (Boolean)

      If set to true, all of the read replicas are deleted, but the primary node is retained.

    • FinalSnapshotIdentifier — (String)

      The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • ReplicationGroup — (map)

        Contains all of the attributes of a specific Redis replication group.

        • ReplicationGroupId — (String)

          The identifier for the replication group.

        • Description — (String)

          The user supplied description of the replication group.

        • GlobalReplicationGroupInfo — (map)

          The name of the Global datastore and role of this replication group in the Global datastore.

          • GlobalReplicationGroupId — (String)

            The name of the Global datastore

          • GlobalReplicationGroupMemberRole — (String)

            The role of the replication group in a Global datastore. Can be primary or secondary.

        • Status — (String)

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

        • PendingModifiedValues — (map)

          A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

          • PrimaryClusterId — (String)

            The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.

          • AutomaticFailoverStatus — (String)

            Indicates the status of automatic failover for this Redis replication group.

            Possible values include:
            • "enabled"
            • "disabled"
          • Resharding — (map)

            The status of an online resharding operation.

            • SlotMigration — (map)

              Represents the progress of an online resharding operation.

              • ProgressPercentage — (Float)

                The percentage of the slot migration that is complete.

          • AuthTokenStatus — (String)

            The auth token status

            Possible values include:
            • "SETTING"
            • "ROTATING"
          • UserGroups — (map)

            The user group being modified.

            • UserGroupIdsToAdd — (Array<String>)

              The ID of the user group to add.

            • UserGroupIdsToRemove — (Array<String>)

              The ID of the user group to remove.

          • LogDeliveryConfigurations — (Array<map>)

            The log delivery configurations being modified

            • LogType — (String)

              Refers to slow-log.

              Possible values include:
              • "slow-log"
            • DestinationType — (String)

              Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

              Possible values include:
              • "cloudwatch-logs"
              • "kinesis-firehose"
            • DestinationDetails — (map)

              Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

              • CloudWatchLogsDetails — (map)

                The configuration details of the CloudWatch Logs destination.

                • LogGroup — (String)

                  The name of the CloudWatch Logs log group.

              • KinesisFirehoseDetails — (map)

                The configuration details of the Kinesis Data Firehose destination.

                • DeliveryStream — (String)

                  The name of the Kinesis Data Firehose delivery stream.

            • LogFormat — (String)

              Returns the log format, either JSON or TEXT

              Possible values include:
              • "text"
              • "json"
        • MemberClusters — (Array<String>)

          The names of all the cache clusters that are part of this replication group.

        • NodeGroups — (Array<map>)

          A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

          • NodeGroupId — (String)

            The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.

          • Status — (String)

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

          • PrimaryEndpoint — (map)

            The endpoint of the primary node in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • ReaderEndpoint — (map)

            The endpoint of the replica nodes in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • Slots — (String)

            The keyspace for this node group (shard).

          • NodeGroupMembers — (Array<map>)

            A list containing information about individual nodes within the node group (shard).

            • CacheClusterId — (String)

              The ID of the cluster to which the node belongs.

            • CacheNodeId — (String)

              The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).

            • ReadEndpoint — (map)

              The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.

              • Address — (String)

                The DNS hostname of the cache node.

              • Port — (Integer)

                The port number that the cache engine is listening on.

            • PreferredAvailabilityZone — (String)

              The name of the Availability Zone in which the node is located.

            • PreferredOutpostArn — (String)

              The outpost ARN of the node group member.

            • CurrentRole — (String)

              The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.

        • SnapshottingClusterId — (String)

          The cluster ID that is used as the daily snapshot source for the replication group.

        • AutomaticFailover — (String)

          Indicates the status of automatic failover for this Redis replication group.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
        • MultiAZ — (String)

          A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

          Possible values include:
          • "enabled"
          • "disabled"
        • ConfigurationEndpoint — (map)

          The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

          • Address — (String)

            The DNS hostname of the cache node.

          • Port — (Integer)

            The port number that the cache engine is listening on.

        • SnapshotRetentionLimit — (Integer)

          The number of days for which ElastiCache 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.

          If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

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

          Example: 05:00-09:00

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

          Note: This parameter is only valid if the Engine parameter is redis.
        • ClusterEnabled — (Boolean)

          A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

          Valid values: true | false

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for each node in the replication group.

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • AuthTokenLastModifiedDate — (Date)

          The date the auth token was last modified

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true.

          You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at-rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • MemberClustersOutpostArns — (Array<String>)

          The outpost ARNs of the replication group's member clusters.

        • KmsKeyId — (String)

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

        • ARN — (String)

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

        • UserGroupIds — (Array<String>)

          The ID of the user group associated to the replication group.

        • LogDeliveryConfigurations — (Array<map>)

          Returns the destination, format and type of the logs.

          • LogType — (String)

            Refers to slow-log.

            Possible values include:
            • "slow-log"
          • DestinationType — (String)

            Returns the destination type, either cloudwatch-logs or kinesis-firehose.

            Possible values include:
            • "cloudwatch-logs"
            • "kinesis-firehose"
          • DestinationDetails — (map)

            Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

            • CloudWatchLogsDetails — (map)

              The configuration details of the CloudWatch Logs destination.

              • LogGroup — (String)

                The name of the CloudWatch Logs log group.

            • KinesisFirehoseDetails — (map)

              The configuration details of the Kinesis Data Firehose destination.

              • DeliveryStream — (String)

                The name of the Kinesis Data Firehose delivery stream.

          • LogFormat — (String)

            Returns the log format, either JSON or TEXT.

            Possible values include:
            • "text"
            • "json"
          • Status — (String)

            Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

            Possible values include:
            • "active"
            • "enabling"
            • "modifying"
            • "disabling"
            • "error"
          • Message — (String)

            Returns an error message for the log delivery configuration.

        • ReplicationGroupCreateTime — (Date)

          The date and time when the cluster was created.

Returns:

  • (AWS.Request) —

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

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

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

Note: This operation is valid for Redis only.

Service Reference:

Examples:

Calling the deleteSnapshot operation

var params = {
  SnapshotName: 'STRING_VALUE' /* required */
};
elasticache.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 be deleted.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • Snapshot — (map)

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

        • SnapshotName — (String)

          The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.

        • ReplicationGroupId — (String)

          The unique identifier of the source replication group.

        • ReplicationGroupDescription — (String)

          A description of the source replication group.

        • CacheClusterId — (String)

          The user-supplied identifier of the source cluster.

        • SnapshotStatus — (String)

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

        • SnapshotSource — (String)

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

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for the source cluster.

          The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

          • General purpose:

            • Current generation:

              M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

              Note: For region availability, see Supported Node Types

              M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

              M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

              T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

              T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

            • Previous generation: (not recommended)

              T1 node types: cache.t1.micro

              M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

              M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

          • Compute optimized:

            • Previous generation: (not recommended)

              C1 node types: cache.c1.xlarge

          • Memory optimized:

            • Current generation:

              R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

              Note: For region availability, see Supported Node Types

              R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

              R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

            • Previous generation: (not recommended)

              M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

              R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

          Additional node type info

          • All current generation instance types are created in Amazon VPC by default.

          • Redis append-only files (AOF) are not supported for T1 or T2 instances.

          • Redis Multi-AZ with automatic failover is not supported on T1 instances.

          • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

        • Engine — (String)

          The name of the cache engine (memcached or redis) used by the source cluster.

        • EngineVersion — (String)

          The version of the cache engine version that is used by the source cluster.

        • NumCacheNodes — (Integer)

          The number of cache nodes in the source cluster.

          For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

        • PreferredAvailabilityZone — (String)

          The name of the Availability Zone in which the source cluster is located.

        • PreferredOutpostArn — (String)

          The ARN (Amazon Resource Name) of the preferred outpost.

        • CacheClusterCreateTime — (Date)

          The date and time when the source cluster was created.

        • PreferredMaintenanceWindow — (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

        • TopicArn — (String)

          The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.

        • Port — (Integer)

          The port number used by each cache nodes in the source cluster.

        • CacheParameterGroupName — (String)

          The cache parameter group that is associated with the source cluster.

        • CacheSubnetGroupName — (String)

          The name of the cache subnet group associated with the source cluster.

        • VpcId — (String)

          The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

        • AutoMinorVersionUpgrade — (Boolean)

          This parameter is currently disabled.

        • SnapshotRetentionLimit — (Integer)

          For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.

          For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation.

          Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

          The daily time range during which ElastiCache takes daily snapshots of the source cluster.

        • NumNodeGroups — (Integer)

          The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.

        • AutomaticFailover — (String)

          Indicates the status of automatic failover for the source Redis replication group.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
        • NodeSnapshots — (Array<map>)

          A list of the cache nodes in the source cluster.

          • CacheClusterId — (String)

            A unique identifier for the source cluster.

          • NodeGroupId — (String)

            A unique identifier for the source node group (shard).

          • CacheNodeId — (String)

            The cache node identifier for the node in the source cluster.

          • NodeGroupConfiguration — (map)

            The configuration for the source node group (shard).

            • NodeGroupId — (String)

              Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

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

              Example: "0-3999"

            • ReplicaCount — (Integer)

              The number of read replica nodes in this node group (shard).

            • PrimaryAvailabilityZone — (String)

              The Availability Zone where the primary node of this node group (shard) is launched.

            • ReplicaAvailabilityZones — (Array<String>)

              A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.

            • PrimaryOutpostArn — (String)

              The outpost ARN of the primary node.

            • ReplicaOutpostArns — (Array<String>)

              The outpost ARN of the node replicas.

          • CacheSize — (String)

            The size of the cache on the source cache node.

          • CacheNodeCreateTime — (Date)

            The date and time when the cache node was created in the source cluster.

          • SnapshotCreateTime — (Date)

            The date and time when the source node's metadata and cache data set was obtained for the snapshot.

        • KmsKeyId — (String)

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

        • ARN — (String)

          The ARN (Amazon Resource Name) of the snapshot.

Returns:

  • (AWS.Request) —

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

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

For Redis engine version 6.x onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC).

Service Reference:

Examples:

Calling the deleteUser operation

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

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

      • UserId — (String)

        The ID of the user.

      • UserName — (String)

        The username of the user.

      • Status — (String)

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

      • Engine — (String)

        The current supported value is Redis.

      • AccessString — (String)

        Access permissions string used for this user.

      • UserGroupIds — (Array<String>)

        Returns a list of the user group IDs the user belongs to.

      • Authentication — (map)

        Denotes whether the user requires a password to authenticate.

        • Type — (String)

          Indicates whether the user requires a password to authenticate.

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

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

      • ARN — (String)

        The Amazon Resource Name (ARN) of the user.

Returns:

  • (AWS.Request) —

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

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

For Redis engine version 6.x onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC).

Service Reference:

Examples:

Calling the deleteUserGroup operation

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

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

      • UserGroupId — (String)

        The ID of the user group.

      • Status — (String)

        Indicates user group status. Can be "creating", "active", "modifying", "deleting".

      • Engine — (String)

        The current supported value is Redis.

      • UserIds — (Array<String>)

        The list of user IDs that belong to the user group.

      • PendingChanges — (map)

        A list of updates being applied to the user group.

        • UserIdsToRemove — (Array<String>)

          The list of user IDs to remove.

        • UserIdsToAdd — (Array<String>)

          The list of user IDs to add.

      • ReplicationGroups — (Array<String>)

        A list of replication groups that the user group can access.

      • ARN — (String)

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

Returns:

  • (AWS.Request) —

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

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

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

By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint.

If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned.

If the cluster is in the deleting state, only cluster-level information is displayed.

If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use.

If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.

Service Reference:

Examples:

Calling the describeCacheClusters operation

var params = {
  CacheClusterId: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  ShowCacheClustersNotInReplicationGroups: true || false,
  ShowCacheNodeInfo: true || false
};
elasticache.describeCacheClusters(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: {}) —
    • CacheClusterId — (String)

      The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.

    • MaxRecords — (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.

      Default: 100

      Constraints: minimum 20; maximum 100.

    • Marker — (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.

    • ShowCacheNodeInfo — (Boolean)

      An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

    • ShowCacheClustersNotInReplicationGroups — (Boolean)

      An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

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:

      • Marker — (String)

        Provides an identifier to allow retrieval of paginated results.

      • CacheClusters — (Array<map>)

        A list of clusters. Each item in the list contains detailed information about one cluster.

        • CacheClusterId — (String)

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

        • ConfigurationEndpoint — (map)

          Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.

          Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211

          • Address — (String)

            The DNS hostname of the cache node.

          • Port — (Integer)

            The port number that the cache engine is listening on.

        • ClientDownloadLandingPage — (String)

          The URL of the web page where you can download the latest ElastiCache client library.

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for the cluster.

          The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

          • General purpose:

            • Current generation:

              M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

              Note: For region availability, see Supported Node Types

              M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

              M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

              T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

              T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

            • Previous generation: (not recommended)

              T1 node types: cache.t1.micro

              M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

              M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

          • Compute optimized:

            • Previous generation: (not recommended)

              C1 node types: cache.c1.xlarge

          • Memory optimized:

            • Current generation:

              R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

              Note: For region availability, see Supported Node Types

              R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

              R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

            • Previous generation: (not recommended)

              M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

              R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

          Additional node type info

          • All current generation instance types are created in Amazon VPC by default.

          • Redis append-only files (AOF) are not supported for T1 or T2 instances.

          • Redis Multi-AZ with automatic failover is not supported on T1 instances.

          • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

        • Engine — (String)

          The name of the cache engine (memcached or redis) to be used for this cluster.

        • EngineVersion — (String)

          The version of the cache engine that is used in this cluster.

        • CacheClusterStatus — (String)

          The current state of this cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cluster nodes, restore-failed, or snapshotting.

        • NumCacheNodes — (Integer)

          The number of cache nodes in the cluster.

          For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

        • PreferredAvailabilityZone — (String)

          The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

        • PreferredOutpostArn — (String)

          The outpost ARN in which the cache cluster is created.

        • CacheClusterCreateTime — (Date)

          The date and time when the cluster was created.

        • PreferredMaintenanceWindow — (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

        • PendingModifiedValues — (map)

          A group of settings that are applied to the cluster in the future, or that are currently being applied.

          • NumCacheNodes — (Integer)

            The new number of cache nodes for the cluster.

            For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

          • CacheNodeIdsToRemove — (Array<String>)

            A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).

          • EngineVersion — (String)

            The new cache engine version that the cluster runs.

          • CacheNodeType — (String)

            The cache node type that this cluster or replication group is scaled to.

          • AuthTokenStatus — (String)

            The auth token status

            Possible values include:
            • "SETTING"
            • "ROTATING"
          • LogDeliveryConfigurations — (Array<map>)

            The log delivery configurations being modified

            • LogType — (String)

              Refers to slow-log.

              Possible values include:
              • "slow-log"
            • DestinationType — (String)

              Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

              Possible values include:
              • "cloudwatch-logs"
              • "kinesis-firehose"
            • DestinationDetails — (map)

              Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

              • CloudWatchLogsDetails — (map)

                The configuration details of the CloudWatch Logs destination.

                • LogGroup — (String)

                  The name of the CloudWatch Logs log group.

              • KinesisFirehoseDetails — (map)

                The configuration details of the Kinesis Data Firehose destination.

                • DeliveryStream — (String)

                  The name of the Kinesis Data Firehose delivery stream.

            • LogFormat — (String)

              Returns the log format, either JSON or TEXT

              Possible values include:
              • "text"
              • "json"
        • NotificationConfiguration — (map)

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

          • TopicArn — (String)

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

          • TopicStatus — (String)

            The current state of the topic.

        • CacheSecurityGroups — (Array<map>)

          A list of cache security group elements, composed of name and status sub-elements.

          • CacheSecurityGroupName — (String)

            The name of the cache security group.

          • Status — (String)

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

        • CacheParameterGroup — (map)

          Status of the cache parameter group.

          • CacheParameterGroupName — (String)

            The name of the cache parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • CacheNodeIdsToReboot — (Array<String>)

            A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).

        • CacheSubnetGroupName — (String)

          The name of the cache subnet group associated with the cluster.

        • CacheNodes — (Array<map>)

          A list of cache nodes that are members of the cluster.

          • CacheNodeId — (String)

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

          • CacheNodeStatus — (String)

            The current state of this cache node, one of the following values: available, creating, rebooting, or deleting.

          • CacheNodeCreateTime — (Date)

            The date and time when the cache node was created.

          • Endpoint — (map)

            The hostname for connecting to this cache node.

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • ParameterGroupStatus — (String)

            The status of the parameter group applied to this cache node.

          • SourceCacheNodeId — (String)

            The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cluster.

          • CustomerAvailabilityZone — (String)

            The Availability Zone where this node was created and now resides.

          • CustomerOutpostArn — (String)

            The customer outpost ARN of the cache node.

        • AutoMinorVersionUpgrade — (Boolean)

          This parameter is currently disabled.

        • SecurityGroups — (Array<map>)

          A list of VPC Security Groups associated with the cluster.

          • SecurityGroupId — (String)

            The identifier of the cache security group.

          • Status — (String)

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

        • ReplicationGroupId — (String)

          The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.

        • SnapshotRetentionLimit — (Integer)

          The number of days for which ElastiCache 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.

          If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

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

          Example: 05:00-09:00

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • AuthTokenLastModifiedDate — (Date)

          The date the auth token was last modified

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true.

          You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at-rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • ARN — (String)

          The ARN (Amazon Resource Name) of the cache cluster.

        • ReplicationGroupLogDeliveryEnabled — (Boolean)

          A boolean value indicating whether log delivery is enabled for the replication group.

        • LogDeliveryConfigurations — (Array<map>)

          Returns the destination, format and type of the logs.

          • LogType — (String)

            Refers to slow-log.

            Possible values include:
            • "slow-log"
          • DestinationType — (String)

            Returns the destination type, either cloudwatch-logs or kinesis-firehose.

            Possible values include:
            • "cloudwatch-logs"
            • "kinesis-firehose"
          • DestinationDetails — (map)

            Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

            • CloudWatchLogsDetails — (map)

              The configuration details of the CloudWatch Logs destination.

              • LogGroup — (String)

                The name of the CloudWatch Logs log group.

            • KinesisFirehoseDetails — (map)

              The configuration details of the Kinesis Data Firehose destination.

              • DeliveryStream — (String)

                The name of the Kinesis Data Firehose delivery stream.

          • LogFormat — (String)

            Returns the log format, either JSON or TEXT.

            Possible values include:
            • "text"
            • "json"
          • Status — (String)

            Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

            Possible values include:
            • "active"
            • "enabling"
            • "modifying"
            • "disabling"
            • "error"
          • Message — (String)

            Returns an error message for the log delivery configuration.

Returns:

  • (AWS.Request) —

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

Waiter Resource States:

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

Returns a list of the available cache engines and their versions.

Service Reference:

Examples:

Calling the describeCacheEngineVersions operation

var params = {
  CacheParameterGroupFamily: 'STRING_VALUE',
  DefaultOnly: true || false,
  Engine: 'STRING_VALUE',
  EngineVersion: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
elasticache.describeCacheEngineVersions(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: {}) —
    • Engine — (String)

      The cache engine to return. Valid values: memcached | redis

    • EngineVersion — (String)

      The cache engine version to return.

      Example: 1.4.14

    • CacheParameterGroupFamily — (String)

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

      Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x |

      Constraints:

      • Must be 1 to 255 alphanumeric characters

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • MaxRecords — (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.

      Default: 100

      Constraints: minimum 20; maximum 100.

    • Marker — (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.

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

      • Marker — (String)

        Provides an identifier to allow retrieval of paginated results.

      • CacheEngineVersions — (Array<map>)

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

        • Engine — (String)

          The name of the cache engine.

        • EngineVersion — (String)

          The version number of the cache engine.

        • CacheParameterGroupFamily — (String)

          The name of the cache parameter group family associated with this cache engine.

          Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x |

        • CacheEngineDescription — (String)

          The description of the cache engine.

        • CacheEngineVersionDescription — (String)

          The description of the cache engine version.

Returns:

  • (AWS.Request) —

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

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

Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.

Service Reference:

Examples:

Calling the describeCacheParameterGroups operation

var params = {
  CacheParameterGroupName: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
elasticache.describeCacheParameterGroups(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: {}) —
    • CacheParameterGroupName — (String)

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

    • MaxRecords — (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.

      Default: 100

      Constraints: minimum 20; maximum 100.

    • Marker — (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:

      • Marker — (String)

        Provides an identifier to allow retrieval of paginated results.

      • CacheParameterGroups — (Array<map>)

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

        • CacheParameterGroupName — (String)

          The name of the cache parameter group.

        • CacheParameterGroupFamily — (String)

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

          Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x |

        • Description — (String)

          The description for this cache parameter group.

        • IsGlobal — (Boolean)

          Indicates whether the parameter group is associated with a Global datastore

        • ARN — (String)

          The ARN (Amazon Resource Name) of the cache parameter group.

Returns:

  • (AWS.Request) —

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

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

Returns the detailed parameter list for a particular cache parameter group.

Service Reference:

Examples:

Calling the describeCacheParameters operation

var params = {
  CacheParameterGroupName: 'STRING_VALUE', /* required */
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  Source: 'STRING_VALUE'
};
elasticache.describeCacheParameters(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: {}) —
    • CacheParameterGroupName — (String)

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

    • Source — (String)

      The parameter types to return.

      Valid values: user | system | engine-default

    • MaxRecords — (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.

      Default: 100

      Constraints: minimum 20; maximum 100.

    • Marker — (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:

      • Marker — (String)

        Provides an identifier to allow retrieval of paginated results.

      • Parameters — (Array<map>)

        A list of Parameter instances.

        • ParameterName — (String)

          The name of the parameter.

        • ParameterValue — (String)

          The value of the parameter.

        • Description — (String)

          A description of the parameter.

        • Source — (String)

          The source of the parameter.

        • DataType — (String)

          The valid data type for the parameter.

        • AllowedValues — (String)

          The valid range of values for the parameter.

        • IsModifiable — (Boolean)

          Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

        • MinimumEngineVersion — (String)

          The earliest cache engine version to which the parameter can apply.

        • ChangeType — (String)

          Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

          Possible values include:
          • "immediate"
          • "requires-reboot"
      • CacheNodeTypeSpecificParameters — (Array<map>)

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

        • ParameterName — (String)

          The name of the parameter.

        • Description — (String)

          A description of the parameter.

        • Source — (String)

          The source of the parameter value.

        • DataType — (String)

          The valid data type for the parameter.

        • AllowedValues — (String)

          The valid range of values for the parameter.

        • IsModifiable — (Boolean)

          Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

        • MinimumEngineVersion — (String)

          The earliest cache engine version to which the parameter can apply.

        • CacheNodeTypeSpecificValues — (Array<map>)

          A list of cache node types and their corresponding values for this parameter.

          • CacheNodeType — (String)

            The cache node type for which this value applies.

          • Value — (String)

            The value for the cache node type.

        • ChangeType — (String)

          Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

          Possible values include:
          • "immediate"
          • "requires-reboot"

Returns:

  • (AWS.Request) —

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

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

Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This applicable only when you have ElastiCache in Classic setup

Service Reference:

Examples:

Calling the describeCacheSecurityGroups operation

var params = {
  CacheSecurityGroupName: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
elasticache.describeCacheSecurityGroups(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: {}) —
    • CacheSecurityGroupName — (String)

      The name of the cache security group to return details for.

    • MaxRecords — (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.

      Default: 100

      Constraints: minimum 20; maximum 100.

    • Marker — (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:

      • Marker — (String)

        Provides an identifier to allow retrieval of paginated results.

      • CacheSecurityGroups — (Array<map>)

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

        • OwnerId — (String)

          The Amazon account ID of the cache security group owner.

        • CacheSecurityGroupName — (String)

          The name of the cache security group.

        • Description — (String)

          The description of the cache security group.

        • EC2SecurityGroups — (Array<map>)

          A list of Amazon EC2 security groups that are associated with this cache security group.

          • Status — (String)

            The status of the Amazon EC2 security group.

          • EC2SecurityGroupName — (String)

            The name of the Amazon EC2 security group.

          • EC2SecurityGroupOwnerId — (String)

            The Amazon account ID of the Amazon EC2 security group owner.

        • ARN — (String)

          The ARN of the cache security group,

Returns:

  • (AWS.Request) —

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

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

Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.

Service Reference:

Examples:

Calling the describeCacheSubnetGroups operation

var params = {
  CacheSubnetGroupName: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
elasticache.describeCacheSubnetGroups(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: {}) —
    • CacheSubnetGroupName — (String)

      The name of the cache subnet group to return details for.

    • MaxRecords — (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.

      Default: 100

      Constraints: minimum 20; maximum 100.

    • Marker — (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:

      • Marker — (String)

        Provides an identifier to allow retrieval of paginated results.

      • CacheSubnetGroups — (Array<map>)

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

        • CacheSubnetGroupName — (String)

          The name of the cache subnet group.

        • CacheSubnetGroupDescription — (String)

          The description of the cache subnet group.

        • VpcId — (String)

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

        • Subnets — (Array<map>)

          A list of subnets associated with the cache subnet group.

          • SubnetIdentifier — (String)

            The unique identifier for the subnet.

          • SubnetAvailabilityZone — (map)

            The Availability Zone associated with the subnet.

            • Name — (String)

              The name of the Availability Zone.

          • SubnetOutpost — (map)

            The outpost ARN of the subnet.

            • SubnetOutpostArn — (String)

              The outpost ARN of the subnet.

        • ARN — (String)

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

Returns:

  • (AWS.Request) —

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

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

Returns the default engine and system parameter information for the specified cache engine.

Service Reference:

Examples:

Calling the describeEngineDefaultParameters operation

var params = {
  CacheParameterGroupFamily: 'STRING_VALUE', /* required */
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
elasticache.describeEngineDefaultParameters(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: {}) —
    • CacheParameterGroupFamily — (String)

      The name of the cache parameter group family.

      Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x |

    • MaxRecords — (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.

      Default: 100

      Constraints: minimum 20; maximum 100.

    • Marker — (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:

      • EngineDefaults — (map)

        Represents the output of a DescribeEngineDefaultParameters operation.

        • CacheParameterGroupFamily — (String)

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

          Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x |

        • Marker — (String)

          Provides an identifier to allow retrieval of paginated results.

        • Parameters — (Array<map>)

          Contains a list of engine default parameters.

          • ParameterName — (String)

            The name of the parameter.

          • ParameterValue — (String)

            The value of the parameter.

          • Description — (String)

            A description of the parameter.

          • Source — (String)

            The source of the parameter.

          • DataType — (String)

            The valid data type for the parameter.

          • AllowedValues — (String)

            The valid range of values for the parameter.

          • IsModifiable — (Boolean)

            Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

          • MinimumEngineVersion — (String)

            The earliest cache engine version to which the parameter can apply.

          • ChangeType — (String)

            Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

            Possible values include:
            • "immediate"
            • "requires-reboot"
        • CacheNodeTypeSpecificParameters — (Array<map>)

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

          • ParameterName — (String)

            The name of the parameter.

          • Description — (String)

            A description of the parameter.

          • Source — (String)

            The source of the parameter value.

          • DataType — (String)

            The valid data type for the parameter.

          • AllowedValues — (String)

            The valid range of values for the parameter.

          • IsModifiable — (Boolean)

            Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

          • MinimumEngineVersion — (String)

            The earliest cache engine version to which the parameter can apply.

          • CacheNodeTypeSpecificValues — (Array<map>)

            A list of cache node types and their corresponding values for this parameter.

            • CacheNodeType — (String)

              The cache node type for which this value applies.

            • Value — (String)

              The value for the cache node type.

          • ChangeType — (String)

            Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

            Possible values include:
            • "immediate"
            • "requires-reboot"

Returns:

  • (AWS.Request) —

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

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

Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter.

By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

Service Reference:

Examples:

Calling the describeEvents operation

var params = {
  Duration: 'NUMBER_VALUE',
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  SourceIdentifier: 'STRING_VALUE',
  SourceType: cache-cluster | cache-parameter-group | cache-security-group | cache-subnet-group | replication-group | user | user-group,
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
elasticache.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: {}) —
    • SourceIdentifier — (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:
      • "cache-cluster"
      • "cache-parameter-group"
      • "cache-security-group"
      • "cache-subnet-group"
      • "replication-group"
      • "user"
      • "user-group"
    • 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.

    • MaxRecords — (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.

      Default: 100

      Constraints: minimum 20; maximum 100.

    • Marker — (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:

      • Marker — (String)

        Provides an identifier to allow retrieval of paginated results.

      • Events — (Array<map>)

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

        • SourceIdentifier — (String)

          The identifier 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:
          • "cache-cluster"
          • "cache-parameter-group"
          • "cache-security-group"
          • "cache-subnet-group"
          • "replication-group"
          • "user"
          • "user-group"
        • 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.

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

Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.

Service Reference:

Examples:

Calling the describeGlobalReplicationGroups operation

var params = {
  GlobalReplicationGroupId: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  ShowMemberInfo: true || false
};
elasticache.describeGlobalReplicationGroups(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: {}) —
    • GlobalReplicationGroupId — (String)

      The name of the Global datastore

    • MaxRecords — (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.

    • Marker — (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.

    • ShowMemberInfo — (Boolean)

      Returns the list of members that comprise the Global datastore.

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:

      • Marker — (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. >

      • GlobalReplicationGroups — (Array<map>)

        Indicates the slot configuration and global identifier for each slice group.

        • GlobalReplicationGroupId — (String)

          The name of the Global datastore

        • GlobalReplicationGroupDescription — (String)

          The optional description of the Global datastore

        • Status — (String)

          The status of the Global datastore

        • CacheNodeType — (String)

          The cache node type of the Global datastore

        • Engine — (String)

          The Elasticache engine. For Redis only.

        • EngineVersion — (String)

          The Elasticache Redis engine version.

        • Members — (Array<map>)

          The replication groups that comprise the Global datastore.

          • ReplicationGroupId — (String)

            The replication group id of the Global datastore member.

          • ReplicationGroupRegion — (String)

            The Amazon region of the Global datastore member.

          • Role — (String)

            Indicates the role of the replication group, primary or secondary.

          • AutomaticFailover — (String)

            Indicates whether automatic failover is enabled for the replication group.

            Possible values include:
            • "enabled"
            • "disabled"
            • "enabling"
            • "disabling"
          • Status — (String)

            The status of the membership of the replication group.

        • ClusterEnabled — (Boolean)

          A flag that indicates whether the Global datastore is cluster enabled.

        • GlobalNodeGroups — (Array<map>)

          Indicates the slot configuration and global identifier for each slice group.

          • GlobalNodeGroupId — (String)

            The name of the global node group

          • Slots — (String)

            The keyspace for this node group

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

        • ARN — (String)

          The ARN (Amazon Resource Name) of the global replication group.

Returns:

  • (AWS.Request) —

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

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

Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.

Note: This operation is valid for Redis only.

Service Reference:

Examples:

Calling the describeReplicationGroups operation

var params = {
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  ReplicationGroupId: 'STRING_VALUE'
};
elasticache.describeReplicationGroups(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: {}) —
    • ReplicationGroupId — (String)

      The identifier for the replication group to be described. This parameter is not case sensitive.

      If you do not specify this parameter, information about all replication groups is returned.

    • MaxRecords — (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.

      Default: 100

      Constraints: minimum 20; maximum 100.

    • Marker — (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:

      • Marker — (String)

        Provides an identifier to allow retrieval of paginated results.

      • ReplicationGroups — (Array<map>)

        A list of replication groups. Each item in the list contains detailed information about one replication group.

        • ReplicationGroupId — (String)

          The identifier for the replication group.

        • Description — (String)

          The user supplied description of the replication group.

        • GlobalReplicationGroupInfo — (map)

          The name of the Global datastore and role of this replication group in the Global datastore.

          • GlobalReplicationGroupId — (String)

            The name of the Global datastore

          • GlobalReplicationGroupMemberRole — (String)

            The role of the replication group in a Global datastore. Can be primary or secondary.

        • Status — (String)

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

        • PendingModifiedValues — (map)

          A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

          • PrimaryClusterId — (String)

            The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.

          • AutomaticFailoverStatus — (String)

            Indicates the status of automatic failover for this Redis replication group.

            Possible values include:
            • "enabled"
            • "disabled"
          • Resharding — (map)

            The status of an online resharding operation.

            • SlotMigration — (map)

              Represents the progress of an online resharding operation.

              • ProgressPercentage — (Float)

                The percentage of the slot migration that is complete.

          • AuthTokenStatus — (String)

            The auth token status

            Possible values include:
            • "SETTING"
            • "ROTATING"
          • UserGroups — (map)

            The user group being modified.

            • UserGroupIdsToAdd — (Array<String>)

              The ID of the user group to add.

            • UserGroupIdsToRemove — (Array<String>)

              The ID of the user group to remove.

          • LogDeliveryConfigurations — (Array<map>)

            The log delivery configurations being modified

            • LogType — (String)

              Refers to slow-log.

              Possible values include:
              • "slow-log"
            • DestinationType — (String)

              Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

              Possible values include:
              • "cloudwatch-logs"
              • "kinesis-firehose"
            • DestinationDetails — (map)

              Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

              • CloudWatchLogsDetails — (map)

                The configuration details of the CloudWatch Logs destination.

                • LogGroup — (String)

                  The name of the CloudWatch Logs log group.

              • KinesisFirehoseDetails — (map)

                The configuration details of the Kinesis Data Firehose destination.

                • DeliveryStream — (String)

                  The name of the Kinesis Data Firehose delivery stream.

            • LogFormat — (String)

              Returns the log format, either JSON or TEXT

              Possible values include:
              • "text"
              • "json"
        • MemberClusters — (Array<String>)

          The names of all the cache clusters that are part of this replication group.

        • NodeGroups — (Array<map>)

          A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

          • NodeGroupId — (String)

            The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.

          • Status — (String)

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

          • PrimaryEndpoint — (map)

            The endpoint of the primary node in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • ReaderEndpoint — (map)

            The endpoint of the replica nodes in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • Slots — (String)

            The keyspace for this node group (shard).

          • NodeGroupMembers — (Array<map>)

            A list containing information about individual nodes within the node group (shard).

            • CacheClusterId — (String)

              The ID of the cluster to which the node belongs.

            • CacheNodeId — (String)

              The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).

            • ReadEndpoint — (map)

              The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.

              • Address — (String)

                The DNS hostname of the cache node.

              • Port — (Integer)

                The port number that the cache engine is listening on.

            • PreferredAvailabilityZone — (String)

              The name of the Availability Zone in which the node is located.

            • PreferredOutpostArn — (String)

              The outpost ARN of the node group member.

            • CurrentRole — (String)

              The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.

        • SnapshottingClusterId — (String)

          The cluster ID that is used as the daily snapshot source for the replication group.

        • AutomaticFailover — (String)

          Indicates the status of automatic failover for this Redis replication group.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
        • MultiAZ — (String)

          A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

          Possible values include:
          • "enabled"
          • "disabled"
        • ConfigurationEndpoint — (map)

          The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

          • Address — (String)

            The DNS hostname of the cache node.

          • Port — (Integer)

            The port number that the cache engine is listening on.

        • SnapshotRetentionLimit — (Integer)

          The number of days for which ElastiCache 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.

          If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

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

          Example: 05:00-09:00

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

          Note: This parameter is only valid if the Engine parameter is redis.
        • ClusterEnabled — (Boolean)

          A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

          Valid values: true | false

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for each node in the replication group.

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • AuthTokenLastModifiedDate — (Date)

          The date the auth token was last modified

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true.

          You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at-rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • MemberClustersOutpostArns — (Array<String>)

          The outpost ARNs of the replication group's member clusters.

        • KmsKeyId — (String)

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

        • ARN — (String)

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

        • UserGroupIds — (Array<String>)

          The ID of the user group associated to the replication group.

        • LogDeliveryConfigurations — (Array<map>)

          Returns the destination, format and type of the logs.

          • LogType — (String)

            Refers to slow-log.

            Possible values include:
            • "slow-log"
          • DestinationType — (String)

            Returns the destination type, either cloudwatch-logs or kinesis-firehose.

            Possible values include:
            • "cloudwatch-logs"
            • "kinesis-firehose"
          • DestinationDetails — (map)

            Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

            • CloudWatchLogsDetails — (map)

              The configuration details of the CloudWatch Logs destination.

              • LogGroup — (String)

                The name of the CloudWatch Logs log group.

            • KinesisFirehoseDetails — (map)

              The configuration details of the Kinesis Data Firehose destination.

              • DeliveryStream — (String)

                The name of the Kinesis Data Firehose delivery stream.

          • LogFormat — (String)

            Returns the log format, either JSON or TEXT.

            Possible values include:
            • "text"
            • "json"
          • Status — (String)

            Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

            Possible values include:
            • "active"
            • "enabling"
            • "modifying"
            • "disabling"
            • "error"
          • Message — (String)

            Returns an error message for the log delivery configuration.

        • ReplicationGroupCreateTime — (Date)

          The date and time when the cluster was created.

Returns:

  • (AWS.Request) —

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

Waiter Resource States:

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

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

Service Reference:

Examples:

Calling the describeReservedCacheNodes operation

var params = {
  CacheNodeType: 'STRING_VALUE',
  Duration: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  OfferingType: 'STRING_VALUE',
  ProductDescription: 'STRING_VALUE',
  ReservedCacheNodeId: 'STRING_VALUE',
  ReservedCacheNodesOfferingId: 'STRING_VALUE'
};
elasticache.describeReservedCacheNodes(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: {}) —
    • ReservedCacheNodeId — (String)

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

    • ReservedCacheNodesOfferingId — (String)

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

    • CacheNodeType — (String)

      The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

      The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

      • General purpose:

        • Current generation:

          M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

          cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

          Note: For region availability, see Supported Node Types

          M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

          M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

          T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

          T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

        • Previous generation: (not recommended)

          T1 node types: cache.t1.micro

          M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

          M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

      • Compute optimized:

        • Previous generation: (not recommended)

          C1 node types: cache.c1.xlarge

      • Memory optimized:

        • Current generation:

          R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

          cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

          Note: For region availability, see Supported Node Types

          R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

          R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

        • Previous generation: (not recommended)

          M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

          R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

      Additional node type info

      • All current generation instance types are created in Amazon VPC by default.

      • Redis append-only files (AOF) are not supported for T1 or T2 instances.

      • Redis Multi-AZ with automatic failover is not supported on T1 instances.

      • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

    • Duration — (String)

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

      Valid Values: 1 | 3 | 31536000 | 94608000

    • ProductDescription — (String)

      The product description filter value. Use this parameter to show only those reservations matching the specified product description.

    • OfferingType — (String)

      The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

      Valid values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"|"All Upfront"|"Partial Upfront"| "No Upfront"

    • MaxRecords — (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.

      Default: 100

      Constraints: minimum 20; maximum 100.

    • Marker — (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:

      • Marker — (String)

        Provides an identifier to allow retrieval of paginated results.

      • ReservedCacheNodes — (Array<map>)

        A list of reserved cache nodes. Each element in the list contains detailed information about one node.

        • ReservedCacheNodeId — (String)

          The unique identifier for the reservation.

        • ReservedCacheNodesOfferingId — (String)

          The offering identifier.

        • CacheNodeType — (String)

          The cache node type for the reserved cache nodes.

          The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

          • General purpose:

            • Current generation:

              M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

              Note: For region availability, see Supported Node Types

              M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

              M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

              T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

              T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

            • Previous generation: (not recommended)

              T1 node types: cache.t1.micro

              M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

              M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

          • Compute optimized:

            • Previous generation: (not recommended)

              C1 node types: cache.c1.xlarge

          • Memory optimized:

            • Current generation:

              R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

              Note: For region availability, see Supported Node Types

              R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

              R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

            • Previous generation: (not recommended)

              M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

              R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

          Additional node type info

          • All current generation instance types are created in Amazon VPC by default.

          • Redis append-only files (AOF) are not supported for T1 or T2 instances.

          • Redis Multi-AZ with automatic failover is not supported on T1 instances.

          • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

        • 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 cache node.

        • UsagePrice — (Float)

          The hourly price charged for this reserved cache node.

        • CacheNodeCount — (Integer)

          The number of cache nodes that have been reserved.

        • ProductDescription — (String)

          The description of the reserved cache node.

        • OfferingType — (String)

          The offering type of this reserved cache node.

        • State — (String)

          The state of the reserved cache node.

        • RecurringCharges — (Array<map>)

          The recurring price charged to run this reserved cache node.

          • RecurringChargeAmount — (Float)

            The monetary amount of the recurring charge.

          • RecurringChargeFrequency — (String)

            The frequency of the recurring charge.

        • ReservationARN — (String)

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

          Example: arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582

Returns:

  • (AWS.Request) —

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

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

Lists available reserved cache node offerings.

Service Reference:

Examples:

Calling the describeReservedCacheNodesOfferings operation

var params = {
  CacheNodeType: 'STRING_VALUE',
  Duration: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  OfferingType: 'STRING_VALUE',
  ProductDescription: 'STRING_VALUE',
  ReservedCacheNodesOfferingId: 'STRING_VALUE'
};
elasticache.describeReservedCacheNodesOfferings(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: {}) —
    • ReservedCacheNodesOfferingId — (String)

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

      Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

    • CacheNodeType — (String)

      The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.

      The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

      • General purpose:

        • Current generation:

          M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

          cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

          Note: For region availability, see Supported Node Types

          M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

          M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

          T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

          T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

        • Previous generation: (not recommended)

          T1 node types: cache.t1.micro

          M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

          M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

      • Compute optimized:

        • Previous generation: (not recommended)

          C1 node types: cache.c1.xlarge

      • Memory optimized:

        • Current generation:

          R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

          cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

          Note: For region availability, see Supported Node Types

          R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

          R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

        • Previous generation: (not recommended)

          M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

          R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

      Additional node type info

      • All current generation instance types are created in Amazon VPC by default.

      • Redis append-only files (AOF) are not supported for T1 or T2 instances.

      • Redis Multi-AZ with automatic failover is not supported on T1 instances.

      • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

    • Duration — (String)

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

      Valid Values: 1 | 3 | 31536000 | 94608000

    • ProductDescription — (String)

      The product description filter value. Use this parameter to show only the available offerings matching the specified product description.

    • OfferingType — (String)

      The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

      Valid Values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization" |"All Upfront"|"Partial Upfront"| "No Upfront"

    • MaxRecords — (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.

      Default: 100

      Constraints: minimum 20; maximum 100.

    • Marker — (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:

      • Marker — (String)

        Provides an identifier to allow retrieval of paginated results.

      • ReservedCacheNodesOfferings — (Array<map>)

        A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.

        • ReservedCacheNodesOfferingId — (String)

          A unique identifier for the reserved cache node offering.

        • CacheNodeType — (String)

          The cache node type for the reserved cache node.

          The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

          • General purpose:

            • Current generation:

              M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

              Note: For region availability, see Supported Node Types

              M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

              M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

              T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

              T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

            • Previous generation: (not recommended)

              T1 node types: cache.t1.micro

              M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

              M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

          • Compute optimized:

            • Previous generation: (not recommended)

              C1 node types: cache.c1.xlarge

          • Memory optimized:

            • Current generation:

              R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

              Note: For region availability, see Supported Node Types

              R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

              R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

            • Previous generation: (not recommended)

              M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

              R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

          Additional node type info

          • All current generation instance types are created in Amazon VPC by default.

          • Redis append-only files (AOF) are not supported for T1 or T2 instances.

          • Redis Multi-AZ with automatic failover is not supported on T1 instances.

          • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

        • Duration — (Integer)

          The duration of the offering. in seconds.

        • FixedPrice — (Float)

          The fixed price charged for this offering.

        • UsagePrice — (Float)

          The hourly price charged for this offering.

        • ProductDescription — (String)

          The cache engine used by the offering.

        • OfferingType — (String)

          The offering type.

        • RecurringCharges — (Array<map>)

          The recurring price charged to run this reserved cache node.

          • RecurringChargeAmount — (Float)

            The monetary amount of the recurring charge.

          • RecurringChargeFrequency — (String)

            The frequency of the recurring charge.

Returns:

  • (AWS.Request) —

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

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

Returns details of the service updates

Service Reference:

Examples:

Calling the describeServiceUpdates operation

var params = {
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  ServiceUpdateName: 'STRING_VALUE',
  ServiceUpdateStatus: [
    available | cancelled | expired,
    /* more items */
  ]
};
elasticache.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

    • ServiceUpdateStatus — (Array<String>)

      The status of the service update

    • MaxRecords — (Integer)

      The maximum number of records to include in the response

    • Marker — (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:

      • Marker — (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.

      • ServiceUpdates — (Array<map>)

        A list of service updates

        • ServiceUpdateName — (String)

          The unique ID of the service update

        • ServiceUpdateReleaseDate — (Date)

          The date when the service update is initially available

        • ServiceUpdateEndDate — (Date)

          The date after which the service update is no longer available

        • ServiceUpdateSeverity — (String)

          The severity of the service update

          Possible values include:
          • "critical"
          • "important"
          • "medium"
          • "low"
        • ServiceUpdateRecommendedApplyByDate — (Date)

          The recommendend date to apply the service update in order to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.

        • ServiceUpdateStatus — (String)

          The status of the service update

          Possible values include:
          • "available"
          • "cancelled"
          • "expired"
        • ServiceUpdateDescription — (String)

          Provides details of the service update

        • ServiceUpdateType — (String)

          Reflects the nature of the service update

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

          The Elasticache engine to which the update applies. Either Redis or Memcached

        • EngineVersion — (String)

          The Elasticache engine version to which the update applies. Either Redis or Memcached engine version

        • AutoUpdateAfterRecommendedApplyByDate — (Boolean)

          Indicates whether the service update will be automatically applied once the recommended apply-by date has expired.

        • EstimatedUpdateTime — (String)

          The estimated length of time the service update will take

Returns:

  • (AWS.Request) —

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

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

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

Note: This operation is valid for Redis only.

Service Reference:

Examples:

Calling the describeSnapshots operation

var params = {
  CacheClusterId: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  ReplicationGroupId: 'STRING_VALUE',
  ShowNodeGroupConfig: true || false,
  SnapshotName: 'STRING_VALUE',
  SnapshotSource: 'STRING_VALUE'
};
elasticache.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: {}) —
    • ReplicationGroupId — (String)

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

    • CacheClusterId — (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 snapshot are described.

    • SnapshotSource — (String)

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

    • Marker — (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.

    • MaxRecords — (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.

      Default: 50

      Constraints: minimum 20; maximum 50.

    • ShowNodeGroupConfig — (Boolean)

      A Boolean value which if true, the node group (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:

      • Marker — (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.

      • Snapshots — (Array<map>)

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

        • SnapshotName — (String)

          The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.

        • ReplicationGroupId — (String)

          The unique identifier of the source replication group.

        • ReplicationGroupDescription — (String)

          A description of the source replication group.

        • CacheClusterId — (String)

          The user-supplied identifier of the source cluster.

        • SnapshotStatus — (String)

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

        • SnapshotSource — (String)

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

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for the source cluster.

          The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

          • General purpose:

            • Current generation:

              M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

              Note: For region availability, see Supported Node Types

              M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

              M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

              T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

              T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

            • Previous generation: (not recommended)

              T1 node types: cache.t1.micro

              M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

              M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

          • Compute optimized:

            • Previous generation: (not recommended)

              C1 node types: cache.c1.xlarge

          • Memory optimized:

            • Current generation:

              R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

              Note: For region availability, see Supported Node Types

              R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

              R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

            • Previous generation: (not recommended)

              M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

              R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

          Additional node type info

          • All current generation instance types are created in Amazon VPC by default.

          • Redis append-only files (AOF) are not supported for T1 or T2 instances.

          • Redis Multi-AZ with automatic failover is not supported on T1 instances.

          • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

        • Engine — (String)

          The name of the cache engine (memcached or redis) used by the source cluster.

        • EngineVersion — (String)

          The version of the cache engine version that is used by the source cluster.

        • NumCacheNodes — (Integer)

          The number of cache nodes in the source cluster.

          For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

        • PreferredAvailabilityZone — (String)

          The name of the Availability Zone in which the source cluster is located.

        • PreferredOutpostArn — (String)

          The ARN (Amazon Resource Name) of the preferred outpost.

        • CacheClusterCreateTime — (Date)

          The date and time when the source cluster was created.

        • PreferredMaintenanceWindow — (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

        • TopicArn — (String)

          The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.

        • Port — (Integer)

          The port number used by each cache nodes in the source cluster.

        • CacheParameterGroupName — (String)

          The cache parameter group that is associated with the source cluster.

        • CacheSubnetGroupName — (String)

          The name of the cache subnet group associated with the source cluster.

        • VpcId — (String)

          The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

        • AutoMinorVersionUpgrade — (Boolean)

          This parameter is currently disabled.

        • SnapshotRetentionLimit — (Integer)

          For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.

          For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation.

          Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

          The daily time range during which ElastiCache takes daily snapshots of the source cluster.

        • NumNodeGroups — (Integer)

          The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.

        • AutomaticFailover — (String)

          Indicates the status of automatic failover for the source Redis replication group.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
        • NodeSnapshots — (Array<map>)

          A list of the cache nodes in the source cluster.

          • CacheClusterId — (String)

            A unique identifier for the source cluster.

          • NodeGroupId — (String)

            A unique identifier for the source node group (shard).

          • CacheNodeId — (String)

            The cache node identifier for the node in the source cluster.

          • NodeGroupConfiguration — (map)

            The configuration for the source node group (shard).

            • NodeGroupId — (String)

              Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

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

              Example: "0-3999"

            • ReplicaCount — (Integer)

              The number of read replica nodes in this node group (shard).

            • PrimaryAvailabilityZone — (String)

              The Availability Zone where the primary node of this node group (shard) is launched.

            • ReplicaAvailabilityZones — (Array<String>)

              A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.

            • PrimaryOutpostArn — (String)

              The outpost ARN of the primary node.

            • ReplicaOutpostArns — (Array<String>)

              The outpost ARN of the node replicas.

          • CacheSize — (String)

            The size of the cache on the source cache node.

          • CacheNodeCreateTime — (Date)

            The date and time when the cache node was created in the source cluster.

          • SnapshotCreateTime — (Date)

            The date and time when the source node's metadata and cache data set was obtained for the snapshot.

        • KmsKeyId — (String)

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

        • ARN — (String)

          The ARN (Amazon Resource Name) of the snapshot.

Returns:

  • (AWS.Request) —

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

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

Returns details of the update actions

Service Reference:

Examples:

Calling the describeUpdateActions operation

var params = {
  CacheClusterIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Engine: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  ReplicationGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  ServiceUpdateName: 'STRING_VALUE',
  ServiceUpdateStatus: [
    available | cancelled | expired,
    /* more items */
  ],
  ServiceUpdateTimeRange: {
    EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  ShowNodeLevelUpdateStatus: true || false,
  UpdateActionStatus: [
    not-applied | waiting-to-start | in-progress | stopping | stopped | complete | scheduling | scheduled | not-applicable,
    /* more items */
  ]
};
elasticache.describeUpdateActions(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

    • ReplicationGroupIds — (Array<String>)

      The replication group IDs

    • CacheClusterIds — (Array<String>)

      The cache cluster IDs

    • Engine — (String)

      The Elasticache engine to which the update applies. Either Redis or Memcached

    • ServiceUpdateStatus — (Array<String>)

      The status of the service update

    • ServiceUpdateTimeRange — (map)

      The range of time specified to search for service updates that are in available status

      • StartTime — (Date)

        The start time of the time range filter

      • EndTime — (Date)

        The end time of the time range filter

    • UpdateActionStatus — (Array<String>)

      The status of the update action.

    • ShowNodeLevelUpdateStatus — (Boolean)

      Dictates whether to include node level update status in the response

    • MaxRecords — (Integer)

      The maximum number of records to include in the response

    • Marker — (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:

      • Marker — (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.

      • UpdateActions — (Array<map>)

        Returns a list of update actions

        • ReplicationGroupId — (String)

          The ID of the replication group

        • CacheClusterId — (String)

          The ID of the cache cluster

        • ServiceUpdateName — (String)

          The unique ID of the service update

        • ServiceUpdateReleaseDate — (Date)

          The date the update is first available

        • ServiceUpdateSeverity — (String)

          The severity of the service update

          Possible values include:
          • "critical"
          • "important"
          • "medium"
          • "low"
        • ServiceUpdateStatus — (String)

          The status of the service update

          Possible values include:
          • "available"
          • "cancelled"
          • "expired"
        • ServiceUpdateRecommendedApplyByDate — (Date)

          The recommended date to apply the service update to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.

        • ServiceUpdateType — (String)

          Reflects the nature of the service update

          Possible values include:
          • "security-update"
        • UpdateActionAvailableDate — (Date)

          The date that the service update is available to a replication group

        • UpdateActionStatus — (String)

          The status of the update action

          Possible values include:
          • "not-applied"
          • "waiting-to-start"
          • "in-progress"
          • "stopping"
          • "stopped"
          • "complete"
          • "scheduling"
          • "scheduled"
          • "not-applicable"
        • NodesUpdated — (String)

          The progress of the service update on the replication group

        • UpdateActionStatusModifiedDate — (Date)

          The date when the UpdateActionStatus was last modified

        • SlaMet — (String)

          If yes, all nodes in the replication group have been updated by the recommended apply-by date. If no, at least one node in the replication group have not been updated by the recommended apply-by date. If N/A, the replication group was created after the recommended apply-by date.

          Possible values include:
          • "yes"
          • "no"
          • "n/a"
        • NodeGroupUpdateStatus — (Array<map>)

          The status of the service update on the node group

          • NodeGroupId — (String)

            The ID of the node group

          • NodeGroupMemberUpdateStatus — (Array<map>)

            The status of the service update on the node group member

            • CacheClusterId — (String)

              The cache cluster ID

            • CacheNodeId — (String)

              The node ID of the cache cluster

            • NodeUpdateStatus — (String)

              The update status of the node

              Possible values include:
              • "not-applied"
              • "waiting-to-start"
              • "in-progress"
              • "stopping"
              • "stopped"
              • "complete"
            • NodeDeletionDate — (Date)

              The deletion date of the node

            • NodeUpdateStartDate — (Date)

              The start date of the update for a node

            • NodeUpdateEndDate — (Date)

              The end date of the update for a node

            • NodeUpdateInitiatedBy — (String)

              Reflects whether the update was initiated by the customer or automatically applied

              Possible values include:
              • "system"
              • "customer"
            • NodeUpdateInitiatedDate — (Date)

              The date when the update is triggered

            • NodeUpdateStatusModifiedDate — (Date)

              The date when the NodeUpdateStatus was last modified

        • CacheNodeUpdateStatus — (Array<map>)

          The status of the service update on the cache node

          • CacheNodeId — (String)

            The node ID of the cache cluster

          • NodeUpdateStatus — (String)

            The update status of the node

            Possible values include:
            • "not-applied"
            • "waiting-to-start"
            • "in-progress"
            • "stopping"
            • "stopped"
            • "complete"
          • NodeDeletionDate — (Date)

            The deletion date of the node

          • NodeUpdateStartDate — (Date)

            The start date of the update for a node

          • NodeUpdateEndDate — (Date)

            The end date of the update for a node

          • NodeUpdateInitiatedBy — (String)

            Reflects whether the update was initiated by the customer or automatically applied

            Possible values include:
            • "system"
            • "customer"
          • NodeUpdateInitiatedDate — (Date)

            The date when the update is triggered

          • NodeUpdateStatusModifiedDate — (Date)

            The date when the NodeUpdateStatus was last modified>

        • EstimatedUpdateTime — (String)

          The estimated length of time for the update to complete

        • Engine — (String)

          The Elasticache engine to which the update applies. Either Redis or Memcached

Returns:

  • (AWS.Request) —

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

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

Returns a list of user groups.

Service Reference:

Examples:

Calling the describeUserGroups operation

var params = {
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  UserGroupId: 'STRING_VALUE'
};
elasticache.describeUserGroups(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: {}) —
    • UserGroupId — (String)

      The ID of the user group.

    • MaxRecords — (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.

    • Marker — (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:

      • UserGroups — (Array<map>)

        Returns a list of user groups.

        • UserGroupId — (String)

          The ID of the user group.

        • Status — (String)

          Indicates user group status. Can be "creating", "active", "modifying", "deleting".

        • Engine — (String)

          The current supported value is Redis.

        • UserIds — (Array<String>)

          The list of user IDs that belong to the user group.

        • PendingChanges — (map)

          A list of updates being applied to the user group.

          • UserIdsToRemove — (Array<String>)

            The list of user IDs to remove.

          • UserIdsToAdd — (Array<String>)

            The list of user IDs to add.

        • ReplicationGroups — (Array<String>)

          A list of replication groups that the user group can access.

        • ARN — (String)

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

      • Marker — (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. >

Returns:

  • (AWS.Request) —

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

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

Returns a list of users.

Service Reference:

Examples:

Calling the describeUsers operation

var params = {
  Engine: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  UserId: 'STRING_VALUE'
};
elasticache.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: {}) —
    • Engine — (String)

      The Redis engine.

    • UserId — (String)

      The ID of the user.

    • Filters — (Array<map>)

      Filter to determine the list of User IDs to return.

      • Name — required — (String)

        The property being filtered. For example, UserId.

      • Values — required — (Array<String>)

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

    • MaxRecords — (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.

    • Marker — (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:

      • Users — (Array<map>)

        A list of users.

        • UserId — (String)

          The ID of the user.

        • UserName — (String)

          The username of the user.

        • Status — (String)

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

        • Engine — (String)

          The current supported value is Redis.

        • AccessString — (String)

          Access permissions string used for this user.

        • UserGroupIds — (Array<String>)

          Returns a list of the user group IDs the user belongs to.

        • Authentication — (map)

          Denotes whether the user requires a password to authenticate.

          • Type — (String)

            Indicates whether the user requires a password to authenticate.

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

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

        • ARN — (String)

          The Amazon Resource Name (ARN) of the user.

      • Marker — (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. >

Returns:

  • (AWS.Request) —

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

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

Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region.

Service Reference:

Examples:

Calling the disassociateGlobalReplicationGroup operation

var params = {
  GlobalReplicationGroupId: 'STRING_VALUE', /* required */
  ReplicationGroupId: 'STRING_VALUE', /* required */
  ReplicationGroupRegion: 'STRING_VALUE' /* required */
};
elasticache.disassociateGlobalReplicationGroup(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: {}) —
    • GlobalReplicationGroupId — (String)

      The name of the Global datastore

    • ReplicationGroupId — (String)

      The name of the secondary cluster you wish to remove from the Global datastore

    • ReplicationGroupRegion — (String)

      The Amazon region of secondary cluster you wish to remove from the Global datastore

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:

      • GlobalReplicationGroup — (map)

        Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

        • The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

        • GlobalReplicationGroupId — (String)

          The name of the Global datastore

        • GlobalReplicationGroupDescription — (String)

          The optional description of the Global datastore

        • Status — (String)

          The status of the Global datastore

        • CacheNodeType — (String)

          The cache node type of the Global datastore

        • Engine — (String)

          The Elasticache engine. For Redis only.

        • EngineVersion — (String)

          The Elasticache Redis engine version.

        • Members — (Array<map>)

          The replication groups that comprise the Global datastore.

          • ReplicationGroupId — (String)

            The replication group id of the Global datastore member.

          • ReplicationGroupRegion — (String)

            The Amazon region of the Global datastore member.

          • Role — (String)

            Indicates the role of the replication group, primary or secondary.

          • AutomaticFailover — (String)

            Indicates whether automatic failover is enabled for the replication group.

            Possible values include:
            • "enabled"
            • "disabled"
            • "enabling"
            • "disabling"
          • Status — (String)

            The status of the membership of the replication group.

        • ClusterEnabled — (Boolean)

          A flag that indicates whether the Global datastore is cluster enabled.

        • GlobalNodeGroups — (Array<map>)

          Indicates the slot configuration and global identifier for each slice group.

          • GlobalNodeGroupId — (String)

            The name of the global node group

          • Slots — (String)

            The keyspace for this node group

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

        • ARN — (String)

          The ARN (Amazon Resource Name) of the global replication group.

Returns:

  • (AWS.Request) —

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

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

Used to failover the primary region to a selected secondary region. The selected secondary region will become primary, and all other clusters will become secondary.

Service Reference:

Examples:

Calling the failoverGlobalReplicationGroup operation

var params = {
  GlobalReplicationGroupId: 'STRING_VALUE', /* required */
  PrimaryRegion: 'STRING_VALUE', /* required */
  PrimaryReplicationGroupId: 'STRING_VALUE' /* required */
};
elasticache.failoverGlobalReplicationGroup(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: {}) —
    • GlobalReplicationGroupId — (String)

      The name of the Global datastore

    • PrimaryRegion — (String)

      The Amazon region of the primary cluster of the Global datastore

    • PrimaryReplicationGroupId — (String)

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

      • GlobalReplicationGroup — (map)

        Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

        • The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

        • GlobalReplicationGroupId — (String)

          The name of the Global datastore

        • GlobalReplicationGroupDescription — (String)

          The optional description of the Global datastore

        • Status — (String)

          The status of the Global datastore

        • CacheNodeType — (String)

          The cache node type of the Global datastore

        • Engine — (String)

          The Elasticache engine. For Redis only.

        • EngineVersion — (String)

          The Elasticache Redis engine version.

        • Members — (Array<map>)

          The replication groups that comprise the Global datastore.

          • ReplicationGroupId — (String)

            The replication group id of the Global datastore member.

          • ReplicationGroupRegion — (String)

            The Amazon region of the Global datastore member.

          • Role — (String)

            Indicates the role of the replication group, primary or secondary.

          • AutomaticFailover — (String)

            Indicates whether automatic failover is enabled for the replication group.

            Possible values include:
            • "enabled"
            • "disabled"
            • "enabling"
            • "disabling"
          • Status — (String)

            The status of the membership of the replication group.

        • ClusterEnabled — (Boolean)

          A flag that indicates whether the Global datastore is cluster enabled.

        • GlobalNodeGroups — (Array<map>)

          Indicates the slot configuration and global identifier for each slice group.

          • GlobalNodeGroupId — (String)

            The name of the global node group

          • Slots — (String)

            The keyspace for this node group

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

        • ARN — (String)

          The ARN (Amazon Resource Name) of the global replication group.

Returns:

  • (AWS.Request) —

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

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

Increase the number of node groups in the Global datastore

Service Reference:

Examples:

Calling the increaseNodeGroupsInGlobalReplicationGroup operation

var params = {
  ApplyImmediately: true || false, /* required */
  GlobalReplicationGroupId: 'STRING_VALUE', /* required */
  NodeGroupCount: 'NUMBER_VALUE', /* required */
  RegionalConfigurations: [
    {
      ReplicationGroupId: 'STRING_VALUE', /* required */
      ReplicationGroupRegion: 'STRING_VALUE', /* required */
      ReshardingConfiguration: [ /* required */
        {
          NodeGroupId: 'STRING_VALUE',
          PreferredAvailabilityZones: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
elasticache.increaseNodeGroupsInGlobalReplicationGroup(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: {}) —
    • GlobalReplicationGroupId — (String)

      The name of the Global datastore

    • NodeGroupCount — (Integer)

      The number of node groups you wish to add

    • RegionalConfigurations — (Array<map>)

      Describes the replication group IDs, the Amazon regions where they are stored and the shard configuration for each that comprise the Global datastore

      • ReplicationGroupId — required — (String)

        The name of the secondary cluster

      • ReplicationGroupRegion — required — (String)

        The Amazon region where the cluster is stored

      • ReshardingConfiguration — required — (Array<map>)

        A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.

        • NodeGroupId — (String)

          Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

        • PreferredAvailabilityZones — (Array<String>)

          A list of preferred availability zones for the nodes in this cluster.

    • ApplyImmediately — (Boolean)

      Indicates that the process begins immediately. At present, the only permitted value for this parameter is true.

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:

      • GlobalReplicationGroup — (map)

        Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

        • The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

        • GlobalReplicationGroupId — (String)

          The name of the Global datastore

        • GlobalReplicationGroupDescription — (String)

          The optional description of the Global datastore

        • Status — (String)

          The status of the Global datastore

        • CacheNodeType — (String)

          The cache node type of the Global datastore

        • Engine — (String)

          The Elasticache engine. For Redis only.

        • EngineVersion — (String)

          The Elasticache Redis engine version.

        • Members — (Array<map>)

          The replication groups that comprise the Global datastore.

          • ReplicationGroupId — (String)

            The replication group id of the Global datastore member.

          • ReplicationGroupRegion — (String)

            The Amazon region of the Global datastore member.

          • Role — (String)

            Indicates the role of the replication group, primary or secondary.

          • AutomaticFailover — (String)

            Indicates whether automatic failover is enabled for the replication group.

            Possible values include:
            • "enabled"
            • "disabled"
            • "enabling"
            • "disabling"
          • Status — (String)

            The status of the membership of the replication group.

        • ClusterEnabled — (Boolean)

          A flag that indicates whether the Global datastore is cluster enabled.

        • GlobalNodeGroups — (Array<map>)

          Indicates the slot configuration and global identifier for each slice group.

          • GlobalNodeGroupId — (String)

            The name of the global node group

          • Slots — (String)

            The keyspace for this node group

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

        • ARN — (String)

          The ARN (Amazon Resource Name) of the global replication group.

Returns:

  • (AWS.Request) —

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

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

Dynamically increases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.

Service Reference:

Examples:

Calling the increaseReplicaCount operation

var params = {
  ApplyImmediately: true || false, /* required */
  ReplicationGroupId: 'STRING_VALUE', /* required */
  NewReplicaCount: 'NUMBER_VALUE',
  ReplicaConfiguration: [
    {
      NewReplicaCount: 'NUMBER_VALUE', /* required */
      NodeGroupId: 'STRING_VALUE', /* required */
      PreferredAvailabilityZones: [
        'STRING_VALUE',
        /* more items */
      ],
      PreferredOutpostArns: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ]
};
elasticache.increaseReplicaCount(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: {}) —
    • ReplicationGroupId — (String)

      The id of the replication group to which you want to add replica nodes.

    • NewReplicaCount — (Integer)

      The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

    • ReplicaConfiguration — (Array<map>)

      A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

      • NodeGroupId — required — (String)

        The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.

      • NewReplicaCount — required — (Integer)

        The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis replication group you are working with.

        The minimum number of replicas in a shard or replication group is:

        • Redis (cluster mode disabled)

          • If Multi-AZ: 1

          • If Multi-AZ: 0

        • Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

      • PreferredAvailabilityZones — (Array<String>)

        A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache for Redis selects the availability zone for each of the replicas.

      • PreferredOutpostArns — (Array<String>)

        The outpost ARNs in which the cache cluster is created.

    • ApplyImmediately — (Boolean)

      If True, the number of replica nodes is increased immediately. ApplyImmediately=False is not currently supported.

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:

      • ReplicationGroup — (map)

        Contains all of the attributes of a specific Redis replication group.

        • ReplicationGroupId — (String)

          The identifier for the replication group.

        • Description — (String)

          The user supplied description of the replication group.

        • GlobalReplicationGroupInfo — (map)

          The name of the Global datastore and role of this replication group in the Global datastore.

          • GlobalReplicationGroupId — (String)

            The name of the Global datastore

          • GlobalReplicationGroupMemberRole — (String)

            The role of the replication group in a Global datastore. Can be primary or secondary.

        • Status — (String)

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

        • PendingModifiedValues — (map)

          A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

          • PrimaryClusterId — (String)

            The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.

          • AutomaticFailoverStatus — (String)

            Indicates the status of automatic failover for this Redis replication group.

            Possible values include:
            • "enabled"
            • "disabled"
          • Resharding — (map)

            The status of an online resharding operation.

            • SlotMigration — (map)

              Represents the progress of an online resharding operation.

              • ProgressPercentage — (Float)

                The percentage of the slot migration that is complete.

          • AuthTokenStatus — (String)

            The auth token status

            Possible values include:
            • "SETTING"
            • "ROTATING"
          • UserGroups — (map)

            The user group being modified.

            • UserGroupIdsToAdd — (Array<String>)

              The ID of the user group to add.

            • UserGroupIdsToRemove — (Array<String>)

              The ID of the user group to remove.

          • LogDeliveryConfigurations — (Array<map>)

            The log delivery configurations being modified

            • LogType — (String)

              Refers to slow-log.

              Possible values include:
              • "slow-log"
            • DestinationType — (String)

              Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

              Possible values include:
              • "cloudwatch-logs"
              • "kinesis-firehose"
            • DestinationDetails — (map)

              Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

              • CloudWatchLogsDetails — (map)

                The configuration details of the CloudWatch Logs destination.

                • LogGroup — (String)

                  The name of the CloudWatch Logs log group.

              • KinesisFirehoseDetails — (map)

                The configuration details of the Kinesis Data Firehose destination.

                • DeliveryStream — (String)

                  The name of the Kinesis Data Firehose delivery stream.

            • LogFormat — (String)

              Returns the log format, either JSON or TEXT

              Possible values include:
              • "text"
              • "json"
        • MemberClusters — (Array<String>)

          The names of all the cache clusters that are part of this replication group.

        • NodeGroups — (Array<map>)

          A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

          • NodeGroupId — (String)

            The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.

          • Status — (String)

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

          • PrimaryEndpoint — (map)

            The endpoint of the primary node in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • ReaderEndpoint — (map)

            The endpoint of the replica nodes in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • Slots — (String)

            The keyspace for this node group (shard).

          • NodeGroupMembers — (Array<map>)

            A list containing information about individual nodes within the node group (shard).

            • CacheClusterId — (String)

              The ID of the cluster to which the node belongs.

            • CacheNodeId — (String)

              The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).

            • ReadEndpoint — (map)

              The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.

              • Address — (String)

                The DNS hostname of the cache node.

              • Port — (Integer)

                The port number that the cache engine is listening on.

            • PreferredAvailabilityZone — (String)

              The name of the Availability Zone in which the node is located.

            • PreferredOutpostArn — (String)

              The outpost ARN of the node group member.

            • CurrentRole — (String)

              The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.

        • SnapshottingClusterId — (String)

          The cluster ID that is used as the daily snapshot source for the replication group.

        • AutomaticFailover — (String)

          Indicates the status of automatic failover for this Redis replication group.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
        • MultiAZ — (String)

          A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

          Possible values include:
          • "enabled"
          • "disabled"
        • ConfigurationEndpoint — (map)

          The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

          • Address — (String)

            The DNS hostname of the cache node.

          • Port — (Integer)

            The port number that the cache engine is listening on.

        • SnapshotRetentionLimit — (Integer)

          The number of days for which ElastiCache 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.

          If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

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

          Example: 05:00-09:00

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

          Note: This parameter is only valid if the Engine parameter is redis.
        • ClusterEnabled — (Boolean)

          A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

          Valid values: true | false

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for each node in the replication group.

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • AuthTokenLastModifiedDate — (Date)

          The date the auth token was last modified

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true.

          You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at-rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • MemberClustersOutpostArns — (Array<String>)

          The outpost ARNs of the replication group's member clusters.

        • KmsKeyId — (String)

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

        • ARN — (String)

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

        • UserGroupIds — (Array<String>)

          The ID of the user group associated to the replication group.

        • LogDeliveryConfigurations — (Array<map>)

          Returns the destination, format and type of the logs.

          • LogType — (String)

            Refers to slow-log.

            Possible values include:
            • "slow-log"
          • DestinationType — (String)

            Returns the destination type, either cloudwatch-logs or kinesis-firehose.

            Possible values include:
            • "cloudwatch-logs"
            • "kinesis-firehose"
          • DestinationDetails — (map)

            Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

            • CloudWatchLogsDetails — (map)

              The configuration details of the CloudWatch Logs destination.

              • LogGroup — (String)

                The name of the CloudWatch Logs log group.

            • KinesisFirehoseDetails — (map)

              The configuration details of the Kinesis Data Firehose destination.

              • DeliveryStream — (String)

                The name of the Kinesis Data Firehose delivery stream.

          • LogFormat — (String)

            Returns the log format, either JSON or TEXT.

            Possible values include:
            • "text"
            • "json"
          • Status — (String)

            Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

            Possible values include:
            • "active"
            • "enabling"
            • "modifying"
            • "disabling"
            • "error"
          • Message — (String)

            Returns an error message for the log delivery configuration.

        • ReplicationGroupCreateTime — (Date)

          The date and time when the cluster was created.

Returns:

  • (AWS.Request) —

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

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

Lists all available node types that you can scale your Redis cluster's or replication group's current node type.

When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this operation.

Service Reference:

Examples:

Calling the listAllowedNodeTypeModifications operation

var params = {
  CacheClusterId: 'STRING_VALUE',
  ReplicationGroupId: 'STRING_VALUE'
};
elasticache.listAllowedNodeTypeModifications(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: {}) —
    • CacheClusterId — (String)

      The name of the cluster you want to scale up to a larger node instanced type. ElastiCache uses the cluster id to identify the current node type of this cluster and from that to create a list of node types you can scale up to.

      You must provide a value for either the CacheClusterId or the ReplicationGroupId.

    • ReplicationGroupId — (String)

      The name of the replication group want to scale up to a larger node type. ElastiCache uses the replication group id to identify the current node type being used by this replication group, and from that to create a list of node types you can scale up to.

      You must provide a value for either the CacheClusterId or the ReplicationGroupId.

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:

      • ScaleUpModifications — (Array<String>)

        A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group.

        When scaling up a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.

      • ScaleDownModifications — (Array<String>)

        A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group. When scaling down a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.

Returns:

  • (AWS.Request) —

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

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

Lists all tags currently on a named resource.

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

If the cluster is not in the available state, ListTagsForResource returns an error.

Service Reference:

Examples:

Calling the listTagsForResource operation

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

Parameters:

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

      The Amazon Resource Name (ARN) of the resource for which you want the list of tags, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

      For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

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.

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

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

Service Reference:

Examples:

Calling the modifyCacheCluster operation

var params = {
  CacheClusterId: 'STRING_VALUE', /* required */
  AZMode: single-az | cross-az,
  ApplyImmediately: true || false,
  AuthToken: 'STRING_VALUE',
  AuthTokenUpdateStrategy: SET | ROTATE | DELETE,
  AutoMinorVersionUpgrade: true || false,
  CacheNodeIdsToRemove: [
    'STRING_VALUE',
    /* more items */
  ],
  CacheNodeType: 'STRING_VALUE',
  CacheParameterGroupName: 'STRING_VALUE',
  CacheSecurityGroupNames: [
    'STRING_VALUE',
    /* more items */
  ],
  EngineVersion: 'STRING_VALUE',
  LogDeliveryConfigurations: [
    {
      DestinationDetails: {
        CloudWatchLogsDetails: {
          LogGroup: 'STRING_VALUE'
        },
        KinesisFirehoseDetails: {
          DeliveryStream: 'STRING_VALUE'
        }
      },
      DestinationType: cloudwatch-logs | kinesis-firehose,
      Enabled: true || false,
      LogFormat: text | json,
      LogType: slow-log
    },
    /* more items */
  ],
  NewAvailabilityZones: [
    'STRING_VALUE',
    /* more items */
  ],
  NotificationTopicArn: 'STRING_VALUE',
  NotificationTopicStatus: 'STRING_VALUE',
  NumCacheNodes: 'NUMBER_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  SnapshotRetentionLimit: 'NUMBER_VALUE',
  SnapshotWindow: 'STRING_VALUE'
};
elasticache.modifyCacheCluster(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: {}) —
    • CacheClusterId — (String)

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

    • NumCacheNodes — (Integer)

      The number of cache nodes that the cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled.

      If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.

      For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

      Note: Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately). A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cluster.
    • CacheNodeIdsToRemove — (Array<String>)

      A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

      For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.

    • AZMode — (String)

      Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.

      Valid values: single-az | cross-az.

      This option is only supported for Memcached clusters.

      Note: You cannot specify single-az if the Memcached cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes are located in different Availability Zones.
      Possible values include:
      • "single-az"
      • "cross-az"
    • NewAvailabilityZones — (Array<String>)
      Note: This option is only supported on Memcached clusters.

      The list of Availability Zones where the new Memcached cache nodes are created.

      This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

      Scenarios:

      • Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.

      • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.

      • Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations.

      The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

      If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

      Impact of new add/remove requests upon pending requests

      • Scenario-1

        • Pending Action: Delete

        • New Request: Delete

        • Result: The new delete, pending or immediate, replaces the pending delete.

      • Scenario-2

        • Pending Action: Delete

        • New Request: Create

        • Result: The new create, pending or immediate, replaces the pending delete.

      • Scenario-3

        • Pending Action: Create

        • New Request: Delete

        • Result: The new delete, pending or immediate, replaces the pending create.

      • Scenario-4

        • Pending Action: Create

        • New Request: Create

        • Result: The new create is added to the pending create.

          Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.
    • CacheSecurityGroupNames — (Array<String>)

      A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.

      You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).

      Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

    • SecurityGroupIds — (Array<String>)

      Specifies the VPC Security Groups associated with the cluster.

      This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).

    • PreferredMaintenanceWindow — (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

    • NotificationTopicArn — (String)

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

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

      The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

    • NotificationTopicStatus — (String)

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

      Valid values: active | inactive

    • ApplyImmediately — (Boolean)

      If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster.

      If false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

      If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.

      Valid values: true | false

      Default: false

    • EngineVersion — (String)

      The upgraded version of the cache engine to be run on the cache nodes.

      Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and 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.

    • AutoMinorVersionUpgrade — (Boolean)

      This parameter is currently disabled.

    • SnapshotRetentionLimit — (Integer)

      The number of days for which ElastiCache 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.

      Note: If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
    • SnapshotWindow — (String)

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

    • CacheNodeType — (String)

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

    • AuthToken — (String)

      Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update parameter. Password constraints:

      • Must be only printable ASCII characters

      • Must be at least 16 characters and no more than 128 characters in length

      • Cannot contain any of the following characters: '/', '"', or '@', '%'

      For more information, see AUTH password at AUTH.

    • AuthTokenUpdateStrategy — (String)

      Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:

      • Rotate

      • Set

      For more information, see Authenticating Users with Redis AUTH

      Possible values include:
      • "SET"
      • "ROTATE"
      • "DELETE"
    • LogDeliveryConfigurations — (Array<map>)

      Specifies the destination, format and type of the logs.

      • LogType — (String)

        Refers to slow-log.

        Possible values include:
        • "slow-log"
      • DestinationType — (String)

        Specify either cloudwatch-logs or kinesis-firehose as the destination type.

        Possible values include:
        • "cloudwatch-logs"
        • "kinesis-firehose"
      • DestinationDetails — (map)

        Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

        • CloudWatchLogsDetails — (map)

          The configuration details of the CloudWatch Logs destination.

          • LogGroup — (String)

            The name of the CloudWatch Logs log group.

        • KinesisFirehoseDetails — (map)

          The configuration details of the Kinesis Data Firehose destination.

          • DeliveryStream — (String)

            The name of the Kinesis Data Firehose delivery stream.

      • LogFormat — (String)

        Specifies either JSON or TEXT

        Possible values include:
        • "text"
        • "json"
      • Enabled — (Boolean)

        Specify if log delivery is enabled. Default true.

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:

      • CacheCluster — (map)

        Contains all of the attributes of a specific cluster.

        • CacheClusterId — (String)

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

        • ConfigurationEndpoint — (map)

          Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.

          Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211

          • Address — (String)

            The DNS hostname of the cache node.

          • Port — (Integer)

            The port number that the cache engine is listening on.

        • ClientDownloadLandingPage — (String)

          The URL of the web page where you can download the latest ElastiCache client library.

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for the cluster.

          The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

          • General purpose:

            • Current generation:

              M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

              Note: For region availability, see Supported Node Types

              M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

              M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

              T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

              T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

            • Previous generation: (not recommended)

              T1 node types: cache.t1.micro

              M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

              M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

          • Compute optimized:

            • Previous generation: (not recommended)

              C1 node types: cache.c1.xlarge

          • Memory optimized:

            • Current generation:

              R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

              Note: For region availability, see Supported Node Types

              R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

              R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

            • Previous generation: (not recommended)

              M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

              R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

          Additional node type info

          • All current generation instance types are created in Amazon VPC by default.

          • Redis append-only files (AOF) are not supported for T1 or T2 instances.

          • Redis Multi-AZ with automatic failover is not supported on T1 instances.

          • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

        • Engine — (String)

          The name of the cache engine (memcached or redis) to be used for this cluster.

        • EngineVersion — (String)

          The version of the cache engine that is used in this cluster.

        • CacheClusterStatus — (String)

          The current state of this cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cluster nodes, restore-failed, or snapshotting.

        • NumCacheNodes — (Integer)

          The number of cache nodes in the cluster.

          For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

        • PreferredAvailabilityZone — (String)

          The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

        • PreferredOutpostArn — (String)

          The outpost ARN in which the cache cluster is created.

        • CacheClusterCreateTime — (Date)

          The date and time when the cluster was created.

        • PreferredMaintenanceWindow — (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

        • PendingModifiedValues — (map)

          A group of settings that are applied to the cluster in the future, or that are currently being applied.

          • NumCacheNodes — (Integer)

            The new number of cache nodes for the cluster.

            For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

          • CacheNodeIdsToRemove — (Array<String>)

            A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).

          • EngineVersion — (String)

            The new cache engine version that the cluster runs.

          • CacheNodeType — (String)

            The cache node type that this cluster or replication group is scaled to.

          • AuthTokenStatus — (String)

            The auth token status

            Possible values include:
            • "SETTING"
            • "ROTATING"
          • LogDeliveryConfigurations — (Array<map>)

            The log delivery configurations being modified

            • LogType — (String)

              Refers to slow-log.

              Possible values include:
              • "slow-log"
            • DestinationType — (String)

              Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

              Possible values include:
              • "cloudwatch-logs"
              • "kinesis-firehose"
            • DestinationDetails — (map)

              Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

              • CloudWatchLogsDetails — (map)

                The configuration details of the CloudWatch Logs destination.

                • LogGroup — (String)

                  The name of the CloudWatch Logs log group.

              • KinesisFirehoseDetails — (map)

                The configuration details of the Kinesis Data Firehose destination.

                • DeliveryStream — (String)

                  The name of the Kinesis Data Firehose delivery stream.

            • LogFormat — (String)

              Returns the log format, either JSON or TEXT

              Possible values include:
              • "text"
              • "json"
        • NotificationConfiguration — (map)

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

          • TopicArn — (String)

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

          • TopicStatus — (String)

            The current state of the topic.

        • CacheSecurityGroups — (Array<map>)

          A list of cache security group elements, composed of name and status sub-elements.

          • CacheSecurityGroupName — (String)

            The name of the cache security group.

          • Status — (String)

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

        • CacheParameterGroup — (map)

          Status of the cache parameter group.

          • CacheParameterGroupName — (String)

            The name of the cache parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • CacheNodeIdsToReboot — (Array<String>)

            A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).

        • CacheSubnetGroupName — (String)

          The name of the cache subnet group associated with the cluster.

        • CacheNodes — (Array<map>)

          A list of cache nodes that are members of the cluster.

          • CacheNodeId — (String)

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

          • CacheNodeStatus — (String)

            The current state of this cache node, one of the following values: available, creating, rebooting, or deleting.

          • CacheNodeCreateTime — (Date)

            The date and time when the cache node was created.

          • Endpoint — (map)

            The hostname for connecting to this cache node.

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • ParameterGroupStatus — (String)

            The status of the parameter group applied to this cache node.

          • SourceCacheNodeId — (String)

            The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cluster.

          • CustomerAvailabilityZone — (String)

            The Availability Zone where this node was created and now resides.

          • CustomerOutpostArn — (String)

            The customer outpost ARN of the cache node.

        • AutoMinorVersionUpgrade — (Boolean)

          This parameter is currently disabled.

        • SecurityGroups — (Array<map>)

          A list of VPC Security Groups associated with the cluster.

          • SecurityGroupId — (String)

            The identifier of the cache security group.

          • Status — (String)

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

        • ReplicationGroupId — (String)

          The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.

        • SnapshotRetentionLimit — (Integer)

          The number of days for which ElastiCache 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.

          If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

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

          Example: 05:00-09:00

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • AuthTokenLastModifiedDate — (Date)

          The date the auth token was last modified

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true.

          You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at-rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • ARN — (String)

          The ARN (Amazon Resource Name) of the cache cluster.

        • ReplicationGroupLogDeliveryEnabled — (Boolean)

          A boolean value indicating whether log delivery is enabled for the replication group.

        • LogDeliveryConfigurations — (Array<map>)

          Returns the destination, format and type of the logs.

          • LogType — (String)

            Refers to slow-log.

            Possible values include:
            • "slow-log"
          • DestinationType — (String)

            Returns the destination type, either cloudwatch-logs or kinesis-firehose.

            Possible values include:
            • "cloudwatch-logs"
            • "kinesis-firehose"
          • DestinationDetails — (map)

            Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

            • CloudWatchLogsDetails — (map)

              The configuration details of the CloudWatch Logs destination.

              • LogGroup — (String)

                The name of the CloudWatch Logs log group.

            • KinesisFirehoseDetails — (map)

              The configuration details of the Kinesis Data Firehose destination.

              • DeliveryStream — (String)

                The name of the Kinesis Data Firehose delivery stream.

          • LogFormat — (String)

            Returns the log format, either JSON or TEXT.

            Possible values include:
            • "text"
            • "json"
          • Status — (String)

            Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

            Possible values include:
            • "active"
            • "enabling"
            • "modifying"
            • "disabling"
            • "error"
          • Message — (String)

            Returns an error message for the log delivery configuration.

Returns:

  • (AWS.Request) —

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

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

Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.

Service Reference:

Examples:

Calling the modifyCacheParameterGroup operation

var params = {
  CacheParameterGroupName: 'STRING_VALUE', /* required */
  ParameterNameValues: [ /* required */
    {
      ParameterName: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE'
    },
    /* more items */
  ]
};
elasticache.modifyCacheParameterGroup(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: {}) —
    • CacheParameterGroupName — (String)

      The name of the cache parameter group to modify.

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

      • CacheParameterGroupName — (String)

        The name of the cache parameter group.

Returns:

  • (AWS.Request) —

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

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

Modifies an existing cache subnet group.

Service Reference:

Examples:

Calling the modifyCacheSubnetGroup operation

var params = {
  CacheSubnetGroupName: 'STRING_VALUE', /* required */
  CacheSubnetGroupDescription: 'STRING_VALUE',
  SubnetIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
elasticache.modifyCacheSubnetGroup(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: {}) —
    • CacheSubnetGroupName — (String)

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

      Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

      Example: mysubnetgroup

    • CacheSubnetGroupDescription — (String)

      A description of the cache subnet group.

    • SubnetIds — (Array<String>)

      The EC2 subnet IDs for the cache 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:

      • CacheSubnetGroup — (map)

        Represents the output of one of the following operations:

        • CreateCacheSubnetGroup

        • ModifyCacheSubnetGroup

        • CacheSubnetGroupName — (String)

          The name of the cache subnet group.

        • CacheSubnetGroupDescription — (String)

          The description of the cache subnet group.

        • VpcId — (String)

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

        • Subnets — (Array<map>)

          A list of subnets associated with the cache subnet group.

          • SubnetIdentifier — (String)

            The unique identifier for the subnet.

          • SubnetAvailabilityZone — (map)

            The Availability Zone associated with the subnet.

            • Name — (String)

              The name of the Availability Zone.

          • SubnetOutpost — (map)

            The outpost ARN of the subnet.

            • SubnetOutpostArn — (String)

              The outpost ARN of the subnet.

        • ARN — (String)

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

Returns:

  • (AWS.Request) —

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

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

Modifies the settings for a Global datastore.

Service Reference:

Examples:

Calling the modifyGlobalReplicationGroup operation

var params = {
  ApplyImmediately: true || false, /* required */
  GlobalReplicationGroupId: 'STRING_VALUE', /* required */
  AutomaticFailoverEnabled: true || false,
  CacheNodeType: 'STRING_VALUE',
  CacheParameterGroupName: 'STRING_VALUE',
  EngineVersion: 'STRING_VALUE',
  GlobalReplicationGroupDescription: 'STRING_VALUE'
};
elasticache.modifyGlobalReplicationGroup(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: {}) —
    • GlobalReplicationGroupId — (String)

      The name of the Global datastore

    • ApplyImmediately — (Boolean)

      This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.

    • CacheNodeType — (String)

      A valid cache node type that you want to scale this Global datastore to.

    • EngineVersion — (String)

      The upgraded version of the cache engine to be run on the clusters in the Global datastore.

    • CacheParameterGroupName — (String)

      The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.

    • GlobalReplicationGroupDescription — (String)

      A description of the Global datastore

    • AutomaticFailoverEnabled — (Boolean)

      Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

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:

      • GlobalReplicationGroup — (map)

        Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

        • The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

        • GlobalReplicationGroupId — (String)

          The name of the Global datastore

        • GlobalReplicationGroupDescription — (String)

          The optional description of the Global datastore

        • Status — (String)

          The status of the Global datastore

        • CacheNodeType — (String)

          The cache node type of the Global datastore

        • Engine — (String)

          The Elasticache engine. For Redis only.

        • EngineVersion — (String)

          The Elasticache Redis engine version.

        • Members — (Array<map>)

          The replication groups that comprise the Global datastore.

          • ReplicationGroupId — (String)

            The replication group id of the Global datastore member.

          • ReplicationGroupRegion — (String)

            The Amazon region of the Global datastore member.

          • Role — (String)

            Indicates the role of the replication group, primary or secondary.

          • AutomaticFailover — (String)

            Indicates whether automatic failover is enabled for the replication group.

            Possible values include:
            • "enabled"
            • "disabled"
            • "enabling"
            • "disabling"
          • Status — (String)

            The status of the membership of the replication group.

        • ClusterEnabled — (Boolean)

          A flag that indicates whether the Global datastore is cluster enabled.

        • GlobalNodeGroups — (Array<map>)

          Indicates the slot configuration and global identifier for each slice group.

          • GlobalNodeGroupId — (String)

            The name of the global node group

          • Slots — (String)

            The keyspace for this node group

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

        • ARN — (String)

          The ARN (Amazon Resource Name) of the global replication group.

Returns:

  • (AWS.Request) —

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

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

Modifies the settings for a replication group.

Note: This operation is valid for Redis only.

Service Reference:

Examples:

Calling the modifyReplicationGroup operation

var params = {
  ReplicationGroupId: 'STRING_VALUE', /* required */
  ApplyImmediately: true || false,
  AuthToken: 'STRING_VALUE',
  AuthTokenUpdateStrategy: SET | ROTATE | DELETE,
  AutoMinorVersionUpgrade: true || false,
  AutomaticFailoverEnabled: true || false,
  CacheNodeType: 'STRING_VALUE',
  CacheParameterGroupName: 'STRING_VALUE',
  CacheSecurityGroupNames: [
    'STRING_VALUE',
    /* more items */
  ],
  EngineVersion: 'STRING_VALUE',
  LogDeliveryConfigurations: [
    {
      DestinationDetails: {
        CloudWatchLogsDetails: {
          LogGroup: 'STRING_VALUE'
        },
        KinesisFirehoseDetails: {
          DeliveryStream: 'STRING_VALUE'
        }
      },
      DestinationType: cloudwatch-logs | kinesis-firehose,
      Enabled: true || false,
      LogFormat: text | json,
      LogType: slow-log
    },
    /* more items */
  ],
  MultiAZEnabled: true || false,
  NodeGroupId: 'STRING_VALUE',
  NotificationTopicArn: 'STRING_VALUE',
  NotificationTopicStatus: 'STRING_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  PrimaryClusterId: 'STRING_VALUE',
  RemoveUserGroups: true || false,
  ReplicationGroupDescription: 'STRING_VALUE',
  SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  SnapshotRetentionLimit: 'NUMBER_VALUE',
  SnapshotWindow: 'STRING_VALUE',
  SnapshottingClusterId: 'STRING_VALUE',
  UserGroupIdsToAdd: [
    'STRING_VALUE',
    /* more items */
  ],
  UserGroupIdsToRemove: [
    'STRING_VALUE',
    /* more items */
  ]
};
elasticache.modifyReplicationGroup(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: {}) —
    • ReplicationGroupId — (String)

      The identifier of the replication group to modify.

    • ReplicationGroupDescription — (String)

      A description for the replication group. Maximum length is 255 characters.

    • PrimaryClusterId — (String)

      For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

    • SnapshottingClusterId — (String)

      The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.

    • AutomaticFailoverEnabled — (Boolean)

      Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

      Valid values: true | false

    • MultiAZEnabled — (Boolean)

      A flag to indicate MultiAZ is enabled.

    • NodeGroupId — (String)

      Deprecated. This parameter is not used.

    • CacheSecurityGroupNames — (Array<String>)

      A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

      This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).

      Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.

    • SecurityGroupIds — (Array<String>)

      Specifies the VPC Security Groups associated with the clusters in the replication group.

      This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

    • PreferredMaintenanceWindow — (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

    • NotificationTopicArn — (String)

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

      Note: The Amazon SNS topic owner must be same as the replication group owner.
    • CacheParameterGroupName — (String)

      The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

    • NotificationTopicStatus — (String)

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

      Valid values: active | inactive

    • ApplyImmediately — (Boolean)

      If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group.

      If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

      Valid values: true | false

      Default: false

    • EngineVersion — (String)

      The upgraded version of the cache engine to be run on the clusters in the replication group.

      Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing replication group and create it anew with the earlier engine version.

    • AutoMinorVersionUpgrade — (Boolean)

      This parameter is currently disabled.

    • SnapshotRetentionLimit — (Integer)

      The number of days for which ElastiCache retains automatic node group (shard) 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.

      Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

    • SnapshotWindow — (String)

      The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId.

      Example: 05:00-09:00

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

    • CacheNodeType — (String)

      A valid cache node type that you want to scale this replication group to.

    • AuthToken — (String)

      Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update-strategy parameter. Password constraints:

      • Must be only printable ASCII characters

      • Must be at least 16 characters and no more than 128 characters in length

      • Cannot contain any of the following characters: '/', '"', or '@', '%'

      For more information, see AUTH password at AUTH.

    • AuthTokenUpdateStrategy — (String)

      Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:

      • Rotate

      • Set

      For more information, see Authenticating Users with Redis AUTH

      Possible values include:
      • "SET"
      • "ROTATE"
      • "DELETE"
    • UserGroupIdsToAdd — (Array<String>)

      The ID of the user group you are associating with the replication group.

    • UserGroupIdsToRemove — (Array<String>)

      The ID of the user group to disassociate from the replication group, meaning the users in the group no longer can access the replication group.

    • RemoveUserGroups — (Boolean)

      Removes the user group associated with this replication group.

    • LogDeliveryConfigurations — (Array<map>)

      Specifies the destination, format and type of the logs.

      • LogType — (String)

        Refers to slow-log.

        Possible values include:
        • "slow-log"
      • DestinationType — (String)

        Specify either cloudwatch-logs or kinesis-firehose as the destination type.

        Possible values include:
        • "cloudwatch-logs"
        • "kinesis-firehose"
      • DestinationDetails — (map)

        Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

        • CloudWatchLogsDetails — (map)

          The configuration details of the CloudWatch Logs destination.

          • LogGroup — (String)

            The name of the CloudWatch Logs log group.

        • KinesisFirehoseDetails — (map)

          The configuration details of the Kinesis Data Firehose destination.

          • DeliveryStream — (String)

            The name of the Kinesis Data Firehose delivery stream.

      • LogFormat — (String)

        Specifies either JSON or TEXT

        Possible values include:
        • "text"
        • "json"
      • Enabled — (Boolean)

        Specify if log delivery is enabled. Default true.

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:

      • ReplicationGroup — (map)

        Contains all of the attributes of a specific Redis replication group.

        • ReplicationGroupId — (String)

          The identifier for the replication group.

        • Description — (String)

          The user supplied description of the replication group.

        • GlobalReplicationGroupInfo — (map)

          The name of the Global datastore and role of this replication group in the Global datastore.

          • GlobalReplicationGroupId — (String)

            The name of the Global datastore

          • GlobalReplicationGroupMemberRole — (String)

            The role of the replication group in a Global datastore. Can be primary or secondary.

        • Status — (String)

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

        • PendingModifiedValues — (map)

          A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

          • PrimaryClusterId — (String)

            The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.

          • AutomaticFailoverStatus — (String)

            Indicates the status of automatic failover for this Redis replication group.

            Possible values include:
            • "enabled"
            • "disabled"
          • Resharding — (map)

            The status of an online resharding operation.

            • SlotMigration — (map)

              Represents the progress of an online resharding operation.

              • ProgressPercentage — (Float)

                The percentage of the slot migration that is complete.

          • AuthTokenStatus — (String)

            The auth token status

            Possible values include:
            • "SETTING"
            • "ROTATING"
          • UserGroups — (map)

            The user group being modified.

            • UserGroupIdsToAdd — (Array<String>)

              The ID of the user group to add.

            • UserGroupIdsToRemove — (Array<String>)

              The ID of the user group to remove.

          • LogDeliveryConfigurations — (Array<map>)

            The log delivery configurations being modified

            • LogType — (String)

              Refers to slow-log.

              Possible values include:
              • "slow-log"
            • DestinationType — (String)

              Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

              Possible values include:
              • "cloudwatch-logs"
              • "kinesis-firehose"
            • DestinationDetails — (map)

              Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

              • CloudWatchLogsDetails — (map)

                The configuration details of the CloudWatch Logs destination.

                • LogGroup — (String)

                  The name of the CloudWatch Logs log group.

              • KinesisFirehoseDetails — (map)

                The configuration details of the Kinesis Data Firehose destination.

                • DeliveryStream — (String)

                  The name of the Kinesis Data Firehose delivery stream.

            • LogFormat — (String)

              Returns the log format, either JSON or TEXT

              Possible values include:
              • "text"
              • "json"
        • MemberClusters — (Array<String>)

          The names of all the cache clusters that are part of this replication group.

        • NodeGroups — (Array<map>)

          A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

          • NodeGroupId — (String)

            The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.

          • Status — (String)

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

          • PrimaryEndpoint — (map)

            The endpoint of the primary node in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • ReaderEndpoint — (map)

            The endpoint of the replica nodes in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • Slots — (String)

            The keyspace for this node group (shard).

          • NodeGroupMembers — (Array<map>)

            A list containing information about individual nodes within the node group (shard).

            • CacheClusterId — (String)

              The ID of the cluster to which the node belongs.

            • CacheNodeId — (String)

              The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).

            • ReadEndpoint — (map)

              The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.

              • Address — (String)

                The DNS hostname of the cache node.

              • Port — (Integer)

                The port number that the cache engine is listening on.

            • PreferredAvailabilityZone — (String)

              The name of the Availability Zone in which the node is located.

            • PreferredOutpostArn — (String)

              The outpost ARN of the node group member.

            • CurrentRole — (String)

              The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.

        • SnapshottingClusterId — (String)

          The cluster ID that is used as the daily snapshot source for the replication group.

        • AutomaticFailover — (String)

          Indicates the status of automatic failover for this Redis replication group.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
        • MultiAZ — (String)

          A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

          Possible values include:
          • "enabled"
          • "disabled"
        • ConfigurationEndpoint — (map)

          The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

          • Address — (String)

            The DNS hostname of the cache node.

          • Port — (Integer)

            The port number that the cache engine is listening on.

        • SnapshotRetentionLimit — (Integer)

          The number of days for which ElastiCache 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.

          If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

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

          Example: 05:00-09:00

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

          Note: This parameter is only valid if the Engine parameter is redis.
        • ClusterEnabled — (Boolean)

          A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

          Valid values: true | false

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for each node in the replication group.

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • AuthTokenLastModifiedDate — (Date)

          The date the auth token was last modified

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true.

          You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at-rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • MemberClustersOutpostArns — (Array<String>)

          The outpost ARNs of the replication group's member clusters.

        • KmsKeyId — (String)

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

        • ARN — (String)

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

        • UserGroupIds — (Array<String>)

          The ID of the user group associated to the replication group.

        • LogDeliveryConfigurations — (Array<map>)

          Returns the destination, format and type of the logs.

          • LogType — (String)

            Refers to slow-log.

            Possible values include:
            • "slow-log"
          • DestinationType — (String)

            Returns the destination type, either cloudwatch-logs or kinesis-firehose.

            Possible values include:
            • "cloudwatch-logs"
            • "kinesis-firehose"
          • DestinationDetails — (map)

            Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

            • CloudWatchLogsDetails — (map)

              The configuration details of the CloudWatch Logs destination.

              • LogGroup — (String)

                The name of the CloudWatch Logs log group.

            • KinesisFirehoseDetails — (map)

              The configuration details of the Kinesis Data Firehose destination.

              • DeliveryStream — (String)

                The name of the Kinesis Data Firehose delivery stream.

          • LogFormat — (String)

            Returns the log format, either JSON or TEXT.

            Possible values include:
            • "text"
            • "json"
          • Status — (String)

            Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

            Possible values include:
            • "active"
            • "enabling"
            • "modifying"
            • "disabling"
            • "error"
          • Message — (String)

            Returns an error message for the log delivery configuration.

        • ReplicationGroupCreateTime — (Date)

          The date and time when the cluster was created.

Returns:

  • (AWS.Request) —

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

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

Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.

Service Reference:

Examples:

Calling the modifyReplicationGroupShardConfiguration operation

var params = {
  ApplyImmediately: true || false, /* required */
  NodeGroupCount: 'NUMBER_VALUE', /* required */
  ReplicationGroupId: 'STRING_VALUE', /* required */
  NodeGroupsToRemove: [
    'STRING_VALUE',
    /* more items */
  ],
  NodeGroupsToRetain: [
    'STRING_VALUE',
    /* more items */
  ],
  ReshardingConfiguration: [
    {
      NodeGroupId: 'STRING_VALUE',
      PreferredAvailabilityZones: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ]
};
elasticache.modifyReplicationGroupShardConfiguration(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: {}) —
    • ReplicationGroupId — (String)

      The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.

    • NodeGroupCount — (Integer)

      The number of node groups (shards) that results from the modification of the shard configuration.

    • ApplyImmediately — (Boolean)

      Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.

      Value: true

    • ReshardingConfiguration — (Array<map>)

      Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter ElastiCache selects availability zones for you.

      You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards).

      • NodeGroupId — (String)

        Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

      • PreferredAvailabilityZones — (Array<String>)

        A list of preferred availability zones for the nodes in this cluster.

    • NodeGroupsToRemove — (Array<String>)

      If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.

      ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

    • NodeGroupsToRetain — (Array<String>)

      If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.

      ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • ReplicationGroup — (map)

        Contains all of the attributes of a specific Redis replication group.

        • ReplicationGroupId — (String)

          The identifier for the replication group.

        • Description — (String)

          The user supplied description of the replication group.

        • GlobalReplicationGroupInfo — (map)

          The name of the Global datastore and role of this replication group in the Global datastore.

          • GlobalReplicationGroupId — (String)

            The name of the Global datastore

          • GlobalReplicationGroupMemberRole — (String)

            The role of the replication group in a Global datastore. Can be primary or secondary.

        • Status — (String)

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

        • PendingModifiedValues — (map)

          A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

          • PrimaryClusterId — (String)

            The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.

          • AutomaticFailoverStatus — (String)

            Indicates the status of automatic failover for this Redis replication group.

            Possible values include:
            • "enabled"
            • "disabled"
          • Resharding — (map)

            The status of an online resharding operation.

            • SlotMigration — (map)

              Represents the progress of an online resharding operation.

              • ProgressPercentage — (Float)

                The percentage of the slot migration that is complete.

          • AuthTokenStatus — (String)

            The auth token status

            Possible values include:
            • "SETTING"
            • "ROTATING"
          • UserGroups — (map)

            The user group being modified.

            • UserGroupIdsToAdd — (Array<String>)

              The ID of the user group to add.

            • UserGroupIdsToRemove — (Array<String>)

              The ID of the user group to remove.

          • LogDeliveryConfigurations — (Array<map>)

            The log delivery configurations being modified

            • LogType — (String)

              Refers to slow-log.

              Possible values include:
              • "slow-log"
            • DestinationType — (String)

              Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

              Possible values include:
              • "cloudwatch-logs"
              • "kinesis-firehose"
            • DestinationDetails — (map)

              Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

              • CloudWatchLogsDetails — (map)

                The configuration details of the CloudWatch Logs destination.

                • LogGroup — (String)

                  The name of the CloudWatch Logs log group.

              • KinesisFirehoseDetails — (map)

                The configuration details of the Kinesis Data Firehose destination.

                • DeliveryStream — (String)

                  The name of the Kinesis Data Firehose delivery stream.

            • LogFormat — (String)

              Returns the log format, either JSON or TEXT

              Possible values include:
              • "text"
              • "json"
        • MemberClusters — (Array<String>)

          The names of all the cache clusters that are part of this replication group.

        • NodeGroups — (Array<map>)

          A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

          • NodeGroupId — (String)

            The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.

          • Status — (String)

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

          • PrimaryEndpoint — (map)

            The endpoint of the primary node in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • ReaderEndpoint — (map)

            The endpoint of the replica nodes in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • Slots — (String)

            The keyspace for this node group (shard).

          • NodeGroupMembers — (Array<map>)

            A list containing information about individual nodes within the node group (shard).

            • CacheClusterId — (String)

              The ID of the cluster to which the node belongs.

            • CacheNodeId — (String)

              The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).

            • ReadEndpoint — (map)

              The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.

              • Address — (String)

                The DNS hostname of the cache node.

              • Port — (Integer)

                The port number that the cache engine is listening on.

            • PreferredAvailabilityZone — (String)

              The name of the Availability Zone in which the node is located.

            • PreferredOutpostArn — (String)

              The outpost ARN of the node group member.

            • CurrentRole — (String)

              The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.

        • SnapshottingClusterId — (String)

          The cluster ID that is used as the daily snapshot source for the replication group.

        • AutomaticFailover — (String)

          Indicates the status of automatic failover for this Redis replication group.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
        • MultiAZ — (String)

          A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

          Possible values include:
          • "enabled"
          • "disabled"
        • ConfigurationEndpoint — (map)

          The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

          • Address — (String)

            The DNS hostname of the cache node.

          • Port — (Integer)

            The port number that the cache engine is listening on.

        • SnapshotRetentionLimit — (Integer)

          The number of days for which ElastiCache 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.

          If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

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

          Example: 05:00-09:00

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

          Note: This parameter is only valid if the Engine parameter is redis.
        • ClusterEnabled — (Boolean)

          A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

          Valid values: true | false

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for each node in the replication group.

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • AuthTokenLastModifiedDate — (Date)

          The date the auth token was last modified

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true.

          You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at-rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • MemberClustersOutpostArns — (Array<String>)

          The outpost ARNs of the replication group's member clusters.

        • KmsKeyId — (String)

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

        • ARN — (String)

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

        • UserGroupIds — (Array<String>)

          The ID of the user group associated to the replication group.

        • LogDeliveryConfigurations — (Array<map>)

          Returns the destination, format and type of the logs.

          • LogType — (String)

            Refers to slow-log.

            Possible values include:
            • "slow-log"
          • DestinationType — (String)

            Returns the destination type, either cloudwatch-logs or kinesis-firehose.

            Possible values include:
            • "cloudwatch-logs"
            • "kinesis-firehose"
          • DestinationDetails — (map)

            Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

            • CloudWatchLogsDetails — (map)

              The configuration details of the CloudWatch Logs destination.

              • LogGroup — (String)

                The name of the CloudWatch Logs log group.

            • KinesisFirehoseDetails — (map)

              The configuration details of the Kinesis Data Firehose destination.

              • DeliveryStream — (String)

                The name of the Kinesis Data Firehose delivery stream.

          • LogFormat — (String)

            Returns the log format, either JSON or TEXT.

            Possible values include:
            • "text"
            • "json"
          • Status — (String)

            Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

            Possible values include:
            • "active"
            • "enabling"
            • "modifying"
            • "disabling"
            • "error"
          • Message — (String)

            Returns an error message for the log delivery configuration.

        • ReplicationGroupCreateTime — (Date)

          The date and time when the cluster was created.

Returns:

  • (AWS.Request) —

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

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

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

Service Reference:

Examples:

Calling the modifyUser operation

var params = {
  UserId: 'STRING_VALUE', /* required */
  AccessString: 'STRING_VALUE',
  AppendAccessString: 'STRING_VALUE',
  NoPasswordRequired: true || false,
  Passwords: [
    'STRING_VALUE',
    /* more items */
  ]
};
elasticache.modifyUser(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: {}) —
    • UserId — (String)

      The ID of the user.

    • AccessString — (String)

      Access permissions string used for this user.

    • AppendAccessString — (String)

      Adds additional user permissions to the access string.

    • Passwords — (Array<String>)

      The passwords belonging to the user. You are allowed up to two.

    • NoPasswordRequired — (Boolean)

      Indicates no password is required for the 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:

      • UserId — (String)

        The ID of the user.

      • UserName — (String)

        The username of the user.

      • Status — (String)

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

      • Engine — (String)

        The current supported value is Redis.

      • AccessString — (String)

        Access permissions string used for this user.

      • UserGroupIds — (Array<String>)

        Returns a list of the user group IDs the user belongs to.

      • Authentication — (map)

        Denotes whether the user requires a password to authenticate.

        • Type — (String)

          Indicates whether the user requires a password to authenticate.

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

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

      • ARN — (String)

        The Amazon Resource Name (ARN) of the user.

Returns:

  • (AWS.Request) —

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

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

Changes the list of users that belong to the user group.

Service Reference:

Examples:

Calling the modifyUserGroup operation

var params = {
  UserGroupId: 'STRING_VALUE', /* required */
  UserIdsToAdd: [
    'STRING_VALUE',
    /* more items */
  ],
  UserIdsToRemove: [
    'STRING_VALUE',
    /* more items */
  ]
};
elasticache.modifyUserGroup(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: {}) —
    • UserGroupId — (String)

      The ID of the user group.

    • UserIdsToAdd — (Array<String>)

      The list of user IDs to add to the user group.

    • UserIdsToRemove — (Array<String>)

      The list of user IDs to remove from the user 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:

      • UserGroupId — (String)

        The ID of the user group.

      • Status — (String)

        Indicates user group status. Can be "creating", "active", "modifying", "deleting".

      • Engine — (String)

        The current supported value is Redis.

      • UserIds — (Array<String>)

        The list of user IDs that belong to the user group.

      • PendingChanges — (map)

        A list of updates being applied to the user group.

        • UserIdsToRemove — (Array<String>)

          The list of user IDs to remove.

        • UserIdsToAdd — (Array<String>)

          The list of user IDs to add.

      • ReplicationGroups — (Array<String>)

        A list of replication groups that the user group can access.

      • ARN — (String)

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

Returns:

  • (AWS.Request) —

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

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

Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes for Redis or Managing Costs with Reserved Nodes for Memcached.

Service Reference:

Examples:

Calling the purchaseReservedCacheNodesOffering operation

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

      The ID of the reserved cache node offering to purchase.

      Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

    • ReservedCacheNodeId — (String)

      A customer-specified identifier to track this reservation.

      Note: The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. If this parameter is not specified, ElastiCache automatically generates an identifier for the reservation.

      Example: myreservationID

    • CacheNodeCount — (Integer)

      The number of cache node instances to reserve.

      Default: 1

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

      • ReservedCacheNode — (map)

        Represents the output of a PurchaseReservedCacheNodesOffering operation.

        • ReservedCacheNodeId — (String)

          The unique identifier for the reservation.

        • ReservedCacheNodesOfferingId — (String)

          The offering identifier.

        • CacheNodeType — (String)

          The cache node type for the reserved cache nodes.

          The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

          • General purpose:

            • Current generation:

              M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

              Note: For region availability, see Supported Node Types

              M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

              M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

              T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

              T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

            • Previous generation: (not recommended)

              T1 node types: cache.t1.micro

              M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

              M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

          • Compute optimized:

            • Previous generation: (not recommended)

              C1 node types: cache.c1.xlarge

          • Memory optimized:

            • Current generation:

              R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

              Note: For region availability, see Supported Node Types

              R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

              R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

            • Previous generation: (not recommended)

              M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

              R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

          Additional node type info

          • All current generation instance types are created in Amazon VPC by default.

          • Redis append-only files (AOF) are not supported for T1 or T2 instances.

          • Redis Multi-AZ with automatic failover is not supported on T1 instances.

          • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

        • 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 cache node.

        • UsagePrice — (Float)

          The hourly price charged for this reserved cache node.

        • CacheNodeCount — (Integer)

          The number of cache nodes that have been reserved.

        • ProductDescription — (String)

          The description of the reserved cache node.

        • OfferingType — (String)

          The offering type of this reserved cache node.

        • State — (String)

          The state of the reserved cache node.

        • RecurringCharges — (Array<map>)

          The recurring price charged to run this reserved cache node.

          • RecurringChargeAmount — (Float)

            The monetary amount of the recurring charge.

          • RecurringChargeFrequency — (String)

            The frequency of the recurring charge.

        • ReservationARN — (String)

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

          Example: arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582

Returns:

  • (AWS.Request) —

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

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

Redistribute slots to ensure uniform distribution across existing shards in the cluster.

Service Reference:

Examples:

Calling the rebalanceSlotsInGlobalReplicationGroup operation

var params = {
  ApplyImmediately: true || false, /* required */
  GlobalReplicationGroupId: 'STRING_VALUE' /* required */
};
elasticache.rebalanceSlotsInGlobalReplicationGroup(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: {}) —
    • GlobalReplicationGroupId — (String)

      The name of the Global datastore

    • ApplyImmediately — (Boolean)

      If True, redistribution is applied immediately.

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:

      • GlobalReplicationGroup — (map)

        Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

        • The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

        • GlobalReplicationGroupId — (String)

          The name of the Global datastore

        • GlobalReplicationGroupDescription — (String)

          The optional description of the Global datastore

        • Status — (String)

          The status of the Global datastore

        • CacheNodeType — (String)

          The cache node type of the Global datastore

        • Engine — (String)

          The Elasticache engine. For Redis only.

        • EngineVersion — (String)

          The Elasticache Redis engine version.

        • Members — (Array<map>)

          The replication groups that comprise the Global datastore.

          • ReplicationGroupId — (String)

            The replication group id of the Global datastore member.

          • ReplicationGroupRegion — (String)

            The Amazon region of the Global datastore member.

          • Role — (String)

            Indicates the role of the replication group, primary or secondary.

          • AutomaticFailover — (String)

            Indicates whether automatic failover is enabled for the replication group.

            Possible values include:
            • "enabled"
            • "disabled"
            • "enabling"
            • "disabling"
          • Status — (String)

            The status of the membership of the replication group.

        • ClusterEnabled — (Boolean)

          A flag that indicates whether the Global datastore is cluster enabled.

        • GlobalNodeGroups — (Array<map>)

          Indicates the slot configuration and global identifier for each slice group.

          • GlobalNodeGroupId — (String)

            The name of the global node group

          • Slots — (String)

            The keyspace for this node group

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

        • ARN — (String)

          The ARN (Amazon Resource Name) of the global replication group.

Returns:

  • (AWS.Request) —

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

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

Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING.

The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.

When the reboot is complete, a cluster event is created.

Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters.

If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.

Service Reference:

Examples:

Calling the rebootCacheCluster operation

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

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

    • CacheNodeIdsToReboot — (Array<String>)

      A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.

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:

      • CacheCluster — (map)

        Contains all of the attributes of a specific cluster.

        • CacheClusterId — (String)

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

        • ConfigurationEndpoint — (map)

          Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.

          Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211

          • Address — (String)

            The DNS hostname of the cache node.

          • Port — (Integer)

            The port number that the cache engine is listening on.

        • ClientDownloadLandingPage — (String)

          The URL of the web page where you can download the latest ElastiCache client library.

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for the cluster.

          The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

          • General purpose:

            • Current generation:

              M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

              Note: For region availability, see Supported Node Types

              M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

              M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

              T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

              T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

            • Previous generation: (not recommended)

              T1 node types: cache.t1.micro

              M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

              M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

          • Compute optimized:

            • Previous generation: (not recommended)

              C1 node types: cache.c1.xlarge

          • Memory optimized:

            • Current generation:

              R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

              Note: For region availability, see Supported Node Types

              R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

              R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

            • Previous generation: (not recommended)

              M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

              R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

          Additional node type info

          • All current generation instance types are created in Amazon VPC by default.

          • Redis append-only files (AOF) are not supported for T1 or T2 instances.

          • Redis Multi-AZ with automatic failover is not supported on T1 instances.

          • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

        • Engine — (String)

          The name of the cache engine (memcached or redis) to be used for this cluster.

        • EngineVersion — (String)

          The version of the cache engine that is used in this cluster.

        • CacheClusterStatus — (String)

          The current state of this cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cluster nodes, restore-failed, or snapshotting.

        • NumCacheNodes — (Integer)

          The number of cache nodes in the cluster.

          For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

        • PreferredAvailabilityZone — (String)

          The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

        • PreferredOutpostArn — (String)

          The outpost ARN in which the cache cluster is created.

        • CacheClusterCreateTime — (Date)

          The date and time when the cluster was created.

        • PreferredMaintenanceWindow — (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

        • PendingModifiedValues — (map)

          A group of settings that are applied to the cluster in the future, or that are currently being applied.

          • NumCacheNodes — (Integer)

            The new number of cache nodes for the cluster.

            For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

          • CacheNodeIdsToRemove — (Array<String>)

            A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).

          • EngineVersion — (String)

            The new cache engine version that the cluster runs.

          • CacheNodeType — (String)

            The cache node type that this cluster or replication group is scaled to.

          • AuthTokenStatus — (String)

            The auth token status

            Possible values include:
            • "SETTING"
            • "ROTATING"
          • LogDeliveryConfigurations — (Array<map>)

            The log delivery configurations being modified

            • LogType — (String)

              Refers to slow-log.

              Possible values include:
              • "slow-log"
            • DestinationType — (String)

              Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

              Possible values include:
              • "cloudwatch-logs"
              • "kinesis-firehose"
            • DestinationDetails — (map)

              Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

              • CloudWatchLogsDetails — (map)

                The configuration details of the CloudWatch Logs destination.

                • LogGroup — (String)

                  The name of the CloudWatch Logs log group.

              • KinesisFirehoseDetails — (map)

                The configuration details of the Kinesis Data Firehose destination.

                • DeliveryStream — (String)

                  The name of the Kinesis Data Firehose delivery stream.

            • LogFormat — (String)

              Returns the log format, either JSON or TEXT

              Possible values include:
              • "text"
              • "json"
        • NotificationConfiguration — (map)

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

          • TopicArn — (String)

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

          • TopicStatus — (String)

            The current state of the topic.

        • CacheSecurityGroups — (Array<map>)

          A list of cache security group elements, composed of name and status sub-elements.

          • CacheSecurityGroupName — (String)

            The name of the cache security group.

          • Status — (String)

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

        • CacheParameterGroup — (map)

          Status of the cache parameter group.

          • CacheParameterGroupName — (String)

            The name of the cache parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • CacheNodeIdsToReboot — (Array<String>)

            A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).

        • CacheSubnetGroupName — (String)

          The name of the cache subnet group associated with the cluster.

        • CacheNodes — (Array<map>)

          A list of cache nodes that are members of the cluster.

          • CacheNodeId — (String)

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

          • CacheNodeStatus — (String)

            The current state of this cache node, one of the following values: available, creating, rebooting, or deleting.

          • CacheNodeCreateTime — (Date)

            The date and time when the cache node was created.

          • Endpoint — (map)

            The hostname for connecting to this cache node.

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • ParameterGroupStatus — (String)

            The status of the parameter group applied to this cache node.

          • SourceCacheNodeId — (String)

            The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cluster.

          • CustomerAvailabilityZone — (String)

            The Availability Zone where this node was created and now resides.

          • CustomerOutpostArn — (String)

            The customer outpost ARN of the cache node.

        • AutoMinorVersionUpgrade — (Boolean)

          This parameter is currently disabled.

        • SecurityGroups — (Array<map>)

          A list of VPC Security Groups associated with the cluster.

          • SecurityGroupId — (String)

            The identifier of the cache security group.

          • Status — (String)

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

        • ReplicationGroupId — (String)

          The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.

        • SnapshotRetentionLimit — (Integer)

          The number of days for which ElastiCache 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.

          If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

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

          Example: 05:00-09:00

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • AuthTokenLastModifiedDate — (Date)

          The date the auth token was last modified

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true.

          You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at-rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • ARN — (String)

          The ARN (Amazon Resource Name) of the cache cluster.

        • ReplicationGroupLogDeliveryEnabled — (Boolean)

          A boolean value indicating whether log delivery is enabled for the replication group.

        • LogDeliveryConfigurations — (Array<map>)

          Returns the destination, format and type of the logs.

          • LogType — (String)

            Refers to slow-log.

            Possible values include:
            • "slow-log"
          • DestinationType — (String)

            Returns the destination type, either cloudwatch-logs or kinesis-firehose.

            Possible values include:
            • "cloudwatch-logs"
            • "kinesis-firehose"
          • DestinationDetails — (map)

            Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

            • CloudWatchLogsDetails — (map)

              The configuration details of the CloudWatch Logs destination.

              • LogGroup — (String)

                The name of the CloudWatch Logs log group.

            • KinesisFirehoseDetails — (map)

              The configuration details of the Kinesis Data Firehose destination.

              • DeliveryStream — (String)

                The name of the Kinesis Data Firehose delivery stream.

          • LogFormat — (String)

            Returns the log format, either JSON or TEXT.

            Possible values include:
            • "text"
            • "json"
          • Status — (String)

            Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

            Possible values include:
            • "active"
            • "enabling"
            • "modifying"
            • "disabling"
            • "error"
          • Message — (String)

            Returns an error message for the log delivery configuration.

Returns:

  • (AWS.Request) —

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

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

Removes the tags identified by the TagKeys list from the named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.

Service Reference:

Examples:

Calling the removeTagsFromResource operation

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

Parameters:

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

      The Amazon Resource Name (ARN) of the resource from which you want the tags removed, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

      For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.

    • TagKeys — (Array<String>)

      A list of TagKeys identifying the tags you want removed from the named resource.

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.

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

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

Service Reference:

Examples:

Calling the resetCacheParameterGroup operation

var params = {
  CacheParameterGroupName: 'STRING_VALUE', /* required */
  ParameterNameValues: [
    {
      ParameterName: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE'
    },
    /* more items */
  ],
  ResetAllParameters: true || false
};
elasticache.resetCacheParameterGroup(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: {}) —
    • CacheParameterGroupName — (String)

      The name of the cache parameter group to reset.

    • ResetAllParameters — (Boolean)

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

      Valid values: true | false

    • ParameterNameValues — (Array<map>)

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

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

      • CacheParameterGroupName — (String)

        The name of the cache parameter group.

Returns:

  • (AWS.Request) —

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

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

Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.

Service Reference:

Examples:

Calling the revokeCacheSecurityGroupIngress operation

var params = {
  CacheSecurityGroupName: 'STRING_VALUE', /* required */
  EC2SecurityGroupName: 'STRING_VALUE', /* required */
  EC2SecurityGroupOwnerId: 'STRING_VALUE' /* required */
};
elasticache.revokeCacheSecurityGroupIngress(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: {}) —
    • CacheSecurityGroupName — (String)

      The name of the cache security group to revoke ingress from.

    • EC2SecurityGroupName — (String)

      The name of the Amazon EC2 security group to revoke access from.

    • EC2SecurityGroupOwnerId — (String)

      The Amazon account number of the Amazon EC2 security group owner. Note that this is not the same thing as an Amazon access key ID - you must provide a valid Amazon account number for this 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:

      • CacheSecurityGroup — (map)

        Represents the output of one of the following operations:

        • AuthorizeCacheSecurityGroupIngress

        • CreateCacheSecurityGroup

        • RevokeCacheSecurityGroupIngress

        • OwnerId — (String)

          The Amazon account ID of the cache security group owner.

        • CacheSecurityGroupName — (String)

          The name of the cache security group.

        • Description — (String)

          The description of the cache security group.

        • EC2SecurityGroups — (Array<map>)

          A list of Amazon EC2 security groups that are associated with this cache security group.

          • Status — (String)

            The status of the Amazon EC2 security group.

          • EC2SecurityGroupName — (String)

            The name of the Amazon EC2 security group.

          • EC2SecurityGroupOwnerId — (String)

            The Amazon account ID of the Amazon EC2 security group owner.

        • ARN — (String)

          The ARN of the cache security group,

Returns:

  • (AWS.Request) —

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

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

Start the migration of data.

Service Reference:

Examples:

Calling the startMigration operation

var params = {
  CustomerNodeEndpointList: [ /* required */
    {
      Address: 'STRING_VALUE',
      Port: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  ReplicationGroupId: 'STRING_VALUE' /* required */
};
elasticache.startMigration(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: {}) —
    • ReplicationGroupId — (String)

      The ID of the replication group to which data should be migrated.

    • CustomerNodeEndpointList — (Array<map>)

      List of endpoints from which data should be migrated. For Redis (cluster mode disabled), list should have only one element.

      • Address — (String)

        The address of the node endpoint

      • Port — (Integer)

        The port of the node endpoint

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:

      • ReplicationGroup — (map)

        Contains all of the attributes of a specific Redis replication group.

        • ReplicationGroupId — (String)

          The identifier for the replication group.

        • Description — (String)

          The user supplied description of the replication group.

        • GlobalReplicationGroupInfo — (map)

          The name of the Global datastore and role of this replication group in the Global datastore.

          • GlobalReplicationGroupId — (String)

            The name of the Global datastore

          • GlobalReplicationGroupMemberRole — (String)

            The role of the replication group in a Global datastore. Can be primary or secondary.

        • Status — (String)

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

        • PendingModifiedValues — (map)

          A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

          • PrimaryClusterId — (String)

            The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.

          • AutomaticFailoverStatus — (String)

            Indicates the status of automatic failover for this Redis replication group.

            Possible values include:
            • "enabled"
            • "disabled"
          • Resharding — (map)

            The status of an online resharding operation.

            • SlotMigration — (map)

              Represents the progress of an online resharding operation.

              • ProgressPercentage — (Float)

                The percentage of the slot migration that is complete.

          • AuthTokenStatus — (String)

            The auth token status

            Possible values include:
            • "SETTING"
            • "ROTATING"
          • UserGroups — (map)

            The user group being modified.

            • UserGroupIdsToAdd — (Array<String>)

              The ID of the user group to add.

            • UserGroupIdsToRemove — (Array<String>)

              The ID of the user group to remove.

          • LogDeliveryConfigurations — (Array<map>)

            The log delivery configurations being modified

            • LogType — (String)

              Refers to slow-log.

              Possible values include:
              • "slow-log"
            • DestinationType — (String)

              Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

              Possible values include:
              • "cloudwatch-logs"
              • "kinesis-firehose"
            • DestinationDetails — (map)

              Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

              • CloudWatchLogsDetails — (map)

                The configuration details of the CloudWatch Logs destination.

                • LogGroup — (String)

                  The name of the CloudWatch Logs log group.

              • KinesisFirehoseDetails — (map)

                The configuration details of the Kinesis Data Firehose destination.

                • DeliveryStream — (String)

                  The name of the Kinesis Data Firehose delivery stream.

            • LogFormat — (String)

              Returns the log format, either JSON or TEXT

              Possible values include:
              • "text"
              • "json"
        • MemberClusters — (Array<String>)

          The names of all the cache clusters that are part of this replication group.

        • NodeGroups — (Array<map>)

          A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

          • NodeGroupId — (String)

            The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.

          • Status — (String)

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

          • PrimaryEndpoint — (map)

            The endpoint of the primary node in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • ReaderEndpoint — (map)

            The endpoint of the replica nodes in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • Slots — (String)

            The keyspace for this node group (shard).

          • NodeGroupMembers — (Array<map>)

            A list containing information about individual nodes within the node group (shard).

            • CacheClusterId — (String)

              The ID of the cluster to which the node belongs.

            • CacheNodeId — (String)

              The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).

            • ReadEndpoint — (map)

              The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.

              • Address — (String)

                The DNS hostname of the cache node.

              • Port — (Integer)

                The port number that the cache engine is listening on.

            • PreferredAvailabilityZone — (String)

              The name of the Availability Zone in which the node is located.

            • PreferredOutpostArn — (String)

              The outpost ARN of the node group member.

            • CurrentRole — (String)

              The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.

        • SnapshottingClusterId — (String)

          The cluster ID that is used as the daily snapshot source for the replication group.

        • AutomaticFailover — (String)

          Indicates the status of automatic failover for this Redis replication group.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
        • MultiAZ — (String)

          A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

          Possible values include:
          • "enabled"
          • "disabled"
        • ConfigurationEndpoint — (map)

          The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

          • Address — (String)

            The DNS hostname of the cache node.

          • Port — (Integer)

            The port number that the cache engine is listening on.

        • SnapshotRetentionLimit — (Integer)

          The number of days for which ElastiCache 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.

          If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

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

          Example: 05:00-09:00

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

          Note: This parameter is only valid if the Engine parameter is redis.
        • ClusterEnabled — (Boolean)

          A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

          Valid values: true | false

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for each node in the replication group.

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • AuthTokenLastModifiedDate — (Date)

          The date the auth token was last modified

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true.

          You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at-rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • MemberClustersOutpostArns — (Array<String>)

          The outpost ARNs of the replication group's member clusters.

        • KmsKeyId — (String)

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

        • ARN — (String)

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

        • UserGroupIds — (Array<String>)

          The ID of the user group associated to the replication group.

        • LogDeliveryConfigurations — (Array<map>)

          Returns the destination, format and type of the logs.

          • LogType — (String)

            Refers to slow-log.

            Possible values include:
            • "slow-log"
          • DestinationType — (String)

            Returns the destination type, either cloudwatch-logs or kinesis-firehose.

            Possible values include:
            • "cloudwatch-logs"
            • "kinesis-firehose"
          • DestinationDetails — (map)

            Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

            • CloudWatchLogsDetails — (map)

              The configuration details of the CloudWatch Logs destination.

              • LogGroup — (String)

                The name of the CloudWatch Logs log group.

            • KinesisFirehoseDetails — (map)

              The configuration details of the Kinesis Data Firehose destination.

              • DeliveryStream — (String)

                The name of the Kinesis Data Firehose delivery stream.

          • LogFormat — (String)

            Returns the log format, either JSON or TEXT.

            Possible values include:
            • "text"
            • "json"
          • Status — (String)

            Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

            Possible values include:
            • "active"
            • "enabling"
            • "modifying"
            • "disabling"
            • "error"
          • Message — (String)

            Returns an error message for the log delivery configuration.

        • ReplicationGroupCreateTime — (Date)

          The date and time when the cluster was created.

Returns:

  • (AWS.Request) —

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

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

Represents the input of a TestFailover operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).

Note the following

  • A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and Amazon CLI) in any rolling 24-hour period.

  • If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.

  • If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.

  • To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:

    1. Replication group message: Test Failover API called for node group <node-group-id>

    2. Cache cluster message: Failover from primary node <primary-node-id> to replica node <node-id> completed

    3. Replication group message: Failover from primary node <primary-node-id> to replica node <node-id> completed

    4. Cache cluster message: Recovering cache nodes <node-id>

    5. Cache cluster message: Finished recovery for cache nodes <node-id>

    For more information see:

Also see, Testing Multi-AZ in the ElastiCache User Guide.

Service Reference:

Examples:

Calling the testFailover operation

var params = {
  NodeGroupId: 'STRING_VALUE', /* required */
  ReplicationGroupId: 'STRING_VALUE' /* required */
};
elasticache.testFailover(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: {}) —
    • ReplicationGroupId — (String)

      The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.

    • NodeGroupId — (String)

      The name of the node group (called shard in the console) in this replication group on which automatic failover is to be tested. You may test automatic failover on up to 5 node groups in any rolling 24-hour period.

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:

      • ReplicationGroup — (map)

        Contains all of the attributes of a specific Redis replication group.

        • ReplicationGroupId — (String)

          The identifier for the replication group.

        • Description — (String)

          The user supplied description of the replication group.

        • GlobalReplicationGroupInfo — (map)

          The name of the Global datastore and role of this replication group in the Global datastore.

          • GlobalReplicationGroupId — (String)

            The name of the Global datastore

          • GlobalReplicationGroupMemberRole — (String)

            The role of the replication group in a Global datastore. Can be primary or secondary.

        • Status — (String)

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

        • PendingModifiedValues — (map)

          A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

          • PrimaryClusterId — (String)

            The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.

          • AutomaticFailoverStatus — (String)

            Indicates the status of automatic failover for this Redis replication group.

            Possible values include:
            • "enabled"
            • "disabled"
          • Resharding — (map)

            The status of an online resharding operation.

            • SlotMigration — (map)

              Represents the progress of an online resharding operation.

              • ProgressPercentage — (Float)

                The percentage of the slot migration that is complete.

          • AuthTokenStatus — (String)

            The auth token status

            Possible values include:
            • "SETTING"
            • "ROTATING"
          • UserGroups — (map)

            The user group being modified.

            • UserGroupIdsToAdd — (Array<String>)

              The ID of the user group to add.

            • UserGroupIdsToRemove — (Array<String>)

              The ID of the user group to remove.

          • LogDeliveryConfigurations — (Array<map>)

            The log delivery configurations being modified

            • LogType — (String)

              Refers to slow-log.

              Possible values include:
              • "slow-log"
            • DestinationType — (String)

              Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

              Possible values include:
              • "cloudwatch-logs"
              • "kinesis-firehose"
            • DestinationDetails — (map)

              Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

              • CloudWatchLogsDetails — (map)

                The configuration details of the CloudWatch Logs destination.

                • LogGroup — (String)

                  The name of the CloudWatch Logs log group.

              • KinesisFirehoseDetails — (map)

                The configuration details of the Kinesis Data Firehose destination.

                • DeliveryStream — (String)

                  The name of the Kinesis Data Firehose delivery stream.

            • LogFormat — (String)

              Returns the log format, either JSON or TEXT

              Possible values include:
              • "text"
              • "json"
        • MemberClusters — (Array<String>)

          The names of all the cache clusters that are part of this replication group.

        • NodeGroups — (Array<map>)

          A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

          • NodeGroupId — (String)

            The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.

          • Status — (String)

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

          • PrimaryEndpoint — (map)

            The endpoint of the primary node in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • ReaderEndpoint — (map)

            The endpoint of the replica nodes in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • Slots — (String)

            The keyspace for this node group (shard).

          • NodeGroupMembers — (Array<map>)

            A list containing information about individual nodes within the node group (shard).

            • CacheClusterId — (String)

              The ID of the cluster to which the node belongs.

            • CacheNodeId — (String)

              The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).

            • ReadEndpoint — (map)

              The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.

              • Address — (String)

                The DNS hostname of the cache node.

              • Port — (Integer)

                The port number that the cache engine is listening on.

            • PreferredAvailabilityZone — (String)

              The name of the Availability Zone in which the node is located.

            • PreferredOutpostArn — (String)

              The outpost ARN of the node group member.

            • CurrentRole — (String)

              The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.

        • SnapshottingClusterId — (String)

          The cluster ID that is used as the daily snapshot source for the replication group.

        • AutomaticFailover — (String)

          Indicates the status of automatic failover for this Redis replication group.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
        • MultiAZ — (String)

          A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

          Possible values include:
          • "enabled"
          • "disabled"
        • ConfigurationEndpoint — (map)

          The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

          • Address — (String)

            The DNS hostname of the cache node.

          • Port — (Integer)

            The port number that the cache engine is listening on.

        • SnapshotRetentionLimit — (Integer)

          The number of days for which ElastiCache 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.

          If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

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

          Example: 05:00-09:00

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

          Note: This parameter is only valid if the Engine parameter is redis.
        • ClusterEnabled — (Boolean)

          A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

          Valid values: true | false

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for each node in the replication group.

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • AuthTokenLastModifiedDate — (Date)

          The date the auth token was last modified

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true.

          You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at-rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • MemberClustersOutpostArns — (Array<String>)

          The outpost ARNs of the replication group's member clusters.

        • KmsKeyId — (String)

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

        • ARN — (String)

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

        • UserGroupIds — (Array<String>)

          The ID of the user group associated to the replication group.

        • LogDeliveryConfigurations — (Array<map>)

          Returns the destination, format and type of the logs.

          • LogType — (String)

            Refers to slow-log.

            Possible values include:
            • "slow-log"
          • DestinationType — (String)

            Returns the destination type, either cloudwatch-logs or kinesis-firehose.

            Possible values include:
            • "cloudwatch-logs"
            • "kinesis-firehose"
          • DestinationDetails — (map)

            Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

            • CloudWatchLogsDetails — (map)

              The configuration details of the CloudWatch Logs destination.

              • LogGroup — (String)

                The name of the CloudWatch Logs log group.

            • KinesisFirehoseDetails — (map)

              The configuration details of the Kinesis Data Firehose destination.

              • DeliveryStream — (String)

                The name of the Kinesis Data Firehose delivery stream.

          • LogFormat — (String)

            Returns the log format, either JSON or TEXT.

            Possible values include:
            • "text"
            • "json"
          • Status — (String)

            Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

            Possible values include:
            • "active"
            • "enabling"
            • "modifying"
            • "disabling"
            • "error"
          • Message — (String)

            Returns an error message for the log delivery configuration.

        • ReplicationGroupCreateTime — (Date)

          The date and time when the cluster was created.

Returns:

  • (AWS.Request) —

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

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

Waits for a given ElastiCache resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the cacheClusterAvailable state

var params = {
  // ... input parameters ...
};
elasticache.waitFor('cacheClusterAvailable', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • state (String) —

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {}) —

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

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

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request) —

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

Waiter Resource States:

Waiter Resource Details

elasticache.waitFor('cacheClusterAvailable', params = {}, [callback]) ⇒ AWS.Request

Waits for the cacheClusterAvailable state by periodically calling the underlying ElastiCache.describeCacheClusters() operation every 15 seconds (at most 40 times).

Examples:

Waiting for the cacheClusterAvailable state

var params = {
  // ... input parameters ...
};
elasticache.waitFor('cacheClusterAvailable', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • CacheClusterId — (String)

      The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.

    • MaxRecords — (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.

      Default: 100

      Constraints: minimum 20; maximum 100.

    • Marker — (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.

    • ShowCacheNodeInfo — (Boolean)

      An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

    • ShowCacheClustersNotInReplicationGroups — (Boolean)

      An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

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:

      • Marker — (String)

        Provides an identifier to allow retrieval of paginated results.

      • CacheClusters — (Array<map>)

        A list of clusters. Each item in the list contains detailed information about one cluster.

        • CacheClusterId — (String)

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

        • ConfigurationEndpoint — (map)

          Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.

          Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211

          • Address — (String)

            The DNS hostname of the cache node.

          • Port — (Integer)

            The port number that the cache engine is listening on.

        • ClientDownloadLandingPage — (String)

          The URL of the web page where you can download the latest ElastiCache client library.

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for the cluster.

          The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

          • General purpose:

            • Current generation:

              M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

              Note: For region availability, see Supported Node Types

              M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

              M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

              T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

              T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

            • Previous generation: (not recommended)

              T1 node types: cache.t1.micro

              M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

              M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

          • Compute optimized:

            • Previous generation: (not recommended)

              C1 node types: cache.c1.xlarge

          • Memory optimized:

            • Current generation:

              R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

              Note: For region availability, see Supported Node Types

              R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

              R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

            • Previous generation: (not recommended)

              M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

              R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

          Additional node type info

          • All current generation instance types are created in Amazon VPC by default.

          • Redis append-only files (AOF) are not supported for T1 or T2 instances.

          • Redis Multi-AZ with automatic failover is not supported on T1 instances.

          • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

        • Engine — (String)

          The name of the cache engine (memcached or redis) to be used for this cluster.

        • EngineVersion — (String)

          The version of the cache engine that is used in this cluster.

        • CacheClusterStatus — (String)

          The current state of this cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cluster nodes, restore-failed, or snapshotting.

        • NumCacheNodes — (Integer)

          The number of cache nodes in the cluster.

          For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

        • PreferredAvailabilityZone — (String)

          The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

        • PreferredOutpostArn — (String)

          The outpost ARN in which the cache cluster is created.

        • CacheClusterCreateTime — (Date)

          The date and time when the cluster was created.

        • PreferredMaintenanceWindow — (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

        • PendingModifiedValues — (map)

          A group of settings that are applied to the cluster in the future, or that are currently being applied.

          • NumCacheNodes — (Integer)

            The new number of cache nodes for the cluster.

            For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

          • CacheNodeIdsToRemove — (Array<String>)

            A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).

          • EngineVersion — (String)

            The new cache engine version that the cluster runs.

          • CacheNodeType — (String)

            The cache node type that this cluster or replication group is scaled to.

          • AuthTokenStatus — (String)

            The auth token status

            Possible values include:
            • "SETTING"
            • "ROTATING"
          • LogDeliveryConfigurations — (Array<map>)

            The log delivery configurations being modified

            • LogType — (String)

              Refers to slow-log.

              Possible values include:
              • "slow-log"
            • DestinationType — (String)

              Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

              Possible values include:
              • "cloudwatch-logs"
              • "kinesis-firehose"
            • DestinationDetails — (map)

              Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

              • CloudWatchLogsDetails — (map)

                The configuration details of the CloudWatch Logs destination.

                • LogGroup — (String)

                  The name of the CloudWatch Logs log group.

              • KinesisFirehoseDetails — (map)

                The configuration details of the Kinesis Data Firehose destination.

                • DeliveryStream — (String)

                  The name of the Kinesis Data Firehose delivery stream.

            • LogFormat — (String)

              Returns the log format, either JSON or TEXT

              Possible values include:
              • "text"
              • "json"
        • NotificationConfiguration — (map)

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

          • TopicArn — (String)

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

          • TopicStatus — (String)

            The current state of the topic.

        • CacheSecurityGroups — (Array<map>)

          A list of cache security group elements, composed of name and status sub-elements.

          • CacheSecurityGroupName — (String)

            The name of the cache security group.

          • Status — (String)

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

        • CacheParameterGroup — (map)

          Status of the cache parameter group.

          • CacheParameterGroupName — (String)

            The name of the cache parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • CacheNodeIdsToReboot — (Array<String>)

            A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).

        • CacheSubnetGroupName — (String)

          The name of the cache subnet group associated with the cluster.

        • CacheNodes — (Array<map>)

          A list of cache nodes that are members of the cluster.

          • CacheNodeId — (String)

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

          • CacheNodeStatus — (String)

            The current state of this cache node, one of the following values: available, creating, rebooting, or deleting.

          • CacheNodeCreateTime — (Date)

            The date and time when the cache node was created.

          • Endpoint — (map)

            The hostname for connecting to this cache node.

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • ParameterGroupStatus — (String)

            The status of the parameter group applied to this cache node.

          • SourceCacheNodeId — (String)

            The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cluster.

          • CustomerAvailabilityZone — (String)

            The Availability Zone where this node was created and now resides.

          • CustomerOutpostArn — (String)

            The customer outpost ARN of the cache node.

        • AutoMinorVersionUpgrade — (Boolean)

          This parameter is currently disabled.

        • SecurityGroups — (Array<map>)

          A list of VPC Security Groups associated with the cluster.

          • SecurityGroupId — (String)

            The identifier of the cache security group.

          • Status — (String)

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

        • ReplicationGroupId — (String)

          The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.

        • SnapshotRetentionLimit — (Integer)

          The number of days for which ElastiCache 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.

          If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

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

          Example: 05:00-09:00

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • AuthTokenLastModifiedDate — (Date)

          The date the auth token was last modified

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true.

          You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at-rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • ARN — (String)

          The ARN (Amazon Resource Name) of the cache cluster.

        • ReplicationGroupLogDeliveryEnabled — (Boolean)

          A boolean value indicating whether log delivery is enabled for the replication group.

        • LogDeliveryConfigurations — (Array<map>)

          Returns the destination, format and type of the logs.

          • LogType — (String)

            Refers to slow-log.

            Possible values include:
            • "slow-log"
          • DestinationType — (String)

            Returns the destination type, either cloudwatch-logs or kinesis-firehose.

            Possible values include:
            • "cloudwatch-logs"
            • "kinesis-firehose"
          • DestinationDetails — (map)

            Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

            • CloudWatchLogsDetails — (map)

              The configuration details of the CloudWatch Logs destination.

              • LogGroup — (String)

                The name of the CloudWatch Logs log group.

            • KinesisFirehoseDetails — (map)

              The configuration details of the Kinesis Data Firehose destination.

              • DeliveryStream — (String)

                The name of the Kinesis Data Firehose delivery stream.

          • LogFormat — (String)

            Returns the log format, either JSON or TEXT.

            Possible values include:
            • "text"
            • "json"
          • Status — (String)

            Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

            Possible values include:
            • "active"
            • "enabling"
            • "modifying"
            • "disabling"
            • "error"
          • Message — (String)

            Returns an error message for the log delivery configuration.

Returns:

  • (AWS.Request) —

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

See Also:

elasticache.waitFor('cacheClusterDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the cacheClusterDeleted state by periodically calling the underlying ElastiCache.describeCacheClusters() operation every 15 seconds (at most 40 times).

Examples:

Waiting for the cacheClusterDeleted state

var params = {
  // ... input parameters ...
};
elasticache.waitFor('cacheClusterDeleted', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • CacheClusterId — (String)

      The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.

    • MaxRecords — (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.

      Default: 100

      Constraints: minimum 20; maximum 100.

    • Marker — (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.

    • ShowCacheNodeInfo — (Boolean)

      An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

    • ShowCacheClustersNotInReplicationGroups — (Boolean)

      An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

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:

      • Marker — (String)

        Provides an identifier to allow retrieval of paginated results.

      • CacheClusters — (Array<map>)

        A list of clusters. Each item in the list contains detailed information about one cluster.

        • CacheClusterId — (String)

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

        • ConfigurationEndpoint — (map)

          Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.

          Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211

          • Address — (String)

            The DNS hostname of the cache node.

          • Port — (Integer)

            The port number that the cache engine is listening on.

        • ClientDownloadLandingPage — (String)

          The URL of the web page where you can download the latest ElastiCache client library.

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for the cluster.

          The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

          • General purpose:

            • Current generation:

              M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

              Note: For region availability, see Supported Node Types

              M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

              M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

              T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

              T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

            • Previous generation: (not recommended)

              T1 node types: cache.t1.micro

              M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

              M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

          • Compute optimized:

            • Previous generation: (not recommended)

              C1 node types: cache.c1.xlarge

          • Memory optimized:

            • Current generation:

              R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).

              cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

              Note: For region availability, see Supported Node Types

              R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

              R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

            • Previous generation: (not recommended)

              M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

              R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

          Additional node type info

          • All current generation instance types are created in Amazon VPC by default.

          • Redis append-only files (AOF) are not supported for T1 or T2 instances.

          • Redis Multi-AZ with automatic failover is not supported on T1 instances.

          • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

        • Engine — (String)

          The name of the cache engine (memcached or redis) to be used for this cluster.

        • EngineVersion — (String)

          The version of the cache engine that is used in this cluster.

        • CacheClusterStatus — (String)

          The current state of this cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cluster nodes, restore-failed, or snapshotting.

        • NumCacheNodes — (Integer)

          The number of cache nodes in the cluster.

          For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

        • PreferredAvailabilityZone — (String)

          The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

        • PreferredOutpostArn — (String)

          The outpost ARN in which the cache cluster is created.

        • CacheClusterCreateTime — (Date)

          The date and time when the cluster was created.

        • PreferredMaintenanceWindow — (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

        • PendingModifiedValues — (map)

          A group of settings that are applied to the cluster in the future, or that are currently being applied.

          • NumCacheNodes — (Integer)

            The new number of cache nodes for the cluster.

            For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

          • CacheNodeIdsToRemove — (Array<String>)

            A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).

          • EngineVersion — (String)

            The new cache engine version that the cluster runs.

          • CacheNodeType — (String)

            The cache node type that this cluster or replication group is scaled to.

          • AuthTokenStatus — (String)

            The auth token status

            Possible values include:
            • "SETTING"
            • "ROTATING"
          • LogDeliveryConfigurations — (Array<map>)

            The log delivery configurations being modified

            • LogType — (String)

              Refers to slow-log.

              Possible values include:
              • "slow-log"
            • DestinationType — (String)

              Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

              Possible values include:
              • "cloudwatch-logs"
              • "kinesis-firehose"
            • DestinationDetails — (map)

              Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

              • CloudWatchLogsDetails — (map)

                The configuration details of the CloudWatch Logs destination.

                • LogGroup — (String)

                  The name of the CloudWatch Logs log group.

              • KinesisFirehoseDetails — (map)

                The configuration details of the Kinesis Data Firehose destination.

                • DeliveryStream — (String)

                  The name of the Kinesis Data Firehose delivery stream.

            • LogFormat — (String)

              Returns the log format, either JSON or TEXT

              Possible values include:
              • "text"
              • "json"
        • NotificationConfiguration — (map)

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

          • TopicArn — (String)

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

          • TopicStatus — (String)

            The current state of the topic.

        • CacheSecurityGroups — (Array<map>)

          A list of cache security group elements, composed of name and status sub-elements.

          • CacheSecurityGroupName — (String)

            The name of the cache security group.

          • Status — (String)

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

        • CacheParameterGroup — (map)

          Status of the cache parameter group.

          • CacheParameterGroupName — (String)

            The name of the cache parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • CacheNodeIdsToReboot — (Array<String>)

            A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).

        • CacheSubnetGroupName — (String)

          The name of the cache subnet group associated with the cluster.

        • CacheNodes — (Array<map>)

          A list of cache nodes that are members of the cluster.

          • CacheNodeId — (String)

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

          • CacheNodeStatus — (String)

            The current state of this cache node, one of the following values: available, creating, rebooting, or deleting.

          • CacheNodeCreateTime — (Date)

            The date and time when the cache node was created.

          • Endpoint — (map)

            The hostname for connecting to this cache node.

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • ParameterGroupStatus — (String)

            The status of the parameter group applied to this cache node.

          • SourceCacheNodeId — (String)

            The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cluster.

          • CustomerAvailabilityZone — (String)

            The Availability Zone where this node was created and now resides.

          • CustomerOutpostArn — (String)

            The customer outpost ARN of the cache node.

        • AutoMinorVersionUpgrade — (Boolean)

          This parameter is currently disabled.

        • SecurityGroups — (Array<map>)

          A list of VPC Security Groups associated with the cluster.

          • SecurityGroupId — (String)

            The identifier of the cache security group.

          • Status — (String)

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

        • ReplicationGroupId — (String)

          The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.

        • SnapshotRetentionLimit — (Integer)

          The number of days for which ElastiCache 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.

          If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

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

          Example: 05:00-09:00

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • AuthTokenLastModifiedDate — (Date)

          The date the auth token was last modified

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true.

          You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at-rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • ARN — (String)

          The ARN (Amazon Resource Name) of the cache cluster.

        • ReplicationGroupLogDeliveryEnabled — (Boolean)

          A boolean value indicating whether log delivery is enabled for the replication group.

        • LogDeliveryConfigurations — (Array<map>)

          Returns the destination, format and type of the logs.

          • LogType — (String)

            Refers to slow-log.

            Possible values include:
            • "slow-log"
          • DestinationType — (String)

            Returns the destination type, either cloudwatch-logs or kinesis-firehose.

            Possible values include:
            • "cloudwatch-logs"
            • "kinesis-firehose"
          • DestinationDetails — (map)

            Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

            • CloudWatchLogsDetails — (map)

              The configuration details of the CloudWatch Logs destination.

              • LogGroup — (String)

                The name of the CloudWatch Logs log group.

            • KinesisFirehoseDetails — (map)

              The configuration details of the Kinesis Data Firehose destination.

              • DeliveryStream — (String)

                The name of the Kinesis Data Firehose delivery stream.

          • LogFormat — (String)

            Returns the log format, either JSON or TEXT.

            Possible values include:
            • "text"
            • "json"
          • Status — (String)

            Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

            Possible values include:
            • "active"
            • "enabling"
            • "modifying"
            • "disabling"
            • "error"
          • Message — (String)

            Returns an error message for the log delivery configuration.

Returns:

  • (AWS.Request) —

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

See Also:

elasticache.waitFor('replicationGroupAvailable', params = {}, [callback]) ⇒ AWS.Request

Waits for the replicationGroupAvailable state by periodically calling the underlying ElastiCache.describeReplicationGroups() operation every 15 seconds (at most 40 times).

Examples:

Waiting for the replicationGroupAvailable state

var params = {
  // ... input parameters ...
};
elasticache.waitFor('replicationGroupAvailable', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • ReplicationGroupId — (String)

      The identifier for the replication group to be described. This parameter is not case sensitive.

      If you do not specify this parameter, information about all replication groups is returned.

    • MaxRecords — (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.

      Default: 100

      Constraints: minimum 20; maximum 100.

    • Marker — (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:

      • Marker — (String)

        Provides an identifier to allow retrieval of paginated results.

      • ReplicationGroups — (Array<map>)

        A list of replication groups. Each item in the list contains detailed information about one replication group.

        • ReplicationGroupId — (String)

          The identifier for the replication group.

        • Description — (String)

          The user supplied description of the replication group.

        • GlobalReplicationGroupInfo — (map)

          The name of the Global datastore and role of this replication group in the Global datastore.

          • GlobalReplicationGroupId — (String)

            The name of the Global datastore

          • GlobalReplicationGroupMemberRole — (String)

            The role of the replication group in a Global datastore. Can be primary or secondary.

        • Status — (String)

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

        • PendingModifiedValues — (map)

          A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

          • PrimaryClusterId — (String)

            The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.

          • AutomaticFailoverStatus — (String)

            Indicates the status of automatic failover for this Redis replication group.

            Possible values include:
            • "enabled"
            • "disabled"
          • Resharding — (map)

            The status of an online resharding operation.

            • SlotMigration — (map)

              Represents the progress of an online resharding operation.

              • ProgressPercentage — (Float)

                The percentage of the slot migration that is complete.

          • AuthTokenStatus — (String)

            The auth token status

            Possible values include:
            • "SETTING"
            • "ROTATING"
          • UserGroups — (map)

            The user group being modified.

            • UserGroupIdsToAdd — (Array<String>)

              The ID of the user group to add.

            • UserGroupIdsToRemove — (Array<String>)

              The ID of the user group to remove.

          • LogDeliveryConfigurations — (Array<map>)

            The log delivery configurations being modified

            • LogType — (String)

              Refers to slow-log.

              Possible values include:
              • "slow-log"
            • DestinationType — (String)

              Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

              Possible values include:
              • "cloudwatch-logs"
              • "kinesis-firehose"
            • DestinationDetails — (map)

              Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

              • CloudWatchLogsDetails — (map)

                The configuration details of the CloudWatch Logs destination.

                • LogGroup — (String)

                  The name of the CloudWatch Logs log group.

              • KinesisFirehoseDetails — (map)

                The configuration details of the Kinesis Data Firehose destination.

                • DeliveryStream — (String)

                  The name of the Kinesis Data Firehose delivery stream.

            • LogFormat — (String)

              Returns the log format, either JSON or TEXT

              Possible values include:
              • "text"
              • "json"
        • MemberClusters — (Array<String>)

          The names of all the cache clusters that are part of this replication group.

        • NodeGroups — (Array<map>)

          A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

          • NodeGroupId — (String)

            The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.

          • Status — (String)

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

          • PrimaryEndpoint — (map)

            The endpoint of the primary node in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • ReaderEndpoint — (map)

            The endpoint of the replica nodes in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • Slots — (String)

            The keyspace for this node group (shard).

          • NodeGroupMembers — (Array<map>)

            A list containing information about individual nodes within the node group (shard).

            • CacheClusterId — (String)

              The ID of the cluster to which the node belongs.

            • CacheNodeId — (String)

              The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).

            • ReadEndpoint — (map)

              The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.

              • Address — (String)

                The DNS hostname of the cache node.

              • Port — (Integer)

                The port number that the cache engine is listening on.

            • PreferredAvailabilityZone — (String)

              The name of the Availability Zone in which the node is located.

            • PreferredOutpostArn — (String)

              The outpost ARN of the node group member.

            • CurrentRole — (String)

              The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.

        • SnapshottingClusterId — (String)

          The cluster ID that is used as the daily snapshot source for the replication group.

        • AutomaticFailover — (String)

          Indicates the status of automatic failover for this Redis replication group.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
        • MultiAZ — (String)

          A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

          Possible values include:
          • "enabled"
          • "disabled"
        • ConfigurationEndpoint — (map)

          The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

          • Address — (String)

            The DNS hostname of the cache node.

          • Port — (Integer)

            The port number that the cache engine is listening on.

        • SnapshotRetentionLimit — (Integer)

          The number of days for which ElastiCache 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.

          If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

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

          Example: 05:00-09:00

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

          Note: This parameter is only valid if the Engine parameter is redis.
        • ClusterEnabled — (Boolean)

          A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

          Valid values: true | false

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for each node in the replication group.

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • AuthTokenLastModifiedDate — (Date)

          The date the auth token was last modified

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true.

          You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at-rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • MemberClustersOutpostArns — (Array<String>)

          The outpost ARNs of the replication group's member clusters.

        • KmsKeyId — (String)

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

        • ARN — (String)

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

        • UserGroupIds — (Array<String>)

          The ID of the user group associated to the replication group.

        • LogDeliveryConfigurations — (Array<map>)

          Returns the destination, format and type of the logs.

          • LogType — (String)

            Refers to slow-log.

            Possible values include:
            • "slow-log"
          • DestinationType — (String)

            Returns the destination type, either cloudwatch-logs or kinesis-firehose.

            Possible values include:
            • "cloudwatch-logs"
            • "kinesis-firehose"
          • DestinationDetails — (map)

            Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

            • CloudWatchLogsDetails — (map)

              The configuration details of the CloudWatch Logs destination.

              • LogGroup — (String)

                The name of the CloudWatch Logs log group.

            • KinesisFirehoseDetails — (map)

              The configuration details of the Kinesis Data Firehose destination.

              • DeliveryStream — (String)

                The name of the Kinesis Data Firehose delivery stream.

          • LogFormat — (String)

            Returns the log format, either JSON or TEXT.

            Possible values include:
            • "text"
            • "json"
          • Status — (String)

            Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

            Possible values include:
            • "active"
            • "enabling"
            • "modifying"
            • "disabling"
            • "error"
          • Message — (String)

            Returns an error message for the log delivery configuration.

        • ReplicationGroupCreateTime — (Date)

          The date and time when the cluster was created.

Returns:

  • (AWS.Request) —

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

See Also:

elasticache.waitFor('replicationGroupDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the replicationGroupDeleted state by periodically calling the underlying ElastiCache.describeReplicationGroups() operation every 15 seconds (at most 40 times).

Examples:

Waiting for the replicationGroupDeleted state

var params = {
  // ... input parameters ...
};
elasticache.waitFor('replicationGroupDeleted', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • ReplicationGroupId — (String)

      The identifier for the replication group to be described. This parameter is not case sensitive.

      If you do not specify this parameter, information about all replication groups is returned.

    • MaxRecords — (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.

      Default: 100

      Constraints: minimum 20; maximum 100.

    • Marker — (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:

      • Marker — (String)

        Provides an identifier to allow retrieval of paginated results.

      • ReplicationGroups — (Array<map>)

        A list of replication groups. Each item in the list contains detailed information about one replication group.

        • ReplicationGroupId — (String)

          The identifier for the replication group.

        • Description — (String)

          The user supplied description of the replication group.

        • GlobalReplicationGroupInfo — (map)

          The name of the Global datastore and role of this replication group in the Global datastore.

          • GlobalReplicationGroupId — (String)

            The name of the Global datastore

          • GlobalReplicationGroupMemberRole — (String)

            The role of the replication group in a Global datastore. Can be primary or secondary.

        • Status — (String)

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

        • PendingModifiedValues — (map)

          A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

          • PrimaryClusterId — (String)

            The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.

          • AutomaticFailoverStatus — (String)

            Indicates the status of automatic failover for this Redis replication group.

            Possible values include:
            • "enabled"
            • "disabled"
          • Resharding — (map)

            The status of an online resharding operation.

            • SlotMigration — (map)

              Represents the progress of an online resharding operation.

              • ProgressPercentage — (Float)

                The percentage of the slot migration that is complete.

          • AuthTokenStatus — (String)

            The auth token status

            Possible values include:
            • "SETTING"
            • "ROTATING"
          • UserGroups — (map)

            The user group being modified.

            • UserGroupIdsToAdd — (Array<String>)

              The ID of the user group to add.

            • UserGroupIdsToRemove — (Array<String>)

              The ID of the user group to remove.

          • LogDeliveryConfigurations — (Array<map>)

            The log delivery configurations being modified

            • LogType — (String)

              Refers to slow-log.

              Possible values include:
              • "slow-log"
            • DestinationType — (String)

              Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

              Possible values include:
              • "cloudwatch-logs"
              • "kinesis-firehose"
            • DestinationDetails — (map)

              Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

              • CloudWatchLogsDetails — (map)

                The configuration details of the CloudWatch Logs destination.

                • LogGroup — (String)

                  The name of the CloudWatch Logs log group.

              • KinesisFirehoseDetails — (map)

                The configuration details of the Kinesis Data Firehose destination.

                • DeliveryStream — (String)

                  The name of the Kinesis Data Firehose delivery stream.

            • LogFormat — (String)

              Returns the log format, either JSON or TEXT

              Possible values include:
              • "text"
              • "json"
        • MemberClusters — (Array<String>)

          The names of all the cache clusters that are part of this replication group.

        • NodeGroups — (Array<map>)

          A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

          • NodeGroupId — (String)

            The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.

          • Status — (String)

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

          • PrimaryEndpoint — (map)

            The endpoint of the primary node in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • ReaderEndpoint — (map)

            The endpoint of the replica nodes in this node group (shard).

            • Address — (String)

              The DNS hostname of the cache node.

            • Port — (Integer)

              The port number that the cache engine is listening on.

          • Slots — (String)

            The keyspace for this node group (shard).

          • NodeGroupMembers — (Array<map>)

            A list containing information about individual nodes within the node group (shard).

            • CacheClusterId — (String)

              The ID of the cluster to which the node belongs.

            • CacheNodeId — (String)

              The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).

            • ReadEndpoint — (map)

              The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.

              • Address — (String)

                The DNS hostname of the cache node.

              • Port — (Integer)

                The port number that the cache engine is listening on.

            • PreferredAvailabilityZone — (String)

              The name of the Availability Zone in which the node is located.

            • PreferredOutpostArn — (String)

              The outpost ARN of the node group member.

            • CurrentRole — (String)

              The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.

        • SnapshottingClusterId — (String)

          The cluster ID that is used as the daily snapshot source for the replication group.

        • AutomaticFailover — (String)

          Indicates the status of automatic failover for this Redis replication group.

          Possible values include:
          • "enabled"
          • "disabled"
          • "enabling"
          • "disabling"
        • MultiAZ — (String)

          A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

          Possible values include:
          • "enabled"
          • "disabled"
        • ConfigurationEndpoint — (map)

          The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

          • Address — (String)

            The DNS hostname of the cache node.

          • Port — (Integer)

            The port number that the cache engine is listening on.

        • SnapshotRetentionLimit — (Integer)

          The number of days for which ElastiCache 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.

          If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

        • SnapshotWindow — (String)

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

          Example: 05:00-09:00

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

          Note: This parameter is only valid if the Engine parameter is redis.
        • ClusterEnabled — (Boolean)

          A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

          Valid values: true | false

        • CacheNodeType — (String)

          The name of the compute and memory capacity node type for each node in the replication group.

        • AuthTokenEnabled — (Boolean)

          A flag that enables using an AuthToken (password) when issuing Redis commands.

          Default: false

        • AuthTokenLastModifiedDate — (Date)

          The date the auth token was last modified

        • TransitEncryptionEnabled — (Boolean)

          A flag that enables in-transit encryption when set to true.

          You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • AtRestEncryptionEnabled — (Boolean)

          A flag that enables encryption at-rest when set to true.

          You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

          Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

          Default: false

        • MemberClustersOutpostArns — (Array<String>)

          The outpost ARNs of the replication group's member clusters.

        • KmsKeyId — (String)

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

        • ARN — (String)

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

        • UserGroupIds — (Array<String>)

          The ID of the user group associated to the replication group.

        • LogDeliveryConfigurations — (Array<map>)

          Returns the destination, format and type of the logs.

          • LogType — (String)

            Refers to slow-log.

            Possible values include:
            • "slow-log"
          • DestinationType — (String)

            Returns the destination type, either cloudwatch-logs or kinesis-firehose.

            Possible values include:
            • "cloudwatch-logs"
            • "kinesis-firehose"
          • DestinationDetails — (map)

            Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

            • CloudWatchLogsDetails — (map)

              The configuration details of the CloudWatch Logs destination.

              • LogGroup — (String)

                The name of the CloudWatch Logs log group.

            • KinesisFirehoseDetails — (map)

              The configuration details of the Kinesis Data Firehose destination.

              • DeliveryStream — (String)

                The name of the Kinesis Data Firehose delivery stream.

          • LogFormat — (String)

            Returns the log format, either JSON or TEXT.

            Possible values include:
            • "text"
            • "json"
          • Status — (String)

            Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

            Possible values include:
            • "active"
            • "enabling"
            • "modifying"
            • "disabling"
            • "error"
          • Message — (String)

            Returns an error message for the log delivery configuration.

        • ReplicationGroupCreateTime — (Date)

          The date and time when the cluster was created.

Returns:

  • (AWS.Request) —

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

See Also: