@aws-sdk/client-rds 3.41.0 → 3.46.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/CHANGELOG.md +51 -0
  2. package/dist-cjs/RDS.js +15 -0
  3. package/dist-cjs/commands/RebootDBClusterCommand.js +36 -0
  4. package/dist-cjs/commands/index.js +1 -0
  5. package/dist-cjs/endpoints.js +9 -0
  6. package/dist-cjs/models/models_1.js +14 -2
  7. package/dist-cjs/protocols/Aws_query.js +248 -4
  8. package/dist-cjs/runtimeConfig.js +0 -2
  9. package/dist-es/RDS.js +15 -0
  10. package/dist-es/commands/RebootDBClusterCommand.js +39 -0
  11. package/dist-es/commands/index.js +1 -0
  12. package/dist-es/endpoints.js +9 -0
  13. package/dist-es/models/models_1.js +8 -0
  14. package/dist-es/protocols/Aws_query.js +250 -0
  15. package/dist-es/runtimeConfig.js +0 -2
  16. package/dist-types/RDS.d.ts +199 -118
  17. package/dist-types/RDSClient.d.ts +3 -2
  18. package/dist-types/commands/AddRoleToDBClusterCommand.d.ts +1 -6
  19. package/dist-types/commands/AuthorizeDBSecurityGroupIngressCommand.d.ts +1 -1
  20. package/dist-types/commands/CopyDBClusterParameterGroupCommand.d.ts +0 -3
  21. package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +11 -7
  22. package/dist-types/commands/CreateCustomDBEngineVersionCommand.d.ts +5 -9
  23. package/dist-types/commands/CreateDBClusterCommand.d.ts +11 -8
  24. package/dist-types/commands/CreateDBClusterEndpointCommand.d.ts +3 -3
  25. package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +11 -5
  26. package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +8 -4
  27. package/dist-types/commands/DeleteDBClusterCommand.d.ts +6 -3
  28. package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +6 -2
  29. package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +6 -2
  30. package/dist-types/commands/DescribeDBClusterBacktracksCommand.d.ts +1 -1
  31. package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +6 -2
  32. package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +6 -2
  33. package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +0 -3
  34. package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +7 -3
  35. package/dist-types/commands/DescribeDBClustersCommand.d.ts +9 -4
  36. package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +1 -1
  37. package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +1 -1
  38. package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +1 -1
  39. package/dist-types/commands/FailoverDBClusterCommand.d.ts +16 -8
  40. package/dist-types/commands/ModifyCustomDBEngineVersionCommand.d.ts +1 -1
  41. package/dist-types/commands/ModifyDBClusterCommand.d.ts +11 -7
  42. package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +9 -5
  43. package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +0 -3
  44. package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +1 -1
  45. package/dist-types/commands/PromoteReadReplicaDBClusterCommand.d.ts +0 -3
  46. package/dist-types/commands/RebootDBClusterCommand.d.ts +52 -0
  47. package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +1 -1
  48. package/dist-types/commands/RemoveRoleFromDBClusterCommand.d.ts +11 -4
  49. package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +7 -4
  50. package/dist-types/commands/RestoreDBClusterFromS3Command.d.ts +1 -1
  51. package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +8 -5
  52. package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +8 -4
  53. package/dist-types/commands/index.d.ts +1 -0
  54. package/dist-types/models/models_0.d.ts +546 -196
  55. package/dist-types/models/models_1.d.ts +690 -151
  56. package/dist-types/protocols/Aws_query.d.ts +3 -0
  57. package/dist-types/ts3.4/RDS.d.ts +5 -0
  58. package/dist-types/ts3.4/RDSClient.d.ts +3 -2
  59. package/dist-types/ts3.4/commands/RebootDBClusterCommand.d.ts +17 -0
  60. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  61. package/dist-types/ts3.4/models/models_0.d.ts +50 -0
  62. package/dist-types/ts3.4/models/models_1.d.ts +58 -0
  63. package/dist-types/ts3.4/protocols/Aws_query.d.ts +3 -0
  64. package/package.json +38 -45
@@ -10,7 +10,7 @@ export interface ModifyGlobalClusterCommandOutput extends ModifyGlobalClusterRes
10
10
  * <p>
11
11
  * Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration
12
12
  * parameters by specifying these parameters and the new values in the request. For more information on
13
- * Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html"> What Is Amazon Aurora?</a> in the
13
+ * Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html"> What is Amazon Aurora?</a> in the
14
14
  * <i>Amazon Aurora User Guide.</i>
15
15
  * </p>
16
16
  * <note>
@@ -8,9 +8,6 @@ export interface PromoteReadReplicaDBClusterCommandOutput extends PromoteReadRep
8
8
  }
