Skip to content

Commit 9c97266

Browse files
author
awstools
committed
feat(client-rds): This release introduces the new DescribeDBMajorEngineVersions API for describing the properties of specific major versions of database engines.
1 parent 2e5c62e commit 9c97266

File tree

11 files changed

+780
-50
lines changed

11 files changed

+780
-50
lines changed

‎clients/client-rds/README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -815,6 +815,14 @@ DescribeDBLogFiles
815815

816816
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/rds/command/DescribeDBLogFilesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-rds/Interface/DescribeDBLogFilesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-rds/Interface/DescribeDBLogFilesCommandOutput/)
817817

818+
</details>
819+
<details>
820+
<summary>
821+
DescribeDBMajorEngineVersions
822+
</summary>
823+
824+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/rds/command/DescribeDBMajorEngineVersionsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-rds/Interface/DescribeDBMajorEngineVersionsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-rds/Interface/DescribeDBMajorEngineVersionsCommandOutput/)
825+
818826
</details>
819827
<details>
820828
<summary>

‎clients/client-rds/src/RDS.ts‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -352,6 +352,11 @@ import {
352352
DescribeDBLogFilesCommandInput,
353353
DescribeDBLogFilesCommandOutput,
354354
} from "./commands/DescribeDBLogFilesCommand";
355+
import {
356+
DescribeDBMajorEngineVersionsCommand,
357+
DescribeDBMajorEngineVersionsCommandInput,
358+
DescribeDBMajorEngineVersionsCommandOutput,
359+
} from "./commands/DescribeDBMajorEngineVersionsCommand";
355360
import {
356361
DescribeDBParameterGroupsCommand,
357362
DescribeDBParameterGroupsCommandInput,
@@ -885,6 +890,7 @@ const commands = {
885890
DescribeDBInstanceAutomatedBackupsCommand,
886891
DescribeDBInstancesCommand,
887892
DescribeDBLogFilesCommand,
893+
DescribeDBMajorEngineVersionsCommand,
888894
DescribeDBParameterGroupsCommand,
889895
DescribeDBParametersCommand,
890896
DescribeDBProxiesCommand,
@@ -2159,6 +2165,24 @@ export interface RDS {
21592165
cb: (err: any, data?: DescribeDBLogFilesCommandOutput) => void
21602166
): void;
21612167

2168+
/**
2169+
* @see {@link DescribeDBMajorEngineVersionsCommand}
2170+
*/
2171+
describeDBMajorEngineVersions(): Promise<DescribeDBMajorEngineVersionsCommandOutput>;
2172+
describeDBMajorEngineVersions(
2173+
args: DescribeDBMajorEngineVersionsCommandInput,
2174+
options?: __HttpHandlerOptions
2175+
): Promise<DescribeDBMajorEngineVersionsCommandOutput>;
2176+
describeDBMajorEngineVersions(
2177+
args: DescribeDBMajorEngineVersionsCommandInput,
2178+
cb: (err: any, data?: DescribeDBMajorEngineVersionsCommandOutput) => void
2179+
): void;
2180+
describeDBMajorEngineVersions(
2181+
args: DescribeDBMajorEngineVersionsCommandInput,
2182+
options: __HttpHandlerOptions,
2183+
cb: (err: any, data?: DescribeDBMajorEngineVersionsCommandOutput) => void
2184+
): void;
2185+
21622186
/**
21632187
* @see {@link DescribeDBParameterGroupsCommand}
21642188
*/

‎clients/client-rds/src/RDSClient.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,10 @@ import {
267267
DescribeDBInstancesCommandOutput,
268268
} from "./commands/DescribeDBInstancesCommand";
269269
import { DescribeDBLogFilesCommandInput, DescribeDBLogFilesCommandOutput } from "./commands/DescribeDBLogFilesCommand";
270+
import {
271+
DescribeDBMajorEngineVersionsCommandInput,
272+
DescribeDBMajorEngineVersionsCommandOutput,
273+
} from "./commands/DescribeDBMajorEngineVersionsCommand";
270274
import {
271275
DescribeDBParameterGroupsCommandInput,
272276
DescribeDBParameterGroupsCommandOutput,
@@ -654,6 +658,7 @@ export type ServiceInputTypes =
654658
| DescribeDBInstanceAutomatedBackupsCommandInput
655659
| DescribeDBInstancesCommandInput
656660
| DescribeDBLogFilesCommandInput
661+
| DescribeDBMajorEngineVersionsCommandInput
657662
| DescribeDBParameterGroupsCommandInput
658663
| DescribeDBParametersCommandInput
659664
| DescribeDBProxiesCommandInput
@@ -821,6 +826,7 @@ export type ServiceOutputTypes =
821826
| DescribeDBInstanceAutomatedBackupsCommandOutput
822827
| DescribeDBInstancesCommandOutput
823828
| DescribeDBLogFilesCommandOutput
829+
| DescribeDBMajorEngineVersionsCommandOutput
824830
| DescribeDBParameterGroupsCommandOutput
825831
| DescribeDBParametersCommandOutput
826832
| DescribeDBProxiesCommandOutput

‎clients/client-rds/src/commands/DescribeDBMajorEngineVersionsCommand.ts‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
// smithy-typescript generated code
2+
import { getEndpointPlugin } from "@smithy/middleware-endpoint";
3+
import { getSerdePlugin } from "@smithy/middleware-serde";
4+
import { Command as $Command } from "@smithy/smithy-client";
5+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
6+
7+
import { commonParams } from "../endpoint/EndpointParameters";
8+
import { DescribeDBMajorEngineVersionsRequest, DescribeDBMajorEngineVersionsResponse } from "../models/models_1";
9+
import {
10+
de_DescribeDBMajorEngineVersionsCommand,
11+
se_DescribeDBMajorEngineVersionsCommand,
12+
} from "../protocols/Aws_query";
13+
import { RDSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSClient";
14+
15+
/**
16+
* @public
17+
*/
18+
export type { __MetadataBearer };
19+
export { $Command };
20+
/**
21+
* @public
22+
*
23+
* The input for {@link DescribeDBMajorEngineVersionsCommand}.
24+
*/
25+
export interface DescribeDBMajorEngineVersionsCommandInput extends DescribeDBMajorEngineVersionsRequest {}
26+
/**
27+
* @public
28+
*
29+
* The output of {@link DescribeDBMajorEngineVersionsCommand}.
30+
*/
31+
export interface DescribeDBMajorEngineVersionsCommandOutput
32+
extends DescribeDBMajorEngineVersionsResponse,
33+
__MetadataBearer {}
34+
35+
/**
36+
* <p>Describes the properties of specific major versions of DB engines.</p>
37+
* @example
38+
* Use a bare-bones client and the command you need to make an API call.
39+
* ```javascript
40+
* import { RDSClient, DescribeDBMajorEngineVersionsCommand } from "@aws-sdk/client-rds"; // ES Modules import
41+
* // const { RDSClient, DescribeDBMajorEngineVersionsCommand } = require("@aws-sdk/client-rds"); // CommonJS import
42+
* const client = new RDSClient(config);
43+
* const input = { // DescribeDBMajorEngineVersionsRequest
44+
* Engine: "STRING_VALUE",
45+
* MajorEngineVersion: "STRING_VALUE",
46+
* Marker: "STRING_VALUE",
47+
* MaxRecords: Number("int"),
48+
* };
49+
* const command = new DescribeDBMajorEngineVersionsCommand(input);
50+
* const response = await client.send(command);
51+
* // { // DescribeDBMajorEngineVersionsResponse
52+
* // DBMajorEngineVersions: [ // DBMajorEngineVersionsList
53+
* // { // DBMajorEngineVersion
54+
* // Engine: "STRING_VALUE",
55+
* // MajorEngineVersion: "STRING_VALUE",
56+
* // SupportedEngineLifecycles: [ // SupportedEngineLifecycleList
57+
* // { // SupportedEngineLifecycle
58+
* // LifecycleSupportName: "open-source-rds-standard-support" || "open-source-rds-extended-support", // required
59+
* // LifecycleSupportStartDate: new Date("TIMESTAMP"), // required
60+
* // LifecycleSupportEndDate: new Date("TIMESTAMP"), // required
61+
* // },
62+
* // ],
63+
* // },
64+
* // ],
65+
* // Marker: "STRING_VALUE",
66+
* // };
67+
*
68+
* ```
69+
*
70+
* @param DescribeDBMajorEngineVersionsCommandInput - {@link DescribeDBMajorEngineVersionsCommandInput}
71+
* @returns {@link DescribeDBMajorEngineVersionsCommandOutput}
72+
* @see {@link DescribeDBMajorEngineVersionsCommandInput} for command's `input` shape.
73+
* @see {@link DescribeDBMajorEngineVersionsCommandOutput} for command's `response` shape.
74+
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
75+
*
76+
* @throws {@link RDSServiceException}
77+
* <p>Base exception class for all service exceptions from RDS service.</p>
78+
*
79+
*
80+
* @public
81+
*/
82+
export class DescribeDBMajorEngineVersionsCommand extends $Command
83+
.classBuilder<
84+
DescribeDBMajorEngineVersionsCommandInput,
85+
DescribeDBMajorEngineVersionsCommandOutput,
86+
RDSClientResolvedConfig,
87+
ServiceInputTypes,
88+
ServiceOutputTypes
89+
>()
90+
.ep(commonParams)
91+
.m(function (this: any, Command: any, cs: any, config: RDSClientResolvedConfig, o: any) {
92+
return [
93+
getSerdePlugin(config, this.serialize, this.deserialize),
94+
getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
95+
];
96+
})
97+
.s("AmazonRDSv19", "DescribeDBMajorEngineVersions", {})
98+
.n("RDSClient", "DescribeDBMajorEngineVersionsCommand")
99+
.f(void 0, void 0)
100+
.ser(se_DescribeDBMajorEngineVersionsCommand)
101+
.de(de_DescribeDBMajorEngineVersionsCommand)
102+
.build() {
103+
/** @internal type navigation helper, not in runtime. */
104+
protected declare static __types: {
105+
api: {
106+
input: DescribeDBMajorEngineVersionsRequest;
107+
output: DescribeDBMajorEngineVersionsResponse;
108+
};
109+
sdk: {
110+
input: DescribeDBMajorEngineVersionsCommandInput;
111+
output: DescribeDBMajorEngineVersionsCommandOutput;
112+
};
113+
};
114+
}

‎clients/client-rds/src/commands/index.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ export * from "./DescribeDBEngineVersionsCommand";
6969
export * from "./DescribeDBInstanceAutomatedBackupsCommand";
7070
export * from "./DescribeDBInstancesCommand";
7171
export * from "./DescribeDBLogFilesCommand";
72+
export * from "./DescribeDBMajorEngineVersionsCommand";
7273
export * from "./DescribeDBParameterGroupsCommand";
7374
export * from "./DescribeDBParametersCommand";
7475
export * from "./DescribeDBProxiesCommand";

‎clients/client-rds/src/models/models_0.ts‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5420,11 +5420,11 @@ export interface CreateDBClusterMessage {
54205420
* you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:</p>
54215421
* <ul>
54225422
* <li>
5423-
* <p>Amazon Aurora - <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html">Using Amazon RDS Extended Support</a> in the <i>Amazon Aurora User Guide</i>
5423+
* <p>Amazon Aurora - <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html">Amazon RDS Extended Support with Amazon Aurora</a> in the <i>Amazon Aurora User Guide</i>
54245424
* </p>
54255425
* </li>
54265426
* <li>
5427-
* <p>Amazon RDS - <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html">Using Amazon RDS Extended Support</a> in the <i>Amazon RDS User Guide</i>
5427+
* <p>Amazon RDS - <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html">Amazon RDS Extended Support with Amazon RDS</a> in the <i>Amazon RDS User Guide</i>
54285428
* </p>
54295429
* </li>
54305430
* </ul>
@@ -6573,7 +6573,7 @@ export interface DBCluster {
65736573
CertificateDetails?: CertificateDetails | undefined;
65746574

65756575
/**
6576-
* <p>The life cycle type for the DB cluster.</p>
6576+
* <p>The lifecycle type for the DB cluster.</p>
65776577
* <p>For more information, see CreateDBCluster.</p>
65786578
* @public
65796579
*/
@@ -8725,7 +8725,7 @@ export interface CreateDBInstanceMessage {
87258725
* </note>
87268726
* <p>This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.</p>
87278727
* <p>You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support,
8728-
* you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html">Using Amazon RDS Extended Support</a> in the <i>Amazon RDS User Guide</i>.</p>
8728+
* you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html">Amazon RDS Extended Support with Amazon RDS</a> in the <i>Amazon RDS User Guide</i>.</p>
87298729
* <p>Valid Values: <code>open-source-rds-extended-support | open-source-rds-extended-support-disabled</code>
87308730
* </p>
87318731
* <p>Default: <code>open-source-rds-extended-support</code>
@@ -9937,7 +9937,7 @@ export interface DBInstance {
99379937
MultiTenant?: boolean | undefined;
99389938

99399939
/**
9940-
* <p>The life cycle type for the DB instance.</p>
9940+
* <p>The lifecycle type for the DB instance.</p>
99419941
* <p>For more information, see CreateDBInstance.</p>
99429942
* @public
99439943
*/
@@ -12422,7 +12422,7 @@ export interface CreateGlobalClusterMessage {
1242212422
* </note>
1242312423
* <p>This setting only applies to Aurora PostgreSQL-based global databases.</p>
1242412424
* <p>You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support,
12425-
* you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html">Using Amazon RDS Extended Support</a> in the <i>Amazon Aurora User Guide</i>.</p>
12425+
* you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html">Amazon RDS Extended Support with Amazon Aurora</a> in the <i>Amazon Aurora User Guide</i>.</p>
1242612426
* <p>Valid Values: <code>open-source-rds-extended-support | open-source-rds-extended-support-disabled</code>
1242712427
* </p>
1242812428
* <p>Default: <code>open-source-rds-extended-support</code>
@@ -12637,7 +12637,7 @@ export interface GlobalCluster {
1263712637
EngineVersion?: string | undefined;
1263812638

1263912639
/**
12640-
* <p>The life cycle type for the global cluster.</p>
12640+
* <p>The lifecycle type for the global cluster.</p>
1264112641
* <p>For more information, see CreateGlobalCluster.</p>
1264212642
* @public
1264312643
*/

0 commit comments

Comments
 (0)