/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the elasticache-2015-02-02.normal.json service model. */ using System; using System.Threading; using System.Threading.Tasks; using System.Collections.Generic; using Amazon.Runtime; using Amazon.ElastiCache.Model; namespace Amazon.ElastiCache { /// /// Interface for accessing 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. /// /// public partial interface IAmazonElastiCache : IAmazonService, IDisposable { /// /// Paginators for the service /// IElastiCachePaginatorFactory Paginators { get; } #region 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. /// /// /// Container for the necessary parameters to execute the AddTagsToResource service method. /// /// The response from the AddTagsToResource service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// The requested cache subnet group name does not refer to an existing cache subnet group. /// /// /// The requested Amazon Resource Name (ARN) does not refer to an existing resource. /// /// /// The requested replication group is not in the available state. /// /// /// The specified replication group does not exist. /// /// /// The requested reserved cache node was not found. /// /// /// The requested snapshot name does not refer to an existing snapshot. /// /// /// The request cannot be processed because it would cause the resource to have more than /// the allowed number of tags. The maximum number of tags permitted on a resource is /// 50. /// /// /// The user group was not found or does not exist /// /// /// The user does not exist or could not be found. /// /// REST API Reference for AddTagsToResource Operation AddTagsToResourceResponse AddTagsToResource(AddTagsToResourceRequest 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. /// /// /// Container for the necessary parameters to execute the AddTagsToResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the AddTagsToResource service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// The requested cache subnet group name does not refer to an existing cache subnet group. /// /// /// The requested Amazon Resource Name (ARN) does not refer to an existing resource. /// /// /// The requested replication group is not in the available state. /// /// /// The specified replication group does not exist. /// /// /// The requested reserved cache node was not found. /// /// /// The requested snapshot name does not refer to an existing snapshot. /// /// /// The request cannot be processed because it would cause the resource to have more than /// the allowed number of tags. The maximum number of tags permitted on a resource is /// 50. /// /// /// The user group was not found or does not exist /// /// /// The user does not exist or could not be found. /// /// REST API Reference for AddTagsToResource Operation Task AddTagsToResourceAsync(AddTagsToResourceRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region AuthorizeCacheSecurityGroupIngress /// /// 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. /// /// /// /// You cannot authorize ingress from an Amazon EC2 security group in one region to an /// ElastiCache cluster in another region. /// /// /// /// Container for the necessary parameters to execute the AuthorizeCacheSecurityGroupIngress service method. /// /// The response from the AuthorizeCacheSecurityGroupIngress service method, as returned by ElastiCache. /// /// The specified Amazon EC2 security group is already authorized for the specified cache /// security group. /// /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// The current state of the cache security group does not allow deletion. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for AuthorizeCacheSecurityGroupIngress Operation AuthorizeCacheSecurityGroupIngressResponse AuthorizeCacheSecurityGroupIngress(AuthorizeCacheSecurityGroupIngressRequest 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. /// /// /// /// You cannot authorize ingress from an Amazon EC2 security group in one region to an /// ElastiCache cluster in another region. /// /// /// /// Container for the necessary parameters to execute the AuthorizeCacheSecurityGroupIngress service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the AuthorizeCacheSecurityGroupIngress service method, as returned by ElastiCache. /// /// The specified Amazon EC2 security group is already authorized for the specified cache /// security group. /// /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// The current state of the cache security group does not allow deletion. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for AuthorizeCacheSecurityGroupIngress Operation Task AuthorizeCacheSecurityGroupIngressAsync(AuthorizeCacheSecurityGroupIngressRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region BatchApplyUpdateAction /// /// Apply the service update. For more information on service updates and applying them, /// see Applying /// Service Updates. /// /// Container for the necessary parameters to execute the BatchApplyUpdateAction service method. /// /// The response from the BatchApplyUpdateAction service method, as returned by ElastiCache. /// /// The value for a parameter is invalid. /// /// /// The service update doesn't exist /// /// REST API Reference for BatchApplyUpdateAction Operation BatchApplyUpdateActionResponse BatchApplyUpdateAction(BatchApplyUpdateActionRequest request); /// /// Apply the service update. For more information on service updates and applying them, /// see Applying /// Service Updates. /// /// Container for the necessary parameters to execute the BatchApplyUpdateAction service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the BatchApplyUpdateAction service method, as returned by ElastiCache. /// /// The value for a parameter is invalid. /// /// /// The service update doesn't exist /// /// REST API Reference for BatchApplyUpdateAction Operation Task BatchApplyUpdateActionAsync(BatchApplyUpdateActionRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region BatchStopUpdateAction /// /// Stop the service update. For more information on service updates and stopping them, /// see Stopping /// Service Updates. /// /// Container for the necessary parameters to execute the BatchStopUpdateAction service method. /// /// The response from the BatchStopUpdateAction service method, as returned by ElastiCache. /// /// The value for a parameter is invalid. /// /// /// The service update doesn't exist /// /// REST API Reference for BatchStopUpdateAction Operation BatchStopUpdateActionResponse BatchStopUpdateAction(BatchStopUpdateActionRequest request); /// /// Stop the service update. For more information on service updates and stopping them, /// see Stopping /// Service Updates. /// /// Container for the necessary parameters to execute the BatchStopUpdateAction service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the BatchStopUpdateAction service method, as returned by ElastiCache. /// /// The value for a parameter is invalid. /// /// /// The service update doesn't exist /// /// REST API Reference for BatchStopUpdateAction Operation Task BatchStopUpdateActionAsync(BatchStopUpdateActionRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CompleteMigration /// /// Complete the migration of data. /// /// Container for the necessary parameters to execute the CompleteMigration service method. /// /// The response from the CompleteMigration service method, as returned by ElastiCache. /// /// The requested replication group is not in the available state. /// /// /// The specified replication group does not exist. /// /// /// The designated replication group is not available for data migration. /// /// REST API Reference for CompleteMigration Operation CompleteMigrationResponse CompleteMigration(CompleteMigrationRequest request); /// /// Complete the migration of data. /// /// Container for the necessary parameters to execute the CompleteMigration service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CompleteMigration service method, as returned by ElastiCache. /// /// The requested replication group is not in the available state. /// /// /// The specified replication group does not exist. /// /// /// The designated replication group is not available for data migration. /// /// REST API Reference for CompleteMigration Operation Task CompleteMigrationAsync(CompleteMigrationRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CopySnapshot /// /// 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. /// ///
///
/// Container for the necessary parameters to execute the CopySnapshot service method. /// /// The response from the CopySnapshot service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The current state of the snapshot does not allow the requested operation to occur. /// /// /// You already have a snapshot with the given name. /// /// /// The requested snapshot name does not refer to an existing snapshot. /// /// /// The request cannot be processed because it would exceed the maximum number of snapshots. /// /// /// The request cannot be processed because it would cause the resource to have more than /// the allowed number of tags. The maximum number of tags permitted on a resource is /// 50. /// /// REST API Reference for CopySnapshot Operation CopySnapshotResponse CopySnapshot(CopySnapshotRequest request); /// /// 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. /// ///
///
/// Container for the necessary parameters to execute the CopySnapshot service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CopySnapshot service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The current state of the snapshot does not allow the requested operation to occur. /// /// /// You already have a snapshot with the given name. /// /// /// The requested snapshot name does not refer to an existing snapshot. /// /// /// The request cannot be processed because it would exceed the maximum number of snapshots. /// /// /// The request cannot be processed because it would cause the resource to have more than /// the allowed number of tags. The maximum number of tags permitted on a resource is /// 50. /// /// REST API Reference for CopySnapshot Operation Task CopySnapshotAsync(CopySnapshotRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateCacheCluster /// /// 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. /// /// /// Container for the necessary parameters to execute the CreateCacheCluster service method. /// /// The response from the CreateCacheCluster service method, as returned by ElastiCache. /// /// You already have a cluster with the given identifier. /// /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// The requested cache subnet group name does not refer to an existing cache subnet group. /// /// /// The request cannot be processed because it would exceed the allowed number of clusters /// per customer. /// /// /// The requested cache node type is not available in the specified Availability Zone. /// For more information, see InsufficientCacheClusterCapacity /// in the ElastiCache User Guide. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested replication group is not in the available state. /// /// /// The VPC network is in an invalid state. /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// nodes in a single cluster. /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// nodes per customer. /// /// /// The specified replication group does not exist. /// /// /// The request cannot be processed because it would cause the resource to have more than /// the allowed number of tags. The maximum number of tags permitted on a resource is /// 50. /// /// REST API Reference for CreateCacheCluster Operation CreateCacheClusterResponse CreateCacheCluster(CreateCacheClusterRequest 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. /// /// /// Container for the necessary parameters to execute the CreateCacheCluster service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateCacheCluster service method, as returned by ElastiCache. /// /// You already have a cluster with the given identifier. /// /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// The requested cache subnet group name does not refer to an existing cache subnet group. /// /// /// The request cannot be processed because it would exceed the allowed number of clusters /// per customer. /// /// /// The requested cache node type is not available in the specified Availability Zone. /// For more information, see InsufficientCacheClusterCapacity /// in the ElastiCache User Guide. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested replication group is not in the available state. /// /// /// The VPC network is in an invalid state. /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// nodes in a single cluster. /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// nodes per customer. /// /// /// The specified replication group does not exist. /// /// /// The request cannot be processed because it would cause the resource to have more than /// the allowed number of tags. The maximum number of tags permitted on a resource is /// 50. /// /// REST API Reference for CreateCacheCluster Operation Task CreateCacheClusterAsync(CreateCacheClusterRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region 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: /// /// /// /// Container for the necessary parameters to execute the CreateCacheParameterGroup service method. /// /// The response from the CreateCacheParameterGroup service method, as returned by ElastiCache. /// /// A cache parameter group with the requested name already exists. /// /// /// The request cannot be processed because it would exceed the maximum number of cache /// security groups. /// /// /// The current state of the cache parameter group does not allow the requested operation /// to occur. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The request cannot be processed because it would cause the resource to have more than /// the allowed number of tags. The maximum number of tags permitted on a resource is /// 50. /// /// REST API Reference for CreateCacheParameterGroup Operation CreateCacheParameterGroupResponse CreateCacheParameterGroup(CreateCacheParameterGroupRequest 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: /// /// /// /// Container for the necessary parameters to execute the CreateCacheParameterGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateCacheParameterGroup service method, as returned by ElastiCache. /// /// A cache parameter group with the requested name already exists. /// /// /// The request cannot be processed because it would exceed the maximum number of cache /// security groups. /// /// /// The current state of the cache parameter group does not allow the requested operation /// to occur. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The request cannot be processed because it would cause the resource to have more than /// the allowed number of tags. The maximum number of tags permitted on a resource is /// 50. /// /// REST API Reference for CreateCacheParameterGroup Operation Task CreateCacheParameterGroupAsync(CreateCacheParameterGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateCacheSecurityGroup /// /// 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. /// /// /// Container for the necessary parameters to execute the CreateCacheSecurityGroup service method. /// /// The response from the CreateCacheSecurityGroup service method, as returned by ElastiCache. /// /// A cache security group with the specified name already exists. /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// security groups. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The request cannot be processed because it would cause the resource to have more than /// the allowed number of tags. The maximum number of tags permitted on a resource is /// 50. /// /// REST API Reference for CreateCacheSecurityGroup Operation CreateCacheSecurityGroupResponse CreateCacheSecurityGroup(CreateCacheSecurityGroupRequest 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. /// /// /// Container for the necessary parameters to execute the CreateCacheSecurityGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateCacheSecurityGroup service method, as returned by ElastiCache. /// /// A cache security group with the specified name already exists. /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// security groups. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The request cannot be processed because it would cause the resource to have more than /// the allowed number of tags. The maximum number of tags permitted on a resource is /// 50. /// /// REST API Reference for CreateCacheSecurityGroup Operation Task CreateCacheSecurityGroupAsync(CreateCacheSecurityGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateCacheSubnetGroup /// /// Creates a new cache subnet group. /// /// /// /// Use this parameter only when you are creating a cluster in an Amazon Virtual Private /// Cloud (Amazon VPC). /// /// /// Container for the necessary parameters to execute the CreateCacheSubnetGroup service method. /// /// The response from the CreateCacheSubnetGroup service method, as returned by ElastiCache. /// /// The requested cache subnet group name is already in use by an existing cache subnet /// group. /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// subnet groups. /// /// /// The request cannot be processed because it would exceed the allowed number of subnets /// in a cache subnet group. /// /// /// An invalid subnet identifier was specified. /// /// /// At least one subnet ID does not match the other subnet IDs. This mismatch typically /// occurs when a user sets one subnet ID to a regional Availability Zone and a different /// one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed /// on this service. /// /// /// The request cannot be processed because it would cause the resource to have more than /// the allowed number of tags. The maximum number of tags permitted on a resource is /// 50. /// /// REST API Reference for CreateCacheSubnetGroup Operation CreateCacheSubnetGroupResponse CreateCacheSubnetGroup(CreateCacheSubnetGroupRequest 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). /// /// /// Container for the necessary parameters to execute the CreateCacheSubnetGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateCacheSubnetGroup service method, as returned by ElastiCache. /// /// The requested cache subnet group name is already in use by an existing cache subnet /// group. /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// subnet groups. /// /// /// The request cannot be processed because it would exceed the allowed number of subnets /// in a cache subnet group. /// /// /// An invalid subnet identifier was specified. /// /// /// At least one subnet ID does not match the other subnet IDs. This mismatch typically /// occurs when a user sets one subnet ID to a regional Availability Zone and a different /// one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed /// on this service. /// /// /// The request cannot be processed because it would cause the resource to have more than /// the allowed number of tags. The maximum number of tags permitted on a resource is /// 50. /// /// REST API Reference for CreateCacheSubnetGroup Operation Task CreateCacheSubnetGroupAsync(CreateCacheSubnetGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region 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 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. /// ///
///
/// Container for the necessary parameters to execute the CreateGlobalReplicationGroup service method. /// /// The response from the CreateGlobalReplicationGroup service method, as returned by ElastiCache. /// /// The Global datastore name already exists. /// /// /// The value for a parameter is invalid. /// /// /// The requested replication group is not in the available state. /// /// /// The specified replication group does not exist. /// /// /// The specified service linked role (SLR) was not found. /// /// REST API Reference for CreateGlobalReplicationGroup Operation CreateGlobalReplicationGroupResponse CreateGlobalReplicationGroup(CreateGlobalReplicationGroupRequest 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. /// ///
///
/// Container for the necessary parameters to execute the CreateGlobalReplicationGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateGlobalReplicationGroup service method, as returned by ElastiCache. /// /// The Global datastore name already exists. /// /// /// The value for a parameter is invalid. /// /// /// The requested replication group is not in the available state. /// /// /// The specified replication group does not exist. /// /// /// The specified service linked role (SLR) was not found. /// /// REST API Reference for CreateGlobalReplicationGroup Operation Task CreateGlobalReplicationGroupAsync(CreateGlobalReplicationGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region 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. /// /// /// /// 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. /// /// /// /// Container for the necessary parameters to execute the CreateReplicationGroup service method. /// /// The response from the CreateReplicationGroup service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// The requested cache subnet group name does not refer to an existing cache subnet group. /// /// /// The request cannot be processed because it would exceed the allowed number of clusters /// per customer. /// /// /// The Global datastore does not exist /// /// /// The requested cache node type is not available in the specified Availability Zone. /// For more information, see InsufficientCacheClusterCapacity /// in the ElastiCache User Guide. /// /// /// The requested cluster is not in the available state. /// /// /// The Global datastore is not available or in primary-only state. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The user group is not in an active state. /// /// /// The VPC network is in an invalid state. /// /// /// The request cannot be processed because it would exceed the maximum allowed number /// of node groups (shards) in a single replication group. The default maximum is 90 /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// nodes in a single cluster. /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// nodes per customer. /// /// /// The specified replication group already exists. /// /// /// The request cannot be processed because it would cause the resource to have more than /// the allowed number of tags. The maximum number of tags permitted on a resource is /// 50. /// /// /// The user group was not found or does not exist /// /// REST API Reference for CreateReplicationGroup Operation CreateReplicationGroupResponse CreateReplicationGroup(CreateReplicationGroupRequest 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. /// /// /// /// This operation is valid for Redis only. /// /// /// /// Container for the necessary parameters to execute the CreateReplicationGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateReplicationGroup service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// The requested cache subnet group name does not refer to an existing cache subnet group. /// /// /// The request cannot be processed because it would exceed the allowed number of clusters /// per customer. /// /// /// The Global datastore does not exist /// /// /// The requested cache node type is not available in the specified Availability Zone. /// For more information, see InsufficientCacheClusterCapacity /// in the ElastiCache User Guide. /// /// /// The requested cluster is not in the available state. /// /// /// The Global datastore is not available or in primary-only state. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The user group is not in an active state. /// /// /// The VPC network is in an invalid state. /// /// /// The request cannot be processed because it would exceed the maximum allowed number /// of node groups (shards) in a single replication group. The default maximum is 90 /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// nodes in a single cluster. /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// nodes per customer. /// /// /// The specified replication group already exists. /// /// /// The request cannot be processed because it would cause the resource to have more than /// the allowed number of tags. The maximum number of tags permitted on a resource is /// 50. /// /// /// The user group was not found or does not exist /// /// REST API Reference for CreateReplicationGroup Operation Task CreateReplicationGroupAsync(CreateReplicationGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateSnapshot /// /// Creates a copy of an entire cluster or replication group at a specific moment in time. /// /// /// /// This operation is valid for Redis only. /// /// /// /// Container for the necessary parameters to execute the CreateSnapshot service method. /// /// The response from the CreateSnapshot service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// The requested cluster is not in the available state. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested replication group is not in the available state. /// /// /// The specified replication group does not exist. /// /// /// You already have a snapshot with the given name. /// /// /// You attempted one of the following operations: /// ///
  • /// /// Creating a snapshot of a Redis cluster running on a cache.t1.micro cache /// node. /// ///
  • /// /// Creating a snapshot of a cluster that is running Memcached rather than Redis. /// ///
/// /// Neither of these are supported by ElastiCache. /// ///
/// /// The request cannot be processed because it would exceed the maximum number of snapshots. /// /// /// The request cannot be processed because it would cause the resource to have more than /// the allowed number of tags. The maximum number of tags permitted on a resource is /// 50. /// /// REST API Reference for CreateSnapshot Operation CreateSnapshotResponse CreateSnapshot(CreateSnapshotRequest request); /// /// Creates a copy of an entire cluster or replication group at a specific moment in time. /// /// /// /// This operation is valid for Redis only. /// /// /// /// Container for the necessary parameters to execute the CreateSnapshot service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateSnapshot service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// The requested cluster is not in the available state. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested replication group is not in the available state. /// /// /// The specified replication group does not exist. /// /// /// You already have a snapshot with the given name. /// /// /// You attempted one of the following operations: /// ///
  • /// /// Creating a snapshot of a Redis cluster running on a cache.t1.micro cache /// node. /// ///
  • /// /// Creating a snapshot of a cluster that is running Memcached rather than Redis. /// ///
/// /// Neither of these are supported by ElastiCache. /// ///
/// /// The request cannot be processed because it would exceed the maximum number of snapshots. /// /// /// The request cannot be processed because it would cause the resource to have more than /// the allowed number of tags. The maximum number of tags permitted on a resource is /// 50. /// /// REST API Reference for CreateSnapshot Operation Task CreateSnapshotAsync(CreateSnapshotRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateUser /// /// For Redis engine version 6.0 onwards: Creates a Redis user. For more information, /// see Using /// Role Based Access Control (RBAC). /// /// Container for the necessary parameters to execute the CreateUser service method. /// /// The response from the CreateUser service method, as returned by ElastiCache. /// /// A user with this username already exists. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The specified service linked role (SLR) was not found. /// /// /// The request cannot be processed because it would cause the resource to have more than /// the allowed number of tags. The maximum number of tags permitted on a resource is /// 50. /// /// /// A user with this ID already exists. /// /// /// The quota of users has been exceeded. /// /// REST API Reference for CreateUser Operation CreateUserResponse CreateUser(CreateUserRequest request); /// /// For Redis engine version 6.0 onwards: Creates a Redis user. For more information, /// see Using /// Role Based Access Control (RBAC). /// /// Container for the necessary parameters to execute the CreateUser service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateUser service method, as returned by ElastiCache. /// /// A user with this username already exists. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The specified service linked role (SLR) was not found. /// /// /// The request cannot be processed because it would cause the resource to have more than /// the allowed number of tags. The maximum number of tags permitted on a resource is /// 50. /// /// /// A user with this ID already exists. /// /// /// The quota of users has been exceeded. /// /// REST API Reference for CreateUser Operation Task CreateUserAsync(CreateUserRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateUserGroup /// /// For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, /// see Using /// Role Based Access Control (RBAC) /// /// Container for the necessary parameters to execute the CreateUserGroup service method. /// /// The response from the CreateUserGroup service method, as returned by ElastiCache. /// /// You must add default user to a user group. /// /// /// A user with this username already exists. /// /// /// The value for a parameter is invalid. /// /// /// The specified service linked role (SLR) was not found. /// /// /// The request cannot be processed because it would cause the resource to have more than /// the allowed number of tags. The maximum number of tags permitted on a resource is /// 50. /// /// /// The user group with this ID already exists. /// /// /// The number of users exceeds the user group limit. /// /// /// The user does not exist or could not be found. /// /// REST API Reference for CreateUserGroup Operation CreateUserGroupResponse CreateUserGroup(CreateUserGroupRequest request); /// /// For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, /// see Using /// Role Based Access Control (RBAC) /// /// Container for the necessary parameters to execute the CreateUserGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateUserGroup service method, as returned by ElastiCache. /// /// You must add default user to a user group. /// /// /// A user with this username already exists. /// /// /// The value for a parameter is invalid. /// /// /// The specified service linked role (SLR) was not found. /// /// /// The request cannot be processed because it would cause the resource to have more than /// the allowed number of tags. The maximum number of tags permitted on a resource is /// 50. /// /// /// The user group with this ID already exists. /// /// /// The number of users exceeds the user group limit. /// /// /// The user does not exist or could not be found. /// /// REST API Reference for CreateUserGroup Operation Task CreateUserGroupAsync(CreateUserGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DecreaseNodeGroupsInGlobalReplicationGroup /// /// Decreases the number of node groups in a Global datastore /// /// Container for the necessary parameters to execute the DecreaseNodeGroupsInGlobalReplicationGroup service method. /// /// The response from the DecreaseNodeGroupsInGlobalReplicationGroup service method, as returned by ElastiCache. /// /// The Global datastore does not exist /// /// /// The Global datastore is not available or in primary-only state. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DecreaseNodeGroupsInGlobalReplicationGroup Operation DecreaseNodeGroupsInGlobalReplicationGroupResponse DecreaseNodeGroupsInGlobalReplicationGroup(DecreaseNodeGroupsInGlobalReplicationGroupRequest request); /// /// Decreases the number of node groups in a Global datastore /// /// Container for the necessary parameters to execute the DecreaseNodeGroupsInGlobalReplicationGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DecreaseNodeGroupsInGlobalReplicationGroup service method, as returned by ElastiCache. /// /// The Global datastore does not exist /// /// /// The Global datastore is not available or in primary-only state. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DecreaseNodeGroupsInGlobalReplicationGroup Operation Task DecreaseNodeGroupsInGlobalReplicationGroupAsync(DecreaseNodeGroupsInGlobalReplicationGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region 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. /// /// Container for the necessary parameters to execute the DecreaseReplicaCount service method. /// /// The response from the DecreaseReplicaCount service method, as returned by ElastiCache. /// /// The request cannot be processed because it would exceed the allowed number of clusters /// per customer. /// /// /// The requested cache node type is not available in the specified Availability Zone. /// For more information, see InsufficientCacheClusterCapacity /// in the ElastiCache User Guide. /// /// /// The requested cluster is not in the available state. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested replication group is not in the available state. /// /// /// The VPC network is in an invalid state. /// /// /// The request cannot be processed because it would exceed the maximum allowed number /// of node groups (shards) in a single replication group. The default maximum is 90 /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// nodes per customer. /// /// /// The operation was not performed because no changes were required. /// /// /// The specified replication group does not exist. /// /// /// The specified service linked role (SLR) was not found. /// /// REST API Reference for DecreaseReplicaCount Operation DecreaseReplicaCountResponse DecreaseReplicaCount(DecreaseReplicaCountRequest 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. /// /// Container for the necessary parameters to execute the DecreaseReplicaCount service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DecreaseReplicaCount service method, as returned by ElastiCache. /// /// The request cannot be processed because it would exceed the allowed number of clusters /// per customer. /// /// /// The requested cache node type is not available in the specified Availability Zone. /// For more information, see InsufficientCacheClusterCapacity /// in the ElastiCache User Guide. /// /// /// The requested cluster is not in the available state. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested replication group is not in the available state. /// /// /// The VPC network is in an invalid state. /// /// /// The request cannot be processed because it would exceed the maximum allowed number /// of node groups (shards) in a single replication group. The default maximum is 90 /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// nodes per customer. /// /// /// The operation was not performed because no changes were required. /// /// /// The specified replication group does not exist. /// /// /// The specified service linked role (SLR) was not found. /// /// REST API Reference for DecreaseReplicaCount Operation Task DecreaseReplicaCountAsync(DecreaseReplicaCountRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region 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 /// ///
  • /// /// 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 /// ///
///
/// Container for the necessary parameters to execute the DeleteCacheCluster service method. /// /// The response from the DeleteCacheCluster service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// The requested cluster is not in the available state. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// You already have a snapshot with the given name. /// /// /// You attempted one of the following operations: /// ///
  • /// /// Creating a snapshot of a Redis cluster running on a cache.t1.micro cache /// node. /// ///
  • /// /// Creating a snapshot of a cluster that is running Memcached rather than Redis. /// ///
/// /// Neither of these are supported by ElastiCache. /// ///
/// /// The request cannot be processed because it would exceed the maximum number of snapshots. /// /// REST API Reference for DeleteCacheCluster Operation DeleteCacheClusterResponse DeleteCacheCluster(DeleteCacheClusterRequest 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 /// ///
///
/// Container for the necessary parameters to execute the DeleteCacheCluster service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteCacheCluster service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// The requested cluster is not in the available state. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// You already have a snapshot with the given name. /// /// /// You attempted one of the following operations: /// ///
  • /// /// Creating a snapshot of a Redis cluster running on a cache.t1.micro cache /// node. /// ///
  • /// /// Creating a snapshot of a cluster that is running Memcached rather than Redis. /// ///
/// /// Neither of these are supported by ElastiCache. /// ///
/// /// The request cannot be processed because it would exceed the maximum number of snapshots. /// /// REST API Reference for DeleteCacheCluster Operation Task DeleteCacheClusterAsync(DeleteCacheClusterRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteCacheParameterGroup /// /// 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. /// /// Container for the necessary parameters to execute the DeleteCacheParameterGroup service method. /// /// The response from the DeleteCacheParameterGroup service method, as returned by ElastiCache. /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// The current state of the cache parameter group does not allow the requested operation /// to occur. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DeleteCacheParameterGroup Operation DeleteCacheParameterGroupResponse DeleteCacheParameterGroup(DeleteCacheParameterGroupRequest 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. /// /// Container for the necessary parameters to execute the DeleteCacheParameterGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteCacheParameterGroup service method, as returned by ElastiCache. /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// The current state of the cache parameter group does not allow the requested operation /// to occur. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DeleteCacheParameterGroup Operation Task DeleteCacheParameterGroupAsync(DeleteCacheParameterGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteCacheSecurityGroup /// /// Deletes a cache security group. /// /// /// /// You cannot delete a cache security group if it is associated with any clusters. /// /// /// /// Container for the necessary parameters to execute the DeleteCacheSecurityGroup service method. /// /// The response from the DeleteCacheSecurityGroup service method, as returned by ElastiCache. /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// The current state of the cache security group does not allow deletion. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DeleteCacheSecurityGroup Operation DeleteCacheSecurityGroupResponse DeleteCacheSecurityGroup(DeleteCacheSecurityGroupRequest request); /// /// Deletes a cache security group. /// /// /// /// You cannot delete a cache security group if it is associated with any clusters. /// /// /// /// Container for the necessary parameters to execute the DeleteCacheSecurityGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteCacheSecurityGroup service method, as returned by ElastiCache. /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// The current state of the cache security group does not allow deletion. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DeleteCacheSecurityGroup Operation Task DeleteCacheSecurityGroupAsync(DeleteCacheSecurityGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteCacheSubnetGroup /// /// Deletes a cache subnet group. /// /// /// /// You cannot delete a default cache subnet group or one that is associated with any /// clusters. /// /// /// /// Container for the necessary parameters to execute the DeleteCacheSubnetGroup service method. /// /// The response from the DeleteCacheSubnetGroup service method, as returned by ElastiCache. /// /// The requested cache subnet group is currently in use. /// /// /// The requested cache subnet group name does not refer to an existing cache subnet group. /// /// REST API Reference for DeleteCacheSubnetGroup Operation DeleteCacheSubnetGroupResponse DeleteCacheSubnetGroup(DeleteCacheSubnetGroupRequest request); /// /// Deletes a cache subnet group. /// /// /// /// You cannot delete a default cache subnet group or one that is associated with any /// clusters. /// /// /// /// Container for the necessary parameters to execute the DeleteCacheSubnetGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteCacheSubnetGroup service method, as returned by ElastiCache. /// /// The requested cache subnet group is currently in use. /// /// /// The requested cache subnet group name does not refer to an existing cache subnet group. /// /// REST API Reference for DeleteCacheSubnetGroup Operation Task DeleteCacheSubnetGroupAsync(DeleteCacheSubnetGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region 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. /// ///
/// /// 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. /// ///
/// Container for the necessary parameters to execute the DeleteGlobalReplicationGroup service method. /// /// The response from the DeleteGlobalReplicationGroup service method, as returned by ElastiCache. /// /// The Global datastore does not exist /// /// /// The Global datastore is not available or in primary-only state. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DeleteGlobalReplicationGroup Operation DeleteGlobalReplicationGroupResponse DeleteGlobalReplicationGroup(DeleteGlobalReplicationGroupRequest 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. /// ///
/// Container for the necessary parameters to execute the DeleteGlobalReplicationGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteGlobalReplicationGroup service method, as returned by ElastiCache. /// /// The Global datastore does not exist /// /// /// The Global datastore is not available or in primary-only state. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DeleteGlobalReplicationGroup Operation Task DeleteGlobalReplicationGroupAsync(DeleteGlobalReplicationGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region 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. /// /// /// /// Container for the necessary parameters to execute the DeleteReplicationGroup service method. /// /// The response from the DeleteReplicationGroup service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested replication group is not in the available state. /// /// /// The specified replication group does not exist. /// /// /// You already have a snapshot with the given name. /// /// /// You attempted one of the following operations: /// ///
  • /// /// Creating a snapshot of a Redis cluster running on a cache.t1.micro cache /// node. /// ///
  • /// /// Creating a snapshot of a cluster that is running Memcached rather than Redis. /// ///
/// /// Neither of these are supported by ElastiCache. /// ///
/// /// The request cannot be processed because it would exceed the maximum number of snapshots. /// /// REST API Reference for DeleteReplicationGroup Operation DeleteReplicationGroupResponse DeleteReplicationGroup(DeleteReplicationGroupRequest 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. /// /// /// /// This operation is valid for Redis only. /// /// /// /// Container for the necessary parameters to execute the DeleteReplicationGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteReplicationGroup service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested replication group is not in the available state. /// /// /// The specified replication group does not exist. /// /// /// You already have a snapshot with the given name. /// /// /// You attempted one of the following operations: /// ///
  • /// /// Creating a snapshot of a Redis cluster running on a cache.t1.micro cache /// node. /// ///
  • /// /// Creating a snapshot of a cluster that is running Memcached rather than Redis. /// ///
/// /// Neither of these are supported by ElastiCache. /// ///
/// /// The request cannot be processed because it would exceed the maximum number of snapshots. /// /// REST API Reference for DeleteReplicationGroup Operation Task DeleteReplicationGroupAsync(DeleteReplicationGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region 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. /// /// /// /// This operation is valid for Redis only. /// /// /// /// Container for the necessary parameters to execute the DeleteSnapshot service method. /// /// The response from the DeleteSnapshot service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The current state of the snapshot does not allow the requested operation to occur. /// /// /// The requested snapshot name does not refer to an existing snapshot. /// /// REST API Reference for DeleteSnapshot Operation DeleteSnapshotResponse DeleteSnapshot(DeleteSnapshotRequest 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. /// /// /// /// This operation is valid for Redis only. /// /// /// /// Container for the necessary parameters to execute the DeleteSnapshot service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteSnapshot service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The current state of the snapshot does not allow the requested operation to occur. /// /// /// The requested snapshot name does not refer to an existing snapshot. /// /// REST API Reference for DeleteSnapshot Operation Task DeleteSnapshotAsync(DeleteSnapshotRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteUser /// /// For Redis engine version 6.0 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). /// /// Container for the necessary parameters to execute the DeleteUser service method. /// /// The response from the DeleteUser service method, as returned by ElastiCache. /// /// The default user assigned to the user group. /// /// /// The value for a parameter is invalid. /// /// /// The user is not in active state. /// /// /// The specified service linked role (SLR) was not found. /// /// /// The user does not exist or could not be found. /// /// REST API Reference for DeleteUser Operation DeleteUserResponse DeleteUser(DeleteUserRequest request); /// /// For Redis engine version 6.0 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). /// /// Container for the necessary parameters to execute the DeleteUser service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteUser service method, as returned by ElastiCache. /// /// The default user assigned to the user group. /// /// /// The value for a parameter is invalid. /// /// /// The user is not in active state. /// /// /// The specified service linked role (SLR) was not found. /// /// /// The user does not exist or could not be found. /// /// REST API Reference for DeleteUser Operation Task DeleteUserAsync(DeleteUserRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteUserGroup /// /// For Redis engine version 6.0 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). /// /// Container for the necessary parameters to execute the DeleteUserGroup service method. /// /// The response from the DeleteUserGroup service method, as returned by ElastiCache. /// /// The value for a parameter is invalid. /// /// /// The user group is not in an active state. /// /// /// The specified service linked role (SLR) was not found. /// /// /// The user group was not found or does not exist /// /// REST API Reference for DeleteUserGroup Operation DeleteUserGroupResponse DeleteUserGroup(DeleteUserGroupRequest request); /// /// For Redis engine version 6.0 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). /// /// Container for the necessary parameters to execute the DeleteUserGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteUserGroup service method, as returned by ElastiCache. /// /// The value for a parameter is invalid. /// /// /// The user group is not in an active state. /// /// /// The specified service linked role (SLR) was not found. /// /// /// The user group was not found or does not exist /// /// REST API Reference for DeleteUserGroup Operation Task DeleteUserGroupAsync(DeleteUserGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region 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. /// /// /// /// The response from the DescribeCacheClusters service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeCacheClusters Operation DescribeCacheClustersResponse 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. /// /// /// Container for the necessary parameters to execute the DescribeCacheClusters service method. /// /// The response from the DescribeCacheClusters service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeCacheClusters Operation DescribeCacheClustersResponse DescribeCacheClusters(DescribeCacheClustersRequest 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. /// /// /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeCacheClusters service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeCacheClusters Operation Task DescribeCacheClustersAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken)); /// /// 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. /// /// /// Container for the necessary parameters to execute the DescribeCacheClusters service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeCacheClusters service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeCacheClusters Operation Task DescribeCacheClustersAsync(DescribeCacheClustersRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeCacheEngineVersions /// /// Returns a list of the available cache engines and their versions. /// /// /// The response from the DescribeCacheEngineVersions service method, as returned by ElastiCache. /// REST API Reference for DescribeCacheEngineVersions Operation DescribeCacheEngineVersionsResponse DescribeCacheEngineVersions(); /// /// Returns a list of the available cache engines and their versions. /// /// Container for the necessary parameters to execute the DescribeCacheEngineVersions service method. /// /// The response from the DescribeCacheEngineVersions service method, as returned by ElastiCache. /// REST API Reference for DescribeCacheEngineVersions Operation DescribeCacheEngineVersionsResponse DescribeCacheEngineVersions(DescribeCacheEngineVersionsRequest request); /// /// Returns a list of the available cache engines and their versions. /// /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeCacheEngineVersions service method, as returned by ElastiCache. /// REST API Reference for DescribeCacheEngineVersions Operation Task DescribeCacheEngineVersionsAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken)); /// /// Returns a list of the available cache engines and their versions. /// /// Container for the necessary parameters to execute the DescribeCacheEngineVersions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeCacheEngineVersions service method, as returned by ElastiCache. /// REST API Reference for DescribeCacheEngineVersions Operation Task DescribeCacheEngineVersionsAsync(DescribeCacheEngineVersionsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeCacheParameterGroups /// /// 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. /// /// /// The response from the DescribeCacheParameterGroups service method, as returned by ElastiCache. /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeCacheParameterGroups Operation DescribeCacheParameterGroupsResponse DescribeCacheParameterGroups(); /// /// 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. /// /// Container for the necessary parameters to execute the DescribeCacheParameterGroups service method. /// /// The response from the DescribeCacheParameterGroups service method, as returned by ElastiCache. /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeCacheParameterGroups Operation DescribeCacheParameterGroupsResponse DescribeCacheParameterGroups(DescribeCacheParameterGroupsRequest 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. /// /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeCacheParameterGroups service method, as returned by ElastiCache. /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeCacheParameterGroups Operation Task DescribeCacheParameterGroupsAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken)); /// /// 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. /// /// Container for the necessary parameters to execute the DescribeCacheParameterGroups service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeCacheParameterGroups service method, as returned by ElastiCache. /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeCacheParameterGroups Operation Task DescribeCacheParameterGroupsAsync(DescribeCacheParameterGroupsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeCacheParameters /// /// Returns the detailed parameter list for a particular cache parameter group. /// /// Container for the necessary parameters to execute the DescribeCacheParameters service method. /// /// The response from the DescribeCacheParameters service method, as returned by ElastiCache. /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeCacheParameters Operation DescribeCacheParametersResponse DescribeCacheParameters(DescribeCacheParametersRequest request); /// /// Returns the detailed parameter list for a particular cache parameter group. /// /// Container for the necessary parameters to execute the DescribeCacheParameters service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeCacheParameters service method, as returned by ElastiCache. /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeCacheParameters Operation Task DescribeCacheParametersAsync(DescribeCacheParametersRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeCacheSecurityGroups /// /// 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 /// /// /// The response from the DescribeCacheSecurityGroups service method, as returned by ElastiCache. /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeCacheSecurityGroups Operation DescribeCacheSecurityGroupsResponse DescribeCacheSecurityGroups(); /// /// 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 /// /// Container for the necessary parameters to execute the DescribeCacheSecurityGroups service method. /// /// The response from the DescribeCacheSecurityGroups service method, as returned by ElastiCache. /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeCacheSecurityGroups Operation DescribeCacheSecurityGroupsResponse DescribeCacheSecurityGroups(DescribeCacheSecurityGroupsRequest 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 /// /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeCacheSecurityGroups service method, as returned by ElastiCache. /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeCacheSecurityGroups Operation Task DescribeCacheSecurityGroupsAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken)); /// /// 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 /// /// Container for the necessary parameters to execute the DescribeCacheSecurityGroups service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeCacheSecurityGroups service method, as returned by ElastiCache. /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeCacheSecurityGroups Operation Task DescribeCacheSecurityGroupsAsync(DescribeCacheSecurityGroupsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeCacheSubnetGroups /// /// 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. /// /// /// The response from the DescribeCacheSubnetGroups service method, as returned by ElastiCache. /// /// The requested cache subnet group name does not refer to an existing cache subnet group. /// /// REST API Reference for DescribeCacheSubnetGroups Operation DescribeCacheSubnetGroupsResponse DescribeCacheSubnetGroups(); /// /// 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. /// /// Container for the necessary parameters to execute the DescribeCacheSubnetGroups service method. /// /// The response from the DescribeCacheSubnetGroups service method, as returned by ElastiCache. /// /// The requested cache subnet group name does not refer to an existing cache subnet group. /// /// REST API Reference for DescribeCacheSubnetGroups Operation DescribeCacheSubnetGroupsResponse DescribeCacheSubnetGroups(DescribeCacheSubnetGroupsRequest 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. /// /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeCacheSubnetGroups service method, as returned by ElastiCache. /// /// The requested cache subnet group name does not refer to an existing cache subnet group. /// /// REST API Reference for DescribeCacheSubnetGroups Operation Task DescribeCacheSubnetGroupsAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken)); /// /// 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. /// /// Container for the necessary parameters to execute the DescribeCacheSubnetGroups service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeCacheSubnetGroups service method, as returned by ElastiCache. /// /// The requested cache subnet group name does not refer to an existing cache subnet group. /// /// REST API Reference for DescribeCacheSubnetGroups Operation Task DescribeCacheSubnetGroupsAsync(DescribeCacheSubnetGroupsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeEngineDefaultParameters /// /// Returns the default engine and system parameter information for the specified cache /// engine. /// /// Container for the necessary parameters to execute the DescribeEngineDefaultParameters service method. /// /// The response from the DescribeEngineDefaultParameters service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeEngineDefaultParameters Operation DescribeEngineDefaultParametersResponse DescribeEngineDefaultParameters(DescribeEngineDefaultParametersRequest request); /// /// Returns the default engine and system parameter information for the specified cache /// engine. /// /// Container for the necessary parameters to execute the DescribeEngineDefaultParameters service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeEngineDefaultParameters service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeEngineDefaultParameters Operation Task DescribeEngineDefaultParametersAsync(DescribeEngineDefaultParametersRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region 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. /// /// /// /// The response from the DescribeEvents service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeEvents Operation DescribeEventsResponse 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. /// /// /// Container for the necessary parameters to execute the DescribeEvents service method. /// /// The response from the DescribeEvents service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeEvents Operation DescribeEventsResponse DescribeEvents(DescribeEventsRequest 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. /// /// /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeEvents service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeEvents Operation Task DescribeEventsAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken)); /// /// 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. /// /// /// Container for the necessary parameters to execute the DescribeEvents service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeEvents service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeEvents Operation Task DescribeEventsAsync(DescribeEventsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeGlobalReplicationGroups /// /// Returns information about a particular global replication group. If no identifier /// is specified, returns information about all Global datastores. /// /// Container for the necessary parameters to execute the DescribeGlobalReplicationGroups service method. /// /// The response from the DescribeGlobalReplicationGroups service method, as returned by ElastiCache. /// /// The Global datastore does not exist /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeGlobalReplicationGroups Operation DescribeGlobalReplicationGroupsResponse DescribeGlobalReplicationGroups(DescribeGlobalReplicationGroupsRequest request); /// /// Returns information about a particular global replication group. If no identifier /// is specified, returns information about all Global datastores. /// /// Container for the necessary parameters to execute the DescribeGlobalReplicationGroups service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeGlobalReplicationGroups service method, as returned by ElastiCache. /// /// The Global datastore does not exist /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeGlobalReplicationGroups Operation Task DescribeGlobalReplicationGroupsAsync(DescribeGlobalReplicationGroupsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeReplicationGroups /// /// Returns information about a particular replication group. If no identifier is specified, /// DescribeReplicationGroups returns information about all replication groups. /// /// /// /// This operation is valid for Redis only. /// /// /// /// /// The response from the DescribeReplicationGroups service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The specified replication group does not exist. /// /// REST API Reference for DescribeReplicationGroups Operation DescribeReplicationGroupsResponse DescribeReplicationGroups(); /// /// Returns information about a particular replication group. If no identifier is specified, /// DescribeReplicationGroups returns information about all replication groups. /// /// /// /// This operation is valid for Redis only. /// /// /// /// Container for the necessary parameters to execute the DescribeReplicationGroups service method. /// /// The response from the DescribeReplicationGroups service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The specified replication group does not exist. /// /// REST API Reference for DescribeReplicationGroups Operation DescribeReplicationGroupsResponse DescribeReplicationGroups(DescribeReplicationGroupsRequest request); /// /// Returns information about a particular replication group. If no identifier is specified, /// DescribeReplicationGroups returns information about all replication groups. /// /// /// /// This operation is valid for Redis only. /// /// /// /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeReplicationGroups service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The specified replication group does not exist. /// /// REST API Reference for DescribeReplicationGroups Operation Task DescribeReplicationGroupsAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken)); /// /// Returns information about a particular replication group. If no identifier is specified, /// DescribeReplicationGroups returns information about all replication groups. /// /// /// /// This operation is valid for Redis only. /// /// /// /// Container for the necessary parameters to execute the DescribeReplicationGroups service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeReplicationGroups service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The specified replication group does not exist. /// /// REST API Reference for DescribeReplicationGroups Operation Task DescribeReplicationGroupsAsync(DescribeReplicationGroupsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeReservedCacheNodes /// /// Returns information about reserved cache nodes for this account, or about a specified /// reserved cache node. /// /// /// The response from the DescribeReservedCacheNodes service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested reserved cache node was not found. /// /// REST API Reference for DescribeReservedCacheNodes Operation DescribeReservedCacheNodesResponse DescribeReservedCacheNodes(); /// /// Returns information about reserved cache nodes for this account, or about a specified /// reserved cache node. /// /// Container for the necessary parameters to execute the DescribeReservedCacheNodes service method. /// /// The response from the DescribeReservedCacheNodes service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested reserved cache node was not found. /// /// REST API Reference for DescribeReservedCacheNodes Operation DescribeReservedCacheNodesResponse DescribeReservedCacheNodes(DescribeReservedCacheNodesRequest request); /// /// Returns information about reserved cache nodes for this account, or about a specified /// reserved cache node. /// /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeReservedCacheNodes service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested reserved cache node was not found. /// /// REST API Reference for DescribeReservedCacheNodes Operation Task DescribeReservedCacheNodesAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken)); /// /// Returns information about reserved cache nodes for this account, or about a specified /// reserved cache node. /// /// Container for the necessary parameters to execute the DescribeReservedCacheNodes service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeReservedCacheNodes service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested reserved cache node was not found. /// /// REST API Reference for DescribeReservedCacheNodes Operation Task DescribeReservedCacheNodesAsync(DescribeReservedCacheNodesRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeReservedCacheNodesOfferings /// /// Lists available reserved cache node offerings. /// /// /// The response from the DescribeReservedCacheNodesOfferings service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested cache node offering does not exist. /// /// REST API Reference for DescribeReservedCacheNodesOfferings Operation DescribeReservedCacheNodesOfferingsResponse DescribeReservedCacheNodesOfferings(); /// /// Lists available reserved cache node offerings. /// /// Container for the necessary parameters to execute the DescribeReservedCacheNodesOfferings service method. /// /// The response from the DescribeReservedCacheNodesOfferings service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested cache node offering does not exist. /// /// REST API Reference for DescribeReservedCacheNodesOfferings Operation DescribeReservedCacheNodesOfferingsResponse DescribeReservedCacheNodesOfferings(DescribeReservedCacheNodesOfferingsRequest request); /// /// Lists available reserved cache node offerings. /// /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeReservedCacheNodesOfferings service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested cache node offering does not exist. /// /// REST API Reference for DescribeReservedCacheNodesOfferings Operation Task DescribeReservedCacheNodesOfferingsAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken)); /// /// Lists available reserved cache node offerings. /// /// Container for the necessary parameters to execute the DescribeReservedCacheNodesOfferings service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeReservedCacheNodesOfferings service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested cache node offering does not exist. /// /// REST API Reference for DescribeReservedCacheNodesOfferings Operation Task DescribeReservedCacheNodesOfferingsAsync(DescribeReservedCacheNodesOfferingsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeServiceUpdates /// /// Returns details of the service updates /// /// Container for the necessary parameters to execute the DescribeServiceUpdates service method. /// /// The response from the DescribeServiceUpdates service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The service update doesn't exist /// /// REST API Reference for DescribeServiceUpdates Operation DescribeServiceUpdatesResponse DescribeServiceUpdates(DescribeServiceUpdatesRequest request); /// /// Returns details of the service updates /// /// Container for the necessary parameters to execute the DescribeServiceUpdates service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeServiceUpdates service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The service update doesn't exist /// /// REST API Reference for DescribeServiceUpdates Operation Task DescribeServiceUpdatesAsync(DescribeServiceUpdatesRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region 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. /// /// /// /// This operation is valid for Redis only. /// /// /// /// /// The response from the DescribeSnapshots service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested snapshot name does not refer to an existing snapshot. /// /// REST API Reference for DescribeSnapshots Operation DescribeSnapshotsResponse 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. /// /// /// /// This operation is valid for Redis only. /// /// /// /// Container for the necessary parameters to execute the DescribeSnapshots service method. /// /// The response from the DescribeSnapshots service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested snapshot name does not refer to an existing snapshot. /// /// REST API Reference for DescribeSnapshots Operation DescribeSnapshotsResponse DescribeSnapshots(DescribeSnapshotsRequest 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. /// /// /// /// This operation is valid for Redis only. /// /// /// /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeSnapshots service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested snapshot name does not refer to an existing snapshot. /// /// REST API Reference for DescribeSnapshots Operation Task DescribeSnapshotsAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken)); /// /// 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. /// /// /// /// Container for the necessary parameters to execute the DescribeSnapshots service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeSnapshots service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested snapshot name does not refer to an existing snapshot. /// /// REST API Reference for DescribeSnapshots Operation Task DescribeSnapshotsAsync(DescribeSnapshotsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeUpdateActions /// /// Returns details of the update actions /// /// Container for the necessary parameters to execute the DescribeUpdateActions service method. /// /// The response from the DescribeUpdateActions service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeUpdateActions Operation DescribeUpdateActionsResponse DescribeUpdateActions(DescribeUpdateActionsRequest request); /// /// Returns details of the update actions /// /// Container for the necessary parameters to execute the DescribeUpdateActions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeUpdateActions service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DescribeUpdateActions Operation Task DescribeUpdateActionsAsync(DescribeUpdateActionsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeUserGroups /// /// Returns a list of user groups. /// /// Container for the necessary parameters to execute the DescribeUserGroups service method. /// /// The response from the DescribeUserGroups service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The specified service linked role (SLR) was not found. /// /// /// The user group was not found or does not exist /// /// REST API Reference for DescribeUserGroups Operation DescribeUserGroupsResponse DescribeUserGroups(DescribeUserGroupsRequest request); /// /// Returns a list of user groups. /// /// Container for the necessary parameters to execute the DescribeUserGroups service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeUserGroups service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The specified service linked role (SLR) was not found. /// /// /// The user group was not found or does not exist /// /// REST API Reference for DescribeUserGroups Operation Task DescribeUserGroupsAsync(DescribeUserGroupsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeUsers /// /// Returns a list of users. /// /// Container for the necessary parameters to execute the DescribeUsers service method. /// /// The response from the DescribeUsers service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The specified service linked role (SLR) was not found. /// /// /// The user does not exist or could not be found. /// /// REST API Reference for DescribeUsers Operation DescribeUsersResponse DescribeUsers(DescribeUsersRequest request); /// /// Returns a list of users. /// /// Container for the necessary parameters to execute the DescribeUsers service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeUsers service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The specified service linked role (SLR) was not found. /// /// /// The user does not exist or could not be found. /// /// REST API Reference for DescribeUsers Operation Task DescribeUsersAsync(DescribeUsersRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DisassociateGlobalReplicationGroup /// /// 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. /// /// Container for the necessary parameters to execute the DisassociateGlobalReplicationGroup service method. /// /// The response from the DisassociateGlobalReplicationGroup service method, as returned by ElastiCache. /// /// The Global datastore does not exist /// /// /// The Global datastore is not available or in primary-only state. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DisassociateGlobalReplicationGroup Operation DisassociateGlobalReplicationGroupResponse DisassociateGlobalReplicationGroup(DisassociateGlobalReplicationGroupRequest 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. /// /// Container for the necessary parameters to execute the DisassociateGlobalReplicationGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DisassociateGlobalReplicationGroup service method, as returned by ElastiCache. /// /// The Global datastore does not exist /// /// /// The Global datastore is not available or in primary-only state. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for DisassociateGlobalReplicationGroup Operation Task DisassociateGlobalReplicationGroupAsync(DisassociateGlobalReplicationGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region FailoverGlobalReplicationGroup /// /// Used to failover the primary region to a secondary region. The secondary region will /// become primary, and all other clusters will become secondary. /// /// Container for the necessary parameters to execute the FailoverGlobalReplicationGroup service method. /// /// The response from the FailoverGlobalReplicationGroup service method, as returned by ElastiCache. /// /// The Global datastore does not exist /// /// /// The Global datastore is not available or in primary-only state. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for FailoverGlobalReplicationGroup Operation FailoverGlobalReplicationGroupResponse FailoverGlobalReplicationGroup(FailoverGlobalReplicationGroupRequest request); /// /// Used to failover the primary region to a secondary region. The secondary region will /// become primary, and all other clusters will become secondary. /// /// Container for the necessary parameters to execute the FailoverGlobalReplicationGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the FailoverGlobalReplicationGroup service method, as returned by ElastiCache. /// /// The Global datastore does not exist /// /// /// The Global datastore is not available or in primary-only state. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for FailoverGlobalReplicationGroup Operation Task FailoverGlobalReplicationGroupAsync(FailoverGlobalReplicationGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region IncreaseNodeGroupsInGlobalReplicationGroup /// /// Increase the number of node groups in the Global datastore /// /// Container for the necessary parameters to execute the IncreaseNodeGroupsInGlobalReplicationGroup service method. /// /// The response from the IncreaseNodeGroupsInGlobalReplicationGroup service method, as returned by ElastiCache. /// /// The Global datastore does not exist /// /// /// The Global datastore is not available or in primary-only state. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for IncreaseNodeGroupsInGlobalReplicationGroup Operation IncreaseNodeGroupsInGlobalReplicationGroupResponse IncreaseNodeGroupsInGlobalReplicationGroup(IncreaseNodeGroupsInGlobalReplicationGroupRequest request); /// /// Increase the number of node groups in the Global datastore /// /// Container for the necessary parameters to execute the IncreaseNodeGroupsInGlobalReplicationGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the IncreaseNodeGroupsInGlobalReplicationGroup service method, as returned by ElastiCache. /// /// The Global datastore does not exist /// /// /// The Global datastore is not available or in primary-only state. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for IncreaseNodeGroupsInGlobalReplicationGroup Operation Task IncreaseNodeGroupsInGlobalReplicationGroupAsync(IncreaseNodeGroupsInGlobalReplicationGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region IncreaseReplicaCount /// /// 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. /// /// Container for the necessary parameters to execute the IncreaseReplicaCount service method. /// /// The response from the IncreaseReplicaCount service method, as returned by ElastiCache. /// /// The request cannot be processed because it would exceed the allowed number of clusters /// per customer. /// /// /// The requested cache node type is not available in the specified Availability Zone. /// For more information, see InsufficientCacheClusterCapacity /// in the ElastiCache User Guide. /// /// /// The requested cluster is not in the available state. /// /// /// The KMS key supplied is not valid. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested replication group is not in the available state. /// /// /// The VPC network is in an invalid state. /// /// /// The request cannot be processed because it would exceed the maximum allowed number /// of node groups (shards) in a single replication group. The default maximum is 90 /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// nodes per customer. /// /// /// The operation was not performed because no changes were required. /// /// /// The specified replication group does not exist. /// /// REST API Reference for IncreaseReplicaCount Operation IncreaseReplicaCountResponse IncreaseReplicaCount(IncreaseReplicaCountRequest 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. /// /// Container for the necessary parameters to execute the IncreaseReplicaCount service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the IncreaseReplicaCount service method, as returned by ElastiCache. /// /// The request cannot be processed because it would exceed the allowed number of clusters /// per customer. /// /// /// The requested cache node type is not available in the specified Availability Zone. /// For more information, see InsufficientCacheClusterCapacity /// in the ElastiCache User Guide. /// /// /// The requested cluster is not in the available state. /// /// /// The KMS key supplied is not valid. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested replication group is not in the available state. /// /// /// The VPC network is in an invalid state. /// /// /// The request cannot be processed because it would exceed the maximum allowed number /// of node groups (shards) in a single replication group. The default maximum is 90 /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// nodes per customer. /// /// /// The operation was not performed because no changes were required. /// /// /// The specified replication group does not exist. /// /// REST API Reference for IncreaseReplicaCount Operation Task IncreaseReplicaCountAsync(IncreaseReplicaCountRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListAllowedNodeTypeModifications /// /// 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. /// /// /// Container for the necessary parameters to execute the ListAllowedNodeTypeModifications service method. /// /// The response from the ListAllowedNodeTypeModifications service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The specified replication group does not exist. /// /// REST API Reference for ListAllowedNodeTypeModifications Operation ListAllowedNodeTypeModificationsResponse ListAllowedNodeTypeModifications(ListAllowedNodeTypeModificationsRequest 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. /// /// /// Container for the necessary parameters to execute the ListAllowedNodeTypeModifications service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListAllowedNodeTypeModifications service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The specified replication group does not exist. /// /// REST API Reference for ListAllowedNodeTypeModifications Operation Task ListAllowedNodeTypeModificationsAsync(ListAllowedNodeTypeModificationsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListTagsForResource /// /// 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. /// /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// The response from the ListTagsForResource service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// The requested cache subnet group name does not refer to an existing cache subnet group. /// /// /// The requested Amazon Resource Name (ARN) does not refer to an existing resource. /// /// /// The requested replication group is not in the available state. /// /// /// The specified replication group does not exist. /// /// /// The requested reserved cache node was not found. /// /// /// The requested snapshot name does not refer to an existing snapshot. /// /// /// The user group was not found or does not exist /// /// /// The user does not exist or could not be found. /// /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest 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. /// /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListTagsForResource service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// The requested cache subnet group name does not refer to an existing cache subnet group. /// /// /// The requested Amazon Resource Name (ARN) does not refer to an existing resource. /// /// /// The requested replication group is not in the available state. /// /// /// The specified replication group does not exist. /// /// /// The requested reserved cache node was not found. /// /// /// The requested snapshot name does not refer to an existing snapshot. /// /// /// The user group was not found or does not exist /// /// /// The user does not exist or could not be found. /// /// REST API Reference for ListTagsForResource Operation Task ListTagsForResourceAsync(ListTagsForResourceRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ModifyCacheCluster /// /// 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. /// /// Container for the necessary parameters to execute the ModifyCacheCluster service method. /// /// The response from the ModifyCacheCluster service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// The requested cache node type is not available in the specified Availability Zone. /// For more information, see InsufficientCacheClusterCapacity /// in the ElastiCache User Guide. /// /// /// The requested cluster is not in the available state. /// /// /// The current state of the cache security group does not allow deletion. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The VPC network is in an invalid state. /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// nodes in a single cluster. /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// nodes per customer. /// /// REST API Reference for ModifyCacheCluster Operation ModifyCacheClusterResponse ModifyCacheCluster(ModifyCacheClusterRequest 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. /// /// Container for the necessary parameters to execute the ModifyCacheCluster service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ModifyCacheCluster service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// The requested cache node type is not available in the specified Availability Zone. /// For more information, see InsufficientCacheClusterCapacity /// in the ElastiCache User Guide. /// /// /// The requested cluster is not in the available state. /// /// /// The current state of the cache security group does not allow deletion. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The VPC network is in an invalid state. /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// nodes in a single cluster. /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// nodes per customer. /// /// REST API Reference for ModifyCacheCluster Operation Task ModifyCacheClusterAsync(ModifyCacheClusterRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ModifyCacheParameterGroup /// /// 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. /// /// Container for the necessary parameters to execute the ModifyCacheParameterGroup service method. /// /// The response from the ModifyCacheParameterGroup service method, as returned by ElastiCache. /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// The current state of the cache parameter group does not allow the requested operation /// to occur. /// /// /// The Global datastore is not available or in primary-only state. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for ModifyCacheParameterGroup Operation ModifyCacheParameterGroupResponse ModifyCacheParameterGroup(ModifyCacheParameterGroupRequest 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. /// /// Container for the necessary parameters to execute the ModifyCacheParameterGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ModifyCacheParameterGroup service method, as returned by ElastiCache. /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// The current state of the cache parameter group does not allow the requested operation /// to occur. /// /// /// The Global datastore is not available or in primary-only state. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for ModifyCacheParameterGroup Operation Task ModifyCacheParameterGroupAsync(ModifyCacheParameterGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ModifyCacheSubnetGroup /// /// Modifies an existing cache subnet group. /// /// Container for the necessary parameters to execute the ModifyCacheSubnetGroup service method. /// /// The response from the ModifyCacheSubnetGroup service method, as returned by ElastiCache. /// /// The requested cache subnet group name does not refer to an existing cache subnet group. /// /// /// The request cannot be processed because it would exceed the allowed number of subnets /// in a cache subnet group. /// /// /// An invalid subnet identifier was specified. /// /// /// The requested subnet is being used by another cache subnet group. /// /// /// At least one subnet ID does not match the other subnet IDs. This mismatch typically /// occurs when a user sets one subnet ID to a regional Availability Zone and a different /// one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed /// on this service. /// /// REST API Reference for ModifyCacheSubnetGroup Operation ModifyCacheSubnetGroupResponse ModifyCacheSubnetGroup(ModifyCacheSubnetGroupRequest request); /// /// Modifies an existing cache subnet group. /// /// Container for the necessary parameters to execute the ModifyCacheSubnetGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ModifyCacheSubnetGroup service method, as returned by ElastiCache. /// /// The requested cache subnet group name does not refer to an existing cache subnet group. /// /// /// The request cannot be processed because it would exceed the allowed number of subnets /// in a cache subnet group. /// /// /// An invalid subnet identifier was specified. /// /// /// The requested subnet is being used by another cache subnet group. /// /// /// At least one subnet ID does not match the other subnet IDs. This mismatch typically /// occurs when a user sets one subnet ID to a regional Availability Zone and a different /// one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed /// on this service. /// /// REST API Reference for ModifyCacheSubnetGroup Operation Task ModifyCacheSubnetGroupAsync(ModifyCacheSubnetGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ModifyGlobalReplicationGroup /// /// Modifies the settings for a Global datastore. /// /// Container for the necessary parameters to execute the ModifyGlobalReplicationGroup service method. /// /// The response from the ModifyGlobalReplicationGroup service method, as returned by ElastiCache. /// /// The Global datastore does not exist /// /// /// The Global datastore is not available or in primary-only state. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for ModifyGlobalReplicationGroup Operation ModifyGlobalReplicationGroupResponse ModifyGlobalReplicationGroup(ModifyGlobalReplicationGroupRequest request); /// /// Modifies the settings for a Global datastore. /// /// Container for the necessary parameters to execute the ModifyGlobalReplicationGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ModifyGlobalReplicationGroup service method, as returned by ElastiCache. /// /// The Global datastore does not exist /// /// /// The Global datastore is not available or in primary-only state. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for ModifyGlobalReplicationGroup Operation Task ModifyGlobalReplicationGroupAsync(ModifyGlobalReplicationGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ModifyReplicationGroup /// /// Modifies the settings for a replication group. /// /// /// /// This operation is valid for Redis only. /// /// /// /// Container for the necessary parameters to execute the ModifyReplicationGroup service method. /// /// The response from the ModifyReplicationGroup service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// The requested cache node type is not available in the specified Availability Zone. /// For more information, see InsufficientCacheClusterCapacity /// in the ElastiCache User Guide. /// /// /// The requested cluster is not in the available state. /// /// /// The current state of the cache security group does not allow deletion. /// /// /// The KMS key supplied is not valid. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested replication group is not in the available state. /// /// /// The user group is not in an active state. /// /// /// The VPC network is in an invalid state. /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// nodes in a single cluster. /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// nodes per customer. /// /// /// The specified replication group does not exist. /// /// /// The user group was not found or does not exist /// /// REST API Reference for ModifyReplicationGroup Operation ModifyReplicationGroupResponse ModifyReplicationGroup(ModifyReplicationGroupRequest request); /// /// Modifies the settings for a replication group. /// /// /// /// This operation is valid for Redis only. /// /// /// /// Container for the necessary parameters to execute the ModifyReplicationGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ModifyReplicationGroup service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// The requested cache node type is not available in the specified Availability Zone. /// For more information, see InsufficientCacheClusterCapacity /// in the ElastiCache User Guide. /// /// /// The requested cluster is not in the available state. /// /// /// The current state of the cache security group does not allow deletion. /// /// /// The KMS key supplied is not valid. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested replication group is not in the available state. /// /// /// The user group is not in an active state. /// /// /// The VPC network is in an invalid state. /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// nodes in a single cluster. /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// nodes per customer. /// /// /// The specified replication group does not exist. /// /// /// The user group was not found or does not exist /// /// REST API Reference for ModifyReplicationGroup Operation Task ModifyReplicationGroupAsync(ModifyReplicationGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ModifyReplicationGroupShardConfiguration /// /// Modifies a replication group's shards (node groups) by allowing you to add shards, /// remove shards, or rebalance the keyspaces among existing shards. /// /// Container for the necessary parameters to execute the ModifyReplicationGroupShardConfiguration service method. /// /// The response from the ModifyReplicationGroupShardConfiguration service method, as returned by ElastiCache. /// /// The requested cache node type is not available in the specified Availability Zone. /// For more information, see InsufficientCacheClusterCapacity /// in the ElastiCache User Guide. /// /// /// The requested cluster is not in the available state. /// /// /// The KMS key supplied is not valid. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested replication group is not in the available state. /// /// /// The VPC network is in an invalid state. /// /// /// The request cannot be processed because it would exceed the maximum allowed number /// of node groups (shards) in a single replication group. The default maximum is 90 /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// nodes per customer. /// /// /// The specified replication group does not exist. /// /// REST API Reference for ModifyReplicationGroupShardConfiguration Operation ModifyReplicationGroupShardConfigurationResponse ModifyReplicationGroupShardConfiguration(ModifyReplicationGroupShardConfigurationRequest request); /// /// Modifies a replication group's shards (node groups) by allowing you to add shards, /// remove shards, or rebalance the keyspaces among existing shards. /// /// Container for the necessary parameters to execute the ModifyReplicationGroupShardConfiguration service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ModifyReplicationGroupShardConfiguration service method, as returned by ElastiCache. /// /// The requested cache node type is not available in the specified Availability Zone. /// For more information, see InsufficientCacheClusterCapacity /// in the ElastiCache User Guide. /// /// /// The requested cluster is not in the available state. /// /// /// The KMS key supplied is not valid. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested replication group is not in the available state. /// /// /// The VPC network is in an invalid state. /// /// /// The request cannot be processed because it would exceed the maximum allowed number /// of node groups (shards) in a single replication group. The default maximum is 90 /// /// /// The request cannot be processed because it would exceed the allowed number of cache /// nodes per customer. /// /// /// The specified replication group does not exist. /// /// REST API Reference for ModifyReplicationGroupShardConfiguration Operation Task ModifyReplicationGroupShardConfigurationAsync(ModifyReplicationGroupShardConfigurationRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ModifyUser /// /// Changes user password(s) and/or access string. /// /// Container for the necessary parameters to execute the ModifyUser service method. /// /// The response from the ModifyUser service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The user is not in active state. /// /// /// The specified service linked role (SLR) was not found. /// /// /// The user does not exist or could not be found. /// /// REST API Reference for ModifyUser Operation ModifyUserResponse ModifyUser(ModifyUserRequest request); /// /// Changes user password(s) and/or access string. /// /// Container for the necessary parameters to execute the ModifyUser service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ModifyUser service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The user is not in active state. /// /// /// The specified service linked role (SLR) was not found. /// /// /// The user does not exist or could not be found. /// /// REST API Reference for ModifyUser Operation Task ModifyUserAsync(ModifyUserRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ModifyUserGroup /// /// Changes the list of users that belong to the user group. /// /// Container for the necessary parameters to execute the ModifyUserGroup service method. /// /// The response from the ModifyUserGroup service method, as returned by ElastiCache. /// /// You must add default user to a user group. /// /// /// A user with this username already exists. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The user group is not in an active state. /// /// /// The specified service linked role (SLR) was not found. /// /// /// The user group was not found or does not exist /// /// /// The user does not exist or could not be found. /// /// REST API Reference for ModifyUserGroup Operation ModifyUserGroupResponse ModifyUserGroup(ModifyUserGroupRequest request); /// /// Changes the list of users that belong to the user group. /// /// Container for the necessary parameters to execute the ModifyUserGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ModifyUserGroup service method, as returned by ElastiCache. /// /// You must add default user to a user group. /// /// /// A user with this username already exists. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The user group is not in an active state. /// /// /// The specified service linked role (SLR) was not found. /// /// /// The user group was not found or does not exist /// /// /// The user does not exist or could not be found. /// /// REST API Reference for ModifyUserGroup Operation Task ModifyUserGroupAsync(ModifyUserGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PurchaseReservedCacheNodesOffering /// /// 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. /// /// Container for the necessary parameters to execute the PurchaseReservedCacheNodesOffering service method. /// /// The response from the PurchaseReservedCacheNodesOffering service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// You already have a reservation with the given identifier. /// /// /// The request cannot be processed because it would exceed the user's cache node quota. /// /// /// The requested cache node offering does not exist. /// /// /// The request cannot be processed because it would cause the resource to have more than /// the allowed number of tags. The maximum number of tags permitted on a resource is /// 50. /// /// REST API Reference for PurchaseReservedCacheNodesOffering Operation PurchaseReservedCacheNodesOfferingResponse PurchaseReservedCacheNodesOffering(PurchaseReservedCacheNodesOfferingRequest 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. /// /// Container for the necessary parameters to execute the PurchaseReservedCacheNodesOffering service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PurchaseReservedCacheNodesOffering service method, as returned by ElastiCache. /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// You already have a reservation with the given identifier. /// /// /// The request cannot be processed because it would exceed the user's cache node quota. /// /// /// The requested cache node offering does not exist. /// /// /// The request cannot be processed because it would cause the resource to have more than /// the allowed number of tags. The maximum number of tags permitted on a resource is /// 50. /// /// REST API Reference for PurchaseReservedCacheNodesOffering Operation Task PurchaseReservedCacheNodesOfferingAsync(PurchaseReservedCacheNodesOfferingRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region RebalanceSlotsInGlobalReplicationGroup /// /// Redistribute slots to ensure uniform distribution across existing shards in the cluster. /// /// Container for the necessary parameters to execute the RebalanceSlotsInGlobalReplicationGroup service method. /// /// The response from the RebalanceSlotsInGlobalReplicationGroup service method, as returned by ElastiCache. /// /// The Global datastore does not exist /// /// /// The Global datastore is not available or in primary-only state. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for RebalanceSlotsInGlobalReplicationGroup Operation RebalanceSlotsInGlobalReplicationGroupResponse RebalanceSlotsInGlobalReplicationGroup(RebalanceSlotsInGlobalReplicationGroupRequest request); /// /// Redistribute slots to ensure uniform distribution across existing shards in the cluster. /// /// Container for the necessary parameters to execute the RebalanceSlotsInGlobalReplicationGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RebalanceSlotsInGlobalReplicationGroup service method, as returned by ElastiCache. /// /// The Global datastore does not exist /// /// /// The Global datastore is not available or in primary-only state. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for RebalanceSlotsInGlobalReplicationGroup Operation Task RebalanceSlotsInGlobalReplicationGroupAsync(RebalanceSlotsInGlobalReplicationGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region RebootCacheCluster /// /// 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. /// /// /// Container for the necessary parameters to execute the RebootCacheCluster service method. /// /// The response from the RebootCacheCluster service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// The requested cluster is not in the available state. /// /// REST API Reference for RebootCacheCluster Operation RebootCacheClusterResponse RebootCacheCluster(RebootCacheClusterRequest 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. /// /// /// Container for the necessary parameters to execute the RebootCacheCluster service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RebootCacheCluster service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// The requested cluster is not in the available state. /// /// REST API Reference for RebootCacheCluster Operation Task RebootCacheClusterAsync(RebootCacheClusterRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region RemoveTagsFromResource /// /// 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. /// /// Container for the necessary parameters to execute the RemoveTagsFromResource service method. /// /// The response from the RemoveTagsFromResource service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// The requested cache subnet group name does not refer to an existing cache subnet group. /// /// /// The requested Amazon Resource Name (ARN) does not refer to an existing resource. /// /// /// The requested replication group is not in the available state. /// /// /// The specified replication group does not exist. /// /// /// The requested reserved cache node was not found. /// /// /// The requested snapshot name does not refer to an existing snapshot. /// /// /// The requested tag was not found on this resource. /// /// /// The user group was not found or does not exist /// /// /// The user does not exist or could not be found. /// /// REST API Reference for RemoveTagsFromResource Operation RemoveTagsFromResourceResponse RemoveTagsFromResource(RemoveTagsFromResourceRequest 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. /// /// Container for the necessary parameters to execute the RemoveTagsFromResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RemoveTagsFromResource service method, as returned by ElastiCache. /// /// The requested cluster ID does not refer to an existing cluster. /// /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// The requested cache subnet group name does not refer to an existing cache subnet group. /// /// /// The requested Amazon Resource Name (ARN) does not refer to an existing resource. /// /// /// The requested replication group is not in the available state. /// /// /// The specified replication group does not exist. /// /// /// The requested reserved cache node was not found. /// /// /// The requested snapshot name does not refer to an existing snapshot. /// /// /// The requested tag was not found on this resource. /// /// /// The user group was not found or does not exist /// /// /// The user does not exist or could not be found. /// /// REST API Reference for RemoveTagsFromResource Operation Task RemoveTagsFromResourceAsync(RemoveTagsFromResourceRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ResetCacheParameterGroup /// /// 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. /// /// Container for the necessary parameters to execute the ResetCacheParameterGroup service method. /// /// The response from the ResetCacheParameterGroup service method, as returned by ElastiCache. /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// The current state of the cache parameter group does not allow the requested operation /// to occur. /// /// /// The Global datastore is not available or in primary-only state. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for ResetCacheParameterGroup Operation ResetCacheParameterGroupResponse ResetCacheParameterGroup(ResetCacheParameterGroupRequest 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. /// /// Container for the necessary parameters to execute the ResetCacheParameterGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ResetCacheParameterGroup service method, as returned by ElastiCache. /// /// The requested cache parameter group name does not refer to an existing cache parameter /// group. /// /// /// The current state of the cache parameter group does not allow the requested operation /// to occur. /// /// /// The Global datastore is not available or in primary-only state. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for ResetCacheParameterGroup Operation Task ResetCacheParameterGroupAsync(ResetCacheParameterGroupRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region RevokeCacheSecurityGroupIngress /// /// Revokes ingress from a cache security group. Use this operation to disallow access /// from an Amazon EC2 security group that had been previously authorized. /// /// Container for the necessary parameters to execute the RevokeCacheSecurityGroupIngress service method. /// /// The response from the RevokeCacheSecurityGroupIngress service method, as returned by ElastiCache. /// /// The specified Amazon EC2 security group is not authorized for the specified cache /// security group. /// /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// The current state of the cache security group does not allow deletion. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for RevokeCacheSecurityGroupIngress Operation RevokeCacheSecurityGroupIngressResponse RevokeCacheSecurityGroupIngress(RevokeCacheSecurityGroupIngressRequest 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. /// /// Container for the necessary parameters to execute the RevokeCacheSecurityGroupIngress service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RevokeCacheSecurityGroupIngress service method, as returned by ElastiCache. /// /// The specified Amazon EC2 security group is not authorized for the specified cache /// security group. /// /// /// The requested cache security group name does not refer to an existing cache security /// group. /// /// /// The current state of the cache security group does not allow deletion. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// REST API Reference for RevokeCacheSecurityGroupIngress Operation Task RevokeCacheSecurityGroupIngressAsync(RevokeCacheSecurityGroupIngressRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region StartMigration /// /// Start the migration of data. /// /// Container for the necessary parameters to execute the StartMigration service method. /// /// The response from the StartMigration service method, as returned by ElastiCache. /// /// The value for a parameter is invalid. /// /// /// The requested replication group is not in the available state. /// /// /// The targeted replication group is not available. /// /// /// The specified replication group does not exist. /// /// REST API Reference for StartMigration Operation StartMigrationResponse StartMigration(StartMigrationRequest request); /// /// Start the migration of data. /// /// Container for the necessary parameters to execute the StartMigration service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the StartMigration service method, as returned by ElastiCache. /// /// The value for a parameter is invalid. /// /// /// The requested replication group is not in the available state. /// /// /// The targeted replication group is not available. /// /// /// The specified replication group does not exist. /// /// REST API Reference for StartMigration Operation Task StartMigrationAsync(StartMigrationRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region TestFailover /// /// 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). /// /// /// /// This API is designed for testing the behavior of your application in case of ElastiCache /// failover. It is not designed to be an operational tool for initiating a failover to /// overcome a problem you may have with the cluster. Moreover, in certain conditions /// such as large-scale operational events, Amazon may block this API. /// ///

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. /// ///
/// Container for the necessary parameters to execute the TestFailover service method. /// /// The response from the TestFailover service method, as returned by ElastiCache. /// /// The customer has exceeded the allowed rate of API calls. /// /// /// The requested cluster is not in the available state. /// /// /// The KMS key supplied is not valid. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested replication group is not in the available state. /// /// /// The node group specified by the NodeGroupId parameter could not be found. /// Please verify that the node group exists and that you spelled the NodeGroupId /// value correctly. /// /// /// The specified replication group does not exist. /// /// /// The TestFailover action is not available. /// /// REST API Reference for TestFailover Operation TestFailoverResponse TestFailover(TestFailoverRequest 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). /// /// /// /// This API is designed for testing the behavior of your application in case of ElastiCache /// failover. It is not designed to be an operational tool for initiating a failover to /// overcome a problem you may have with the cluster. Moreover, in certain conditions /// such as large-scale operational events, Amazon may block this API. /// ///

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. /// ///
/// Container for the necessary parameters to execute the TestFailover service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the TestFailover service method, as returned by ElastiCache. /// /// The customer has exceeded the allowed rate of API calls. /// /// /// The requested cluster is not in the available state. /// /// /// The KMS key supplied is not valid. /// /// /// Two or more incompatible parameters were specified. /// /// /// The value for a parameter is invalid. /// /// /// The requested replication group is not in the available state. /// /// /// The node group specified by the NodeGroupId parameter could not be found. /// Please verify that the node group exists and that you spelled the NodeGroupId /// value correctly. /// /// /// The specified replication group does not exist. /// /// /// The TestFailover action is not available. /// /// REST API Reference for TestFailover Operation Task TestFailoverAsync(TestFailoverRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion } }