Skip to content

Commit

Permalink
feat(client-memorydb): Amazon MemoryDB SDK now supports all APIs for …
Browse files Browse the repository at this point in the history
…newly launched Valkey engine. Please refer to the updated Amazon MemoryDB public documentation for detailed information on API usage.
  • Loading branch information
awstools committed Oct 8, 2024
1 parent 1cbb8d6 commit d4a2f23
Show file tree
Hide file tree
Showing 19 changed files with 127 additions and 29 deletions.
4 changes: 2 additions & 2 deletions clients/client-memorydb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@

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

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

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

## Installing

Expand Down
4 changes: 2 additions & 2 deletions clients/client-memorydb/src/MemoryDB.ts
Original file line number Diff line number Diff line change
Expand Up @@ -758,9 +758,9 @@ export interface MemoryDB {
}

/**
* <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.
* <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.
*
* 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>
* 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>
* @public
*/
export class MemoryDB extends MemoryDBClient implements MemoryDB {}
Expand Down
4 changes: 2 additions & 2 deletions clients/client-memorydb/src/MemoryDBClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -396,9 +396,9 @@ export type MemoryDBClientResolvedConfigType = __SmithyResolvedConfiguration<__H
export interface MemoryDBClientResolvedConfig extends MemoryDBClientResolvedConfigType {}

/**
* <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.
* <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.
*
* 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>
* 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>
* @public
*/
export class MemoryDBClient extends __Client<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ export interface BatchUpdateClusterCommandOutput extends BatchUpdateClusterRespo
* // Port: Number("int"),
* // },
* // NodeType: "STRING_VALUE",
* // Engine: "STRING_VALUE",
* // EngineVersion: "STRING_VALUE",
* // EnginePatchVersion: "STRING_VALUE",
* // ParameterGroupName: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResponse, __Metad
* // Name: "STRING_VALUE",
* // Description: "STRING_VALUE",
* // NodeType: "STRING_VALUE",
* // Engine: "STRING_VALUE",
* // EngineVersion: "STRING_VALUE",
* // MaintenanceWindow: "STRING_VALUE",
* // TopicArn: "STRING_VALUE",
Expand Down
2 changes: 2 additions & 0 deletions clients/client-memorydb/src/commands/CreateClusterCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
* ],
* SnapshotWindow: "STRING_VALUE",
* ACLName: "STRING_VALUE", // required
* Engine: "STRING_VALUE",
* EngineVersion: "STRING_VALUE",
* AutoMinorVersionUpgrade: true || false,
* DataTiering: true || false,
Expand Down Expand Up @@ -118,6 +119,7 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
* // Port: Number("int"),
* // },
* // NodeType: "STRING_VALUE",
* // Engine: "STRING_VALUE",
* // EngineVersion: "STRING_VALUE",
* // EnginePatchVersion: "STRING_VALUE",
* // ParameterGroupName: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotResponse, __M
* // Name: "STRING_VALUE",
* // Description: "STRING_VALUE",
* // NodeType: "STRING_VALUE",
* // Engine: "STRING_VALUE",
* // EngineVersion: "STRING_VALUE",
* // MaintenanceWindow: "STRING_VALUE",
* // TopicArn: "STRING_VALUE",
Expand Down
6 changes: 1 addition & 5 deletions clients/client-memorydb/src/commands/DeleteClusterCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,6 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met