9
9
  /**
10
10
  * <p>Promotes a read replica DB cluster to a standalone DB cluster.</p>
11
- * <note>
12
- * <p>This action only applies to Aurora DB clusters.</p>
13
- * </note>
14
11
  * @example
15
12
  * Use a bare-bones client and the command you need to make an API call.
16
13
  * ```javascript
@@ -0,0 +1,52 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { RebootDBClusterMessage, RebootDBClusterResult } from "../models/models_1";
4
+ import { RDSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSClient";
5
+ export interface RebootDBClusterCommandInput extends RebootDBClusterMessage {
6
+ }
7
+ export interface RebootDBClusterCommandOutput extends RebootDBClusterResult, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>You might need to reboot your DB cluster, usually for maintenance reasons.
11
+ * For example, if you make certain modifications,
12
+ * or if you change the DB cluster parameter group associated with the DB cluster,
13
+ * reboot the DB cluster for the changes to take effect.
14
+ * </p>
15
+ *
16
+ * <p>Rebooting a DB cluster restarts the database engine service. Rebooting a DB
17
+ * cluster results in a momentary outage, during which the DB cluster status is set to rebooting.
18
+ * </p>
19
+ *
20
+ * <p>Use this operation only for a non-Aurora Multi-AZ DB cluster.
21
+ * The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
22
+ *
23
+ * <p>For more information on Multi-AZ DB clusters, see
24
+ * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
25
+ * Multi-AZ deployments with two readable standby DB instances</a> in the
26
+ * <i>Amazon RDS User Guide.</i>
27
+ * </p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { RDSClient, RebootDBClusterCommand } from "@aws-sdk/client-rds"; // ES Modules import
32
+ * // const { RDSClient, RebootDBClusterCommand } = require("@aws-sdk/client-rds"); // CommonJS import
33
+ * const client = new RDSClient(config);
34
+ * const command = new RebootDBClusterCommand(input);
35
+ * const response = await client.send(command);
36
+ * ```
37
+ *
38
+ * @see {@link RebootDBClusterCommandInput} for command's `input` shape.
39
+ * @see {@link RebootDBClusterCommandOutput} for command's `response` shape.
40
+ * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
41
+ *
42
+ */
43
+ export declare class RebootDBClusterCommand extends $Command<RebootDBClusterCommandInput, RebootDBClusterCommandOutput, RDSClientResolvedConfig> {
44
+ readonly input: RebootDBClusterCommandInput;
45
+ constructor(input: RebootDBClusterCommandInput);
46
+ /**
47
+ * @internal
48
+ */
49
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RDSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RebootDBClusterCommandInput, RebootDBClusterCommandOutput>;
50
+ private serialize;
51
+ private deserialize;
52
+ }
@@ -10,7 +10,7 @@ export interface RemoveFromGlobalClusterCommandOutput extends RemoveFromGlobalCl
10
10
  * <p>
11
11
  * Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a
12
12
  * standalone cluster with read-write capability instead of being read-only and receiving data from a
13
- * primary cluster in a different region.
13
+ * primary cluster in a different Region.
14
14
  * </p>
15
15
  * <note>
16
16
  * <p>This action only applies to Aurora DB clusters.</p>
@@ -7,11 +7,18 @@ export interface RemoveRoleFromDBClusterCommandInput extends RemoveRoleFromDBClu
7
7
  export interface RemoveRoleFromDBClusterCommandOutput extends __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Disassociates an Amazon Web Services Identity and Access Management (IAM) role from an Amazon Aurora DB cluster.
11
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.Authorizing.html">Authorizing Amazon Aurora MySQL
12
- * to Access Other Amazon Web Services Services on Your Behalf </a> in the <i>Amazon Aurora User Guide</i>.</p>
10
+ * <p>Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a
11
+ * DB cluster.</p>
12
+ * <p>For more information on Amazon Aurora DB clusters, see
13
+ * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
14
+ * What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
15
+ * </p>
16
+ * <p>For more information on Multi-AZ DB clusters, see
17
+ * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
18
+ * Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
19
+ * </p>
13
20
  * <note>
14
- * <p>This action only applies to Aurora DB clusters.</p>
21
+ * <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
15
22
  * </note>
16
23
  * @example
17
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -19,13 +19,16 @@ export interface ResetDBClusterParameterGroupCommandOutput extends DBClusterPara
19
19
  * are set to <code>pending-reboot</code> to take effect on the next DB instance restart
20
20
  * or <code>RebootDBInstance</code> request. You must call <code>RebootDBInstance</code> for every
21
21
  * DB instance in your DB cluster that you want the updated static parameter to apply to.</p>
