feat(client-rds): This release adds support for option groups and rep…

…lica enhancements to Amazon RDS Custom.
aws · Nov 17, 2023 · fb8ad1a · fb8ad1a
1 parent 61b32fe
commit fb8ad1a
Show file tree

Hide file tree

Showing 19 changed files with 358 additions and 58 deletions.
diff --git a/clients/client-rds/src/commands/CopyDBClusterParameterGroupCommand.ts b/clients/client-rds/src/commands/CopyDBClusterParameterGroupCommand.ts
@@ -38,6 +38,10 @@ export interface CopyDBClusterParameterGroupCommandOutput extends CopyDBClusterP
 /**
  * @public
  * <p>Copies the specified DB cluster parameter group.</p>
+ *          <note>
+ *             <p>You can't copy a default DB cluster parameter group. Instead, create a new custom DB cluster parameter group, which copies
+ *                 the default parameters and values for the specified DB cluster parameter group family.</p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-rds/src/commands/CopyDBParameterGroupCommand.ts b/clients/client-rds/src/commands/CopyDBParameterGroupCommand.ts
@@ -38,6 +38,10 @@ export interface CopyDBParameterGroupCommandOutput extends CopyDBParameterGroupR
 /**
  * @public
  * <p>Copies the specified DB parameter group.</p>
+ *          <note>
+ *             <p>You can't copy a default DB parameter group. Instead, create a new custom DB parameter group, which copies the default
+ *                 parameters and values for the specified DB parameter group family.</p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-rds/src/commands/CreateDBClusterCommand.ts b/clients/client-rds/src/commands/CreateDBClusterCommand.ts
@@ -106,6 +106,7 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
  *   RdsCustomClusterConfiguration: { // RdsCustomClusterConfiguration
  *     InterconnectSubnetId: "STRING_VALUE",
  *     TransitGatewayMulticastDomainId: "STRING_VALUE",
+ *     ReplicaMode: "open-read-only" || "mounted",
  *   },
  *   DeletionProtection: true || false,
  *   GlobalClusterIdentifier: "STRING_VALUE",
@@ -176,6 +177,14 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
  * //     ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
  * //       "STRING_VALUE",
  * //     ],
+ * //     StatusInfos: [ // DBClusterStatusInfoList
+ * //       { // DBClusterStatusInfo
+ * //         StatusType: "STRING_VALUE",
+ * //         Normal: true || false,
+ * //         Status: "STRING_VALUE",
+ * //         Message: "STRING_VALUE",
+ * //       },
+ * //     ],
  * //     DBClusterMembers: [ // DBClusterMemberList
  * //       { // DBClusterMember
  * //         DBInstanceIdentifier: "STRING_VALUE",
@@ -224,6 +233,7 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
  * //     RdsCustomClusterConfiguration: { // RdsCustomClusterConfiguration
  * //       InterconnectSubnetId: "STRING_VALUE",
  * //       TransitGatewayMulticastDomainId: "STRING_VALUE",
+ * //       ReplicaMode: "open-read-only" || "mounted",
  * //     },
  * //     DeletionProtection: true || false,
  * //     HttpEndpointEnabled: true || false,
@@ -272,6 +282,7 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
  * //       RdsCustomClusterConfiguration: {
  * //         InterconnectSubnetId: "STRING_VALUE",
  * //         TransitGatewayMulticastDomainId: "STRING_VALUE",
+ * //         ReplicaMode: "open-read-only" || "mounted",
  * //       },
  * //       Iops: Number("int"),
  * //       StorageType: "STRING_VALUE",
@@ -356,6 +367,10 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
  * @throws {@link InvalidDBInstanceStateFault} (client fault)
  *  <p>The DB instance isn't in a valid state.</p>
  *
+ * @throws {@link InvalidDBSubnetGroupFault} (client fault)
+ *  <p>The DBSubnetGroup doesn't belong to the same VPC as that of an existing
+ *             cross-region read replica of the same source instance.</p>
+ *
  * @throws {@link InvalidDBSubnetGroupStateFault} (client fault)
  *  <p>The DB subnet group cannot be deleted because it's in use.</p>
  *
@@ -372,6 +387,9 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
  * @throws {@link KMSKeyNotAccessibleFault} (client fault)
  *  <p>An error occurred accessing an Amazon Web Services KMS key.</p>
  *
+ * @throws {@link OptionGroupNotFoundFault} (client fault)
+ *  <p>The specified option group could not be found.</p>
+ *
  * @throws {@link StorageQuotaExceededFault} (client fault)
  *  <p>The request would result in the user exceeding the allowed amount of storage
  *             available across all DB instances.</p>

diff --git a/clients/client-rds/src/commands/DeleteDBClusterCommand.ts b/clients/client-rds/src/commands/DeleteDBClusterCommand.ts
@@ -101,6 +101,14 @@ export interface DeleteDBClusterCommandOutput extends DeleteDBClusterResult, __M
  * //     ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
  * //       "STRING_VALUE",
  * //     ],
+ * //     StatusInfos: [ // DBClusterStatusInfoList
+ * //       { // DBClusterStatusInfo
+ * //         StatusType: "STRING_VALUE",
+ * //         Normal: true || false,
+ * //         Status: "STRING_VALUE",
+ * //         Message: "STRING_VALUE",
+ * //       },
+ * //     ],
  * //     DBClusterMembers: [ // DBClusterMemberList
  * //       { // DBClusterMember
  * //         DBInstanceIdentifier: "STRING_VALUE",
@@ -149,6 +157,7 @@ export interface DeleteDBClusterCommandOutput extends DeleteDBClusterResult, __M
  * //     RdsCustomClusterConfiguration: { // RdsCustomClusterConfiguration
  * //       InterconnectSubnetId: "STRING_VALUE",
  * //       TransitGatewayMulticastDomainId: "STRING_VALUE",
+ * //       ReplicaMode: "open-read-only" || "mounted",
  * //     },
  * //     DeletionProtection: true || false,
  * //     HttpEndpointEnabled: true || false,
@@ -197,6 +206,7 @@ export interface DeleteDBClusterCommandOutput extends DeleteDBClusterResult, __M
  * //       RdsCustomClusterConfiguration: {
  * //         InterconnectSubnetId: "STRING_VALUE",
  * //         TransitGatewayMulticastDomainId: "STRING_VALUE",
+ * //         ReplicaMode: "open-read-only" || "mounted",
  * //       },
  * //       Iops: Number("int"),
  * //       StorageType: "STRING_VALUE",

diff --git a/clients/client-rds/src/commands/DescribeDBClusterAutomatedBackupsCommand.ts b/clients/client-rds/src/commands/DescribeDBClusterAutomatedBackupsCommand.ts
@@ -14,8 +14,7 @@ import {
   SMITHY_CONTEXT_KEY,
 } from "@smithy/types";
 
-import { DBClusterAutomatedBackupMessage } from "../models/models_0";
-import { DescribeDBClusterAutomatedBackupsMessage } from "../models/models_1";
+import { DBClusterAutomatedBackupMessage, DescribeDBClusterAutomatedBackupsMessage } from "../models/models_1";
 import {
   de_DescribeDBClusterAutomatedBackupsCommand,
   se_DescribeDBClusterAutomatedBackupsCommand,

diff --git a/clients/client-rds/src/commands/DescribeDBClustersCommand.ts b/clients/client-rds/src/commands/DescribeDBClustersCommand.ts
@@ -108,6 +108,14 @@ export interface DescribeDBClustersCommandOutput extends DBClusterMessage, __Met
  * //       ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
  * //         "STRING_VALUE",
  * //       ],
+ * //       StatusInfos: [ // DBClusterStatusInfoList
+ * //         { // DBClusterStatusInfo
+ * //           StatusType: "STRING_VALUE",
+ * //           Normal: true || false,
+ * //           Status: "STRING_VALUE",
+ * //           Message: "STRING_VALUE",
+ * //         },
+ * //       ],
  * //       DBClusterMembers: [ // DBClusterMemberList
  * //         { // DBClusterMember
  * //           DBInstanceIdentifier: "STRING_VALUE",
@@ -156,6 +164,7 @@ export interface DescribeDBClustersCommandOutput extends DBClusterMessage, __Met
  * //       RdsCustomClusterConfiguration: { // RdsCustomClusterConfiguration
  * //         InterconnectSubnetId: "STRING_VALUE",
  * //         TransitGatewayMulticastDomainId: "STRING_VALUE",
+ * //         ReplicaMode: "open-read-only" || "mounted",
  * //       },
  * //       DeletionProtection: true || false,
  * //       HttpEndpointEnabled: true || false,
@@ -204,6 +213,7 @@ export interface DescribeDBClustersCommandOutput extends DBClusterMessage, __Met
  * //         RdsCustomClusterConfiguration: {
  * //           InterconnectSubnetId: "STRING_VALUE",
  * //           TransitGatewayMulticastDomainId: "STRING_VALUE",
+ * //           ReplicaMode: "open-read-only" || "mounted",
  * //         },
  * //         Iops: Number("int"),
  * //         StorageType: "STRING_VALUE",

diff --git a/clients/client-rds/src/commands/FailoverDBClusterCommand.ts b/clients/client-rds/src/commands/FailoverDBClusterCommand.ts
@@ -105,6 +105,14 @@ export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult,
  * //     ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
  * //       "STRING_VALUE",
  * //     ],
+ * //     StatusInfos: [ // DBClusterStatusInfoList
+ * //       { // DBClusterStatusInfo
+ * //         StatusType: "STRING_VALUE",
+ * //         Normal: true || false,
+ * //         Status: "STRING_VALUE",
+ * //         Message: "STRING_VALUE",
+ * //       },
+ * //     ],
  * //     DBClusterMembers: [ // DBClusterMemberList
  * //       { // DBClusterMember
  * //         DBInstanceIdentifier: "STRING_VALUE",
@@ -153,6 +161,7 @@ export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult,
  * //     RdsCustomClusterConfiguration: { // RdsCustomClusterConfiguration
  * //       InterconnectSubnetId: "STRING_VALUE",
  * //       TransitGatewayMulticastDomainId: "STRING_VALUE",
+ * //       ReplicaMode: "open-read-only" || "mounted",
  * //     },
  * //     DeletionProtection: true || false,
  * //     HttpEndpointEnabled: true || false,
@@ -201,6 +210,7 @@ export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult,
  * //       RdsCustomClusterConfiguration: {
  * //         InterconnectSubnetId: "STRING_VALUE",
  * //         TransitGatewayMulticastDomainId: "STRING_VALUE",
+ * //         ReplicaMode: "open-read-only" || "mounted",
  * //       },
  * //       Iops: Number("int"),
  * //       StorageType: "STRING_VALUE",

diff --git a/clients/client-rds/src/commands/ModifyDBClusterCommand.ts b/clients/client-rds/src/commands/ModifyDBClusterCommand.ts
@@ -157,6 +157,14 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M
  * //     ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
  * //       "STRING_VALUE",
  * //     ],
+ * //     StatusInfos: [ // DBClusterStatusInfoList
+ * //       { // DBClusterStatusInfo
+ * //         StatusType: "STRING_VALUE",
+ * //         Normal: true || false,
+ * //         Status: "STRING_VALUE",
+ * //         Message: "STRING_VALUE",
+ * //       },
+ * //     ],
  * //     DBClusterMembers: [ // DBClusterMemberList
  * //       { // DBClusterMember
  * //         DBInstanceIdentifier: "STRING_VALUE",
@@ -205,6 +213,7 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M
  * //     RdsCustomClusterConfiguration: { // RdsCustomClusterConfiguration
  * //       InterconnectSubnetId: "STRING_VALUE",
  * //       TransitGatewayMulticastDomainId: "STRING_VALUE",
+ * //       ReplicaMode: "open-read-only" || "mounted",
  * //     },
  * //     DeletionProtection: true || false,
  * //     HttpEndpointEnabled: true || false,
@@ -253,6 +262,7 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M
  * //       RdsCustomClusterConfiguration: {
  * //         InterconnectSubnetId: "STRING_VALUE",
  * //         TransitGatewayMulticastDomainId: "STRING_VALUE",
+ * //         ReplicaMode: "open-read-only" || "mounted",
  * //       },
  * //       Iops: Number("int"),
  * //       StorageType: "STRING_VALUE",
@@ -334,6 +344,9 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M
  *  <p>The DB subnet group doesn't cover all Availability Zones after it's
  *             created because of users' change.</p>
  *
+ * @throws {@link OptionGroupNotFoundFault} (client fault)
+ *  <p>The specified option group could not be found.</p>
+ *
  * @throws {@link StorageQuotaExceededFault} (client fault)
  *  <p>The request would result in the user exceeding the allowed amount of storage
  *             available across all DB instances.</p>

diff --git a/clients/client-rds/src/commands/PromoteReadReplicaDBClusterCommand.ts b/clients/client-rds/src/commands/PromoteReadReplicaDBClusterCommand.ts
@@ -88,6 +88,14 @@ export interface PromoteReadReplicaDBClusterCommandOutput extends PromoteReadRep
  * //     ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
  * //       "STRING_VALUE",
  * //     ],
+ * //     StatusInfos: [ // DBClusterStatusInfoList
+ * //       { // DBClusterStatusInfo
+ * //         StatusType: "STRING_VALUE",
+ * //         Normal: true || false,
+ * //         Status: "STRING_VALUE",
+ * //         Message: "STRING_VALUE",
+ * //       },
+ * //     ],
  * //     DBClusterMembers: [ // DBClusterMemberList
  * //       { // DBClusterMember
  * //         DBInstanceIdentifier: "STRING_VALUE",
@@ -136,6 +144,7 @@ export interface PromoteReadReplicaDBClusterCommandOutput extends PromoteReadRep
  * //     RdsCustomClusterConfiguration: { // RdsCustomClusterConfiguration
  * //       InterconnectSubnetId: "STRING_VALUE",
  * //       TransitGatewayMulticastDomainId: "STRING_VALUE",
+ * //       ReplicaMode: "open-read-only" || "mounted",
  * //     },
  * //     DeletionProtection: true || false,
  * //     HttpEndpointEnabled: true || false,
@@ -184,6 +193,7 @@ export interface PromoteReadReplicaDBClusterCommandOutput extends PromoteReadRep
  * //       RdsCustomClusterConfiguration: {
  * //         InterconnectSubnetId: "STRING_VALUE",
  * //         TransitGatewayMulticastDomainId: "STRING_VALUE",
+ * //         ReplicaMode: "open-read-only" || "mounted",
  * //       },
  * //       Iops: Number("int"),
  * //       StorageType: "STRING_VALUE",

diff --git a/clients/client-rds/src/commands/RebootDBClusterCommand.ts b/clients/client-rds/src/commands/RebootDBClusterCommand.ts
@@ -98,6 +98,14 @@ export interface RebootDBClusterCommandOutput extends RebootDBClusterResult, __M
  * //     ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
  * //       "STRING_VALUE",
  * //     ],
+ * //     StatusInfos: [ // DBClusterStatusInfoList
+ * //       { // DBClusterStatusInfo
+ * //         StatusType: "STRING_VALUE",
+ * //         Normal: true || false,
+ * //         Status: "STRING_VALUE",
+ * //         Message: "STRING_VALUE",
+ * //       },
+ * //     ],
  * //     DBClusterMembers: [ // DBClusterMemberList
  * //       { // DBClusterMember
  * //         DBInstanceIdentifier: "STRING_VALUE",
@@ -146,6 +154,7 @@ export interface RebootDBClusterCommandOutput extends RebootDBClusterResult, __M
  * //     RdsCustomClusterConfiguration: { // RdsCustomClusterConfiguration
  * //       InterconnectSubnetId: "STRING_VALUE",
  * //       TransitGatewayMulticastDomainId: "STRING_VALUE",
+ * //       ReplicaMode: "open-read-only" || "mounted",
  * //     },
  * //     DeletionProtection: true || false,
  * //     HttpEndpointEnabled: true || false,
@@ -194,6 +203,7 @@ export interface RebootDBClusterCommandOutput extends RebootDBClusterResult, __M
  * //       RdsCustomClusterConfiguration: {
  * //         InterconnectSubnetId: "STRING_VALUE",
  * //         TransitGatewayMulticastDomainId: "STRING_VALUE",
+ * //         ReplicaMode: "open-read-only" || "mounted",
  * //       },
  * //       Iops: Number("int"),
  * //       StorageType: "STRING_VALUE",

diff --git a/clients/client-rds/src/commands/RestoreDBClusterFromS3Command.ts b/clients/client-rds/src/commands/RestoreDBClusterFromS3Command.ts
@@ -154,6 +154,14 @@ export interface RestoreDBClusterFromS3CommandOutput extends RestoreDBClusterFro
  * //     ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
  * //       "STRING_VALUE",
  * //     ],
+ * //     StatusInfos: [ // DBClusterStatusInfoList
+ * //       { // DBClusterStatusInfo
+ * //         StatusType: "STRING_VALUE",
+ * //         Normal: true || false,
+ * //         Status: "STRING_VALUE",
+ * //         Message: "STRING_VALUE",
+ * //       },
+ * //     ],
  * //     DBClusterMembers: [ // DBClusterMemberList
  * //       { // DBClusterMember
  * //         DBInstanceIdentifier: "STRING_VALUE",
@@ -202,6 +210,7 @@ export interface RestoreDBClusterFromS3CommandOutput extends RestoreDBClusterFro
  * //     RdsCustomClusterConfiguration: { // RdsCustomClusterConfiguration
  * //       InterconnectSubnetId: "STRING_VALUE",
  * //       TransitGatewayMulticastDomainId: "STRING_VALUE",
+ * //       ReplicaMode: "open-read-only" || "mounted",
  * //     },
  * //     DeletionProtection: true || false,
  * //     HttpEndpointEnabled: true || false,
@@ -250,6 +259,7 @@ export interface RestoreDBClusterFromS3CommandOutput extends RestoreDBClusterFro
  * //       RdsCustomClusterConfiguration: {
  * //         InterconnectSubnetId: "STRING_VALUE",
  * //         TransitGatewayMulticastDomainId: "STRING_VALUE",
+ * //         ReplicaMode: "open-read-only" || "mounted",
  * //       },
  * //       Iops: Number("int"),
  * //       StorageType: "STRING_VALUE",

diff --git a/clients/client-rds/src/commands/RestoreDBClusterFromSnapshotCommand.ts b/clients/client-rds/src/commands/RestoreDBClusterFromSnapshotCommand.ts
@@ -117,6 +117,7 @@ export interface RestoreDBClusterFromSnapshotCommandOutput
  *   RdsCustomClusterConfiguration: { // RdsCustomClusterConfiguration
  *     InterconnectSubnetId: "STRING_VALUE",
  *     TransitGatewayMulticastDomainId: "STRING_VALUE",
+ *     ReplicaMode: "open-read-only" || "mounted",
  *   },
  * };
  * const command = new RestoreDBClusterFromSnapshotCommand(input);
@@ -160,6 +161,14 @@ export interface RestoreDBClusterFromSnapshotCommandOutput
  * //     ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
  * //       "STRING_VALUE",
  * //     ],
+ * //     StatusInfos: [ // DBClusterStatusInfoList
+ * //       { // DBClusterStatusInfo
+ * //         StatusType: "STRING_VALUE",
+ * //         Normal: true || false,
+ * //         Status: "STRING_VALUE",
+ * //         Message: "STRING_VALUE",
+ * //       },
+ * //     ],
  * //     DBClusterMembers: [ // DBClusterMemberList
  * //       { // DBClusterMember
  * //         DBInstanceIdentifier: "STRING_VALUE",
@@ -208,6 +217,7 @@ export interface RestoreDBClusterFromSnapshotCommandOutput
  * //     RdsCustomClusterConfiguration: { // RdsCustomClusterConfiguration
  * //       InterconnectSubnetId: "STRING_VALUE",
  * //       TransitGatewayMulticastDomainId: "STRING_VALUE",
+ * //       ReplicaMode: "open-read-only" || "mounted",
  * //     },
  * //     DeletionProtection: true || false,
  * //     HttpEndpointEnabled: true || false,
@@ -256,6 +266,7 @@ export interface RestoreDBClusterFromSnapshotCommandOutput
  * //       RdsCustomClusterConfiguration: {
  * //         InterconnectSubnetId: "STRING_VALUE",
  * //         TransitGatewayMulticastDomainId: "STRING_VALUE",
+ * //         ReplicaMode: "open-read-only" || "mounted",
  * //       },
  * //       Iops: Number("int"),
  * //       StorageType: "STRING_VALUE",

diff --git a/clients/client-rds/src/commands/RestoreDBClusterToPointInTimeCommand.ts b/clients/client-rds/src/commands/RestoreDBClusterToPointInTimeCommand.ts
@@ -119,6 +119,7 @@ export interface RestoreDBClusterToPointInTimeCommandOutput
  *   RdsCustomClusterConfiguration: { // RdsCustomClusterConfiguration
  *     InterconnectSubnetId: "STRING_VALUE",
  *     TransitGatewayMulticastDomainId: "STRING_VALUE",
+ *     ReplicaMode: "open-read-only" || "mounted",
  *   },
  * };
  * const command = new RestoreDBClusterToPointInTimeCommand(input);
@@ -162,6 +163,14 @@ export interface RestoreDBClusterToPointInTimeCommandOutput
  * //     ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
  * //       "STRING_VALUE",
  * //     ],
+ * //     StatusInfos: [ // DBClusterStatusInfoList
+ * //       { // DBClusterStatusInfo
+ * //         StatusType: "STRING_VALUE",
+ * //         Normal: true || false,
+ * //         Status: "STRING_VALUE",
+ * //         Message: "STRING_VALUE",
+ * //       },
+ * //     ],
  * //     DBClusterMembers: [ // DBClusterMemberList
  * //       { // DBClusterMember
  * //         DBInstanceIdentifier: "STRING_VALUE",
@@ -210,6 +219,7 @@ export interface RestoreDBClusterToPointInTimeCommandOutput
  * //     RdsCustomClusterConfiguration: { // RdsCustomClusterConfiguration
  * //       InterconnectSubnetId: "STRING_VALUE",
  * //       TransitGatewayMulticastDomainId: "STRING_VALUE",
+ * //       ReplicaMode: "open-read-only" || "mounted",
  * //     },
  * //     DeletionProtection: true || false,
  * //     HttpEndpointEnabled: true || false,
@@ -258,6 +268,7 @@ export interface RestoreDBClusterToPointInTimeCommandOutput
  * //       RdsCustomClusterConfiguration: {
  * //         InterconnectSubnetId: "STRING_VALUE",
  * //         TransitGatewayMulticastDomainId: "STRING_VALUE",
+ * //         ReplicaMode: "open-read-only" || "mounted",
  * //       },
  * //       Iops: Number("int"),
  * //       StorageType: "STRING_VALUE",