/**
* <p>Deletes a cluster. It also deletes all associated nodes and node endpoints</p>
* <note>
* <p>
* <code>CreateSnapshot</code> permission is required to create a final snapshot.
* Without this permission, the API call will fail with an <code>Access Denied</code> exception.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -94,6 +89,7 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
* // Port: Number("int"),
* // },
* // NodeType: "STRING_VALUE",
* // Engine: "STRING_VALUE",
* // EngineVersion: "STRING_VALUE",
* // EnginePatchVersion: "STRING_VALUE",
* // ParameterGroupName: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ export interface DeleteSnapshotCommandOutput extends DeleteSnapshotResponse, __M
* // Name: "STRING_VALUE",
* // Description: "STRING_VALUE",
* // NodeType: "STRING_VALUE",
* // Engine: "STRING_VALUE",
* // EngineVersion: "STRING_VALUE",
* // MaintenanceWindow: "STRING_VALUE",
* // TopicArn: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ export interface DescribeClustersCommandOutput extends DescribeClustersResponse,
* // Port: Number("int"),
* // },
* // NodeType: "STRING_VALUE",
* // Engine: "STRING_VALUE",
* // EngineVersion: "STRING_VALUE",
* // EnginePatchVersion: "STRING_VALUE",
* // ParameterGroupName: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,15 @@ export interface DescribeEngineVersionsCommandInput extends DescribeEngineVersio
export interface DescribeEngineVersionsCommandOutput extends DescribeEngineVersionsResponse, __MetadataBearer {}

/**
* <p>Returns a list of the available Redis OSS engine versions.</p>
* <p>Returns a list of the available engine versions.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { MemoryDBClient, DescribeEngineVersionsCommand } from "@aws-sdk/client-memorydb"; // ES Modules import
* // const { MemoryDBClient, DescribeEngineVersionsCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import
* const client = new MemoryDBClient(config);
* const input = { // DescribeEngineVersionsRequest
* Engine: "STRING_VALUE",
* EngineVersion: "STRING_VALUE",
* ParameterGroupFamily: "STRING_VALUE",
* MaxResults: Number("int"),
Expand All @@ -48,6 +49,7 @@ export interface DescribeEngineVersionsCommandOutput extends DescribeEngineVersi
* // NextToken: "STRING_VALUE",
* // EngineVersions: [ // EngineVersionInfoList
* // { // EngineVersionInfo
* // Engine: "STRING_VALUE",
* // EngineVersion: "STRING_VALUE",
* // EnginePatchVersion: "STRING_VALUE",
* // ParameterGroupFamily: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ export interface DescribeServiceUpdatesCommandOutput extends DescribeServiceUpda
* // Description: "STRING_VALUE",
* // Status: "available" || "in-progress" || "complete" || "scheduled",
* // Type: "security-update",
* // Engine: "STRING_VALUE",
* // NodesUpdated: "STRING_VALUE",
* // AutoUpdateStartDate: new Date("TIMESTAMP"),
* // },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ export interface DescribeSnapshotsCommandOutput extends DescribeSnapshotsRespons
* // Name: "STRING_VALUE",
* // Description: "STRING_VALUE",
* // NodeType: "STRING_VALUE",
* // Engine: "STRING_VALUE",
* // EngineVersion: "STRING_VALUE",
* // MaintenanceWindow: "STRING_VALUE",
* // TopicArn: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ export interface FailoverShardCommandOutput extends FailoverShardResponse, __Met
* // Port: Number("int"),
* // },
* // NodeType: "STRING_VALUE",
* // Engine: "STRING_VALUE",
* // EngineVersion: "STRING_VALUE",
* // EnginePatchVersion: "STRING_VALUE",
* // ParameterGroupName: "STRING_VALUE",
Expand Down
2 changes: 2 additions & 0 deletions clients/client-memorydb/src/commands/UpdateClusterCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ export interface UpdateClusterCommandOutput extends UpdateClusterResponse, __Met
* SnapshotWindow: "STRING_VALUE",
* SnapshotRetentionLimit: Number("int"),
* NodeType: "STRING_VALUE",
* Engine: "STRING_VALUE",
* EngineVersion: "STRING_VALUE",
* ReplicaConfiguration: { // ReplicaConfigurationRequest
* ReplicaCount: Number("int"),
Expand Down Expand Up @@ -107,6 +108,7 @@ export interface UpdateClusterCommandOutput extends UpdateClusterResponse, __Met
* // Port: Number("int"),
* // },
* // NodeType: "STRING_VALUE",
* // Engine: "STRING_VALUE",
* // EngineVersion: "STRING_VALUE",
* // EnginePatchVersion: "STRING_VALUE",
* // ParameterGroupName: "STRING_VALUE",
Expand Down
4 changes: 2 additions & 2 deletions clients/client-memorydb/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
// smithy-typescript generated code
/* eslint-disable */
/**
* <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.
* <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.
*
* 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>
* 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>
*
* @packageDocumentation
*/
Expand Down
55 changes: 49 additions & 6 deletions clients/client-memorydb/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -450,13 +450,20 @@ export interface Cluster {
NodeType?: string;

/**
* <p>The Redis OSS engine version used by the cluster</p>
* <p>
* The Redis OSS or Valkey engine used by the cluster.</p>
* @public
*/
Engine?: string;

/**
* <p>The Redis engine version used by the cluster</p>
* @public
*/
EngineVersion?: string;

/**
* <p>The Redis OSS engine patch version used by the cluster</p>
* <p>The engine patch version used by the cluster</p>
* @public
*/
EnginePatchVersion?: string;
Expand Down Expand Up @@ -772,7 +779,13 @@ export interface ClusterConfiguration {
NodeType?: string;

/**
* <p>The Redis OSS engine version used by the cluster</p>
* <p>The configuration for the Redis OSS or Valkey engine used by the cluster.</p>
* @public
*/
Engine?: string;

/**
* <p>The engine version used by the cluster</p>
* @public
*/
EngineVersion?: string;
Expand Down Expand Up @@ -1336,7 +1349,13 @@ export interface CreateClusterRequest {
ACLName: string | undefined;

/**
* <p>The version number of the Redis OSS engine to be used for the cluster.</p>
* <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>
* @public
*/
Engine?: string;

/**
* <p>The version number of the engine to be used for the cluster.</p>
* @public
*/
EngineVersion?: string;
Expand Down Expand Up @@ -2435,7 +2454,13 @@ export interface DescribeClustersResponse {
*/
export interface DescribeEngineVersionsRequest {
/**
* <p>The Redis OSS engine version</p>
* <p>The engine version to return. Valid values are either valkey or redis.</p>
* @public
*/
Engine?: string;

/**
* <p>The engine version.</p>
* @public
*/
EngineVersion?: string;
Expand Down Expand Up @@ -2466,10 +2491,16 @@ export interface DescribeEngineVersionsRequest {
}

/**
* <p>Provides details of the Redis OSS engine version</p>
* <p>Provides details of the engine version.</p>
* @public
*/
export interface EngineVersionInfo {
/**
* <p>The version of the Redis OSS or Valkey engine used by the cluster.</p>
* @public
*/
Engine?: string;

/**
* <p>The engine version</p>
* @public
Expand Down Expand Up @@ -3132,6 +3163,12 @@ export interface ServiceUpdate {
*/
Type?: ServiceUpdateType;

/**
* <p>The MemoryDB engine to which the update applies. The values are either Redis or Valkey.</p>
* @public
*/
Engine?: string;

/**
* <p>A list of nodes updated by the service update</p>
* @public
Expand Down Expand Up @@ -3898,6 +3935,12 @@ export interface UpdateClusterRequest {
*/
NodeType?: string;

/**
* <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>
* @public
*/
Engine?: string;

/**
* <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>
* @public
Expand Down
3 changes: 3 additions & 0 deletions clients/client-memorydb/src/protocols/Aws_json1_1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2654,6 +2654,7 @@ const de_Cluster = (output: any, context: __SerdeContext): Cluster => {
ClusterEndpoint: _json,
DataTiering: __expectString,
Description: __expectString,
Engine: __expectString,
EnginePatchVersion: __expectString,
EngineVersion: __expectString,
KmsKeyId: __expectString,
Expand Down Expand Up @@ -2684,6 +2685,7 @@ const de_Cluster = (output: any, context: __SerdeContext): Cluster => {
const de_ClusterConfiguration = (output: any, context: __SerdeContext): ClusterConfiguration => {
return take(output, {
Description: __expectString,
Engine: __expectString,
EngineVersion: __expectString,
MaintenanceWindow: __expectString,
Name: __expectString,
Expand Down Expand Up @@ -3113,6 +3115,7 @@ const de_ServiceUpdate = (output: any, context: __SerdeContext): ServiceUpdate =
AutoUpdateStartDate: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
ClusterName: __expectString,
Description: __expectString,
Engine: __expectString,
NodesUpdated: __expectString,
ReleaseDate: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
ServiceUpdateName: __expectString,
Expand Down
Loading

0 comments on commit d4a2f23

Please sign in to comment.