Skip to content

Commit d4a2f23

Browse files
author
awstools
committed
feat(client-memorydb): Amazon MemoryDB SDK now supports all APIs for newly launched Valkey engine. Please refer to the updated Amazon MemoryDB public documentation for detailed information on API usage.
1 parent 1cbb8d6 commit d4a2f23

19 files changed

+127
-29
lines changed

clients/client-memorydb/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66

77
AWS SDK for JavaScript MemoryDB Client for Node.js, Browser and React Native.
88

9-
<p>MemoryDB is a fully managed, Redis OSS-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures.
9+
<p>MemoryDB for Redis is a fully managed, Redis-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures.
1010

11-
MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis OSS, a popular open source data store, enabling you to leverage Redis OSS’ flexible and friendly data structures, APIs, and commands.</p>
11+
MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis, a popular open source data store, enabling you to leverage Redis’ flexible and friendly data structures, APIs, and commands.</p>
1212

1313
## Installing
1414

clients/client-memorydb/src/MemoryDB.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -758,9 +758,9 @@ export interface MemoryDB {
758758
}
759759

760760
/**
761-
* <p>MemoryDB is a fully managed, Redis OSS-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures.
761+
* <p>MemoryDB for Redis is a fully managed, Redis-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures.
762762
*
763-
* MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis OSS, a popular open source data store, enabling you to leverage Redis OSS’ flexible and friendly data structures, APIs, and commands.</p>
763+
* MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis, a popular open source data store, enabling you to leverage Redis’ flexible and friendly data structures, APIs, and commands.</p>
764764
* @public
765765
*/
766766
export class MemoryDB extends MemoryDBClient implements MemoryDB {}

clients/client-memorydb/src/MemoryDBClient.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -396,9 +396,9 @@ export type MemoryDBClientResolvedConfigType = __SmithyResolvedConfiguration<__H
396396
export interface MemoryDBClientResolvedConfig extends MemoryDBClientResolvedConfigType {}
397397

398398
/**
399-
* <p>MemoryDB is a fully managed, Redis OSS-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures.
399+
* <p>MemoryDB for Redis is a fully managed, Redis-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures.
400400
*
401-
* MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis OSS, a popular open source data store, enabling you to leverage Redis OSS’ flexible and friendly data structures, APIs, and commands.</p>
401+
* MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis, a popular open source data store, enabling you to leverage Redis’ flexible and friendly data structures, APIs, and commands.</p>
402402
* @public
403403
*/
404404
export class MemoryDBClient extends __Client<

clients/client-memorydb/src/commands/BatchUpdateClusterCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ export interface BatchUpdateClusterCommandOutput extends BatchUpdateClusterRespo
9494
* // Port: Number("int"),
9595
* // },
9696
* // NodeType: "STRING_VALUE",
97+
* // Engine: "STRING_VALUE",
9798
* // EngineVersion: "STRING_VALUE",
9899
* // EnginePatchVersion: "STRING_VALUE",
99100
* // ParameterGroupName: "STRING_VALUE",

clients/client-memorydb/src/commands/CopySnapshotCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResponse, __Metad
6060
* // Name: "STRING_VALUE",
6161
* // Description: "STRING_VALUE",
6262
* // NodeType: "STRING_VALUE",
63+
* // Engine: "STRING_VALUE",
6364
* // EngineVersion: "STRING_VALUE",
6465
* // MaintenanceWindow: "STRING_VALUE",
6566
* // TopicArn: "STRING_VALUE",

clients/client-memorydb/src/commands/CreateClusterCommand.ts

+2
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
6464
* ],
6565
* SnapshotWindow: "STRING_VALUE",
6666
* ACLName: "STRING_VALUE", // required
67+
* Engine: "STRING_VALUE",
6768
* EngineVersion: "STRING_VALUE",
6869
* AutoMinorVersionUpgrade: true || false,
6970
* DataTiering: true || false,
@@ -118,6 +119,7 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
118119
* // Port: Number("int"),
119120
* // },
120121
* // NodeType: "STRING_VALUE",
122+
* // Engine: "STRING_VALUE",
121123
* // EngineVersion: "STRING_VALUE",
122124
* // EnginePatchVersion: "STRING_VALUE",
123125
* // ParameterGroupName: "STRING_VALUE",

