Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ElastiCache

Amazon ElastiCache

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.

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly config

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

middlewareStack

Methods

addTagsToResource

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

    Parameters

    Returns Promise<AddTagsToResourceCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: AddTagsToResourceCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<AddTagsToResourceCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

authorizeCacheSecurityGroupIngress

batchApplyUpdateAction

batchStopUpdateAction

completeMigration

copySnapshot

  • Makes a copy of an existing snapshot.

        <note>
            <p>This operation is valid for Redis only.</p>
         </note>
    
        <important>
            <p>Users or groups that have permissions to use the <code>CopySnapshot</code> 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 <code>CopySnapshot</code> operation.
                For more information about using IAM to control the use of ElastiCache operations, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html">Exporting Snapshots</a>
                and <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.html">Authentication & Access Control</a>.</p>
         </important>
    
        <p>You could receive the following error messages.</p>
        <p class="title">
            <b>Error Messages</b>
         </p>
         <ul>
            <li>
                <p>
                  <b>Error Message:</b>
                    The S3 bucket %s is outside of the region.</p>
                <p>
                  <b>Solution:</b>
                    Create an Amazon S3 bucket in the same region as your snapshot.
                    For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
            </li>
            <li>
                <p>
                  <b>Error Message:</b>
                    The S3 bucket %s does not exist.</p>
                <p>
                  <b>Solution:</b>
                    Create an Amazon S3 bucket in the same region as your snapshot.
                    For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
            </li>
            <li>
                <p>
                  <b>Error Message:</b>
                    The S3 bucket %s is not owned by the authenticated user.</p>
                <p>
                  <b>Solution:</b>
                    Create an Amazon S3 bucket in the same region as your snapshot.
                    For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
            </li>
            <li>
                <p>
                  <b>Error Message:</b>
                    The authenticated user does not have sufficient permissions to perform the desired activity.</p>
                <p>
                  <b>Solution:</b>
                    Contact your system administrator to get the needed permissions.</p>
            </li>
            <li>
                <p>
                  <b>Error Message:</b>
                    The S3 bucket %s already contains an object with key %s.</p>
                <p>
                  <b>Solution:</b>
                    Give the <code>TargetSnapshotName</code> a new and unique value.
                    If exporting a snapshot,
                    you could alternatively create a new Amazon S3 bucket
                    and use this same value for <code>TargetSnapshotName</code>.</p>
            </li>
            <li>
                <p>
                  <b>Error Message: </b>
                    ElastiCache has not been granted READ permissions %s on the S3 Bucket.</p>
                <p>
                  <b>Solution:</b>
                    Add List and Read permissions on the bucket.
                For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
            </li>
            <li>
                <p>
                  <b>Error Message: </b>
                    ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.</p>
                <p>
                  <b>Solution:</b>
                    Add Upload/Delete permissions on the bucket.
                    For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
            </li>
            <li>
                <p>
                  <b>Error Message: </b>
                    ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.</p>
                <p>
                  <b>Solution:</b>
                    Add View Permissions on the bucket.
                For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
            </li>
         </ul>
    

    Parameters

    Returns Promise<CopySnapshotCommandOutput>

  • Makes a copy of an existing snapshot.

    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.

    Parameters

    Returns void

  • Makes a copy of an existing snapshot.

    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.

    Parameters

    Returns void

  • Makes a copy of an existing snapshot.

        <note>
            <p>This operation is valid for Redis only.</p>
         </note>
    
        <important>
            <p>Users or groups that have permissions to use the <code>CopySnapshot</code> 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 <code>CopySnapshot</code> operation.
                For more information about using IAM to control the use of ElastiCache operations, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html">Exporting Snapshots</a>
                and <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.html">Authentication & Access Control</a>.</p>
         </important>
    
        <p>You could receive the following error messages.</p>
        <p class="title">
            <b>Error Messages</b>
         </p>
         <ul>
            <li>
                <p>
                  <b>Error Message:</b>
                    The S3 bucket %s is outside of the region.</p>
                <p>
                  <b>Solution:</b>
                    Create an Amazon S3 bucket in the same region as your snapshot.
                    For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
            </li>
            <li>
                <p>
                  <b>Error Message:</b>
                    The S3 bucket %s does not exist.</p>
                <p>
                  <b>Solution:</b>
                    Create an Amazon S3 bucket in the same region as your snapshot.
                    For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
            </li>
            <li>
                <p>
                  <b>Error Message:</b>
                    The S3 bucket %s is not owned by the authenticated user.</p>
                <p>
                  <b>Solution:</b>
                    Create an Amazon S3 bucket in the same region as your snapshot.
                    For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-create-s3-bucket">Step 1: Create an Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
            </li>
            <li>
                <p>
                  <b>Error Message:</b>
                    The authenticated user does not have sufficient permissions to perform the desired activity.</p>
                <p>
                  <b>Solution:</b>
                    Contact your system administrator to get the needed permissions.</p>
            </li>
            <li>
                <p>
                  <b>Error Message:</b>
                    The S3 bucket %s already contains an object with key %s.</p>
                <p>
                  <b>Solution:</b>
                    Give the <code>TargetSnapshotName</code> a new and unique value.
                    If exporting a snapshot,
                    you could alternatively create a new Amazon S3 bucket
                    and use this same value for <code>TargetSnapshotName</code>.</p>
            </li>
            <li>
                <p>
                  <b>Error Message: </b>
                    ElastiCache has not been granted READ permissions %s on the S3 Bucket.</p>
                <p>
                  <b>Solution:</b>
                    Add List and Read permissions on the bucket.
                For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
            </li>
            <li>
                <p>
                  <b>Error Message: </b>
                    ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.</p>
                <p>
                  <b>Solution:</b>
                    Add Upload/Delete permissions on the bucket.
                    For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
            </li>
            <li>
                <p>
                  <b>Error Message: </b>
                    ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.</p>
                <p>
                  <b>Solution:</b>
                    Add View Permissions on the bucket.
                For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the ElastiCache User Guide.</p>
            </li>
         </ul>
    

    Parameters

    • args: CopySnapshotCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<CopySnapshotCommandOutput>

  • Makes a copy of an existing snapshot.

    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.

    Parameters

    Returns void

  • Makes a copy of an existing snapshot.

    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.

    Parameters

    Returns void

