Skip to content

Commit 1cbb8d6

Browse files
author
awstools
committed
feat(client-elasticache): AWS ElastiCache SDK now supports using APIs with newly launched Valkey engine. Please refer to updated AWS ElastiCache public documentation for detailed information on API usage.
1 parent 4ddaa97 commit 1cbb8d6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+558
-455
lines changed

‎clients/client-elasticache/src/commands/AddTagsToResourceCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ export interface AddTagsToResourceCommandOutput extends TagListMessage, __Metada
9797
* <p>The requested replication group is not in the <code>available</code> state.</p>
9898
*
9999
* @throws {@link InvalidServerlessCacheSnapshotStateFault} (client fault)
100-
* <p>The state of the serverless cache snapshot was not received. Available for Redis OSS and Serverless Memcached only.</p>
100+
* <p>The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.</p>
101101
*
102102
* @throws {@link InvalidServerlessCacheStateFault} (client fault)
103103
* <p>The account for these credentials is not currently active.</p>
@@ -112,7 +112,7 @@ export interface AddTagsToResourceCommandOutput extends TagListMessage, __Metada
112112
* <p>The serverless cache was not found or does not exist.</p>
113113
*
114114
* @throws {@link ServerlessCacheSnapshotNotFoundFault} (client fault)
115-
* <p>This serverless cache snapshot could not be found or does not exist. Available for Redis OSS and Serverless Memcached only.</p>
115+
* <p>This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.</p>
116116
*
117117
* @throws {@link SnapshotNotFoundFault} (client fault)
118118
* <p>The requested snapshot name does not refer to an existing snapshot.</p>

‎clients/client-elasticache/src/commands/CompleteMigrationCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,7 @@ export interface CompleteMigrationCommandOutput extends CompleteMigrationRespons
161161
* // IpDiscovery: "ipv4" || "ipv6",
162162
* // TransitEncryptionMode: "preferred" || "required",
163163
* // ClusterMode: "enabled" || "disabled" || "compatible",
164+
* // Engine: "STRING_VALUE",
164165
* // },
165166
* // };
166167
*

‎clients/client-elasticache/src/commands/CopyServerlessCacheSnapshotCommand.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export interface CopyServerlessCacheSnapshotCommandOutput
3030
__MetadataBearer {}
3131

