@aws-sdk/client-rds 3.130.0 → 3.136.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 (45) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/dist-cjs/RDS.js +15 -0
  3. package/dist-cjs/commands/ModifyActivityStreamCommand.js +36 -0
  4. package/dist-cjs/commands/index.js +1 -0
  5. package/dist-cjs/models/models_0.js +13 -12
  6. package/dist-cjs/models/models_1.js +27 -4
  7. package/dist-cjs/protocols/Aws_query.js +104 -5
  8. package/dist-es/RDS.js +15 -0
  9. package/dist-es/commands/ModifyActivityStreamCommand.js +39 -0
  10. package/dist-es/commands/index.js +1 -0
  11. package/dist-es/models/models_0.js +7 -4
  12. package/dist-es/models/models_1.js +17 -0
  13. package/dist-es/protocols/Aws_query.js +112 -0
  14. package/dist-types/RDS.d.ts +55 -68
  15. package/dist-types/RDSClient.d.ts +3 -2
  16. package/dist-types/commands/BacktrackDBClusterCommand.d.ts +1 -1
  17. package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +9 -42
  18. package/dist-types/commands/CopyDBSnapshotCommand.d.ts +3 -3
  19. package/dist-types/commands/CreateDBClusterCommand.d.ts +1 -3
  20. package/dist-types/commands/CreateDBClusterEndpointCommand.d.ts +1 -1
  21. package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +9 -9
  22. package/dist-types/commands/CreateDBInstanceCommand.d.ts +8 -0
  23. package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts +2 -2
  24. package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +1 -1
  25. package/dist-types/commands/CreateGlobalClusterCommand.d.ts +1 -1
  26. package/dist-types/commands/DescribeEventsCommand.d.ts +2 -0
  27. package/dist-types/commands/FailoverDBClusterCommand.d.ts +1 -1
  28. package/dist-types/commands/ModifyActivityStreamCommand.d.ts +39 -0
  29. package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +1 -1
  30. package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +1 -1
  31. package/dist-types/commands/ModifyDBSnapshotAttributeCommand.d.ts +1 -1
  32. package/dist-types/commands/RebootDBInstanceCommand.d.ts +1 -0
  33. package/dist-types/commands/StopDBInstanceAutomatedBackupsReplicationCommand.d.ts +1 -1
  34. package/dist-types/commands/index.d.ts +1 -0
  35. package/dist-types/models/models_0.d.ts +342 -133
  36. package/dist-types/models/models_1.d.ts +216 -39
  37. package/dist-types/protocols/Aws_query.d.ts +3 -0
  38. package/dist-types/ts3.4/RDS.d.ts +5 -0
  39. package/dist-types/ts3.4/RDSClient.d.ts +3 -2
  40. package/dist-types/ts3.4/commands/ModifyActivityStreamCommand.d.ts +17 -0
  41. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  42. package/dist-types/ts3.4/models/models_0.d.ts +8 -11
  43. package/dist-types/ts3.4/models/models_1.d.ts +44 -1
  44. package/dist-types/ts3.4/protocols/Aws_query.d.ts +3 -0
  45. package/package.json +4 -4
@@ -21,15 +21,15 @@ export interface CreateDBClusterParameterGroupCommandOutput extends CreateDBClus
21
21
  * cluster without failover for the new DB cluster parameter group and associated settings to take effect.</p>
22
22
  * <important>
23
23
  * <p>After you create a DB cluster parameter group, you should wait at least 5 minutes
24
- * before creating your first DB cluster
25
- * that uses that DB cluster parameter group as the default parameter
26
- * group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter
27
- * group is used as the default for a new DB cluster. This is especially important for parameters
28
- * that are critical when creating the default database for a DB cluster, such as the character set
29
- * for the default database defined by the <code>character_set_database</code> parameter. You can use the
30
- * <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the
31
- * <code>DescribeDBClusterParameters</code> action to verify
32
- * that your DB cluster parameter group has been created or modified.</p>
24
+ * before creating your first DB cluster that uses that DB cluster parameter group as
25
+ * the default parameter group. This allows Amazon RDS to fully complete the create
26
+ * action before the DB cluster parameter group is used as the default for a new DB
27
+ * cluster. This is especially important for parameters that are critical when creating
28
+ * the default database for a DB cluster, such as the character set for the default
29
+ * database defined by the <code>character_set_database</code> parameter. You can use
30
+ * the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the
31
+ * <code>DescribeDBClusterParameters</code> operation to verify that your DB
32
+ * cluster parameter group has been created or modified.</p>
33
33
  * </important>
34
34
  * <p>For more information on Amazon Aurora, see
35
35
  * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
@@ -8,6 +8,14 @@ export interface CreateDBInstanceCommandOutput extends CreateDBInstanceResult, _
8
8
  }