createCacheCluster

createCacheParameterGroup

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

    Parameters

    Returns Promise<CreateCacheParameterGroupCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: CreateCacheParameterGroupCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<CreateCacheParameterGroupCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

createCacheSecurityGroup

createCacheSubnetGroup

createGlobalReplicationGroup

  • 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 <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html">Replication Across Regions Using Global Datastore</a>. </p>
    
         <ul>
            <li>
               <p>The <b>GlobalReplicationGroupIdSuffix</b> is the name of the Global datastore.</p>
            </li>
            <li>
               <p>The <b>PrimaryReplicationGroupId</b> represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.</p>
            </li>
         </ul>
    

    Parameters

    Returns Promise<CreateGlobalReplicationGroupCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

  • 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 <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html">Replication Across Regions Using Global Datastore</a>. </p>
    
         <ul>
            <li>
               <p>The <b>GlobalReplicationGroupIdSuffix</b> is the name of the Global datastore.</p>
            </li>
            <li>
               <p>The <b>PrimaryReplicationGroupId</b> represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.</p>
            </li>
         </ul>
    

    Parameters

    • args: CreateGlobalReplicationGroupCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<CreateGlobalReplicationGroupCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

createReplicationGroup

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

        </p>
        <p>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
            <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.Creating.html">Creating a Subnet Group</a>. For versions below 5.0.6,
            the limit is 250 per cluster.</p>
        <p>To request a limit increase, see
            <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">Amazon Service Limits</a>
            and choose the limit type <b>Nodes per cluster per instance type</b>. </p>
        <p>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 <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html">Scaling ElastiCache for Redis Clusters</a> in the <i>ElastiCache User Guide</i>.</p>
    
    
        <note>
            <p>This operation is valid for Redis only.</p>
         </note>
    

    Parameters

    Returns Promise<CreateReplicationGroupCommandOutput>

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

    This operation is valid for Redis only.

    Parameters

    Returns void

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

    This operation is valid for Redis only.

    Parameters

    Returns void

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

        </p>
        <p>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
            <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.Creating.html">Creating a Subnet Group</a>. For versions below 5.0.6,
            the limit is 250 per cluster.</p>
        <p>To request a limit increase, see
            <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">Amazon Service Limits</a>
            and choose the limit type <b>Nodes per cluster per instance type</b>. </p>
        <p>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 <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html">Scaling ElastiCache for Redis Clusters</a> in the <i>ElastiCache User Guide</i>.</p>
    
    
        <note>
            <p>This operation is valid for Redis only.</p>
         </note>
    

    Parameters

    • args: CreateReplicationGroupCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<CreateReplicationGroupCommandOutput>

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

    This operation is valid for Redis only.

    Parameters

    Returns void

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

    This operation is valid for Redis only.

    Parameters

    Returns void

createSnapshot

createUser

createUserGroup

decreaseNodeGroupsInGlobalReplicationGroup

decreaseReplicaCount

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

    Parameters

    Returns Promise<DecreaseReplicaCountCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: DecreaseReplicaCountCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DecreaseReplicaCountCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