3232
/**
33-
* <p>Creates a copy of an existing serverless cache’s snapshot. Available for Redis OSS and Serverless Memcached only.</p>
33+
* <p>Creates a copy of an existing serverless cache’s snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.</p>
3434
* @example
3535
* Use a bare-bones client and the command you need to make an API call.
3636
* ```javascript
@@ -83,16 +83,16 @@ export interface CopyServerlessCacheSnapshotCommandOutput
8383
* <p>The value for a parameter is invalid.</p>
8484
*
8585
* @throws {@link InvalidServerlessCacheSnapshotStateFault} (client fault)
86-
* <p>The state of the serverless cache snapshot was not received. Available for Redis OSS and Serverless Memcached only.</p>
86+
* <p>The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.</p>
8787
*
8888
* @throws {@link ServerlessCacheSnapshotAlreadyExistsFault} (client fault)
89-
* <p>A serverless cache snapshot with this name already exists. Available for Redis OSS and Serverless Memcached only.</p>
89+
* <p>A serverless cache snapshot with this name already exists. Available for Valkey, Redis OSS and Serverless Memcached only.</p>
9090
*
9191
* @throws {@link ServerlessCacheSnapshotNotFoundFault} (client fault)
92-
* <p>This serverless cache snapshot could not be found or does not exist. Available for Redis OSS and Serverless Memcached only.</p>
92+
* <p>This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.</p>
9393
*
9494
* @throws {@link ServerlessCacheSnapshotQuotaExceededFault} (client fault)
95-
* <p>The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Redis OSS and Serverless Memcached only.</p>
95+
* <p>The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Valkey, Redis OSS and Serverless Memcached only.</p>
9696
*
9797
* @throws {@link ServiceLinkedRoleNotFoundFault} (client fault)
9898
* <p>The specified service linked role (SLR) was not found.</p>

‎clients/client-elasticache/src/commands/CopySnapshotCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat
3030
/**
3131
* <p>Makes a copy of an existing snapshot.</p>
3232
* <note>
33-
* <p>This operation is valid for Redis OSS only.</p>
33+
* <p>This operation is valid for Valkey or Redis OSS only.</p>
3434
* </note>
3535
* <important>
3636
* <p>Users or groups that have permissions to use the <code>CopySnapshot</code>

‎clients/client-elasticache/src/commands/CreateCacheClusterCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ export interface CreateCacheClusterCommandOutput extends CreateCacheClusterResul
2929

3030
/**
3131
* <p>Creates a cluster. All nodes in the cluster run the same protocol-compliant cache
32-
* engine software, either Memcached or Redis OSS.</p>
33-
* <p>This operation is not supported for Redis OSS (cluster mode enabled) clusters.</p>
32+
* engine software, either Memcached, Valkey or Redis OSS.</p>
33+
* <p>This operation is not supported for Valkey or Redis OSS (cluster mode enabled) clusters.</p>
3434
* @example
3535
* Use a bare-bones client and the command you need to make an API call.
3636
* ```javascript

‎clients/client-elasticache/src/commands/CreateGlobalReplicationGroupCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ export interface CreateGlobalReplicationGroupCommandOutput
3030
__MetadataBearer {}
3131

3232
/**
33-
* <p>Global Datastore for Redis OSS offers fully managed, fast, reliable and secure
34-
* cross-region replication. Using Global Datastore for Redis OSS, you can create cross-region
35-
* read replica clusters for ElastiCache (Redis OSS) to enable low-latency reads and disaster
33+
* <p>Global Datastore offers fully managed, fast, reliable and secure
34+
* cross-region replication. Using Global Datastore with Valkey or Redis OSS, you can create cross-region
35+
* read replica clusters for ElastiCache to enable low-latency reads and disaster
3636
* recovery across regions. For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html">Replication
3737
* Across Regions Using Global Datastore</a>. </p>
3838
* <ul>

‎clients/client-elasticache/src/commands/CreateReplicationGroupCommand.ts

+9-9
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,18 @@ export interface CreateReplicationGroupCommandInput extends CreateReplicationGro
2828
export interface CreateReplicationGroupCommandOutput extends CreateReplicationGroupResult, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a Redis OSS (cluster mode disabled) or a Redis OSS (cluster mode enabled) replication
31+
* <p>Creates a Valkey or Redis OSS (cluster mode disabled) or a Valkey or Redis OSS (cluster mode enabled) replication
3232
* group.</p>
3333
* <p>This API can be used to create a standalone regional replication group or a secondary
3434
* replication group associated with a Global datastore.</p>
35-
* <p>A Redis OSS (cluster mode disabled) replication group is a collection of nodes, where
35+
* <p>A Valkey or Redis OSS (cluster mode disabled) replication group is a collection of nodes, where
3636
* one of the nodes is a read/write primary and the others are read-only replicas.
3737
* Writes to the primary are asynchronously propagated to the replicas.</p>
38-
* <p>A Redis OSS cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI:
38+
* <p>A Valkey or Redis OSS cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI:
3939
* node groups). Each shard has a primary node and up to 5 read-only replica nodes. The
4040
* configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which
4141
* is the maximum number or replicas allowed. </p>
42-
* <p>The node or shard limit can be increased to a maximum of 500 per cluster if the Redis OSS
42+
* <p>The node or shard limit can be increased to a maximum of 500 per cluster if the Valkey or Redis OSS
4343
* engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node
4444
* cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500
4545
* shards (single primary and no replicas). Make sure there are enough available IP
@@ -50,14 +50,13 @@ export interface CreateReplicationGroupCommandOutput extends CreateReplicationGr
5050
* <p>To request a limit increase, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">Amazon Service Limits</a> and
5151
* choose the limit type <b>Nodes per cluster per instance
5252
* type</b>. </p>
53-
* <p>When a Redis OSS (cluster mode disabled) replication group has been successfully created,
53+
* <p>When a Valkey or Redis OSS (cluster mode disabled) replication group has been successfully created,
5454
* you can add one or more read replicas to it, up to a total of 5 read replicas. If you
55-
* need to increase or decrease the number of node groups (console: shards), you can use ElastiCache (Redis OSS) scaling.
56-
* For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html">Scaling
57-
* ElastiCache (Redis OSS) Clusters</a> in the <i>ElastiCache User
55+
* need to increase or decrease the number of node groups (console: shards), you can use scaling.
56+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html">Scaling self-designed clusters</a> in the <i>ElastiCache User
5857
* Guide</i>.</p>
5958
* <note>
60-
* <p>This operation is valid for Redis OSS only.</p>
59+
* <p>This operation is valid for Valkey and Redis OSS only.</p>
6160
* </note>
6261
* @example
6362
* Use a bare-bones client and the command you need to make an API call.
@@ -272,6 +271,7 @@ export interface CreateReplicationGroupCommandOutput extends CreateReplicationGr
272271
* // IpDiscovery: "ipv4" || "ipv6",
273272
* // TransitEncryptionMode: "preferred" || "required",
274273
* // ClusterMode: "enabled" || "disabled" || "compatible",
274+
* // Engine: "STRING_VALUE",
275275
* // },
276276
* // };
277277
*

‎clients/client-elasticache/src/commands/CreateServerlessCacheSnapshotCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface CreateServerlessCacheSnapshotCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Redis OSS and Serverless Memcached only.</p>
36+
* <p>This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Valkey, Redis OSS and Serverless Memcached only.</p>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.
3939
* ```javascript
@@ -92,10 +92,10 @@ export interface CreateServerlessCacheSnapshotCommandOutput
9292
* <p>The serverless cache was not found or does not exist.</p>
9393
*
9494
* @throws {@link ServerlessCacheSnapshotAlreadyExistsFault} (client fault)
95-
* <p>A serverless cache snapshot with this name already exists. Available for Redis OSS and Serverless Memcached only.</p>
95+
* <p>A serverless cache snapshot with this name already exists. Available for Valkey, Redis OSS and Serverless Memcached only.</p>
9696
*
9797
* @throws {@link ServerlessCacheSnapshotQuotaExceededFault} (client fault)
98-
* <p>The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Redis OSS and Serverless Memcached only.</p>
98+
* <p>The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Valkey, Redis OSS and Serverless Memcached only.</p>
9999
*
100100
* @throws {@link ServiceLinkedRoleNotFoundFault} (client fault)
101101
* <p>The specified service linked role (SLR) was not found.</p>

‎clients/client-elasticache/src/commands/CreateSnapshotCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotResult, __Met
3131
* <p>Creates a copy of an entire cluster or replication group at a specific moment in
3232
* time.</p>
3333
* <note>
34-
* <p>This operation is valid for Redis OSS only.</p>
34+
* <p>This operation is valid for Valkey or Redis OSS only.</p>
3535
* </note>
3636
* @example
3737
* Use a bare-bones client and the command you need to make an API call.
@@ -141,12 +141,12 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotResult, __Met
141141
* <p>You attempted one of the following operations:</p>
142142
* <ul>
143143
* <li>
144-
* <p>Creating a snapshot of a Redis OSS cluster running on a
144+
* <p>Creating a snapshot of a Valkey or Redis OSS cluster running on a
145145
* <code>cache.t1.micro</code> cache node.</p>
146146
* </li>
147147
* <li>
148148
* <p>Creating a snapshot of a cluster that is running Memcached rather than
149-
* Redis OSS.</p>
149+
* Valkey or Redis OSS.</p>
150150
* </li>
151151
* </ul>
152152
* <p>Neither of these are supported by ElastiCache.</p>

‎clients/client-elasticache/src/commands/CreateUserCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface CreateUserCommandInput extends CreateUserMessage {}
2828
export interface CreateUserCommandOutput extends User, __MetadataBearer {}
2929

3030
/**
31-
* <p>For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user. For more information, see
31+
* <p>For Valkey engine version 7.2 onwards and Redis OSS 6.0 and onwards: Creates a user. For more information, see
3232
* <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>.</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-elasticache/src/commands/CreateUserGroupCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface CreateUserGroupCommandInput extends CreateUserGroupMessage {}
2828
export interface CreateUserGroupCommandOutput extends UserGroup, __MetadataBearer {}
2929

3030
/**
31-
* <p>For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user group. For more
31+
* <p>For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Creates a user group. For more
3232
* information, see <a href="http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html">Using Role Based Access Control (RBAC)</a>
3333
* </p>
3434
* @example

‎clients/client-elasticache/src/commands/DecreaseReplicaCountCommand.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ export interface DecreaseReplicaCountCommandInput extends DecreaseReplicaCountMe
2828
export interface DecreaseReplicaCountCommandOutput extends DecreaseReplicaCountResult, __MetadataBearer {}
2929

3030
/**
31-
* <p>Dynamically decreases the number of replicas in a Redis OSS (cluster mode disabled)
31+
* <p>Dynamically decreases the number of replicas in a Valkey or Redis OSS (cluster mode disabled)
3232
* replication group or the number of replica nodes in one or more node groups (shards) of
33-
* a Redis OSS (cluster mode enabled) replication group. This operation is performed with no
33+
* a Valkey or Redis OSS (cluster mode enabled) replication group. This operation is performed with no
3434
* cluster down time.</p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.
@@ -180,6 +180,7 @@ export interface DecreaseReplicaCountCommandOutput extends DecreaseReplicaCountR
180180
* // IpDiscovery: "ipv4" || "ipv6",
181181
* // TransitEncryptionMode: "preferred" || "required",
182182
* // ClusterMode: "enabled" || "disabled" || "compatible",
183+
* // Engine: "STRING_VALUE",
183184
* // },
184185
* // };
185186
*

‎clients/client-elasticache/src/commands/DeleteCacheClusterCommand.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ export interface DeleteCacheClusterCommandOutput extends DeleteCacheClusterResul
3535
* <p>This operation is not valid for:</p>
3636
* <ul>
3737
* <li>
38-
* <p>Redis OSS (cluster mode enabled) clusters</p>
38+
* <p>Valkey or Redis OSS (cluster mode enabled) clusters</p>
3939
* </li>
4040
* <li>
41-
* <p>Redis OSS (cluster mode disabled) clusters</p>
41+
* <p>Valkey or Redis OSS (cluster mode disabled) clusters</p>
4242
* </li>
4343
* <li>
4444
* <p>A cluster that is the last read replica of a replication group</p>
@@ -50,7 +50,7 @@ export interface DeleteCacheClusterCommandOutput extends DeleteCacheClusterResul
5050
* <p>A node group (shard) that has Multi-AZ mode enabled</p>
5151
* </li>
5252
* <li>
53-
* <p>A cluster from a Redis OSS (cluster mode enabled) replication group</p>
53+
* <p>A cluster from a Valkey or Redis OSS (cluster mode enabled) replication group</p>
5454
* </li>
5555
* <li>
5656
* <p>A cluster that is not in the <code>available</code> state</p>
@@ -210,12 +210,12 @@ export interface DeleteCacheClusterCommandOutput extends DeleteCacheClusterResul
210210
* <p>You attempted one of the following operations:</p>
211211
* <ul>
212212
* <li>
213-
* <p>Creating a snapshot of a Redis OSS cluster running on a
213+
* <p>Creating a snapshot of a Valkey or Redis OSS cluster running on a
214214
* <code>cache.t1.micro</code> cache node.</p>
215215
* </li>
216216
* <li>
217217
* <p>Creating a snapshot of a cluster that is running Memcached rather than
218-
* Redis OSS.</p>
218+
* Valkey or Redis OSS.</p>
219219
* </li>
220220
* </ul>
221221
* <p>Neither of these are supported by ElastiCache.</p>

‎clients/client-elasticache/src/commands/DeleteReplicationGroupCommand.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,7 @@ export interface DeleteReplicationGroupCommandOutput extends DeleteReplicationGr
181181
* // IpDiscovery: "ipv4" || "ipv6",
182182
* // TransitEncryptionMode: "preferred" || "required",
183183
* // ClusterMode: "enabled" || "disabled" || "compatible",
184+
* // Engine: "STRING_VALUE",
184185
* // },
185186
* // };
186187
*
@@ -211,12 +212,12 @@ export interface DeleteReplicationGroupCommandOutput extends DeleteReplicationGr
211212
* <p>You attempted one of the following operations:</p>
212213
* <ul>
213214
* <li>
214-
* <p>Creating a snapshot of a Redis OSS cluster running on a
215+
* <p>Creating a snapshot of a Valkey or Redis OSS cluster running on a
215216
* <code>cache.t1.micro</code> cache node.</p>
216217
* </li>
217218
* <li>
218219
* <p>Creating a snapshot of a cluster that is running Memcached rather than
219-
* Redis OSS.</p>
220+
* Valkey or Redis OSS.</p>
220221
* </li>
221222
* </ul>
222223
* <p>Neither of these are supported by ElastiCache.</p>

‎clients/client-elasticache/src/commands/DeleteServerlessCacheCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ export interface DeleteServerlessCacheCommandOutput extends DeleteServerlessCach
112112
* <p>The serverless cache was not found or does not exist.</p>
113113
*
114114
* @throws {@link ServerlessCacheSnapshotAlreadyExistsFault} (client fault)
115-
* <p>A serverless cache snapshot with this name already exists. Available for Redis OSS and Serverless Memcached only.</p>
115+
* <p>A serverless cache snapshot with this name already exists. Available for Valkey, Redis OSS and Serverless Memcached only.</p>
116116
*
117117
* @throws {@link ServiceLinkedRoleNotFoundFault} (client fault)
118118
* <p>The specified service linked role (SLR) was not found.</p>

‎clients/client-elasticache/src/commands/DeleteServerlessCacheSnapshotCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface DeleteServerlessCacheSnapshotCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>Deletes an existing serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.</p>
36+
* <p>Deletes an existing serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.</p>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.
3939
* ```javascript
@@ -75,10 +75,10 @@ export interface DeleteServerlessCacheSnapshotCommandOutput
7575
* <p>The value for a parameter is invalid.</p>
7676
*
7777
* @throws {@link InvalidServerlessCacheSnapshotStateFault} (client fault)
78-
* <p>The state of the serverless cache snapshot was not received. Available for Redis OSS and Serverless Memcached only.</p>
78+
* <p>The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.</p>
7979
*
8080
* @throws {@link ServerlessCacheSnapshotNotFoundFault} (client fault)
81-
* <p>This serverless cache snapshot could not be found or does not exist. Available for Redis OSS and Serverless Memcached only.</p>
81+
* <p>This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.</p>
8282
*
8383
* @throws {@link ServiceLinkedRoleNotFoundFault} (client fault)
8484
* <p>The specified service linked role (SLR) was not found.</p>

0 commit comments

Comments
 (0)