9
9
  /**
10
10
  * <p>Creates a new DB instance.</p>
11
+ * <p>The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster.
12
+ * For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance
13
+ * to the cluster.</p>
14
+ * <p>For more information about creating an RDS DB instance, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html">
15
+ * Creating an Amazon RDS DB instance</a> in the <i>Amazon RDS User Guide</i>.</p>
16
+ * <p>For more information about creating a DB instance in an Aurora DB cluster, see
17
+ * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html">
18
+ * Creating an Amazon Aurora DB cluster</a> in the <i>Amazon Aurora User Guide</i>.</p>
11
19
  * @example
12
20
  * Use a bare-bones client and the command you need to make an API call.
13
21
  * ```javascript
@@ -11,8 +11,8 @@ export interface CreateDBInstanceReadReplicaCommandOutput extends CreateDBInstan
11
11
  * instance. You can create a read replica for a DB instance running MySQL, MariaDB,
12
12
  * Oracle, PostgreSQL, or SQL Server. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html">Working with Read
13
13
  * Replicas</a> in the <i>Amazon RDS User Guide</i>.</p>
14
- * <p>Amazon Aurora doesn't support this action. Call the <code>CreateDBInstance</code>
15
- * action to create a DB instance for an Aurora DB cluster.</p>
14
+ * <p>Amazon Aurora doesn't support this operation. Call the <code>CreateDBInstance</code>
15
+ * operation to create a DB instance for an Aurora DB cluster.</p>
16
16
  * <p>All read replica DB instances are created with backups disabled. All other DB
17
17
  * instance attributes (including DB security groups and DB parameter groups) are inherited
18
18
  * from the source DB instance, except as specified.</p>
@@ -7,7 +7,7 @@ export interface CreateEventSubscriptionCommandInput extends CreateEventSubscrip
7
7
  export interface CreateEventSubscriptionCommandOutput extends CreateEventSubscriptionResult, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Creates an RDS event notification subscription. This action requires a topic Amazon
10
+ * <p>Creates an RDS event notification subscription. This operation requires a topic Amazon
11
11
  * Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.
12
12
  * To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the
13
13
  * topic. The ARN is displayed in the SNS console.</p>
@@ -18,7 +18,7 @@ export interface CreateGlobalClusterCommandOutput extends CreateGlobalClusterRes
18
18
  * Or you can specify an existing Aurora cluster during the create operation,
19
19
  * and this cluster becomes the primary cluster of the global database.</p>
20
20
  * <note>
21
- * <p>This action only applies to Aurora DB clusters.</p>
21
+ * <p>This action applies only to Aurora DB clusters.</p>
22
22
  * </note>
23
23
  * @example
24
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -10,6 +10,8 @@ export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBe
10
10
  * <p>Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days.
11
11
  * Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be
12
12
  * obtained by providing the name as a parameter.</p>
13
+ * <p>For more information on working with events, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/working-with-events.html">Monitoring Amazon RDS events</a> in the <i>Amazon RDS User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/working-with-events.html">Monitoring Amazon Aurora
14
+ * events</a> in the <i>Amazon Aurora User Guide</i>.</p>
13
15
  * <note>
14
16
  * <p>By default, RDS returns events that were generated in the past hour.</p>
15
17
  * </note>
@@ -13,7 +13,7 @@ export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult,
13
13
  * <p>For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances)
14
14
  * in the DB cluster to be the primary DB instance (the cluster writer).</p>
15
15
  * <p>An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists,
16
- * when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readbable standby
16
+ * when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby
17
17
  * DB instance when the primary DB instance fails.</p>
18
18
  * <p>To simulate a failure of a primary instance for testing, you can force a failover.
19
19
  * Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing
@@ -0,0 +1,39 @@
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 { ModifyActivityStreamRequest, ModifyActivityStreamResponse } from "../models/models_1";
4
+ import { RDSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSClient";
5
+ export interface ModifyActivityStreamCommandInput extends ModifyActivityStreamRequest {
6
+ }
7
+ export interface ModifyActivityStreamCommandOutput extends ModifyActivityStreamResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only,
11
+ * whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy,
12
+ * and then lock your activity stream. Restarting the activity stream isn't required. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.Modifying.html"> Modifying a database activity stream</a> in the
13
+ * <i>Amazon RDS User Guide</i>. </p>
14
+ * <p>This operation is supported for RDS for Oracle only.</p>
15
+ * @example
16
+ * Use a bare-bones client and the command you need to make an API call.
17
+ * ```javascript
18
+ * import { RDSClient, ModifyActivityStreamCommand } from "@aws-sdk/client-rds"; // ES Modules import
19
+ * // const { RDSClient, ModifyActivityStreamCommand } = require("@aws-sdk/client-rds"); // CommonJS import
20
+ * const client = new RDSClient(config);
21
+ * const command = new ModifyActivityStreamCommand(input);
22
+ * const response = await client.send(command);
23
+ * ```
24
+ *
25
+ * @see {@link ModifyActivityStreamCommandInput} for command's `input` shape.
26
+ * @see {@link ModifyActivityStreamCommandOutput} for command's `response` shape.
27
+ * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
28
+ *
29
+ */
30
+ export declare class ModifyActivityStreamCommand extends $Command<ModifyActivityStreamCommandInput, ModifyActivityStreamCommandOutput, RDSClientResolvedConfig> {
31
+ readonly input: ModifyActivityStreamCommandInput;
32
+ constructor(input: ModifyActivityStreamCommandInput);
33
+ /**
34
+ * @internal
35
+ */
36
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RDSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ModifyActivityStreamCommandInput, ModifyActivityStreamCommandOutput>;
37
+ private serialize;
38
+ private deserialize;
39
+ }
@@ -19,7 +19,7 @@ export interface ModifyDBClusterParameterGroupCommandOutput extends DBClusterPar
19
19
  * that are critical when creating the default database for a DB cluster, such as the character set