deleteCacheCluster

  • 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

                <p>A cluster that is the last read replica of a replication group</p>
            </li>
            <li>
                <p>A cluster that is the primary node of a replication group</p>
            </li>
            <li>
                <p>A node group (shard) that has Multi-AZ mode enabled</p>
            </li>
            <li>
                <p>A cluster from a Redis (cluster mode enabled) replication group</p>
            </li>
            <li>
                <p>A cluster that is not in the <code>available</code> state</p>
            </li>
         </ul>
    

    Parameters

    Returns Promise<DeleteCacheClusterCommandOutput>

  • 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

    Parameters

    Returns void

  • 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

    Parameters

    Returns void

  • 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

                <p>A cluster that is the last read replica of a replication group</p>
            </li>
            <li>
                <p>A cluster that is the primary node of a replication group</p>
            </li>
            <li>
                <p>A node group (shard) that has Multi-AZ mode enabled</p>
            </li>
            <li>
                <p>A cluster from a Redis (cluster mode enabled) replication group</p>
            </li>
            <li>
                <p>A cluster that is not in the <code>available</code> state</p>
            </li>
         </ul>
    

    Parameters

    • args: DeleteCacheClusterCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeleteCacheClusterCommandOutput>

  • 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

    Parameters

    Returns void

  • 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

    Parameters

    Returns void

deleteCacheParameterGroup

deleteCacheSecurityGroup

deleteCacheSubnetGroup

deleteGlobalReplicationGroup

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

          <p>Since the Global Datastore has only a primary cluster, you can delete the Global Datastore
             while retaining the primary by setting <code>RetainPrimaryReplicationGroup=true</code>. 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.</p>
    
        <p>When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources;
            you cannot cancel or revert this operation.</p>
    

    Parameters

    Returns Promise<DeleteGlobalReplicationGroupCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

          <p>Since the Global Datastore has only a primary cluster, you can delete the Global Datastore
             while retaining the primary by setting <code>RetainPrimaryReplicationGroup=true</code>. 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.</p>
    
        <p>When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources;
            you cannot cancel or revert this operation.</p>
    

    Parameters

    • args: DeleteGlobalReplicationGroupCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeleteGlobalReplicationGroupCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

deleteReplicationGroup

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

    This operation is valid for Redis only.

    Parameters

    Returns Promise<DeleteReplicationGroupCommandOutput>

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

    This operation is valid for Redis only.

    Parameters

    Returns void

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

    This operation is valid for Redis only.

    Parameters

    Returns void

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

    This operation is valid for Redis only.

    Parameters

    • args: DeleteReplicationGroupCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeleteReplicationGroupCommandOutput>

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

    This operation is valid for Redis only.

    Parameters

    Returns void

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

    This operation is valid for Redis only.

    Parameters

    Returns void

deleteSnapshot

  • 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>
            <p>This operation is valid for Redis only.</p>
         </note>
    

    Parameters

    Returns Promise<DeleteSnapshotCommandOutput>

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

    This operation is valid for Redis only.

    Parameters

    Returns void

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

    This operation is valid for Redis only.

    Parameters

    Returns void

  • 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>
            <p>This operation is valid for Redis only.</p>
         </note>
    

    Parameters

    • args: DeleteSnapshotCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeleteSnapshotCommandOutput>

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

    This operation is valid for Redis only.

    Parameters

    Returns void

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

    This operation is valid for Redis only.

    Parameters

    Returns void

deleteUser

deleteUserGroup

describeCacheClusters

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

    Parameters

    Returns Promise<DescribeCacheClustersCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: DescribeCacheClustersCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DescribeCacheClustersCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

describeCacheEngineVersions

describeCacheParameterGroups

describeCacheParameters

describeCacheSecurityGroups

describeCacheSubnetGroups

describeEngineDefaultParameters

describeEvents

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

    Parameters

    Returns Promise<DescribeEventsCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: DescribeEventsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DescribeEventsCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

describeGlobalReplicationGroups

describeReplicationGroups

describeReservedCacheNodes

describeReservedCacheNodesOfferings

describeServiceUpdates

describeSnapshots

  • 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>
            <p>This operation is valid for Redis only.</p>
         </note>
    

    Parameters

    Returns Promise<DescribeSnapshotsCommandOutput>

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

    This operation is valid for Redis only.

    Parameters

    Returns void

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

    This operation is valid for Redis only.

    Parameters

    Returns void

  • 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>
            <p>This operation is valid for Redis only.</p>
         </note>
    

    Parameters

    • args: DescribeSnapshotsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DescribeSnapshotsCommandOutput>

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

    This operation is valid for Redis only.

    Parameters

    Returns void

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

    This operation is valid for Redis only.

    Parameters

    Returns void

describeUpdateActions

describeUserGroups

describeUsers

destroy

  • destroy(): void
  • Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

    Returns void

disassociateGlobalReplicationGroup

failoverGlobalReplicationGroup

increaseNodeGroupsInGlobalReplicationGroup

increaseReplicaCount