clients/client-memorydb/src/commands/CreateSnapshotCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotResponse, __M
5959
* // Name: "STRING_VALUE",
6060
* // Description: "STRING_VALUE",
6161
* // NodeType: "STRING_VALUE",
62+
* // Engine: "STRING_VALUE",
6263
* // EngineVersion: "STRING_VALUE",
6364
* // MaintenanceWindow: "STRING_VALUE",
6465
* // TopicArn: "STRING_VALUE",

clients/client-memorydb/src/commands/DeleteClusterCommand.ts

+1-5
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,6 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
2929

3030
/**
3131
* <p>Deletes a cluster. It also deletes all associated nodes and node endpoints</p>
32-
* <note>
33-
* <p>
34-
* <code>CreateSnapshot</code> permission is required to create a final snapshot.
35-
* Without this permission, the API call will fail with an <code>Access Denied</code> exception.</p>
36-
* </note>
3732
* @example
3833
* Use a bare-bones client and the command you need to make an API call.
3934
* ```javascript
@@ -94,6 +89,7 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
9489
* // Port: Number("int"),
9590
* // },
9691
* // NodeType: "STRING_VALUE",
92+
* // Engine: "STRING_VALUE",
9793
* // EngineVersion: "STRING_VALUE",
9894
* // EnginePatchVersion: "STRING_VALUE",
9995
* // ParameterGroupName: "STRING_VALUE",

clients/client-memorydb/src/commands/DeleteSnapshotCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ export interface DeleteSnapshotCommandOutput extends DeleteSnapshotResponse, __M
5151
* // Name: "STRING_VALUE",
5252
* // Description: "STRING_VALUE",
5353
* // NodeType: "STRING_VALUE",
54+
* // Engine: "STRING_VALUE",
5455
* // EngineVersion: "STRING_VALUE",
5556
* // MaintenanceWindow: "STRING_VALUE",
5657
* // TopicArn: "STRING_VALUE",

clients/client-memorydb/src/commands/DescribeClustersCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ export interface DescribeClustersCommandOutput extends DescribeClustersResponse,
9393
* // Port: Number("int"),
9494
* // },
9595
* // NodeType: "STRING_VALUE",
96+
* // Engine: "STRING_VALUE",
9697
* // EngineVersion: "STRING_VALUE",
9798
* // EnginePatchVersion: "STRING_VALUE",
9899
* // ParameterGroupName: "STRING_VALUE",

clients/client-memorydb/src/commands/DescribeEngineVersionsCommand.ts

+3-1
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,15 @@ export interface DescribeEngineVersionsCommandInput extends DescribeEngineVersio
2828
export interface DescribeEngineVersionsCommandOutput extends DescribeEngineVersionsResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Returns a list of the available Redis OSS engine versions.</p>
31+
* <p>Returns a list of the available engine versions.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript
3535
* import { MemoryDBClient, DescribeEngineVersionsCommand } from "@aws-sdk/client-memorydb"; // ES Modules import
3636
* // const { MemoryDBClient, DescribeEngineVersionsCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import
3737
* const client = new MemoryDBClient(config);
3838
* const input = { // DescribeEngineVersionsRequest
39+
* Engine: "STRING_VALUE",
3940
* EngineVersion: "STRING_VALUE",
4041
* ParameterGroupFamily: "STRING_VALUE",
4142
* MaxResults: Number("int"),
@@ -48,6 +49,7 @@ export interface DescribeEngineVersionsCommandOutput extends DescribeEngineVersi
4849
* // NextToken: "STRING_VALUE",
4950
* // EngineVersions: [ // EngineVersionInfoList
5051
* // { // EngineVersionInfo
52+
* // Engine: "STRING_VALUE",
5153
* // EngineVersion: "STRING_VALUE",
5254
* // EnginePatchVersion: "STRING_VALUE",
5355
* // ParameterGroupFamily: "STRING_VALUE",

clients/client-memorydb/src/commands/DescribeServiceUpdatesCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ export interface DescribeServiceUpdatesCommandOutput extends DescribeServiceUpda
5858
* // Description: "STRING_VALUE",
5959
* // Status: "available" || "in-progress" || "complete" || "scheduled",
6060
* // Type: "security-update",
61+
* // Engine: "STRING_VALUE",
6162
* // NodesUpdated: "STRING_VALUE",
6263
* // AutoUpdateStartDate: new Date("TIMESTAMP"),
6364
* // },

clients/client-memorydb/src/commands/DescribeSnapshotsCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ export interface DescribeSnapshotsCommandOutput extends DescribeSnapshotsRespons
5959
* // Name: "STRING_VALUE",
6060
* // Description: "STRING_VALUE",
6161
* // NodeType: "STRING_VALUE",
62+
* // Engine: "STRING_VALUE",
6263
* // EngineVersion: "STRING_VALUE",
6364
* // MaintenanceWindow: "STRING_VALUE",
6465
* // TopicArn: "STRING_VALUE",

clients/client-memorydb/src/commands/FailoverShardCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ export interface FailoverShardCommandOutput extends FailoverShardResponse, __Met
9090
* // Port: Number("int"),
9191
* // },
9292
* // NodeType: "STRING_VALUE",
93+
* // Engine: "STRING_VALUE",
9394
* // EngineVersion: "STRING_VALUE",
9495
* // EnginePatchVersion: "STRING_VALUE",
9596
* // ParameterGroupName: "STRING_VALUE",

clients/client-memorydb/src/commands/UpdateClusterCommand.ts

+2
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ export interface UpdateClusterCommandOutput extends UpdateClusterResponse, __Met
4848
* SnapshotWindow: "STRING_VALUE",
4949
* SnapshotRetentionLimit: Number("int"),
5050
* NodeType: "STRING_VALUE",
51+
* Engine: "STRING_VALUE",
5152
* EngineVersion: "STRING_VALUE",
5253
* ReplicaConfiguration: { // ReplicaConfigurationRequest
5354
* ReplicaCount: Number("int"),
@@ -107,6 +108,7 @@ export interface UpdateClusterCommandOutput extends UpdateClusterResponse, __Met
107108
* // Port: Number("int"),
108109
* // },
109110
* // NodeType: "STRING_VALUE",
111+
* // Engine: "STRING_VALUE",
110112
* // EngineVersion: "STRING_VALUE",
111113
* // EnginePatchVersion: "STRING_VALUE",
112114
* // ParameterGroupName: "STRING_VALUE",

clients/client-memorydb/src/index.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
// smithy-typescript generated code
22
/* eslint-disable */
33
/**
4-
* <p>MemoryDB is a fully managed, Redis OSS-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures.
4+
* <p>MemoryDB for Redis is a fully managed, Redis-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures.
55
*
6-
* MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis OSS, a popular open source data store, enabling you to leverage Redis OSS’ flexible and friendly data structures, APIs, and commands.</p>
6+
* MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis, a popular open source data store, enabling you to leverage Redis’ flexible and friendly data structures, APIs, and commands.</p>
77
*
88
* @packageDocumentation
99
*/