20
20
  * for the default database defined by the <code>character_set_database</code> parameter. You can use the
21
21
  * <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the
22
- * <code>DescribeDBClusterParameters</code> action to verify
22
+ * <code>DescribeDBClusterParameters</code> operation to verify
23
23
  * that your DB cluster parameter group has been created or modified.</p>
24
24
  * <p>If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora
25
25
  * applies the update immediately. The cluster restart might interrupt your workload. In that case,
@@ -24,7 +24,7 @@ export interface ModifyDBClusterSnapshotAttributeCommandOutput extends ModifyDBC
24
24
  * parameter. You can't use <code>all</code> as a value for that parameter in this
25
25
  * case.</p>
26
26
  * <p>To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster
27
- * snapshot, or whether a manual DB cluster snapshot is public or private, use the <a>DescribeDBClusterSnapshotAttributes</a> API action. The accounts are
27
+ * snapshot, or whether a manual DB cluster snapshot is public or private, use the <a>DescribeDBClusterSnapshotAttributes</a> API operation. The accounts are
28
28
  * returned as values for the <code>restore</code> attribute.</p>
29
29
  * @example
30
30
  * Use a bare-bones client and the command you need to make an API call.
@@ -22,7 +22,7 @@ export interface ModifyDBSnapshotAttributeCommandOutput extends ModifyDBSnapshot
22
22
  * list of authorized Amazon Web Services account IDs for the <code>ValuesToAdd</code> parameter. You
23
23
  * can't use <code>all</code> as a value for that parameter in this case.</p>
24
24
  * <p>To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or
25
- * whether a manual DB snapshot public or private, use the <a>DescribeDBSnapshotAttributes</a> API action. The accounts are returned as
25
+ * whether a manual DB snapshot public or private, use the <a>DescribeDBSnapshotAttributes</a> API operation. The accounts are returned as
26
26
  * values for the <code>restore</code> attribute.</p>
27
27
  * @example
28
28
  * Use a bare-bones client and the command you need to make an API call.
@@ -16,6 +16,7 @@ export interface RebootDBInstanceCommandOutput extends RebootDBInstanceResult, _
16
16
  * <p>For more information about rebooting, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_RebootInstance.html">Rebooting a DB Instance</a> in the <i>Amazon RDS User Guide.</i>
17
17
  * </p>
18
18
  * <p>This command doesn't apply to RDS Custom.</p>
19
+ * <p>If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the <code>RebootDBCluster</code> operation.</p>
19
20
  * @example
20
21
  * Use a bare-bones client and the command you need to make an API call.
21
22
  * ```javascript
@@ -8,7 +8,7 @@ export interface StopDBInstanceAutomatedBackupsReplicationCommandOutput extends
8
8
  }
9
9
  /**
10
10
  * <p>Stops automated backup replication for a DB instance.</p>
11
- * <p>This command doesn't apply to RDS Custom.</p>
11
+ * <p>This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.</p>
12
12
  * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html">
13
13
  * Replicating Automated Backups to Another Amazon Web Services Region</a> in the <i>Amazon RDS User Guide.</i>
14
14
  * </p>
@@ -86,6 +86,7 @@ export * from "./DownloadDBLogFilePortionCommand";
86
86
  export * from "./FailoverDBClusterCommand";
87
87
  export * from "./FailoverGlobalClusterCommand";
88
88
  export * from "./ListTagsForResourceCommand";
89
+ export * from "./ModifyActivityStreamCommand";
89
90
  export * from "./ModifyCertificatesCommand";
90
91
  export * from "./ModifyCurrentDBClusterCapacityCommand";
91
92
  export * from "./ModifyCustomDBEngineVersionCommand";