From f0d3d51cae33f36070b926d2423c18fe4d830e1e Mon Sep 17 00:00:00 2001
From: awstools 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. 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. 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. 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. 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. 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. 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. 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. 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 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 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 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 Amazon Resource Name (ARN) does not refer to an existing
+ * resource. The requested replication group is not in the 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 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 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. 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.
+TestMigration
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-elasticache/classes/testmigrationcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-elasticache/interfaces/testmigrationcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-elasticache/interfaces/testmigrationcommandoutput.html)
+
+available
state.
The specified Amazon EC2 security group is already authorized for the specified cache security group.
+ *The specified Amazon EC2 security group is already authorized for the specified cache + * security group.
* * @throws {@link CacheSecurityGroupNotFoundFault} (client fault) - *The requested cache security group name does not refer to an existing cache security group.
+ *The requested cache security group name does not refer to an existing cache security + * group.
* * @throws {@link InvalidCacheSecurityGroupStateFault} (client fault) *The current state of the cache security group does not allow deletion.
diff --git a/clients/client-elasticache/src/commands/BatchApplyUpdateActionCommand.ts b/clients/client-elasticache/src/commands/BatchApplyUpdateActionCommand.ts index 9a683d71765e3..9c993fd98e28a 100644 --- a/clients/client-elasticache/src/commands/BatchApplyUpdateActionCommand.ts +++ b/clients/client-elasticache/src/commands/BatchApplyUpdateActionCommand.ts @@ -36,7 +36,9 @@ export interface BatchApplyUpdateActionCommandOutput extends UpdateActionResults /** * @public - *Apply the service update. For more information on service updates and applying them, see Applying Service Updates.
+ *Apply the service update. For more information on service updates and applying them, + * see Applying Service + * Updates.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-elasticache/src/commands/BatchStopUpdateActionCommand.ts b/clients/client-elasticache/src/commands/BatchStopUpdateActionCommand.ts index e865ad77ebd6f..7dcce8eb17480 100644 --- a/clients/client-elasticache/src/commands/BatchStopUpdateActionCommand.ts +++ b/clients/client-elasticache/src/commands/BatchStopUpdateActionCommand.ts @@ -36,7 +36,9 @@ export interface BatchStopUpdateActionCommandOutput extends UpdateActionResultsM /** * @public - *Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.
+ *Stop the service update. For more information on service updates and stopping them, + * see Stopping + * Service Updates.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-elasticache/src/commands/CopySnapshotCommand.ts b/clients/client-elasticache/src/commands/CopySnapshotCommand.ts index b2733632cb095..79f3860db02a3 100644 --- a/clients/client-elasticache/src/commands/CopySnapshotCommand.ts +++ b/clients/client-elasticache/src/commands/CopySnapshotCommand.ts @@ -41,12 +41,13 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat *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.
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.
*@@ -55,76 +56,75 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat *
- * Error Message: - * The S3 bucket %s is outside of the region.
+ * 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.
+ * 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.
+ * 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.
+ * 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.
+ * 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.
+ * 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.
+ * 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.
+ * Solution: Contact your system administrator + * to get the needed permissions. *- * Error Message: - * The S3 bucket %s already contains an object with key %s.
+ * 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
.
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.
+ * 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.
+ * 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.
+ * 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.
+ * 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.
+ * 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.
+ * 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. *The value for a parameter is invalid.
* * @throws {@link InvalidSnapshotStateFault} (client fault) - *The current state of the snapshot does not allow the requested operation to occur.
+ *The current state of the snapshot does not allow the requested operation to + * occur.
* * @throws {@link SnapshotAlreadyExistsFault} (client fault) *You already have a snapshot with the given name.
@@ -226,10 +227,13 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat *The requested snapshot name does not refer to an existing snapshot.
* * @throws {@link SnapshotQuotaExceededFault} (client fault) - *The request cannot be processed because it would exceed the maximum number of snapshots.
+ *The request cannot be processed because it would exceed the maximum number of + * snapshots.
* * @throws {@link TagQuotaPerResourceExceeded} (client fault) - *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 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.
* * @throws {@link ElastiCacheServiceException} *Base exception class for all service exceptions from ElastiCache service.
diff --git a/clients/client-elasticache/src/commands/CreateCacheClusterCommand.ts b/clients/client-elasticache/src/commands/CreateCacheClusterCommand.ts index 107402a6acafb..648cf3d6302b3 100644 --- a/clients/client-elasticache/src/commands/CreateCacheClusterCommand.ts +++ b/clients/client-elasticache/src/commands/CreateCacheClusterCommand.ts @@ -36,9 +36,8 @@ export interface CreateCacheClusterCommandOutput extends CreateCacheClusterResul /** * @public - *Creates a cluster. All nodes in the - * cluster run the same protocol-compliant cache engine software, either Memcached - * or Redis.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. @@ -237,20 +236,24 @@ export interface CreateCacheClusterCommandOutput extends CreateCacheClusterResul *You already have a cluster with the given identifier.
* * @throws {@link CacheParameterGroupNotFoundFault} (client fault) - *The requested cache parameter group name does not refer to an existing cache parameter group.
+ *The requested cache parameter group name does not refer to an existing cache parameter + * group.
* * @throws {@link CacheSecurityGroupNotFoundFault} (client fault) - *The requested cache security group name does not refer to an existing cache security group.
+ *The requested cache security group name does not refer to an existing cache security + * group.
* * @throws {@link CacheSubnetGroupNotFoundFault} (client fault) - *The requested cache subnet group name does not refer to an existing cache subnet group.
+ *The requested cache subnet group name does not refer to an existing cache subnet + * group.
* * @throws {@link ClusterQuotaForCustomerExceededFault} (client fault) - *The request cannot be processed because it would exceed the allowed number of clusters per customer.
+ *The request cannot be processed because it would exceed the allowed number of clusters + * per customer.
* * @throws {@link InsufficientCacheClusterCapacityFault} (client fault) - *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 cache node type is not available in the specified Availability Zone. For + * more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
* * @throws {@link InvalidParameterCombinationException} (client fault) *Two or more incompatible parameters were specified.
@@ -265,16 +268,20 @@ export interface CreateCacheClusterCommandOutput extends CreateCacheClusterResul *The VPC network is in an invalid state.
* * @throws {@link NodeQuotaForClusterExceededFault} (client fault) - *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 in a single cluster.
* * @throws {@link NodeQuotaForCustomerExceededFault} (client fault) - *The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
+ *The request cannot be processed because it would exceed the allowed number of cache + * nodes per customer.
* * @throws {@link ReplicationGroupNotFoundFault} (client fault) *The specified replication group does not exist.
* * @throws {@link TagQuotaPerResourceExceeded} (client fault) - *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 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.
* * @throws {@link ElastiCacheServiceException} *Base exception class for all service exceptions from ElastiCache service.
diff --git a/clients/client-elasticache/src/commands/CreateCacheParameterGroupCommand.ts b/clients/client-elasticache/src/commands/CreateCacheParameterGroupCommand.ts index 016b304e1a119..5e9e00753651b 100644 --- a/clients/client-elasticache/src/commands/CreateCacheParameterGroupCommand.ts +++ b/clients/client-elasticache/src/commands/CreateCacheParameterGroupCommand.ts @@ -36,12 +36,13 @@ export interface CreateCacheParameterGroupCommandOutput extends CreateCacheParam /** * @public - *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:
+ *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:
*@@ -49,7 +50,8 @@ export interface CreateCacheParameterGroupCommandOutput extends CreateCacheParam *
- * Parameters and Parameter Groups in the ElastiCache User Guide.
+ * Parameters and + * Parameter Groups in the ElastiCache User Guide. *A cache parameter group with the requested name already exists.
* * @throws {@link CacheParameterGroupQuotaExceededFault} (client fault) - *The request cannot be processed because it would exceed the maximum number of cache security groups.
+ *The request cannot be processed because it would exceed the maximum number of cache + * security groups.
* * @throws {@link InvalidCacheParameterGroupStateFault} (client fault) - *The current state of the cache parameter group does not allow the requested operation to occur.
+ *The current state of the cache parameter group does not allow the requested operation + * to occur.
* * @throws {@link InvalidParameterCombinationException} (client fault) *Two or more incompatible parameters were specified.
@@ -105,7 +109,9 @@ export interface CreateCacheParameterGroupCommandOutput extends CreateCacheParam *The value for a parameter is invalid.
* * @throws {@link TagQuotaPerResourceExceeded} (client fault) - *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 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.
* * @throws {@link ElastiCacheServiceException} *Base exception class for all service exceptions from ElastiCache service.
diff --git a/clients/client-elasticache/src/commands/CreateCacheSecurityGroupCommand.ts b/clients/client-elasticache/src/commands/CreateCacheSecurityGroupCommand.ts index 281488e2fede6..db940d9009c36 100644 --- a/clients/client-elasticache/src/commands/CreateCacheSecurityGroupCommand.ts +++ b/clients/client-elasticache/src/commands/CreateCacheSecurityGroupCommand.ts @@ -36,12 +36,11 @@ export interface CreateCacheSecurityGroupCommandOutput extends CreateCacheSecuri /** * @public - *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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -88,7 +87,8 @@ export interface CreateCacheSecurityGroupCommandOutput extends CreateCacheSecuri *A cache security group with the specified name already exists.
* * @throws {@link CacheSecurityGroupQuotaExceededFault} (client fault) - *The request cannot be processed because it would exceed the allowed number of cache security groups.
+ *The request cannot be processed because it would exceed the allowed number of cache + * security groups.
* * @throws {@link InvalidParameterCombinationException} (client fault) *Two or more incompatible parameters were specified.
@@ -97,7 +97,9 @@ export interface CreateCacheSecurityGroupCommandOutput extends CreateCacheSecuri *The value for a parameter is invalid.
* * @throws {@link TagQuotaPerResourceExceeded} (client fault) - *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 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.
* * @throws {@link ElastiCacheServiceException} *Base exception class for all service exceptions from ElastiCache service.
diff --git a/clients/client-elasticache/src/commands/CreateCacheSubnetGroupCommand.ts b/clients/client-elasticache/src/commands/CreateCacheSubnetGroupCommand.ts index dc30edd67e34c..105c48d6be163 100644 --- a/clients/client-elasticache/src/commands/CreateCacheSubnetGroupCommand.ts +++ b/clients/client-elasticache/src/commands/CreateCacheSubnetGroupCommand.ts @@ -37,7 +37,8 @@ export interface CreateCacheSubnetGroupCommandOutput extends CreateCacheSubnetGr /** * @public *Creates a new cache subnet group.
- *Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
+ *Use this parameter only when you are creating a cluster in an Amazon Virtual Private + * Cloud (Amazon VPC).
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -94,23 +95,30 @@ export interface CreateCacheSubnetGroupCommandOutput extends CreateCacheSubnetGr * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape. * * @throws {@link CacheSubnetGroupAlreadyExistsFault} (client fault) - *The requested cache subnet group name is already in use by an existing cache subnet group.
+ *The requested cache subnet group name is already in use by an existing cache subnet + * group.
* * @throws {@link CacheSubnetGroupQuotaExceededFault} (client fault) - *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 cache + * subnet groups.
* * @throws {@link CacheSubnetQuotaExceededFault} (client fault) - *The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.
+ *The request cannot be processed because it would exceed the allowed number of subnets + * in a cache subnet group.
* * @throws {@link InvalidSubnet} (client fault) *An invalid subnet identifier was specified.
* * @throws {@link SubnetNotAllowedFault} (client fault) - *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.
+ *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.
* * @throws {@link TagQuotaPerResourceExceeded} (client fault) - *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 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.
* * @throws {@link ElastiCacheServiceException} *Base exception class for all service exceptions from ElastiCache service.
diff --git a/clients/client-elasticache/src/commands/CreateGlobalReplicationGroupCommand.ts b/clients/client-elasticache/src/commands/CreateGlobalReplicationGroupCommand.ts index 84fee4c3a4d59..a727f64ba1e7e 100644 --- a/clients/client-elasticache/src/commands/CreateGlobalReplicationGroupCommand.ts +++ b/clients/client-elasticache/src/commands/CreateGlobalReplicationGroupCommand.ts @@ -38,19 +38,20 @@ export interface CreateGlobalReplicationGroupCommandOutput /** * @public - *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.
+ *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 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.
+ *The PrimaryReplicationGroupId represents the + * name of the primary cluster that accepts writes and will replicate updates to + * the secondary cluster.
*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. + *
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.
+ *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.
+ * 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.
*The requested cluster ID does not refer to an existing cluster.
* * @throws {@link CacheParameterGroupNotFoundFault} (client fault) - *The requested cache parameter group name does not refer to an existing cache parameter group.
+ *The requested cache parameter group name does not refer to an existing cache parameter + * group.
* * @throws {@link CacheSecurityGroupNotFoundFault} (client fault) - *The requested cache security group name does not refer to an existing cache security group.
+ *The requested cache security group name does not refer to an existing cache security + * group.
* * @throws {@link CacheSubnetGroupNotFoundFault} (client fault) - *The requested cache subnet group name does not refer to an existing cache subnet group.
+ *The requested cache subnet group name does not refer to an existing cache subnet + * group.
* * @throws {@link ClusterQuotaForCustomerExceededFault} (client fault) - *The request cannot be processed because it would exceed the allowed number of clusters per customer.
+ *The request cannot be processed because it would exceed the allowed number of clusters + * per customer.
* * @throws {@link GlobalReplicationGroupNotFoundFault} (client fault) *The Global datastore does not exist
* * @throws {@link InsufficientCacheClusterCapacityFault} (client fault) - *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 cache node type is not available in the specified Availability Zone. For + * more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
* * @throws {@link InvalidCacheClusterStateFault} (client fault) *The requested cluster is not in the available
state.
The VPC network is in an invalid state.
* * @throws {@link NodeGroupsPerReplicationGroupQuotaExceededFault} (client fault) - *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 maximum allowed number of + * node groups (shards) in a single replication group. The default maximum is 90
* * @throws {@link NodeQuotaForClusterExceededFault} (client fault) - *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 in a single cluster.
* * @throws {@link NodeQuotaForCustomerExceededFault} (client fault) - *The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
+ *The request cannot be processed because it would exceed the allowed number of cache + * nodes per customer.
* * @throws {@link ReplicationGroupAlreadyExistsFault} (client fault) *The specified replication group already exists.
* * @throws {@link TagQuotaPerResourceExceeded} (client fault) - *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 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.
* * @throws {@link UserGroupNotFoundFault} (client fault) *The user group was not found or does not exist
diff --git a/clients/client-elasticache/src/commands/CreateSnapshotCommand.ts b/clients/client-elasticache/src/commands/CreateSnapshotCommand.ts index 1aec631dc9fc8..8df49ab056efe 100644 --- a/clients/client-elasticache/src/commands/CreateSnapshotCommand.ts +++ b/clients/client-elasticache/src/commands/CreateSnapshotCommand.ts @@ -36,8 +36,8 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotResult, __Met /** * @public - *Creates a copy of an entire cluster or replication group at a - * specific moment in time.
+ *Creates a copy of an entire cluster or replication group at a specific moment in + * time.
*This operation is valid for Redis only.
*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 Redis cluster running on a
+ * cache.t1.micro
cache node.
Creating a snapshot of a cluster that is running Memcached rather than Redis.
+ *Creating a snapshot of a cluster that is running Memcached rather than + * Redis.
*Neither of these are supported by ElastiCache.
* * @throws {@link SnapshotQuotaExceededFault} (client fault) - *The request cannot be processed because it would exceed the maximum number of snapshots.
+ *The request cannot be processed because it would exceed the maximum number of + * snapshots.
* * @throws {@link TagQuotaPerResourceExceeded} (client fault) - *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 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.
* * @throws {@link ElastiCacheServiceException} *Base exception class for all service exceptions from ElastiCache service.
diff --git a/clients/client-elasticache/src/commands/CreateUserCommand.ts b/clients/client-elasticache/src/commands/CreateUserCommand.ts index f543c08422ef3..5cd9c88fa45fd 100644 --- a/clients/client-elasticache/src/commands/CreateUserCommand.ts +++ b/clients/client-elasticache/src/commands/CreateUserCommand.ts @@ -36,7 +36,8 @@ export interface CreateUserCommandOutput extends User, __MetadataBearer {} /** * @public - *For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC).
+ *For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see + * Using Role Based Access Control (RBAC).
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -105,7 +106,9 @@ export interface CreateUserCommandOutput extends User, __MetadataBearer {} *The specified service linked role (SLR) was not found.
* * @throws {@link TagQuotaPerResourceExceeded} (client fault) - *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 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.
* * @throws {@link UserAlreadyExistsFault} (client fault) *A user with this ID already exists.
diff --git a/clients/client-elasticache/src/commands/CreateUserGroupCommand.ts b/clients/client-elasticache/src/commands/CreateUserGroupCommand.ts index 1d1350286725a..6ad1588c0078a 100644 --- a/clients/client-elasticache/src/commands/CreateUserGroupCommand.ts +++ b/clients/client-elasticache/src/commands/CreateUserGroupCommand.ts @@ -36,7 +36,8 @@ export interface CreateUserGroupCommandOutput extends UserGroup, __MetadataBeare /** * @public - *For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC) + *
For Redis engine version 6.0 onwards: Creates a Redis user group. For more + * information, see Using Role Based Access Control (RBAC) *
* @example * Use a bare-bones client and the command you need to make an API call. @@ -102,7 +103,9 @@ export interface CreateUserGroupCommandOutput extends UserGroup, __MetadataBeare *The specified service linked role (SLR) was not found.
* * @throws {@link TagQuotaPerResourceExceeded} (client fault) - *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 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.
* * @throws {@link UserGroupAlreadyExistsFault} (client fault) *The user group with this ID already exists.
diff --git a/clients/client-elasticache/src/commands/DecreaseReplicaCountCommand.ts b/clients/client-elasticache/src/commands/DecreaseReplicaCountCommand.ts index 423d963279ae0..7f4d04ee0d30d 100644 --- a/clients/client-elasticache/src/commands/DecreaseReplicaCountCommand.ts +++ b/clients/client-elasticache/src/commands/DecreaseReplicaCountCommand.ts @@ -36,9 +36,10 @@ export interface DecreaseReplicaCountCommandOutput extends DecreaseReplicaCountR /** * @public - *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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -199,11 +200,12 @@ export interface DecreaseReplicaCountCommandOutput extends DecreaseReplicaCountR * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape. * * @throws {@link ClusterQuotaForCustomerExceededFault} (client fault) - *The request cannot be processed because it would exceed the allowed number of clusters per customer.
+ *The request cannot be processed because it would exceed the allowed number of clusters + * per customer.
* * @throws {@link InsufficientCacheClusterCapacityFault} (client fault) - *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 cache node type is not available in the specified Availability Zone. For + * more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
* * @throws {@link InvalidCacheClusterStateFault} (client fault) *The requested cluster is not in the available
state.
The VPC network is in an invalid state.
* * @throws {@link NodeGroupsPerReplicationGroupQuotaExceededFault} (client fault) - *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 maximum allowed number of + * node groups (shards) in a single replication group. The default maximum is 90
* * @throws {@link NodeQuotaForCustomerExceededFault} (client fault) - *The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
+ *The request cannot be processed because it would exceed the allowed number of cache + * nodes per customer.
* * @throws {@link NoOperationFault} (client fault) *The operation was not performed because no changes were required.
diff --git a/clients/client-elasticache/src/commands/DeleteCacheClusterCommand.ts b/clients/client-elasticache/src/commands/DeleteCacheClusterCommand.ts index 6e2625bbcee63..9195e35ee0e52 100644 --- a/clients/client-elasticache/src/commands/DeleteCacheClusterCommand.ts +++ b/clients/client-elasticache/src/commands/DeleteCacheClusterCommand.ts @@ -36,11 +36,10 @@ export interface DeleteCacheClusterCommandOutput extends DeleteCacheClusterResul /** * @public - *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.
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:
*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 Redis cluster running on a
+ * cache.t1.micro
cache node.
Creating a snapshot of a cluster that is running Memcached rather than Redis.
+ *Creating a snapshot of a cluster that is running Memcached rather than + * Redis.
*Neither of these are supported by ElastiCache.
* * @throws {@link SnapshotQuotaExceededFault} (client fault) - *The request cannot be processed because it would exceed the maximum number of snapshots.
+ *The request cannot be processed because it would exceed the maximum number of + * snapshots.
* * @throws {@link ElastiCacheServiceException} *Base exception class for all service exceptions from ElastiCache service.
diff --git a/clients/client-elasticache/src/commands/DeleteCacheParameterGroupCommand.ts b/clients/client-elasticache/src/commands/DeleteCacheParameterGroupCommand.ts index a8e5f5b7881a9..0a906b143f4fe 100644 --- a/clients/client-elasticache/src/commands/DeleteCacheParameterGroupCommand.ts +++ b/clients/client-elasticache/src/commands/DeleteCacheParameterGroupCommand.ts @@ -36,9 +36,9 @@ export interface DeleteCacheParameterGroupCommandOutput extends __MetadataBearer /** * @public - *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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -61,10 +61,12 @@ export interface DeleteCacheParameterGroupCommandOutput extends __MetadataBearer * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape. * * @throws {@link CacheParameterGroupNotFoundFault} (client fault) - *The requested cache parameter group name does not refer to an existing cache parameter group.
+ *The requested cache parameter group name does not refer to an existing cache parameter + * group.
* * @throws {@link InvalidCacheParameterGroupStateFault} (client fault) - *The current state of the cache parameter group does not allow the requested operation to occur.
+ *The current state of the cache parameter group does not allow the requested operation + * to occur.
* * @throws {@link InvalidParameterCombinationException} (client fault) *Two or more incompatible parameters were specified.
diff --git a/clients/client-elasticache/src/commands/DeleteCacheSecurityGroupCommand.ts b/clients/client-elasticache/src/commands/DeleteCacheSecurityGroupCommand.ts index 0f226123254eb..9709e56148e7a 100644 --- a/clients/client-elasticache/src/commands/DeleteCacheSecurityGroupCommand.ts +++ b/clients/client-elasticache/src/commands/DeleteCacheSecurityGroupCommand.ts @@ -38,7 +38,8 @@ export interface DeleteCacheSecurityGroupCommandOutput extends __MetadataBearer * @public *Deletes a cache security group.
*You cannot delete a cache security group if it is associated with any clusters.
+ *You cannot delete a cache security group if it is associated with any + * clusters.
*The requested cache security group name does not refer to an existing cache security group.
+ *The requested cache security group name does not refer to an existing cache security + * group.
* * @throws {@link InvalidCacheSecurityGroupStateFault} (client fault) *The current state of the cache security group does not allow deletion.
diff --git a/clients/client-elasticache/src/commands/DeleteCacheSubnetGroupCommand.ts b/clients/client-elasticache/src/commands/DeleteCacheSubnetGroupCommand.ts index 6c3e19043a182..c29ef80d48f4e 100644 --- a/clients/client-elasticache/src/commands/DeleteCacheSubnetGroupCommand.ts +++ b/clients/client-elasticache/src/commands/DeleteCacheSubnetGroupCommand.ts @@ -38,7 +38,8 @@ export interface DeleteCacheSubnetGroupCommandOutput extends __MetadataBearer {} * @public *Deletes a cache subnet group.
*You cannot delete a default cache subnet group or one that is associated with any clusters.
+ *You cannot delete a default cache subnet group or one that is associated with any + * clusters.
*The requested cache subnet group is currently in use.
* * @throws {@link CacheSubnetGroupNotFoundFault} (client fault) - *The requested cache subnet group name does not refer to an existing cache subnet group.
+ *The requested cache subnet group name does not refer to an existing cache subnet + * group.
* * @throws {@link ElastiCacheServiceException} *Base exception class for all service exceptions from ElastiCache service.
diff --git a/clients/client-elasticache/src/commands/DeleteGlobalReplicationGroupCommand.ts b/clients/client-elasticache/src/commands/DeleteGlobalReplicationGroupCommand.ts index aa086cf3fdc29..dd99f29ea7bcd 100644 --- a/clients/client-elasticache/src/commands/DeleteGlobalReplicationGroupCommand.ts +++ b/clients/client-elasticache/src/commands/DeleteGlobalReplicationGroupCommand.ts @@ -41,17 +41,24 @@ export interface DeleteGlobalReplicationGroupCommandOutput *Deleting a Global datastore is a two-step process:
*First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.
+ *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
.
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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-elasticache/src/commands/DeleteReplicationGroupCommand.ts b/clients/client-elasticache/src/commands/DeleteReplicationGroupCommand.ts index 6386c93e8ec7a..e074b3c8856db 100644 --- a/clients/client-elasticache/src/commands/DeleteReplicationGroupCommand.ts +++ b/clients/client-elasticache/src/commands/DeleteReplicationGroupCommand.ts @@ -36,12 +36,14 @@ export interface DeleteReplicationGroupCommandOutput extends DeleteReplicationGr /** * @public - *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.
+ *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.
*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 Redis cluster running on a
+ * cache.t1.micro
cache node.
Creating a snapshot of a cluster that is running Memcached rather than Redis.
+ *Creating a snapshot of a cluster that is running Memcached rather than + * Redis.
*Neither of these are supported by ElastiCache.
* * @throws {@link SnapshotQuotaExceededFault} (client fault) - *The request cannot be processed because it would exceed the maximum number of snapshots.
+ *The request cannot be processed because it would exceed the maximum number of + * snapshots.
* * @throws {@link ElastiCacheServiceException} *Base exception class for all service exceptions from ElastiCache service.
diff --git a/clients/client-elasticache/src/commands/DeleteSnapshotCommand.ts b/clients/client-elasticache/src/commands/DeleteSnapshotCommand.ts index 52d4479e703bf..288a9df3f902a 100644 --- a/clients/client-elasticache/src/commands/DeleteSnapshotCommand.ts +++ b/clients/client-elasticache/src/commands/DeleteSnapshotCommand.ts @@ -36,9 +36,9 @@ export interface DeleteSnapshotCommandOutput extends DeleteSnapshotResult, __Met /** * @public - *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.
+ *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.
*The value for a parameter is invalid.
* * @throws {@link InvalidSnapshotStateFault} (client fault) - *The current state of the snapshot does not allow the requested operation to occur.
+ *The current state of the snapshot does not allow the requested operation to + * occur.
* * @throws {@link SnapshotNotFoundFault} (client fault) *The requested snapshot name does not refer to an existing snapshot.
diff --git a/clients/client-elasticache/src/commands/DeleteUserCommand.ts b/clients/client-elasticache/src/commands/DeleteUserCommand.ts index 04eb69c37a8b6..c4e16162328e6 100644 --- a/clients/client-elasticache/src/commands/DeleteUserCommand.ts +++ b/clients/client-elasticache/src/commands/DeleteUserCommand.ts @@ -36,7 +36,9 @@ export interface DeleteUserCommandOutput extends User, __MetadataBearer {} /** * @public - *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).
+ *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).
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-elasticache/src/commands/DeleteUserGroupCommand.ts b/clients/client-elasticache/src/commands/DeleteUserGroupCommand.ts index 704f69655e455..16b1fcfc9bce7 100644 --- a/clients/client-elasticache/src/commands/DeleteUserGroupCommand.ts +++ b/clients/client-elasticache/src/commands/DeleteUserGroupCommand.ts @@ -36,7 +36,9 @@ export interface DeleteUserGroupCommandOutput extends UserGroup, __MetadataBeare /** * @public - *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).
+ *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).
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-elasticache/src/commands/DescribeCacheClustersCommand.ts b/clients/client-elasticache/src/commands/DescribeCacheClustersCommand.ts index c3c0b9a1978f6..f473372fee876 100644 --- a/clients/client-elasticache/src/commands/DescribeCacheClustersCommand.ts +++ b/clients/client-elasticache/src/commands/DescribeCacheClustersCommand.ts @@ -36,19 +36,19 @@ export interface DescribeCacheClustersCommandOutput extends CacheClusterMessage, /** * @public - *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 + *
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.
diff --git a/clients/client-elasticache/src/commands/DescribeCacheEngineVersionsCommand.ts b/clients/client-elasticache/src/commands/DescribeCacheEngineVersionsCommand.ts index ade4a2e710c82..98e2b684fb636 100644 --- a/clients/client-elasticache/src/commands/DescribeCacheEngineVersionsCommand.ts +++ b/clients/client-elasticache/src/commands/DescribeCacheEngineVersionsCommand.ts @@ -36,8 +36,7 @@ export interface DescribeCacheEngineVersionsCommandOutput extends CacheEngineVer /** * @public - *Returns a list of the available cache - * engines and their versions.
+ *Returns a list of the available cache engines and their versions.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-elasticache/src/commands/DescribeCacheParameterGroupsCommand.ts b/clients/client-elasticache/src/commands/DescribeCacheParameterGroupsCommand.ts index 829e5ede6f01c..fce962d603dbd 100644 --- a/clients/client-elasticache/src/commands/DescribeCacheParameterGroupsCommand.ts +++ b/clients/client-elasticache/src/commands/DescribeCacheParameterGroupsCommand.ts @@ -36,9 +36,8 @@ export interface DescribeCacheParameterGroupsCommandOutput extends CacheParamete /** * @public - *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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -74,7 +73,8 @@ export interface DescribeCacheParameterGroupsCommandOutput extends CacheParamete * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape. * * @throws {@link CacheParameterGroupNotFoundFault} (client fault) - *The requested cache parameter group name does not refer to an existing cache parameter group.
+ *The requested cache parameter group name does not refer to an existing cache parameter + * group.
* * @throws {@link InvalidParameterCombinationException} (client fault) *Two or more incompatible parameters were specified.
diff --git a/clients/client-elasticache/src/commands/DescribeCacheParametersCommand.ts b/clients/client-elasticache/src/commands/DescribeCacheParametersCommand.ts index 3c62984b1f39a..a7f5f5b8cba9f 100644 --- a/clients/client-elasticache/src/commands/DescribeCacheParametersCommand.ts +++ b/clients/client-elasticache/src/commands/DescribeCacheParametersCommand.ts @@ -36,8 +36,7 @@ export interface DescribeCacheParametersCommandOutput extends CacheParameterGrou /** * @public - *Returns the detailed parameter list for a - * particular cache parameter group.
+ *Returns the detailed parameter list for a particular cache parameter group.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -96,7 +95,8 @@ export interface DescribeCacheParametersCommandOutput extends CacheParameterGrou * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape. * * @throws {@link CacheParameterGroupNotFoundFault} (client fault) - *The requested cache parameter group name does not refer to an existing cache parameter group.
+ *The requested cache parameter group name does not refer to an existing cache parameter + * group.
* * @throws {@link InvalidParameterCombinationException} (client fault) *Two or more incompatible parameters were specified.
diff --git a/clients/client-elasticache/src/commands/DescribeCacheSecurityGroupsCommand.ts b/clients/client-elasticache/src/commands/DescribeCacheSecurityGroupsCommand.ts index 9fc0b09d7a313..549b928324930 100644 --- a/clients/client-elasticache/src/commands/DescribeCacheSecurityGroupsCommand.ts +++ b/clients/client-elasticache/src/commands/DescribeCacheSecurityGroupsCommand.ts @@ -36,10 +36,9 @@ export interface DescribeCacheSecurityGroupsCommandOutput extends CacheSecurityG /** * @public - *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 - *
+ *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
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -81,7 +80,8 @@ export interface DescribeCacheSecurityGroupsCommandOutput extends CacheSecurityG * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape. * * @throws {@link CacheSecurityGroupNotFoundFault} (client fault) - *The requested cache security group name does not refer to an existing cache security group.
+ *The requested cache security group name does not refer to an existing cache security + * group.
* * @throws {@link InvalidParameterCombinationException} (client fault) *Two or more incompatible parameters were specified.
diff --git a/clients/client-elasticache/src/commands/DescribeCacheSubnetGroupsCommand.ts b/clients/client-elasticache/src/commands/DescribeCacheSubnetGroupsCommand.ts index ee6b2262e6774..8e5b199dba4aa 100644 --- a/clients/client-elasticache/src/commands/DescribeCacheSubnetGroupsCommand.ts +++ b/clients/client-elasticache/src/commands/DescribeCacheSubnetGroupsCommand.ts @@ -36,10 +36,10 @@ export interface DescribeCacheSubnetGroupsCommandOutput extends CacheSubnetGroup /** * @public - *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. - *
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -91,7 +91,8 @@ export interface DescribeCacheSubnetGroupsCommandOutput extends CacheSubnetGroup * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape. * * @throws {@link CacheSubnetGroupNotFoundFault} (client fault) - *The requested cache subnet group name does not refer to an existing cache subnet group.
+ *The requested cache subnet group name does not refer to an existing cache subnet + * group.
* * @throws {@link ElastiCacheServiceException} *Base exception class for all service exceptions from ElastiCache service.
diff --git a/clients/client-elasticache/src/commands/DescribeEngineDefaultParametersCommand.ts b/clients/client-elasticache/src/commands/DescribeEngineDefaultParametersCommand.ts index 2b56eda69e21e..ea850b44fad7d 100644 --- a/clients/client-elasticache/src/commands/DescribeEngineDefaultParametersCommand.ts +++ b/clients/client-elasticache/src/commands/DescribeEngineDefaultParametersCommand.ts @@ -41,8 +41,8 @@ export interface DescribeEngineDefaultParametersCommandOutput /** * @public - *Returns the default engine and - * system parameter information for the specified cache engine.
+ *Returns the default engine and system parameter information for the specified cache + * engine.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-elasticache/src/commands/DescribeEventsCommand.ts b/clients/client-elasticache/src/commands/DescribeEventsCommand.ts index f3321e00fd733..06bb385f13774 100644 --- a/clients/client-elasticache/src/commands/DescribeEventsCommand.ts +++ b/clients/client-elasticache/src/commands/DescribeEventsCommand.ts @@ -36,12 +36,11 @@ export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBe /** * @public - *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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-elasticache/src/commands/DescribeGlobalReplicationGroupsCommand.ts b/clients/client-elasticache/src/commands/DescribeGlobalReplicationGroupsCommand.ts index 8bb64ec9aee90..d8a2075c2a178 100644 --- a/clients/client-elasticache/src/commands/DescribeGlobalReplicationGroupsCommand.ts +++ b/clients/client-elasticache/src/commands/DescribeGlobalReplicationGroupsCommand.ts @@ -41,7 +41,8 @@ export interface DescribeGlobalReplicationGroupsCommandOutput /** * @public - *Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.
+ *Returns information about a particular global replication group. If no identifier is + * specified, returns information about all Global datastores.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-elasticache/src/commands/DescribeReplicationGroupsCommand.ts b/clients/client-elasticache/src/commands/DescribeReplicationGroupsCommand.ts index e561ad8400412..42443e1455828 100644 --- a/clients/client-elasticache/src/commands/DescribeReplicationGroupsCommand.ts +++ b/clients/client-elasticache/src/commands/DescribeReplicationGroupsCommand.ts @@ -36,9 +36,9 @@ export interface DescribeReplicationGroupsCommandOutput extends ReplicationGroup /** * @public - *Returns information about a particular
- * replication group. If no identifier is specified, DescribeReplicationGroups
- * returns information about all replication groups.
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.
*Returns information about reserved cache - * nodes for this account, or about a specified reserved cache node.
+ *Returns information about reserved cache nodes for this account, or about a specified + * reserved cache node.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-elasticache/src/commands/DescribeReservedCacheNodesOfferingsCommand.ts b/clients/client-elasticache/src/commands/DescribeReservedCacheNodesOfferingsCommand.ts index 2ce06efe4159f..294a2cb728491 100644 --- a/clients/client-elasticache/src/commands/DescribeReservedCacheNodesOfferingsCommand.ts +++ b/clients/client-elasticache/src/commands/DescribeReservedCacheNodesOfferingsCommand.ts @@ -41,8 +41,7 @@ export interface DescribeReservedCacheNodesOfferingsCommandOutput /** * @public - *Lists available reserved cache - * node offerings.
+ *Lists available reserved cache node offerings.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-elasticache/src/commands/DescribeSnapshotsCommand.ts b/clients/client-elasticache/src/commands/DescribeSnapshotsCommand.ts index 5817662adb3e3..1688f94c98953 100644 --- a/clients/client-elasticache/src/commands/DescribeSnapshotsCommand.ts +++ b/clients/client-elasticache/src/commands/DescribeSnapshotsCommand.ts @@ -36,8 +36,8 @@ export interface DescribeSnapshotsCommandOutput extends DescribeSnapshotsListMes /** * @public - *Returns information about cluster or replication group snapshots.
- * By default, DescribeSnapshots
lists all of your snapshots; it can optionally
+ *
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.
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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-elasticache/src/commands/FailoverGlobalReplicationGroupCommand.ts b/clients/client-elasticache/src/commands/FailoverGlobalReplicationGroupCommand.ts index d37a273b361f6..543f3d1176f50 100644 --- a/clients/client-elasticache/src/commands/FailoverGlobalReplicationGroupCommand.ts +++ b/clients/client-elasticache/src/commands/FailoverGlobalReplicationGroupCommand.ts @@ -41,7 +41,8 @@ export interface FailoverGlobalReplicationGroupCommandOutput /** * @public - *Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.
+ *Used to failover the primary region to a secondary region. The secondary region will + * become primary, and all other clusters will become secondary.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-elasticache/src/commands/IncreaseReplicaCountCommand.ts b/clients/client-elasticache/src/commands/IncreaseReplicaCountCommand.ts index 1b584b883dea7..49a024fe915bc 100644 --- a/clients/client-elasticache/src/commands/IncreaseReplicaCountCommand.ts +++ b/clients/client-elasticache/src/commands/IncreaseReplicaCountCommand.ts @@ -36,9 +36,10 @@ export interface IncreaseReplicaCountCommandOutput extends IncreaseReplicaCountR /** * @public - *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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -196,11 +197,12 @@ export interface IncreaseReplicaCountCommandOutput extends IncreaseReplicaCountR * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape. * * @throws {@link ClusterQuotaForCustomerExceededFault} (client fault) - *The request cannot be processed because it would exceed the allowed number of clusters per customer.
+ *The request cannot be processed because it would exceed the allowed number of clusters + * per customer.
* * @throws {@link InsufficientCacheClusterCapacityFault} (client fault) - *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 cache node type is not available in the specified Availability Zone. For + * more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
* * @throws {@link InvalidCacheClusterStateFault} (client fault) *The requested cluster is not in the available
state.
The VPC network is in an invalid state.
* * @throws {@link NodeGroupsPerReplicationGroupQuotaExceededFault} (client fault) - *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 maximum allowed number of + * node groups (shards) in a single replication group. The default maximum is 90
* * @throws {@link NodeQuotaForCustomerExceededFault} (client fault) - *The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
+ *The request cannot be processed because it would exceed the allowed number of cache + * nodes per customer.
* * @throws {@link NoOperationFault} (client fault) *The operation was not performed because no changes were required.
diff --git a/clients/client-elasticache/src/commands/ListAllowedNodeTypeModificationsCommand.ts b/clients/client-elasticache/src/commands/ListAllowedNodeTypeModificationsCommand.ts index 6f5c069804d53..2d86c77872cea 100644 --- a/clients/client-elasticache/src/commands/ListAllowedNodeTypeModificationsCommand.ts +++ b/clients/client-elasticache/src/commands/ListAllowedNodeTypeModificationsCommand.ts @@ -41,11 +41,12 @@ export interface ListAllowedNodeTypeModificationsCommandOutput /** * @public - *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.
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.
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.
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.
The requested cluster ID does not refer to an existing cluster.
* * @throws {@link CacheParameterGroupNotFoundFault} (client fault) - *The requested cache parameter group name does not refer to an existing cache parameter group.
+ *The requested cache parameter group name does not refer to an existing cache parameter + * group.
* * @throws {@link CacheSecurityGroupNotFoundFault} (client fault) - *The requested cache security group name does not refer to an existing cache security group.
+ *The requested cache security group name does not refer to an existing cache security + * group.
* * @throws {@link CacheSubnetGroupNotFoundFault} (client fault) - *The requested cache subnet group name does not refer to an existing cache subnet group.
+ *The requested cache subnet group name does not refer to an existing cache subnet + * group.
* * @throws {@link InvalidARNFault} (client fault) - *The requested Amazon Resource Name (ARN) does not refer to an existing resource.
+ *The requested Amazon Resource Name (ARN) does not refer to an existing + * resource.
* * @throws {@link InvalidReplicationGroupStateFault} (client fault) *The requested replication group is not in the available
state.
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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -220,14 +219,16 @@ export interface ModifyCacheClusterCommandOutput extends ModifyCacheClusterResul *The requested cluster ID does not refer to an existing cluster.
* * @throws {@link CacheParameterGroupNotFoundFault} (client fault) - *The requested cache parameter group name does not refer to an existing cache parameter group.
+ *The requested cache parameter group name does not refer to an existing cache parameter + * group.
* * @throws {@link CacheSecurityGroupNotFoundFault} (client fault) - *The requested cache security group name does not refer to an existing cache security group.
+ *The requested cache security group name does not refer to an existing cache security + * group.
* * @throws {@link InsufficientCacheClusterCapacityFault} (client fault) - *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 cache node type is not available in the specified Availability Zone. For + * more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
* * @throws {@link InvalidCacheClusterStateFault} (client fault) *The requested cluster is not in the available
state.
The VPC network is in an invalid state.
* * @throws {@link NodeQuotaForClusterExceededFault} (client fault) - *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 in a single cluster.
* * @throws {@link NodeQuotaForCustomerExceededFault} (client fault) - *The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
+ *The request cannot be processed because it would exceed the allowed number of cache + * nodes per customer.
* * @throws {@link ElastiCacheServiceException} *Base exception class for all service exceptions from ElastiCache service.
diff --git a/clients/client-elasticache/src/commands/ModifyCacheParameterGroupCommand.ts b/clients/client-elasticache/src/commands/ModifyCacheParameterGroupCommand.ts index a90c74b17c117..5c2ee8cab28f1 100644 --- a/clients/client-elasticache/src/commands/ModifyCacheParameterGroupCommand.ts +++ b/clients/client-elasticache/src/commands/ModifyCacheParameterGroupCommand.ts @@ -36,9 +36,8 @@ export interface ModifyCacheParameterGroupCommandOutput extends CacheParameterGr /** * @public - *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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -69,10 +68,12 @@ export interface ModifyCacheParameterGroupCommandOutput extends CacheParameterGr * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape. * * @throws {@link CacheParameterGroupNotFoundFault} (client fault) - *The requested cache parameter group name does not refer to an existing cache parameter group.
+ *The requested cache parameter group name does not refer to an existing cache parameter + * group.
* * @throws {@link InvalidCacheParameterGroupStateFault} (client fault) - *The current state of the cache parameter group does not allow the requested operation to occur.
+ *The current state of the cache parameter group does not allow the requested operation + * to occur.
* * @throws {@link InvalidGlobalReplicationGroupStateFault} (client fault) *The Global datastore is not available or in primary-only state.
diff --git a/clients/client-elasticache/src/commands/ModifyCacheSubnetGroupCommand.ts b/clients/client-elasticache/src/commands/ModifyCacheSubnetGroupCommand.ts index 9b034ad2839de..c7a0754b7d6be 100644 --- a/clients/client-elasticache/src/commands/ModifyCacheSubnetGroupCommand.ts +++ b/clients/client-elasticache/src/commands/ModifyCacheSubnetGroupCommand.ts @@ -87,10 +87,12 @@ export interface ModifyCacheSubnetGroupCommandOutput extends ModifyCacheSubnetGr * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape. * * @throws {@link CacheSubnetGroupNotFoundFault} (client fault) - *The requested cache subnet group name does not refer to an existing cache subnet group.
+ *The requested cache subnet group name does not refer to an existing cache subnet + * group.
* * @throws {@link CacheSubnetQuotaExceededFault} (client fault) - *The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.
+ *The request cannot be processed because it would exceed the allowed number of subnets + * in a cache subnet group.
* * @throws {@link InvalidSubnet} (client fault) *An invalid subnet identifier was specified.
@@ -99,8 +101,10 @@ export interface ModifyCacheSubnetGroupCommandOutput extends ModifyCacheSubnetGr *The requested subnet is being used by another cache subnet group.
* * @throws {@link SubnetNotAllowedFault} (client fault) - *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.
+ *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.
* * @throws {@link ElastiCacheServiceException} *Base exception class for all service exceptions from ElastiCache service.
diff --git a/clients/client-elasticache/src/commands/ModifyReplicationGroupCommand.ts b/clients/client-elasticache/src/commands/ModifyReplicationGroupCommand.ts index 9e7e9534acfc9..fbabf5ea2a710 100644 --- a/clients/client-elasticache/src/commands/ModifyReplicationGroupCommand.ts +++ b/clients/client-elasticache/src/commands/ModifyReplicationGroupCommand.ts @@ -40,13 +40,13 @@ export interface ModifyReplicationGroupCommandOutput extends ModifyReplicationGr *- * Scaling for Amazon ElastiCache for Redis (cluster mode enabled) - * in the ElastiCache User Guide
+ * Scaling for Amazon ElastiCache for Redis (cluster mode enabled) in + * the ElastiCache User Guide *- * ModifyReplicationGroupShardConfiguration - * in the ElastiCache API Reference
+ * ModifyReplicationGroupShardConfiguration in the ElastiCache API + * Reference *The requested cluster ID does not refer to an existing cluster.
* * @throws {@link CacheParameterGroupNotFoundFault} (client fault) - *The requested cache parameter group name does not refer to an existing cache parameter group.
+ *The requested cache parameter group name does not refer to an existing cache parameter + * group.
* * @throws {@link CacheSecurityGroupNotFoundFault} (client fault) - *The requested cache security group name does not refer to an existing cache security group.
+ *The requested cache security group name does not refer to an existing cache security + * group.
* * @throws {@link InsufficientCacheClusterCapacityFault} (client fault) - *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 cache node type is not available in the specified Availability Zone. For + * more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
* * @throws {@link InvalidCacheClusterStateFault} (client fault) *The requested cluster is not in the available
state.
The VPC network is in an invalid state.
* * @throws {@link NodeQuotaForClusterExceededFault} (client fault) - *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 in a single cluster.
* * @throws {@link NodeQuotaForCustomerExceededFault} (client fault) - *The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
+ *The request cannot be processed because it would exceed the allowed number of cache + * nodes per customer.
* * @throws {@link ReplicationGroupNotFoundFault} (client fault) *The specified replication group does not exist.
diff --git a/clients/client-elasticache/src/commands/ModifyReplicationGroupShardConfigurationCommand.ts b/clients/client-elasticache/src/commands/ModifyReplicationGroupShardConfigurationCommand.ts index f8ed77e933791..0b7bf6babe7cb 100644 --- a/clients/client-elasticache/src/commands/ModifyReplicationGroupShardConfigurationCommand.ts +++ b/clients/client-elasticache/src/commands/ModifyReplicationGroupShardConfigurationCommand.ts @@ -45,8 +45,8 @@ export interface ModifyReplicationGroupShardConfigurationCommandOutput /** * @public - *Modifies a replication group's shards (node groups) by allowing you to - * add shards, remove shards, or rebalance the keyspaces among existing shards.
+ *Modifies a replication group's shards (node groups) by allowing you to add shards, + * remove shards, or rebalance the keyspaces among existing shards.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -206,8 +206,8 @@ export interface ModifyReplicationGroupShardConfigurationCommandOutput * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape. * * @throws {@link InsufficientCacheClusterCapacityFault} (client fault) - *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 cache node type is not available in the specified Availability Zone. For + * more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
* * @throws {@link InvalidCacheClusterStateFault} (client fault) *The requested cluster is not in the available
state.
The VPC network is in an invalid state.
* * @throws {@link NodeGroupsPerReplicationGroupQuotaExceededFault} (client fault) - *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 maximum allowed number of + * node groups (shards) in a single replication group. The default maximum is 90
* * @throws {@link NodeQuotaForCustomerExceededFault} (client fault) - *The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
+ *The request cannot be processed because it would exceed the allowed number of cache + * nodes per customer.
* * @throws {@link ReplicationGroupNotFoundFault} (client fault) *The specified replication group does not exist.
diff --git a/clients/client-elasticache/src/commands/PurchaseReservedCacheNodesOfferingCommand.ts b/clients/client-elasticache/src/commands/PurchaseReservedCacheNodesOfferingCommand.ts index 908b700abf216..b2cc9234f155f 100644 --- a/clients/client-elasticache/src/commands/PurchaseReservedCacheNodesOfferingCommand.ts +++ b/clients/client-elasticache/src/commands/PurchaseReservedCacheNodesOfferingCommand.ts @@ -44,10 +44,9 @@ export interface PurchaseReservedCacheNodesOfferingCommandOutput /** * @public - *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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -108,13 +107,16 @@ export interface PurchaseReservedCacheNodesOfferingCommandOutput *You already have a reservation with the given identifier.
* * @throws {@link ReservedCacheNodeQuotaExceededFault} (client fault) - *The request cannot be processed because it would exceed the user's cache node quota.
+ *The request cannot be processed because it would exceed the user's cache node + * quota.
* * @throws {@link ReservedCacheNodesOfferingNotFoundFault} (client fault) *The requested cache node offering does not exist.
* * @throws {@link TagQuotaPerResourceExceeded} (client fault) - *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 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.
* * @throws {@link ElastiCacheServiceException} *Base exception class for all service exceptions from ElastiCache service.
diff --git a/clients/client-elasticache/src/commands/RebalanceSlotsInGlobalReplicationGroupCommand.ts b/clients/client-elasticache/src/commands/RebalanceSlotsInGlobalReplicationGroupCommand.ts index 08b7ca6a9a83e..866c512f38887 100644 --- a/clients/client-elasticache/src/commands/RebalanceSlotsInGlobalReplicationGroupCommand.ts +++ b/clients/client-elasticache/src/commands/RebalanceSlotsInGlobalReplicationGroupCommand.ts @@ -45,7 +45,8 @@ export interface RebalanceSlotsInGlobalReplicationGroupCommandOutput /** * @public - *Redistribute slots to ensure uniform distribution across existing shards in the cluster.
+ *Redistribute slots to ensure uniform distribution across existing shards in the + * cluster.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-elasticache/src/commands/RebootCacheClusterCommand.ts b/clients/client-elasticache/src/commands/RebootCacheClusterCommand.ts index b3d8e3f143981..f582b742f8a14 100644 --- a/clients/client-elasticache/src/commands/RebootCacheClusterCommand.ts +++ b/clients/client-elasticache/src/commands/RebootCacheClusterCommand.ts @@ -36,17 +36,18 @@ export interface RebootCacheClusterCommandOutput extends RebootCacheClusterResul /** * @public - *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.
+ *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.
+ *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.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-elasticache/src/commands/RemoveTagsFromResourceCommand.ts b/clients/client-elasticache/src/commands/RemoveTagsFromResourceCommand.ts index bbdd2048c701d..b3c0ec70dab80 100644 --- a/clients/client-elasticache/src/commands/RemoveTagsFromResourceCommand.ts +++ b/clients/client-elasticache/src/commands/RemoveTagsFromResourceCommand.ts @@ -36,10 +36,11 @@ export interface RemoveTagsFromResourceCommandOutput extends TagListMessage, __M /** * @public - *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.
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.
The requested cluster ID does not refer to an existing cluster.
* * @throws {@link CacheParameterGroupNotFoundFault} (client fault) - *The requested cache parameter group name does not refer to an existing cache parameter group.
+ *The requested cache parameter group name does not refer to an existing cache parameter + * group.
* * @throws {@link CacheSecurityGroupNotFoundFault} (client fault) - *The requested cache security group name does not refer to an existing cache security group.
+ *The requested cache security group name does not refer to an existing cache security + * group.
* * @throws {@link CacheSubnetGroupNotFoundFault} (client fault) - *The requested cache subnet group name does not refer to an existing cache subnet group.
+ *The requested cache subnet group name does not refer to an existing cache subnet + * group.
* * @throws {@link InvalidARNFault} (client fault) - *The requested Amazon Resource Name (ARN) does not refer to an existing resource.
+ *The requested Amazon Resource Name (ARN) does not refer to an existing + * resource.
* * @throws {@link InvalidReplicationGroupStateFault} (client fault) *The requested replication group is not in the available
state.
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.
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.
The requested cache parameter group name does not refer to an existing cache parameter group.
+ *The requested cache parameter group name does not refer to an existing cache parameter + * group.
* * @throws {@link InvalidCacheParameterGroupStateFault} (client fault) - *The current state of the cache parameter group does not allow the requested operation to occur.
+ *The current state of the cache parameter group does not allow the requested operation + * to occur.
* * @throws {@link InvalidGlobalReplicationGroupStateFault} (client fault) *The Global datastore is not available or in primary-only state.
diff --git a/clients/client-elasticache/src/commands/RevokeCacheSecurityGroupIngressCommand.ts b/clients/client-elasticache/src/commands/RevokeCacheSecurityGroupIngressCommand.ts index 918606a7d8068..802dea9318058 100644 --- a/clients/client-elasticache/src/commands/RevokeCacheSecurityGroupIngressCommand.ts +++ b/clients/client-elasticache/src/commands/RevokeCacheSecurityGroupIngressCommand.ts @@ -41,9 +41,8 @@ export interface RevokeCacheSecurityGroupIngressCommandOutput /** * @public - *Revokes ingress from a cache security group. - * Use this operation to disallow access from an Amazon EC2 security group - * that had been previously authorized.
+ *Revokes ingress from a cache security group. Use this operation to disallow access + * from an Amazon EC2 security group that had been previously authorized.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -82,10 +81,12 @@ export interface RevokeCacheSecurityGroupIngressCommandOutput * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape. * * @throws {@link AuthorizationNotFoundFault} (client fault) - *The specified Amazon EC2 security group is not authorized for the specified cache security group.
+ *The specified Amazon EC2 security group is not authorized for the specified cache + * security group.
* * @throws {@link CacheSecurityGroupNotFoundFault} (client fault) - *The requested cache security group name does not refer to an existing cache security group.
+ *The requested cache security group name does not refer to an existing cache security + * group.
* * @throws {@link InvalidCacheSecurityGroupStateFault} (client fault) *The current state of the cache security group does not allow deletion.
diff --git a/clients/client-elasticache/src/commands/TestFailoverCommand.ts b/clients/client-elasticache/src/commands/TestFailoverCommand.ts index e10cad1424029..de11a5732841c 100644 --- a/clients/client-elasticache/src/commands/TestFailoverCommand.ts +++ b/clients/client-elasticache/src/commands/TestFailoverCommand.ts @@ -36,49 +36,63 @@ export interface TestFailoverCommandOutput extends TestFailoverResult, __Metadat /** * @public - *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.
+ *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.
+ *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 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.
+ *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:
+ *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:
*Replication group message: Test Failover API called for node group
+ *
Replication group message: Test Failover API called for node
+ * group
*
Cache cluster message: Failover from primary node
+ *
Cache cluster message: Failover from primary node
+ *
*
Replication group message: Failover from primary node
+ *
Replication group message: Failover from primary node
+ *
*
Cache cluster message: Recovering cache nodes
+ *
Cache cluster message: Recovering cache nodes
+ *
*
Cache cluster message: Finished recovery for cache nodes
+ *
Cache cluster message: Finished recovery for cache nodes
+ *
*
- * Viewing ElastiCache Events - * in the ElastiCache User Guide + * Viewing + * ElastiCache Events in the ElastiCache User + * Guide *
*Also see, Testing Multi-AZ in the ElastiCache User Guide.
+ *Also see, Testing + * Multi-AZ in the ElastiCache User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -261,7 +277,8 @@ export interface TestFailoverCommandOutput extends TestFailoverResult, __Metadat * * @throws {@link NodeGroupNotFoundFault} (client fault) *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.
NodeGroupId
value correctly.
*
* @throws {@link ReplicationGroupNotFoundFault} (client fault)
* The specified replication group does not exist.
diff --git a/clients/client-elasticache/src/commands/TestMigrationCommand.ts b/clients/client-elasticache/src/commands/TestMigrationCommand.ts new file mode 100644 index 0000000000000..513c6c3ac6114 --- /dev/null +++ b/clients/client-elasticache/src/commands/TestMigrationCommand.ts @@ -0,0 +1,277 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@smithy/types"; + +import { ElastiCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ElastiCacheClient"; +import { TestMigrationMessage, TestMigrationResponse } from "../models/models_0"; +import { de_TestMigrationCommand, se_TestMigrationCommand } from "../protocols/Aws_query"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link TestMigrationCommand}. + */ +export interface TestMigrationCommandInput extends TestMigrationMessage {} +/** + * @public + * + * The output of {@link TestMigrationCommand}. + */ +export interface TestMigrationCommandOutput extends TestMigrationResponse, __MetadataBearer {} + +/** + * @public + *Async API to test connection between source and target replication group.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, TestMigrationCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, TestMigrationCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const input = { // TestMigrationMessage + * ReplicationGroupId: "STRING_VALUE", // required + * CustomerNodeEndpointList: [ // CustomerNodeEndpointList // required + * { // CustomerNodeEndpoint + * Address: "STRING_VALUE", + * Port: Number("int"), + * }, + * ], + * }; + * const command = new TestMigrationCommand(input); + * const response = await client.send(command); + * // { // TestMigrationResponse + * // ReplicationGroup: { // ReplicationGroup + * // ReplicationGroupId: "STRING_VALUE", + * // Description: "STRING_VALUE", + * // GlobalReplicationGroupInfo: { // GlobalReplicationGroupInfo + * // GlobalReplicationGroupId: "STRING_VALUE", + * // GlobalReplicationGroupMemberRole: "STRING_VALUE", + * // }, + * // Status: "STRING_VALUE", + * // PendingModifiedValues: { // ReplicationGroupPendingModifiedValues + * // PrimaryClusterId: "STRING_VALUE", + * // AutomaticFailoverStatus: "enabled" || "disabled", + * // Resharding: { // ReshardingStatus + * // SlotMigration: { // SlotMigration + * // ProgressPercentage: Number("double"), + * // }, + * // }, + * // AuthTokenStatus: "SETTING" || "ROTATING", + * // UserGroups: { // UserGroupsUpdateStatus + * // UserGroupIdsToAdd: [ // UserGroupIdList + * // "STRING_VALUE", + * // ], + * // UserGroupIdsToRemove: [ + * // "STRING_VALUE", + * // ], + * // }, + * // LogDeliveryConfigurations: [ // PendingLogDeliveryConfigurationList + * // { // PendingLogDeliveryConfiguration + * // LogType: "slow-log" || "engine-log", + * // DestinationType: "cloudwatch-logs" || "kinesis-firehose", + * // DestinationDetails: { // DestinationDetails + * // CloudWatchLogsDetails: { // CloudWatchLogsDestinationDetails + * // LogGroup: "STRING_VALUE", + * // }, + * // KinesisFirehoseDetails: { // KinesisFirehoseDestinationDetails + * // DeliveryStream: "STRING_VALUE", + * // }, + * // }, + * // LogFormat: "text" || "json", + * // }, + * // ], + * // TransitEncryptionEnabled: true || false, + * // TransitEncryptionMode: "preferred" || "required", + * // ClusterMode: "enabled" || "disabled" || "compatible", + * // }, + * // MemberClusters: [ // ClusterIdList + * // "STRING_VALUE", + * // ], + * // NodeGroups: [ // NodeGroupList + * // { // NodeGroup + * // NodeGroupId: "STRING_VALUE", + * // Status: "STRING_VALUE", + * // PrimaryEndpoint: { // Endpoint + * // Address: "STRING_VALUE", + * // Port: Number("int"), + * // }, + * // ReaderEndpoint: { + * // Address: "STRING_VALUE", + * // Port: Number("int"), + * // }, + * // Slots: "STRING_VALUE", + * // NodeGroupMembers: [ // NodeGroupMemberList + * // { // NodeGroupMember + * // CacheClusterId: "STRING_VALUE", + * // CacheNodeId: "STRING_VALUE", + * // ReadEndpoint: { + * // Address: "STRING_VALUE", + * // Port: Number("int"), + * // }, + * // PreferredAvailabilityZone: "STRING_VALUE", + * // PreferredOutpostArn: "STRING_VALUE", + * // CurrentRole: "STRING_VALUE", + * // }, + * // ], + * // }, + * // ], + * // SnapshottingClusterId: "STRING_VALUE", + * // AutomaticFailover: "enabled" || "disabled" || "enabling" || "disabling", + * // MultiAZ: "enabled" || "disabled", + * // ConfigurationEndpoint: "The value for a parameter is invalid.
+ * + * @throws {@link InvalidReplicationGroupStateFault} (client fault) + *The requested replication group is not in the available
state.
The targeted replication group is not available.
+ * + * @throws {@link ReplicationGroupNotFoundFault} (client fault) + *The specified replication group does not exist.
+ * + * @throws {@link ElastiCacheServiceException} + *Base exception class for all service exceptions from ElastiCache service.
+ * + */ +export class TestMigrationCommand extends $Command< + TestMigrationCommandInput, + TestMigrationCommandOutput, + ElastiCacheClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: TestMigrationCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackAmazon 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.
+ *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.
* * @packageDocumentation */ diff --git a/clients/client-elasticache/src/models/models_0.ts b/clients/client-elasticache/src/models/models_0.ts index 16e4baaaa305a..02ead5eda91d3 100644 --- a/clients/client-elasticache/src/models/models_0.ts +++ b/clients/client-elasticache/src/models/models_0.ts @@ -5,8 +5,11 @@ import { ElastiCacheServiceException as __BaseException } from "./ElastiCacheSer /** * @public - *A tag that can be added to an ElastiCache cluster or replication group. - * Tags are composed of a Key/Value pair. 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. A tag with a null Value is permitted.
+ *A tag that can be added to an ElastiCache cluster or replication group. Tags are + * composed of a Key/Value pair. 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. A tag with a null Value is permitted.
*/ export interface Tag { /** @@ -29,18 +32,20 @@ export interface Tag { export interface AddTagsToResourceMessage { /** * @public - *The Amazon Resource Name (ARN) of the resource to which the tags are to be added,
- * for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
- * or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot
.
- * ElastiCache resources are cluster and snapshot.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.
+ *The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for
+ * example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
or
+ * arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot
.
+ * ElastiCache resources are cluster and
+ * snapshot.
For more information about ARNs, see Amazon Resource Names (ARNs) + * and Amazon Service Namespaces.
*/ ResourceName: string | undefined; /** * @public - *A list of tags to be added to this resource. A tag is a key-value pair. - * A tag key must be accompanied by a tag value, although null is accepted.
+ *A list of tags to be added to this resource. A tag is a key-value pair. A tag key must + * be accompanied by a tag value, although null is accepted.
*/ Tags: Tag[] | undefined; } @@ -67,7 +72,8 @@ export class CacheClusterNotFoundFault extends __BaseException { /** * @public - *The requested cache parameter group name does not refer to an existing cache parameter group.
+ *The requested cache parameter group name does not refer to an existing cache parameter + * group.
*/ export class CacheParameterGroupNotFoundFault extends __BaseException { readonly name: "CacheParameterGroupNotFoundFault" = "CacheParameterGroupNotFoundFault"; @@ -87,7 +93,8 @@ export class CacheParameterGroupNotFoundFault extends __BaseException { /** * @public - *The requested cache security group name does not refer to an existing cache security group.
+ *The requested cache security group name does not refer to an existing cache security + * group.
*/ export class CacheSecurityGroupNotFoundFault extends __BaseException { readonly name: "CacheSecurityGroupNotFoundFault" = "CacheSecurityGroupNotFoundFault"; @@ -107,7 +114,8 @@ export class CacheSecurityGroupNotFoundFault extends __BaseException { /** * @public - *The requested cache subnet group name does not refer to an existing cache subnet group.
+ *The requested cache subnet group name does not refer to an existing cache subnet + * group.
*/ export class CacheSubnetGroupNotFoundFault extends __BaseException { readonly name: "CacheSubnetGroupNotFoundFault" = "CacheSubnetGroupNotFoundFault"; @@ -127,7 +135,8 @@ export class CacheSubnetGroupNotFoundFault extends __BaseException { /** * @public - *The requested Amazon Resource Name (ARN) does not refer to an existing resource.
+ *The requested Amazon Resource Name (ARN) does not refer to an existing + * resource.
*/ export class InvalidARNFault extends __BaseException { readonly name: "InvalidARNFault" = "InvalidARNFault"; @@ -228,7 +237,8 @@ export class SnapshotNotFoundFault extends __BaseException { /** * @public *Represents the output from the AddTagsToResource
,
- * ListTagsForResource
, and RemoveTagsFromResource
operations.
ListTagsForResource
, and RemoveTagsFromResource
+ * operations.
*/
export interface TagListMessage {
/**
@@ -240,7 +250,9 @@ export interface TagListMessage {
/**
* @public
- * 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 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.
*/ export class TagQuotaPerResourceExceeded extends __BaseException { readonly name: "TagQuotaPerResourceExceeded" = "TagQuotaPerResourceExceeded"; @@ -300,31 +312,34 @@ export class UserNotFoundFault extends __BaseException { /** * @public - *Represents the allowed node types you can use to modify your cluster or replication group.
+ *Represents the allowed node types you can use to modify your cluster or replication + * group.
*/ export interface AllowedNodeTypeModificationsMessage { /** * @public - *A string list, each element of which specifies a cache node type which you can use - * to scale your cluster or replication group.
- *When scaling up a Redis cluster or replication group using ModifyCacheCluster
or
- * ModifyReplicationGroup
,
- * use a value from this list for the CacheNodeType
parameter.
A string list, each element of which specifies a cache node type which you can use to + * scale your cluster or replication group.
+ *When scaling up a Redis cluster or replication group using
+ * ModifyCacheCluster
or ModifyReplicationGroup
, use a value
+ * from this list for the CacheNodeType
parameter.
A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group. - * - * When scaling down a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.
+ *A string list, each element of which specifies a cache node type which you can use to + * scale your cluster or replication group. When scaling down a Redis cluster or + * replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from + * this list for the CacheNodeType parameter.
*/ ScaleDownModifications?: string[]; } /** * @public - *The specified Amazon EC2 security group is already authorized for the specified cache security group.
+ *The specified Amazon EC2 security group is already authorized for the specified cache + * security group.
*/ export class AuthorizationAlreadyExistsFault extends __BaseException { readonly name: "AuthorizationAlreadyExistsFault" = "AuthorizationAlreadyExistsFault"; @@ -355,15 +370,16 @@ export interface AuthorizeCacheSecurityGroupIngressMessage { /** * @public - *The Amazon EC2 security group to be authorized for ingress to the cache security group.
+ *The Amazon EC2 security group to be authorized for ingress to the cache security + * group.
*/ EC2SecurityGroupName: string | undefined; /** * @public - *The Amazon account number of the Amazon EC2 security group owner. - * Note that this is not the same thing as an Amazon access key ID - - * you must provide a valid Amazon account number for this parameter.
+ *The Amazon account number of the Amazon EC2 security group owner. Note that this is + * not the same thing as an Amazon access key ID - you must provide a valid Amazon account + * number for this parameter.
*/ EC2SecurityGroupOwnerId: string | undefined; } @@ -434,7 +450,8 @@ export interface CacheSecurityGroup { /** * @public - *A list of Amazon EC2 security groups that are associated with this cache security group.
+ *A list of Amazon EC2 security groups that are associated with this cache security + * group.
*/ EC2SecurityGroups?: EC2SecurityGroup[]; @@ -629,7 +646,8 @@ export interface ProcessedUpdateAction { /** * @public - *Update action that has failed to be processed for the corresponding apply/stop request
+ *Update action that has failed to be processed for the corresponding apply/stop + * request
*/ export interface UnprocessedUpdateAction { /** @@ -715,7 +733,9 @@ export interface CompleteMigrationMessage { /** * @public - *Forces the migration to stop without ensuring that data is in sync. It is recommended to use this option only to abort the migration and not recommended when application wants to continue migration to ElastiCache.
+ *Forces the migration to stop without ensuring that data is in sync. It is recommended + * to use this option only to abort the migration and not recommended when application + * wants to continue migration to ElastiCache.
*/ Force?: boolean; } @@ -753,7 +773,8 @@ export type ClusterMode = (typeof ClusterMode)[keyof typeof ClusterMode]; /** * @public - *Represents the information required for client programs to connect to a cache node.
+ *Represents the information required for client programs to connect to a cache + * node.
*/ export interface Endpoint { /** @@ -785,7 +806,8 @@ export type DataTieringStatus = (typeof DataTieringStatus)[keyof typeof DataTier /** * @public - *The name of the Global datastore and role of this replication group in the Global datastore.
+ *The name of the Global datastore and role of this replication group in the Global + * datastore.
*/ export interface GlobalReplicationGroupInfo { /** @@ -796,7 +818,8 @@ export interface GlobalReplicationGroupInfo { /** * @public - *The role of the replication group in a Global datastore. Can be primary or secondary.
+ *The role of the replication group in a Global datastore. Can be primary or + * secondary.
*/ GlobalReplicationGroupMemberRole?: string; } @@ -841,7 +864,8 @@ export interface KinesisFirehoseDestinationDetails { /** * @public - *Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
+ *Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose + * destination.
*/ export interface DestinationDetails { /** @@ -924,19 +948,22 @@ export type LogDeliveryConfigurationStatus = export interface LogDeliveryConfiguration { /** * @public - *Refers to slow-log or engine-log.
+ *Refers to slow-log or + * engine-log.
*/ LogType?: LogType | string; /** * @public - *Returns the destination type, either cloudwatch-logs
or kinesis-firehose
.
Returns the destination type, either cloudwatch-logs
or
+ * kinesis-firehose
.
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
+ *Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose + * destination.
*/ DestinationDetails?: DestinationDetails; @@ -948,7 +975,9 @@ export interface LogDeliveryConfiguration { /** * @public - *Returns the log delivery configuration status. Values are one of enabling
| disabling
| modifying
| active
| error
+ *
Returns the log delivery configuration status. Values are one of enabling
+ * | disabling
| modifying
| active
|
+ * error
*
The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
+ *The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, + * etc.).
*/ CacheNodeId?: string; @@ -1028,31 +1058,32 @@ export interface NodeGroupMember { /** * @public *The role that is currently assigned to the node - primary
or
- * replica
. This member is only applicable for Redis (cluster mode disabled)
- * replication groups.
replica
. This member is only applicable for Redis (cluster mode
+ * disabled) replication groups.
*/
CurrentRole?: string;
}
/**
* @public
- * Represents a collection of cache nodes in a replication group. - * One node in the node group is the read/write primary node. - * All the other nodes are read-only Replica nodes.
+ *Represents a collection of cache nodes in a replication group. One node in the node + * group is the read/write primary node. All the other nodes are read-only Replica + * nodes.
*/ export interface NodeGroup { /** * @public - *The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. - * A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for - * a node group.
+ *The identifier for the node group (shard). A Redis (cluster mode disabled) replication + * group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster + * mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. + * Optionally, the user can provide the id for a node group.
*/ NodeGroupId?: string; /** * @public *The current state of this replication group - creating
,
- * available
, modifying
, deleting
.
available
, modifying
, deleting
.
*/
Status?: string;
@@ -1076,7 +1107,8 @@ export interface NodeGroup {
/**
* @public
- * A list containing information about individual nodes within the node group (shard).
+ *A list containing information about individual nodes within the node group + * (shard).
*/ NodeGroupMembers?: NodeGroupMember[]; } @@ -1117,7 +1149,8 @@ export type PendingAutomaticFailoverStatus = export interface PendingLogDeliveryConfiguration { /** * @public - *Refers to slow-log or engine-log..
+ *Refers to slow-log or + * engine-log..
*/ LogType?: LogType | string; @@ -1129,7 +1162,8 @@ export interface PendingLogDeliveryConfiguration { /** * @public - *Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
+ *Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose + * destination.
*/ DestinationDetails?: DestinationDetails; @@ -1198,14 +1232,15 @@ export interface UserGroupsUpdateStatus { /** * @public - *The settings to be applied to the Redis replication group, - * either immediately or during the next maintenance window.
+ *The settings to be applied to the Redis replication group, either immediately or + * during the next maintenance window.
*/ export interface ReplicationGroupPendingModifiedValues { /** * @public - *The primary cluster ID that is applied immediately (if --apply-immediately
- * was specified), or during the next maintenance window.
The primary cluster ID that is applied immediately (if
+ * --apply-immediately
was specified), or during the next maintenance
+ * window.
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
+ *A setting that allows you to migrate your clients to use in-transit encryption, with + * no downtime.
*/ TransitEncryptionMode?: TransitEncryptionMode | string; /** * @public - *Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. - * - * Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
+ *Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first + * set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect + * using both cluster mode enabled and cluster mode disabled. After you migrate all Redis + * clients to use cluster mode enabled, you can then complete cluster mode configuration + * and set the cluster mode to Enabled.
*/ ClusterMode?: ClusterMode | string; } @@ -1279,26 +1317,23 @@ export interface ReplicationGroup { /** * @public - *The name of the Global datastore and role of this replication group in the Global datastore.
+ *The name of the Global datastore and role of this replication group in the Global + * datastore.
*/ GlobalReplicationGroupInfo?: GlobalReplicationGroupInfo; /** * @public - *The current state of this replication group -
- * creating
,
- * available
,
- * modifying
,
- * deleting
,
- * create-failed
,
- * snapshotting
.
The current state of this replication group - creating
,
+ * available
, modifying
, deleting
,
+ * create-failed
, snapshotting
.
A group of settings to be applied to the replication group, - * either immediately or during the next maintenance window.
+ *A group of settings to be applied to the replication group, either immediately or + * during the next maintenance window.
*/ PendingModifiedValues?: ReplicationGroupPendingModifiedValues; @@ -1310,16 +1345,16 @@ export interface ReplicationGroup { /** * @public - *A list of node groups in this replication group. - * For Redis (cluster mode disabled) replication groups, this is a single-element list. - * For Redis (cluster mode enabled) replication groups, the list contains an entry for each - * node group (shard).
+ *A list of node groups in this replication group. For Redis (cluster mode disabled) + * replication groups, this is a single-element list. For Redis (cluster mode enabled) + * replication groups, the list contains an entry for each node group (shard).
*/ NodeGroups?: NodeGroup[]; /** * @public - *The cluster ID that is used as the daily snapshot source for the replication group.
+ *The cluster ID that is used as the daily snapshot source for the replication + * group.
*/ SnapshottingClusterId?: string; @@ -1331,15 +1366,16 @@ export interface ReplicationGroup { /** * @public - *A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ + *
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more + * information, see Minimizing Downtime: Multi-AZ *
*/ MultiAZ?: MultiAZStatus | string; /** * @public - *The configuration endpoint for this replication group. - * Use the configuration endpoint to connect to this replication group.
+ *The configuration endpoint for this replication group. Use the configuration endpoint + * to connect to this replication group.
*/ ConfigurationEndpoint?: Endpoint; @@ -1349,28 +1385,32 @@ export interface ReplicationGroup { * deleting them. For example, if you setSnapshotRetentionLimit
to 5, a
* snapshot that was taken today is retained for 5 days before being deleted.
*
- * If the value of SnapshotRetentionLimit
is set to zero (0), backups are turned off.
If the value of SnapshotRetentionLimit
is set to zero (0), backups
+ * are turned off.
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
+ *The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot + * of your node group (shard).
*Example: 05:00-09:00
*
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
+ *If you do not specify this parameter, ElastiCache automatically chooses an appropriate + * time range.
*This parameter is only valid if the Engine
parameter is redis
.
This parameter is only valid if the Engine
parameter is
+ * redis
.
A flag indicating whether or not this replication group is cluster enabled; - * i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).
+ *A flag indicating whether or not this replication group is cluster enabled; i.e., + * whether its data can be partitioned across multiple shards (API/CLI: node + * groups).
*Valid values: true
| false
*
The name of the compute and memory capacity node type for each node in the replication group.
+ *The name of the compute and memory capacity node type for each node in the replication + * group.
*/ CacheNodeType?: string; /** * @public - *A flag that enables using an AuthToken
(password)
- * when issuing Redis commands.
A flag that enables using an AuthToken
(password) when issuing Redis
+ * commands.
Default: false
*
A flag that enables in-transit encryption when set to true
.
- * Required:
- * Only available when creating a replication group in an Amazon VPC using redis version 3.2.6
, 4.x
or later.
3.2.6
, 4.x
or
+ * later.
* Default: false
*
A flag that enables encryption at-rest when set to true
.
You cannot modify the value of AtRestEncryptionEnabled
- * after the cluster is created. To enable encryption at-rest on a cluster
- * you must set AtRestEncryptionEnabled
to true
- * when you create a cluster.
You cannot modify the value of AtRestEncryptionEnabled
after the cluster
+ * is created. To enable encryption at-rest on a cluster you must set
+ * AtRestEncryptionEnabled
to true
when you create a
+ * cluster.
- * Required:
- * Only available when creating a replication group in an Amazon VPC using redis version 3.2.6
, 4.x
or later.
3.2.6
, 4.x
or
+ * later.
* Default: false
*
Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. - * For more information, see Data tiering.
+ *Enables data tiering. Data tiering is only supported for replication groups using the + * r6gd node type. This parameter must be set to true when using r6gd nodes. For more + * information, see Data tiering.
*/ DataTiering?: DataTieringStatus | string; /** * @public - *If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
+ *If you are running Redis engine version 6.0 or later, set this parameter to yes if you + * want to opt-in to the next auto minor version upgrade campaign. This parameter is + * disabled for previous versions.
*/ AutoMinorVersionUpgrade?: boolean; /** * @public - *Must be either ipv4
| ipv6
| dual_stack
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the
- * Nitro system.
Must be either ipv4
| ipv6
| dual_stack
. IPv6
+ * is supported for workloads using Redis engine version 6.2 onward or Memcached engine
+ * version 1.6.6 on all instances built on the Nitro system.
The network type you choose when modifying a cluster, either ipv4
| ipv6
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the
- * Nitro system.
The network type you choose when modifying a cluster, either ipv4
|
+ * ipv6
. IPv6 is supported for workloads using Redis engine version 6.2
+ * onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
+ *A setting that allows you to migrate your clients to use in-transit encryption, with + * no downtime.
*/ TransitEncryptionMode?: TransitEncryptionMode | string; /** * @public - *Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. - * - * Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
+ *Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first + * set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect + * using both cluster mode enabled and cluster mode disabled. After you migrate all Redis + * clients to use cluster mode enabled, you can then complete cluster mode configuration + * and set the cluster mode to Enabled.
*/ ClusterMode?: ClusterMode | string; } @@ -1545,20 +1596,21 @@ export interface CopySnapshotMessage { /** * @public - *A name for the snapshot copy. - * ElastiCache does not permit overwriting a snapshot, therefore - * this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.
+ *A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, + * therefore this name must be unique within its context - ElastiCache or an Amazon S3 + * bucket if exporting.
*/ TargetSnapshotName: string | undefined; /** * @public - *The Amazon S3 bucket to which the snapshot is exported. - * This parameter is used only when exporting a snapshot for external access.
- *When using this parameter to export a snapshot, - * be sure Amazon ElastiCache has the needed permissions to this S3 bucket. - * For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.
- *For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.
+ *The Amazon S3 bucket to which the snapshot is exported. This parameter is used only + * when exporting a snapshot for external access.
+ *When using this parameter to export a snapshot, be sure Amazon ElastiCache has the + * needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the + * Amazon ElastiCache User Guide.
+ *For more information, see Exporting a + * Snapshot in the Amazon ElastiCache User Guide.
*/ TargetBucket?: string; @@ -1570,29 +1622,30 @@ export interface CopySnapshotMessage { /** * @public - *A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
+ *A list of tags to be added to this resource. A tag is a key-value pair. A tag key must + * be accompanied by a tag value, although null is accepted.
*/ Tags?: Tag[]; } /** * @public - *Node group (shard) configuration options.
- * Each node group (shard) configuration has the following: Slots
, PrimaryAvailabilityZone
, ReplicaAvailabilityZones
, ReplicaCount
.
Node group (shard) configuration options. Each node group (shard) configuration has
+ * the following: Slots
, PrimaryAvailabilityZone
,
+ * ReplicaAvailabilityZones
, ReplicaCount
.
Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these - * configuration values apply to.
+ *Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the + * node group these configuration values apply to.
*/ NodeGroupId?: string; /** * @public - *A string that specifies the keyspace for a particular node group.
- * Keyspaces range from 0 to 16,383.
- * The string is in the format startkey-endkey
.
A string that specifies the keyspace for a particular node group. Keyspaces range from
+ * 0 to 16,383. The string is in the format startkey-endkey
.
Example: "0-3999"
*
The Availability Zone where the primary node of this node group (shard) is launched.
+ *The Availability Zone where the primary node of this node group (shard) is + * launched.
*/ PrimaryAvailabilityZone?: string; /** * @public - *A list of Availability Zones to be used for the read replicas.
- * The number of Availability Zones in this list must match the value of ReplicaCount
- * or ReplicasPerNodeGroup
if not specified.
A list of Availability Zones to be used for the read replicas. The number of
+ * Availability Zones in this list must match the value of ReplicaCount
or
+ * ReplicasPerNodeGroup
if not specified.
The date and time when the source node's metadata and cache data set was obtained for the snapshot.
+ *The date and time when the source node's metadata and cache data set was obtained for + * the snapshot.
*/ SnapshotCreateTime?: Date; } /** * @public - *Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.
+ *Represents a copy of an entire Redis cluster as of the time when the snapshot was + * taken.
*/ export interface Snapshot { /** * @public - *The name of a snapshot. - * For an automatic snapshot, the name is system-generated. - * For a manual snapshot, this is the user-provided name.
+ *The name of a snapshot. For an automatic snapshot, the name is system-generated. For a + * manual snapshot, this is the user-provided name.
*/ SnapshotName?: string; @@ -1712,24 +1767,25 @@ export interface Snapshot { /** * @public - *The status of the snapshot. Valid values: creating
| available
- * | restoring
| copying
| deleting
.
The status of the snapshot. Valid values: creating
|
+ * available
| restoring
| copying
|
+ * deleting
.
Indicates whether the snapshot is from an automatic backup (automated
)
- * or was created manually (manual
).
Indicates whether the snapshot is from an automatic backup (automated
) or
+ * was created manually (manual
).
The name of the compute and memory capacity node type for the source cluster.
- *The following node types are supported by ElastiCache. - * Generally speaking, the current generation types provide more memory and computational power - * at lower cost when compared to their equivalent previous generation counterparts.
+ *The following node types are supported by ElastiCache. Generally speaking, the current + * generation types provide more memory and computational power at lower cost when compared + * to their equivalent previous generation counterparts.
*General purpose:
@@ -1886,17 +1942,20 @@ export interface Snapshot { * *All current generation instance types are created in Amazon VPC by default.
+ *All current generation instance types are created in Amazon VPC by + * default.
*Redis append-only files (AOF) are not supported for T1 or T2 instances.
*Redis Multi-AZ with automatic failover is not supported on T1 instances.
+ *Redis Multi-AZ with automatic failover is not supported on T1 + * instances.
*Redis configuration variables appendonly
and
- * appendfsync
are not supported on Redis version 2.8.22 and later.
appendfsync
are not supported on Redis version 2.8.22 and
+ * later.
* The name of the cache engine (memcached
or
- * redis
) used by the source cluster.
The name of the cache engine (memcached
or redis
) used by
+ * the source cluster.
The number of cache nodes in the source cluster.
- *For clusters running Redis, this value must be 1. - * For clusters running Memcached, this value must be between 1 and 40.
+ *For clusters running Redis, this value must be 1. For clusters running Memcached, this + * value must be between 1 and 40.
*/ NumCacheNodes?: number; @@ -1943,10 +2002,9 @@ export interface Snapshot { /** * @public - *Specifies the weekly time range during which maintenance - * on the cluster is performed. It is specified as a range in - * the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum - * maintenance window is a 60 minute period.
+ *Specifies the weekly time range during which maintenance on the cluster is performed. + * It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The + * minimum maintenance window is a 60 minute period.
*Valid values for ddd
are:
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
+ *The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing + * notifications.
*/ TopicArn?: string; @@ -2016,47 +2075,52 @@ export interface Snapshot { /** * @public - *The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
+ *The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the + * source cluster.
*/ VpcId?: string; /** * @public - *If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. - *
+ *If you are running Redis engine version 6.0 or later, set this parameter to yes if + * you want to opt-in to the next auto minor version upgrade campaign. This parameter is + * disabled for previous versions.
*/ AutoMinorVersionUpgrade?: boolean; /** * @public - *For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
- *For manual snapshots, this field reflects the SnapshotRetentionLimit
for the
- * source cluster when the snapshot was created. This field is otherwise ignored:
- * Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot
- * operation.
For an automatic snapshot, the number of days for which ElastiCache retains the + * snapshot before deleting it.
+ *For manual snapshots, this field reflects the SnapshotRetentionLimit
for
+ * the source cluster when the snapshot was created. This field is otherwise ignored:
+ * Manual snapshots do not expire, and can only be deleted using the
+ * DeleteSnapshot
operation.
- * Important - * If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
+ * Important If the value of SnapshotRetentionLimit is set + * to zero (0), backups are turned off. */ SnapshotRetentionLimit?: number; /** * @public - *The daily time range during which ElastiCache takes daily snapshots of the source cluster.
+ *The daily time range during which ElastiCache takes daily snapshots of the source + * cluster.
*/ SnapshotWindow?: string; /** * @public - *The number of node groups (shards) in this snapshot. - * When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored - * replication group must be the same.
+ *The number of node groups (shards) in this snapshot. When restoring from a snapshot, + * the number of node groups (shards) in the snapshot and in the restored replication group + * must be the same.
*/ NumNodeGroups?: number; /** * @public - *Indicates the status of automatic failover for the source Redis replication group.
+ *Indicates the status of automatic failover for the source Redis replication + * group.
*/ AutomaticFailover?: AutomaticFailoverStatus | string; @@ -2080,8 +2144,9 @@ export interface Snapshot { /** * @public - *Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. - * For more information, see Data tiering.
+ *Enables data tiering. Data tiering is only supported for replication groups using the + * r6gd node type. This parameter must be set to true when using r6gd nodes. For more + * information, see Data tiering.
*/ DataTiering?: DataTieringStatus | string; } @@ -2092,14 +2157,16 @@ export interface Snapshot { export interface CopySnapshotResult { /** * @public - *Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.
+ *Represents a copy of an entire Redis cluster as of the time when the snapshot was + * taken.
*/ Snapshot?: Snapshot; } /** * @public - *The current state of the snapshot does not allow the requested operation to occur.
+ *The current state of the snapshot does not allow the requested operation to + * occur.
*/ export class InvalidSnapshotStateFault extends __BaseException { readonly name: "InvalidSnapshotStateFault" = "InvalidSnapshotStateFault"; @@ -2139,7 +2206,8 @@ export class SnapshotAlreadyExistsFault extends __BaseException { /** * @public - *The request cannot be processed because it would exceed the maximum number of snapshots.
+ *The request cannot be processed because it would exceed the maximum number of + * snapshots.
*/ export class SnapshotQuotaExceededFault extends __BaseException { readonly name: "SnapshotQuotaExceededFault" = "SnapshotQuotaExceededFault"; @@ -2179,7 +2247,8 @@ export class CacheClusterAlreadyExistsFault extends __BaseException { /** * @public - *The request cannot be processed because it would exceed the allowed number of clusters per customer.
+ *The request cannot be processed because it would exceed the allowed number of clusters + * per customer.
*/ export class ClusterQuotaForCustomerExceededFault extends __BaseException { readonly name: "ClusterQuotaForCustomerExceededFault" = "ClusterQuotaForCustomerExceededFault"; @@ -2218,19 +2287,22 @@ export type AZMode = (typeof AZMode)[keyof typeof AZMode]; export interface LogDeliveryConfigurationRequest { /** * @public - *Refers to slow-log or engine-log..
+ *Refers to slow-log or + * engine-log..
*/ LogType?: LogType | string; /** * @public - *Specify either cloudwatch-logs
or kinesis-firehose
as the destination type.
Specify either cloudwatch-logs
or kinesis-firehose
as the
+ * destination type.
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
+ *Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose + * destination.
*/ DestinationDetails?: DestinationDetails; @@ -2268,7 +2340,8 @@ export type OutpostMode = (typeof OutpostMode)[keyof typeof OutpostMode]; export interface CreateCacheClusterMessage { /** * @public - *The node group (shard) identifier. This parameter is stored as a lowercase string.
+ *The node group (shard) identifier. This parameter is stored as a lowercase + * string.
** Constraints: *
@@ -2288,43 +2361,56 @@ export interface CreateCacheClusterMessage { /** * @public - *The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.
- *If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.
+ *The ID of the replication group to which this cluster should belong. If this parameter + * is specified, the cluster is added to the specified replication group as a read replica; + * otherwise, the cluster is a standalone primary that is not part of any replication + * group.
+ *If the specified replication group is Multi-AZ enabled and the Availability Zone is + * not specified, the cluster is created in Availability Zones that provide the best spread + * of read replicas across Availability Zones.
*This parameter is only valid if the Engine
parameter is redis
.
This parameter is only valid if the Engine
parameter is
+ * redis
.
Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or - * created across multiple Availability Zones in the cluster's region.
+ *Specifies whether the nodes in this Memcached cluster are created in a single + * Availability Zone or created across multiple Availability Zones in the cluster's + * region.
*This parameter is only supported for Memcached clusters.
- *If the AZMode
and PreferredAvailabilityZones
are not specified,
- * ElastiCache assumes single-az
mode.
If the AZMode
and PreferredAvailabilityZones
are not
+ * specified, ElastiCache assumes single-az
mode.
The EC2 Availability Zone in which the cluster is created.
- *All nodes belonging to this cluster are placed in the preferred Availability Zone.
- * If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones
.
All nodes belonging to this cluster are placed in the preferred Availability Zone. If
+ * you want to create your nodes across multiple Availability Zones, use
+ * PreferredAvailabilityZones
.
Default: System chosen Availability Zone.
*/ PreferredAvailabilityZone?: string; /** * @public - *A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.
+ *A list of the Availability Zones in which cache nodes are created. The order of the + * zones in the list is not important.
*This option is only supported on Memcached.
*If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.
- *The number of Availability Zones listed must equal the value of NumCacheNodes
.
If you are creating your cluster in an Amazon VPC (recommended) you can only + * locate nodes in Availability Zones that are associated with the subnets in the + * selected subnet group.
+ *The number of Availability Zones listed must equal the value of
+ * NumCacheNodes
.
If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone
instead, or
- * repeat the Availability Zone multiple times in the list.
If you want all the nodes in the same Availability Zone, use
+ * PreferredAvailabilityZone
instead, or repeat the Availability Zone
+ * multiple times in the list.
Default: System chosen Availability Zones.
*/ PreferredAvailabilityZones?: string[]; @@ -2332,19 +2418,19 @@ export interface CreateCacheClusterMessage { /** * @public *The initial number of cache nodes that the cluster has.
- *For clusters running Redis, this value must be 1. - * For clusters running Memcached, this value must be between 1 and 40.
- *If you need more than 40 nodes for your Memcached cluster, - * please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
+ *For clusters running Redis, this value must be 1. For clusters running Memcached, this + * value must be between 1 and 40.
+ *If you need more than 40 nodes for your Memcached cluster, please fill out the + * ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
*/ NumCacheNodes?: number; /** * @public *The compute and memory capacity of the nodes in the node group (shard).
- *The following node types are supported by ElastiCache. - * Generally speaking, the current generation types provide more memory and computational power - * at lower cost when compared to their equivalent previous generation counterparts.
+ *The following node types are supported by ElastiCache. Generally speaking, the current + * generation types provide more memory and computational power at lower cost when compared + * to their equivalent previous generation counterparts.
*General purpose:
@@ -2501,17 +2587,20 @@ export interface CreateCacheClusterMessage { * *All current generation instance types are created in Amazon VPC by default.
+ *All current generation instance types are created in Amazon VPC by + * default.
*Redis append-only files (AOF) are not supported for T1 or T2 instances.
*Redis Multi-AZ with automatic failover is not supported on T1 instances.
+ *Redis Multi-AZ with automatic failover is not supported on T1 + * instances.
*Redis configuration variables appendonly
and
- * appendfsync
are not supported on Redis version 2.8.22 and later.
appendfsync
are not supported on Redis version 2.8.22 and
+ * later.
* The name of the cache engine to be used for this cluster.
- *Valid values for this parameter are: memcached
| redis
+ *
Valid values for this parameter are: memcached
|
+ * redis
*
The version number of the cache engine to be used for this cluster. - * To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
+ *The version number of the cache engine to be used for this cluster. To view the + * supported cache engine versions, use the DescribeCacheEngineVersions operation.
*- * Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. - * If you want to use an earlier engine version, - * you must delete the existing cluster or replication group and create it anew with the earlier engine version.
+ * Important: You can upgrade to a newer engine version + * (see Selecting + * a Cache Engine and Version), but you cannot downgrade to an earlier engine + * version. If you want to use an earlier engine version, you must delete the existing + * cluster or replication group and create it anew with the earlier engine version. */ EngineVersion?: string; /** * @public - *The name of the parameter group to associate with this cluster.
- * If this argument is omitted, the default parameter group for the specified engine is used.
- * You cannot use any parameter group which has cluster-enabled='yes'
when creating a cluster.
The name of the parameter group to associate with this cluster. If this argument is
+ * omitted, the default parameter group for the specified engine is used. You cannot use
+ * any parameter group which has cluster-enabled='yes'
when creating a
+ * cluster.
The name of the subnet group to be used for the cluster.
- *Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
+ *Use this parameter only when you are creating a cluster in an Amazon Virtual Private + * Cloud (Amazon VPC).
*If you're going to launch your cluster in an Amazon VPC, - * you need to create a subnet group before you start creating a cluster. - * For more information, see Subnets and Subnet Groups.
+ *If you're going to launch your cluster in an Amazon VPC, you need to create a + * subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
*A list of security group names to associate with this cluster.
- *Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).
+ *Use this parameter only when you are creating a cluster outside of an Amazon Virtual + * Private Cloud (Amazon VPC).
*/ CacheSecurityGroupNames?: string[]; /** * @public *One or more VPC security groups associated with the cluster.
- *Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
+ *Use this parameter only when you are creating a cluster in an Amazon Virtual Private + * Cloud (Amazon VPC).
*/ SecurityGroupIds?: string[]; @@ -2578,12 +2673,13 @@ export interface CreateCacheClusterMessage { /** * @public - *A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies - * a Redis RDB snapshot file stored in Amazon S3. - * The snapshot file is used to populate the node group (shard). - * The Amazon S3 object name in the ARN cannot contain any commas.
+ *A single-element string list containing an Amazon Resource Name (ARN) that uniquely + * identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to + * populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any + * commas.
*This parameter is only valid if the Engine
parameter is redis
.
This parameter is only valid if the Engine
parameter is
+ * redis
.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
*
The name of a Redis snapshot from which to restore data into the new node group (shard).
- * The snapshot status changes to restoring
while the new node group (shard) is being created.
The name of a Redis snapshot from which to restore data into the new node group
+ * (shard). The snapshot status changes to restoring
while the new node group
+ * (shard) is being created.
This parameter is only valid if the Engine
parameter is redis
.
This parameter is only valid if the Engine
parameter is
+ * redis
.
Specifies the weekly time range during which maintenance - * on the cluster is performed. It is specified as a range in - * the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum - * maintenance window is a 60 minute period. - *
+ *Specifies the weekly time range during which maintenance on the cluster is performed. + * It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The + * minimum maintenance window is a 60 minute period.
*/ PreferredMaintenanceWindow?: string; /** * @public - *The port number on which each of the cache nodes accepts connections.
+ *The port number on which each of the cache nodes accepts connections.
*/ Port?: number; /** * @public *The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic - * to which notifications are sent.
+ * to which notifications are sent. *The Amazon SNS topic owner must be the same as the cluster owner.
*If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. - *
+ *If you are running Redis engine version 6.0 or later, set this parameter to yes if + * you want to opt-in to the next auto minor version upgrade campaign. This parameter is + * disabled for previous versions.
*/ AutoMinorVersionUpgrade?: boolean; /** * @public - *The number of days for which ElastiCache retains automatic snapshots before deleting them.
- * For example, if you set SnapshotRetentionLimit
to 5,
- * a snapshot taken today is retained for 5 days before being deleted.
The number of days for which ElastiCache retains automatic snapshots before deleting
+ * them. For example, if you set SnapshotRetentionLimit
to 5, a snapshot taken
+ * today is retained for 5 days before being deleted.
This parameter is only valid if the Engine
parameter is redis
.
This parameter is only valid if the Engine
parameter is
+ * redis
.
Default: 0 (i.e., automatic backups are disabled for this cache cluster).
*/ @@ -2647,12 +2745,15 @@ export interface CreateCacheClusterMessage { /** * @public - *The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
+ *The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot + * of your node group (shard).
*Example: 05:00-09:00
*
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
+ *If you do not specify this parameter, ElastiCache automatically chooses an appropriate + * time range.
*This parameter is only valid if the Engine
parameter is redis
.
This parameter is only valid if the Engine
parameter is
+ * redis
.
- * Reserved parameter. - * The password used to access a password protected server.
+ * Reserved parameter. The password used to access a + * password protected server. *Password constraints:
*Must be only printable ASCII characters.
*Must be at least 16 characters and no more than 128 - * characters in length.
+ *Must be at least 16 characters and no more than 128 characters in + * length.
*The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
+ *The only permitted printable special characters are !, &, #, $, ^, <, + * >, and -. Other printable special characters cannot be used in the AUTH + * token.
*For more information, see AUTH password at http://redis.io/commands/AUTH.
+ *For more information, see AUTH + * password at http://redis.io/commands/AUTH.
*/ AuthToken?: string; /** * @public - *Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
+ *Specifies whether the nodes in the cluster are created in a single outpost or across + * multiple outposts.
*/ OutpostMode?: OutpostMode | string; @@ -2711,15 +2816,17 @@ export interface CreateCacheClusterMessage { /** * @public - *Must be either ipv4
| ipv6
| dual_stack
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the
- * Nitro system.
Must be either ipv4
| ipv6
| dual_stack
. IPv6
+ * is supported for workloads using Redis engine version 6.2 onward or Memcached engine
+ * version 1.6.6 on all instances built on the Nitro system.
The network type you choose when modifying a cluster, either ipv4
| ipv6
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the
- * Nitro system.
The network type you choose when modifying a cluster, either ipv4
|
+ * ipv6
. IPv6 is supported for workloads using Redis engine version 6.2
+ * onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
Represents an individual cache node within a cluster. Each cache node runs its own * instance of the cluster's protocol-compliant caching software - either Memcached or * Redis.
- *The following node types are supported by ElastiCache. - * Generally speaking, the current generation types provide more memory and computational power - * at lower cost when compared to their equivalent previous generation counterparts.
+ *The following node types are supported by ElastiCache. Generally speaking, the current + * generation types provide more memory and computational power at lower cost when compared + * to their equivalent previous generation counterparts.
*General purpose:
@@ -2888,30 +2995,37 @@ export interface CreateCacheClusterMessage { * *All current generation instance types are created in Amazon VPC by default.
+ *All current generation instance types are created in Amazon VPC by + * default.
*Redis append-only files (AOF) are not supported for T1 or T2 instances.
*Redis Multi-AZ with automatic failover is not supported on T1 instances.
+ *Redis Multi-AZ with automatic failover is not supported on T1 + * instances.
*Redis configuration variables appendonly
and
- * appendfsync
are not supported on Redis version 2.8.22 and later.
appendfsync
are not supported on Redis version 2.8.22 and
+ * later.
* The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's Amazon account.
+ *The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The + * combination of cluster ID and node ID uniquely identifies every cache node used in a + * customer's Amazon account.
*/ CacheNodeId?: string; /** * @public - *The current state of this cache node, one of the following values: available
, creating
, rebooting
, or deleting
.
The current state of this cache node, one of the following values:
+ * available
, creating
, rebooting
, or
+ * deleting
.
The ID of the primary node to which this read replica node is synchronized. - * If this field is empty, this node is not associated with a primary cluster.
+ *The ID of the primary node to which this read replica node is synchronized. If this + * field is empty, this node is not associated with a primary cluster.
*/ SourceCacheNodeId?: string; @@ -2972,8 +3086,8 @@ export interface CacheParameterGroupStatus { /** * @public - *A list of the cache node IDs which need to be rebooted for parameter changes to be applied. - * A node ID is a numeric identifier (0001, 0002, etc.).
+ *A list of the cache node IDs which need to be rebooted for parameter changes to be + * applied. A node ID is a numeric identifier (0001, 0002, etc.).
*/ CacheNodeIdsToReboot?: string[]; } @@ -2991,16 +3105,18 @@ export interface CacheSecurityGroupMembership { /** * @public - *The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cluster are modified.
+ *The membership status in the cache security group. The status changes when a cache + * security group is modified, or when the cache security groups assigned to a cluster are + * modified.
*/ Status?: string; } /** * @public - *Describes a notification topic and its status. - * Notification topics are used for publishing ElastiCache events to subscribers - * using Amazon Simple Notification Service (SNS).
+ *Describes a notification topic and its status. Notification topics are used for + * publishing ElastiCache events to subscribers using Amazon Simple Notification Service + * (SNS).
*/ export interface NotificationConfiguration { /** @@ -3018,15 +3134,15 @@ export interface NotificationConfiguration { /** * @public - *A group of settings that are applied to the cluster in the future, - * or that are currently being applied.
+ *A group of settings that are applied to the cluster in the future, or that are + * currently being applied.
*/ export interface PendingModifiedValues { /** * @public *The new number of cache nodes for the cluster.
- *For clusters running Redis, this value must be 1. - * For clusters running Memcached, this value must be between 1 and 40.
+ *For clusters running Redis, this value must be 1. For clusters running Memcached, this + * value must be between 1 and 40.
*/ NumCacheNodes?: number; @@ -3039,7 +3155,7 @@ export interface PendingModifiedValues { /** * @public - *The new cache engine version that the cluster runs.
+ *The new cache engine version that the cluster runs.
*/ EngineVersion?: string; @@ -3069,7 +3185,8 @@ export interface PendingModifiedValues { /** * @public - *A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
+ *A setting that allows you to migrate your clients to use in-transit encryption, with + * no downtime.
*/ TransitEncryptionMode?: TransitEncryptionMode | string; } @@ -3087,9 +3204,9 @@ export interface SecurityGroupMembership { /** * @public - *The status of the cache security group membership. - * The status changes whenever a cache security group is modified, - * or when the cache security groups assigned to a cluster are modified.
+ *The status of the cache security group membership. The status changes whenever a cache + * security group is modified, or when the cache security groups assigned to a cluster are + * modified.
*/ Status?: string; } @@ -3101,15 +3218,16 @@ export interface SecurityGroupMembership { export interface CacheCluster { /** * @public - *The user-supplied identifier of the cluster. - * This identifier is a unique key that identifies a cluster.
+ *The user-supplied identifier of the cluster. This identifier is a unique key that + * identifies a cluster.
*/ CacheClusterId?: string; /** * @public - *Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster.
- * The configuration endpoint will always have .cfg
in it.
Represents a Memcached cluster endpoint which can be used by an application to connect
+ * to any node in the cluster. The configuration endpoint will always have
+ * .cfg
in it.
Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
*
The URL of the web page where you can download the latest ElastiCache client library.
+ *The URL of the web page where you can download the latest ElastiCache client + * library.
*/ ClientDownloadLandingPage?: string; /** * @public *The name of the compute and memory capacity node type for the cluster.
- *The following node types are supported by ElastiCache. - * Generally speaking, the current generation types provide more memory and computational power - * at lower cost when compared to their equivalent previous generation counterparts.
+ *The following node types are supported by ElastiCache. Generally speaking, the current + * generation types provide more memory and computational power at lower cost when compared + * to their equivalent previous generation counterparts.
*General purpose:
@@ -3283,17 +3402,20 @@ export interface CacheCluster { * *All current generation instance types are created in Amazon VPC by default.
+ *All current generation instance types are created in Amazon VPC by + * default.
*Redis append-only files (AOF) are not supported for T1 or T2 instances.
*Redis Multi-AZ with automatic failover is not supported on T1 instances.
+ *Redis Multi-AZ with automatic failover is not supported on T1 + * instances.
*Redis configuration variables appendonly
and
- * appendfsync
are not supported on Redis version 2.8.22 and later.
appendfsync
are not supported on Redis version 2.8.22 and
+ * later.
* The name of the cache engine (memcached
or
- * redis
) to be used for this cluster.
The name of the cache engine (memcached
or redis
) to be used
+ * for this cluster.
The current state of this cluster, one of the following values:
- * available
,
- * creating
,
- * deleted
,
- * deleting
,
- * incompatible-network
,
- * modifying
,
- * rebooting cluster nodes
,
- * restore-failed
, or
- * snapshotting
.
available
, creating
, deleted
,
+ * deleting
, incompatible-network
, modifying
,
+ * rebooting cluster nodes
, restore-failed
, or
+ * snapshotting
.
*/
CacheClusterStatus?: string;
/**
* @public
* The number of cache nodes in the cluster.
- *For clusters running Redis, this value must be 1. For clusters running Memcached, - * this value must be between 1 and 40.
+ *For clusters running Redis, this value must be 1. For clusters running Memcached, this + * value must be between 1 and 40.
*/ NumCacheNodes?: number; /** * @public - *The name of the Availability Zone in which the cluster is located or "Multiple" - * if the cache nodes are located in different Availability Zones.
+ *The name of the Availability Zone in which the cluster is located or "Multiple" if the + * cache nodes are located in different Availability Zones.
*/ PreferredAvailabilityZone?: string; @@ -3356,10 +3473,9 @@ export interface CacheCluster { /** * @public - *Specifies the weekly time range during which maintenance - * on the cluster is performed. It is specified as a range in - * the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum - * maintenance window is a 60 minute period.
+ *Specifies the weekly time range during which maintenance on the cluster is performed. + * It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The + * minimum maintenance window is a 60 minute period.
*Valid values for ddd
are:
A group of settings that are applied to the cluster in the future, - * or that are currently being applied.
+ *A group of settings that are applied to the cluster in the future, or that are + * currently being applied.
*/ PendingModifiedValues?: PendingModifiedValues; /** * @public - *Describes a notification topic and its status. - * Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
+ *Describes a notification topic and its status. Notification topics are used for + * publishing ElastiCache events to subscribers using Amazon Simple Notification Service + * (SNS).
*/ NotificationConfiguration?: NotificationConfiguration; /** * @public - *A list of cache security group elements, composed of name and status sub-elements.
+ *A list of cache security group elements, composed of name and status + * sub-elements.
*/ CacheSecurityGroups?: CacheSecurityGroupMembership[]; @@ -3443,8 +3561,9 @@ export interface CacheCluster { /** * @public - *If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. - *
+ *If you are running Redis engine version 6.0 or later, set this parameter to yes if + * you want to opt-in to the next auto minor version upgrade campaign. This parameter is + * disabled for previous versions.
*/ AutoMinorVersionUpgrade?: boolean; @@ -3456,27 +3575,27 @@ export interface CacheCluster { /** * @public - *The replication group to which this cluster belongs. - * If this field is empty, the cluster is not associated with any replication group.
+ *The replication group to which this cluster belongs. If this field is empty, the + * cluster is not associated with any replication group.
*/ ReplicationGroupId?: string; /** * @public *The number of days for which ElastiCache retains automatic cluster snapshots before
- * deleting them. For example, if you set SnapshotRetentionLimit
to 5, a
+ * deleting them. For example, if you set SnapshotRetentionLimit
to 5, a
* snapshot that was taken today is retained for 5 days before being deleted.
- * If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
+ *If the value of SnapshotRetentionLimit is set to zero (0), backups are turned + * off.
*The daily time range (in UTC) during which ElastiCache begins taking a - * daily snapshot of your cluster.
+ *The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot + * of your cluster.
*Example: 05:00-09:00
*
A flag that enables using an AuthToken
(password)
- * when issuing Redis commands.
A flag that enables using an AuthToken
(password) when issuing Redis
+ * commands.
Default: false
*
A flag that enables in-transit encryption when set to true
.
- * Required:
- * Only available when creating a replication group in an Amazon VPC using redis version 3.2.6
, 4.x
or later.
3.2.6
, 4.x
or
+ * later.
* Default: false
*
A flag that enables encryption at-rest when set to true
.
You cannot modify the value of AtRestEncryptionEnabled
- * after the cluster is created. To enable at-rest encryption on a cluster
- * you must set AtRestEncryptionEnabled
to true
- * when you create a cluster.
You cannot modify the value of AtRestEncryptionEnabled
after the cluster
+ * is created. To enable at-rest encryption on a cluster you must set
+ * AtRestEncryptionEnabled
to true
when you create a
+ * cluster.
- * Required:
- * Only available when creating a replication group in an Amazon VPC using redis version 3.2.6
, 4.x
or later.
3.2.6
, 4.x
or
+ * later.
* Default: false
*
A boolean value indicating whether log delivery is enabled for the replication group.
+ *A boolean value indicating whether log delivery is enabled for the replication + * group.
*/ ReplicationGroupLogDeliveryEnabled?: boolean; @@ -3543,21 +3665,24 @@ export interface CacheCluster { /** * @public - *Must be either ipv4
| ipv6
| dual_stack
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the
- * Nitro system.
Must be either ipv4
| ipv6
| dual_stack
. IPv6
+ * is supported for workloads using Redis engine version 6.2 onward or Memcached engine
+ * version 1.6.6 on all instances built on the Nitro system.
The network type associated with the cluster, either ipv4
| ipv6
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the
- * Nitro system.
The network type associated with the cluster, either ipv4
|
+ * ipv6
. IPv6 is supported for workloads using Redis engine version 6.2
+ * onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
+ *A setting that allows you to migrate your clients to use in-transit encryption, with + * no downtime.
*/ TransitEncryptionMode?: TransitEncryptionMode | string; } @@ -3575,8 +3700,8 @@ export interface CreateCacheClusterResult { /** * @public - *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 cache node type is not available in the specified Availability Zone. For + * more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
*/ export class InsufficientCacheClusterCapacityFault extends __BaseException { readonly name: "InsufficientCacheClusterCapacityFault" = "InsufficientCacheClusterCapacityFault"; @@ -3616,7 +3741,8 @@ export class InvalidVPCNetworkStateFault extends __BaseException { /** * @public - *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 in a single cluster.
*/ export class NodeQuotaForClusterExceededFault extends __BaseException { readonly name: "NodeQuotaForClusterExceededFault" = "NodeQuotaForClusterExceededFault"; @@ -3636,7 +3762,8 @@ export class NodeQuotaForClusterExceededFault extends __BaseException { /** * @public - *The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
+ *The request cannot be processed because it would exceed the allowed number of cache + * nodes per customer.
*/ export class NodeQuotaForCustomerExceededFault extends __BaseException { readonly name: "NodeQuotaForCustomerExceededFault" = "NodeQuotaForCustomerExceededFault"; @@ -3676,7 +3803,8 @@ export class CacheParameterGroupAlreadyExistsFault extends __BaseException { /** * @public - *The request cannot be processed because it would exceed the maximum number of cache security groups.
+ *The request cannot be processed because it would exceed the maximum number of cache + * security groups.
*/ export class CacheParameterGroupQuotaExceededFault extends __BaseException { readonly name: "CacheParameterGroupQuotaExceededFault" = "CacheParameterGroupQuotaExceededFault"; @@ -3707,18 +3835,12 @@ export interface CreateCacheParameterGroupMessage { /** * @public - *The name of the cache parameter group family that the cache parameter group can be used with.
- *Valid values are:
- * memcached1.4
|
- * memcached1.5
|
- * memcached1.6
|
- * redis2.6
|
- * redis2.8
|
- * redis3.2
|
- * redis4.0
|
- * redis5.0
|
- * redis6.x
|
- * redis7
+ *
The name of the cache parameter group family that the cache parameter group can be + * used with.
+ *Valid values are: memcached1.4
| memcached1.5
|
+ * memcached1.6
| redis2.6
| redis2.8
|
+ * redis3.2
| redis4.0
| redis5.0
|
+ * redis6.x
| redis7
*
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
+ *A list of tags to be added to this resource. A tag is a key-value pair. A tag key must + * be accompanied by a tag value, although null is accepted.
*/ Tags?: Tag[]; } @@ -3749,18 +3872,12 @@ export interface CacheParameterGroup { /** * @public - *The name of the cache parameter group family that this cache parameter group is compatible with.
- *Valid values are:
- * memcached1.4
|
- * memcached1.5
|
- * memcached1.6
|
- * redis2.6
|
- * redis2.8
|
- * redis3.2
|
- * redis4.0
|
- * redis5.0
|
- * redis6.x
|
- * redis7
+ *
The name of the cache parameter group family that this cache parameter group is + * compatible with.
+ *Valid values are: memcached1.4
| memcached1.5
|
+ * memcached1.6
| redis2.6
| redis2.8
|
+ * redis3.2
| redis4.0
| redis5.0
|
+ * redis6.x
| redis7
*
The current state of the cache parameter group does not allow the requested operation to occur.
+ *The current state of the cache parameter group does not allow the requested operation + * to occur.
*/ export class InvalidCacheParameterGroupStateFault extends __BaseException { readonly name: "InvalidCacheParameterGroupStateFault" = "InvalidCacheParameterGroupStateFault"; @@ -3837,7 +3955,8 @@ export class CacheSecurityGroupAlreadyExistsFault extends __BaseException { /** * @public - *The request cannot be processed because it would exceed the allowed number of cache security groups.
+ *The request cannot be processed because it would exceed the allowed number of cache + * security groups.
*/ export class CacheSecurityGroupQuotaExceededFault extends __BaseException { readonly name: "CacheSecurityGroupQuotaExceededFault" = "CacheSecurityGroupQuotaExceededFault"; @@ -3862,8 +3981,10 @@ export class CacheSecurityGroupQuotaExceededFault extends __BaseException { export interface CreateCacheSecurityGroupMessage { /** * @public - *A name for the cache security group. This value is stored as a lowercase string.
- *Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word "Default".
+ *A name for the cache security group. This value is stored as a lowercase + * string.
+ *Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word + * "Default".
*Example: mysecuritygroup
*
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
+ *A list of tags to be added to this resource. A tag is a key-value pair. A tag key must + * be accompanied by a tag value, although null is accepted.
*/ Tags?: Tag[]; } @@ -3912,7 +4034,8 @@ export interface CreateCacheSecurityGroupResult { /** * @public - *The requested cache subnet group name is already in use by an existing cache subnet group.
+ *The requested cache subnet group name is already in use by an existing cache subnet + * group.
*/ export class CacheSubnetGroupAlreadyExistsFault extends __BaseException { readonly name: "CacheSubnetGroupAlreadyExistsFault" = "CacheSubnetGroupAlreadyExistsFault"; @@ -3932,7 +4055,8 @@ export class CacheSubnetGroupAlreadyExistsFault extends __BaseException { /** * @public - *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 cache + * subnet groups.
*/ export class CacheSubnetGroupQuotaExceededFault extends __BaseException { readonly name: "CacheSubnetGroupQuotaExceededFault" = "CacheSubnetGroupQuotaExceededFault"; @@ -3952,7 +4076,8 @@ export class CacheSubnetGroupQuotaExceededFault extends __BaseException { /** * @public - *The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.
+ *The request cannot be processed because it would exceed the allowed number of subnets + * in a cache subnet group.
*/ export class CacheSubnetQuotaExceededFault extends __BaseException { readonly name: "CacheSubnetQuotaExceededFault" = "CacheSubnetQuotaExceededFault"; @@ -3998,7 +4123,8 @@ export interface CreateCacheSubnetGroupMessage { /** * @public - *A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
+ *A list of tags to be added to this resource. A tag is a key-value pair. A tag key must + * be accompanied by a tag value, although null is accepted.
*/ Tags?: Tag[]; } @@ -4029,8 +4155,8 @@ export interface SubnetOutpost { /** * @public - *Represents the subnet associated with a cluster. - * This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
+ *Represents the subnet associated with a cluster. This parameter refers to subnets + * defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
*/ export interface Subnet { /** @@ -4053,8 +4179,9 @@ export interface Subnet { /** * @public - *Either ipv4
| ipv6
| dual_stack
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the
- * Nitro system.
Either ipv4
| ipv6
| dual_stack
. IPv6 is
+ * supported for workloads using Redis engine version 6.2 onward or Memcached engine
+ * version 1.6.6 on all instances built on the Nitro system.
Either ipv4
| ipv6
| dual_stack
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the
- * Nitro system.
Either ipv4
| ipv6
| dual_stack
. IPv6 is
+ * supported for workloads using Redis engine version 6.2 onward or Memcached engine
+ * version 1.6.6 on all instances built on the Nitro system.
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.
+ *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.
*/ export class SubnetNotAllowedFault extends __BaseException { readonly name: "SubnetNotAllowedFault" = "SubnetNotAllowedFault"; @@ -4184,9 +4314,14 @@ export class SubnetNotAllowedFault extends __BaseException { export interface CreateGlobalReplicationGroupMessage { /** * @public - *The suffix name of a Global datastore. Amazon ElastiCache automatically applies a prefix - * to the Global datastore ID when it is created. Each Amazon Region has its own prefix. For instance, a Global datastore ID created in the US-West-1 region will begin with "dsdfu" along with the suffix name you provide. The suffix, combined with the auto-generated prefix, guarantees uniqueness of the Global datastore name across multiple regions.
- *For a full list of Amazon Regions and their respective Global datastore iD prefixes, see Using the Amazon CLI with Global datastores .
+ *The suffix name of a Global datastore. Amazon ElastiCache automatically applies a + * prefix to the Global datastore ID when it is created. Each Amazon Region has its own + * prefix. For instance, a Global datastore ID created in the US-West-1 region will begin + * with "dsdfu" along with the suffix name you provide. The suffix, combined with the + * auto-generated prefix, guarantees uniqueness of the Global datastore name across + * multiple regions.
+ *For a full list of Amazon Regions and their respective Global datastore iD prefixes, + * see Using the Amazon CLI with Global datastores .
*/ GlobalReplicationGroupIdSuffix: string | undefined; @@ -4198,7 +4333,8 @@ export interface CreateGlobalReplicationGroupMessage { /** * @public - *The name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
+ *The name of the primary cluster that accepts writes and will replicate updates to the + * secondary cluster.
*/ PrimaryReplicationGroupId: string | undefined; } @@ -4223,7 +4359,8 @@ export interface GlobalNodeGroup { /** * @public - *A member of a Global datastore. It contains the Replication Group Id, the Amazon region and the role of the replication group.
+ *A member of a Global datastore. It contains the Replication Group Id, the Amazon + * region and the role of the replication group.
*/ export interface GlobalReplicationGroupMember { /** @@ -4259,12 +4396,14 @@ export interface GlobalReplicationGroupMember { /** * @public - *Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary - * cluster automatically replicates updates to the secondary cluster.
+ *Consists of a primary cluster that accepts writes and an associated secondary cluster + * that resides in a different Amazon region. The secondary cluster accepts only reads. The + * primary cluster automatically replicates updates to the secondary cluster.
*The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, - * which is what you use to associate a secondary cluster.
+ *The GlobalReplicationGroupIdSuffix represents + * the name of the Global datastore, which is what you use to associate a secondary + * cluster.
*A flag that enables using an AuthToken
(password)
- * when issuing Redis commands.
A flag that enables using an AuthToken
(password) when issuing Redis
+ * commands.
Default: false
*
A flag that enables in-transit encryption when set to true.
*
- * Required:
- * Only available when creating a replication group in an Amazon VPC using redis version 3.2.6
, 4.x
or later.
3.2.6
, 4.x
or
+ * later.
*/
TransitEncryptionEnabled?: boolean;
/**
* @public
* A flag that enables encryption at rest when set to true
.
You cannot modify the value of AtRestEncryptionEnabled
after the replication
- * group is created.
- * To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled
to
- * true
when you create the replication group.
You cannot modify the value of AtRestEncryptionEnabled
after the
+ * replication group is created. To enable encryption at rest on a replication group you
+ * must set AtRestEncryptionEnabled
to true
when you create the
+ * replication group.
- * Required:
- * Only available when creating a replication group in an Amazon VPC using redis version 3.2.6
, 4.x
or later.
3.2.6
, 4.x
or
+ * later.
*/
AtRestEncryptionEnabled?: boolean;
@@ -4367,12 +4508,14 @@ export interface GlobalReplicationGroup {
export interface CreateGlobalReplicationGroupResult {
/**
* @public
- * Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary - * cluster automatically replicates updates to the secondary cluster.
+ *Consists of a primary cluster that accepts writes and an associated secondary cluster + * that resides in a different Amazon region. The secondary cluster accepts only reads. The + * primary cluster automatically replicates updates to the secondary cluster.
*The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, - * which is what you use to associate a secondary cluster.
+ *The GlobalReplicationGroupIdSuffix represents + * the name of the Global datastore, which is what you use to associate a secondary + * cluster.
*The replication group identifier. This parameter is stored as a lowercase string.
+ *The replication group identifier. This parameter is stored as a lowercase + * string.
*Constraints:
*The identifier of the cluster that serves as the primary for this replication
- * group. This cluster must already exist and have a status of available
.
The identifier of the cluster that serves as the primary for this replication group.
+ * This cluster must already exist and have a status of available
.
This parameter is not required if NumCacheClusters
,
- * NumNodeGroups
, or
- * ReplicasPerNodeGroup
is specified.
NumNodeGroups
, or ReplicasPerNodeGroup
is
+ * specified.
*/
PrimaryClusterId?: string;
/**
* @public
- * Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
+ *Specifies whether a read-only replica is automatically promoted to read/write primary + * if the existing primary fails.
*
- * AutomaticFailoverEnabled
must be enabled for Redis (cluster mode enabled) replication groups.
AutomaticFailoverEnabled
must be enabled for Redis (cluster mode enabled)
+ * replication groups.
* Default: false
*/ AutomaticFailoverEnabled?: boolean; /** * @public - *A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
+ *A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more + * information, see Minimizing Downtime: Multi-AZ.
*/ MultiAZEnabled?: boolean; /** * @public *The number of clusters this replication group initially has.
- *This parameter is not used if there is more than one node group (shard).
- * You should use ReplicasPerNodeGroup
instead.
If AutomaticFailoverEnabled
is true
, the value of this parameter must be at least 2.
- * If AutomaticFailoverEnabled
is false
you can omit this parameter (it will default to 1), or you
- * can explicitly set it to a value between 2 and 6.
The maximum permitted value for NumCacheClusters
is 6 (1 primary plus 5 replicas).
This parameter is not used if there is more than one node group (shard). You should
+ * use ReplicasPerNodeGroup
instead.
If AutomaticFailoverEnabled
is true
, the value of this
+ * parameter must be at least 2. If AutomaticFailoverEnabled
is
+ * false
you can omit this parameter (it will default to 1), or you can
+ * explicitly set it to a value between 2 and 6.
The maximum permitted value for NumCacheClusters
is 6 (1 primary plus 5
+ * replicas).
A list of EC2 Availability Zones in which the replication group's clusters are created. - * The order of the Availability Zones in the list is the order in which clusters are allocated. - * The primary cluster is created in the first AZ in the list.
- *This parameter is not used if there is more than one node group (shard).
- * You should use NodeGroupConfiguration
instead.
A list of EC2 Availability Zones in which the replication group's clusters are + * created. The order of the Availability Zones in the list is the order in which clusters + * are allocated. The primary cluster is created in the first AZ in the list.
+ *This parameter is not used if there is more than one node group (shard). You should
+ * use NodeGroupConfiguration
instead.
If you are creating your replication group in an Amazon VPC (recommended), - * you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.
- *The number of Availability Zones listed must equal the value of NumCacheClusters
.
If you are creating your replication group in an Amazon VPC (recommended), you can + * only locate clusters in Availability Zones associated with the subnets in the + * selected subnet group.
+ *The number of Availability Zones listed must equal the value of
+ * NumCacheClusters
.
Default: system chosen Availability Zones.
*/ @@ -4509,40 +4660,41 @@ export interface CreateReplicationGroupMessage { /** * @public - *An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. - * For Redis (cluster mode disabled) either omit this parameter or set it to 1.
+ *An optional parameter that specifies the number of node groups (shards) for this Redis + * (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit + * this parameter or set it to 1.
*Default: 1
*/ NumNodeGroups?: number; /** * @public - *An optional parameter that specifies the number of replica nodes in each node group (shard). - * Valid values are 0 to 5.
+ *An optional parameter that specifies the number of replica nodes in each node group + * (shard). Valid values are 0 to 5.
*/ ReplicasPerNodeGroup?: number; /** * @public - *A list of node group (shard) configuration options.
- * Each node group (shard) configuration has the following members:
- * PrimaryAvailabilityZone
,
- * ReplicaAvailabilityZones
,
- * ReplicaCount
, and
- * Slots
.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to - * individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a - * Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter - * because you must specify the slots for each node group.
+ *A list of node group (shard) configuration options. Each node group (shard)
+ * configuration has the following members: PrimaryAvailabilityZone
,
+ * ReplicaAvailabilityZones
, ReplicaCount
, and
+ * Slots
.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) + * replication group, you can use this parameter to individually configure each node group + * (shard), or you can omit this parameter. However, it is required when seeding a Redis + * (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group + * (shard) using this parameter because you must specify the slots for each node + * group.
*/ NodeGroupConfiguration?: NodeGroupConfiguration[]; /** * @public *The compute and memory capacity of the nodes in the node group (shard).
- *The following node types are supported by ElastiCache. - * Generally speaking, the current generation types provide more memory and computational power - * at lower cost when compared to their equivalent previous generation counterparts.
+ *The following node types are supported by ElastiCache. Generally speaking, the current + * generation types provide more memory and computational power at lower cost when compared + * to their equivalent previous generation counterparts.
*General purpose:
@@ -4699,17 +4851,20 @@ export interface CreateReplicationGroupMessage { * *All current generation instance types are created in Amazon VPC by default.
+ *All current generation instance types are created in Amazon VPC by + * default.
*Redis append-only files (AOF) are not supported for T1 or T2 instances.
*Redis Multi-AZ with automatic failover is not supported on T1 instances.
+ *Redis Multi-AZ with automatic failover is not supported on T1 + * instances.
*Redis configuration variables appendonly
and
- * appendfsync
are not supported on Redis version 2.8.22 and later.
appendfsync
are not supported on Redis version 2.8.22 and
+ * later.
* The name of the cache engine to be used for the clusters in this replication group. The value must be set to Redis
.
The name of the cache engine to be used for the clusters in this replication group.
+ * The value must be set to Redis
.
The version number of the cache engine to be used for the clusters in this replication group.
- * To view the supported cache engine versions, use the DescribeCacheEngineVersions
operation.
The version number of the cache engine to be used for the clusters in this replication
+ * group. To view the supported cache engine versions, use the
+ * DescribeCacheEngineVersions
operation.
- * Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, - * but you cannot downgrade to an earlier engine version. - * If you want to use an earlier engine version, - * you must delete the existing cluster or replication group and - * create it anew with the earlier engine version.
+ * Important: You can upgrade to a newer engine version + * (see Selecting + * a Cache Engine and Version) in the ElastiCache User + * Guide, but you cannot downgrade to an earlier engine version. If you want + * to use an earlier engine version, you must delete the existing cluster or replication + * group and create it anew with the earlier engine version. */ EngineVersion?: string; /** * @public - *The name of the parameter group to associate with this replication group. - * If this argument is omitted, the default cache parameter group for the specified engine is + *
The name of the parameter group to associate with this replication group. If this + * argument is omitted, the default cache parameter group for the specified engine is * used.
- *If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, - * we recommend that you specify the parameter group by name.
+ *If you are running Redis version 3.2.4 or later, only one node group (shard), and want + * to use a default parameter group, we recommend that you specify the parameter group by + * name.
*To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2
.
To create a Redis (cluster mode disabled) replication group, use
+ * CacheParameterGroupName=default.redis3.2
.
To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on
.
To create a Redis (cluster mode enabled) replication group, use
+ * CacheParameterGroupName=default.redis3.2.cluster.on
.
The name of the cache subnet group to be used for the replication group.
*If you're going to launch your cluster in an Amazon VPC, - * you need to create a subnet group before you start creating a cluster. - * For more information, see Subnets and Subnet Groups.
+ *If you're going to launch your cluster in an Amazon VPC, you need to create a + * subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
*One or more Amazon VPC security groups associated with this replication group.
- *Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
+ *Use this parameter only when you are creating a replication group in an Amazon Virtual + * Private Cloud (Amazon VPC).
*/ SecurityGroupIds?: string[]; /** * @public - *A list of tags to be added to this resource.
- * Tags are comma-separated key,value pairs (e.g. Key=myKey
, Value=myKeyValue
. You can include multiple tags as shown following:
- * Key=myKey
, Value=myKeyValue
Key=mySecondKey
, Value=mySecondKeyValue
. Tags on replication groups will be replicated to all nodes.
A list of tags to be added to this resource. Tags are comma-separated key,value pairs
+ * (e.g. Key=myKey
, Value=myKeyValue
. You can include multiple
+ * tags as shown following: Key=myKey
, Value=myKeyValue
+ * Key=mySecondKey
, Value=mySecondKeyValue
. Tags on
+ * replication groups will be replicated to all nodes.
A list of Amazon Resource Names (ARN) that uniquely identify - * the Redis RDB snapshot files stored in Amazon S3. - * The snapshot files are used to populate the new replication group. - * The Amazon S3 object name in the ARN cannot contain any commas. - * The new replication group will have the number of node groups (console: shards) - * specified by the parameter NumNodeGroups or the number of - * node groups configured by NodeGroupConfiguration regardless - * of the number of ARNs specified here.
+ *A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot + * files stored in Amazon S3. The snapshot files are used to populate the new replication + * group. The Amazon S3 object name in the ARN cannot contain any commas. The new + * replication group will have the number of node groups (console: shards) specified by the + * parameter NumNodeGroups or the number of node groups configured by + * NodeGroupConfiguration regardless of the number of ARNs + * specified here.
*Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
*
The name of a snapshot from which to restore data into the new replication group.
- * The snapshot status changes to restoring
while the new replication group is being created.
The name of a snapshot from which to restore data into the new replication group. The
+ * snapshot status changes to restoring
while the new replication group is
+ * being created.
Specifies the weekly time range during which maintenance
- * on the cluster is performed. It is specified as a range in
- * the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum
- * maintenance window is a 60 minute period.
- * Valid values for ddd
are:
Specifies the weekly time range during which maintenance - * on the cluster is performed. It is specified as a range in - * the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum - * maintenance window is a 60 minute period.
+ *Specifies the weekly time range during which maintenance on the cluster is performed.
+ * It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The
+ * minimum maintenance window is a 60 minute period. Valid values for ddd
+ * are:
Specifies the weekly time range during which maintenance on the cluster is performed. + * It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The + * minimum maintenance window is a 60 minute period.
*Valid values for ddd
are:
The port number on which each member of the replication group accepts connections.
+ *The port number on which each member of the replication group accepts + * connections.
*/ Port?: number; /** * @public - *The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) - * topic to which notifications are sent.
+ *The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic + * to which notifications are sent.
*The Amazon SNS topic owner must be the same as the cluster owner.
*If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. - *
+ *If you are running Redis engine version 6.0 or later, set this parameter to yes if + * you want to opt-in to the next auto minor version upgrade campaign. This parameter is + * disabled for previous versions.
*/ AutoMinorVersionUpgrade?: boolean; /** * @public - *The number of days for which ElastiCache retains automatic snapshots before deleting them.
- * For example, if you set SnapshotRetentionLimit
to 5,
- * a snapshot that was taken today is retained for 5 days before being deleted.
The number of days for which ElastiCache retains automatic snapshots before deleting
+ * them. For example, if you set SnapshotRetentionLimit
to 5, a snapshot that
+ * was taken today is retained for 5 days before being deleted.
Default: 0 (i.e., automatic backups are disabled for this cluster).
*/ SnapshotRetentionLimit?: number; /** * @public - *The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
+ *The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot + * of your node group (shard).
*Example: 05:00-09:00
*
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
+ *If you do not specify this parameter, ElastiCache automatically chooses an appropriate + * time range.
*/ SnapshotWindow?: string; /** * @public *- * Reserved parameter. - * The password used to access a password protected server.
+ * Reserved parameter. The password used to access a + * password protected server. *
- * AuthToken
can be specified only on replication groups where TransitEncryptionEnabled
is
- * true
.
AuthToken
can be specified only on replication groups where
+ * TransitEncryptionEnabled
is true
.
* For HIPAA compliance, you must specify TransitEncryptionEnabled
as true
,
- * an AuthToken
, and a CacheSubnetGroup
.
For HIPAA compliance, you must specify TransitEncryptionEnabled
as
+ * true
, an AuthToken
, and a
+ * CacheSubnetGroup
.
Password constraints:
*Must be only printable ASCII characters.
*Must be at least 16 characters and no more than 128 - * characters in length.
+ *Must be at least 16 characters and no more than 128 characters in + * length.
*The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
+ *The only permitted printable special characters are !, &, #, $, ^, <, + * >, and -. Other printable special characters cannot be used in the AUTH + * token.
*For more information, see AUTH password at http://redis.io/commands/AUTH.
+ *For more information, see AUTH + * password at http://redis.io/commands/AUTH.
*/ AuthToken?: string; /** * @public *A flag that enables in-transit encryption when set to true
.
This parameter is valid only if the Engine
parameter is redis
,
- * the EngineVersion
parameter is 3.2.6
, 4.x
or later,
- * and the cluster is being created in an Amazon VPC.
This parameter is valid only if the Engine
parameter is
+ * redis
, the EngineVersion
parameter is 3.2.6
,
+ * 4.x
or later, and the cluster is being created in an Amazon VPC.
If you enable in-transit encryption, you must also specify a value for
- * CacheSubnetGroup
.
CacheSubnetGroup
.
*
- * Required:
- * Only available when creating a replication group in an Amazon VPC using redis version 3.2.6
, 4.x
or later.
3.2.6
, 4.x
or
+ * later.
* Default: false
*
For HIPAA compliance, you must specify TransitEncryptionEnabled
as true
,
- * an AuthToken
, and a CacheSubnetGroup
.
For HIPAA compliance, you must specify TransitEncryptionEnabled
as
+ * true
, an AuthToken
, and a
+ * CacheSubnetGroup
.
A flag that enables encryption at rest when set to true
.
You cannot modify the value of AtRestEncryptionEnabled
after the replication
- * group is created.
- * To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled
to
- * true
when you create the replication group.
You cannot modify the value of AtRestEncryptionEnabled
after the
+ * replication group is created. To enable encryption at rest on a replication group you
+ * must set AtRestEncryptionEnabled
to true
when you create the
+ * replication group.
- * Required:
- * Only available when creating a replication group in an Amazon VPC using redis version 3.2.6
, 4.x
or later.
3.2.6
, 4.x
or
+ * later.
* Default: false
*
Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. - * For more information, see Data tiering.
+ *Enables data tiering. Data tiering is only supported for replication groups using the + * r6gd node type. This parameter must be set to true when using r6gd nodes. For more + * information, see Data tiering.
*/ DataTieringEnabled?: boolean; /** * @public - *Must be either ipv4
| ipv6
| dual_stack
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the
- * Nitro system.
Must be either ipv4
| ipv6
| dual_stack
. IPv6
+ * is supported for workloads using Redis engine version 6.2 onward or Memcached engine
+ * version 1.6.6 on all instances built on the Nitro system.
The network type you choose when creating a replication group, either ipv4
| ipv6
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the
- * Nitro system.
The network type you choose when creating a replication group, either
+ * ipv4
| ipv6
. IPv6 is supported for workloads using Redis
+ * engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on
+ * the Nitro system.
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
- *When setting TransitEncryptionEnabled
to true
, you can set your
- * TransitEncryptionMode
to preferred
in the same request, to allow
- * both encrypted and unencrypted connections at the same time. Once you migrate all your Redis
- * clients to use encrypted connections you can modify the value to required
to
- * allow encrypted connections only.
A setting that allows you to migrate your clients to use in-transit encryption, with + * no downtime.
+ *When setting TransitEncryptionEnabled
to true
, you can set
+ * your TransitEncryptionMode
to preferred
in the same request,
+ * to allow both encrypted and unencrypted connections at the same time. Once you migrate
+ * all your Redis clients to use encrypted connections you can modify the value to
+ * required
to allow encrypted connections only.
Setting TransitEncryptionMode
to required
is a two-step
- * process that requires you to first set the TransitEncryptionMode
to preferred
,
- * after that you can set TransitEncryptionMode
to required
.
TransitEncryptionMode
to
+ * preferred
, after that you can set TransitEncryptionMode
to
+ * required
.
* This process will not trigger the replacement of the replication group.
*/ TransitEncryptionMode?: TransitEncryptionMode | string; /** * @public - *Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. - * - * Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
+ *Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first + * set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect + * using both cluster mode enabled and cluster mode disabled. After you migrate all Redis + * clients to use cluster mode enabled, you can then complete cluster mode configuration + * and set the cluster mode to Enabled.
*/ ClusterMode?: ClusterMode | string; } @@ -5121,8 +5301,8 @@ export class InvalidUserGroupStateFault extends __BaseException { /** * @public - *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 maximum allowed number of + * node groups (shards) in a single replication group. The default maximum is 90
*/ export class NodeGroupsPerReplicationGroupQuotaExceededFault extends __BaseException { readonly name: "NodeGroupsPerReplicationGroupQuotaExceededFault" = "NodeGroupsPerReplicationGroupQuotaExceededFault"; @@ -5167,13 +5347,15 @@ export class ReplicationGroupAlreadyExistsFault extends __BaseException { export interface CreateSnapshotMessage { /** * @public - *The identifier of an existing replication group. The snapshot is created from this replication group.
+ *The identifier of an existing replication group. The snapshot is created from this + * replication group.
*/ ReplicationGroupId?: string; /** * @public - *The identifier of an existing cluster. The snapshot is created from this cluster.
+ *The identifier of an existing cluster. The snapshot is created from this + * cluster.
*/ CacheClusterId?: string; @@ -5191,7 +5373,8 @@ export interface CreateSnapshotMessage { /** * @public - *A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
+ *A list of tags to be added to this resource. A tag is a key-value pair. A tag key must + * be accompanied by a tag value, although null is accepted.
*/ Tags?: Tag[]; } @@ -5202,7 +5385,8 @@ export interface CreateSnapshotMessage { export interface CreateSnapshotResult { /** * @public - *Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.
+ *Represents a copy of an entire Redis cluster as of the time when the snapshot was + * taken.
*/ Snapshot?: Snapshot; } @@ -5212,11 +5396,12 @@ export interface CreateSnapshotResult { *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 Redis cluster running on a
+ * cache.t1.micro
cache node.
Creating a snapshot of a cluster that is running Memcached rather than Redis.
+ *Creating a snapshot of a cluster that is running Memcached rather than + * Redis.
*Neither of these are supported by ElastiCache.
@@ -5259,13 +5444,15 @@ export type InputAuthenticationType = (typeof InputAuthenticationType)[keyof typ export interface AuthenticationMode { /** * @public - *Specifies the authentication type. Possible options are IAM authentication, password and no password.
+ *Specifies the authentication type. Possible options are IAM authentication, password + * and no password.
*/ Type?: InputAuthenticationType | string; /** * @public - *Specifies the passwords to use for authentication if Type
is set to password
.
Specifies the passwords to use for authentication if Type
is set to
+ * password
.
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
+ *A list of tags to be added to this resource. A tag is a key-value pair. A tag key must + * be accompanied by a tag value, although null is accepted.
*/ Tags?: Tag[]; @@ -5499,7 +5687,8 @@ export interface CreateUserGroupMessage { /** * @public - *A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
+ *A list of tags to be added to this resource. A tag is a key-value pair. A tag key must + * be accompanied by a tag value, although null is accepted.
*/ Tags?: Tag[]; } @@ -5554,7 +5743,8 @@ export interface UserGroup { /** * @public - *Indicates user group status. Can be "creating", "active", "modifying", "deleting".
+ *Indicates user group status. Can be "creating", "active", "modifying", + * "deleting".
*/ Status?: string; @@ -5647,30 +5837,35 @@ export interface DecreaseNodeGroupsInGlobalReplicationGroupMessage { /** * @public - *The number of node groups (shards) that results from the modification of the shard configuration
+ *The number of node groups (shards) that results from the modification of the shard + * configuration
*/ NodeGroupCount: number | undefined; /** * @public - *If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. - * - * ElastiCache for Redis will attempt to remove all node groups listed by GlobalNodeGroupsToRemove from the cluster.
+ *If the value of NodeGroupCount is less than the current number of node groups + * (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. + * GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. + * ElastiCache for Redis will attempt to remove all node groups listed by + * GlobalNodeGroupsToRemove from the cluster.
*/ GlobalNodeGroupsToRemove?: string[]; /** * @public - *If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster. ElastiCache for Redis will attempt to retain all node groups listed by GlobalNodeGroupsToRetain from the cluster. - * - * - *
+ *If the value of NodeGroupCount is less than the current number of node groups + * (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. + * GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster. + * ElastiCache for Redis will attempt to retain all node groups listed by + * GlobalNodeGroupsToRetain from the cluster.
*/ GlobalNodeGroupsToRetain?: string[]; /** * @public - *Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.
+ *Indicates that the shard reconfiguration process begins immediately. At present, the + * only permitted value for this parameter is true.
*/ ApplyImmediately: boolean | undefined; } @@ -5681,12 +5876,14 @@ export interface DecreaseNodeGroupsInGlobalReplicationGroupMessage { export interface DecreaseNodeGroupsInGlobalReplicationGroupResult { /** * @public - *Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary - * cluster automatically replicates updates to the secondary cluster.
+ *Consists of a primary cluster that accepts writes and an associated secondary cluster + * that resides in a different Amazon region. The secondary cluster accepts only reads. The + * primary cluster automatically replicates updates to the secondary cluster.
*The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, - * which is what you use to associate a secondary cluster.
+ *The GlobalReplicationGroupIdSuffix represents + * the name of the Global datastore, which is what you use to associate a secondary + * cluster.
*Node group (shard) configuration options when adding or removing replicas. - * Each node group (shard) configuration has the following members: NodeGroupId, NewReplicaCount, and PreferredAvailabilityZones.
+ *Node group (shard) configuration options when adding or removing replicas. Each + * node group (shard) configuration has the following members: NodeGroupId, + * NewReplicaCount, and PreferredAvailabilityZones.
*/ export interface ConfigureShard { /** * @public - *The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) - * replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)'s - * node group's (shard's) id, see Finding a Shard's Id.
+ *The 4-digit id for the node group you are configuring. For Redis (cluster mode + * disabled) replication groups, the node group id is always 0001. To find a Redis (cluster + * mode enabled)'s node group's (shard's) id, see Finding a Shard's + * Id.
*/ NodeGroupId: string | undefined; /** * @public - *The number of replicas you want in this node group at the end of this operation.
- * The maximum value for NewReplicaCount
is 5.
- * The minimum value depends upon the type of Redis replication group you are working with.
The number of replicas you want in this node group at the end of this operation.
+ * The maximum value for NewReplicaCount
is 5. The minimum value depends upon
+ * the type of Redis replication group you are working with.
The minimum number of replicas in a shard or replication group is:
*Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
+ *Redis (cluster mode enabled): 0 (though you will not be able to failover to + * a replica if your primary node fails)
*A list of PreferredAvailabilityZone
strings that specify which availability zones the
- * replication group's nodes are to be in. The nummber of PreferredAvailabilityZone
values must
- * equal the value of NewReplicaCount
plus 1 to account for the primary node. If this member of
- * ReplicaConfiguration
is omitted, ElastiCache for Redis selects the availability zone for
- * each of the replicas.
A list of PreferredAvailabilityZone
strings that specify which
+ * availability zones the replication group's nodes are to be in. The nummber of
+ * PreferredAvailabilityZone
values must equal the value of
+ * NewReplicaCount
plus 1 to account for the primary node. If this member
+ * of ReplicaConfiguration
is omitted, ElastiCache for Redis selects the
+ * availability zone for each of the replicas.
The id of the replication group from which you want to remove replica nodes.
+ *The id of the replication group from which you want to remove replica + * nodes.
*/ ReplicationGroupId: string | undefined; /** * @public - *The number of read replica nodes you want at the completion of this operation. - * For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the - * replication group. For Redis (cluster mode enabled) replication groups, this is the number of - * replica nodes in each of the replication group's node groups.
+ *The number of read replica nodes you want at the completion of this operation. For + * Redis (cluster mode disabled) replication groups, this is the number of replica nodes in + * the replication group. For Redis (cluster mode enabled) replication groups, this is the + * number of replica nodes in each of the replication group's node groups.
*The minimum number of replicas in a shard or replication group is:
*Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
+ *Redis (cluster mode enabled): 0 (though you will not be able to failover to + * a replica if your primary node fails)
*A list of ConfigureShard
objects that can be used to configure each shard
- * in a Redis (cluster mode enabled) replication group. The ConfigureShard
has three members:
- * NewReplicaCount
, NodeGroupId
, and PreferredAvailabilityZones
.
A list of ConfigureShard
objects that can be used to configure each
+ * shard in a Redis (cluster mode enabled) replication group. The
+ * ConfigureShard
has three members: NewReplicaCount
,
+ * NodeGroupId
, and PreferredAvailabilityZones
.
A list of the node ids to remove from the replication group or node group (shard).
+ *A list of the node ids to remove from the replication group or node group + * (shard).
*/ ReplicasToRemove?: string[]; /** * @public *If True
, the number of replica nodes is decreased immediately.
- *
- * ApplyImmediately=False
is not currently supported.
ApplyImmediately=False
is not currently supported.
*/
ApplyImmediately: boolean | undefined;
}
@@ -5846,14 +6050,16 @@ export class NoOperationFault extends __BaseException {
export interface DeleteCacheClusterMessage {
/**
* @public
- * The cluster identifier for the cluster to be deleted. This parameter is not case sensitive.
+ *The cluster identifier for the cluster to be deleted. This parameter is not case + * sensitive.
*/ CacheClusterId: string | undefined; /** * @public - *The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. - * ElastiCache creates the snapshot, and then deletes the cluster immediately afterward.
+ *The user-supplied name of a final cluster snapshot. This is the unique name that + * identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster + * immediately afterward.
*/ FinalSnapshotIdentifier?: string; } @@ -5878,7 +6084,8 @@ export interface DeleteCacheParameterGroupMessage { * @public *The name of the cache parameter group to delete.
*The specified cache security group must not be associated with any clusters.
+ *The specified cache security group must not be associated with any + * clusters.
*Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary - * cluster automatically replicates updates to the secondary cluster.
+ *Consists of a primary cluster that accepts writes and an associated secondary cluster + * that resides in a different Amazon region. The secondary cluster accepts only reads. The + * primary cluster automatically replicates updates to the secondary cluster.
*The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, - * which is what you use to associate a secondary cluster.
+ *The GlobalReplicationGroupIdSuffix represents + * the name of the Global datastore, which is what you use to associate a secondary + * cluster.
*The identifier for the cluster to be deleted. This parameter is not case sensitive.
+ *The identifier for the cluster to be deleted. This parameter is not case + * sensitive.
*/ ReplicationGroupId: string | undefined; /** * @public - *If set to true
, all of the read replicas are deleted,
- * but the primary node is retained.
If set to true
, all of the read replicas are deleted, but the primary
+ * node is retained.
The name of a final node group (shard) snapshot. - * ElastiCache creates the snapshot from the primary node in the cluster, - * rather than one of the replicas; this is to ensure that it captures the freshest data. - * After the final snapshot is taken, the replication group is immediately deleted.
+ *The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from + * the primary node in the cluster, rather than one of the replicas; this is to ensure that + * it captures the freshest data. After the final snapshot is taken, the replication group + * is immediately deleted.
*/ FinalSnapshotIdentifier?: string; } @@ -6024,7 +6234,8 @@ export interface DeleteSnapshotMessage { export interface DeleteSnapshotResult { /** * @public - *Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.
+ *Represents a copy of an entire Redis cluster as of the time when the snapshot was + * taken.
*/ Snapshot?: Snapshot; } @@ -6104,7 +6315,8 @@ export interface CacheClusterMessage { /** * @public - *A list of clusters. Each item in the list contains detailed information about one cluster.
+ *A list of clusters. Each item in the list contains detailed information about one + * cluster.
*/ CacheClusters?: CacheCluster[]; } @@ -6123,9 +6335,9 @@ export interface DescribeCacheClustersMessage { /** * @public - *The maximum number of records to include in the response. If more records exist than the
- * specified MaxRecords
value, a marker is included in the response so that
- * the remaining results can be retrieved.
The maximum number of records to include in the response. If more records exist than
+ * the specified MaxRecords
value, a marker is included in the response so
+ * that the remaining results can be retrieved.
Default: 100
*Constraints: minimum 20; maximum 100.
*/ @@ -6133,10 +6345,9 @@ export interface DescribeCacheClustersMessage { /** * @public - *An optional marker returned from a prior request.
- * Use this marker for pagination of results from this operation. If this
- * parameter is specified, the response includes only records beyond the marker, up to the
- * value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of
+ * results from this operation. If this parameter is specified, the response includes only
+ * records beyond the marker, up to the value specified by MaxRecords
.
An optional flag that can be included in the DescribeCacheCluster
request
- * to show only nodes (API/CLI: clusters) that are not members of a replication group.
- * In practice, this mean Memcached and single node Redis clusters.
The name of the cache parameter group family associated with this cache engine.
- *Valid values are:
- * memcached1.4
|
- * memcached1.5
|
- * memcached1.6
|
- * redis2.6
|
- * redis2.8
|
- * redis3.2
|
- * redis4.0
|
- * redis5.0
|
- * redis6.x
|
- * redis7
+ *
Valid values are: memcached1.4
| memcached1.5
|
+ * memcached1.6
| redis2.6
| redis2.8
|
+ * redis3.2
| redis4.0
| redis5.0
|
+ * redis6.x
| redis7
*
Represents the output of a DescribeCacheEngineVersions operation.
+ *Represents the output of a DescribeCacheEngineVersions + * operation.
*/ export interface CacheEngineVersionMessage { /** @@ -6217,8 +6422,8 @@ export interface CacheEngineVersionMessage { /** * @public - *A list of cache engine version details. - * Each element in the list contains detailed information about one cache engine version.
+ *A list of cache engine version details. Each element in the list contains detailed + * information about one cache engine version.
*/ CacheEngineVersions?: CacheEngineVersion[]; } @@ -6230,7 +6435,8 @@ export interface CacheEngineVersionMessage { export interface DescribeCacheEngineVersionsMessage { /** * @public - *The cache engine to return. Valid values: memcached
| redis
+ *
The cache engine to return. Valid values: memcached
|
+ * redis
*
The name of a specific cache parameter group family to return details for.
- *Valid values are:
- * memcached1.4
|
- * memcached1.5
|
- * memcached1.6
|
- * redis2.6
|
- * redis2.8
|
- * redis3.2
|
- * redis4.0
|
- * redis5.0
|
- * redis6.x
|
- * redis6.2
|
- * redis7
+ *
Valid values are: memcached1.4
| memcached1.5
|
+ * memcached1.6
| redis2.6
| redis2.8
|
+ * redis3.2
| redis4.0
| redis5.0
|
+ * redis6.x
| redis6.2
| redis7
*
Constraints:
*The maximum number of records to include in the response. If more records exist than the
- * specified MaxRecords
value, a marker is included in the response so that
- * the remaining results can be retrieved.
The maximum number of records to include in the response. If more records exist than
+ * the specified MaxRecords
value, a marker is included in the response so
+ * that the remaining results can be retrieved.
Default: 100
*Constraints: minimum 20; maximum 100.
*/ @@ -6286,16 +6484,16 @@ export interface DescribeCacheEngineVersionsMessage { /** * @public - *An optional marker returned from a prior request. Use this marker for pagination of results from this operation.
- * If this parameter is specified, the response includes only records beyond the marker, up to the
- * value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of
+ * results from this operation. If this parameter is specified, the response includes only
+ * records beyond the marker, up to the value specified by MaxRecords
.
If true
, specifies that only the default version of the specified engine or engine
- * and major version combination is to be returned.
If true
, specifies that only the default version of the specified engine
+ * or engine and major version combination is to be returned.
A list of cache parameter groups. Each element in the list contains detailed information - * about one cache parameter group.
+ *A list of cache parameter groups. Each element in the list contains detailed + * information about one cache parameter group.
*/ CacheParameterGroups?: CacheParameterGroup[]; } @@ -6332,9 +6530,9 @@ export interface DescribeCacheParameterGroupsMessage { /** * @public - *The maximum number of records to include in the response. If more records exist than the
- * specified MaxRecords
value, a marker is included in the response so that
- * the remaining results can be retrieved.
The maximum number of records to include in the response. If more records exist than
+ * the specified MaxRecords
value, a marker is included in the response so
+ * that the remaining results can be retrieved.
Default: 100
*Constraints: minimum 20; maximum 100.
*/ @@ -6342,9 +6540,9 @@ export interface DescribeCacheParameterGroupsMessage { /** * @public - *An optional marker returned from a prior request. Use this marker for pagination of results from this operation.
- * If this parameter is specified, the response includes only records beyond the marker, up to the
- * value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of
+ * results from this operation. If this parameter is specified, the response includes only
+ * records beyond the marker, up to the value specified by MaxRecords
.
Indicates whether a change to the parameter is applied immediately - * or requires a reboot for the change to be applied. - * You can force a reboot or wait until the next maintenance window's reboot. - * For more information, see Rebooting a Cluster.
+ *Indicates whether a change to the parameter is applied immediately or requires a + * reboot for the change to be applied. You can force a reboot or wait until the next + * maintenance window's reboot. For more information, see Rebooting a + * Cluster.
*/ ChangeType?: ChangeType | string; } /** * @public - *Describes an individual setting that controls some aspect of ElastiCache behavior.
+ *Describes an individual setting that controls some aspect of ElastiCache + * behavior.
*/ export interface Parameter { /** @@ -6491,8 +6690,9 @@ export interface Parameter { /** * @public - *Indicates whether (true
) or not (false
) the parameter can be modified.
- * Some parameters have security or operational implications that prevent them from being changed.
Indicates whether (true
) or not (false
) the parameter can be
+ * modified. Some parameters have security or operational implications that prevent them
+ * from being changed.
Indicates whether a change to the parameter is applied immediately - * or requires a reboot for the change to be applied. - * You can force a reboot or wait until the next maintenance window's reboot. - * For more information, see Rebooting a Cluster.
+ *Indicates whether a change to the parameter is applied immediately or requires a + * reboot for the change to be applied. You can force a reboot or wait until the next + * maintenance window's reboot. For more information, see Rebooting a + * Cluster.
*/ ChangeType?: ChangeType | string; } @@ -6531,8 +6731,8 @@ export interface CacheParameterGroupDetails { /** * @public - *A list of parameters specific to a particular cache node type. - * Each element in the list contains detailed information about one parameter.
+ *A list of parameters specific to a particular cache node type. Each element in the + * list contains detailed information about one parameter.
*/ CacheNodeTypeSpecificParameters?: CacheNodeTypeSpecificParameter[]; } @@ -6551,16 +6751,17 @@ export interface DescribeCacheParametersMessage { /** * @public *The parameter types to return.
- *Valid values: user
| system
| engine-default
+ *
Valid values: user
| system
|
+ * engine-default
*
The maximum number of records to include in the response. If more records exist than the
- * specified MaxRecords
value, a marker is included in the response so that
- * the remaining results can be retrieved.
The maximum number of records to include in the response. If more records exist than
+ * the specified MaxRecords
value, a marker is included in the response so
+ * that the remaining results can be retrieved.
Default: 100
*Constraints: minimum 20; maximum 100.
*/ @@ -6568,10 +6769,9 @@ export interface DescribeCacheParametersMessage { /** * @public - *An optional marker returned from a prior request.
- * Use this marker for pagination of results from this operation.
- * If this parameter is specified, the response includes only records beyond the marker, up to the
- * value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of
+ * results from this operation. If this parameter is specified, the response includes only
+ * records beyond the marker, up to the value specified by MaxRecords
.
A list of cache security groups. Each element in the list contains detailed information about one group.
+ *A list of cache security groups. Each element in the list contains detailed + * information about one group.
*/ CacheSecurityGroups?: CacheSecurityGroup[]; } @@ -6607,9 +6808,9 @@ export interface DescribeCacheSecurityGroupsMessage { /** * @public - *The maximum number of records to include in the response. If more records exist than the
- * specified MaxRecords
value, a marker is included in the response so that
- * the remaining results can be retrieved.
The maximum number of records to include in the response. If more records exist than
+ * the specified MaxRecords
value, a marker is included in the response so
+ * that the remaining results can be retrieved.
Default: 100
*Constraints: minimum 20; maximum 100.
*/ @@ -6617,9 +6818,9 @@ export interface DescribeCacheSecurityGroupsMessage { /** * @public - *An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this
- * parameter is specified, the response includes only records beyond the marker, up to the
- * value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of
+ * results from this operation. If this parameter is specified, the response includes only
+ * records beyond the marker, up to the value specified by MaxRecords
.
A list of cache subnet groups. Each element in the list contains detailed information about one group.
+ *A list of cache subnet groups. Each element in the list contains detailed information + * about one group.
*/ CacheSubnetGroups?: CacheSubnetGroup[]; } @@ -6655,9 +6857,9 @@ export interface DescribeCacheSubnetGroupsMessage { /** * @public - *The maximum number of records to include in the response. If more records exist than the
- * specified MaxRecords
value, a marker is included in the response so that
- * the remaining results can be retrieved.
The maximum number of records to include in the response. If more records exist than
+ * the specified MaxRecords
value, a marker is included in the response so
+ * that the remaining results can be retrieved.
Default: 100
*Constraints: minimum 20; maximum 100.
*/ @@ -6665,43 +6867,35 @@ export interface DescribeCacheSubnetGroupsMessage { /** * @public - *An optional marker returned from a prior request.
- * Use this marker for pagination of results from this operation.
- * If this parameter is specified, the response includes only records beyond the marker, up to the
- * value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of
+ * results from this operation. If this parameter is specified, the response includes only
+ * records beyond the marker, up to the value specified by MaxRecords
.
Represents the input of a DescribeEngineDefaultParameters
operation.
Represents the input of a DescribeEngineDefaultParameters
+ * operation.
The name of the cache parameter group family.
- *Valid values are:
- * memcached1.4
|
- * memcached1.5
|
- * memcached1.6
|
- * redis2.6
|
- * redis2.8
|
- * redis3.2
|
- * redis4.0
|
- * redis5.0
|
- * redis6.x
|
- * redis6.2
|
- * redis7
+ *
Valid values are: memcached1.4
| memcached1.5
|
+ * memcached1.6
| redis2.6
| redis2.8
|
+ * redis3.2
| redis4.0
| redis5.0
|
+ * redis6.x
| redis6.2
| redis7
*
The maximum number of records to include in the response. If more records exist than the
- * specified MaxRecords
value, a marker is included in the response so that
- * the remaining results can be retrieved.
The maximum number of records to include in the response. If more records exist than
+ * the specified MaxRecords
value, a marker is included in the response so
+ * that the remaining results can be retrieved.
Default: 100
*Constraints: minimum 20; maximum 100.
*/ @@ -6709,33 +6903,27 @@ export interface DescribeEngineDefaultParametersMessage { /** * @public - *An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this
- * parameter is specified, the response includes only records beyond the marker, up to the
- * value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of
+ * results from this operation. If this parameter is specified, the response includes only
+ * records beyond the marker, up to the value specified by MaxRecords
.
Represents the output of a DescribeEngineDefaultParameters
operation.
Represents the output of a DescribeEngineDefaultParameters
+ * operation.
Specifies the name of the cache parameter group family to which the engine default parameters apply.
- *Valid values are:
- * memcached1.4
|
- * memcached1.5
|
- * memcached1.6
|
- * redis2.6
|
- * redis2.8
|
- * redis3.2
|
- * redis4.0
|
- * redis5.0
|
- * redis6.0
|
- * redis6.x
|
- * redis7
+ *
Specifies the name of the cache parameter group family to which the engine default + * parameters apply.
+ *Valid values are: memcached1.4
| memcached1.5
|
+ * memcached1.6
| redis2.6
| redis2.8
|
+ * redis3.2
| redis4.0
| redis5.0
|
+ * redis6.0
| redis6.x
| redis7
*
A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.
+ *A list of parameters specific to a particular cache node type. Each element in the + * list contains detailed information about one parameter.
*/ CacheNodeTypeSpecificParameters?: CacheNodeTypeSpecificParameter[]; } @@ -6765,7 +6954,8 @@ export interface EngineDefaults { export interface DescribeEngineDefaultParametersResult { /** * @public - *Represents the output of a DescribeEngineDefaultParameters
operation.
Represents the output of a DescribeEngineDefaultParameters
+ * operation.
The identifier of the event source for which events are returned. - * If not specified, all sources are included in the response.
+ *The identifier of the event source for which events are returned. If not specified, + * all sources are included in the response.
*/ SourceIdentifier?: string; /** * @public - *The event source to retrieve events for. - * If no value is specified, all events are returned.
+ *The event source to retrieve events for. If no value is specified, all events are + * returned.
*/ SourceType?: SourceType | string; /** * @public - *The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
+ *The beginning of the time interval to retrieve events for, specified in ISO 8601 + * format.
** Example: 2017-03-30T07:03:49.555Z
*/ @@ -6818,7 +7009,8 @@ export interface DescribeEventsMessage { /** * @public - *The end of the time interval for which to retrieve events, specified in ISO 8601 format.
+ *The end of the time interval for which to retrieve events, specified in ISO 8601 + * format.
** Example: 2017-03-30T07:03:49.555Z
*/ @@ -6832,9 +7024,9 @@ export interface DescribeEventsMessage { /** * @public - *The maximum number of records to include in the response. If more records exist than the
- * specified MaxRecords
value, a marker is included in the response so that
- * the remaining results can be retrieved.
The maximum number of records to include in the response. If more records exist than
+ * the specified MaxRecords
value, a marker is included in the response so
+ * that the remaining results can be retrieved.
Default: 100
*Constraints: minimum 20; maximum 100.
*/ @@ -6842,31 +7034,31 @@ export interface DescribeEventsMessage { /** * @public - *An optional marker returned from a prior request.
- * Use this marker for pagination of results from this operation.
- * If this parameter is specified, the response includes only records beyond the marker,
- * up to the value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of
+ * results from this operation. If this parameter is specified, the response includes only
+ * records beyond the marker, up to the value specified by MaxRecords
.
Represents a single occurrence of something interesting within the system. - * Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.
+ *Represents a single occurrence of something interesting within the system. Some + * examples of events are creating a cluster, adding or removing a cache node, or rebooting + * a node.
*/ export interface Event { /** * @public - *The identifier for the source of the event. - * For example, if the event occurred at the cluster level, - * the identifier would be the name of the cluster.
+ *The identifier for the source of the event. For example, if the event occurred at the + * cluster level, the identifier would be the name of the cluster.
*/ SourceIdentifier?: string; /** * @public - *Specifies the origin of this event - a cluster, a parameter group, a security group, etc.
+ *Specifies the origin of this event - a cluster, a parameter group, a security group, + * etc.
*/ SourceType?: SourceType | string; @@ -6896,7 +7088,8 @@ export interface EventsMessage { /** * @public - *A list of events. Each element in the list contains detailed information about one event.
+ *A list of events. Each element in the list contains detailed information about one + * event.
*/ Events?: Event[]; } @@ -6913,13 +7106,17 @@ export interface DescribeGlobalReplicationGroupsMessage { /** * @public - *The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
+ *The maximum number of records to include in the response. If more records exist than + * the specified MaxRecords value, a marker is included in the response so that the + * remaining results can be retrieved.
*/ MaxRecords?: number; /** * @public - *An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of
+ * results from this operation. If this parameter is specified, the response includes only
+ * records beyond the marker, up to the value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >
+ *An optional marker returned from a prior request. Use this marker for pagination of + * results from this operation. If this parameter is specified, the response includes only + * records beyond the marker, up to the value specified by MaxRecords. >
*/ Marker?: string; @@ -6954,16 +7153,18 @@ export interface DescribeGlobalReplicationGroupsResult { export interface DescribeReplicationGroupsMessage { /** * @public - *The identifier for the replication group to be described. This parameter is not case sensitive.
- *If you do not specify this parameter, information about all replication groups is returned.
+ *The identifier for the replication group to be described. This parameter is not case + * sensitive.
+ *If you do not specify this parameter, information about all replication groups is + * returned.
*/ ReplicationGroupId?: string; /** * @public - *The maximum number of records to include in the response. If more records exist than the
- * specified MaxRecords
value, a marker is included in the response so that
- * the remaining results can be retrieved.
The maximum number of records to include in the response. If more records exist than
+ * the specified MaxRecords
value, a marker is included in the response so
+ * that the remaining results can be retrieved.
Default: 100
*Constraints: minimum 20; maximum 100.
*/ @@ -6971,9 +7172,9 @@ export interface DescribeReplicationGroupsMessage { /** * @public - *An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this
- * parameter is specified, the response includes only records beyond the marker, up to the
- * value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of
+ * results from this operation. If this parameter is specified, the response includes only
+ * records beyond the marker, up to the value specified by MaxRecords
.
A list of replication groups. Each item in the list contains detailed information about one replication group.
+ *A list of replication groups. Each item in the list contains detailed information + * about one replication group.
*/ ReplicationGroups?: ReplicationGroup[]; } @@ -7003,25 +7205,25 @@ export interface ReplicationGroupMessage { export interface DescribeReservedCacheNodesMessage { /** * @public - *The reserved cache node identifier filter value. - * Use this parameter to show only the reservation that matches the specified reservation ID.
+ *The reserved cache node identifier filter value. Use this parameter to show only the + * reservation that matches the specified reservation ID.
*/ ReservedCacheNodeId?: string; /** * @public - *The offering identifier filter value. - * Use this parameter to show only purchased reservations matching the specified offering identifier.
+ *The offering identifier filter value. Use this parameter to show only purchased + * reservations matching the specified offering identifier.
*/ ReservedCacheNodesOfferingId?: string; /** * @public - *The cache node type filter value. - * Use this parameter to show only those reservations matching the specified cache node type.
- *The following node types are supported by ElastiCache. - * Generally speaking, the current generation types provide more memory and computational power - * at lower cost when compared to their equivalent previous generation counterparts.
+ *The cache node type filter value. Use this parameter to show only those reservations + * matching the specified cache node type.
+ *The following node types are supported by ElastiCache. Generally speaking, the current + * generation types provide more memory and computational power at lower cost when compared + * to their equivalent previous generation counterparts.
*General purpose:
@@ -7178,17 +7380,20 @@ export interface DescribeReservedCacheNodesMessage { * *All current generation instance types are created in Amazon VPC by default.
+ *All current generation instance types are created in Amazon VPC by + * default.
*Redis append-only files (AOF) are not supported for T1 or T2 instances.
*Redis Multi-AZ with automatic failover is not supported on T1 instances.
+ *Redis Multi-AZ with automatic failover is not supported on T1 + * instances.
*Redis configuration variables appendonly
and
- * appendfsync
are not supported on Redis version 2.8.22 and later.
appendfsync
are not supported on Redis version 2.8.22 and
+ * later.
* The duration filter value, specified in years or seconds. - * Use this parameter to show only reservations for this duration.
+ *The duration filter value, specified in years or seconds. Use this parameter to show + * only reservations for this duration.
*Valid Values: 1 | 3 | 31536000 | 94608000
*
The product description filter value. Use this parameter to show only those reservations matching the specified product description.
+ *The product description filter value. Use this parameter to show only those + * reservations matching the specified product description.
*/ ProductDescription?: string; /** * @public - *The offering type filter value. - * Use this parameter to show only the available offerings matching the specified offering type.
- *Valid values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"|"All Upfront"|"Partial Upfront"| "No Upfront"
+ *
The offering type filter value. Use this parameter to show only the available + * offerings matching the specified offering type.
+ *Valid values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"|"All
+ * Upfront"|"Partial Upfront"| "No Upfront"
*
The maximum number of records to include in the response. If more records exist than the
- * specified MaxRecords
value, a marker is included in the response so that
- * the remaining results can be retrieved.
The maximum number of records to include in the response. If more records exist than
+ * the specified MaxRecords
value, a marker is included in the response so
+ * that the remaining results can be retrieved.
Default: 100
*Constraints: minimum 20; maximum 100.
*/ @@ -7230,18 +7437,17 @@ export interface DescribeReservedCacheNodesMessage { /** * @public - *An optional marker returned from a prior request.
- * Use this marker for pagination of results from this operation.
- * If this parameter is specified, the response includes only records beyond the marker,
- * up to the value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of
+ * results from this operation. If this parameter is specified, the response includes only
+ * records beyond the marker, up to the value specified by MaxRecords
.
Contains the specific price and frequency of a recurring charges for a reserved cache node, - * or for a reserved cache node offering.
+ *Contains the specific price and frequency of a recurring charges for a reserved cache + * node, or for a reserved cache node offering.
*/ export interface RecurringCharge { /** @@ -7259,7 +7465,8 @@ export interface RecurringCharge { /** * @public - *Represents the output of a PurchaseReservedCacheNodesOffering
operation.
Represents the output of a PurchaseReservedCacheNodesOffering
+ * operation.
The cache node type for the reserved cache nodes.
- *The following node types are supported by ElastiCache. - * Generally speaking, the current generation types provide more memory and computational power - * at lower cost when compared to their equivalent previous generation counterparts.
+ *The following node types are supported by ElastiCache. Generally speaking, the current + * generation types provide more memory and computational power at lower cost when compared + * to their equivalent previous generation counterparts.
*General purpose:
@@ -7436,17 +7643,20 @@ export interface ReservedCacheNode { * *All current generation instance types are created in Amazon VPC by default.
+ *All current generation instance types are created in Amazon VPC by + * default.
*Redis append-only files (AOF) are not supported for T1 or T2 instances.
*Redis Multi-AZ with automatic failover is not supported on T1 instances.
+ *Redis Multi-AZ with automatic failover is not supported on T1 + * instances.
*Redis configuration variables appendonly
and
- * appendfsync
are not supported on Redis version 2.8.22 and later.
appendfsync
are not supported on Redis version 2.8.22 and
+ * later.
* The Amazon Resource Name (ARN) of the reserved cache node.
- *Example: arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582
+ *
Example:
+ * arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582
*
A list of reserved cache nodes. Each element in the list contains detailed information about one node.
+ *A list of reserved cache nodes. Each element in the list contains detailed information + * about one node.
*/ ReservedCacheNodes?: ReservedCacheNode[]; } /** * @public - *Represents the input of a DescribeReservedCacheNodesOfferings
operation.
Represents the input of a DescribeReservedCacheNodesOfferings
+ * operation.
The offering identifier filter value. - * Use this parameter to show only the available offering that matches the specified reservation identifier.
+ *The offering identifier filter value. Use this parameter to show only the available + * offering that matches the specified reservation identifier.
*Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
*
The cache node type filter value. - * Use this parameter to show only the available offerings matching the specified cache node type.
- *The following node types are supported by ElastiCache. - * Generally speaking, the current generation types provide more memory and computational power - * at lower cost when compared to their equivalent previous generation counterparts.
+ *The cache node type filter value. Use this parameter to show only the available + * offerings matching the specified cache node type.
+ *The following node types are supported by ElastiCache. Generally speaking, the current + * generation types provide more memory and computational power at lower cost when compared + * to their equivalent previous generation counterparts.
*General purpose:
@@ -7710,17 +7923,20 @@ export interface DescribeReservedCacheNodesOfferingsMessage { * *All current generation instance types are created in Amazon VPC by default.
+ *All current generation instance types are created in Amazon VPC by + * default.
*Redis append-only files (AOF) are not supported for T1 or T2 instances.
*Redis Multi-AZ with automatic failover is not supported on T1 instances.
+ *Redis Multi-AZ with automatic failover is not supported on T1 + * instances.
*Redis configuration variables appendonly
and
- * appendfsync
are not supported on Redis version 2.8.22 and later.
appendfsync
are not supported on Redis version 2.8.22 and
+ * later.
* Duration filter value, specified in years or seconds. - * Use this parameter to show only reservations for a given duration.
+ *Duration filter value, specified in years or seconds. Use this parameter to show only + * reservations for a given duration.
*Valid Values: 1 | 3 | 31536000 | 94608000
*
The product description filter value. - * Use this parameter to show only the available offerings matching the specified product description.
+ *The product description filter value. Use this parameter to show only the available + * offerings matching the specified product description.
*/ ProductDescription?: string; /** * @public - *The offering type filter value. - * Use this parameter to show only the available offerings matching the specified offering type.
- *Valid Values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization" |"All Upfront"|"Partial Upfront"| "No Upfront"
+ *
The offering type filter value. Use this parameter to show only the available + * offerings matching the specified offering type.
+ *Valid Values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization" |"All
+ * Upfront"|"Partial Upfront"| "No Upfront"
*
The maximum number of records to include in the response. If more records exist than the
- * specified MaxRecords
value, a marker is included in the response so that
- * the remaining results can be retrieved.
The maximum number of records to include in the response. If more records exist than
+ * the specified MaxRecords
value, a marker is included in the response so
+ * that the remaining results can be retrieved.
Default: 100
*Constraints: minimum 20; maximum 100.
*/ @@ -7763,10 +7980,9 @@ export interface DescribeReservedCacheNodesOfferingsMessage { /** * @public - *An optional marker returned from a prior request.
- * Use this marker for pagination of results from this operation.
- * If this parameter is specified, the response includes only records beyond the marker,
- * up to the value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of
+ * results from this operation. If this parameter is specified, the response includes only
+ * records beyond the marker, up to the value specified by MaxRecords
.
The cache node type for the reserved cache node.
- *The following node types are supported by ElastiCache. - * Generally speaking, the current generation types provide more memory and computational power - * at lower cost when compared to their equivalent previous generation counterparts.
+ *The following node types are supported by ElastiCache. Generally speaking, the current + * generation types provide more memory and computational power at lower cost when compared + * to their equivalent previous generation counterparts.
*General purpose:
@@ -7944,17 +8160,20 @@ export interface ReservedCacheNodesOffering { * *All current generation instance types are created in Amazon VPC by default.
+ *All current generation instance types are created in Amazon VPC by + * default.
*Redis append-only files (AOF) are not supported for T1 or T2 instances.
*Redis Multi-AZ with automatic failover is not supported on T1 instances.
+ *Redis Multi-AZ with automatic failover is not supported on T1 + * instances.
*Redis configuration variables appendonly
and
- * appendfsync
are not supported on Redis version 2.8.22 and later.
appendfsync
are not supported on Redis version 2.8.22 and
+ * later.
* Represents the output of a DescribeReservedCacheNodesOfferings
operation.
Represents the output of a DescribeReservedCacheNodesOfferings
+ * operation.
A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.
+ *A list of reserved cache node offerings. Each element in the list contains detailed + * information about one offering.
*/ ReservedCacheNodesOfferings?: ReservedCacheNodesOffering[]; } @@ -8074,10 +8295,9 @@ export interface DescribeServiceUpdatesMessage { /** * @public - *An optional marker returned from a prior request.
- * Use this marker for pagination of results from this operation. If this
- * parameter is specified, the response includes only records beyond the marker, up to the
- * value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of
+ * results from this operation. If this parameter is specified, the response includes only
+ * records beyond the marker, up to the value specified by MaxRecords
.
The recommendend date to apply the service update in order to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.
+ *The recommendend date to apply the service update in order to ensure compliance. For + * information on compliance, see Self-Service Security Updates for Compliance.
*/ ServiceUpdateRecommendedApplyByDate?: Date; @@ -8172,13 +8393,15 @@ export interface ServiceUpdate { /** * @public - *The Elasticache engine version to which the update applies. Either Redis or Memcached engine version
+ *The Elasticache engine version to which the update applies. Either Redis or Memcached + * engine version
*/ EngineVersion?: string; /** * @public - *Indicates whether the service update will be automatically applied once the recommended apply-by date has expired.
+ *Indicates whether the service update will be automatically applied once the + * recommended apply-by date has expired.
*/ AutoUpdateAfterRecommendedApplyByDate?: boolean; @@ -8195,10 +8418,9 @@ export interface ServiceUpdate { export interface ServiceUpdatesMessage { /** * @public - *An optional marker returned from a prior request.
- * Use this marker for pagination of results from this operation. If this
- * parameter is specified, the response includes only records beyond the marker, up to the
- * value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of
+ * results from this operation. If this parameter is specified, the response includes only
+ * records beyond the marker, up to the value specified by MaxRecords
.
An optional marker returned from a prior request.
- * Use this marker for pagination of results from this operation.
- * If this parameter is specified, the response includes only records beyond the marker,
- * up to the value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of
+ * results from this operation. If this parameter is specified, the response includes only
+ * records beyond the marker, up to the value specified by MaxRecords
.
A list of snapshots. Each item in the list contains detailed information about one snapshot.
+ *A list of snapshots. Each item in the list contains detailed information about one + * snapshot.
*/ Snapshots?: Snapshot[]; } @@ -8237,47 +8459,47 @@ export interface DescribeSnapshotsListMessage { export interface DescribeSnapshotsMessage { /** * @public - *A user-supplied replication group identifier. - * If this parameter is specified, only snapshots associated with that specific replication group are described.
+ *A user-supplied replication group identifier. If this parameter is specified, only + * snapshots associated with that specific replication group are described.
*/ ReplicationGroupId?: string; /** * @public - *A user-supplied cluster identifier. - * If this parameter is specified, only snapshots associated with that specific cluster are described.
+ *A user-supplied cluster identifier. If this parameter is specified, only snapshots + * associated with that specific cluster are described.
*/ CacheClusterId?: string; /** * @public - *A user-supplied name of the snapshot. - * If this parameter is specified, only this snapshot are described.
+ *A user-supplied name of the snapshot. If this parameter is specified, only this + * snapshot are described.
*/ SnapshotName?: string; /** * @public - *If set to system
, the output shows snapshots that were automatically created by ElastiCache.
- * If set to user
the output shows snapshots that were manually created.
- * If omitted, the output shows both automatically and manually created snapshots.
If set to system
, the output shows snapshots that were automatically
+ * created by ElastiCache. If set to user
the output shows snapshots that were
+ * manually created. If omitted, the output shows both automatically and manually created
+ * snapshots.
An optional marker returned from a prior request.
- * Use this marker for pagination of results from this operation.
- * If this parameter is specified, the response includes only records beyond the marker,
- * up to the value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of
+ * results from this operation. If this parameter is specified, the response includes only
+ * records beyond the marker, up to the value specified by MaxRecords
.
The maximum number of records to include in the response. If more records exist than the
- * specified MaxRecords
value, a marker is included in the response so that
- * the remaining results can be retrieved.
The maximum number of records to include in the response. If more records exist than
+ * the specified MaxRecords
value, a marker is included in the response so
+ * that the remaining results can be retrieved.
Default: 50
*Constraints: minimum 20; maximum 50.
*/ @@ -8285,14 +8507,16 @@ export interface DescribeSnapshotsMessage { /** * @public - *A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
+ *A Boolean value which if true, the node group (shard) configuration is included in the + * snapshot description.
*/ ShowNodeGroupConfig?: boolean; } /** * @public - *Filters update actions from the service updates that are in available status during the time range.
+ *Filters update actions from the service updates that are in available status during + * the time range.
*/ export interface TimeRangeFilter { /** @@ -8344,7 +8568,8 @@ export interface DescribeUpdateActionsMessage { /** * @public - *The range of time specified to search for service updates that are in available status
+ *The range of time specified to search for service updates that are in available + * status
*/ ServiceUpdateTimeRange?: TimeRangeFilter; @@ -8368,10 +8593,9 @@ export interface DescribeUpdateActionsMessage { /** * @public - *An optional marker returned from a prior request.
- * Use this marker for pagination of results from this operation. If this
- * parameter is specified, the response includes only records beyond the marker, up to the
- * value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of
+ * results from this operation. If this parameter is specified, the response includes only
+ * records beyond the marker, up to the value specified by MaxRecords
.
Reflects whether the update was initiated by the customer or automatically applied
+ *Reflects whether the update was initiated by the customer or automatically + * applied
*/ NodeUpdateInitiatedBy?: NodeUpdateInitiatedBy | string; @@ -8464,7 +8689,7 @@ export interface CacheNodeUpdateStatus { /** * @public - *The status of the service update on the node group member
+ *The status of the service update on the node group member
*/ export interface NodeGroupMemberUpdateStatus { /** @@ -8505,7 +8730,8 @@ export interface NodeGroupMemberUpdateStatus { /** * @public - *Reflects whether the update was initiated by the customer or automatically applied
+ *Reflects whether the update was initiated by the customer or automatically + * applied
*/ NodeUpdateInitiatedBy?: NodeUpdateInitiatedBy | string; @@ -8598,13 +8824,14 @@ export interface UpdateAction { /** * @public - *The recommended date to apply the service update to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.
+ *The recommended date to apply the service update to ensure compliance. For information + * on compliance, see Self-Service Security Updates for Compliance.
*/ ServiceUpdateRecommendedApplyByDate?: Date; /** * @public - *Reflects the nature of the service update
+ *Reflects the nature of the service update
*/ ServiceUpdateType?: ServiceUpdateType | string; @@ -8634,8 +8861,10 @@ export interface UpdateAction { /** * @public - *If yes, all nodes in the replication group have been updated by the recommended apply-by date. If no, at least one node in the replication group have not been updated by the recommended apply-by date. If N/A, the replication group was created after the - * recommended apply-by date.
+ *If yes, all nodes in the replication group have been updated by the recommended + * apply-by date. If no, at least one node in the replication group have not been updated + * by the recommended apply-by date. If N/A, the replication group was created after the + * recommended apply-by date.
*/ SlaMet?: SlaMet | string; @@ -8670,10 +8899,9 @@ export interface UpdateAction { export interface UpdateActionsMessage { /** * @public - *An optional marker returned from a prior request.
- * Use this marker for pagination of results from this operation. If this
- * parameter is specified, the response includes only records beyond the marker, up to the
- * value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of
+ * results from this operation. If this parameter is specified, the response includes only
+ * records beyond the marker, up to the value specified by MaxRecords
.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
+ *The maximum number of records to include in the response. If more records exist than + * the specified MaxRecords value, a marker is included in the response so that the + * remaining results can be retrieved.
*/ MaxRecords?: number; /** * @public - *An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >
+ *An optional marker returned from a prior request. Use this marker for pagination of + * results from this operation. If this parameter is specified, the response includes only + * records beyond the marker, up to the value specified by MaxRecords. >
*/ Marker?: string; } @@ -8719,7 +8951,9 @@ export interface DescribeUserGroupsResult { /** * @public - *An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >
+ *An optional marker returned from a prior request. Use this marker for pagination of + * results from this operation. If this parameter is specified, the response includes only + * records beyond the marker, up to the value specified by MaxRecords. >
*/ Marker?: string; } @@ -8766,13 +9000,17 @@ export interface DescribeUsersMessage { /** * @public - *The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
+ *The maximum number of records to include in the response. If more records exist than + * the specified MaxRecords value, a marker is included in the response so that the + * remaining results can be retrieved.
*/ MaxRecords?: number; /** * @public - *An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >
+ *An optional marker returned from a prior request. Use this marker for pagination of + * results from this operation. If this parameter is specified, the response includes only + * records beyond the marker, up to the value specified by MaxRecords. >
*/ Marker?: string; } @@ -8789,7 +9027,9 @@ export interface DescribeUsersResult { /** * @public - *An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >
+ *An optional marker returned from a prior request. Use this marker for pagination of + * results from this operation. If this parameter is specified, the response includes only + * records beyond the marker, up to the value specified by MaxRecords. >
*/ Marker?: string; } @@ -8812,7 +9052,8 @@ export interface DisassociateGlobalReplicationGroupMessage { /** * @public - *The Amazon region of secondary cluster you wish to remove from the Global datastore
+ *The Amazon region of secondary cluster you wish to remove from the Global + * datastore
*/ ReplicationGroupRegion: string | undefined; } @@ -8823,12 +9064,14 @@ export interface DisassociateGlobalReplicationGroupMessage { export interface DisassociateGlobalReplicationGroupResult { /** * @public - *Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary - * cluster automatically replicates updates to the secondary cluster.
+ *Consists of a primary cluster that accepts writes and an associated secondary cluster + * that resides in a different Amazon region. The secondary cluster accepts only reads. The + * primary cluster automatically replicates updates to the secondary cluster.
*The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, - * which is what you use to associate a secondary cluster.
+ *The GlobalReplicationGroupIdSuffix represents + * the name of the Global datastore, which is what you use to associate a secondary + * cluster.
*Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary - * cluster automatically replicates updates to the secondary cluster.
+ *Consists of a primary cluster that accepts writes and an associated secondary cluster + * that resides in a different Amazon region. The secondary cluster accepts only reads. The + * primary cluster automatically replicates updates to the secondary cluster.
*The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, - * which is what you use to associate a secondary cluster.
+ *The GlobalReplicationGroupIdSuffix represents + * the name of the Global datastore, which is what you use to associate a secondary + * cluster.
*A list of PreferredAvailabilityZones
objects that specifies
- * the configuration of a node group in the resharded cluster.
A list of PreferredAvailabilityZones
objects that specifies the
+ * configuration of a node group in the resharded cluster.
Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these - * configuration values apply to.
+ *Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the + * node group these configuration values apply to.
*/ NodeGroupId?: string; @@ -8915,7 +9160,8 @@ export interface RegionalConfiguration { /** * @public - *A list of PreferredAvailabilityZones
objects that specifies the configuration of a node group in the resharded cluster.
A list of PreferredAvailabilityZones
objects that specifies the
+ * configuration of a node group in the resharded cluster.
The number of node groups you wish to add
+ *Total number of node groups you want
*/ NodeGroupCount: number | undefined; /** * @public - *Describes the replication group IDs, the Amazon regions where they are stored and the shard configuration for each that comprise the Global datastore
+ *Describes the replication group IDs, the Amazon regions where they are stored and the + * shard configuration for each that comprise the Global datastore
*/ RegionalConfigurations?: RegionalConfiguration[]; /** * @public - *Indicates that the process begins immediately. At present, the only permitted value for this parameter is true.
+ *Indicates that the process begins immediately. At present, the only permitted value + * for this parameter is true.
*/ ApplyImmediately: boolean | undefined; } @@ -8955,12 +9203,14 @@ export interface IncreaseNodeGroupsInGlobalReplicationGroupMessage { export interface IncreaseNodeGroupsInGlobalReplicationGroupResult { /** * @public - *Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary - * cluster automatically replicates updates to the secondary cluster.
+ *Consists of a primary cluster that accepts writes and an associated secondary cluster + * that resides in a different Amazon region. The secondary cluster accepts only reads. The + * primary cluster automatically replicates updates to the secondary cluster.
*The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, - * which is what you use to associate a secondary cluster.
+ *The GlobalReplicationGroupIdSuffix represents + * the name of the Global datastore, which is what you use to associate a secondary + * cluster.
*The number of read replica nodes you want at the completion of this operation. - * For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the - * replication group. For Redis (cluster mode enabled) replication groups, this is the number of - * replica nodes in each of the replication group's node groups.
+ *The number of read replica nodes you want at the completion of this operation. For + * Redis (cluster mode disabled) replication groups, this is the number of replica nodes in + * the replication group. For Redis (cluster mode enabled) replication groups, this is the + * number of replica nodes in each of the replication group's node groups.
*/ NewReplicaCount?: number; /** * @public - *A list of ConfigureShard
objects that can be used to configure each shard
- * in a Redis (cluster mode enabled) replication group. The ConfigureShard
has three members:
- * NewReplicaCount
, NodeGroupId
, and PreferredAvailabilityZones
.
A list of ConfigureShard
objects that can be used to configure each
+ * shard in a Redis (cluster mode enabled) replication group. The
+ * ConfigureShard
has three members: NewReplicaCount
,
+ * NodeGroupId
, and PreferredAvailabilityZones
.
If True
, the number of replica nodes is increased immediately.
- *
- * ApplyImmediately=False
is not currently supported.
ApplyImmediately=False
is not currently supported.
*/
ApplyImmediately: boolean | undefined;
}
@@ -9036,28 +9286,31 @@ export class InvalidKMSKeyFault extends __BaseException {
/**
* @public
- * The input parameters for the ListAllowedNodeTypeModifications
operation.
The input parameters for the ListAllowedNodeTypeModifications
+ * operation.
The name of the cluster you want to scale up to a larger node instanced type. - * ElastiCache uses the cluster id to identify the current node type of this cluster and from that to create a list of node types you can scale up to.
+ * ElastiCache uses the cluster id to identify the current node type of this cluster and + * from that to create a list of node types you can scale up to. *You must provide a value for either the CacheClusterId
or the
- * ReplicationGroupId
.
ReplicationGroupId
.
* The name of the replication group want to scale up to a larger node type. - * ElastiCache uses the replication group id to identify the current node type being used by - * this replication group, and from that to create a list of node types you can scale up to.
+ *The name of the replication group want to scale up to a larger node type. ElastiCache + * uses the replication group id to identify the current node type being used by this + * replication group, and from that to create a list of node types you can scale up + * to.
*You must provide a value for either the CacheClusterId
or the
- * ReplicationGroupId
.
ReplicationGroupId
.
* The Amazon Resource Name (ARN) of the resource for which you want the list of tags,
- * for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
- * or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot
.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
+ * for examplearn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
or
+ * arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot
.
+ * For more information about ARNs, see Amazon Resource Names (ARNs) + * and Amazon Web + * Services Service Namespaces.
*/ ResourceName: string | undefined; } @@ -9107,31 +9362,34 @@ export interface ModifyCacheClusterMessage { /** * @public - *The number of cache nodes that the cluster should have.
- * If the value for NumCacheNodes
is greater than the sum of the number of current cache nodes and
- * the number of cache nodes pending creation (which may be zero), more nodes are added.
- * If the value is less than the number of existing cache nodes, nodes are removed.
- * If the value is equal to the number of current cache nodes,
- * any pending add or remove requests are canceled.
If you are removing cache nodes, you must
- * use the CacheNodeIdsToRemove
parameter to provide the IDs of the specific cache nodes to remove.
For clusters running Redis, this value must be 1. - * For clusters running Memcached, this value must be between 1 and 40.
+ *The number of cache nodes that the cluster should have. If the value for
+ * NumCacheNodes
is greater than the sum of the number of current cache
+ * nodes and the number of cache nodes pending creation (which may be zero), more nodes are
+ * added. If the value is less than the number of existing cache nodes, nodes are removed.
+ * If the value is equal to the number of current cache nodes, any pending add or remove
+ * requests are canceled.
If you are removing cache nodes, you must use the CacheNodeIdsToRemove
+ * parameter to provide the IDs of the specific cache nodes to remove.
For clusters running Redis, this value must be 1. For clusters running Memcached, this + * value must be between 1 and 40.
*Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately
).
A pending operation to modify the number of cache nodes in a cluster during its maintenance window,
- * whether by adding or removing nodes in accordance with the scale out architecture, is not queued.
- * The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the
- * number of cache nodes in the cluster.
- * For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes.
- * Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa.
- * As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement,
- * a request to add nodes does not automatically override a previous pending operation to add nodes.
- * The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and
- * retry the new request.
- * To cancel pending operations to modify the number of cache nodes in a cluster,
- * use the ModifyCacheCluster
request and
- * set NumCacheNodes
equal to the number of cache nodes currently in the cluster.
Adding or removing Memcached cache nodes can be applied immediately or as a
+ * pending operation (see ApplyImmediately
).
A pending operation to modify the number of cache nodes in a cluster during its
+ * maintenance window, whether by adding or removing nodes in accordance with the scale
+ * out architecture, is not queued. The customer's latest request to add or remove
+ * nodes to the cluster overrides any previous pending operations to modify the number
+ * of cache nodes in the cluster. For example, a request to remove 2 nodes would
+ * override a previous pending operation to remove 3 nodes. Similarly, a request to add
+ * 2 nodes would override a previous pending operation to remove 3 nodes and vice
+ * versa. As Memcached cache nodes may now be provisioned in different Availability
+ * Zones with flexible cache node placement, a request to add nodes does not
+ * automatically override a previous pending operation to add nodes. The customer can
+ * modify the previous pending operation to add more nodes or explicitly cancel the
+ * pending request and retry the new request. To cancel pending operations to modify
+ * the number of cache nodes in a cluster, use the ModifyCacheCluster
+ * request and set NumCacheNodes
equal to the number of cache nodes
+ * currently in the cluster.
A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002,
- * etc.). This parameter is only valid when NumCacheNodes
is less than the existing number
- * of cache nodes. The number of cache node IDs supplied in this parameter must match the
- * difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is
- * greater, and the value of NumCacheNodes
in the request.
For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this
- * ModifyCacheCluster
call is 5, you must list 2 (7 - 5) cache node IDs to remove.
NumCacheNodes
is less than the
+ * existing number of cache nodes. The number of cache node IDs supplied in this parameter
+ * must match the difference between the existing number of cache nodes in the cluster or
+ * pending cache nodes, whichever is greater, and the value of NumCacheNodes
+ * in the request.
+ * For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number
+ * of cache nodes in this ModifyCacheCluster
call is 5, you must list 2 (7 -
+ * 5) cache node IDs to remove.
Specifies whether the new nodes in this Memcached cluster are all created in a - * single Availability Zone or created across multiple Availability Zones.
+ *Specifies whether the new nodes in this Memcached cluster are all created in a single + * Availability Zone or created across multiple Availability Zones.
*Valid values: single-az
| cross-az
.
This option is only supported for Memcached clusters.
*You cannot specify single-az
if the Memcached cluster already has cache nodes in different Availability Zones.
- * If cross-az
is specified, existing Memcached nodes remain in their current Availability Zone.
Only newly created nodes are located in different Availability Zones. - *
+ *You cannot specify single-az
if the Memcached cluster already has
+ * cache nodes in different Availability Zones. If cross-az
is specified,
+ * existing Memcached nodes remain in their current Availability Zone.
Only newly created nodes are located in different Availability Zones.
*The list of Availability Zones where the new Memcached cache nodes are created.
*This parameter is only valid when NumCacheNodes
in the request is greater
- * than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero).
- * The number of Availability Zones supplied in this list must match the cache nodes being added in this request.
Scenarios:
*
- * Scenario 1: You have 3 active nodes and wish to add 2 nodes.
- * Specify NumCacheNodes=5
(3 + 2) and optionally specify two Availability Zones
- * for the two new nodes.
NumCacheNodes=5
(3 + 2) and optionally
+ * specify two Availability Zones for the two new nodes.
*
- * Scenario 2: You have 3 active nodes and 2 nodes pending creation
- * (from the scenario 1 call) and want to add 1 more node.
- * Specify NumCacheNodes=6
((3 + 2) + 1) and
- * optionally specify an Availability Zone for the new node.
NumCacheNodes=6
((3 + 2) + 1) and optionally specify an
+ * Availability Zone for the new node.
*
- * Scenario 3: You want to cancel all pending operations.
- * Specify NumCacheNodes=3
to cancel all pending operations.
NumCacheNodes=3
to cancel all pending
+ * operations.
* The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation,
- * add 0 nodes by setting NumCacheNodes
to the number of current nodes.
If cross-az
is specified, existing Memcached nodes remain in their current Availability Zone.
- * Only newly created nodes can be located in different Availability Zones.
- * For guidance on how to move existing Memcached nodes to different Availability Zones, see the
- * Availability Zone Considerations section of Cache Node Considerations for Memcached.
The Availability Zone placement of nodes pending creation cannot be modified. If you
+ * wish to cancel any nodes pending creation, add 0 nodes by setting
+ * NumCacheNodes
to the number of current nodes.
If cross-az
is specified, existing Memcached nodes remain in their
+ * current Availability Zone. Only newly created nodes can be located in different
+ * Availability Zones. For guidance on how to move existing Memcached nodes to different
+ * Availability Zones, see the Availability Zone
+ * Considerations section of Cache Node
+ * Considerations for Memcached.
* Impact of new add/remove requests upon pending requests *
@@ -9213,7 +9478,8 @@ export interface ModifyCacheClusterMessage { *New Request: Delete
*Result: The new delete, pending or immediate, replaces the pending delete.
+ *Result: The new delete, pending or immediate, replaces the pending + * delete.
*New Request: Create
* *Result: The new create, pending or immediate, replaces the pending delete.
+ *Result: The new create, pending or immediate, replaces the pending + * delete.
*New Request: Delete
* *Result: The new delete, pending or immediate, replaces the pending create.
+ *Result: The new delete, pending or immediate, replaces the pending + * create.
*Result: The new create is added to the pending create.
*- * Important: - * If the new create request is Apply Immediately - Yes, - * all creates are performed immediately. - * If the new create request is Apply Immediately - No, - * all creates are pending.
+ * Important: If the new create + * request is Apply Immediately - Yes, + * all creates are performed immediately. If the new create request is + * Apply Immediately - No, all + * creates are pending. *A list of cache security group names to authorize on this cluster. - * This change is asynchronously applied as soon as possible.
- *You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).
- *Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
+ *A list of cache security group names to authorize on this cluster. This change is + * asynchronously applied as soon as possible.
+ *You can use this parameter only with clusters that are created outside of an Amazon + * Virtual Private Cloud (Amazon VPC).
+ *Constraints: Must contain no more than 255 alphanumeric characters. Must not be + * "Default".
*/ CacheSecurityGroupNames?: string[]; /** * @public *Specifies the VPC Security Groups associated with the cluster.
- *This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).
+ *This parameter can be used only with clusters that are created in an Amazon Virtual + * Private Cloud (Amazon VPC).
*/ SecurityGroupIds?: string[]; /** * @public - *Specifies the weekly time range during which maintenance - * on the cluster is performed. It is specified as a range in - * the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum - * maintenance window is a 60 minute period.
+ *Specifies the weekly time range during which maintenance on the cluster is performed. + * It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The + * minimum maintenance window is a 60 minute period.
*Valid values for ddd
are:
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
+ *The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are + * sent.
*The Amazon SNS topic owner must be same as the cluster owner.
*The name of the cache parameter group to apply to this cluster. This change is
* asynchronously applied as soon as possible for parameters when the
- * ApplyImmediately
parameter is specified as true
for this request.
ApplyImmediately
parameter is specified as true
for this
+ * request.
*/
CacheParameterGroupName?: string;
@@ -9367,11 +9639,11 @@ export interface ModifyCacheClusterMessage {
* If true
, this parameter causes the modifications in this request and any
* pending modifications to be applied, asynchronously and as soon as possible, regardless
* of the PreferredMaintenanceWindow
setting for the cluster.
If false
, changes to the cluster are applied on the next
- * maintenance reboot, or the next failure reboot, whichever occurs first.
If false
, changes to the cluster are applied on the next maintenance
+ * reboot, or the next failure reboot, whichever occurs first.
If you perform a ModifyCacheCluster
before a pending modification is applied,
- * the pending modification is replaced by the newer modification.
If you perform a ModifyCacheCluster
before a pending modification is
+ * applied, the pending modification is replaced by the newer modification.
Valid values: true
| false
*
The upgraded version of the cache engine to be run on the cache nodes.
** Important: You can upgrade to a newer engine version - * (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. - * If you want to use an earlier engine version, - * you must delete the existing cluster and create it anew with the earlier engine version.
+ * (see Selecting + * a Cache Engine and Version), but you cannot downgrade to an earlier engine + * version. If you want to use an earlier engine version, you must delete the existing + * cluster and create it anew with the earlier engine version. */ EngineVersion?: string; /** * @public - *If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. - *
+ *If you are running Redis engine version 6.0 or later, set this parameter to yes if + * you want to opt-in to the next auto minor version upgrade campaign. This parameter is + * disabled for previous versions.
*/ AutoMinorVersionUpgrade?: boolean; /** * @public *The number of days for which ElastiCache retains automatic cluster snapshots before
- * deleting them. For example, if you set SnapshotRetentionLimit
to 5, a
+ * deleting them. For example, if you set SnapshotRetentionLimit
to 5, a
* snapshot that was taken today is retained for 5 days before being deleted.
If the value of SnapshotRetentionLimit
is set to zero (0), backups are turned off.
If the value of SnapshotRetentionLimit
is set to zero (0), backups
+ * are turned off.
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of - * your cluster.
+ *The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot + * of your cluster.
*/ SnapshotWindow?: string; @@ -9424,29 +9699,29 @@ export interface ModifyCacheClusterMessage { /** * @public - *Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update
parameter.
- * Password constraints:
Reserved parameter. The password used to access a password protected server. This
+ * parameter must be specified with the auth-token-update
parameter. Password
+ * constraints:
Must be only printable ASCII characters
*Must be at least 16 characters and no more than 128 characters in length
+ *Must be at least 16 characters and no more than 128 characters in + * length
*Cannot contain any of the following characters: '/', '"', or '@', '%'
*- * - * For more information, see AUTH password at AUTH.
+ *For more information, see AUTH password at AUTH.
*/ AuthToken?: string; /** * @public - *Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token
parameter.
- * Possible values:
Specifies the strategy to use to update the AUTH token. This parameter must be
+ * specified with the auth-token
parameter. Possible values:
Rotate
@@ -9455,8 +9730,7 @@ export interface ModifyCacheClusterMessage { *Set
*- * For more information, see Authenticating Users with Redis AUTH + *
For more information, see Authenticating Users with Redis AUTH *
*/ AuthTokenUpdateStrategy?: AuthTokenUpdateStrategyType | string; @@ -9469,8 +9743,9 @@ export interface ModifyCacheClusterMessage { /** * @public - *The network type you choose when modifying a cluster, either ipv4
| ipv6
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the
- * Nitro system.
The network type you choose when modifying a cluster, either ipv4
|
+ * ipv6
. IPv6 is supported for workloads using Redis engine version 6.2
+ * onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.
+ *An array of parameter names and values for the parameter update. You must supply at + * least one parameter name and value; subsequent arguments are optional. A maximum of 20 + * parameters may be modified per request.
*/ ParameterNameValues: ParameterNameValue[] | undefined; } @@ -9553,7 +9830,8 @@ export interface ModifyCacheParameterGroupMessage { export interface ModifyCacheSubnetGroupMessage { /** * @public - *The name for the cache subnet group. This value is stored as a lowercase string.
+ *The name for the cache subnet group. This value is stored as a lowercase + * string.
*Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
*Example: mysubnetgroup
*
This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global + *
This parameter causes the modifications in this request and any pending modifications + * to be applied, asynchronously and as soon as possible. Modifications to Global * Replication Groups cannot be requested to be applied in PreferredMaintenceWindow. - *
+ * */ ApplyImmediately: boolean | undefined; @@ -9642,13 +9921,15 @@ export interface ModifyGlobalReplicationGroupMessage { /** * @public - *The upgraded version of the cache engine to be run on the clusters in the Global datastore.
+ *The upgraded version of the cache engine to be run on the clusters in the Global + * datastore.
*/ EngineVersion?: string; /** * @public - *The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.
+ *The name of the cache parameter group to use with the Global datastore. It must be + * compatible with the major engine version used by the Global datastore.
*/ CacheParameterGroupName?: string; @@ -9660,7 +9941,8 @@ export interface ModifyGlobalReplicationGroupMessage { /** * @public - *Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
+ *Determines whether a read replica is automatically promoted to read/write primary if + * the existing primary encounters a failure.
*/ AutomaticFailoverEnabled?: boolean; } @@ -9671,12 +9953,14 @@ export interface ModifyGlobalReplicationGroupMessage { export interface ModifyGlobalReplicationGroupResult { /** * @public - *Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary - * cluster automatically replicates updates to the secondary cluster.
+ *Consists of a primary cluster that accepts writes and an associated secondary cluster + * that resides in a different Amazon region. The secondary cluster accepts only reads. The + * primary cluster automatically replicates updates to the secondary cluster.
*The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, - * which is what you use to associate a secondary cluster.
+ *The GlobalReplicationGroupIdSuffix represents + * the name of the Global datastore, which is what you use to associate a secondary + * cluster.
*For replication groups with a single primary, - * if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. - * The nodes of all other clusters in the replication group are read replicas.
+ *For replication groups with a single primary, if this parameter is specified, + * ElastiCache promotes the specified cluster in the specified replication group to the + * primary role. The nodes of all other clusters in the replication group are read + * replicas.
*/ PrimaryClusterId?: string; @@ -9717,7 +10002,8 @@ export interface ModifyReplicationGroupMessage { /** * @public - *Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
+ *Determines whether a read replica is automatically promoted to read/write primary if + * the existing primary encounters a failure.
*Valid values: true
| false
*
A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.
- *This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).
- *Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default
.
A list of cache security group names to authorize for the clusters in this replication + * group. This change is asynchronously applied as soon as possible.
+ *This parameter can be used only with replication group containing clusters running + * outside of an Amazon Virtual Private Cloud (Amazon VPC).
+ *Constraints: Must contain no more than 255 alphanumeric characters. Must not be
+ * Default
.
Specifies the VPC Security Groups associated with the clusters in the replication group.
+ *Specifies the VPC Security Groups associated with the clusters in the replication + * group.
*This parameter can be used only with replication group containing clusters running in * an Amazon Virtual Private Cloud (Amazon VPC).
*/ @@ -9755,10 +10045,9 @@ export interface ModifyReplicationGroupMessage { /** * @public - *Specifies the weekly time range during which maintenance - * on the cluster is performed. It is specified as a range in - * the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum - * maintenance window is a 60 minute period.
+ *Specifies the weekly time range during which maintenance on the cluster is performed. + * It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The + * minimum maintenance window is a 60 minute period.
*Valid values for ddd
are:
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
+ *The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are + * sent.
*The Amazon SNS topic owner must be same as the replication group owner.
*The name of the cache parameter group to apply to all of the clusters in this replication group.
- * This change is asynchronously applied as soon as possible for parameters when the
- * ApplyImmediately
parameter is specified as true
for this request.
The name of the cache parameter group to apply to all of the clusters in this
+ * replication group. This change is asynchronously applied as soon as possible for
+ * parameters when the ApplyImmediately
parameter is specified as
+ * true
for this request.
The upgraded version of the cache engine to be run on the clusters in the replication group.
+ *The upgraded version of the cache engine to be run on the clusters in the replication + * group.
*- * Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. - * If you want to use an earlier engine version, - * you must delete the existing replication group and create it anew with the earlier engine version.
+ * Important: You can upgrade to a newer engine version + * (see Selecting + * a Cache Engine and Version), but you cannot downgrade to an earlier engine + * version. If you want to use an earlier engine version, you must delete the existing + * replication group and create it anew with the earlier engine version. */ EngineVersion?: string; /** * @public - *If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. - *
+ *If you are running Redis engine version 6.0 or later, set this parameter to yes if + * you want to opt-in to the next auto minor version upgrade campaign. This parameter is + * disabled for previous versions.
*/ AutoMinorVersionUpgrade?: boolean; /** * @public - *The number of days for which ElastiCache retains automatic node group (shard) snapshots before
- * deleting them. For example, if you set SnapshotRetentionLimit
to 5, a
- * snapshot that was taken today is retained for 5 days before being deleted.
The number of days for which ElastiCache retains automatic node group (shard)
+ * snapshots before deleting them. For example, if you set
+ * SnapshotRetentionLimit
to 5, a snapshot that was taken today is
+ * retained for 5 days before being deleted.
- * Important If the value of SnapshotRetentionLimit is set to zero (0), - * backups are turned off.
+ * Important If the value of SnapshotRetentionLimit is + * set to zero (0), backups are turned off. */ SnapshotRetentionLimit?: number; /** * @public - *The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of
- * the node group (shard) specified by SnapshottingClusterId
.
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot
+ * of the node group (shard) specified by SnapshottingClusterId
.
Example: 05:00-09:00
*
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
+ *If you do not specify this parameter, ElastiCache automatically chooses an appropriate + * time range.
*/ SnapshotWindow?: string; @@ -9888,30 +10185,29 @@ export interface ModifyReplicationGroupMessage { /** * @public - *Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update-strategy
- * parameter.
+ *
Reserved parameter. The password used to access a password protected server. This
+ * parameter must be specified with the auth-token-update-strategy
parameter.
* Password constraints:
Must be only printable ASCII characters
*Must be at least 16 characters and no more than 128 characters in length
+ *Must be at least 16 characters and no more than 128 characters in + * length
*Cannot contain any of the following characters: '/', '"', or '@', '%'
*- * - * For more information, see AUTH password at AUTH.
+ *For more information, see AUTH password at AUTH.
*/ AuthToken?: string; /** * @public - *Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token
parameter.
- * Possible values:
Specifies the strategy to use to update the AUTH token. This parameter must be
+ * specified with the auth-token
parameter. Possible values:
Rotate
@@ -9920,8 +10216,7 @@ export interface ModifyReplicationGroupMessage { *Set
*- * For more information, see Authenticating Users with Redis AUTH + *
For more information, see Authenticating Users with Redis AUTH *
*/ AuthTokenUpdateStrategy?: AuthTokenUpdateStrategyType | string; @@ -9934,7 +10229,8 @@ export interface ModifyReplicationGroupMessage { /** * @public - *The ID of the user group to disassociate from the replication group, meaning the users in the group no longer can access the replication group.
+ *The ID of the user group to disassociate from the replication group, meaning the users + * in the group no longer can access the replication group.
*/ UserGroupIdsToRemove?: string[]; @@ -9952,32 +10248,43 @@ export interface ModifyReplicationGroupMessage { /** * @public - *The network type you choose when modifying a cluster, either ipv4
| ipv6
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the
- * Nitro system.
The network type you choose when modifying a cluster, either ipv4
|
+ * ipv6
. IPv6 is supported for workloads using Redis engine version 6.2
+ * onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
A flag that enables in-transit encryption when set to true. If you are enabling in-transit encryption for an existing cluster, you must also set TransitEncryptionMode
to preferred
.
A flag that enables in-transit encryption when set to true. If you are enabling
+ * in-transit encryption for an existing cluster, you must also set
+ * TransitEncryptionMode
to preferred
.
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
- *You must set TransitEncryptionEnabled
to true
, for your existing cluster, and set TransitEncryptionMode
to preferred
in the same request to allow both encrypted and
- * unencrypted connections at the same time. Once you migrate all your Redis clients to use encrypted connections you can set the value to required
to allow encrypted connections only.
Setting TransitEncryptionMode
to required
is a two-step process that requires you to first set the TransitEncryptionMode
to preferred
, after that you can set TransitEncryptionMode
to required
.
- *
A setting that allows you to migrate your clients to use in-transit encryption, with + * no downtime.
+ *You must set TransitEncryptionEnabled
to true
, for your
+ * existing cluster, and set TransitEncryptionMode
to preferred
+ * in the same request to allow both encrypted and unencrypted connections at the same
+ * time. Once you migrate all your Redis clients to use encrypted connections you can set
+ * the value to required
to allow encrypted connections only.
Setting TransitEncryptionMode
to required
is a two-step
+ * process that requires you to first set the TransitEncryptionMode
to
+ * preferred
, after that you can set TransitEncryptionMode
to
+ * required
.
Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. - * - * Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
+ *Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first + * set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect + * using both cluster mode enabled and cluster mode disabled. After you migrate all Redis + * clients to use cluster mode enabled, you can then complete cluster mode configuration + * and set the cluster mode to Enabled.
*/ ClusterMode?: ClusterMode | string; } @@ -9995,64 +10302,63 @@ export interface ModifyReplicationGroupResult { /** * @public - *Represents the input for a ModifyReplicationGroupShardConfiguration
operation.
Represents the input for a ModifyReplicationGroupShardConfiguration
+ * operation.
The name of the Redis (cluster mode enabled) cluster (replication group) - * on which the shards are to be configured.
+ *The name of the Redis (cluster mode enabled) cluster (replication group) on which the + * shards are to be configured.
*/ ReplicationGroupId: string | undefined; /** * @public - *The number of node groups (shards) that results from the modification of the - * shard configuration.
+ *The number of node groups (shards) that results from the modification of the shard + * configuration.
*/ NodeGroupCount: number | undefined; /** * @public - *Indicates that the shard reconfiguration process begins immediately.
- * At present, the only permitted value for this parameter is true
.
Indicates that the shard reconfiguration process begins immediately. At present, the
+ * only permitted value for this parameter is true
.
Value: true
*/ ApplyImmediately: boolean | undefined; /** * @public - *Specifies the preferred availability zones for each node group in the cluster.
- * If the value of NodeGroupCount
is greater than the current number
- * of node groups (shards), you can use this parameter to specify the preferred
- * availability zones of the cluster's shards.
- * If you omit this parameter ElastiCache selects availability zones for you.
You can specify this parameter only if the value of NodeGroupCount
- * is greater than the current number of node groups (shards).
Specifies the preferred availability zones for each node group in the cluster. If the
+ * value of NodeGroupCount
is greater than the current number of node groups
+ * (shards), you can use this parameter to specify the preferred availability zones of the
+ * cluster's shards. If you omit this parameter ElastiCache selects availability zones for
+ * you.
You can specify this parameter only if the value of NodeGroupCount
is
+ * greater than the current number of node groups (shards).
If the value of NodeGroupCount
is less than the
- * current number of node groups (shards), then either NodeGroupsToRemove
or
- * NodeGroupsToRetain
is required.
- * NodeGroupsToRemove
is a list of NodeGroupId
s to remove
- * from the cluster.
ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove
- * from the cluster.
If the value of NodeGroupCount
is less than the current number of node
+ * groups (shards), then either NodeGroupsToRemove
or
+ * NodeGroupsToRetain
is required. NodeGroupsToRemove
is a
+ * list of NodeGroupId
s to remove from the cluster.
ElastiCache for Redis will attempt to remove all node groups listed by
+ * NodeGroupsToRemove
from the cluster.
If the value of NodeGroupCount
is less than the
- * current number of node groups (shards), then either NodeGroupsToRemove
or
- * NodeGroupsToRetain
is required.
- * NodeGroupsToRetain
is a list of NodeGroupId
s to retain
- * in the cluster.
ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain
- * from the cluster.
If the value of NodeGroupCount
is less than the current number of node
+ * groups (shards), then either NodeGroupsToRemove
or
+ * NodeGroupsToRetain
is required. NodeGroupsToRetain
is a
+ * list of NodeGroupId
s to retain in the cluster.
ElastiCache for Redis will attempt to remove all node groups except those listed by
+ * NodeGroupsToRetain
from the cluster.
Represents the input of a PurchaseReservedCacheNodesOffering
operation.
Represents the input of a PurchaseReservedCacheNodesOffering
+ * operation.
A customer-specified identifier to track this reservation.
*The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. - * If this parameter is not specified, - * ElastiCache automatically generates an identifier for the reservation.
+ *The Reserved Cache Node ID is an unique customer-specified identifier to track + * this reservation. If this parameter is not specified, ElastiCache automatically + * generates an identifier for the reservation.
*Example: myreservationID
*/ @@ -10167,7 +10474,8 @@ export interface PurchaseReservedCacheNodesOfferingMessage { /** * @public - *A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
+ *A list of tags to be added to this resource. A tag is a key-value pair. A tag key must + * be accompanied by a tag value, although null is accepted.
*/ Tags?: Tag[]; } @@ -10178,7 +10486,8 @@ export interface PurchaseReservedCacheNodesOfferingMessage { export interface PurchaseReservedCacheNodesOfferingResult { /** * @public - *Represents the output of a PurchaseReservedCacheNodesOffering
operation.
Represents the output of a PurchaseReservedCacheNodesOffering
+ * operation.
The request cannot be processed because it would exceed the user's cache node quota.
+ *The request cannot be processed because it would exceed the user's cache node + * quota.
*/ export class ReservedCacheNodeQuotaExceededFault extends __BaseException { readonly name: "ReservedCacheNodeQuotaExceededFault" = "ReservedCacheNodeQuotaExceededFault"; @@ -10246,12 +10556,14 @@ export interface RebalanceSlotsInGlobalReplicationGroupMessage { export interface RebalanceSlotsInGlobalReplicationGroupResult { /** * @public - *Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary - * cluster automatically replicates updates to the secondary cluster.
+ *Consists of a primary cluster that accepts writes and an associated secondary cluster + * that resides in a different Amazon region. The secondary cluster accepts only reads. The + * primary cluster automatically replicates updates to the secondary cluster.
*The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, - * which is what you use to associate a secondary cluster.
+ *The GlobalReplicationGroupIdSuffix represents + * the name of the Global datastore, which is what you use to associate a secondary + * cluster.
*A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.
+ *A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, + * etc.). To reboot an entire cluster, specify all of the cache node IDs.
*/ CacheNodeIdsToReboot: string[] | undefined; } @@ -10295,15 +10608,17 @@ export interface RemoveTagsFromResourceMessage { /** * @public *The Amazon Resource Name (ARN) of the resource from which you want the tags removed,
- * for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
- * or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot
.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.
+ * for examplearn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
or
+ * arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot
.
+ * For more information about ARNs, see Amazon Resource Names (ARNs) + * and Amazon Service Namespaces.
*/ ResourceName: string | undefined; /** * @public - *A list of TagKeys
identifying the tags you want removed from the named resource.
A list of TagKeys
identifying the tags you want removed from the named
+ * resource.
If true
,
- * all parameters in the cache parameter group are reset to their default values.
- * If false
, only the parameters listed by ParameterNameValues
- * are reset to their default values.
If true
, all parameters in the cache parameter group are reset to their
+ * default values. If false
, only the parameters listed by
+ * ParameterNameValues
are reset to their default values.
Valid values: true
| false
*
An array of parameter names to reset to their default values.
- * If ResetAllParameters
is true
,
- * do not use ParameterNameValues
.
- * If ResetAllParameters
is false
,
- * you must specify the name of at least one parameter to reset.
An array of parameter names to reset to their default values. If
+ * ResetAllParameters
is true
, do not use
+ * ParameterNameValues
. If ResetAllParameters
is
+ * false
, you must specify the name of at least one parameter to
+ * reset.
The specified Amazon EC2 security group is not authorized for the specified cache security group.
+ *The specified Amazon EC2 security group is not authorized for the specified cache + * security group.
*/ export class AuthorizationNotFoundFault extends __BaseException { readonly name: "AuthorizationNotFoundFault" = "AuthorizationNotFoundFault"; @@ -10383,7 +10698,8 @@ export class AuthorizationNotFoundFault extends __BaseException { /** * @public - *Represents the input of a RevokeCacheSecurityGroupIngress
operation.
Represents the input of a RevokeCacheSecurityGroupIngress
+ * operation.
The Amazon account number of the Amazon EC2 security group owner. - * Note that this is not the same thing as an Amazon access key ID - you must provide - * a valid Amazon account number for this parameter.
+ *The Amazon account number of the Amazon EC2 security group owner. Note that this is + * not the same thing as an Amazon access key ID - you must provide a valid Amazon account + * number for this parameter.
*/ EC2SecurityGroupOwnerId: string | undefined; } @@ -10485,7 +10801,8 @@ export interface StartMigrationMessage { /** * @public - *List of endpoints from which data should be migrated. For Redis (cluster mode disabled), list should have only one element.
+ *List of endpoints from which data should be migrated. For Redis (cluster mode + * disabled), list should have only one element.
*/ CustomerNodeEndpointList: CustomerNodeEndpoint[] | undefined; } @@ -10524,7 +10841,8 @@ export class APICallRateForCustomerExceededFault extends __BaseException { /** * @public *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.
NodeGroupId
value correctly.
*/
export class NodeGroupNotFoundFault extends __BaseException {
readonly name: "NodeGroupNotFoundFault" = "NodeGroupNotFoundFault";
@@ -10556,8 +10874,8 @@ export interface TestFailoverMessage {
/**
* @public
* The name of the node group (called shard in the console) in this replication group on - * which automatic failover is to be tested. - * You may test automatic failover on up to 5 node groups in any rolling 24-hour period.
+ * which automatic failover is to be tested. You may test automatic failover on up to 5 + * node groups in any rolling 24-hour period. */ NodeGroupId: string | undefined; } @@ -10592,3 +10910,32 @@ export interface TestFailoverResult { */ ReplicationGroup?: ReplicationGroup; } + +/** + * @public + */ +export interface TestMigrationMessage { + /** + * @public + *The ID of the replication group to which data is to be migrated.
+ */ + ReplicationGroupId: string | undefined; + + /** + * @public + *List of endpoints from which data should be migrated. List should have only one + * element.
+ */ + CustomerNodeEndpointList: CustomerNodeEndpoint[] | undefined; +} + +/** + * @public + */ +export interface TestMigrationResponse { + /** + * @public + *Contains all of the attributes of a specific Redis replication group.
+ */ + ReplicationGroup?: ReplicationGroup; +} diff --git a/clients/client-elasticache/src/protocols/Aws_query.ts b/clients/client-elasticache/src/protocols/Aws_query.ts index 53cb67e75d594..23831399e59be 100644 --- a/clients/client-elasticache/src/protocols/Aws_query.ts +++ b/clients/client-elasticache/src/protocols/Aws_query.ts @@ -219,6 +219,7 @@ import { } from "../commands/RevokeCacheSecurityGroupIngressCommand"; import { StartMigrationCommandInput, StartMigrationCommandOutput } from "../commands/StartMigrationCommand"; import { TestFailoverCommandInput, TestFailoverCommandOutput } from "../commands/TestFailoverCommand"; +import { TestMigrationCommandInput, TestMigrationCommandOutput } from "../commands/TestMigrationCommand"; import { ElastiCacheServiceException as __BaseException } from "../models/ElastiCacheServiceException"; import { AddTagsToResourceMessage, @@ -456,6 +457,8 @@ import { TestFailoverMessage, TestFailoverNotAvailableFault, TestFailoverResult, + TestMigrationMessage, + TestMigrationResponse, TimeRangeFilter, UnprocessedUpdateAction, UpdateAction, @@ -1579,6 +1582,23 @@ export const se_TestFailoverCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +/** + * serializeAws_queryTestMigrationCommand + */ +export const se_TestMigrationCommand = async ( + input: TestMigrationCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = SHARED_HEADERS; + let body: any; + body = buildFormUrlencodedString({ + ...se_TestMigrationMessage(input, context), + Action: "TestMigration", + Version: "2015-02-02", + }); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + /** * deserializeAws_queryAddTagsToResourceCommand */ @@ -5448,6 +5468,61 @@ const de_TestFailoverCommandError = async ( } }; +/** + * deserializeAws_queryTestMigrationCommand + */ +export const de_TestMigrationCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): PromiseA tag is a key-value pair where the key and value are case-sensitive. \n 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. \n For more information, see Resource-level permissions.
\n\n For example, you can use cost-allocation tags to your ElastiCache resources, \n Amazon generates a cost allocation report as a comma-separated value (CSV) file \n with your usage and costs aggregated by your tags. \n You can apply tags that represent business categories (such as cost centers, application names, or owners) \n to organize your costs across multiple services.
\nFor more information, \n see Using Cost Allocation Tags in Amazon ElastiCache \n in the ElastiCache User Guide.
" + "smithy.api#documentation": "A tag is a key-value pair where the key and value are case-sensitive. You can use tags\n to categorize and track all your ElastiCache resources, with the exception of global\n replication group. When you add or remove tags on replication groups, those actions will\n be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
\nFor example, you can use cost-allocation tags to your ElastiCache resources, Amazon\n generates a cost allocation report as a comma-separated value (CSV) file with your usage\n and costs aggregated by your tags. You can apply tags that represent business categories\n (such as cost centers, application names, or owners) to organize your costs across\n multiple services.
\nFor more information, see Using Cost Allocation Tags in\n Amazon ElastiCache in the ElastiCache User\n Guide.
" } }, "com.amazonaws.elasticache#AddTagsToResourceMessage": { @@ -125,14 +125,14 @@ "ResourceName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to which the tags are to be added, \n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
\n or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot
.\n ElastiCache resources are cluster and snapshot.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for\n example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
or\n arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot
.\n ElastiCache resources are cluster and\n snapshot.
For more information about ARNs, see Amazon Resource Names (ARNs)\n and Amazon Service Namespaces.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { - "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. \n A tag key must be accompanied by a tag value, although null is accepted.
", + "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
", "smithy.api#required": {} } } @@ -157,18 +157,18 @@ "ScaleUpModifications": { "target": "com.amazonaws.elasticache#NodeTypeList", "traits": { - "smithy.api#documentation": "A string list, each element of which specifies a cache node type which you can use \n to scale your cluster or replication group.
\nWhen scaling up a Redis cluster or replication group using ModifyCacheCluster
or\n ModifyReplicationGroup
, \n use a value from this list for the CacheNodeType
parameter.
A string list, each element of which specifies a cache node type which you can use to\n scale your cluster or replication group.
\nWhen scaling up a Redis cluster or replication group using\n ModifyCacheCluster
or ModifyReplicationGroup
, use a value\n from this list for the CacheNodeType
parameter.
A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group.\n \n When scaling down a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.
" + "smithy.api#documentation": "A string list, each element of which specifies a cache node type which you can use to\n scale your cluster or replication group. When scaling down a Redis cluster or\n replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from\n this list for the CacheNodeType parameter.
" } } }, "traits": { - "smithy.api#documentation": "Represents the allowed node types you can use to modify your cluster or replication group.
" + "smithy.api#documentation": "Represents the allowed node types you can use to modify your cluster or replication\n group.
" } }, "com.amazonaws.elasticache#AmazonElastiCacheV9": { @@ -369,6 +369,9 @@ }, { "target": "com.amazonaws.elasticache#TestFailover" + }, + { + "target": "com.amazonaws.elasticache#TestMigration" } ], "traits": { @@ -383,7 +386,7 @@ "name": "elasticache" }, "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "Amazon ElastiCache is a web service that makes it easier to set up, operate, \n and scale a distributed cache in the cloud.
\nWith ElastiCache, customers get all of the benefits of a high-performance, \n in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. \n The service makes setup, scaling, \n and cluster failure handling much simpler than in a self-managed cache deployment.
\nIn addition, through integration with Amazon CloudWatch, \n customers get enhanced visibility into the key performance statistics \n associated with their cache and can receive alarms if a part of their cache runs hot.
", + "smithy.api#documentation": "Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale\n a distributed cache in the cloud.
\nWith ElastiCache, customers get all of the benefits of a high-performance, in-memory\n cache with less of the administrative burden involved in launching and managing a\n distributed cache. The service makes setup, scaling, and cluster failure handling much\n simpler than in a self-managed cache deployment.
\nIn addition, through integration with Amazon CloudWatch, customers get enhanced\n visibility into the key performance statistics associated with their cache and can\n receive alarms if a part of their cache runs hot.
", "smithy.api#title": "Amazon ElastiCache", "smithy.api#xmlNamespace": { "uri": "http://elasticache.amazonaws.com/doc/2015-02-02/" @@ -1509,13 +1512,13 @@ "Type": { "target": "com.amazonaws.elasticache#InputAuthenticationType", "traits": { - "smithy.api#documentation": "Specifies the authentication type. Possible options are IAM authentication, password and no password.
" + "smithy.api#documentation": "Specifies the authentication type. Possible options are IAM authentication, password\n and no password.
" } }, "Passwords": { "target": "com.amazonaws.elasticache#PasswordListInput", "traits": { - "smithy.api#documentation": "Specifies the passwords to use for authentication if Type
is set to password
.
Specifies the passwords to use for authentication if Type
is set to\n password
.
The specified Amazon EC2 security group is already authorized for the specified cache security group.
", + "smithy.api#documentation": "The specified Amazon EC2 security group is already authorized for the specified cache\n security group.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1575,7 +1578,7 @@ "code": "AuthorizationNotFound", "httpResponseCode": 404 }, - "smithy.api#documentation": "The specified Amazon EC2 security group is not authorized for the specified cache security group.
", + "smithy.api#documentation": "The specified Amazon EC2 security group is not authorized for the specified cache\n security group.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -1606,7 +1609,7 @@ } ], "traits": { - "smithy.api#documentation": "Allows network ingress to a cache\n security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2\n security groups are used as the authorization mechanism.
\nYou cannot authorize ingress from an Amazon EC2 security group in one region to an\n ElastiCache cluster in another region.
\nAllows network ingress to a cache security group. Applications using ElastiCache must\n be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization\n mechanism.
\nYou cannot authorize ingress from an Amazon EC2 security group in one region to an\n ElastiCache cluster in another region.
\nThe Amazon EC2 security group to be authorized for ingress to the cache security group.
", + "smithy.api#documentation": "The Amazon EC2 security group to be authorized for ingress to the cache security\n group.
", "smithy.api#required": {} } }, "EC2SecurityGroupOwnerId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The Amazon account number of the Amazon EC2 security group owner. \n Note that this is not the same thing as an Amazon access key ID - \n you must provide a valid Amazon account number for this parameter.
", + "smithy.api#documentation": "The Amazon account number of the Amazon EC2 security group owner. Note that this is\n not the same thing as an Amazon access key ID - you must provide a valid Amazon account\n number for this parameter.
", "smithy.api#required": {} } } @@ -1644,6 +1647,9 @@ "CacheSecurityGroup": { "target": "com.amazonaws.elasticache#CacheSecurityGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#AutomaticFailoverStatus": { @@ -1718,7 +1724,7 @@ } ], "traits": { - "smithy.api#documentation": "Apply the service update. For more information on service updates and applying them, see Applying Service Updates.
" + "smithy.api#documentation": "Apply the service update. For more information on service updates and applying them,\n see Applying Service\n Updates.
" } }, "com.amazonaws.elasticache#BatchApplyUpdateActionMessage": { @@ -1762,7 +1768,7 @@ } ], "traits": { - "smithy.api#documentation": "Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.
" + "smithy.api#documentation": "Stop the service update. For more information on service updates and stopping them,\n see Stopping\n Service Updates.
" } }, "com.amazonaws.elasticache#BatchStopUpdateActionMessage": { @@ -1804,31 +1810,31 @@ "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The user-supplied identifier of the cluster. \n This identifier is a unique key that identifies a cluster.
" + "smithy.api#documentation": "The user-supplied identifier of the cluster. This identifier is a unique key that\n identifies a cluster.
" } }, "ConfigurationEndpoint": { "target": "com.amazonaws.elasticache#Endpoint", "traits": { - "smithy.api#documentation": "Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster.\n The configuration endpoint will always have .cfg
in it.
Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
\n
Represents a Memcached cluster endpoint which can be used by an application to connect\n to any node in the cluster. The configuration endpoint will always have\n .cfg
in it.
Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
\n
The URL of the web page where you can download the latest ElastiCache client library.
" + "smithy.api#documentation": "The URL of the web page where you can download the latest ElastiCache client\n library.
" } }, "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the compute and memory capacity node type for the cluster.
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n
\n M4 node types:\n cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n
\n T3 node types:\n cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro
\n
\n M1 node types:\n cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge
\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The name of the compute and memory capacity node type for the cluster.
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n
\n M4 node types:\n cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n
\n T3 node types:\n cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro
\n
\n M1 node types:\n cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge
\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1\n instances.
\nRedis configuration variables appendonly
and\n appendfsync
are not supported on Redis version 2.8.22 and\n later.
The name of the cache engine (memcached
or \n redis
) to be used for this cluster.
The name of the cache engine (memcached
or redis
) to be used\n for this cluster.
The current state of this cluster, one of the following values: \n available
, \n creating
, \n deleted
, \n deleting
,\n incompatible-network
,\n modifying
,\n rebooting cluster nodes
,\n restore-failed
, or \n snapshotting
.
The current state of this cluster, one of the following values:\n available
, creating
, deleted
,\n deleting
, incompatible-network
, modifying
,\n rebooting cluster nodes
, restore-failed
, or\n snapshotting
.
The number of cache nodes in the cluster.
\nFor clusters running Redis, this value must be 1. For clusters running Memcached, \n this value must be between 1 and 40.
" + "smithy.api#documentation": "The number of cache nodes in the cluster.
\nFor clusters running Redis, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.
" } }, "PreferredAvailabilityZone": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the Availability Zone in which the cluster is located or \"Multiple\" \n if the cache nodes are located in different Availability Zones.
" + "smithy.api#documentation": "The name of the Availability Zone in which the cluster is located or \"Multiple\" if the\n cache nodes are located in different Availability Zones.
" } }, "PreferredOutpostArn": { @@ -1870,7 +1876,7 @@ "PreferredMaintenanceWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.
\nValid values for ddd
are:
\n sun
\n
\n mon
\n
\n tue
\n
\n wed
\n
\n thu
\n
\n fri
\n
\n sat
\n
Example: sun:23:00-mon:01:30
\n
Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.
\nValid values for ddd
are:
\n sun
\n
\n mon
\n
\n tue
\n
\n wed
\n
\n thu
\n
\n fri
\n
\n sat
\n
Example: sun:23:00-mon:01:30
\n
Describes a notification topic and its status. \n Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
" + "smithy.api#documentation": "Describes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).
" } }, "CacheSecurityGroups": { "target": "com.amazonaws.elasticache#CacheSecurityGroupMembershipList", "traits": { - "smithy.api#documentation": "A list of cache security group elements, composed of name and status sub-elements.
" + "smithy.api#documentation": "A list of cache security group elements, composed of name and status\n sub-elements.
" } }, "CacheParameterGroup": { @@ -1910,7 +1916,7 @@ "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. \n
" + "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.
" } }, "SecurityGroups": { @@ -1922,25 +1928,25 @@ "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The replication group to which this cluster belongs. \n If this field is empty, the cluster is not associated with any replication group.
" + "smithy.api#documentation": "The replication group to which this cluster belongs. If this field is empty, the\n cluster is not associated with any replication group.
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit
to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.
\n If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
\nThe number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit
to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned\n off.
\nThe daily time range (in UTC) during which ElastiCache begins taking a \n daily snapshot of your cluster.
\nExample: 05:00-09:00
\n
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your cluster.
\nExample: 05:00-09:00
\n
A flag that enables using an AuthToken
(password)\n when issuing Redis commands.
Default: false
\n
A flag that enables using an AuthToken
(password) when issuing Redis\n commands.
Default: false
\n
A flag that enables in-transit encryption when set to true
.
\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6
, 4.x
or later.
Default: false
\n
A flag that enables in-transit encryption when set to true
.
\n Required: Only available when creating a replication\n group in an Amazon VPC using redis version 3.2.6
, 4.x
or\n later.
Default: false
\n
A flag that enables encryption at-rest when set to true
.
You cannot modify the value of AtRestEncryptionEnabled
\n after the cluster is created. To enable at-rest encryption on a cluster\n you must set AtRestEncryptionEnabled
to true
\n when you create a cluster.
\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6
, 4.x
or later.
Default: false
\n
A flag that enables encryption at-rest when set to true
.
You cannot modify the value of AtRestEncryptionEnabled
after the cluster\n is created. To enable at-rest encryption on a cluster you must set\n AtRestEncryptionEnabled
to true
when you create a\n cluster.
\n Required: Only available when creating a replication\n group in an Amazon VPC using redis version 3.2.6
, 4.x
or\n later.
Default: false
\n
A boolean value indicating whether log delivery is enabled for the replication group.
" + "smithy.api#documentation": "A boolean value indicating whether log delivery is enabled for the replication\n group.
" } }, "LogDeliveryConfigurations": { @@ -1983,19 +1989,19 @@ "NetworkType": { "target": "com.amazonaws.elasticache#NetworkType", "traits": { - "smithy.api#documentation": "Must be either ipv4
| ipv6
| dual_stack
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
Must be either ipv4
| ipv6
| dual_stack
. IPv6\n is supported for workloads using Redis engine version 6.2 onward or Memcached engine\n version 1.6.6 on all instances built on the Nitro system.
The network type associated with the cluster, either ipv4
| ipv6
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
The network type associated with the cluster, either ipv4
|\n ipv6
. IPv6 is supported for workloads using Redis engine version 6.2\n onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
" + "smithy.api#documentation": "A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.
" } } }, @@ -2053,7 +2059,7 @@ "CacheClusters": { "target": "com.amazonaws.elasticache#CacheClusterList", "traits": { - "smithy.api#documentation": "A list of clusters. Each item in the list contains detailed information about one cluster.
" + "smithy.api#documentation": "A list of clusters. Each item in the list contains detailed information about one\n cluster.
" } } }, @@ -2096,7 +2102,7 @@ "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the cache parameter group family associated with this cache engine.
\nValid values are: \n memcached1.4
| \n memcached1.5
| \n memcached1.6
| \n redis2.6
| \n redis2.8
|\n redis3.2
|\n redis4.0
|\n redis5.0
| \n redis6.x
|\n redis7
\n
The name of the cache parameter group family associated with this cache engine.
\nValid values are: memcached1.4
| memcached1.5
|\n memcached1.6
| redis2.6
| redis2.8
|\n redis3.2
| redis4.0
| redis5.0
|\n redis6.x
| redis7
\n
A list of cache engine version details. \n Each element in the list contains detailed information about one cache engine version.
" + "smithy.api#documentation": "A list of cache engine version details. Each element in the list contains detailed\n information about one cache engine version.
" } } }, "traits": { - "smithy.api#documentation": "Represents the output of a DescribeCacheEngineVersions operation.
" + "smithy.api#documentation": "Represents the output of a DescribeCacheEngineVersions\n operation.
" } }, "com.amazonaws.elasticache#CacheNode": { @@ -2151,13 +2157,13 @@ "CacheNodeId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's Amazon account.
" + "smithy.api#documentation": "The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's Amazon account.
" } }, "CacheNodeStatus": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The current state of this cache node, one of the following values: available
, creating
, rebooting
, or deleting
.
The current state of this cache node, one of the following values:\n available
, creating
, rebooting
, or\n deleting
.
The ID of the primary node to which this read replica node is synchronized. \n If this field is empty, this node is not associated with a primary cluster.
" + "smithy.api#documentation": "The ID of the primary node to which this read replica node is synchronized. If this\n field is empty, this node is not associated with a primary cluster.
" } }, "CustomerAvailabilityZone": { @@ -2198,7 +2204,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents an individual cache node within a cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n
\n M4 node types:\n cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n
\n T3 node types:\n cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro
\n
\n M1 node types:\n cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge
\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
Represents an individual cache node within a cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n
\n M4 node types:\n cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n
\n T3 node types:\n cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro
\n
\n M1 node types:\n cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge
\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1\n instances.
\nRedis configuration variables appendonly
and\n appendfsync
are not supported on Redis version 2.8.22 and\n later.
Indicates whether a change to the parameter is applied immediately\n or requires a reboot for the change to be applied. \n You can force a reboot or wait until the next maintenance window's reboot.\n For more information, see Rebooting a Cluster.
" + "smithy.api#documentation": "Indicates whether a change to the parameter is applied immediately or requires a\n reboot for the change to be applied. You can force a reboot or wait until the next\n maintenance window's reboot. For more information, see Rebooting a\n Cluster.
" } } }, @@ -2356,7 +2362,7 @@ "NodeUpdateInitiatedBy": { "target": "com.amazonaws.elasticache#NodeUpdateInitiatedBy", "traits": { - "smithy.api#documentation": "Reflects whether the update was initiated by the customer or automatically applied
" + "smithy.api#documentation": "Reflects whether the update was initiated by the customer or automatically\n applied
" } }, "NodeUpdateInitiatedDate": { @@ -2397,7 +2403,7 @@ "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the cache parameter group family that this cache parameter group is compatible with.
\nValid values are: \n memcached1.4
| \n memcached1.5
| \n memcached1.6
| \n redis2.6
| \n redis2.8
|\n redis3.2
|\n redis4.0
|\n redis5.0
| \n redis6.x
| \n redis7
\n
The name of the cache parameter group family that this cache parameter group is\n compatible with.
\nValid values are: memcached1.4
| memcached1.5
|\n memcached1.6
| redis2.6
| redis2.8
|\n redis3.2
| redis4.0
| redis5.0
|\n redis6.x
| redis7
\n
A list of parameters specific to a particular cache node type. \n Each element in the list contains detailed information about one parameter.
" + "smithy.api#documentation": "A list of parameters specific to a particular cache node type. Each element in the\n list contains detailed information about one parameter.
" } } }, @@ -2502,7 +2508,7 @@ "code": "CacheParameterGroupNotFound", "httpResponseCode": 404 }, - "smithy.api#documentation": "The requested cache parameter group name does not refer to an existing cache parameter group.
", + "smithy.api#documentation": "The requested cache parameter group name does not refer to an existing cache parameter\n group.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -2519,7 +2525,7 @@ "code": "CacheParameterGroupQuotaExceeded", "httpResponseCode": 400 }, - "smithy.api#documentation": "The request cannot be processed because it would exceed the maximum number of cache security groups.
", + "smithy.api#documentation": "The request cannot be processed because it would exceed the maximum number of cache\n security groups.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2542,7 +2548,7 @@ "CacheNodeIdsToReboot": { "target": "com.amazonaws.elasticache#CacheNodeIdsList", "traits": { - "smithy.api#documentation": "A list of the cache node IDs which need to be rebooted for parameter changes to be applied. \n A node ID is a numeric identifier (0001, 0002, etc.).
" + "smithy.api#documentation": "A list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).
" } } }, @@ -2562,7 +2568,7 @@ "CacheParameterGroups": { "target": "com.amazonaws.elasticache#CacheParameterGroupList", "traits": { - "smithy.api#documentation": "A list of cache parameter groups. Each element in the list contains detailed information \n about one cache parameter group.
" + "smithy.api#documentation": "A list of cache parameter groups. Each element in the list contains detailed\n information about one cache parameter group.
" } } }, @@ -2594,7 +2600,7 @@ "EC2SecurityGroups": { "target": "com.amazonaws.elasticache#EC2SecurityGroupList", "traits": { - "smithy.api#documentation": "A list of Amazon EC2 security groups that are associated with this cache security group.
" + "smithy.api#documentation": "A list of Amazon EC2 security groups that are associated with this cache security\n group.
" } }, "ARN": { @@ -2637,7 +2643,7 @@ "Status": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cluster are modified.
" + "smithy.api#documentation": "The membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cluster are\n modified.
" } } }, @@ -2666,7 +2672,7 @@ "CacheSecurityGroups": { "target": "com.amazonaws.elasticache#CacheSecurityGroups", "traits": { - "smithy.api#documentation": "A list of cache security groups. Each element in the list contains detailed information about one group.
" + "smithy.api#documentation": "A list of cache security groups. Each element in the list contains detailed\n information about one group.
" } } }, @@ -2695,7 +2701,7 @@ "code": "CacheSecurityGroupNotFound", "httpResponseCode": 404 }, - "smithy.api#documentation": "The requested cache security group name does not refer to an existing cache security group.
", + "smithy.api#documentation": "The requested cache security group name does not refer to an existing cache security\n group.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -2712,7 +2718,7 @@ "code": "QuotaExceeded.CacheSecurityGroup", "httpResponseCode": 400 }, - "smithy.api#documentation": "The request cannot be processed because it would exceed the allowed number of cache security groups.
", + "smithy.api#documentation": "The request cannot be processed because it would exceed the allowed number of cache\n security groups.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2762,7 +2768,7 @@ "SupportedNetworkTypes": { "target": "com.amazonaws.elasticache#NetworkTypeList", "traits": { - "smithy.api#documentation": "Either ipv4
| ipv6
| dual_stack
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
Either ipv4
| ipv6
| dual_stack
. IPv6 is\n supported for workloads using Redis engine version 6.2 onward or Memcached engine\n version 1.6.6 on all instances built on the Nitro system.
The requested cache subnet group name is already in use by an existing cache subnet group.
", + "smithy.api#documentation": "The requested cache subnet group name is already in use by an existing cache subnet\n group.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2816,7 +2822,7 @@ "CacheSubnetGroups": { "target": "com.amazonaws.elasticache#CacheSubnetGroups", "traits": { - "smithy.api#documentation": "A list of cache subnet groups. Each element in the list contains detailed information about one group.
" + "smithy.api#documentation": "A list of cache subnet groups. Each element in the list contains detailed information\n about one group.
" } } }, @@ -2836,7 +2842,7 @@ "code": "CacheSubnetGroupNotFoundFault", "httpResponseCode": 400 }, - "smithy.api#documentation": "The requested cache subnet group name does not refer to an existing cache subnet group.
", + "smithy.api#documentation": "The requested cache subnet group name does not refer to an existing cache subnet\n group.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2853,7 +2859,7 @@ "code": "CacheSubnetGroupQuotaExceeded", "httpResponseCode": 400 }, - "smithy.api#documentation": "The request cannot be processed because it would exceed the allowed number of cache subnet groups.
", + "smithy.api#documentation": "The request cannot be processed because it would exceed the allowed number of cache\n subnet groups.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2879,7 +2885,7 @@ "code": "CacheSubnetQuotaExceededFault", "httpResponseCode": 400 }, - "smithy.api#documentation": "The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.
", + "smithy.api#documentation": "The request cannot be processed because it would exceed the allowed number of subnets\n in a cache subnet group.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2959,7 +2965,7 @@ "code": "ClusterQuotaForCustomerExceeded", "httpResponseCode": 400 }, - "smithy.api#documentation": "The request cannot be processed because it would exceed the allowed number of clusters per customer.
", + "smithy.api#documentation": "The request cannot be processed because it would exceed the allowed number of clusters\n per customer.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3001,7 +3007,7 @@ "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Forces the migration to stop without ensuring that data is in sync. It is recommended to use this option only to abort the migration and not recommended when application wants to continue migration to ElastiCache.
" + "smithy.api#documentation": "Forces the migration to stop without ensuring that data is in sync. It is recommended\n to use this option only to abort the migration and not recommended when application\n wants to continue migration to ElastiCache.
" } } } @@ -3023,7 +3029,7 @@ "NodeGroupId": { "target": "com.amazonaws.elasticache#AllowedNodeGroupId", "traits": { - "smithy.api#documentation": "The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) \n replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)'s \n node group's (shard's) id, see Finding a Shard's Id.
", + "smithy.api#documentation": "The 4-digit id for the node group you are configuring. For Redis (cluster mode\n disabled) replication groups, the node group id is always 0001. To find a Redis (cluster\n mode enabled)'s node group's (shard's) id, see Finding a Shard's\n Id.
", "smithy.api#required": {} } }, @@ -3031,14 +3037,14 @@ "target": "com.amazonaws.elasticache#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The number of replicas you want in this node group at the end of this operation. \n The maximum value for NewReplicaCount
is 5.\n The minimum value depends upon the type of Redis replication group you are working with.
The minimum number of replicas in a shard or replication group is:
\nRedis (cluster mode disabled)
\nIf Multi-AZ: 1
\nIf Multi-AZ: 0
\nRedis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
\nThe number of replicas you want in this node group at the end of this operation.\n The maximum value for NewReplicaCount
is 5. The minimum value depends upon\n the type of Redis replication group you are working with.
The minimum number of replicas in a shard or replication group is:
\nRedis (cluster mode disabled)
\nIf Multi-AZ: 1
\nIf Multi-AZ: 0
\nRedis (cluster mode enabled): 0 (though you will not be able to failover to\n a replica if your primary node fails)
\nA list of PreferredAvailabilityZone
strings that specify which availability zones the \n replication group's nodes are to be in. The nummber of PreferredAvailabilityZone
values must \n equal the value of NewReplicaCount
plus 1 to account for the primary node. If this member of \n ReplicaConfiguration
is omitted, ElastiCache for Redis selects the availability zone for \n each of the replicas.
A list of PreferredAvailabilityZone
strings that specify which\n availability zones the replication group's nodes are to be in. The nummber of\n PreferredAvailabilityZone
values must equal the value of\n NewReplicaCount
plus 1 to account for the primary node. If this member\n of ReplicaConfiguration
is omitted, ElastiCache for Redis selects the\n availability zone for each of the replicas.
Node group (shard) configuration options when adding or removing replicas. \n Each node group (shard) configuration has the following members: NodeGroupId, NewReplicaCount, and PreferredAvailabilityZones.
" + "smithy.api#documentation": "Node group (shard) configuration options when adding or removing replicas. Each\n node group (shard) configuration has the following members: NodeGroupId,\n NewReplicaCount, and PreferredAvailabilityZones.
" } }, "com.amazonaws.elasticache#CopySnapshot": { @@ -3084,7 +3090,7 @@ } ], "traits": { - "smithy.api#documentation": "Makes a copy of an existing snapshot.
\nThis operation is valid for Redis only.
\nUsers or groups that have permissions to use the CopySnapshot
operation \n can create their own Amazon S3 buckets and copy snapshots to it. \n To control access to your snapshots, use an IAM policy to control who has the ability to use \n the CopySnapshot
operation. \n For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots \n and Authentication & Access Control.
You could receive the following error messages.
\n\n Error Messages\n
\n\n Error Message:\n The S3 bucket %s is outside of the region.
\n\n Solution:\n Create an Amazon S3 bucket in the same region as your snapshot. \n For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
\n\n Error Message:\n The S3 bucket %s does not exist.
\n\n Solution:\n Create an Amazon S3 bucket in the same region as your snapshot.\n For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
\n\n Error Message:\n The S3 bucket %s is not owned by the authenticated user.
\n\n Solution:\n Create an Amazon S3 bucket in the same region as your snapshot.\n For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
\n\n Error Message:\n The authenticated user does not have sufficient permissions to perform the desired activity.
\n\n Solution:\n Contact your system administrator to get the needed permissions.
\n\n Error Message:\n The S3 bucket %s already contains an object with key %s.
\n\n Solution:\n Give the TargetSnapshotName
a new and unique value.\n If exporting a snapshot, \n you could alternatively create a new Amazon S3 bucket \n and use this same value for TargetSnapshotName
.
\n Error Message: \n ElastiCache has not been granted READ permissions %s on the S3 Bucket.
\n\n Solution:\n Add List and Read permissions on the bucket.\n For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
\n\n Error Message: \n ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.
\n\n Solution:\n Add Upload/Delete permissions on the bucket.\n For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
\n\n Error Message: \n ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.
\n\n Solution:\n Add View Permissions on the bucket.\n For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
\nMakes a copy of an existing snapshot.
\nThis operation is valid for Redis only.
\nUsers or groups that have permissions to use the CopySnapshot
\n operation can create their own Amazon S3 buckets and copy snapshots to it. To\n control access to your snapshots, use an IAM policy to control who has the ability\n to use the CopySnapshot
operation. For more information about using IAM\n to control the use of ElastiCache operations, see Exporting\n Snapshots and Authentication & Access\n Control.
You could receive the following error messages.
\n\n Error Messages\n
\n\n Error Message: The S3 bucket %s is outside of\n the region.
\n\n Solution: Create an Amazon S3 bucket in the\n same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User\n Guide.
\n\n Error Message: The S3 bucket %s does not\n exist.
\n\n Solution: Create an Amazon S3 bucket in the\n same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User\n Guide.
\n\n Error Message: The S3 bucket %s is not owned\n by the authenticated user.
\n\n Solution: Create an Amazon S3 bucket in the\n same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User\n Guide.
\n\n Error Message: The authenticated user does\n not have sufficient permissions to perform the desired activity.
\n\n Solution: Contact your system administrator\n to get the needed permissions.
\n\n Error Message: The S3 bucket %s already\n contains an object with key %s.
\n\n Solution: Give the\n TargetSnapshotName
a new and unique value. If exporting a\n snapshot, you could alternatively create a new Amazon S3 bucket and use this\n same value for TargetSnapshotName
.
\n Error Message: ElastiCache has not been\n granted READ permissions %s on the S3 Bucket.
\n\n Solution: Add List and Read permissions on\n the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the\n ElastiCache User Guide.
\n\n Error Message: ElastiCache has not been\n granted WRITE permissions %s on the S3 Bucket.
\n\n Solution: Add Upload/Delete permissions on\n the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the\n ElastiCache User Guide.
\n\n Error Message: ElastiCache has not been\n granted READ_ACP permissions %s on the S3 Bucket.
\n\n Solution: Add View Permissions on the bucket.\n For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the\n ElastiCache User Guide.
\nA name for the snapshot copy.\n ElastiCache does not permit overwriting a snapshot, therefore\n this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.
", + "smithy.api#documentation": "A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot,\n therefore this name must be unique within its context - ElastiCache or an Amazon S3\n bucket if exporting.
", "smithy.api#required": {} } }, "TargetBucket": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The Amazon S3 bucket to which the snapshot is exported.\n This parameter is used only when exporting a snapshot for external access.
\nWhen using this parameter to export a snapshot, \n be sure Amazon ElastiCache has the needed permissions to this S3 bucket. \n For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.
\nFor more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.
" + "smithy.api#documentation": "The Amazon S3 bucket to which the snapshot is exported. This parameter is used only\n when exporting a snapshot for external access.
\nWhen using this parameter to export a snapshot, be sure Amazon ElastiCache has the\n needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the\n Amazon ElastiCache User Guide.
\nFor more information, see Exporting a\n Snapshot in the Amazon ElastiCache User Guide.
" } }, "KmsKeyId": { @@ -3119,7 +3125,7 @@ "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { - "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
" + "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } } }, @@ -3133,6 +3139,9 @@ "Snapshot": { "target": "com.amazonaws.elasticache#Snapshot" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#CreateCacheCluster": { @@ -3188,7 +3197,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a cluster. All nodes in the\n cluster run the same protocol-compliant cache engine software, either Memcached\n or Redis.
\nThis operation is not supported for Redis (cluster mode enabled) clusters.
" + "smithy.api#documentation": "Creates a cluster. All nodes in the cluster run the same protocol-compliant cache\n engine software, either Memcached or Redis.
\nThis operation is not supported for Redis (cluster mode enabled) clusters.
" } }, "com.amazonaws.elasticache#CreateCacheClusterMessage": { @@ -3197,80 +3206,80 @@ "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The node group (shard) identifier. This parameter is stored as a lowercase string.
\n\n Constraints:\n
\nA name must contain from 1 to 50 alphanumeric characters or hyphens.
\nThe first character must be a letter.
\nA name cannot end with a hyphen or contain two consecutive hyphens.
\nThe node group (shard) identifier. This parameter is stored as a lowercase\n string.
\n\n Constraints:\n
\nA name must contain from 1 to 50 alphanumeric characters or hyphens.
\nThe first character must be a letter.
\nA name cannot end with a hyphen or contain two consecutive hyphens.
\nThe ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.
\nIf the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.
\nThis parameter is only valid if the Engine
parameter is redis
.
The ID of the replication group to which this cluster should belong. If this parameter\n is specified, the cluster is added to the specified replication group as a read replica;\n otherwise, the cluster is a standalone primary that is not part of any replication\n group.
\nIf the specified replication group is Multi-AZ enabled and the Availability Zone is\n not specified, the cluster is created in Availability Zones that provide the best spread\n of read replicas across Availability Zones.
\nThis parameter is only valid if the Engine
parameter is\n redis
.
Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or \n created across multiple Availability Zones in the cluster's region.
\nThis parameter is only supported for Memcached clusters.
\nIf the AZMode
and PreferredAvailabilityZones
are not specified, \n ElastiCache assumes single-az
mode.
Specifies whether the nodes in this Memcached cluster are created in a single\n Availability Zone or created across multiple Availability Zones in the cluster's\n region.
\nThis parameter is only supported for Memcached clusters.
\nIf the AZMode
and PreferredAvailabilityZones
are not\n specified, ElastiCache assumes single-az
mode.
The EC2 Availability Zone in which the cluster is created.
\nAll nodes belonging to this cluster are placed in the preferred Availability Zone. \n If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones
.
Default: System chosen Availability Zone.
" + "smithy.api#documentation": "The EC2 Availability Zone in which the cluster is created.
\nAll nodes belonging to this cluster are placed in the preferred Availability Zone. If\n you want to create your nodes across multiple Availability Zones, use\n PreferredAvailabilityZones
.
Default: System chosen Availability Zone.
" } }, "PreferredAvailabilityZones": { "target": "com.amazonaws.elasticache#PreferredAvailabilityZoneList", "traits": { - "smithy.api#documentation": "A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.
\nThis option is only supported on Memcached.
\nIf you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.
\nThe number of Availability Zones listed must equal the value of NumCacheNodes
.
If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone
instead, or \n repeat the Availability Zone multiple times in the list.
Default: System chosen Availability Zones.
" + "smithy.api#documentation": "A list of the Availability Zones in which cache nodes are created. The order of the\n zones in the list is not important.
\nThis option is only supported on Memcached.
\nIf you are creating your cluster in an Amazon VPC (recommended) you can only\n locate nodes in Availability Zones that are associated with the subnets in the\n selected subnet group.
\nThe number of Availability Zones listed must equal the value of\n NumCacheNodes
.
If you want all the nodes in the same Availability Zone, use\n PreferredAvailabilityZone
instead, or repeat the Availability Zone\n multiple times in the list.
Default: System chosen Availability Zones.
" } }, "NumCacheNodes": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The initial number of cache nodes that the cluster has.
\nFor clusters running Redis, this value must be 1. \n For clusters running Memcached, this value must be between 1 and 40.
\nIf you need more than 40 nodes for your Memcached cluster, \n please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
" + "smithy.api#documentation": "The initial number of cache nodes that the cluster has.
\nFor clusters running Redis, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.
\nIf you need more than 40 nodes for your Memcached cluster, please fill out the\n ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
" } }, "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The compute and memory capacity of the nodes in the node group (shard).
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n
\n M4 node types:\n cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n
\n T3 node types:\n cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro
\n
\n M1 node types:\n cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge
\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The compute and memory capacity of the nodes in the node group (shard).
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n
\n M4 node types:\n cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n
\n T3 node types:\n cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro
\n
\n M1 node types:\n cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge
\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1\n instances.
\nRedis configuration variables appendonly
and\n appendfsync
are not supported on Redis version 2.8.22 and\n later.
The name of the cache engine to be used for this cluster.
\nValid values for this parameter are: memcached
| redis
\n
The name of the cache engine to be used for this cluster.
\nValid values for this parameter are: memcached
|\n redis
\n
The version number of the cache engine to be used for this cluster. \n To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
\n\n Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version.\n If you want to use an earlier engine version, \n you must delete the existing cluster or replication group and create it anew with the earlier engine version.
" + "smithy.api#documentation": "The version number of the cache engine to be used for this cluster. To view the\n supported cache engine versions, use the DescribeCacheEngineVersions operation.
\n\n Important: You can upgrade to a newer engine version\n (see Selecting\n a Cache Engine and Version), but you cannot downgrade to an earlier engine\n version. If you want to use an earlier engine version, you must delete the existing\n cluster or replication group and create it anew with the earlier engine version.
" } }, "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the parameter group to associate with this cluster. \n If this argument is omitted, the default parameter group for the specified engine is used.\n You cannot use any parameter group which has cluster-enabled='yes'
when creating a cluster.
The name of the parameter group to associate with this cluster. If this argument is\n omitted, the default parameter group for the specified engine is used. You cannot use\n any parameter group which has cluster-enabled='yes'
when creating a\n cluster.
The name of the subnet group to be used for the cluster.
\nUse this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
\nIf you're going to launch your cluster in an Amazon VPC, \n you need to create a subnet group before you start creating a cluster. \n For more information, see Subnets and Subnet Groups.
\nThe name of the subnet group to be used for the cluster.
\nUse this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (Amazon VPC).
\nIf you're going to launch your cluster in an Amazon VPC, you need to create a\n subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
\nA list of security group names to associate with this cluster.
\nUse this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).
" + "smithy.api#documentation": "A list of security group names to associate with this cluster.
\nUse this parameter only when you are creating a cluster outside of an Amazon Virtual\n Private Cloud (Amazon VPC).
" } }, "SecurityGroupIds": { "target": "com.amazonaws.elasticache#SecurityGroupIdsList", "traits": { - "smithy.api#documentation": "One or more VPC security groups associated with the cluster.
\nUse this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
" + "smithy.api#documentation": "One or more VPC security groups associated with the cluster.
\nUse this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (Amazon VPC).
" } }, "Tags": { @@ -3282,61 +3291,61 @@ "SnapshotArns": { "target": "com.amazonaws.elasticache#SnapshotArnsList", "traits": { - "smithy.api#documentation": "A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies \n a Redis RDB snapshot file stored in Amazon S3.\n The snapshot file is used to populate the node group (shard). \n The Amazon S3 object name in the ARN cannot contain any commas.
\nThis parameter is only valid if the Engine
parameter is redis
.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
\n
A single-element string list containing an Amazon Resource Name (ARN) that uniquely\n identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to\n populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any\n commas.
\nThis parameter is only valid if the Engine
parameter is\n redis
.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
\n
The name of a Redis snapshot from which to restore data into the new node group (shard).\n The snapshot status changes to restoring
while the new node group (shard) is being created.
This parameter is only valid if the Engine
parameter is redis
.
The name of a Redis snapshot from which to restore data into the new node group\n (shard). The snapshot status changes to restoring
while the new node group\n (shard) is being created.
This parameter is only valid if the Engine
parameter is\n redis
.
Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.\n
" + "smithy.api#documentation": "Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.
" } }, "Port": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The port number on which each of the cache nodes accepts connections.
" + "smithy.api#documentation": "The port number on which each of the cache nodes accepts connections.
" } }, "NotificationTopicArn": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic \n to which notifications are sent.
\nThe Amazon SNS topic owner must be the same as the cluster owner.
\nThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic\n to which notifications are sent.
\nThe Amazon SNS topic owner must be the same as the cluster owner.
\nIf you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. \n
" + "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days for which ElastiCache retains automatic snapshots before deleting them. \n For example, if you set SnapshotRetentionLimit
to 5,\n a snapshot taken today is retained for 5 days before being deleted.
This parameter is only valid if the Engine
parameter is redis
.
Default: 0 (i.e., automatic backups are disabled for this cache cluster).
" + "smithy.api#documentation": "The number of days for which ElastiCache retains automatic snapshots before deleting\n them. For example, if you set SnapshotRetentionLimit
to 5, a snapshot taken\n today is retained for 5 days before being deleted.
This parameter is only valid if the Engine
parameter is\n redis
.
Default: 0 (i.e., automatic backups are disabled for this cache cluster).
" } }, "SnapshotWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
\nExample: 05:00-09:00
\n
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
\nThis parameter is only valid if the Engine
parameter is redis
.
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your node group (shard).
\nExample: 05:00-09:00
\n
If you do not specify this parameter, ElastiCache automatically chooses an appropriate\n time range.
\nThis parameter is only valid if the Engine
parameter is\n redis
.
\n Reserved parameter. \n The password used to access a password protected server.
\nPassword constraints:
\nMust be only printable ASCII characters.
\nMust be at least 16 characters and no more than 128\n characters in length.
\nThe only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
\nFor more information, see AUTH password at http://redis.io/commands/AUTH.
" + "smithy.api#documentation": "\n Reserved parameter. The password used to access a\n password protected server.
\nPassword constraints:
\nMust be only printable ASCII characters.
\nMust be at least 16 characters and no more than 128 characters in\n length.
\nThe only permitted printable special characters are !, &, #, $, ^, <,\n >, and -. Other printable special characters cannot be used in the AUTH\n token.
\nFor more information, see AUTH\n password at http://redis.io/commands/AUTH.
" } }, "OutpostMode": { "target": "com.amazonaws.elasticache#OutpostMode", "traits": { - "smithy.api#documentation": "Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
" + "smithy.api#documentation": "Specifies whether the nodes in the cluster are created in a single outpost or across\n multiple outposts.
" } }, "PreferredOutpostArn": { @@ -3366,13 +3375,13 @@ "NetworkType": { "target": "com.amazonaws.elasticache#NetworkType", "traits": { - "smithy.api#documentation": "Must be either ipv4
| ipv6
| dual_stack
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
Must be either ipv4
| ipv6
| dual_stack
. IPv6\n is supported for workloads using Redis engine version 6.2 onward or Memcached engine\n version 1.6.6 on all instances built on the Nitro system.
The network type you choose when modifying a cluster, either ipv4
| ipv6
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
The network type you choose when modifying a cluster, either ipv4
|\n ipv6
. IPv6 is supported for workloads using Redis engine version 6.2\n onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
Creates a new Amazon ElastiCache cache parameter group. An ElastiCache\n cache parameter group is a collection of parameters and their values that are applied to all of the nodes\n in any cluster or replication group using the CacheParameterGroup.
\nA newly created CacheParameterGroup is an exact duplicate of the default parameter group\n for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can\n change the values of specific parameters. For more information, see:
\n\n ModifyCacheParameterGroup in the ElastiCache API Reference.
\n\n Parameters and Parameter Groups in the ElastiCache User Guide.
\nCreates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter\n group is a collection of parameters and their values that are applied to all of the\n nodes in any cluster or replication group using the CacheParameterGroup.
\nA newly created CacheParameterGroup is an exact duplicate of the default parameter\n group for the CacheParameterGroupFamily. To customize the newly created\n CacheParameterGroup you can change the values of specific parameters. For more\n information, see:
\n\n ModifyCacheParameterGroup in the ElastiCache API Reference.
\n\n Parameters and\n Parameter Groups in the ElastiCache User Guide.
\nThe name of the cache parameter group family that the cache parameter group can be used with.
\nValid values are: \n memcached1.4
| \n memcached1.5
| \n memcached1.6
| \n redis2.6
| \n redis2.8
|\n redis3.2
|\n redis4.0
|\n redis5.0
| \n redis6.x
|\n redis7
\n
The name of the cache parameter group family that the cache parameter group can be\n used with.
\nValid values are: memcached1.4
| memcached1.5
|\n memcached1.6
| redis2.6
| redis2.8
|\n redis3.2
| redis4.0
| redis5.0
|\n redis6.x
| redis7
\n
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
" + "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } } }, @@ -3461,6 +3473,9 @@ "CacheParameterGroup": { "target": "com.amazonaws.elasticache#CacheParameterGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#CreateCacheSecurityGroup": { @@ -3489,7 +3504,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new cache security group. Use a\n cache security group to control access to one or more clusters.
\nCache security groups are only used when you are creating a cluster outside of an Amazon\n Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache\n subnet group instead. For more information, \n see CreateCacheSubnetGroup.
" + "smithy.api#documentation": "Creates a new cache security group. Use a cache security group to control access to\n one or more clusters.
\nCache security groups are only used when you are creating a cluster outside of an\n Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a\n VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.
" } }, "com.amazonaws.elasticache#CreateCacheSecurityGroupMessage": { @@ -3498,7 +3513,7 @@ "CacheSecurityGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "A name for the cache security group. This value is stored as a lowercase string.
\nConstraints: Must contain no more than 255 alphanumeric characters. Cannot be the word \"Default\".
\nExample: mysecuritygroup
\n
A name for the cache security group. This value is stored as a lowercase\n string.
\nConstraints: Must contain no more than 255 alphanumeric characters. Cannot be the word\n \"Default\".
\nExample: mysecuritygroup
\n
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
" + "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } } }, @@ -3526,6 +3541,9 @@ "CacheSecurityGroup": { "target": "com.amazonaws.elasticache#CacheSecurityGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#CreateCacheSubnetGroup": { @@ -3557,7 +3575,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new cache subnet group.
\nUse this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
" + "smithy.api#documentation": "Creates a new cache subnet group.
\nUse this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (Amazon VPC).
" } }, "com.amazonaws.elasticache#CreateCacheSubnetGroupMessage": { @@ -3587,7 +3605,7 @@ "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { - "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
" + "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } } }, @@ -3601,6 +3619,9 @@ "CacheSubnetGroup": { "target": "com.amazonaws.elasticache#CacheSubnetGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#CreateGlobalReplicationGroup": { @@ -3629,7 +3650,7 @@ } ], "traits": { - "smithy.api#documentation": "Global Datastore for Redis offers fully managed, fast, \n reliable and secure cross-region replication.\n Using Global Datastore for Redis, you can create cross-region\n read replica clusters for ElastiCache for Redis to enable low-latency reads\n and disaster recovery across regions. For more information,\n\n see Replication Across Regions Using Global Datastore.
\nThe GlobalReplicationGroupIdSuffix is the name of the Global datastore.
\nThe PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
\nGlobal Datastore for Redis offers fully managed, fast, reliable and secure\n cross-region replication. Using Global Datastore for Redis, you can create cross-region\n read replica clusters for ElastiCache for Redis to enable low-latency reads and disaster\n recovery across regions. For more information, see Replication\n Across Regions Using Global Datastore.
\nThe GlobalReplicationGroupIdSuffix is the\n name of the Global datastore.
\nThe PrimaryReplicationGroupId represents the\n name of the primary cluster that accepts writes and will replicate updates to\n the secondary cluster.
\nThe suffix name of a Global datastore. Amazon ElastiCache automatically applies a prefix \n to the Global datastore ID when it is created. Each Amazon Region has its own prefix. For instance, a Global datastore ID created in the US-West-1 region will begin with \"dsdfu\" along with the suffix name you provide. The suffix, combined with the auto-generated prefix, guarantees uniqueness of the Global datastore name across multiple regions.
\nFor a full list of Amazon Regions and their respective Global datastore iD prefixes, see Using the Amazon CLI with Global datastores .
", + "smithy.api#documentation": "The suffix name of a Global datastore. Amazon ElastiCache automatically applies a\n prefix to the Global datastore ID when it is created. Each Amazon Region has its own\n prefix. For instance, a Global datastore ID created in the US-West-1 region will begin\n with \"dsdfu\" along with the suffix name you provide. The suffix, combined with the\n auto-generated prefix, guarantees uniqueness of the Global datastore name across\n multiple regions.
\nFor a full list of Amazon Regions and their respective Global datastore iD prefixes,\n see Using the Amazon CLI with Global datastores .
", "smithy.api#required": {} } }, @@ -3651,7 +3672,7 @@ "PrimaryReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
", + "smithy.api#documentation": "The name of the primary cluster that accepts writes and will replicate updates to the\n secondary cluster.
", "smithy.api#required": {} } } @@ -3663,6 +3684,9 @@ "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#CreateReplicationGroup": { @@ -3733,7 +3757,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.
\nThis API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.
\nA Redis (cluster mode disabled) replication group is a collection of clusters, \n where one of the clusters is a read/write primary and the others are read-only replicas. \n Writes to the primary are asynchronously propagated to the replicas.
\nA Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). \n 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.\n \n
\nThe 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 \n 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. \n 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 \n Creating a Subnet Group. For versions below 5.0.6, \n the limit is 250 per cluster.
\nTo request a limit increase, see \n Amazon Service Limits \n and choose the limit type Nodes per cluster per instance type.
\nWhen a Redis (cluster mode disabled) replication group has been successfully created, \n you can add one or more read replicas to it, up to a total of 5 read replicas. \n If you need to increase or decrease the number of node groups (console: shards), \n you can avail yourself of ElastiCache for Redis' scaling. For more information,\n see Scaling ElastiCache for Redis Clusters in the ElastiCache User Guide.
\nThis operation is valid for Redis only.
\nCreates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication\n group.
\nThis API can be used to create a standalone regional replication group or a secondary\n replication group associated with a Global datastore.
\nA Redis (cluster mode disabled) replication group is a collection of clusters, where\n one of the clusters is a read/write primary and the others are read-only replicas.\n Writes to the primary are asynchronously propagated to the replicas.
\nA Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI:\n node groups). Each shard has a primary node and up to 5 read-only replica nodes. The\n configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which\n is the maximum number or replicas allowed.
\nThe node or shard limit can be increased to a maximum of 500 per cluster if the Redis\n engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node\n cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500\n shards (single primary and no replicas). Make sure there are enough available IP\n addresses to accommodate the increase. Common pitfalls include the subnets in the subnet\n group have too small a CIDR range or the subnets are shared and heavily used by other\n clusters. For more information, see Creating a Subnet\n Group. For versions below 5.0.6, the limit is 250 per cluster.
\nTo request a limit increase, see Amazon Service Limits and\n choose the limit type Nodes per cluster per instance\n type.
\nWhen a Redis (cluster mode disabled) replication group has been successfully created,\n you can add one or more read replicas to it, up to a total of 5 read replicas. If you\n need to increase or decrease the number of node groups (console: shards), you can avail\n yourself of ElastiCache for Redis' scaling. For more information, see Scaling\n ElastiCache for Redis Clusters in the ElastiCache User\n Guide.
\nThis operation is valid for Redis only.
\nThe replication group identifier. This parameter is stored as a lowercase string.
\nConstraints:
\nA name must contain from 1 to 40 alphanumeric characters or hyphens.
\nThe first character must be a letter.
\nA name cannot end with a hyphen or contain two consecutive hyphens.
\nThe replication group identifier. This parameter is stored as a lowercase\n string.
\nConstraints:
\nA name must contain from 1 to 40 alphanumeric characters or hyphens.
\nThe first character must be a letter.
\nA name cannot end with a hyphen or contain two consecutive hyphens.
\nThe identifier of the cluster that serves as the primary for this replication\n group. This cluster must already exist and have a status of available
.
This parameter is not required if NumCacheClusters
,\n NumNodeGroups
, or\n ReplicasPerNodeGroup
is specified.
The identifier of the cluster that serves as the primary for this replication group.\n This cluster must already exist and have a status of available
.
This parameter is not required if NumCacheClusters
,\n NumNodeGroups
, or ReplicasPerNodeGroup
is\n specified.
Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
\n\n AutomaticFailoverEnabled
must be enabled for Redis (cluster mode enabled) replication groups.
Default: false
" + "smithy.api#documentation": "Specifies whether a read-only replica is automatically promoted to read/write primary\n if the existing primary fails.
\n\n AutomaticFailoverEnabled
must be enabled for Redis (cluster mode enabled)\n replication groups.
Default: false
" } }, "MultiAZEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
" + "smithy.api#documentation": "A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more\n information, see Minimizing Downtime: Multi-AZ.
" } }, "NumCacheClusters": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of clusters this replication group initially has.
\nThis parameter is not used if there is more than one node group (shard). \n You should use ReplicasPerNodeGroup
instead.
If AutomaticFailoverEnabled
is true
, the value of this parameter must be at least 2.\n If AutomaticFailoverEnabled
is false
you can omit this parameter (it will default to 1), or you\n can explicitly set it to a value between 2 and 6.
The maximum permitted value for NumCacheClusters
is 6 (1 primary plus 5 replicas).
The number of clusters this replication group initially has.
\nThis parameter is not used if there is more than one node group (shard). You should\n use ReplicasPerNodeGroup
instead.
If AutomaticFailoverEnabled
is true
, the value of this\n parameter must be at least 2. If AutomaticFailoverEnabled
is\n false
you can omit this parameter (it will default to 1), or you can\n explicitly set it to a value between 2 and 6.
The maximum permitted value for NumCacheClusters
is 6 (1 primary plus 5\n replicas).
A list of EC2 Availability Zones in which the replication group's clusters are created. \n The order of the Availability Zones in the list is the order in which clusters are allocated. \n The primary cluster is created in the first AZ in the list.
\nThis parameter is not used if there is more than one node group (shard). \n You should use NodeGroupConfiguration
instead.
If you are creating your replication group in an Amazon VPC (recommended), \n you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.
\nThe number of Availability Zones listed must equal the value of NumCacheClusters
.
Default: system chosen Availability Zones.
" + "smithy.api#documentation": "A list of EC2 Availability Zones in which the replication group's clusters are\n created. The order of the Availability Zones in the list is the order in which clusters\n are allocated. The primary cluster is created in the first AZ in the list.
\nThis parameter is not used if there is more than one node group (shard). You should\n use NodeGroupConfiguration
instead.
If you are creating your replication group in an Amazon VPC (recommended), you can\n only locate clusters in Availability Zones associated with the subnets in the\n selected subnet group.
\nThe number of Availability Zones listed must equal the value of\n NumCacheClusters
.
Default: system chosen Availability Zones.
" } }, "NumNodeGroups": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. \n For Redis (cluster mode disabled) either omit this parameter or set it to 1.
\nDefault: 1
" + "smithy.api#documentation": "An optional parameter that specifies the number of node groups (shards) for this Redis\n (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit\n this parameter or set it to 1.
\nDefault: 1
" } }, "ReplicasPerNodeGroup": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "An optional parameter that specifies the number of replica nodes in each node group (shard).\n Valid values are 0 to 5.
" + "smithy.api#documentation": "An optional parameter that specifies the number of replica nodes in each node group\n (shard). Valid values are 0 to 5.
" } }, "NodeGroupConfiguration": { "target": "com.amazonaws.elasticache#NodeGroupConfigurationList", "traits": { - "smithy.api#documentation": "A list of node group (shard) configuration options. \n Each node group (shard) configuration has the following members:\n PrimaryAvailabilityZone
,\n ReplicaAvailabilityZones
,\n ReplicaCount
, and \n Slots
.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to \n individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a \n Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter \n because you must specify the slots for each node group.
" + "smithy.api#documentation": "A list of node group (shard) configuration options. Each node group (shard)\n configuration has the following members: PrimaryAvailabilityZone
,\n ReplicaAvailabilityZones
, ReplicaCount
, and\n Slots
.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled)\n replication group, you can use this parameter to individually configure each node group\n (shard), or you can omit this parameter. However, it is required when seeding a Redis\n (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group\n (shard) using this parameter because you must specify the slots for each node\n group.
" } }, "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The compute and memory capacity of the nodes in the node group (shard).
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n
\n M4 node types:\n cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n
\n T3 node types:\n cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro
\n
\n M1 node types:\n cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge
\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The compute and memory capacity of the nodes in the node group (shard).
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n
\n M4 node types:\n cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n
\n T3 node types:\n cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro
\n
\n M1 node types:\n cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge
\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1\n instances.
\nRedis configuration variables appendonly
and\n appendfsync
are not supported on Redis version 2.8.22 and\n later.
The name of the cache engine to be used for the clusters in this replication group. The value must be set to Redis
.
The name of the cache engine to be used for the clusters in this replication group.\n The value must be set to Redis
.
The version number of the cache engine to be used for the clusters in this replication group. \n To view the supported cache engine versions, use the DescribeCacheEngineVersions
operation.
\n Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, \n but you cannot downgrade to an earlier engine version.\n If you want to use an earlier engine version, \n you must delete the existing cluster or replication group and \n create it anew with the earlier engine version.
" + "smithy.api#documentation": "The version number of the cache engine to be used for the clusters in this replication\n group. To view the supported cache engine versions, use the\n DescribeCacheEngineVersions
operation.
\n Important: You can upgrade to a newer engine version\n (see Selecting\n a Cache Engine and Version) in the ElastiCache User\n Guide, but you cannot downgrade to an earlier engine version. If you want\n to use an earlier engine version, you must delete the existing cluster or replication\n group and create it anew with the earlier engine version.
" } }, "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the parameter group to associate with this replication group. \n If this argument is omitted, the default cache parameter group for the specified engine is\n used.
\nIf you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, \n we recommend that you specify the parameter group by name.
\nTo create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2
.
To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on
.
The name of the parameter group to associate with this replication group. If this\n argument is omitted, the default cache parameter group for the specified engine is\n used.
\nIf you are running Redis version 3.2.4 or later, only one node group (shard), and want\n to use a default parameter group, we recommend that you specify the parameter group by\n name.
\nTo create a Redis (cluster mode disabled) replication group, use\n CacheParameterGroupName=default.redis3.2
.
To create a Redis (cluster mode enabled) replication group, use\n CacheParameterGroupName=default.redis3.2.cluster.on
.
The name of the cache subnet group to be used for the replication group.
\nIf you're going to launch your cluster in an Amazon VPC, \n you need to create a subnet group before you start creating a cluster. \n For more information, see Subnets and Subnet Groups.
\nThe name of the cache subnet group to be used for the replication group.
\nIf you're going to launch your cluster in an Amazon VPC, you need to create a\n subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
\nOne or more Amazon VPC security groups associated with this replication group.
\nUse this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
" + "smithy.api#documentation": "One or more Amazon VPC security groups associated with this replication group.
\nUse this parameter only when you are creating a replication group in an Amazon Virtual\n Private Cloud (Amazon VPC).
" } }, "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { - "smithy.api#documentation": "A list of tags to be added to this resource. \n Tags are comma-separated key,value pairs (e.g. Key=myKey
, Value=myKeyValue
. You can include multiple tags as shown following: \n Key=myKey
, Value=myKeyValue
Key=mySecondKey
, Value=mySecondKeyValue
. Tags on replication groups will be replicated to all nodes.
A list of tags to be added to this resource. Tags are comma-separated key,value pairs\n (e.g. Key=myKey
, Value=myKeyValue
. You can include multiple\n tags as shown following: Key=myKey
, Value=myKeyValue
\n Key=mySecondKey
, Value=mySecondKeyValue
. Tags on\n replication groups will be replicated to all nodes.
A list of Amazon Resource Names (ARN) that uniquely identify \n the Redis RDB snapshot files stored in Amazon S3. \n The snapshot files are used to populate the new replication group. \n The Amazon S3 object name in the ARN cannot contain any commas. \n The new replication group will have the number of node groups (console: shards)\n specified by the parameter NumNodeGroups or the number of\n node groups configured by NodeGroupConfiguration regardless \n of the number of ARNs specified here.
\nExample of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
\n
A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot\n files stored in Amazon S3. The snapshot files are used to populate the new replication\n group. The Amazon S3 object name in the ARN cannot contain any commas. The new\n replication group will have the number of node groups (console: shards) specified by the\n parameter NumNodeGroups or the number of node groups configured by\n NodeGroupConfiguration regardless of the number of ARNs\n specified here.
\nExample of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
\n
The name of a snapshot from which to restore data into the new replication group.\n The snapshot status changes to restoring
while the new replication group is being created.
The name of a snapshot from which to restore data into the new replication group. The\n snapshot status changes to restoring
while the new replication group is\n being created.
Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.\n Valid values for ddd
are:
Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.
\nValid values for ddd
are:
\n sun
\n
\n mon
\n
\n tue
\n
\n wed
\n
\n thu
\n
\n fri
\n
\n sat
\n
Example: sun:23:00-mon:01:30
\n
Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period. Valid values for ddd
\n are:
Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.
\nValid values for ddd
are:
\n sun
\n
\n mon
\n
\n tue
\n
\n wed
\n
\n thu
\n
\n fri
\n
\n sat
\n
Example: sun:23:00-mon:01:30
\n
The port number on which each member of the replication group accepts connections.
" + "smithy.api#documentation": "The port number on which each member of the replication group accepts\n connections.
" } }, "NotificationTopicArn": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) \n topic to which notifications are sent.
\nThe Amazon SNS topic owner must be the same as the cluster owner.
\nThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic\n to which notifications are sent.
\nThe Amazon SNS topic owner must be the same as the cluster owner.
\nIf you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. \n
" + "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days for which ElastiCache retains automatic snapshots before deleting them. \n For example, if you set SnapshotRetentionLimit
to 5, \n a snapshot that was taken today is retained for 5 days before being deleted.
Default: 0 (i.e., automatic backups are disabled for this cluster).
" + "smithy.api#documentation": "The number of days for which ElastiCache retains automatic snapshots before deleting\n them. For example, if you set SnapshotRetentionLimit
to 5, a snapshot that\n was taken today is retained for 5 days before being deleted.
Default: 0 (i.e., automatic backups are disabled for this cluster).
" } }, "SnapshotWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
\nExample: 05:00-09:00
\n
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
" + "smithy.api#documentation": "The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your node group (shard).
\nExample: 05:00-09:00
\n
If you do not specify this parameter, ElastiCache automatically chooses an appropriate\n time range.
" } }, "AuthToken": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "\n Reserved parameter. \n The password used to access a password protected server.
\n\n AuthToken
can be specified only on replication groups where TransitEncryptionEnabled
is \n true
.
For HIPAA compliance, you must specify TransitEncryptionEnabled
as true
, \n an AuthToken
, and a CacheSubnetGroup
.
Password constraints:
\nMust be only printable ASCII characters.
\nMust be at least 16 characters and no more than 128\n characters in length.
\nThe only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
\nFor more information, see AUTH password at http://redis.io/commands/AUTH.
" + "smithy.api#documentation": "\n Reserved parameter. The password used to access a\n password protected server.
\n\n AuthToken
can be specified only on replication groups where\n TransitEncryptionEnabled
is true
.
For HIPAA compliance, you must specify TransitEncryptionEnabled
as\n true
, an AuthToken
, and a\n CacheSubnetGroup
.
Password constraints:
\nMust be only printable ASCII characters.
\nMust be at least 16 characters and no more than 128 characters in\n length.
\nThe only permitted printable special characters are !, &, #, $, ^, <,\n >, and -. Other printable special characters cannot be used in the AUTH\n token.
\nFor more information, see AUTH\n password at http://redis.io/commands/AUTH.
" } }, "TransitEncryptionEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "A flag that enables in-transit encryption when set to true
.
This parameter is valid only if the Engine
parameter is redis
,\n the EngineVersion
parameter is 3.2.6
, 4.x
or later,\n and the cluster is being created in an Amazon VPC.
If you enable in-transit encryption, you must also specify a value for \n CacheSubnetGroup
.
\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6
, 4.x
or later.
Default: false
\n
For HIPAA compliance, you must specify TransitEncryptionEnabled
as true
, \n an AuthToken
, and a CacheSubnetGroup
.
A flag that enables in-transit encryption when set to true
.
This parameter is valid only if the Engine
parameter is\n redis
, the EngineVersion
parameter is 3.2.6
,\n 4.x
or later, and the cluster is being created in an Amazon VPC.
If you enable in-transit encryption, you must also specify a value for\n CacheSubnetGroup
.
\n Required: Only available when creating a replication\n group in an Amazon VPC using redis version 3.2.6
, 4.x
or\n later.
Default: false
\n
For HIPAA compliance, you must specify TransitEncryptionEnabled
as\n true
, an AuthToken
, and a\n CacheSubnetGroup
.
A flag that enables encryption at rest when set to true
.
You cannot modify the value of AtRestEncryptionEnabled
after the replication\n group is created. \n To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled
to \n true
when you create the replication group.
\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6
, 4.x
or later.
Default: false
\n
A flag that enables encryption at rest when set to true
.
You cannot modify the value of AtRestEncryptionEnabled
after the\n replication group is created. To enable encryption at rest on a replication group you\n must set AtRestEncryptionEnabled
to true
when you create the\n replication group.
\n Required: Only available when creating a replication\n group in an Amazon VPC using redis version 3.2.6
, 4.x
or\n later.
Default: false
\n
Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes.\n For more information, see Data tiering.
" + "smithy.api#documentation": "Enables data tiering. Data tiering is only supported for replication groups using the\n r6gd node type. This parameter must be set to true when using r6gd nodes. For more\n information, see Data tiering.
" } }, "NetworkType": { "target": "com.amazonaws.elasticache#NetworkType", "traits": { - "smithy.api#documentation": "Must be either ipv4
| ipv6
| dual_stack
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
Must be either ipv4
| ipv6
| dual_stack
. IPv6\n is supported for workloads using Redis engine version 6.2 onward or Memcached engine\n version 1.6.6 on all instances built on the Nitro system.
The network type you choose when creating a replication group, either ipv4
| ipv6
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
The network type you choose when creating a replication group, either\n ipv4
| ipv6
. IPv6 is supported for workloads using Redis\n engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on\n the Nitro system.
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
\nWhen setting TransitEncryptionEnabled
to true
, you can set your\n TransitEncryptionMode
to preferred
in the same request, to allow\n both encrypted and unencrypted connections at the same time. Once you migrate all your Redis\n clients to use encrypted connections you can modify the value to required
to\n allow encrypted connections only.
Setting TransitEncryptionMode
to required
is a two-step\n process that requires you to first set the TransitEncryptionMode
to preferred
, \n after that you can set TransitEncryptionMode
to required
.
This process will not trigger the replacement of the replication group.
" + "smithy.api#documentation": "A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.
\nWhen setting TransitEncryptionEnabled
to true
, you can set\n your TransitEncryptionMode
to preferred
in the same request,\n to allow both encrypted and unencrypted connections at the same time. Once you migrate\n all your Redis clients to use encrypted connections you can modify the value to\n required
to allow encrypted connections only.
Setting TransitEncryptionMode
to required
is a two-step\n process that requires you to first set the TransitEncryptionMode
to\n preferred
, after that you can set TransitEncryptionMode
to\n required
.
This process will not trigger the replacement of the replication group.
" } }, "ClusterMode": { "target": "com.amazonaws.elasticache#ClusterMode", "traits": { - "smithy.api#documentation": "Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible.\n \n Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
" + "smithy.api#documentation": "Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Redis\n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.
" } } }, @@ -3980,6 +4004,9 @@ "ReplicationGroup": { "target": "com.amazonaws.elasticache#ReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#CreateSnapshot": { @@ -4023,7 +4050,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a copy of an entire cluster or replication group at a\n specific moment in time.
\nThis operation is valid for Redis only.
\nCreates a copy of an entire cluster or replication group at a specific moment in\n time.
\nThis operation is valid for Redis only.
\nThe identifier of an existing replication group. The snapshot is created from this replication group.
" + "smithy.api#documentation": "The identifier of an existing replication group. The snapshot is created from this\n replication group.
" } }, "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The identifier of an existing cluster. The snapshot is created from this cluster.
" + "smithy.api#documentation": "The identifier of an existing cluster. The snapshot is created from this\n cluster.
" } }, "SnapshotName": { @@ -4057,7 +4084,7 @@ "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { - "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
" + "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } } }, @@ -4071,6 +4098,9 @@ "Snapshot": { "target": "com.amazonaws.elasticache#Snapshot" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#CreateUser": { @@ -4105,7 +4135,7 @@ } ], "traits": { - "smithy.api#documentation": "For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC).
" + "smithy.api#documentation": "For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see\n Using Role Based Access Control (RBAC).
" } }, "com.amazonaws.elasticache#CreateUserGroup": { @@ -4143,7 +4173,7 @@ } ], "traits": { - "smithy.api#documentation": "For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC)\n
" + "smithy.api#documentation": "For Redis engine version 6.0 onwards: Creates a Redis user group. For more\n information, see Using Role Based Access Control (RBAC)\n
" } }, "com.amazonaws.elasticache#CreateUserGroupMessage": { @@ -4172,7 +4202,7 @@ "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { - "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
" + "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } } } @@ -4223,7 +4253,7 @@ "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { - "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
" + "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } }, "AuthenticationMode": { @@ -4317,27 +4347,27 @@ "target": "com.amazonaws.elasticache#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The number of node groups (shards) that results from the modification of the shard configuration
", + "smithy.api#documentation": "The number of node groups (shards) that results from the modification of the shard\n configuration
", "smithy.api#required": {} } }, "GlobalNodeGroupsToRemove": { "target": "com.amazonaws.elasticache#GlobalNodeGroupIdList", "traits": { - "smithy.api#documentation": "If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.\n \n ElastiCache for Redis will attempt to remove all node groups listed by GlobalNodeGroupsToRemove from the cluster.
" + "smithy.api#documentation": "If the value of NodeGroupCount is less than the current number of node groups\n (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.\n GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.\n ElastiCache for Redis will attempt to remove all node groups listed by\n GlobalNodeGroupsToRemove from the cluster.
" } }, "GlobalNodeGroupsToRetain": { "target": "com.amazonaws.elasticache#GlobalNodeGroupIdList", "traits": { - "smithy.api#documentation": "If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster. ElastiCache for Redis will attempt to retain all node groups listed by GlobalNodeGroupsToRetain from the cluster. \n \n\n
" + "smithy.api#documentation": "If the value of NodeGroupCount is less than the current number of node groups\n (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.\n GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster.\n ElastiCache for Redis will attempt to retain all node groups listed by\n GlobalNodeGroupsToRetain from the cluster.
" } }, "ApplyImmediately": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.
", + "smithy.api#documentation": "Indicates that the shard reconfiguration process begins immediately. At present, the\n only permitted value for this parameter is true.
", "smithy.api#required": {} } } @@ -4349,6 +4379,9 @@ "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#DecreaseReplicaCount": { @@ -4398,7 +4431,7 @@ } ], "traits": { - "smithy.api#documentation": "Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number of\n replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation\n is performed with no cluster down time.
" + "smithy.api#documentation": "Dynamically decreases the number of replicas in a Redis (cluster mode disabled)\n replication group or the number of replica nodes in one or more node groups (shards) of\n a Redis (cluster mode enabled) replication group. This operation is performed with no\n cluster down time.
" } }, "com.amazonaws.elasticache#DecreaseReplicaCountMessage": { @@ -4407,33 +4440,33 @@ "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The id of the replication group from which you want to remove replica nodes.
", + "smithy.api#documentation": "The id of the replication group from which you want to remove replica\n nodes.
", "smithy.api#required": {} } }, "NewReplicaCount": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of read replica nodes you want at the completion of this operation.\n For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the\n replication group. For Redis (cluster mode enabled) replication groups, this is the number of \n replica nodes in each of the replication group's node groups.
\nThe minimum number of replicas in a shard or replication group is:
\nRedis (cluster mode disabled)
\nIf Multi-AZ is enabled: 1
\nIf Multi-AZ is not enabled: 0
\nRedis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
\nThe number of read replica nodes you want at the completion of this operation. For\n Redis (cluster mode disabled) replication groups, this is the number of replica nodes in\n the replication group. For Redis (cluster mode enabled) replication groups, this is the\n number of replica nodes in each of the replication group's node groups.
\nThe minimum number of replicas in a shard or replication group is:
\nRedis (cluster mode disabled)
\nIf Multi-AZ is enabled: 1
\nIf Multi-AZ is not enabled: 0
\nRedis (cluster mode enabled): 0 (though you will not be able to failover to\n a replica if your primary node fails)
\nA list of ConfigureShard
objects that can be used to configure each shard\n in a Redis (cluster mode enabled) replication group. The ConfigureShard
has three members:\n NewReplicaCount
, NodeGroupId
, and PreferredAvailabilityZones
.
A list of ConfigureShard
objects that can be used to configure each\n shard in a Redis (cluster mode enabled) replication group. The\n ConfigureShard
has three members: NewReplicaCount
,\n NodeGroupId
, and PreferredAvailabilityZones
.
A list of the node ids to remove from the replication group or node group (shard).
" + "smithy.api#documentation": "A list of the node ids to remove from the replication group or node group\n (shard).
" } }, "ApplyImmediately": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "If True
, the number of replica nodes is decreased immediately. \n\n ApplyImmediately=False
is not currently supported.
If True
, the number of replica nodes is decreased immediately.\n ApplyImmediately=False
is not currently supported.
Deletes a previously provisioned cluster.\n DeleteCacheCluster
deletes all associated cache nodes, node endpoints and the\n cluster itself. When you receive a successful response from this operation,\n Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert\n this operation.
This operation is not valid for:
\nRedis (cluster mode enabled) clusters
\nRedis (cluster mode disabled) clusters
\nA cluster that is the last read replica of a replication group
\nA cluster that is the primary node of a replication group
\nA node group (shard) that has Multi-AZ mode enabled
\nA cluster from a Redis (cluster mode enabled) replication group
\nA cluster that is not in the available
state
Deletes a previously provisioned cluster. DeleteCacheCluster
deletes all\n associated cache nodes, node endpoints and the cluster itself. When you receive a\n successful response from this operation, Amazon ElastiCache immediately begins deleting\n the cluster; you cannot cancel or revert this operation.
This operation is not valid for:
\nRedis (cluster mode enabled) clusters
\nRedis (cluster mode disabled) clusters
\nA cluster that is the last read replica of a replication group
\nA cluster that is the primary node of a replication group
\nA node group (shard) that has Multi-AZ mode enabled
\nA cluster from a Redis (cluster mode enabled) replication group
\nA cluster that is not in the available
state
The cluster identifier for the cluster to be deleted. This parameter is not case sensitive.
", + "smithy.api#documentation": "The cluster identifier for the cluster to be deleted. This parameter is not case\n sensitive.
", "smithy.api#required": {} } }, "FinalSnapshotIdentifier": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. \n ElastiCache creates the snapshot, and then deletes the cluster immediately afterward.
" + "smithy.api#documentation": "The user-supplied name of a final cluster snapshot. This is the unique name that\n identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster\n immediately afterward.
" } } }, @@ -4543,6 +4579,9 @@ "CacheCluster": { "target": "com.amazonaws.elasticache#CacheCluster" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#DeleteCacheParameterGroup": { @@ -4568,7 +4607,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified cache parameter\n group. You cannot delete a cache parameter group if it is associated with any cache\n clusters. You cannot delete the default cache parameter groups in your account.
" + "smithy.api#documentation": "Deletes the specified cache parameter group. You cannot delete a cache parameter group\n if it is associated with any cache clusters. You cannot delete the default cache\n parameter groups in your account.
" } }, "com.amazonaws.elasticache#DeleteCacheParameterGroupMessage": { @@ -4577,7 +4616,7 @@ "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the cache parameter group to delete.
\nThe specified cache security group must not be associated with any clusters.
\nThe name of the cache parameter group to delete.
\nThe specified cache security group must not be associated with any\n clusters.
\nDeletes a cache security group.
\nYou cannot delete a cache security group if it is associated with any clusters.
\nDeletes a cache security group.
\nYou cannot delete a cache security group if it is associated with any\n clusters.
\nDeletes a cache subnet group.
\nYou cannot delete a default cache subnet group or one that is associated with any clusters.
\nDeletes a cache subnet group.
\nYou cannot delete a default cache subnet group or one that is associated with any\n clusters.
\nDeleting a Global datastore is a two-step process:
\nFirst, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.
\nOnce 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\n while retaining the primary by setting RetainPrimaryReplicationGroup=true
. The primary cluster is never deleted when deleting a \n 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; \n you cannot cancel or revert this operation.
" + "smithy.api#documentation": "Deleting a Global datastore is a two-step process:
\nFirst, you must DisassociateGlobalReplicationGroup to remove\n the secondary clusters in the Global datastore.
\nOnce the Global datastore contains only the primary cluster, you can use the\n DeleteGlobalReplicationGroup
API to delete the Global datastore\n while retainining the primary cluster using\n RetainPrimaryReplicationGroup=true
.
Since the Global Datastore has only a primary cluster, you can delete the Global\n Datastore while retaining the primary by setting\n RetainPrimaryReplicationGroup=true
. The primary cluster is never\n deleted when deleting a Global Datastore. It can only be deleted when it no longer is\n associated with any Global Datastore.
When you receive a successful response from this operation, Amazon ElastiCache\n immediately begins deleting the selected resources; you cannot cancel or revert this\n operation.
" } }, "com.amazonaws.elasticache#DeleteGlobalReplicationGroupMessage": { @@ -4711,6 +4750,9 @@ "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#DeleteReplicationGroup": { @@ -4745,7 +4787,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing replication group. \n By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. \n If the replication group has only one primary, \n 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; \n you cannot cancel or revert this operation.
\nThis operation is valid for Redis only.
\nDeletes an existing replication group. By default, this operation deletes the entire\n replication group, including the primary/primaries and all of the read replicas. If the\n replication group has only one primary, you can optionally delete only the read\n replicas, while retaining the primary by setting\n RetainPrimaryCluster=true
.
When you receive a successful response from this operation, Amazon ElastiCache\n immediately begins deleting the selected resources; you cannot cancel or revert this\n operation.
\nThis operation is valid for Redis only.
\nThe identifier for the cluster to be deleted. This parameter is not case sensitive.
", + "smithy.api#documentation": "The identifier for the cluster to be deleted. This parameter is not case\n sensitive.
", "smithy.api#required": {} } }, "RetainPrimaryCluster": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "If set to true
, all of the read replicas are deleted, \n but the primary node is retained.
If set to true
, all of the read replicas are deleted, but the primary\n node is retained.
The name of a final node group (shard) snapshot. \n ElastiCache creates the snapshot from the primary node in the cluster, \n rather than one of the replicas; this is to ensure that it captures the freshest data. \n After the final snapshot is taken, the replication group is immediately deleted.
" + "smithy.api#documentation": "The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from\n the primary node in the cluster, rather than one of the replicas; this is to ensure that\n it captures the freshest data. After the final snapshot is taken, the replication group\n is immediately deleted.
" } } }, @@ -4781,6 +4823,9 @@ "ReplicationGroup": { "target": "com.amazonaws.elasticache#ReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#DeleteSnapshot": { @@ -4806,7 +4851,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing snapshot. When you receive a\n successful response from this operation, ElastiCache immediately begins deleting the snapshot;\n you cannot cancel or revert this operation.
\nThis operation is valid for Redis only.
\nDeletes an existing snapshot. When you receive a successful response from this\n operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or\n revert this operation.
\nThis operation is valid for Redis only.
\nFor 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).
" + "smithy.api#documentation": "For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from\n all user groups and in turn removed from all replication groups. For more information,\n see Using Role Based Access Control (RBAC).
" } }, "com.amazonaws.elasticache#DeleteUserGroup": { @@ -4884,7 +4932,7 @@ } ], "traits": { - "smithy.api#documentation": "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).
" + "smithy.api#documentation": "For Redis engine version 6.0 onwards: Deletes a user group. The user group must first\n be disassociated from the replication group before it can be deleted. For more\n information, see Using Role Based Access Control (RBAC).
" } }, "com.amazonaws.elasticache#DeleteUserGroupMessage": { @@ -4931,7 +4979,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about all provisioned\n clusters if no cluster identifier is specified, or about a specific cache\n cluster if a cluster identifier is supplied.
\nBy default, abbreviated information about the clusters is returned. You can\n use the optional ShowCacheNodeInfo flag to retrieve detailed information about the\n cache nodes associated with the clusters. These details include the DNS address\n and port for the cache node endpoint.
\nIf the cluster is in the creating state, only cluster-level information is displayed \n until all of the nodes are successfully provisioned.
\nIf the cluster is in the deleting state, only cluster-level information is displayed.
\nIf cache nodes are currently being added to the cluster, node endpoint information\n and creation time for the additional nodes are not displayed until they are\n completely provisioned. When the cluster state is available, the cluster is\n ready for use.
\nIf cache nodes are currently being removed from the cluster, no endpoint information \n for the removed nodes is displayed.
", + "smithy.api#documentation": "Returns information about all provisioned clusters if no cluster identifier is\n specified, or about a specific cache cluster if a cluster identifier is supplied.
\nBy default, abbreviated information about the clusters is returned. You can use the\n optional ShowCacheNodeInfo flag to retrieve detailed information\n about the cache nodes associated with the clusters. These details include the DNS\n address and port for the cache node endpoint.
\nIf the cluster is in the creating state, only cluster-level\n information is displayed until all of the nodes are successfully provisioned.
\nIf the cluster is in the deleting state, only cluster-level\n information is displayed.
\nIf cache nodes are currently being added to the cluster, node endpoint information and\n creation time for the additional nodes are not displayed until they are completely\n provisioned. When the cluster state is available, the cluster is\n ready for use.
\nIf cache nodes are currently being removed from the cluster, no endpoint information\n for the removed nodes is displayed.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5093,25 +5141,25 @@ "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords
value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords
.
An optional flag that can be included in the DescribeCacheCluster
request \n to retrieve information about the individual cache nodes.
An optional flag that can be included in the DescribeCacheCluster
request\n to retrieve information about the individual cache nodes.
An optional flag that can be included in the DescribeCacheCluster
request\n to show only nodes (API/CLI: clusters) that are not members of a replication group.\n In practice, this mean Memcached and single node Redis clusters.
An optional flag that can be included in the DescribeCacheCluster
request\n to show only nodes (API/CLI: clusters) that are not members of a replication group. In\n practice, this mean Memcached and single node Redis clusters.
Returns a list of the available cache\n engines and their versions.
", + "smithy.api#documentation": "Returns a list of the available cache engines and their versions.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5143,7 +5191,7 @@ "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The cache engine to return. Valid values: memcached
| redis
\n
The cache engine to return. Valid values: memcached
|\n redis
\n
The name of a specific cache parameter group family to return details for.
\nValid values are: \n memcached1.4
| \n memcached1.5
| \n memcached1.6
| \n redis2.6
| \n redis2.8
|\n redis3.2
|\n redis4.0
|\n redis5.0
| \n redis6.x
| \n redis6.2
|\n redis7
\n
Constraints:
\nMust be 1 to 255 alphanumeric characters
\nFirst character must be a letter
\nCannot end with a hyphen or contain two consecutive hyphens
\nThe name of a specific cache parameter group family to return details for.
\nValid values are: memcached1.4
| memcached1.5
|\n memcached1.6
| redis2.6
| redis2.8
|\n redis3.2
| redis4.0
| redis5.0
|\n redis6.x
| redis6.2
| redis7
\n
Constraints:
\nMust be 1 to 255 alphanumeric characters
\nFirst character must be a letter
\nCannot end with a hyphen or contain two consecutive hyphens
\nThe maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords
value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords
.
If true
, specifies that only the default version of the specified engine or engine\n and major version combination is to be returned.
If true
, specifies that only the default version of the specified engine\n or engine and major version combination is to be returned.
Returns a list of cache parameter group\n descriptions. If a cache parameter group name is specified, the list contains only\n the descriptions for that group.
", + "smithy.api#documentation": "Returns a list of cache parameter group descriptions. If a cache parameter group name\n is specified, the list contains only the descriptions for that group.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5223,13 +5271,13 @@ "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords
value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords
.
Returns the detailed parameter list for a\n particular cache parameter group.
", + "smithy.api#documentation": "Returns the detailed parameter list for a particular cache parameter group.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5279,19 +5327,19 @@ "Source": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The parameter types to return.
\nValid values: user
| system
| engine-default
\n
The parameter types to return.
\nValid values: user
| system
|\n engine-default
\n
The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords
value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords
.
Returns a list of cache security group\n descriptions. If a cache security group name is specified, the list contains only\n the description of that group. This applicable only when you have ElastiCache in Classic setup\n
", + "smithy.api#documentation": "Returns a list of cache security group descriptions. If a cache security group name is\n specified, the list contains only the description of that group. This applicable only\n when you have ElastiCache in Classic setup
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5340,13 +5388,13 @@ "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords
value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords
.
Returns a list of cache subnet group\n descriptions. If a subnet group name is specified, the list contains only the\n description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.\n
", + "smithy.api#documentation": "Returns a list of cache subnet group descriptions. If a subnet group name is\n specified, the list contains only the description of that group. This is applicable only\n when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by\n default.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5389,13 +5437,13 @@ "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords
value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords
.
Returns the default engine and\n system parameter information for the specified cache engine.
", + "smithy.api#documentation": "Returns the default engine and system parameter information for the specified cache\n engine.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "EngineDefaults.Marker", @@ -5435,25 +5483,25 @@ "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the cache parameter group family.
\nValid values are: \n memcached1.4
| \n memcached1.5
| \n memcached1.6
| \n redis2.6
| \n redis2.8
|\n redis3.2
|\n redis4.0
|\n redis5.0
| \n redis6.x
| \n redis6.2
|\n redis7
\n
The name of the cache parameter group family.
\nValid values are: memcached1.4
| memcached1.5
|\n memcached1.6
| redis2.6
| redis2.8
|\n redis3.2
| redis4.0
| redis5.0
|\n redis6.x
| redis6.2
| redis7
\n
The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords
value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords
.
Represents the input of a DescribeEngineDefaultParameters
operation.
Represents the input of a DescribeEngineDefaultParameters
\n operation.
Returns events related to clusters, cache\n security groups, and cache parameter groups. You can obtain events specific to a\n particular cluster, cache security group, or cache parameter group by providing\n the name as a parameter.
\nBy default, only the events occurring within the last hour are returned; \n however, you can retrieve up to 14 days' worth of events if necessary.
", + "smithy.api#documentation": "Returns events related to clusters, cache security groups, and cache parameter groups.\n You can obtain events specific to a particular cluster, cache security group, or cache\n parameter group by providing the name as a parameter.
\nBy default, only the events occurring within the last hour are returned; however, you\n can retrieve up to 14 days' worth of events if necessary.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5496,25 +5547,25 @@ "SourceIdentifier": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The identifier of the event source for which events are returned. \n If not specified, all sources are included in the response.
" + "smithy.api#documentation": "The identifier of the event source for which events are returned. If not specified,\n all sources are included in the response.
" } }, "SourceType": { "target": "com.amazonaws.elasticache#SourceType", "traits": { - "smithy.api#documentation": "The event source to retrieve events for. \n If no value is specified, all events are returned.
" + "smithy.api#documentation": "The event source to retrieve events for. If no value is specified, all events are\n returned.
" } }, "StartTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
\n\n Example: 2017-03-30T07:03:49.555Z
" + "smithy.api#documentation": "The beginning of the time interval to retrieve events for, specified in ISO 8601\n format.
\n\n Example: 2017-03-30T07:03:49.555Z
" } }, "EndTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "The end of the time interval for which to retrieve events, specified in ISO 8601 format.
\n\n Example: 2017-03-30T07:03:49.555Z
" + "smithy.api#documentation": "The end of the time interval for which to retrieve events, specified in ISO 8601\n format.
\n\n Example: 2017-03-30T07:03:49.555Z
" } }, "Duration": { @@ -5526,13 +5577,13 @@ "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords
value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords
.
Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.
", + "smithy.api#documentation": "Returns information about a particular global replication group. If no identifier is\n specified, returns information about all Global datastores.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5581,13 +5632,13 @@ "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so that the\n remaining results can be retrieved.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >
" + "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords. >
" } }, "GlobalReplicationGroups": { @@ -5613,6 +5664,9 @@ "smithy.api#documentation": "Indicates the slot configuration and global identifier for each slice group.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#DescribeReplicationGroups": { @@ -5635,7 +5689,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about a particular\n replication group. If no identifier is specified, DescribeReplicationGroups
\n returns information about all replication groups.
This operation is valid for Redis only.
\nReturns information about a particular replication group. If no identifier is\n specified, DescribeReplicationGroups
returns information about all\n replication groups.
This operation is valid for Redis only.
\nThe identifier for the replication group to be described. This parameter is not case sensitive.
\nIf you do not specify this parameter, information about all replication groups is returned.
" + "smithy.api#documentation": "The identifier for the replication group to be described. This parameter is not case\n sensitive.
\nIf you do not specify this parameter, information about all replication groups is\n returned.
" } }, "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords
value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords
.
Returns information about reserved cache\n nodes for this account, or about a specified reserved cache node.
", + "smithy.api#documentation": "Returns information about reserved cache nodes for this account, or about a specified\n reserved cache node.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5765,49 +5819,49 @@ "ReservedCacheNodeId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The reserved cache node identifier filter value. \n Use this parameter to show only the reservation that matches the specified reservation ID.
" + "smithy.api#documentation": "The reserved cache node identifier filter value. Use this parameter to show only the\n reservation that matches the specified reservation ID.
" } }, "ReservedCacheNodesOfferingId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The offering identifier filter value. \n Use this parameter to show only purchased reservations matching the specified offering identifier.
" + "smithy.api#documentation": "The offering identifier filter value. Use this parameter to show only purchased\n reservations matching the specified offering identifier.
" } }, "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The cache node type filter value. \n Use this parameter to show only those reservations matching the specified cache node type.
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n
\n M4 node types:\n cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n
\n T3 node types:\n cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro
\n
\n M1 node types:\n cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge
\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The cache node type filter value. Use this parameter to show only those reservations\n matching the specified cache node type.
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n
\n M4 node types:\n cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n
\n T3 node types:\n cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro
\n
\n M1 node types:\n cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge
\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1\n instances.
\nRedis configuration variables appendonly
and\n appendfsync
are not supported on Redis version 2.8.22 and\n later.
The duration filter value, specified in years or seconds. \n Use this parameter to show only reservations for this duration.
\nValid Values: 1 | 3 | 31536000 | 94608000
\n
The duration filter value, specified in years or seconds. Use this parameter to show\n only reservations for this duration.
\nValid Values: 1 | 3 | 31536000 | 94608000
\n
The product description filter value. Use this parameter to show only those reservations matching the specified product description.
" + "smithy.api#documentation": "The product description filter value. Use this parameter to show only those\n reservations matching the specified product description.
" } }, "OfferingType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The offering type filter value. \n Use this parameter to show only the available offerings matching the specified offering type.
\nValid values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\"|\"All Upfront\"|\"Partial Upfront\"| \"No Upfront\"
\n
The offering type filter value. Use this parameter to show only the available\n offerings matching the specified offering type.
\nValid values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\"|\"All\n Upfront\"|\"Partial Upfront\"| \"No Upfront\"
\n
The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords
value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords
.
Lists available reserved cache\n node offerings.
", + "smithy.api#documentation": "Lists available reserved cache node offerings.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5850,48 +5904,48 @@ "ReservedCacheNodesOfferingId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The offering identifier filter value. \n Use this parameter to show only the available offering that matches the specified reservation identifier.
\nExample: 438012d3-4052-4cc7-b2e3-8d3372e0e706
\n
The offering identifier filter value. Use this parameter to show only the available\n offering that matches the specified reservation identifier.
\nExample: 438012d3-4052-4cc7-b2e3-8d3372e0e706
\n
The cache node type filter value. \n Use this parameter to show only the available offerings matching the specified cache node type.
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n
\n M4 node types:\n cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n
\n T3 node types:\n cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro
\n
\n M1 node types:\n cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge
\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The cache node type filter value. Use this parameter to show only the available\n offerings matching the specified cache node type.
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n
\n M4 node types:\n cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n
\n T3 node types:\n cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro
\n
\n M1 node types:\n cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge
\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1\n instances.
\nRedis configuration variables appendonly
and\n appendfsync
are not supported on Redis version 2.8.22 and\n later.
Duration filter value, specified in years or seconds. \n Use this parameter to show only reservations for a given duration.
\nValid Values: 1 | 3 | 31536000 | 94608000
\n
Duration filter value, specified in years or seconds. Use this parameter to show only\n reservations for a given duration.
\nValid Values: 1 | 3 | 31536000 | 94608000
\n
The product description filter value. \n Use this parameter to show only the available offerings matching the specified product description.
" + "smithy.api#documentation": "The product description filter value. Use this parameter to show only the available\n offerings matching the specified product description.
" } }, "OfferingType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The offering type filter value. \n Use this parameter to show only the available offerings matching the specified offering type.
\nValid Values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\" |\"All Upfront\"|\"Partial Upfront\"| \"No Upfront\"
\n
The offering type filter value. Use this parameter to show only the available\n offerings matching the specified offering type.
\nValid Values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\" |\"All\n Upfront\"|\"Partial Upfront\"| \"No Upfront\"
\n
The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords
value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords
.
Represents the input of a DescribeReservedCacheNodesOfferings
operation.
Represents the input of a DescribeReservedCacheNodesOfferings
\n operation.
An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords
.
Returns information about cluster or replication group snapshots.\n By default, DescribeSnapshots
lists all of your snapshots; it can optionally\n describe a single snapshot, or just the snapshots associated with a particular cache\n cluster.
This operation is valid for Redis only.
\nReturns information about cluster or replication group snapshots. By default,\n DescribeSnapshots
lists all of your snapshots; it can optionally\n describe a single snapshot, or just the snapshots associated with a particular cache\n cluster.
This operation is valid for Redis only.
\nAn optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords
.
A list of snapshots. Each item in the list contains detailed information about one snapshot.
" + "smithy.api#documentation": "A list of snapshots. Each item in the list contains detailed information about one\n snapshot.
" } } }, @@ -6010,43 +6064,43 @@ "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "A user-supplied replication group identifier.\n If this parameter is specified, only snapshots associated with that specific replication group are described.
" + "smithy.api#documentation": "A user-supplied replication group identifier. If this parameter is specified, only\n snapshots associated with that specific replication group are described.
" } }, "CacheClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "A user-supplied cluster identifier. \n If this parameter is specified, only snapshots associated with that specific cluster are described.
" + "smithy.api#documentation": "A user-supplied cluster identifier. If this parameter is specified, only snapshots\n associated with that specific cluster are described.
" } }, "SnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "A user-supplied name of the snapshot. \n If this parameter is specified, only this snapshot are described.
" + "smithy.api#documentation": "A user-supplied name of the snapshot. If this parameter is specified, only this\n snapshot are described.
" } }, "SnapshotSource": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "If set to system
, the output shows snapshots that were automatically created by ElastiCache. \n If set to user
the output shows snapshots that were manually created. \n If omitted, the output shows both automatically and manually created snapshots.
If set to system
, the output shows snapshots that were automatically\n created by ElastiCache. If set to user
the output shows snapshots that were\n manually created. If omitted, the output shows both automatically and manually created\n snapshots.
An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords
.
The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords
value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 50
\nConstraints: minimum 20; maximum 50.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords
value, a marker is included in the response so\n that the remaining results can be retrieved.
Default: 50
\nConstraints: minimum 20; maximum 50.
" } }, "ShowNodeGroupConfig": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
" + "smithy.api#documentation": "A Boolean value which if true, the node group (shard) configuration is included in the\n snapshot description.
" } } }, @@ -6116,7 +6170,7 @@ "ServiceUpdateTimeRange": { "target": "com.amazonaws.elasticache#TimeRangeFilter", "traits": { - "smithy.api#documentation": "The range of time specified to search for service updates that are in available status
" + "smithy.api#documentation": "The range of time specified to search for service updates that are in available\n status
" } }, "UpdateActionStatus": { @@ -6140,7 +6194,7 @@ "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords
.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so that the\n remaining results can be retrieved.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >
" + "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords. >
" } } } @@ -6209,9 +6263,12 @@ "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >
" + "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords. >
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#DescribeUsers": { @@ -6267,13 +6324,13 @@ "MaxRecords": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
" + "smithy.api#documentation": "The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a marker is included in the response so that the\n remaining results can be retrieved.
" } }, "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >
" + "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords. >
" } } } @@ -6290,9 +6347,12 @@ "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >
" + "smithy.api#documentation": "An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords. >
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#DestinationDetails": { @@ -6312,7 +6372,7 @@ } }, "traits": { - "smithy.api#documentation": "Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
" + "smithy.api#documentation": "Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose\n destination.
" } }, "com.amazonaws.elasticache#DestinationType": { @@ -6355,7 +6415,7 @@ } ], "traits": { - "smithy.api#documentation": "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.
" + "smithy.api#documentation": "Remove a secondary cluster from the Global datastore using the Global datastore name.\n The secondary cluster will no longer receive updates from the primary cluster, but will\n remain as a standalone cluster in that Amazon region.
" } }, "com.amazonaws.elasticache#DisassociateGlobalReplicationGroupMessage": { @@ -6378,7 +6438,7 @@ "ReplicationGroupRegion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The Amazon region of secondary cluster you wish to remove from the Global datastore
", + "smithy.api#documentation": "The Amazon region of secondary cluster you wish to remove from the Global\n datastore
", "smithy.api#required": {} } } @@ -6390,6 +6450,9 @@ "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#Double": { @@ -6468,7 +6531,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the information required for client programs to connect to a cache node.
" + "smithy.api#documentation": "Represents the information required for client programs to connect to a cache\n node.
" } }, "com.amazonaws.elasticache#EngineDefaults": { @@ -6477,7 +6540,7 @@ "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "Specifies the name of the cache parameter group family to which the engine default parameters apply.
\nValid values are: \n memcached1.4
| \n memcached1.5
| \n memcached1.6
| \n redis2.6
| \n redis2.8
|\n redis3.2
|\n redis4.0
|\n redis5.0
| \n redis6.0
| \n redis6.x
| \n redis7
\n
Specifies the name of the cache parameter group family to which the engine default\n parameters apply.
\nValid values are: memcached1.4
| memcached1.5
|\n memcached1.6
| redis2.6
| redis2.8
|\n redis3.2
| redis4.0
| redis5.0
|\n redis6.0
| redis6.x
| redis7
\n
A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.
" + "smithy.api#documentation": "A list of parameters specific to a particular cache node type. Each element in the\n list contains detailed information about one parameter.
" } } }, "traits": { - "smithy.api#documentation": "Represents the output of a DescribeEngineDefaultParameters
operation.
Represents the output of a DescribeEngineDefaultParameters
\n operation.
The identifier for the source of the event. \n For example, if the event occurred at the cluster level, \n the identifier would be the name of the cluster.
" + "smithy.api#documentation": "The identifier for the source of the event. For example, if the event occurred at the\n cluster level, the identifier would be the name of the cluster.
" } }, "SourceType": { "target": "com.amazonaws.elasticache#SourceType", "traits": { - "smithy.api#documentation": "Specifies the origin of this event - a cluster, a parameter group, a security group, etc.
" + "smithy.api#documentation": "Specifies the origin of this event - a cluster, a parameter group, a security group,\n etc.
" } }, "Message": { @@ -6538,7 +6601,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents a single occurrence of something interesting within the system. \n Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.
" + "smithy.api#documentation": "Represents a single occurrence of something interesting within the system. Some\n examples of events are creating a cluster, adding or removing a cache node, or rebooting\n a node.
" } }, "com.amazonaws.elasticache#EventList": { @@ -6562,7 +6625,7 @@ "Events": { "target": "com.amazonaws.elasticache#EventList", "traits": { - "smithy.api#documentation": "A list of events. Each element in the list contains detailed information about one event.
" + "smithy.api#documentation": "A list of events. Each element in the list contains detailed information about one\n event.
" } } }, @@ -6596,7 +6659,7 @@ } ], "traits": { - "smithy.api#documentation": "Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.
" + "smithy.api#documentation": "Used to failover the primary region to a secondary region. The secondary region will\n become primary, and all other clusters will become secondary.
" } }, "com.amazonaws.elasticache#FailoverGlobalReplicationGroupMessage": { @@ -6631,6 +6694,9 @@ "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#Filter": { @@ -6782,19 +6848,19 @@ "AuthTokenEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "A flag that enables using an AuthToken
(password)\n when issuing Redis commands.
Default: false
\n
A flag that enables using an AuthToken
(password) when issuing Redis\n commands.
Default: false
\n
A flag that enables in-transit encryption when set to true.
\n\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6
, 4.x
or later.
A flag that enables in-transit encryption when set to true.
\n\n Required: Only available when creating a replication\n group in an Amazon VPC using redis version 3.2.6
, 4.x
or\n later.
A flag that enables encryption at rest when set to true
.
You cannot modify the value of AtRestEncryptionEnabled
after the replication\n group is created. \n To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled
to \n true
when you create the replication group.
\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6
, 4.x
or later.
A flag that enables encryption at rest when set to true
.
You cannot modify the value of AtRestEncryptionEnabled
after the\n replication group is created. To enable encryption at rest on a replication group you\n must set AtRestEncryptionEnabled
to true
when you create the\n replication group.
\n Required: Only available when creating a replication\n group in an Amazon VPC using redis version 3.2.6
, 4.x
or\n later.
Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary\n cluster automatically replicates updates to the secondary cluster.
\nThe GlobalReplicationGroupIdSuffix represents the name of the Global datastore,\n which is what you use to associate a secondary cluster.
\nConsists of a primary cluster that accepts writes and an associated secondary cluster\n that resides in a different Amazon region. The secondary cluster accepts only reads. The\n primary cluster automatically replicates updates to the secondary cluster.
\nThe GlobalReplicationGroupIdSuffix represents\n the name of the Global datastore, which is what you use to associate a secondary\n cluster.
\nThe role of the replication group in a Global datastore. Can be primary or secondary.
" + "smithy.api#documentation": "The role of the replication group in a Global datastore. Can be primary or\n secondary.
" } } }, "traits": { - "smithy.api#documentation": "The name of the Global datastore and role of this replication group in the Global datastore.
" + "smithy.api#documentation": "The name of the Global datastore and role of this replication group in the Global\n datastore.
" } }, "com.amazonaws.elasticache#GlobalReplicationGroupList": { @@ -6889,7 +6955,7 @@ } }, "traits": { - "smithy.api#documentation": "A member of a Global datastore. It contains the Replication Group Id, the Amazon region and the role of the replication group.
" + "smithy.api#documentation": "A member of a Global datastore. It contains the Replication Group Id, the Amazon\n region and the role of the replication group.
" } }, "com.amazonaws.elasticache#GlobalReplicationGroupMemberList": { @@ -6955,21 +7021,21 @@ "target": "com.amazonaws.elasticache#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The number of node groups you wish to add
", + "smithy.api#documentation": "Total number of node groups you want
", "smithy.api#required": {} } }, "RegionalConfigurations": { "target": "com.amazonaws.elasticache#RegionalConfigurationList", "traits": { - "smithy.api#documentation": "Describes the replication group IDs, the Amazon regions where they are stored and the shard configuration for each that comprise the Global datastore
" + "smithy.api#documentation": "Describes the replication group IDs, the Amazon regions where they are stored and the\n shard configuration for each that comprise the Global datastore
" } }, "ApplyImmediately": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates that the process begins immediately. At present, the only permitted value for this parameter is true.
", + "smithy.api#documentation": "Indicates that the process begins immediately. At present, the only permitted value\n for this parameter is true.
", "smithy.api#required": {} } } @@ -6981,6 +7047,9 @@ "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#IncreaseReplicaCount": { @@ -7030,7 +7099,7 @@ } ], "traits": { - "smithy.api#documentation": "Dynamically increases the number of replicas in a Redis (cluster mode disabled) replication group or the number of\n replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation\n is performed with no cluster down time.
" + "smithy.api#documentation": "Dynamically increases the number of replicas in a Redis (cluster mode disabled)\n replication group or the number of replica nodes in one or more node groups (shards) of\n a Redis (cluster mode enabled) replication group. This operation is performed with no\n cluster down time.
" } }, "com.amazonaws.elasticache#IncreaseReplicaCountMessage": { @@ -7046,20 +7115,20 @@ "NewReplicaCount": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of read replica nodes you want at the completion of this operation.\n For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the\n replication group. For Redis (cluster mode enabled) replication groups, this is the number of \n replica nodes in each of the replication group's node groups.
" + "smithy.api#documentation": "The number of read replica nodes you want at the completion of this operation. For\n Redis (cluster mode disabled) replication groups, this is the number of replica nodes in\n the replication group. For Redis (cluster mode enabled) replication groups, this is the\n number of replica nodes in each of the replication group's node groups.
" } }, "ReplicaConfiguration": { "target": "com.amazonaws.elasticache#ReplicaConfigurationList", "traits": { - "smithy.api#documentation": "A list of ConfigureShard
objects that can be used to configure each shard\n in a Redis (cluster mode enabled) replication group. The ConfigureShard
has three members:\n NewReplicaCount
, NodeGroupId
, and PreferredAvailabilityZones
.
A list of ConfigureShard
objects that can be used to configure each\n shard in a Redis (cluster mode enabled) replication group. The\n ConfigureShard
has three members: NewReplicaCount
,\n NodeGroupId
, and PreferredAvailabilityZones
.
If True
, the number of replica nodes is increased immediately. \n\n ApplyImmediately=False
is not currently supported.
If True
, the number of replica nodes is increased immediately.\n ApplyImmediately=False
is not currently supported.
The requested cache node type is not available in the specified Availability Zone.\n For more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
", + "smithy.api#documentation": "The requested cache node type is not available in the specified Availability Zone. For\n more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7134,7 +7206,7 @@ "code": "InvalidARN", "httpResponseCode": 400 }, - "smithy.api#documentation": "The requested Amazon Resource Name (ARN) does not refer to an existing resource.
", + "smithy.api#documentation": "The requested Amazon Resource Name (ARN) does not refer to an existing\n resource.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7168,7 +7240,7 @@ "code": "InvalidCacheParameterGroupState", "httpResponseCode": 400 }, - "smithy.api#documentation": "The current state of the cache parameter group does not allow the requested operation to occur.
", + "smithy.api#documentation": "The current state of the cache parameter group does not allow the requested operation\n to occur.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7293,7 +7365,7 @@ "code": "InvalidSnapshotState", "httpResponseCode": 400 }, - "smithy.api#documentation": "The current state of the snapshot does not allow the requested operation to occur.
", + "smithy.api#documentation": "The current state of the snapshot does not allow the requested operation to\n occur.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7426,7 +7498,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all available node types that you\n can scale your Redis cluster's or replication group's current node type.
\nWhen you use the ModifyCacheCluster
or ModifyReplicationGroup
operations to\n scale your cluster or replication group, the value of the CacheNodeType
parameter\n must be one of the node types returned by this operation.
Lists all available node types that you can scale your Redis cluster's or replication\n group's current node type.
\nWhen you use the ModifyCacheCluster
or\n ModifyReplicationGroup
operations to scale your cluster or replication\n group, the value of the CacheNodeType
parameter must be one of the node\n types returned by this operation.
The name of the cluster you want to scale up to a larger node instanced type. \n ElastiCache uses the cluster id to identify the current node type of this cluster and from that to create a list of node types you can scale up to.
\nYou must provide a value for either the CacheClusterId
or the\n ReplicationGroupId
.
The name of the cluster you want to scale up to a larger node instanced type.\n ElastiCache uses the cluster id to identify the current node type of this cluster and\n from that to create a list of node types you can scale up to.
\nYou must provide a value for either the CacheClusterId
or the\n ReplicationGroupId
.
The name of the replication group want to scale up to a larger node type.\n ElastiCache uses the replication group id to identify the current node type being used by\n this replication group, and from that to create a list of node types you can scale up to.
\nYou must provide a value for either the CacheClusterId
or the\n ReplicationGroupId
.
The name of the replication group want to scale up to a larger node type. ElastiCache\n uses the replication group id to identify the current node type being used by this\n replication group, and from that to create a list of node types you can scale up\n to.
\nYou must provide a value for either the CacheClusterId
or the\n ReplicationGroupId
.
The input parameters for the ListAllowedNodeTypeModifications
operation.
The input parameters for the ListAllowedNodeTypeModifications
\n operation.
Lists all tags currently on a named resource.
\nA tag is a key-value pair where the key and value are case-sensitive. \n 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. \n For more information, see Resource-level permissions.
\nIf the cluster is not in the available state, ListTagsForResource
\n returns an error.
Lists all tags currently on a named resource.
\nA tag is a key-value pair where the key and value are case-sensitive. You can use\n tags to categorize and track all your ElastiCache resources, with the exception of\n global replication group. When you add or remove tags on replication groups, those\n actions will be replicated to all nodes in the replication group. For more information,\n see Resource-level permissions.
\nIf the cluster is not in the available state,\n ListTagsForResource
returns an error.
The Amazon Resource Name (ARN) of the resource for which you want the list of tags, \n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
\n or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot
.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which you want the list of tags,\n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
or\n arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot
.
For more information about ARNs, see Amazon Resource Names (ARNs)\n and Amazon Web\n Services Service Namespaces.
", "smithy.api#required": {} } } @@ -7517,19 +7589,19 @@ "LogType": { "target": "com.amazonaws.elasticache#LogType", "traits": { - "smithy.api#documentation": "Refers to slow-log or engine-log.
" + "smithy.api#documentation": "Refers to slow-log or\n engine-log.
" } }, "DestinationType": { "target": "com.amazonaws.elasticache#DestinationType", "traits": { - "smithy.api#documentation": "Returns the destination type, either cloudwatch-logs
or kinesis-firehose
.
Returns the destination type, either cloudwatch-logs
or\n kinesis-firehose
.
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
" + "smithy.api#documentation": "Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose\n destination.
" } }, "LogFormat": { @@ -7541,7 +7613,7 @@ "Status": { "target": "com.amazonaws.elasticache#LogDeliveryConfigurationStatus", "traits": { - "smithy.api#documentation": "Returns the log delivery configuration status. Values are one of enabling
| disabling
| modifying
| active
| error
\n
Returns the log delivery configuration status. Values are one of enabling
\n | disabling
| modifying
| active
|\n error
\n
Refers to slow-log or engine-log..
" + "smithy.api#documentation": "Refers to slow-log or\n engine-log..
" } }, "DestinationType": { "target": "com.amazonaws.elasticache#DestinationType", "traits": { - "smithy.api#documentation": "Specify either cloudwatch-logs
or kinesis-firehose
as the destination type.
Specify either cloudwatch-logs
or kinesis-firehose
as the\n destination type.
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
" + "smithy.api#documentation": "Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose\n destination.
" } }, "LogFormat": { @@ -7724,7 +7796,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the settings for a cluster. You\n can use this operation to change one or more cluster configuration parameters by\n specifying the parameters and the new values.
" + "smithy.api#documentation": "Modifies the settings for a cluster. You can use this operation to change one or more\n cluster configuration parameters by specifying the parameters and the new values.
" } }, "com.amazonaws.elasticache#ModifyCacheClusterMessage": { @@ -7740,55 +7812,55 @@ "NumCacheNodes": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of cache nodes that the cluster should have. \n If the value for NumCacheNodes
is greater than the sum of the number of current cache nodes and \n the number of cache nodes pending creation (which may be zero), more nodes are added. \n If the value is less than the number of existing cache nodes, nodes are removed. \n If the value is equal to the number of current cache nodes, \n any pending add or remove requests are canceled.
If you are removing cache nodes, you must\n use the CacheNodeIdsToRemove
parameter to provide the IDs of the specific cache nodes to remove.
For clusters running Redis, this value must be 1. \n For clusters running Memcached, this value must be between 1 and 40.
\nAdding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately
).
A pending operation to modify the number of cache nodes in a cluster during its maintenance window, \n whether by adding or removing nodes in accordance with the scale out architecture, is not queued. \n The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the \n number of cache nodes in the cluster. \n For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. \n Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. \n As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, \n a request to add nodes does not automatically override a previous pending operation to add nodes. \n The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and \n retry the new request. \n To cancel pending operations to modify the number of cache nodes in a cluster, \n use the ModifyCacheCluster
request and \n set NumCacheNodes
equal to the number of cache nodes currently in the cluster.
The number of cache nodes that the cluster should have. If the value for\n NumCacheNodes
is greater than the sum of the number of current cache\n nodes and the number of cache nodes pending creation (which may be zero), more nodes are\n added. If the value is less than the number of existing cache nodes, nodes are removed.\n If the value is equal to the number of current cache nodes, any pending add or remove\n requests are canceled.
If you are removing cache nodes, you must use the CacheNodeIdsToRemove
\n parameter to provide the IDs of the specific cache nodes to remove.
For clusters running Redis, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.
\nAdding or removing Memcached cache nodes can be applied immediately or as a\n pending operation (see ApplyImmediately
).
A pending operation to modify the number of cache nodes in a cluster during its\n maintenance window, whether by adding or removing nodes in accordance with the scale\n out architecture, is not queued. The customer's latest request to add or remove\n nodes to the cluster overrides any previous pending operations to modify the number\n of cache nodes in the cluster. For example, a request to remove 2 nodes would\n override a previous pending operation to remove 3 nodes. Similarly, a request to add\n 2 nodes would override a previous pending operation to remove 3 nodes and vice\n versa. As Memcached cache nodes may now be provisioned in different Availability\n Zones with flexible cache node placement, a request to add nodes does not\n automatically override a previous pending operation to add nodes. The customer can\n modify the previous pending operation to add more nodes or explicitly cancel the\n pending request and retry the new request. To cancel pending operations to modify\n the number of cache nodes in a cluster, use the ModifyCacheCluster
\n request and set NumCacheNodes
equal to the number of cache nodes\n currently in the cluster.
A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002,\n etc.). This parameter is only valid when NumCacheNodes
is less than the existing number\n of cache nodes. The number of cache node IDs supplied in this parameter must match the\n difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is\n greater, and the value of NumCacheNodes
in the request.
For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this \n ModifyCacheCluster
call is 5, you must list 2 (7 - 5) cache node IDs to remove.
A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002,\n etc.). This parameter is only valid when NumCacheNodes
is less than the\n existing number of cache nodes. The number of cache node IDs supplied in this parameter\n must match the difference between the existing number of cache nodes in the cluster or\n pending cache nodes, whichever is greater, and the value of NumCacheNodes
\n in the request.
For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number\n of cache nodes in this ModifyCacheCluster
call is 5, you must list 2 (7 -\n 5) cache node IDs to remove.
Specifies whether the new nodes in this Memcached cluster are all created in a \n single Availability Zone or created across multiple Availability Zones.
\nValid values: single-az
| cross-az
.
This option is only supported for Memcached clusters.
\nYou cannot specify single-az
if the Memcached cluster already has cache nodes in different Availability Zones. \n If cross-az
is specified, existing Memcached nodes remain in their current Availability Zone.
Only newly created nodes are located in different Availability Zones. \n
\nSpecifies whether the new nodes in this Memcached cluster are all created in a single\n Availability Zone or created across multiple Availability Zones.
\nValid values: single-az
| cross-az
.
This option is only supported for Memcached clusters.
\nYou cannot specify single-az
if the Memcached cluster already has\n cache nodes in different Availability Zones. If cross-az
is specified,\n existing Memcached nodes remain in their current Availability Zone.
Only newly created nodes are located in different Availability Zones.
\nThis option is only supported on Memcached clusters.
\nThe list of Availability Zones where the new Memcached cache nodes are created.
\nThis parameter is only valid when NumCacheNodes
in the request is greater \n than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). \n The number of Availability Zones supplied in this list must match the cache nodes being added in this request.
Scenarios:
\n\n Scenario 1: You have 3 active nodes and wish to add 2 nodes. \n Specify NumCacheNodes=5
(3 + 2) and optionally specify two Availability Zones \n for the two new nodes.
\n Scenario 2: You have 3 active nodes and 2 nodes pending creation \n (from the scenario 1 call) and want to add 1 more node. \n Specify NumCacheNodes=6
((3 + 2) + 1) and \n optionally specify an Availability Zone for the new node.
\n Scenario 3: You want to cancel all pending operations. \n Specify NumCacheNodes=3
to cancel all pending operations.
The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, \n add 0 nodes by setting NumCacheNodes
to the number of current nodes.
If cross-az
is specified, existing Memcached nodes remain in their current Availability Zone. \n Only newly created nodes can be located in different Availability Zones. \n For guidance on how to move existing Memcached nodes to different Availability Zones, see the\n Availability Zone Considerations section of Cache Node Considerations for Memcached.
\n Impact of new add/remove requests upon pending requests\n
\nScenario-1
\nPending Action: Delete
\nNew Request: Delete
\nResult: The new delete, pending or immediate, replaces the pending delete.
\nScenario-2
\nPending Action: Delete
\nNew Request: Create
\nResult: The new create, pending or immediate, replaces the pending delete.
\nScenario-3
\nPending Action: Create
\nNew Request: Delete
\nResult: The new delete, pending or immediate, replaces the pending create.
\nScenario-4
\nPending Action: Create
\nNew Request: Create
\nResult: The new create is added to the pending create.
\n\n Important:\n If the new create request is Apply Immediately - Yes, \n all creates are performed immediately. \n If the new create request is Apply Immediately - No, \n all creates are pending.
\nThis option is only supported on Memcached clusters.
\nThe list of Availability Zones where the new Memcached cache nodes are created.
\nThis parameter is only valid when NumCacheNodes
in the request is greater\n than the sum of the number of active cache nodes and the number of cache nodes pending\n creation (which may be zero). The number of Availability Zones supplied in this list\n must match the cache nodes being added in this request.
Scenarios:
\n\n Scenario 1: You have 3 active nodes and wish\n to add 2 nodes. Specify NumCacheNodes=5
(3 + 2) and optionally\n specify two Availability Zones for the two new nodes.
\n Scenario 2: You have 3 active nodes and 2\n nodes pending creation (from the scenario 1 call) and want to add 1 more node.\n Specify NumCacheNodes=6
((3 + 2) + 1) and optionally specify an\n Availability Zone for the new node.
\n Scenario 3: You want to cancel all pending\n operations. Specify NumCacheNodes=3
to cancel all pending\n operations.
The Availability Zone placement of nodes pending creation cannot be modified. If you\n wish to cancel any nodes pending creation, add 0 nodes by setting\n NumCacheNodes
to the number of current nodes.
If cross-az
is specified, existing Memcached nodes remain in their\n current Availability Zone. Only newly created nodes can be located in different\n Availability Zones. For guidance on how to move existing Memcached nodes to different\n Availability Zones, see the Availability Zone\n Considerations section of Cache Node\n Considerations for Memcached.
\n Impact of new add/remove requests upon pending requests\n
\nScenario-1
\nPending Action: Delete
\nNew Request: Delete
\nResult: The new delete, pending or immediate, replaces the pending\n delete.
\nScenario-2
\nPending Action: Delete
\nNew Request: Create
\nResult: The new create, pending or immediate, replaces the pending\n delete.
\nScenario-3
\nPending Action: Create
\nNew Request: Delete
\nResult: The new delete, pending or immediate, replaces the pending\n create.
\nScenario-4
\nPending Action: Create
\nNew Request: Create
\nResult: The new create is added to the pending create.
\n\n Important: If the new create\n request is Apply Immediately - Yes,\n all creates are performed immediately. If the new create request is\n Apply Immediately - No, all\n creates are pending.
\nA list of cache security group names to authorize on this cluster. \n This change is asynchronously applied as soon as possible.
\nYou can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).
\nConstraints: Must contain no more than 255 alphanumeric characters. Must not be \"Default\".
" + "smithy.api#documentation": "A list of cache security group names to authorize on this cluster. This change is\n asynchronously applied as soon as possible.
\nYou can use this parameter only with clusters that are created outside of an Amazon\n Virtual Private Cloud (Amazon VPC).
\nConstraints: Must contain no more than 255 alphanumeric characters. Must not be\n \"Default\".
" } }, "SecurityGroupIds": { "target": "com.amazonaws.elasticache#SecurityGroupIdsList", "traits": { - "smithy.api#documentation": "Specifies the VPC Security Groups associated with the cluster.
\nThis parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).
" + "smithy.api#documentation": "Specifies the VPC Security Groups associated with the cluster.
\nThis parameter can be used only with clusters that are created in an Amazon Virtual\n Private Cloud (Amazon VPC).
" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.
\nValid values for ddd
are:
\n sun
\n
\n mon
\n
\n tue
\n
\n wed
\n
\n thu
\n
\n fri
\n
\n sat
\n
Example: sun:23:00-mon:01:30
\n
Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.
\nValid values for ddd
are:
\n sun
\n
\n mon
\n
\n tue
\n
\n wed
\n
\n thu
\n
\n fri
\n
\n sat
\n
Example: sun:23:00-mon:01:30
\n
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
\nThe Amazon SNS topic owner must be same as the cluster owner.
\nThe Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are\n sent.
\nThe Amazon SNS topic owner must be same as the cluster owner.
\nThe name of the cache parameter group to apply to this cluster. This change is\n asynchronously applied as soon as possible for parameters when the\n ApplyImmediately
parameter is specified as true
for this request.
The name of the cache parameter group to apply to this cluster. This change is\n asynchronously applied as soon as possible for parameters when the\n ApplyImmediately
parameter is specified as true
for this\n request.
If true
, this parameter causes the modifications in this request and any\n pending modifications to be applied, asynchronously and as soon as possible, regardless\n of the PreferredMaintenanceWindow
setting for the cluster.
If false
, changes to the cluster are applied on the next\n maintenance reboot, or the next failure reboot, whichever occurs first.
If you perform a ModifyCacheCluster
before a pending modification is applied, \n the pending modification is replaced by the newer modification.
Valid values: true
| false
\n
Default: false
\n
If true
, this parameter causes the modifications in this request and any\n pending modifications to be applied, asynchronously and as soon as possible, regardless\n of the PreferredMaintenanceWindow
setting for the cluster.
If false
, changes to the cluster are applied on the next maintenance\n reboot, or the next failure reboot, whichever occurs first.
If you perform a ModifyCacheCluster
before a pending modification is\n applied, the pending modification is replaced by the newer modification.
Valid values: true
| false
\n
Default: false
\n
The upgraded version of the cache engine to be run on the cache nodes.
\n\n Important: You can upgrade to a newer engine version \n (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version.\n If you want to use an earlier engine version, \n you must delete the existing cluster and create it anew with the earlier engine version.
" + "smithy.api#documentation": "The upgraded version of the cache engine to be run on the cache nodes.
\n\n Important: You can upgrade to a newer engine version\n (see Selecting\n a Cache Engine and Version), but you cannot downgrade to an earlier engine\n version. If you want to use an earlier engine version, you must delete the existing\n cluster and create it anew with the earlier engine version.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. \n
" + "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit
to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.
If the value of SnapshotRetentionLimit
is set to zero (0), backups are turned off.
The number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit
to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.
If the value of SnapshotRetentionLimit
is set to zero (0), backups\n are turned off.
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of\n your cluster.
" + "smithy.api#documentation": "The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your cluster.
" } }, "CacheNodeType": { @@ -7837,13 +7909,13 @@ "AuthToken": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update
parameter.\n Password constraints:
Must be only printable ASCII characters
\nMust be at least 16 characters and no more than 128 characters in length
\nCannot contain any of the following characters: '/', '\"', or '@', '%'
\n\n \n For more information, see AUTH password at AUTH.
" + "smithy.api#documentation": "Reserved parameter. The password used to access a password protected server. This\n parameter must be specified with the auth-token-update
parameter. Password\n constraints:
Must be only printable ASCII characters
\nMust be at least 16 characters and no more than 128 characters in\n length
\nCannot contain any of the following characters: '/', '\"', or '@', '%'
\nFor more information, see AUTH password at AUTH.
" } }, "AuthTokenUpdateStrategy": { "target": "com.amazonaws.elasticache#AuthTokenUpdateStrategyType", "traits": { - "smithy.api#documentation": "Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token
parameter.\n Possible values:
Rotate
\nSet
\n\n For more information, see Authenticating Users with Redis AUTH\n
" + "smithy.api#documentation": "Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the auth-token
parameter. Possible values:
Rotate
\nSet
\nFor more information, see Authenticating Users with Redis AUTH\n
" } }, "LogDeliveryConfigurations": { @@ -7855,7 +7927,7 @@ "IpDiscovery": { "target": "com.amazonaws.elasticache#IpDiscovery", "traits": { - "smithy.api#documentation": "The network type you choose when modifying a cluster, either ipv4
| ipv6
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
The network type you choose when modifying a cluster, either ipv4
|\n ipv6
. IPv6 is supported for workloads using Redis engine version 6.2\n onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
Modifies the parameters of a cache\n parameter group. You can modify up to 20 parameters in a single request by submitting a\n list parameter name and value pairs.
" + "smithy.api#documentation": "Modifies the parameters of a cache parameter group. You can modify up to 20 parameters\n in a single request by submitting a list parameter name and value pairs.
" } }, "com.amazonaws.elasticache#ModifyCacheParameterGroupMessage": { @@ -7913,7 +7988,7 @@ "ParameterNameValues": { "target": "com.amazonaws.elasticache#ParameterNameValueList", "traits": { - "smithy.api#documentation": "An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.
", + "smithy.api#documentation": "An array of parameter names and values for the parameter update. You must supply at\n least one parameter name and value; subsequent arguments are optional. A maximum of 20\n parameters may be modified per request.
", "smithy.api#required": {} } } @@ -7957,7 +8032,7 @@ "CacheSubnetGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name for the cache subnet group. This value is stored as a lowercase string.
\nConstraints: Must contain no more than 255 alphanumeric characters or hyphens.
\nExample: mysubnetgroup
\n
The name for the cache subnet group. This value is stored as a lowercase\n string.
\nConstraints: Must contain no more than 255 alphanumeric characters or hyphens.
\nExample: mysubnetgroup
\n
This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global \n Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.\n
", + "smithy.api#documentation": "This parameter causes the modifications in this request and any pending modifications\n to be applied, asynchronously and as soon as possible. Modifications to Global\n Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.\n
", "smithy.api#required": {} } }, @@ -8036,13 +8114,13 @@ "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The upgraded version of the cache engine to be run on the clusters in the Global datastore.
" + "smithy.api#documentation": "The upgraded version of the cache engine to be run on the clusters in the Global\n datastore.
" } }, "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.
" + "smithy.api#documentation": "The name of the cache parameter group to use with the Global datastore. It must be\n compatible with the major engine version used by the Global datastore.
" } }, "GlobalReplicationGroupDescription": { @@ -8054,7 +8132,7 @@ "AutomaticFailoverEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
" + "smithy.api#documentation": "Determines whether a read replica is automatically promoted to read/write primary if\n the existing primary encounters a failure.
" } } } @@ -8065,6 +8143,9 @@ "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#ModifyReplicationGroup": { @@ -8126,7 +8207,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the settings for a replication group.
\n\n Scaling for Amazon ElastiCache for Redis (cluster mode enabled)\n in the ElastiCache User Guide
\n\n ModifyReplicationGroupShardConfiguration\n in the ElastiCache API Reference
\nThis operation is valid for Redis only.
\nModifies the settings for a replication group.
\n\n Scaling for Amazon ElastiCache for Redis (cluster mode enabled) in\n the ElastiCache User Guide
\n\n ModifyReplicationGroupShardConfiguration in the ElastiCache API\n Reference
\nThis operation is valid for Redis only.
\nFor replication groups with a single primary, \n if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. \n The nodes of all other clusters in the replication group are read replicas.
" + "smithy.api#documentation": "For replication groups with a single primary, if this parameter is specified,\n ElastiCache promotes the specified cluster in the specified replication group to the\n primary role. The nodes of all other clusters in the replication group are read\n replicas.
" } }, "SnapshottingClusterId": { @@ -8160,7 +8241,7 @@ "AutomaticFailoverEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
\nValid values: true
| false
\n
Determines whether a read replica is automatically promoted to read/write primary if\n the existing primary encounters a failure.
\nValid values: true
| false
\n
A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.
\nThis parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).
\nConstraints: Must contain no more than 255 alphanumeric characters. Must not be Default
.
A list of cache security group names to authorize for the clusters in this replication\n group. This change is asynchronously applied as soon as possible.
\nThis parameter can be used only with replication group containing clusters running\n outside of an Amazon Virtual Private Cloud (Amazon VPC).
\nConstraints: Must contain no more than 255 alphanumeric characters. Must not be\n Default
.
Specifies the VPC Security Groups associated with the clusters in the replication group.
\nThis parameter can be used only with replication group containing clusters running in \n an Amazon Virtual Private Cloud (Amazon VPC).
" + "smithy.api#documentation": "Specifies the VPC Security Groups associated with the clusters in the replication\n group.
\nThis parameter can be used only with replication group containing clusters running in\n an Amazon Virtual Private Cloud (Amazon VPC).
" } }, "PreferredMaintenanceWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.
\nValid values for ddd
are:
\n sun
\n
\n mon
\n
\n tue
\n
\n wed
\n
\n thu
\n
\n fri
\n
\n sat
\n
Example: sun:23:00-mon:01:30
\n
Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.
\nValid values for ddd
are:
\n sun
\n
\n mon
\n
\n tue
\n
\n wed
\n
\n thu
\n
\n fri
\n
\n sat
\n
Example: sun:23:00-mon:01:30
\n
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
\nThe Amazon SNS topic owner must be same as the replication group owner.
\nThe Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are\n sent.
\nThe Amazon SNS topic owner must be same as the replication group owner.
\nThe name of the cache parameter group to apply to all of the clusters in this replication group. \n This change is asynchronously applied as soon as possible for parameters when the \n ApplyImmediately
parameter is specified as true
for this request.
The name of the cache parameter group to apply to all of the clusters in this\n replication group. This change is asynchronously applied as soon as possible for\n parameters when the ApplyImmediately
parameter is specified as\n true
for this request.
The status of the Amazon SNS notification topic for the replication group. \n Notifications are sent only if the status is active
.
Valid values: active
| inactive
\n
The status of the Amazon SNS notification topic for the replication group.\n Notifications are sent only if the status is active
.
Valid values: active
| inactive
\n
The upgraded version of the cache engine to be run on the clusters in the replication group.
\n\n Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version.\n If you want to use an earlier engine version, \n you must delete the existing replication group and create it anew with the earlier engine version.
" + "smithy.api#documentation": "The upgraded version of the cache engine to be run on the clusters in the replication\n group.
\n\n Important: You can upgrade to a newer engine version\n (see Selecting\n a Cache Engine and Version), but you cannot downgrade to an earlier engine\n version. If you want to use an earlier engine version, you must delete the existing\n replication group and create it anew with the earlier engine version.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. \n
" + "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days for which ElastiCache retains automatic node group (shard) snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit
to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.
\n Important If the value of SnapshotRetentionLimit is set to zero (0), \n backups are turned off.
" + "smithy.api#documentation": "The number of days for which ElastiCache retains automatic node group (shard)\n snapshots before deleting them. For example, if you set\n SnapshotRetentionLimit
to 5, a snapshot that was taken today is\n retained for 5 days before being deleted.
\n Important If the value of SnapshotRetentionLimit is\n set to zero (0), backups are turned off.
" } }, "SnapshotWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of\n the node group (shard) specified by SnapshottingClusterId
.
Example: 05:00-09:00
\n
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
" + "smithy.api#documentation": "The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of the node group (shard) specified by SnapshottingClusterId
.
Example: 05:00-09:00
\n
If you do not specify this parameter, ElastiCache automatically chooses an appropriate\n time range.
" } }, "CacheNodeType": { @@ -8252,13 +8333,13 @@ "AuthToken": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update-strategy
\n parameter.\n Password constraints:
Must be only printable ASCII characters
\nMust be at least 16 characters and no more than 128 characters in length
\nCannot contain any of the following characters: '/', '\"', or '@', '%'
\n\n \n For more information, see AUTH password at AUTH.
" + "smithy.api#documentation": "Reserved parameter. The password used to access a password protected server. This\n parameter must be specified with the auth-token-update-strategy
parameter.\n Password constraints:
Must be only printable ASCII characters
\nMust be at least 16 characters and no more than 128 characters in\n length
\nCannot contain any of the following characters: '/', '\"', or '@', '%'
\nFor more information, see AUTH password at AUTH.
" } }, "AuthTokenUpdateStrategy": { "target": "com.amazonaws.elasticache#AuthTokenUpdateStrategyType", "traits": { - "smithy.api#documentation": "Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token
parameter.\n Possible values:
Rotate
\nSet
\n\n For more information, see Authenticating Users with Redis AUTH\n
" + "smithy.api#documentation": "Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the auth-token
parameter. Possible values:
Rotate
\nSet
\nFor more information, see Authenticating Users with Redis AUTH\n
" } }, "UserGroupIdsToAdd": { @@ -8270,7 +8351,7 @@ "UserGroupIdsToRemove": { "target": "com.amazonaws.elasticache#UserGroupIdList", "traits": { - "smithy.api#documentation": "The ID of the user group to disassociate from the replication group, meaning the users in the group no longer can access the replication group.
" + "smithy.api#documentation": "The ID of the user group to disassociate from the replication group, meaning the users\n in the group no longer can access the replication group.
" } }, "RemoveUserGroups": { @@ -8288,25 +8369,25 @@ "IpDiscovery": { "target": "com.amazonaws.elasticache#IpDiscovery", "traits": { - "smithy.api#documentation": "The network type you choose when modifying a cluster, either ipv4
| ipv6
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
The network type you choose when modifying a cluster, either ipv4
|\n ipv6
. IPv6 is supported for workloads using Redis engine version 6.2\n onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
A flag that enables in-transit encryption when set to true. If you are enabling in-transit encryption for an existing cluster, you must also set TransitEncryptionMode
to preferred
.
A flag that enables in-transit encryption when set to true. If you are enabling\n in-transit encryption for an existing cluster, you must also set\n TransitEncryptionMode
to preferred
.
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
\nYou must set TransitEncryptionEnabled
to true
, for your existing cluster, and set TransitEncryptionMode
to preferred
in the same request to allow both encrypted and \nunencrypted connections at the same time. Once you migrate all your Redis clients to use encrypted connections you can set the value to required
to allow encrypted connections only.
Setting TransitEncryptionMode
to required
is a two-step process that requires you to first set the TransitEncryptionMode
to preferred
, after that you can set TransitEncryptionMode
to required
.\n
A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.
\nYou must set TransitEncryptionEnabled
to true
, for your\n existing cluster, and set TransitEncryptionMode
to preferred
\n in the same request to allow both encrypted and unencrypted connections at the same\n time. Once you migrate all your Redis clients to use encrypted connections you can set\n the value to required
to allow encrypted connections only.
Setting TransitEncryptionMode
to required
is a two-step\n process that requires you to first set the TransitEncryptionMode
to\n preferred
, after that you can set TransitEncryptionMode
to\n required
.
Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible.\n \n Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
" + "smithy.api#documentation": "Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Redis\n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.
" } } }, @@ -8320,6 +8401,9 @@ "ReplicationGroup": { "target": "com.amazonaws.elasticache#ReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#ModifyReplicationGroupShardConfiguration": { @@ -8363,7 +8447,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies a replication group's shards (node groups) by allowing you to\n add shards, remove shards, or rebalance the keyspaces among existing shards.
" + "smithy.api#documentation": "Modifies a replication group's shards (node groups) by allowing you to add shards,\n remove shards, or rebalance the keyspaces among existing shards.
" } }, "com.amazonaws.elasticache#ModifyReplicationGroupShardConfigurationMessage": { @@ -8372,7 +8456,7 @@ "ReplicationGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The name of the Redis (cluster mode enabled) cluster (replication group)\n on which the shards are to be configured.
", + "smithy.api#documentation": "The name of the Redis (cluster mode enabled) cluster (replication group) on which the\n shards are to be configured.
", "smithy.api#required": {} } }, @@ -8380,7 +8464,7 @@ "target": "com.amazonaws.elasticache#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The number of node groups (shards) that results from the modification of the\n shard configuration.
", + "smithy.api#documentation": "The number of node groups (shards) that results from the modification of the shard\n configuration.
", "smithy.api#required": {} } }, @@ -8388,31 +8472,31 @@ "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates that the shard reconfiguration process begins immediately. \n At present, the only permitted value for this parameter is true
.
Value: true
", + "smithy.api#documentation": "Indicates that the shard reconfiguration process begins immediately. At present, the\n only permitted value for this parameter is true
.
Value: true
", "smithy.api#required": {} } }, "ReshardingConfiguration": { "target": "com.amazonaws.elasticache#ReshardingConfigurationList", "traits": { - "smithy.api#documentation": "Specifies the preferred availability zones for each node group in the cluster.\n If the value of NodeGroupCount
is greater than the current number\n of node groups (shards), you can use this parameter to specify the preferred \n availability zones of the cluster's shards. \n If you omit this parameter ElastiCache selects availability zones for you.
You can specify this parameter only if the value of NodeGroupCount
\n is greater than the current number of node groups (shards).
Specifies the preferred availability zones for each node group in the cluster. If the\n value of NodeGroupCount
is greater than the current number of node groups\n (shards), you can use this parameter to specify the preferred availability zones of the\n cluster's shards. If you omit this parameter ElastiCache selects availability zones for\n you.
You can specify this parameter only if the value of NodeGroupCount
is\n greater than the current number of node groups (shards).
If the value of NodeGroupCount
is less than the \n current number of node groups (shards), then either NodeGroupsToRemove
or\n NodeGroupsToRetain
is required.\n NodeGroupsToRemove
is a list of NodeGroupId
s to remove \n from the cluster.
ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove
\n from the cluster.
If the value of NodeGroupCount
is less than the current number of node\n groups (shards), then either NodeGroupsToRemove
or\n NodeGroupsToRetain
is required. NodeGroupsToRemove
is a\n list of NodeGroupId
s to remove from the cluster.
ElastiCache for Redis will attempt to remove all node groups listed by\n NodeGroupsToRemove
from the cluster.
If the value of NodeGroupCount
is less than the \n current number of node groups (shards), then either NodeGroupsToRemove
or\n NodeGroupsToRetain
is required.\n NodeGroupsToRetain
is a list of NodeGroupId
s to retain \n in the cluster.
ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain
\n from the cluster.
If the value of NodeGroupCount
is less than the current number of node\n groups (shards), then either NodeGroupsToRemove
or\n NodeGroupsToRetain
is required. NodeGroupsToRetain
is a\n list of NodeGroupId
s to retain in the cluster.
ElastiCache for Redis will attempt to remove all node groups except those listed by\n NodeGroupsToRetain
from the cluster.
Represents the input for a ModifyReplicationGroupShardConfiguration
operation.
Represents the input for a ModifyReplicationGroupShardConfiguration
\n operation.
The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001.\n A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for\n a node group.
" + "smithy.api#documentation": "The identifier for the node group (shard). A Redis (cluster mode disabled) replication\n group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster\n mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090.\n Optionally, the user can provide the id for a node group.
" } }, "Status": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The current state of this replication group - creating
, \n available
, modifying
, deleting
.
The current state of this replication group - creating
,\n available
, modifying
, deleting
.
A list containing information about individual nodes within the node group (shard).
" + "smithy.api#documentation": "A list containing information about individual nodes within the node group\n (shard).
" } } }, "traits": { - "smithy.api#documentation": "Represents a collection of cache nodes in a replication group.\n One node in the node group is the read/write primary node. \n All the other nodes are read-only Replica nodes.
" + "smithy.api#documentation": "Represents a collection of cache nodes in a replication group. One node in the node\n group is the read/write primary node. All the other nodes are read-only Replica\n nodes.
" } }, "com.amazonaws.elasticache#NodeGroupConfiguration": { @@ -8669,13 +8756,13 @@ "NodeGroupId": { "target": "com.amazonaws.elasticache#AllowedNodeGroupId", "traits": { - "smithy.api#documentation": "Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these \n configuration values apply to.
" + "smithy.api#documentation": "Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the\n node group these configuration values apply to.
" } }, "Slots": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "A string that specifies the keyspace for a particular node group.\n Keyspaces range from 0 to 16,383.\n The string is in the format startkey-endkey
.
Example: \"0-3999\"
\n
A string that specifies the keyspace for a particular node group. Keyspaces range from\n 0 to 16,383. The string is in the format startkey-endkey
.
Example: \"0-3999\"
\n
The Availability Zone where the primary node of this node group (shard) is launched.
" + "smithy.api#documentation": "The Availability Zone where the primary node of this node group (shard) is\n launched.
" } }, "ReplicaAvailabilityZones": { "target": "com.amazonaws.elasticache#AvailabilityZonesList", "traits": { - "smithy.api#documentation": "A list of Availability Zones to be used for the read replicas.\n The number of Availability Zones in this list must match the value of ReplicaCount
\n or ReplicasPerNodeGroup
if not specified.
A list of Availability Zones to be used for the read replicas. The number of\n Availability Zones in this list must match the value of ReplicaCount
or\n ReplicasPerNodeGroup
if not specified.
Node group (shard) configuration options. \n Each node group (shard) configuration has the following: Slots
, PrimaryAvailabilityZone
, ReplicaAvailabilityZones
, ReplicaCount
.
Node group (shard) configuration options. Each node group (shard) configuration has\n the following: Slots
, PrimaryAvailabilityZone
,\n ReplicaAvailabilityZones
, ReplicaCount
.
The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
" + "smithy.api#documentation": "The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002,\n etc.).
" } }, "ReadEndpoint": { @@ -8767,7 +8854,7 @@ "CurrentRole": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The role that is currently assigned to the node - primary
or \n replica
. This member is only applicable for Redis (cluster mode disabled) \n replication groups.
The role that is currently assigned to the node - primary
or\n replica
. This member is only applicable for Redis (cluster mode\n disabled) replication groups.
Reflects whether the update was initiated by the customer or automatically applied
" + "smithy.api#documentation": "Reflects whether the update was initiated by the customer or automatically\n applied
" } }, "NodeUpdateInitiatedDate": { @@ -8843,7 +8930,7 @@ } }, "traits": { - "smithy.api#documentation": "The status of the service update on the node group member
" + "smithy.api#documentation": "The status of the service update on the node group member
" } }, "com.amazonaws.elasticache#NodeGroupMemberUpdateStatusList": { @@ -8867,7 +8954,7 @@ "code": "NodeGroupNotFoundFault", "httpResponseCode": 404 }, - "smithy.api#documentation": "The node group specified by the NodeGroupId
parameter could not be found.\n Please verify that the node group exists and that you spelled the NodeGroupId
value correctly.
The node group specified by the NodeGroupId
parameter could not be found.\n Please verify that the node group exists and that you spelled the\n NodeGroupId
value correctly.
The request cannot be processed because it would exceed the maximum allowed number\n of node groups (shards) in a single replication group. The default maximum is 90
", + "smithy.api#documentation": "The request cannot be processed because it would exceed the maximum allowed number of\n node groups (shards) in a single replication group. The default maximum is 90
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -8948,7 +9035,7 @@ "code": "NodeQuotaForClusterExceeded", "httpResponseCode": 400 }, - "smithy.api#documentation": "The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.
", + "smithy.api#documentation": "The request cannot be processed because it would exceed the allowed number of cache\n nodes in a single cluster.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -8965,7 +9052,7 @@ "code": "NodeQuotaForCustomerExceeded", "httpResponseCode": 400 }, - "smithy.api#documentation": "The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
", + "smithy.api#documentation": "The request cannot be processed because it would exceed the allowed number of cache\n nodes per customer.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -9012,7 +9099,7 @@ "SnapshotCreateTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "The date and time when the source node's metadata and cache data set was obtained for the snapshot.
" + "smithy.api#documentation": "The date and time when the source node's metadata and cache data set was obtained for\n the snapshot.
" } } }, @@ -9110,7 +9197,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes a notification topic and its status. \n Notification topics are used for publishing ElastiCache events to subscribers \n using Amazon Simple Notification Service (SNS).
" + "smithy.api#documentation": "Describes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).
" } }, "com.amazonaws.elasticache#OutpostArnsList": { @@ -9182,7 +9269,7 @@ "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether (true
) or not (false
) the parameter can be modified. \n Some parameters have security or operational implications that prevent them from being changed.
Indicates whether (true
) or not (false
) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.
Indicates whether a change to the parameter is applied immediately\n or requires a reboot for the change to be applied. \n You can force a reboot or wait until the next maintenance window's reboot.\n For more information, see Rebooting a Cluster.
" + "smithy.api#documentation": "Indicates whether a change to the parameter is applied immediately or requires a\n reboot for the change to be applied. You can force a reboot or wait until the next\n maintenance window's reboot. For more information, see Rebooting a\n Cluster.
" } } }, "traits": { - "smithy.api#documentation": "Describes an individual setting that controls some aspect of ElastiCache behavior.
" + "smithy.api#documentation": "Describes an individual setting that controls some aspect of ElastiCache\n behavior.
" } }, "com.amazonaws.elasticache#ParameterNameValue": { @@ -9274,7 +9361,7 @@ "LogType": { "target": "com.amazonaws.elasticache#LogType", "traits": { - "smithy.api#documentation": "Refers to slow-log or engine-log..
" + "smithy.api#documentation": "Refers to slow-log or\n engine-log..
" } }, "DestinationType": { @@ -9286,7 +9373,7 @@ "DestinationDetails": { "target": "com.amazonaws.elasticache#DestinationDetails", "traits": { - "smithy.api#documentation": "Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
" + "smithy.api#documentation": "Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose\n destination.
" } }, "LogFormat": { @@ -9312,19 +9399,19 @@ "NumCacheNodes": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The new number of cache nodes for the cluster.
\nFor clusters running Redis, this value must be 1. \n For clusters running Memcached, this value must be between 1 and 40.
" + "smithy.api#documentation": "The new number of cache nodes for the cluster.
\nFor clusters running Redis, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.
" } }, "CacheNodeIdsToRemove": { "target": "com.amazonaws.elasticache#CacheNodeIdsList", "traits": { - "smithy.api#documentation": "A list of cache node IDs that are being removed (or will be removed) from the cluster. \n A node ID is a 4-digit numeric identifier (0001, 0002, etc.).
" + "smithy.api#documentation": "A list of cache node IDs that are being removed (or will be removed) from the cluster.\n A node ID is a 4-digit numeric identifier (0001, 0002, etc.).
" } }, "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The new cache engine version that the cluster runs.
" + "smithy.api#documentation": "The new cache engine version that the cluster runs.
" } }, "CacheNodeType": { @@ -9354,12 +9441,12 @@ "TransitEncryptionMode": { "target": "com.amazonaws.elasticache#TransitEncryptionMode", "traits": { - "smithy.api#documentation": "A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
" + "smithy.api#documentation": "A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.
" } } }, "traits": { - "smithy.api#documentation": "A group of settings that are applied to the cluster in the future, \n or that are currently being applied.
" + "smithy.api#documentation": "A group of settings that are applied to the cluster in the future, or that are\n currently being applied.
" } }, "com.amazonaws.elasticache#PreferredAvailabilityZoneList": { @@ -9450,7 +9537,7 @@ } ], "traits": { - "smithy.api#documentation": "Allows you to purchase a reserved\n cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, \n see Managing Costs with Reserved Nodes for Redis or \n Managing Costs with Reserved Nodes for Memcached.
" + "smithy.api#documentation": "Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible\n for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes for Redis or Managing Costs with\n Reserved Nodes for Memcached.
" } }, "com.amazonaws.elasticache#PurchaseReservedCacheNodesOfferingMessage": { @@ -9466,7 +9553,7 @@ "ReservedCacheNodeId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "A customer-specified identifier to track this reservation.
\nThe Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. \n If this parameter is not specified, \n ElastiCache automatically generates an identifier for the reservation.
\nExample: myreservationID
" + "smithy.api#documentation": "A customer-specified identifier to track this reservation.
\nThe Reserved Cache Node ID is an unique customer-specified identifier to track\n this reservation. If this parameter is not specified, ElastiCache automatically\n generates an identifier for the reservation.
\nExample: myreservationID
" } }, "CacheNodeCount": { @@ -9478,12 +9565,12 @@ "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { - "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
" + "smithy.api#documentation": "A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted.
" } } }, "traits": { - "smithy.api#documentation": "Represents the input of a PurchaseReservedCacheNodesOffering
operation.
Represents the input of a PurchaseReservedCacheNodesOffering
\n operation.
Redistribute slots to ensure uniform distribution across existing shards in the cluster.
" + "smithy.api#documentation": "Redistribute slots to ensure uniform distribution across existing shards in the\n cluster.
" } }, "com.amazonaws.elasticache#RebalanceSlotsInGlobalReplicationGroupMessage": { @@ -9543,6 +9633,9 @@ "GlobalReplicationGroup": { "target": "com.amazonaws.elasticache#GlobalReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#RebootCacheCluster": { @@ -9562,7 +9655,7 @@ } ], "traits": { - "smithy.api#documentation": "Reboots some, or all, of the cache nodes\n within a provisioned cluster. This operation applies any modified cache parameter\n groups to the cluster. The reboot operation takes place as soon as possible, and\n results in a momentary outage to the cluster. During the reboot, the cluster\n status is set to REBOOTING.
\nThe reboot causes the contents of the cache (for each cache node being rebooted) to be lost.
\nWhen the reboot is complete, a cluster event is created.
\nRebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters.\n Rebooting is not supported on Redis (cluster mode enabled) clusters.
\nIf you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied,\n see Rebooting a Cluster for an alternate process.
" + "smithy.api#documentation": "Reboots some, or all, of the cache nodes within a provisioned cluster. This operation\n applies any modified cache parameter groups to the cluster. The reboot operation takes\n place as soon as possible, and results in a momentary outage to the cluster. During the\n reboot, the cluster status is set to REBOOTING.
\nThe reboot causes the contents of the cache (for each cache node being rebooted) to be\n lost.
\nWhen the reboot is complete, a cluster event is created.
\nRebooting a cluster is currently supported on Memcached and Redis (cluster mode\n disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled)\n clusters.
\nIf you make changes to parameters that require a Redis (cluster mode enabled) cluster\n reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.
" } }, "com.amazonaws.elasticache#RebootCacheClusterMessage": { @@ -9578,7 +9671,7 @@ "CacheNodeIdsToReboot": { "target": "com.amazonaws.elasticache#CacheNodeIdsList", "traits": { - "smithy.api#documentation": "A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.
", + "smithy.api#documentation": "A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002,\n etc.). To reboot an entire cluster, specify all of the cache node IDs.
", "smithy.api#required": {} } } @@ -9593,6 +9686,9 @@ "CacheCluster": { "target": "com.amazonaws.elasticache#CacheCluster" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#RecurringCharge": { @@ -9613,7 +9709,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains the specific price and frequency of a recurring charges for a reserved cache node, \n or for a reserved cache node offering.
" + "smithy.api#documentation": "Contains the specific price and frequency of a recurring charges for a reserved cache\n node, or for a reserved cache node offering.
" } }, "com.amazonaws.elasticache#RecurringChargeList": { @@ -9645,7 +9741,7 @@ "ReshardingConfiguration": { "target": "com.amazonaws.elasticache#ReshardingConfigurationList", "traits": { - "smithy.api#documentation": "A list of PreferredAvailabilityZones
objects that specifies the configuration of a node group in the resharded cluster.
A list of PreferredAvailabilityZones
objects that specifies the\n configuration of a node group in the resharded cluster.
Removes the tags identified by the TagKeys
\n list from the named resource. A tag is a key-value pair where the key and value are case-sensitive. \n 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. \n For more information, see Resource-level permissions.
Removes the tags identified by the TagKeys
list from the named resource.\n A tag is a key-value pair where the key and value are case-sensitive. You can use tags\n to categorize and track all your ElastiCache resources, with the exception of global\n replication group. When you add or remove tags on replication groups, those actions will\n be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
The Amazon Resource Name (ARN) of the resource from which you want the tags removed, \n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
\n or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot
.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource from which you want the tags removed,\n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
or\n arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot
.
For more information about ARNs, see Amazon Resource Names (ARNs)\n and Amazon Service Namespaces.
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.elasticache#KeyList", "traits": { - "smithy.api#documentation": "A list of TagKeys
identifying the tags you want removed from the named resource.
A list of TagKeys
identifying the tags you want removed from the named\n resource.
The name of the Global datastore and role of this replication group in the Global datastore.
" + "smithy.api#documentation": "The name of the Global datastore and role of this replication group in the Global\n datastore.
" } }, "Status": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The current state of this replication group - \n creating
, \n available
, \n modifying
, \n deleting
, \n create-failed
,\n snapshotting
.
The current state of this replication group - creating
,\n available
, modifying
, deleting
,\n create-failed
, snapshotting
.
A group of settings to be applied to the replication group, \n either immediately or during the next maintenance window.
" + "smithy.api#documentation": "A group of settings to be applied to the replication group, either immediately or\n during the next maintenance window.
" } }, "MemberClusters": { @@ -9792,13 +9888,13 @@ "NodeGroups": { "target": "com.amazonaws.elasticache#NodeGroupList", "traits": { - "smithy.api#documentation": "A list of node groups in this replication group.\n For Redis (cluster mode disabled) replication groups, this is a single-element list.\n For Redis (cluster mode enabled) replication groups, the list contains an entry for each\n node group (shard).
" + "smithy.api#documentation": "A list of node groups in this replication group. For Redis (cluster mode disabled)\n replication groups, this is a single-element list. For Redis (cluster mode enabled)\n replication groups, the list contains an entry for each node group (shard).
" } }, "SnapshottingClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The cluster ID that is used as the daily snapshot source for the replication group.
" + "smithy.api#documentation": "The cluster ID that is used as the daily snapshot source for the replication\n group.
" } }, "AutomaticFailover": { @@ -9810,43 +9906,43 @@ "MultiAZ": { "target": "com.amazonaws.elasticache#MultiAZStatus", "traits": { - "smithy.api#documentation": "A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ\n
" + "smithy.api#documentation": "A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more\n information, see Minimizing Downtime: Multi-AZ\n
" } }, "ConfigurationEndpoint": { "target": "com.amazonaws.elasticache#Endpoint", "traits": { - "smithy.api#documentation": "The configuration endpoint for this replication group. \n Use the configuration endpoint to connect to this replication group.
" + "smithy.api#documentation": "The configuration endpoint for this replication group. Use the configuration endpoint\n to connect to this replication group.
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit
to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.
\n If the value of SnapshotRetentionLimit
is set to zero (0), backups are turned off.
The number of days for which ElastiCache retains automatic cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit
to 5, a\n snapshot that was taken today is retained for 5 days before being deleted.
If the value of SnapshotRetentionLimit
is set to zero (0), backups\n are turned off.
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
\nExample: 05:00-09:00
\n
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
\nThis parameter is only valid if the Engine
parameter is redis
.
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot\n of your node group (shard).
\nExample: 05:00-09:00
\n
If you do not specify this parameter, ElastiCache automatically chooses an appropriate\n time range.
\nThis parameter is only valid if the Engine
parameter is\n redis
.
A flag indicating whether or not this replication group is cluster enabled; \n i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).
\nValid values: true
| false
\n
A flag indicating whether or not this replication group is cluster enabled; i.e.,\n whether its data can be partitioned across multiple shards (API/CLI: node\n groups).
\nValid values: true
| false
\n
The name of the compute and memory capacity node type for each node in the replication group.
" + "smithy.api#documentation": "The name of the compute and memory capacity node type for each node in the replication\n group.
" } }, "AuthTokenEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "A flag that enables using an AuthToken
(password)\n when issuing Redis commands.
Default: false
\n
A flag that enables using an AuthToken
(password) when issuing Redis\n commands.
Default: false
\n
A flag that enables in-transit encryption when set to true
.
\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6
, 4.x
or later.
Default: false
\n
A flag that enables in-transit encryption when set to true
.
\n Required: Only available when creating a replication\n group in an Amazon VPC using redis version 3.2.6
, 4.x
or\n later.
Default: false
\n
A flag that enables encryption at-rest when set to true
.
You cannot modify the value of AtRestEncryptionEnabled
\n after the cluster is created. To enable encryption at-rest on a cluster\n you must set AtRestEncryptionEnabled
to true
\n when you create a cluster.
\n Required:\n Only available when creating a replication group in an Amazon VPC using redis version 3.2.6
, 4.x
or later.
Default: false
\n
A flag that enables encryption at-rest when set to true
.
You cannot modify the value of AtRestEncryptionEnabled
after the cluster\n is created. To enable encryption at-rest on a cluster you must set\n AtRestEncryptionEnabled
to true
when you create a\n cluster.
\n Required: Only available when creating a replication\n group in an Amazon VPC using redis version 3.2.6
, 4.x
or\n later.
Default: false
\n
Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes.\n For more information, see Data tiering.
" + "smithy.api#documentation": "Enables data tiering. Data tiering is only supported for replication groups using the\n r6gd node type. This parameter must be set to true when using r6gd nodes. For more\n information, see Data tiering.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
" + "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if you\n want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.
" } }, "NetworkType": { "target": "com.amazonaws.elasticache#NetworkType", "traits": { - "smithy.api#documentation": "Must be either ipv4
| ipv6
| dual_stack
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
Must be either ipv4
| ipv6
| dual_stack
. IPv6\n is supported for workloads using Redis engine version 6.2 onward or Memcached engine\n version 1.6.6 on all instances built on the Nitro system.
The network type you choose when modifying a cluster, either ipv4
| ipv6
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
The network type you choose when modifying a cluster, either ipv4
|\n ipv6
. IPv6 is supported for workloads using Redis engine version 6.2\n onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
" + "smithy.api#documentation": "A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.
" } }, "ClusterMode": { "target": "com.amazonaws.elasticache#ClusterMode", "traits": { - "smithy.api#documentation": "Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible.\n \n Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
" + "smithy.api#documentation": "Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Redis\n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.
" } } }, @@ -10012,7 +10108,7 @@ "ReplicationGroups": { "target": "com.amazonaws.elasticache#ReplicationGroupList", "traits": { - "smithy.api#documentation": "A list of replication groups. Each item in the list contains detailed information about one replication group.
" + "smithy.api#documentation": "A list of replication groups. Each item in the list contains detailed information\n about one replication group.
" } } }, @@ -10069,7 +10165,7 @@ "PrimaryClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The primary cluster ID that is applied immediately (if --apply-immediately
\n was specified), or during the next maintenance window.
The primary cluster ID that is applied immediately (if\n --apply-immediately
was specified), or during the next maintenance\n window.
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
" + "smithy.api#documentation": "A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.
" } }, "ClusterMode": { "target": "com.amazonaws.elasticache#ClusterMode", "traits": { - "smithy.api#documentation": "Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible.\n \n Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
" + "smithy.api#documentation": "Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Redis\n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.
" } } }, "traits": { - "smithy.api#documentation": "The settings to be applied to the Redis replication group, \n either immediately or during the next maintenance window.
" + "smithy.api#documentation": "The settings to be applied to the Redis replication group, either immediately or\n during the next maintenance window.
" } }, "com.amazonaws.elasticache#ReservedCacheNode": { @@ -10143,7 +10239,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The cache node type for the reserved cache nodes.
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n
\n M4 node types:\n cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n
\n T3 node types:\n cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro
\n
\n M1 node types:\n cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge
\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The cache node type for the reserved cache nodes.
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n
\n M4 node types:\n cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n
\n T3 node types:\n cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro
\n
\n M1 node types:\n cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge
\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1\n instances.
\nRedis configuration variables appendonly
and\n appendfsync
are not supported on Redis version 2.8.22 and\n later.
The Amazon Resource Name (ARN) of the reserved cache node.
\nExample: arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582
\n
The Amazon Resource Name (ARN) of the reserved cache node.
\nExample:\n arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582
\n
Represents the output of a PurchaseReservedCacheNodesOffering
operation.
Represents the output of a PurchaseReservedCacheNodesOffering
\n operation.
A list of reserved cache nodes. Each element in the list contains detailed information about one node.
" + "smithy.api#documentation": "A list of reserved cache nodes. Each element in the list contains detailed information\n about one node.
" } } }, @@ -10290,7 +10386,7 @@ "code": "ReservedCacheNodeQuotaExceeded", "httpResponseCode": 400 }, - "smithy.api#documentation": "The request cannot be processed because it would exceed the user's cache node quota.
", + "smithy.api#documentation": "The request cannot be processed because it would exceed the user's cache node\n quota.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -10307,7 +10403,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The cache node type for the reserved cache node.
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n
\n M4 node types:\n cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n
\n T3 node types:\n cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro
\n
\n M1 node types:\n cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge
\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The cache node type for the reserved cache node.
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n
\n M4 node types:\n cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n
\n T3 node types:\n cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro
\n
\n M1 node types:\n cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge
\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1\n instances.
\nRedis configuration variables appendonly
and\n appendfsync
are not supported on Redis version 2.8.22 and\n later.
A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.
" + "smithy.api#documentation": "A list of reserved cache node offerings. Each element in the list contains detailed\n information about one offering.
" } } }, "traits": { - "smithy.api#documentation": "Represents the output of a DescribeReservedCacheNodesOfferings
operation.
Represents the output of a DescribeReservedCacheNodesOfferings
\n operation.
Modifies the parameters of a cache\n parameter group to the engine or system default value. You can reset specific parameters\n by submitting a list of parameter names. To reset the entire cache parameter group,\n specify the ResetAllParameters
and CacheParameterGroupName
parameters.
Modifies the parameters of a cache parameter group to the engine or system default\n value. You can reset specific parameters by submitting a list of parameter names. To\n reset the entire cache parameter group, specify the ResetAllParameters
and\n CacheParameterGroupName
parameters.
If true
, \n all parameters in the cache parameter group are reset to their default values.\n If false
, only the parameters listed by ParameterNameValues
\n are reset to their default values.
Valid values: true
| false
\n
If true
, all parameters in the cache parameter group are reset to their\n default values. If false
, only the parameters listed by\n ParameterNameValues
are reset to their default values.
Valid values: true
| false
\n
An array of parameter names to reset to their default values. \n If ResetAllParameters
is true
, \n do not use ParameterNameValues
.\n If ResetAllParameters
is false
, \n you must specify the name of at least one parameter to reset.
An array of parameter names to reset to their default values. If\n ResetAllParameters
is true
, do not use\n ParameterNameValues
. If ResetAllParameters
is\n false
, you must specify the name of at least one parameter to\n reset.
Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these \n configuration values apply to.
" + "smithy.api#documentation": "Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the\n node group these configuration values apply to.
" } }, "PreferredAvailabilityZones": { @@ -10474,7 +10570,7 @@ } }, "traits": { - "smithy.api#documentation": "A list of PreferredAvailabilityZones
objects that specifies\n the configuration of a node group in the resharded cluster.
A list of PreferredAvailabilityZones
objects that specifies the\n configuration of a node group in the resharded cluster.
Revokes ingress from a cache security group. \n Use this operation to disallow access from an Amazon EC2 security group\n that had been previously authorized.
" + "smithy.api#documentation": "Revokes ingress from a cache security group. Use this operation to disallow access\n from an Amazon EC2 security group that had been previously authorized.
" } }, "com.amazonaws.elasticache#RevokeCacheSecurityGroupIngressMessage": { @@ -10549,13 +10645,13 @@ "EC2SecurityGroupOwnerId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The Amazon account number of the Amazon EC2 security group owner. \n Note that this is not the same thing as an Amazon access key ID - you must provide \n a valid Amazon account number for this parameter.
", + "smithy.api#documentation": "The Amazon account number of the Amazon EC2 security group owner. Note that this is\n not the same thing as an Amazon access key ID - you must provide a valid Amazon account\n number for this parameter.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a RevokeCacheSecurityGroupIngress
operation.
Represents the input of a RevokeCacheSecurityGroupIngress
\n operation.
The status of the cache security group membership. \n The status changes whenever a cache security group is modified, \n or when the cache security groups assigned to a cluster are modified.
" + "smithy.api#documentation": "The status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cluster are\n modified.
" } } }, @@ -10648,7 +10747,7 @@ "ServiceUpdateRecommendedApplyByDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "The recommendend date to apply the service update in order to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.
" + "smithy.api#documentation": "The recommendend date to apply the service update in order to ensure compliance. For\n information on compliance, see Self-Service Security Updates for Compliance.
" } }, "ServiceUpdateStatus": { @@ -10678,13 +10777,13 @@ "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The Elasticache engine version to which the update applies. Either Redis or Memcached engine version
" + "smithy.api#documentation": "The Elasticache engine version to which the update applies. Either Redis or Memcached\n engine version
" } }, "AutoUpdateAfterRecommendedApplyByDate": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "Indicates whether the service update will be automatically applied once the recommended apply-by date has expired.
" + "smithy.api#documentation": "Indicates whether the service update will be automatically applied once the\n recommended apply-by date has expired.
" } }, "EstimatedUpdateTime": { @@ -10805,7 +10904,7 @@ "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords
.
The name of a snapshot. \n For an automatic snapshot, the name is system-generated. \n For a manual snapshot, this is the user-provided name.
" + "smithy.api#documentation": "The name of a snapshot. For an automatic snapshot, the name is system-generated. For a\n manual snapshot, this is the user-provided name.
" } }, "ReplicationGroupId": { @@ -10884,25 +10983,25 @@ "SnapshotStatus": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The status of the snapshot. Valid values: creating
| available
\n | restoring
| copying
| deleting
.
The status of the snapshot. Valid values: creating
|\n available
| restoring
| copying
|\n deleting
.
Indicates whether the snapshot is from an automatic backup (automated
) \n or was created manually (manual
).
Indicates whether the snapshot is from an automatic backup (automated
) or\n was created manually (manual
).
The name of the compute and memory capacity node type for the source cluster.
\nThe following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n
\n M4 node types:\n cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n
\n T3 node types:\n cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro
\n
\n M1 node types:\n cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge
\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1 instances.
\nRedis configuration variables appendonly
and \n\t\t\t\tappendfsync
are not supported on Redis version 2.8.22 and later.
The name of the compute and memory capacity node type for the source cluster.
\nThe following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.
\nGeneral purpose:
\nCurrent generation:
\n\n M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large
,\n\t\t\t\t\t\t\tcache.m6g.xlarge
,\n\t\t\t\t\t\t\tcache.m6g.2xlarge
,\n\t\t\t\t\t\t\tcache.m6g.4xlarge
,\n\t\t\t\t\t\t\tcache.m6g.8xlarge
,\n\t\t\t\t\t\t\tcache.m6g.12xlarge
,\n\t\t\t\t\t\t\tcache.m6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n M5 node types:\n cache.m5.large
,\n \t\t\t\t\t\tcache.m5.xlarge
,\n \t\t\t\t\t\tcache.m5.2xlarge
,\n \t\t\t\t\t\tcache.m5.4xlarge
,\n \t\t\t\t\t\tcache.m5.12xlarge
,\n \t\t\t\t\t\tcache.m5.24xlarge
\n
\n M4 node types:\n cache.m4.large
,\n \t\t\t\t\t\tcache.m4.xlarge
,\n \t\t\t\t\t\tcache.m4.2xlarge
,\n \t\t\t\t\t\tcache.m4.4xlarge
,\n \t\t\t\t\t\tcache.m4.10xlarge
\n
\n T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro
,\n\t\t\t\t\t cache.t4g.small
,\n\t\t\t\t\t cache.t4g.medium
\n
\n T3 node types:\n cache.t3.micro
, \n \t\t\t\t\t\tcache.t3.small
,\n \t\t\t\t\t\tcache.t3.medium
\n
\n T2 node types:\n cache.t2.micro
, \n \t\t\t\t\t\tcache.t2.small
,\n \t\t\t\t\t\tcache.t2.medium
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n T1 node types:\n cache.t1.micro
\n
\n M1 node types:\n cache.m1.small
, \n\t\t\t\t\t\t cache.m1.medium
, \n\t\t\t\t\t\t cache.m1.large
,\n\t\t\t\t\t\t cache.m1.xlarge
\n
\n M3 node types:\n cache.m3.medium
,\n \t\t\t\t\t\tcache.m3.large
, \n \t\t\t\t\t\tcache.m3.xlarge
,\n \t\t\t\t\t\tcache.m3.2xlarge
\n
Compute optimized:
\nPrevious generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n C1 node types:\n cache.c1.xlarge
\n
Memory optimized:
\nCurrent generation:
\n\n R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
\n\n cache.r6g.large
,\n\t\t\t\t\t\t\tcache.r6g.xlarge
,\n\t\t\t\t\t\t\tcache.r6g.2xlarge
,\n\t\t\t\t\t\t\tcache.r6g.4xlarge
,\n\t\t\t\t\t\t\tcache.r6g.8xlarge
,\n\t\t\t\t\t\t\tcache.r6g.12xlarge
,\n\t\t\t\t\t\t\tcache.r6g.16xlarge
\n
For region availability, see Supported Node Types\n
\n\n R5 node types:\n cache.r5.large
,\n \t\t\t\t\t cache.r5.xlarge
,\n \t\t\t\t\t cache.r5.2xlarge
,\n \t\t\t\t\t cache.r5.4xlarge
,\n \t\t\t\t\t cache.r5.12xlarge
,\n \t\t\t\t\t cache.r5.24xlarge
\n
\n R4 node types:\n cache.r4.large
,\n \t\t\t\t\t cache.r4.xlarge
,\n \t\t\t\t\t cache.r4.2xlarge
,\n \t\t\t\t\t cache.r4.4xlarge
,\n \t\t\t\t\t cache.r4.8xlarge
,\n \t\t\t\t\t cache.r4.16xlarge
\n
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
\n\n M2 node types:\n cache.m2.xlarge
, \n \t\t\t\t\t\tcache.m2.2xlarge
,\n \t\t\t\t\t\tcache.m2.4xlarge
\n
\n R3 node types:\n cache.r3.large
, \n \t\t\t\t\t\tcache.r3.xlarge
,\n \t\t\t\t\t\tcache.r3.2xlarge
, \n \t\t\t\t\t\tcache.r3.4xlarge
,\n \t\t\t\t\t\tcache.r3.8xlarge
\n
\n Additional node type info\n
\nAll current generation instance types are created in Amazon VPC by\n default.
\nRedis append-only files (AOF) are not supported for T1 or T2 instances.
\nRedis Multi-AZ with automatic failover is not supported on T1\n instances.
\nRedis configuration variables appendonly
and\n appendfsync
are not supported on Redis version 2.8.22 and\n later.
The name of the cache engine (memcached
or \n redis
) used by the source cluster.
The name of the cache engine (memcached
or redis
) used by\n the source cluster.
The number of cache nodes in the source cluster.
\nFor clusters running Redis, this value must be 1. \n For clusters running Memcached, this value must be between 1 and 40.
" + "smithy.api#documentation": "The number of cache nodes in the source cluster.
\nFor clusters running Redis, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.
" } }, "PreferredAvailabilityZone": { @@ -10938,13 +11037,13 @@ "PreferredMaintenanceWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.
\nValid values for ddd
are:
\n sun
\n
\n mon
\n
\n tue
\n
\n wed
\n
\n thu
\n
\n fri
\n
\n sat
\n
Example: sun:23:00-mon:01:30
\n
Specifies the weekly time range during which maintenance on the cluster is performed.\n It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The\n minimum maintenance window is a 60 minute period.
\nValid values for ddd
are:
\n sun
\n
\n mon
\n
\n tue
\n
\n wed
\n
\n thu
\n
\n fri
\n
\n sat
\n
Example: sun:23:00-mon:01:30
\n
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing\n notifications.
" } }, "Port": { @@ -10968,38 +11067,38 @@ "VpcId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
" + "smithy.api#documentation": "The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the\n source cluster.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.elasticache#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. \n
" + "smithy.api#documentation": "If you are running Redis engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.
" } }, "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
\nFor manual snapshots, this field reflects the SnapshotRetentionLimit
for the\n source cluster when the snapshot was created. This field is otherwise ignored:\n Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot
\n operation.
\n Important\n If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
" + "smithy.api#documentation": "For an automatic snapshot, the number of days for which ElastiCache retains the\n snapshot before deleting it.
\nFor manual snapshots, this field reflects the SnapshotRetentionLimit
for\n the source cluster when the snapshot was created. This field is otherwise ignored:\n Manual snapshots do not expire, and can only be deleted using the\n DeleteSnapshot
operation.
\n Important If the value of SnapshotRetentionLimit is set\n to zero (0), backups are turned off.
" } }, "SnapshotWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "The daily time range during which ElastiCache takes daily snapshots of the source cluster.
" + "smithy.api#documentation": "The daily time range during which ElastiCache takes daily snapshots of the source\n cluster.
" } }, "NumNodeGroups": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of node groups (shards) in this snapshot.\n When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored \n replication group must be the same.
" + "smithy.api#documentation": "The number of node groups (shards) in this snapshot. When restoring from a snapshot,\n the number of node groups (shards) in the snapshot and in the restored replication group\n must be the same.
" } }, "AutomaticFailover": { "target": "com.amazonaws.elasticache#AutomaticFailoverStatus", "traits": { - "smithy.api#documentation": "Indicates the status of automatic failover for the source Redis replication group.
" + "smithy.api#documentation": "Indicates the status of automatic failover for the source Redis replication\n group.
" } }, "NodeSnapshots": { @@ -11023,12 +11122,12 @@ "DataTiering": { "target": "com.amazonaws.elasticache#DataTieringStatus", "traits": { - "smithy.api#documentation": "Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes.\n For more information, see Data tiering.
" + "smithy.api#documentation": "Enables data tiering. Data tiering is only supported for replication groups using the\n r6gd node type. This parameter must be set to true when using r6gd nodes. For more\n information, see Data tiering.
" } } }, "traits": { - "smithy.api#documentation": "Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.
" + "smithy.api#documentation": "Represents a copy of an entire Redis cluster as of the time when the snapshot was\n taken.
" } }, "com.amazonaws.elasticache#SnapshotAlreadyExistsFault": { @@ -11069,7 +11168,7 @@ "code": "SnapshotFeatureNotSupportedFault", "httpResponseCode": 400 }, - "smithy.api#documentation": "You attempted one of the following operations:
\nCreating a snapshot of a Redis cluster running on a cache.t1.micro
cache\n node.
Creating a snapshot of a cluster that is running Memcached rather than Redis.
\nNeither of these are supported by ElastiCache.
", + "smithy.api#documentation": "You attempted one of the following operations:
\nCreating a snapshot of a Redis cluster running on a\n cache.t1.micro
cache node.
Creating a snapshot of a cluster that is running Memcached rather than\n Redis.
\nNeither of these are supported by ElastiCache.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -11112,7 +11211,7 @@ "code": "SnapshotQuotaExceededFault", "httpResponseCode": 400 }, - "smithy.api#documentation": "The request cannot be processed because it would exceed the maximum number of snapshots.
", + "smithy.api#documentation": "The request cannot be processed because it would exceed the maximum number of\n snapshots.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -11203,7 +11302,7 @@ "CustomerNodeEndpointList": { "target": "com.amazonaws.elasticache#CustomerNodeEndpointList", "traits": { - "smithy.api#documentation": "List of endpoints from which data should be migrated. For Redis (cluster mode disabled), list should have only one element.
", + "smithy.api#documentation": "List of endpoints from which data should be migrated. For Redis (cluster mode\n disabled), list should have only one element.
", "smithy.api#required": {} } } @@ -11247,12 +11346,12 @@ "SupportedNetworkTypes": { "target": "com.amazonaws.elasticache#NetworkTypeList", "traits": { - "smithy.api#documentation": "Either ipv4
| ipv6
| dual_stack
. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the \n Nitro system.
Either ipv4
| ipv6
| dual_stack
. IPv6 is\n supported for workloads using Redis engine version 6.2 onward or Memcached engine\n version 1.6.6 on all instances built on the Nitro system.
Represents the subnet associated with a cluster. \n This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
" + "smithy.api#documentation": "Represents the subnet associated with a cluster. This parameter refers to subnets\n defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
" } }, "com.amazonaws.elasticache#SubnetIdentifierList": { @@ -11302,7 +11401,7 @@ "code": "SubnetNotAllowedFault", "httpResponseCode": 400 }, - "smithy.api#documentation": "At least one subnet ID does not match the other subnet IDs. This mismatch typically occurs when a\n 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.
", + "smithy.api#documentation": "At least one subnet ID does not match the other subnet IDs. This mismatch typically\n occurs when a user sets one subnet ID to a regional Availability Zone and a different\n one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed\n on this service.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -11341,7 +11440,7 @@ } }, "traits": { - "smithy.api#documentation": "A tag that can be added to an ElastiCache cluster or replication group. \n Tags are composed of a Key/Value pair. 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. A tag with a null Value is permitted.
" + "smithy.api#documentation": "A tag that can be added to an ElastiCache cluster or replication group. Tags are\n composed of a Key/Value pair. You can use tags to categorize and track all your\n ElastiCache resources, with the exception of global replication group. When you add or\n remove tags on replication groups, those actions will be replicated to all nodes in the\n replication group. A tag with a null Value is permitted.
" } }, "com.amazonaws.elasticache#TagList": { @@ -11364,7 +11463,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the output from the AddTagsToResource
, \n ListTagsForResource
, and RemoveTagsFromResource
operations.
Represents the output from the AddTagsToResource
,\n ListTagsForResource
, and RemoveTagsFromResource
\n operations.
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.
", + "smithy.api#documentation": "The request cannot be processed because it would cause the resource to have more than\n the allowed number of tags. The maximum number of tags permitted on a resource is\n 50.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -11439,7 +11538,7 @@ } ], "traits": { - "smithy.api#documentation": "Represents the input of a TestFailover
operation which test automatic failover on\n 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 \n 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.
\n\n Note the following\n
\nA customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and Amazon CLI) \n in any rolling 24-hour period.
\nIf calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.
\n\n
If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, \n the first node replacement must complete before a subsequent call can be made.
\nTo determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console,\n the Amazon CLI, or the ElastiCache API.\n Look for the following automatic failover related events, listed here in order of occurrance:
\nReplication group message: Test Failover API called for node group
\n
Cache cluster message: Failover from primary node
\n
Replication group message: Failover from primary node
\n
Cache cluster message: Recovering cache nodes
\n
Cache cluster message: Finished recovery for cache nodes
\n
For more information see:
\n\n Viewing ElastiCache Events\n in the ElastiCache User Guide\n
\n\n DescribeEvents in the ElastiCache API Reference
\nAlso see, Testing Multi-AZ in the ElastiCache User Guide.
" + "smithy.api#documentation": "Represents the input of a TestFailover
operation which test automatic\n failover on a specified node group (called shard in the console) in a replication group\n (called cluster in the console).
This API is designed for testing the behavior of your application in case of\n ElastiCache failover. It is not designed to be an operational tool for initiating a\n failover to overcome a problem you may have with the cluster. Moreover, in certain\n conditions such as large-scale operational events, Amazon may block this API.
\n\n Note the following\n
\nA customer can use this operation to test automatic failover on up to 5 shards\n (called node groups in the ElastiCache API and Amazon CLI) in any rolling\n 24-hour period.
\nIf calling this operation on shards in different clusters (called replication\n groups in the API and CLI), the calls can be made concurrently.
\n\n
If calling this operation multiple times on different shards in the same Redis\n (cluster mode enabled) replication group, the first node replacement must\n complete before a subsequent call can be made.
\nTo determine whether the node replacement is complete you can check Events\n using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API.\n Look for the following automatic failover related events, listed here in order\n of occurrance:
\nReplication group message: Test Failover API called for node\n group
\n
Cache cluster message: Failover from primary node\n
\n
Replication group message: Failover from primary node\n
\n
Cache cluster message: Recovering cache nodes\n
\n
Cache cluster message: Finished recovery for cache nodes\n
\n
For more information see:
\n\n Viewing\n ElastiCache Events in the ElastiCache User\n Guide\n
\n\n DescribeEvents in the ElastiCache API Reference
\nAlso see, Testing\n Multi-AZ in the ElastiCache User Guide.
" } }, "com.amazonaws.elasticache#TestFailoverMessage": { @@ -11455,7 +11554,7 @@ "NodeGroupId": { "target": "com.amazonaws.elasticache#AllowedNodeGroupId", "traits": { - "smithy.api#documentation": "The name of the node group (called shard in the console) in this replication group on\n which automatic failover is to be tested.\n You may test automatic failover on up to 5 node groups in any rolling 24-hour period.
", + "smithy.api#documentation": "The name of the node group (called shard in the console) in this replication group on\n which automatic failover is to be tested. You may test automatic failover on up to 5\n node groups in any rolling 24-hour period.
", "smithy.api#required": {} } } @@ -11484,6 +11583,65 @@ "ReplicationGroup": { "target": "com.amazonaws.elasticache#ReplicationGroup" } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.elasticache#TestMigration": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticache#TestMigrationMessage" + }, + "output": { + "target": "com.amazonaws.elasticache#TestMigrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.elasticache#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.elasticache#InvalidReplicationGroupStateFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupAlreadyUnderMigrationFault" + }, + { + "target": "com.amazonaws.elasticache#ReplicationGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "Async API to test connection between source and target replication group.
" + } + }, + "com.amazonaws.elasticache#TestMigrationMessage": { + "type": "structure", + "members": { + "ReplicationGroupId": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "The ID of the replication group to which data is to be migrated.
", + "smithy.api#required": {} + } + }, + "CustomerNodeEndpointList": { + "target": "com.amazonaws.elasticache#CustomerNodeEndpointList", + "traits": { + "smithy.api#documentation": "List of endpoints from which data should be migrated. List should have only one\n element.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.elasticache#TestMigrationResponse": { + "type": "structure", + "members": { + "ReplicationGroup": { + "target": "com.amazonaws.elasticache#ReplicationGroup" + } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.elasticache#TimeRangeFilter": { @@ -11503,7 +11661,7 @@ } }, "traits": { - "smithy.api#documentation": "Filters update actions from the service updates that are in available status during the time range.
" + "smithy.api#documentation": "Filters update actions from the service updates that are in available status during\n the time range.
" } }, "com.amazonaws.elasticache#TransitEncryptionMode": { @@ -11564,7 +11722,7 @@ } }, "traits": { - "smithy.api#documentation": "Update action that has failed to be processed for the corresponding apply/stop request
" + "smithy.api#documentation": "Update action that has failed to be processed for the corresponding apply/stop\n request
" } }, "com.amazonaws.elasticache#UnprocessedUpdateActionList": { @@ -11618,13 +11776,13 @@ "ServiceUpdateRecommendedApplyByDate": { "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "The recommended date to apply the service update to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.
" + "smithy.api#documentation": "The recommended date to apply the service update to ensure compliance. For information\n on compliance, see Self-Service Security Updates for Compliance.
" } }, "ServiceUpdateType": { "target": "com.amazonaws.elasticache#ServiceUpdateType", "traits": { - "smithy.api#documentation": "Reflects the nature of the service update
" + "smithy.api#documentation": "Reflects the nature of the service update
" } }, "UpdateActionAvailableDate": { @@ -11654,7 +11812,7 @@ "SlaMet": { "target": "com.amazonaws.elasticache#SlaMet", "traits": { - "smithy.api#documentation": "If yes, all nodes in the replication group have been updated by the recommended apply-by date. If no, at least one node in the replication group have not been updated by the recommended apply-by date. If N/A, the replication group was created after the\n recommended apply-by date.
" + "smithy.api#documentation": "If yes, all nodes in the replication group have been updated by the recommended\n apply-by date. If no, at least one node in the replication group have not been updated\n by the recommended apply-by date. If N/A, the replication group was created after the\n recommended apply-by date.
" } }, "NodeGroupUpdateStatus": { @@ -11789,7 +11947,7 @@ "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "An optional marker returned from a prior request. \n Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords
.
An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords
.
Indicates user group status. Can be \"creating\", \"active\", \"modifying\", \"deleting\".
" + "smithy.api#documentation": "Indicates user group status. Can be \"creating\", \"active\", \"modifying\",\n \"deleting\".
" } }, "Engine": {