clients/client-memorydb/src/models/models_0.ts

+49-6
Original file line numberDiff line numberDiff line change
@@ -450,13 +450,20 @@ export interface Cluster {
450450
NodeType?: string;
451451

452452
/**
453-
* <p>The Redis OSS engine version used by the cluster</p>
453+
* <p>
454+
* The Redis OSS or Valkey engine used by the cluster.</p>
455+
* @public
456+
*/
457+
Engine?: string;
458+
459+
/**
460+
* <p>The Redis engine version used by the cluster</p>
454461
* @public
455462
*/
456463
EngineVersion?: string;
457464

458465
/**
459-
* <p>The Redis OSS engine patch version used by the cluster</p>
466+
* <p>The engine patch version used by the cluster</p>
460467
* @public
461468
*/
462469
EnginePatchVersion?: string;
@@ -772,7 +779,13 @@ export interface ClusterConfiguration {
772779
NodeType?: string;
773780

774781
/**
775-
* <p>The Redis OSS engine version used by the cluster</p>
782+
* <p>The configuration for the Redis OSS or Valkey engine used by the cluster.</p>
783+
* @public
784+
*/
785+
Engine?: string;
786+
787+
/**
788+
* <p>The engine version used by the cluster</p>
776789
* @public
777790
*/
778791
EngineVersion?: string;
@@ -1336,7 +1349,13 @@ export interface CreateClusterRequest {
13361349
ACLName: string | undefined;
13371350

13381351
/**
1339-
* <p>The version number of the Redis OSS engine to be used for the cluster.</p>
1352+
* <p>The name of the engine to be used for the nodes in this cluster. The value must be set to either Redis or Valkey.</p>
1353+
* @public
1354+
*/
1355+
Engine?: string;
1356+
1357+
/**
1358+
* <p>The version number of the engine to be used for the cluster.</p>
13401359
* @public
13411360
*/
13421361
EngineVersion?: string;
@@ -2435,7 +2454,13 @@ export interface DescribeClustersResponse {
24352454
*/
24362455
export interface DescribeEngineVersionsRequest {
24372456
/**
2438-
* <p>The Redis OSS engine version</p>
2457+
* <p>The engine version to return. Valid values are either valkey or redis.</p>
2458+
* @public
2459+
*/
2460+
Engine?: string;
2461+
2462+
/**
2463+
* <p>The engine version.</p>
24392464
* @public
24402465
*/
24412466
EngineVersion?: string;
@@ -2466,10 +2491,16 @@ export interface DescribeEngineVersionsRequest {
24662491
}
24672492

24682493
/**
2469-
* <p>Provides details of the Redis OSS engine version</p>
2494+
* <p>Provides details of the engine version.</p>
24702495
* @public
24712496
*/
24722497
export interface EngineVersionInfo {
2498+
/**
2499+
* <p>The version of the Redis OSS or Valkey engine used by the cluster.</p>
2500+
* @public
2501+
*/
2502+
Engine?: string;
2503+
24732504
/**
24742505
* <p>The engine version</p>
24752506
* @public
@@ -3132,6 +3163,12 @@ export interface ServiceUpdate {
31323163
*/
31333164
Type?: ServiceUpdateType;
31343165

3166+
/**
3167+
* <p>The MemoryDB engine to which the update applies. The values are either Redis or Valkey.</p>
3168+
* @public
3169+
*/
3170+
Engine?: string;
3171+
31353172
/**
31363173
* <p>A list of nodes updated by the service update</p>
31373174
* @public
@@ -3898,6 +3935,12 @@ export interface UpdateClusterRequest {
38983935
*/
38993936
NodeType?: string;
39003937

3938+
/**
3939+
* <p>The name of the engine to be used for the nodes in this cluster. The value must be set to either Redis or Valkey.</p>
3940+
* @public
3941+
*/
3942+
Engine?: string;
3943+
39013944
/**
39023945
* <p>The upgraded version of the engine to be run on the nodes. You can upgrade to a newer engine 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.</p>
39033946
* @public

clients/client-memorydb/src/protocols/Aws_json1_1.ts

+3
Original file line numberDiff line numberDiff line change
@@ -2654,6 +2654,7 @@ const de_Cluster = (output: any, context: __SerdeContext): Cluster => {
26542654
ClusterEndpoint: _json,
26552655
DataTiering: __expectString,
26562656
Description: __expectString,
2657+
Engine: __expectString,
26572658
EnginePatchVersion: __expectString,
26582659
EngineVersion: __expectString,
26592660
KmsKeyId: __expectString,
@@ -2684,6 +2685,7 @@ const de_Cluster = (output: any, context: __SerdeContext): Cluster => {
26842685
const de_ClusterConfiguration = (output: any, context: __SerdeContext): ClusterConfiguration => {
26852686
return take(output, {
26862687
Description: __expectString,
2688+
Engine: __expectString,
26872689
EngineVersion: __expectString,
26882690
MaintenanceWindow: __expectString,
26892691
Name: __expectString,
@@ -3113,6 +3115,7 @@ const de_ServiceUpdate = (output: any, context: __SerdeContext): ServiceUpdate =
31133115
AutoUpdateStartDate: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
31143116
ClusterName: __expectString,
31153117
Description: __expectString,
3118+
Engine: __expectString,
31163119
NodesUpdated: __expectString,
31173120
ReleaseDate: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
31183121
ServiceUpdateName: __expectString,

0 commit comments

Comments
 (0)