22
- *
23
- * <p>For more information on Amazon Aurora, see
22
+ * <p>For more information on Amazon Aurora DB clusters, see
24
23
  * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
25
- * What Is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
24
+ * What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
25
+ * </p>
26
+ * <p>For more information on Multi-AZ DB clusters, see
27
+ * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
28
+ * Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
26
29
  * </p>
27
30
  * <note>
28
- * <p>This action only applies to Aurora DB clusters.</p>
31
+ * <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
29
32
  * </note>
30
33
  * @example
31
34
  * Use a bare-bones client and the command you need to make an API call.
@@ -21,7 +21,7 @@ export interface RestoreDBClusterFromS3CommandOutput extends RestoreDBClusterFro
21
21
  * </note>
22
22
  * <p>For more information on Amazon Aurora, see
23
23
  * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
24
- * What Is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
24
+ * What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
25
25
  * </p>
26
26
  * <note>
27
27
  * <p>This action only applies to Aurora DB clusters. The source DB engine must be
@@ -7,8 +7,7 @@ export interface RestoreDBClusterFromSnapshotCommandInput extends RestoreDBClust
7
7
  export interface RestoreDBClusterFromSnapshotCommandOutput extends RestoreDBClusterFromSnapshotResult, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Creates a new DB cluster from a DB snapshot or DB cluster snapshot. This action
11
- * only applies to Aurora DB clusters.</p>
10
+ * <p>Creates a new DB cluster from a DB snapshot or DB cluster snapshot.</p>
12
11
  * <p>The target DB cluster is created from the source snapshot with a default
13
12
  * configuration. If you don't specify a security group, the new DB cluster is
14
13
  * associated with the default security group.</p>
@@ -20,12 +19,16 @@ export interface RestoreDBClusterFromSnapshotCommandOutput extends RestoreDBClus
20
19
  * the <code>RestoreDBClusterFromSnapshot</code> action has completed and the DB
21
20
  * cluster is available.</p>
22
21
  * </note>
23
- * <p>For more information on Amazon Aurora, see
22
+ * <p>For more information on Amazon Aurora DB clusters, see
24
23
  * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
25
- * What Is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
24
+ * What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
25
+ * </p>
26
+ * <p>For more information on Multi-AZ DB clusters, see
27
+ * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
28
+ * Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
26
29
  * </p>
27
30
  * <note>
28
- * <p>This action only applies to Aurora DB clusters.</p>
31
+ * <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
29
32
  * </note>
30
33
  * @example
31
34
  * Use a bare-bones client and the command you need to make an API call.
@@ -13,19 +13,23 @@ export interface RestoreDBClusterToPointInTimeCommandOutput extends RestoreDBClu
13
13
  * source DB cluster with the same configuration as the original DB cluster, except that
14
14
  * the new DB cluster is created with the default DB security group. </p>
15
15
  * <note>
16
- * <p>This action only restores the DB cluster, not the DB instances for that DB
16
+ * <p>For Aurora, this action only restores the DB cluster, not the DB instances for that DB
17
17
  * cluster. You must invoke the <code>CreateDBInstance</code> action to create DB
18
18
  * instances for the restored DB cluster, specifying the identifier of the restored DB
19
19
  * cluster in <code>DBClusterIdentifier</code>. You can create DB instances only after
20
20
  * the <code>RestoreDBClusterToPointInTime</code> action has completed and the DB
21
21
  * cluster is available.</p>
22
22
  * </note>
23
- * <p>For more information on Amazon Aurora, see
23
+ * <p>For more information on Amazon Aurora DB clusters, see
24
24
  * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
25
- * What Is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
25
+ * What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i>
26
+ * </p>
27
+ * <p>For more information on Multi-AZ DB clusters, see
28
+ * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
29
+ * Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
26
30
  * </p>
27
31
  * <note>
28
- * <p>This action only applies to Aurora DB clusters.</p>
32
+ * <p>The Multi-AZ DB clusters feature is in preview and is subject to change.</p>
29
33
  * </note>
30
34
  * @example
31
35
  * Use a bare-bones client and the command you need to make an API call.
@@ -113,6 +113,7 @@ export * from "./ModifyOptionGroupCommand";
113
113
  export * from "./PromoteReadReplicaCommand";
114
114
  export * from "./PromoteReadReplicaDBClusterCommand";
115
115
  export * from "./PurchaseReservedDBInstancesOfferingCommand";
116
+ export * from "./RebootDBClusterCommand";
116
117
  export * from "./RebootDBInstanceCommand";
117
118
  export * from "./RegisterDBProxyTargetsCommand";
118
119
  export * from "./RemoveFromGlobalClusterCommand";