@aws-sdk/client-rds 3.225.0 → 3.229.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.
- package/README.md +0 -1
- package/dist-cjs/protocols/Aws_query.js +19 -0
- package/dist-cjs/runtimeConfig.browser.js +3 -3
- package/dist-cjs/runtimeConfig.js +2 -1
- package/dist-es/protocols/Aws_query.js +19 -0
- package/dist-es/runtimeConfig.browser.js +1 -1
- package/dist-es/runtimeConfig.js +2 -1
- package/dist-types/RDS.d.ts +281 -282
- package/dist-types/RDSClient.d.ts +14 -15
- package/dist-types/commands/AddRoleToDBInstanceCommand.d.ts +3 -3
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +1 -1
- package/dist-types/commands/AuthorizeDBSecurityGroupIngressCommand.d.ts +4 -4
- package/dist-types/commands/BacktrackDBClusterCommand.d.ts +3 -3
- package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +10 -10
- package/dist-types/commands/CopyDBSnapshotCommand.d.ts +3 -3
- package/dist-types/commands/CreateBlueGreenDeploymentCommand.d.ts +3 -3
- package/dist-types/commands/CreateCustomDBEngineVersionCommand.d.ts +10 -10
- package/dist-types/commands/CreateDBClusterCommand.d.ts +3 -3
- package/dist-types/commands/CreateDBClusterEndpointCommand.d.ts +2 -2
- package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +8 -8
- package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +2 -2
- package/dist-types/commands/CreateDBInstanceCommand.d.ts +3 -3
- package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts +4 -4
- package/dist-types/commands/CreateDBParameterGroupCommand.d.ts +4 -4
- package/dist-types/commands/CreateDBSecurityGroupCommand.d.ts +3 -3
- package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +4 -4
- package/dist-types/commands/CreateGlobalClusterCommand.d.ts +3 -3
- package/dist-types/commands/CreateOptionGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBlueGreenDeploymentCommand.d.ts +1 -1
- package/dist-types/commands/DeleteCustomDBEngineVersionCommand.d.ts +7 -7
- package/dist-types/commands/DeleteDBClusterCommand.d.ts +2 -2
- package/dist-types/commands/DeleteDBClusterEndpointCommand.d.ts +2 -2
- package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +2 -2
- package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +4 -4
- package/dist-types/commands/DeleteDBInstanceCommand.d.ts +7 -7
- package/dist-types/commands/DeleteDBSecurityGroupCommand.d.ts +3 -3
- package/dist-types/commands/DeleteDBSnapshotCommand.d.ts +2 -2
- package/dist-types/commands/DeleteDBSubnetGroupCommand.d.ts +2 -2
- package/dist-types/commands/DeleteGlobalClusterCommand.d.ts +2 -2
- package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeBlueGreenDeploymentsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBClusterBacktracksCommand.d.ts +3 -3
- package/dist-types/commands/DescribeDBClusterEndpointsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +2 -2
- package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +2 -2
- package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeDBClustersCommand.d.ts +3 -3
- package/dist-types/commands/DescribeDBInstanceAutomatedBackupsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBInstancesCommand.d.ts +2 -2
- package/dist-types/commands/DescribeDBLogFilesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDBSecurityGroupsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeDBSnapshotAttributesCommand.d.ts +2 -2
- package/dist-types/commands/DescribeDBSubnetGroupsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEventCategoriesCommand.d.ts +2 -2
- package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEventsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +3 -3
- package/dist-types/commands/DescribeSourceRegionsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeValidDBInstanceModificationsCommand.d.ts +1 -1
- package/dist-types/commands/DownloadDBLogFilePortionCommand.d.ts +1 -1
- package/dist-types/commands/FailoverDBClusterCommand.d.ts +6 -6
- package/dist-types/commands/FailoverGlobalClusterCommand.d.ts +4 -4
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ModifyActivityStreamCommand.d.ts +1 -1
- package/dist-types/commands/ModifyCertificatesCommand.d.ts +7 -7
- package/dist-types/commands/ModifyCurrentDBClusterCapacityCommand.d.ts +7 -7
- package/dist-types/commands/ModifyCustomDBEngineVersionCommand.d.ts +3 -3
- package/dist-types/commands/ModifyDBClusterCommand.d.ts +2 -2
- package/dist-types/commands/ModifyDBClusterEndpointCommand.d.ts +2 -2
- package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +4 -4
- package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +5 -5
- package/dist-types/commands/ModifyDBParameterGroupCommand.d.ts +2 -2
- package/dist-types/commands/ModifyDBSnapshotAttributeCommand.d.ts +5 -5
- package/dist-types/commands/ModifyDBSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/ModifyEventSubscriptionCommand.d.ts +1 -1
- package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +2 -2
- package/dist-types/commands/PromoteReadReplicaCommand.d.ts +6 -6
- package/dist-types/commands/RebootDBClusterCommand.d.ts +3 -3
- package/dist-types/commands/RebootDBInstanceCommand.d.ts +4 -4
- package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +2 -2
- package/dist-types/commands/RemoveRoleFromDBClusterCommand.d.ts +2 -2
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +1 -1
- package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +3 -3
- package/dist-types/commands/RestoreDBClusterFromS3Command.d.ts +5 -5
- package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +5 -5
- package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +4 -4
- package/dist-types/commands/RestoreDBInstanceFromDBSnapshotCommand.d.ts +4 -4
- package/dist-types/commands/RestoreDBInstanceFromS3Command.d.ts +1 -1
- package/dist-types/commands/RestoreDBInstanceToPointInTimeCommand.d.ts +3 -3
- package/dist-types/commands/RevokeDBSecurityGroupIngressCommand.d.ts +2 -2
- package/dist-types/commands/StartDBClusterCommand.d.ts +3 -3
- package/dist-types/commands/StartDBInstanceAutomatedBackupsReplicationCommand.d.ts +2 -2
- package/dist-types/commands/StartDBInstanceCommand.d.ts +3 -3
- package/dist-types/commands/StartExportTaskCommand.d.ts +1 -1
- package/dist-types/commands/StopActivityStreamCommand.d.ts +1 -1
- package/dist-types/commands/StopDBClusterCommand.d.ts +3 -3
- package/dist-types/commands/StopDBInstanceAutomatedBackupsReplicationCommand.d.ts +2 -2
- package/dist-types/commands/StopDBInstanceCommand.d.ts +3 -3
- package/dist-types/commands/SwitchoverBlueGreenDeploymentCommand.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +1528 -1511
- package/dist-types/models/models_1.d.ts +1352 -1352
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +4 -0
- package/dist-types/ts3.4/models/models_1.d.ts +1 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +4 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +4 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +4 -1
- package/package.json +31 -30
|
@@ -11,10 +11,10 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M
|
|
|
11
11
|
* <p>Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster.
|
|
12
12
|
* You can change one or more settings by specifying these parameters and the new values in the
|
|
13
13
|
* request.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
15
15
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
16
16
|
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
18
18
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
19
19
|
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
20
20
|
* @example
|
|
@@ -10,9 +10,9 @@ export interface ModifyDBClusterEndpointCommandOutput extends DBClusterEndpoint,
|
|
|
10
10
|
}
|
|
11
11
|
/**
|
|
12
12
|
* <p>Modifies the properties of an endpoint in an Amazon Aurora DB cluster.</p>
|
|
13
|
-
*
|
|
13
|
+
* <note>
|
|
14
14
|
* <p>This action only applies to Aurora DB clusters.</p>
|
|
15
|
-
*
|
|
15
|
+
* </note>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
18
|
* ```javascript
|
|
@@ -12,7 +12,7 @@ export interface ModifyDBClusterParameterGroupCommandOutput extends DBClusterPar
|
|
|
12
12
|
* submit a list of the following: <code>ParameterName</code>, <code>ParameterValue</code>,
|
|
13
13
|
* and <code>ApplyMethod</code>. A maximum of 20
|
|
14
14
|
* parameters can be modified in a single request.</p>
|
|
15
|
-
*
|
|
15
|
+
* <important>
|
|
16
16
|
* <p>After you create a DB cluster parameter group, you should wait at least 5 minutes
|
|
17
17
|
* before creating your first DB cluster that uses that DB cluster parameter group as the default parameter
|
|
18
18
|
* group. This allows Amazon RDS to fully complete the create action before the parameter
|
|
@@ -26,11 +26,11 @@ export interface ModifyDBClusterParameterGroupCommandOutput extends DBClusterPar
|
|
|
26
26
|
* applies the update immediately. The cluster restart might interrupt your workload. In that case,
|
|
27
27
|
* your application must reopen any connections and retry any transactions that were active
|
|
28
28
|
* when the parameter changes took effect.</p>
|
|
29
|
-
*
|
|
30
|
-
*
|
|
29
|
+
* </important>
|
|
30
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
31
31
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
32
32
|
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
33
|
-
*
|
|
33
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
34
34
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
35
35
|
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
36
36
|
* </p>
|
|
@@ -9,22 +9,22 @@ export interface ModifyDBClusterSnapshotAttributeCommandOutput extends ModifyDBC
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify
|
|
13
13
|
* <code>restore</code> as the <code>AttributeName</code> and use the
|
|
14
14
|
* <code>ValuesToAdd</code> parameter to add a list of IDs of the Amazon Web Services accounts that are
|
|
15
15
|
* authorized to restore the manual DB cluster snapshot. Use the value <code>all</code> to
|
|
16
16
|
* make the manual DB cluster snapshot public, which means that it can be copied or
|
|
17
17
|
* restored by all Amazon Web Services accounts.</p>
|
|
18
|
-
*
|
|
18
|
+
* <note>
|
|
19
19
|
* <p>Don't add the <code>all</code> value for any manual DB cluster snapshots
|
|
20
20
|
* that contain private information that you don't want available to all Amazon Web Services
|
|
21
21
|
* accounts.</p>
|
|
22
|
-
*
|
|
23
|
-
*
|
|
22
|
+
* </note>
|
|
23
|
+
* <p>If a manual DB cluster snapshot is encrypted, it can be shared, but only by
|
|
24
24
|
* specifying a list of authorized Amazon Web Services account IDs for the <code>ValuesToAdd</code>
|
|
25
25
|
* parameter. You can't use <code>all</code> as a value for that parameter in this
|
|
26
26
|
* case.</p>
|
|
27
|
-
*
|
|
27
|
+
* <p>To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster
|
|
28
28
|
* snapshot, or whether a manual DB cluster snapshot is public or private, use the <a>DescribeDBClusterSnapshotAttributes</a> API operation. The accounts are
|
|
29
29
|
* returned as values for the <code>restore</code> attribute.</p>
|
|
30
30
|
* @example
|
|
@@ -11,7 +11,7 @@ export interface ModifyDBParameterGroupCommandOutput extends DBParameterGroupNam
|
|
|
11
11
|
* <p>Modifies the parameters of a DB parameter group. To modify more than one parameter,
|
|
12
12
|
* submit a list of the following: <code>ParameterName</code>, <code>ParameterValue</code>, and
|
|
13
13
|
* <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request.</p>
|
|
14
|
-
*
|
|
14
|
+
* <important>
|
|
15
15
|
* <p>After you modify a DB parameter group, you should wait at least 5 minutes
|
|
16
16
|
* before creating your first DB instance that uses that DB parameter group as the default parameter
|
|
17
17
|
* group. This allows Amazon RDS to fully complete the modify action before the parameter
|
|
@@ -21,7 +21,7 @@ export interface ModifyDBParameterGroupCommandOutput extends DBParameterGroupNam
|
|
|
21
21
|
* <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the
|
|
22
22
|
* <i>DescribeDBParameters</i> command to verify
|
|
23
23
|
* that your DB parameter group has been created or modified.</p>
|
|
24
|
-
*
|
|
24
|
+
* </important>
|
|
25
25
|
* @example
|
|
26
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
27
27
|
* ```javascript
|
|
@@ -9,20 +9,20 @@ export interface ModifyDBSnapshotAttributeCommandOutput extends ModifyDBSnapshot
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>To share a manual DB snapshot with other Amazon Web Services accounts, specify <code>restore</code>
|
|
13
13
|
* as the <code>AttributeName</code> and use the <code>ValuesToAdd</code> parameter to add
|
|
14
14
|
* a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot.
|
|
15
15
|
* Uses the value <code>all</code> to make the manual DB snapshot public, which means it
|
|
16
16
|
* can be copied or restored by all Amazon Web Services accounts.</p>
|
|
17
|
-
*
|
|
17
|
+
* <note>
|
|
18
18
|
* <p>Don't add the <code>all</code> value for any manual DB snapshots that
|
|
19
19
|
* contain private information that you don't want available to all Amazon Web Services
|
|
20
20
|
* accounts.</p>
|
|
21
|
-
*
|
|
22
|
-
*
|
|
21
|
+
* </note>
|
|
22
|
+
* <p>If the manual DB snapshot is encrypted, it can be shared, but only by specifying a
|
|
23
23
|
* list of authorized Amazon Web Services account IDs for the <code>ValuesToAdd</code> parameter. You
|
|
24
24
|
* can't use <code>all</code> as a value for that parameter in this case.</p>
|
|
25
|
-
*
|
|
25
|
+
* <p>To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or
|
|
26
26
|
* whether a manual DB snapshot public or private, use the <a>DescribeDBSnapshotAttributes</a> API operation. The accounts are returned as
|
|
27
27
|
* values for the <code>restore</code> attribute.</p>
|
|
28
28
|
* @example
|
|
@@ -12,7 +12,7 @@ export interface ModifyDBSnapshotCommandOutput extends ModifyDBSnapshotResult, _
|
|
|
12
12
|
* or unencrypted, but not shared or public.
|
|
13
13
|
*
|
|
14
14
|
* </p>
|
|
15
|
-
*
|
|
15
|
+
* <p>Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command
|
|
16
16
|
* doesn't apply to RDS Custom.</p>
|
|
17
17
|
* @example
|
|
18
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,7 +10,7 @@ export interface ModifyEventSubscriptionCommandOutput extends ModifyEventSubscri
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change
|
|
12
12
|
* source identifiers for a subscription, use the <code>AddSourceIdentifierToSubscription</code> and <code>RemoveSourceIdentifierFromSubscription</code> calls.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>You can see a list of the event categories for a given source type (<code>SourceType</code>)
|
|
14
14
|
* in <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html">Events</a> in the <i>Amazon RDS User Guide</i>
|
|
15
15
|
* or by using the <code>DescribeEventCategories</code> operation.</p>
|
|
16
16
|
* @example
|
|
@@ -12,9 +12,9 @@ export interface ModifyGlobalClusterCommandOutput extends ModifyGlobalClusterRes
|
|
|
12
12
|
* parameters by specifying these parameters and the new values in the request. For more information on
|
|
13
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>.</p>
|
|
15
|
-
*
|
|
15
|
+
* <note>
|
|
16
16
|
* <p>This action only applies to Aurora DB clusters.</p>
|
|
17
|
-
*
|
|
17
|
+
* </note>
|
|
18
18
|
* @example
|
|
19
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
20
20
|
* ```javascript
|
|
@@ -9,10 +9,10 @@ export interface PromoteReadReplicaCommandOutput extends PromoteReadReplicaResul
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Promotes a read replica DB instance to a standalone DB instance.</p>
|
|
12
|
-
*
|
|
12
|
+
* <note>
|
|
13
13
|
* <ul>
|
|
14
14
|
* <li>
|
|
15
|
-
*
|
|
15
|
+
* <p>Backup duration is a function of the amount of changes to the database since the previous
|
|
16
16
|
* backup. If you plan to promote a read replica to a standalone instance, we
|
|
17
17
|
* recommend that you enable backups and complete at least one backup prior to
|
|
18
18
|
* promotion. In addition, a read replica cannot be promoted to a standalone
|
|
@@ -20,12 +20,12 @@ export interface PromoteReadReplicaCommandOutput extends PromoteReadReplicaResul
|
|
|
20
20
|
* enabled backups on your read replica, configure the automated backup window
|
|
21
21
|
* so that daily backups do not interfere with read replica
|
|
22
22
|
* promotion.</p>
|
|
23
|
-
*
|
|
23
|
+
* </li>
|
|
24
24
|
* <li>
|
|
25
|
-
*
|
|
26
|
-
*
|
|
25
|
+
* <p>This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.</p>
|
|
26
|
+
* </li>
|
|
27
27
|
* </ul>
|
|
28
|
-
*
|
|
28
|
+
* </note>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
31
|
* ```javascript
|
|
@@ -12,10 +12,10 @@ export interface RebootDBClusterCommandOutput extends RebootDBClusterResult, __M
|
|
|
12
12
|
* For example, if you make certain modifications,
|
|
13
13
|
* or if you change the DB cluster parameter group associated with the DB cluster,
|
|
14
14
|
* reboot the DB cluster for the changes to take effect.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>Rebooting a DB cluster restarts the database engine service. Rebooting a DB
|
|
16
16
|
* cluster results in a momentary outage, during which the DB cluster status is set to rebooting.</p>
|
|
17
|
-
*
|
|
18
|
-
*
|
|
17
|
+
* <p>Use this operation only for a non-Aurora Multi-AZ DB cluster.</p>
|
|
18
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
19
19
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
20
20
|
* Multi-AZ deployments with two readable standby DB instances</a> in the
|
|
21
21
|
* <i>Amazon RDS User Guide.</i>
|
|
@@ -12,12 +12,12 @@ export interface RebootDBInstanceCommandOutput extends RebootDBInstanceResult, _
|
|
|
12
12
|
* For example, if you make certain modifications,
|
|
13
13
|
* or if you change the DB parameter group associated with the DB instance,
|
|
14
14
|
* you must reboot the instance for the changes to take effect.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>Rebooting a DB instance restarts the database engine service.
|
|
16
16
|
* Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.</p>
|
|
17
|
-
*
|
|
17
|
+
* <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>
|
|
18
18
|
* </p>
|
|
19
|
-
*
|
|
20
|
-
*
|
|
19
|
+
* <p>This command doesn't apply to RDS Custom.</p>
|
|
20
|
+
* <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>
|
|
21
21
|
* @example
|
|
22
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
23
23
|
* ```javascript
|
|
@@ -11,9 +11,9 @@ export interface RemoveFromGlobalClusterCommandOutput extends RemoveFromGlobalCl
|
|
|
11
11
|
* <p>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
13
|
* primary cluster in a different Region.</p>
|
|
14
|
-
*
|
|
14
|
+
* <note>
|
|
15
15
|
* <p>This action only applies to Aurora DB clusters.</p>
|
|
16
|
-
*
|
|
16
|
+
* </note>
|
|
17
17
|
* @example
|
|
18
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
19
19
|
* ```javascript
|
|
@@ -10,10 +10,10 @@ export interface RemoveRoleFromDBClusterCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a
|
|
12
12
|
* DB cluster.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
14
14
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
15
15
|
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
17
17
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
18
18
|
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
19
19
|
* </p>
|
|
@@ -9,7 +9,7 @@ export interface RemoveTagsFromResourceCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Removes metadata tags from an Amazon RDS resource.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>For an overview on tagging an Amazon RDS resource,
|
|
13
13
|
* see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html">Tagging Amazon RDS Resources</a>
|
|
14
14
|
* in the <i>Amazon RDS User Guide.</i>
|
|
15
15
|
* </p>
|
|
@@ -13,14 +13,14 @@ export interface ResetDBClusterParameterGroupCommandOutput extends DBClusterPara
|
|
|
13
13
|
* and <code>ApplyMethod</code>. To reset the
|
|
14
14
|
* entire DB cluster parameter group, specify the <code>DBClusterParameterGroupName</code>
|
|
15
15
|
* and <code>ResetAllParameters</code> parameters.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>When resetting the entire group, dynamic parameters are updated immediately and static parameters
|
|
17
17
|
* are set to <code>pending-reboot</code> to take effect on the next DB instance restart
|
|
18
18
|
* or <code>RebootDBInstance</code> request. You must call <code>RebootDBInstance</code> for every
|
|
19
19
|
* DB instance in your DB cluster that you want the updated static parameter to apply to.</p>
|
|
20
|
-
*
|
|
20
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
21
21
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
22
22
|
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
23
|
-
*
|
|
23
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
24
24
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
25
25
|
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
26
26
|
* </p>
|
|
@@ -12,21 +12,21 @@ export interface RestoreDBClusterFromS3CommandOutput extends RestoreDBClusterFro
|
|
|
12
12
|
* Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be
|
|
13
13
|
* created using the Percona XtraBackup utility as described in <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.ExtMySQL.html#AuroraMySQL.Migrating.ExtMySQL.S3"> Migrating Data from MySQL by Using an Amazon S3 Bucket</a> in the
|
|
14
14
|
* <i>Amazon Aurora User Guide</i>.</p>
|
|
15
|
-
*
|
|
15
|
+
* <note>
|
|
16
16
|
* <p>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>RestoreDBClusterFromS3</code> action has completed and the DB
|
|
21
21
|
* cluster is available.</p>
|
|
22
|
-
*
|
|
23
|
-
*
|
|
22
|
+
* </note>
|
|
23
|
+
* <p>For more information on Amazon Aurora, see
|
|
24
24
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
25
25
|
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
26
|
-
*
|
|
26
|
+
* <note>
|
|
27
27
|
* <p>This action only applies to Aurora DB clusters. The source DB engine must be
|
|
28
28
|
* MySQL.</p>
|
|
29
|
-
*
|
|
29
|
+
* </note>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -9,21 +9,21 @@ export interface RestoreDBClusterFromSnapshotCommandOutput extends RestoreDBClus
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a new DB cluster from a DB snapshot or DB cluster snapshot.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>The target DB cluster is created from the source snapshot with a default
|
|
13
13
|
* configuration. If you don't specify a security group, the new DB cluster is
|
|
14
14
|
* associated with the default security group.</p>
|
|
15
|
-
*
|
|
15
|
+
* <note>
|
|
16
16
|
* <p>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>RestoreDBClusterFromSnapshot</code> action has completed and the DB
|
|
21
21
|
* cluster is available.</p>
|
|
22
|
-
*
|
|
23
|
-
*
|
|
22
|
+
* </note>
|
|
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
25
|
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
26
|
-
*
|
|
26
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
27
27
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
28
28
|
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
29
29
|
* </p>
|
|
@@ -13,18 +13,18 @@ export interface RestoreDBClusterToPointInTimeCommandOutput extends RestoreDBClu
|
|
|
13
13
|
* <code>BackupRetentionPeriod</code> days. The target DB cluster is created from the
|
|
14
14
|
* source DB cluster with the same configuration as the original DB cluster, except that
|
|
15
15
|
* the new DB cluster is created with the default DB security group.</p>
|
|
16
|
-
*
|
|
16
|
+
* <note>
|
|
17
17
|
* <p>For Aurora, this action only restores the DB cluster, not the DB instances for that DB
|
|
18
18
|
* cluster. You must invoke the <code>CreateDBInstance</code> action to create DB
|
|
19
19
|
* instances for the restored DB cluster, specifying the identifier of the restored DB
|
|
20
20
|
* cluster in <code>DBClusterIdentifier</code>. You can create DB instances only after
|
|
21
21
|
* the <code>RestoreDBClusterToPointInTime</code> action has completed and the DB
|
|
22
22
|
* cluster is available.</p>
|
|
23
|
-
*
|
|
24
|
-
*
|
|
23
|
+
* </note>
|
|
24
|
+
* <p>For more information on Amazon Aurora DB clusters, see
|
|
25
25
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
26
26
|
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
27
|
-
*
|
|
27
|
+
* <p>For more information on Multi-AZ DB clusters, see
|
|
28
28
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html">
|
|
29
29
|
* Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i>
|
|
30
30
|
* </p>
|
|
@@ -12,16 +12,16 @@ export interface RestoreDBInstanceFromDBSnapshotCommandOutput extends RestoreDBI
|
|
|
12
12
|
* of the source's original configuration, including the default security group and DB parameter group. By default, the new DB
|
|
13
13
|
* instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group
|
|
14
14
|
* associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance
|
|
16
16
|
* before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you
|
|
17
17
|
* have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as
|
|
18
18
|
* the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original
|
|
19
19
|
* DB instance with the DB instance created from the snapshot.</p>
|
|
20
|
-
*
|
|
20
|
+
* <p>If you are restoring from a shared manual DB snapshot, the <code>DBSnapshotIdentifier</code>
|
|
21
21
|
* must be the ARN of the shared DB snapshot.</p>
|
|
22
|
-
*
|
|
22
|
+
* <note>
|
|
23
23
|
* <p>This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use <code>RestoreDBClusterFromSnapshot</code>.</p>
|
|
24
|
-
*
|
|
24
|
+
* </note>
|
|
25
25
|
* @example
|
|
26
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
27
27
|
* ```javascript
|
|
@@ -16,7 +16,7 @@ export interface RestoreDBInstanceFromS3CommandOutput extends RestoreDBInstanceF
|
|
|
16
16
|
* For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html">Importing Data into an Amazon RDS MySQL DB Instance</a>
|
|
17
17
|
* in the <i>Amazon RDS User Guide.</i>
|
|
18
18
|
* </p>
|
|
19
|
-
*
|
|
19
|
+
* <p>This command doesn't apply to RDS Custom.</p>
|
|
20
20
|
* @example
|
|
21
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
22
22
|
* ```javascript
|
|
@@ -9,15 +9,15 @@ export interface RestoreDBInstanceToPointInTimeCommandOutput extends RestoreDBIn
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>The target database is created with most of the original configuration, but in a
|
|
13
13
|
* system-selected Availability Zone, with the default security group, the default subnet
|
|
14
14
|
* group, and the default DB parameter group. By default, the new DB instance is created as
|
|
15
15
|
* a single-AZ deployment except when the instance is a SQL Server instance that has an
|
|
16
16
|
* option group that is associated with mirroring; in this case, the instance becomes a
|
|
17
17
|
* mirrored deployment and not a single-AZ deployment.</p>
|
|
18
|
-
*
|
|
18
|
+
* <note>
|
|
19
19
|
* <p>This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use <code>RestoreDBClusterToPointInTime</code>.</p>
|
|
20
|
-
*
|
|
20
|
+
* </note>
|
|
21
21
|
* @example
|
|
22
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
23
23
|
* ```javascript
|
|
@@ -11,13 +11,13 @@ export interface RevokeDBSecurityGroupIngressCommandOutput extends RevokeDBSecur
|
|
|
11
11
|
* <p>Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required
|
|
12
12
|
* parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either
|
|
13
13
|
* EC2SecurityGroupName or EC2SecurityGroupId).</p>
|
|
14
|
-
*
|
|
14
|
+
* <note>
|
|
15
15
|
* <p>EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that
|
|
16
16
|
* you migrate as soon as possible. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html">Migrate from EC2-Classic to a VPC</a> in the
|
|
17
17
|
* <i>Amazon EC2 User Guide</i>, the blog <a href="http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/">EC2-Classic Networking is Retiring –
|
|
18
18
|
* Here’s How to Prepare</a>, and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html">Moving a DB instance not in a VPC
|
|
19
19
|
* into a VPC</a> in the <i>Amazon RDS User Guide</i>.</p>
|
|
20
|
-
*
|
|
20
|
+
* </note>
|
|
21
21
|
* @example
|
|
22
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
23
23
|
* ```javascript
|
|
@@ -10,12 +10,12 @@ export interface StartDBClusterCommandOutput extends StartDBClusterResult, __Met
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster
|
|
12
12
|
* CLI command, or the StopDBCluster action.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>For more information, see
|
|
14
14
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html">
|
|
15
15
|
* Stopping and Starting an Aurora Cluster</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
16
|
-
*
|
|
16
|
+
* <note>
|
|
17
17
|
* <p>This action only applies to Aurora DB clusters.</p>
|
|
18
|
-
*
|
|
18
|
+
* </note>
|
|
19
19
|
* @example
|
|
20
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
21
21
|
* ```javascript
|
|
@@ -9,8 +9,8 @@ export interface StartDBInstanceAutomatedBackupsReplicationCommandOutput extends
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Enables replication of automated backups to a different Amazon Web Services Region.</p>
|
|
12
|
-
*
|
|
13
|
-
*
|
|
12
|
+
* <p>This command doesn't apply to RDS Custom.</p>
|
|
13
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html">
|
|
14
14
|
* Replicating Automated Backups to Another Amazon Web Services Region</a> in the <i>Amazon RDS User Guide.</i>
|
|
15
15
|
* </p>
|
|
16
16
|
* @example
|
|
@@ -9,15 +9,15 @@ export interface StartDBInstanceCommandOutput extends StartDBInstanceResult, __M
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>For more information, see
|
|
13
13
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StartInstance.html">
|
|
14
14
|
* Starting an Amazon RDS DB instance That Was Previously Stopped</a> in the
|
|
15
15
|
* <i>Amazon RDS User Guide.</i>
|
|
16
16
|
* </p>
|
|
17
|
-
*
|
|
17
|
+
* <note>
|
|
18
18
|
* <p>This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.
|
|
19
19
|
* For Aurora DB clusters, use <code>StartDBCluster</code> instead.</p>
|
|
20
|
-
*
|
|
20
|
+
* </note>
|
|
21
21
|
* @example
|
|
22
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
23
23
|
* ```javascript
|
|
@@ -11,7 +11,7 @@ export interface StartExportTaskCommandOutput extends ExportTask, __MetadataBear
|
|
|
11
11
|
/**
|
|
12
12
|
* <p>Starts an export of a snapshot to Amazon S3.
|
|
13
13
|
* The provided IAM role must have access to the S3 bucket.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>This command doesn't apply to RDS Custom.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
17
|
* ```javascript
|
|
@@ -10,7 +10,7 @@ export interface StopActivityStreamCommandOutput extends StopActivityStreamRespo
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Stops a database activity stream that was started using the Amazon Web Services console,
|
|
12
12
|
* the <code>start-activity-stream</code> CLI command, or the <code>StartActivityStream</code> action.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>For more information, see
|
|
14
14
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/DBActivityStreams.html">Database Activity Streams</a>
|
|
15
15
|
* in the <i>Amazon Aurora User Guide</i>.</p>
|
|
16
16
|
* @example
|
|
@@ -11,12 +11,12 @@ export interface StopDBClusterCommandOutput extends StopDBClusterResult, __Metad
|
|
|
11
11
|
* <p>Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's
|
|
12
12
|
* metadata, including its endpoints and DB parameter groups. Aurora also
|
|
13
13
|
* retains the transaction logs so you can do a point-in-time restore if necessary.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>For more information, see
|
|
15
15
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html">
|
|
16
16
|
* Stopping and Starting an Aurora Cluster</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
17
|
-
*
|
|
17
|
+
* <note>
|
|
18
18
|
* <p>This action only applies to Aurora DB clusters.</p>
|
|
19
|
-
*
|
|
19
|
+
* </note>
|
|
20
20
|
* @example
|
|
21
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
22
22
|
* ```javascript
|
|
@@ -9,8 +9,8 @@ export interface StopDBInstanceAutomatedBackupsReplicationCommandOutput extends
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Stops automated backup replication for a DB instance.</p>
|
|
12
|
-
*
|
|
13
|
-
*
|
|
12
|
+
* <p>This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.</p>
|
|
13
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html">
|
|
14
14
|
* Replicating Automated Backups to Another Amazon Web Services Region</a> in the <i>Amazon RDS User Guide.</i>
|
|
15
15
|
* </p>
|
|
16
16
|
* @example
|
|
@@ -11,15 +11,15 @@ export interface StopDBInstanceCommandOutput extends StopDBInstanceResult, __Met
|
|
|
11
11
|
* <p>Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint,
|
|
12
12
|
* DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if
|
|
13
13
|
* necessary.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>For more information, see
|
|
15
15
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StopInstance.html">
|
|
16
16
|
* Stopping an Amazon RDS DB Instance Temporarily</a> in the
|
|
17
17
|
* <i>Amazon RDS User Guide.</i>
|
|
18
18
|
* </p>
|
|
19
|
-
*
|
|
19
|
+
* <note>
|
|
20
20
|
* <p>This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.
|
|
21
21
|
* For Aurora clusters, use <code>StopDBCluster</code> instead.</p>
|
|
22
|
-
*
|
|
22
|
+
* </note>
|
|
23
23
|
* @example
|
|
24
24
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
25
|
* ```javascript
|
|
@@ -9,9 +9,9 @@ export interface SwitchoverBlueGreenDeploymentCommandOutput extends SwitchoverBl
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Switches over a blue/green deployment.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Before you switch over, production traffic is routed to the databases in the blue environment.
|
|
13
13
|
* After you switch over, production traffic is routed to the databases in the green environment.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html">Using Amazon RDS Blue/Green Deployments
|
|
15
15
|
* for database updates</a> in the <i>Amazon RDS User Guide</i> and
|
|
16
16
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html">
|
|
17
17
|
* Using Amazon RDS Blue/Green Deployments for database updates</a> in the <i>Amazon Aurora
|