@aws-sdk/client-rds 3.775.0 → 3.777.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/dist-types/commands/AddRoleToDBClusterCommand.d.ts +8 -5
- package/dist-types/commands/AddRoleToDBInstanceCommand.d.ts +9 -6
- package/dist-types/commands/AddSourceIdentifierToSubscriptionCommand.d.ts +16 -16
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +10 -7
- package/dist-types/commands/ApplyPendingMaintenanceActionCommand.d.ts +13 -13
- package/dist-types/commands/AuthorizeDBSecurityGroupIngressCommand.d.ts +6 -6
- package/dist-types/commands/BacktrackDBClusterCommand.d.ts +1 -0
- package/dist-types/commands/CancelExportTaskCommand.d.ts +14 -14
- package/dist-types/commands/CopyDBClusterParameterGroupCommand.d.ts +11 -11
- package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +26 -26
- package/dist-types/commands/CopyDBParameterGroupCommand.d.ts +11 -11
- package/dist-types/commands/CopyDBSnapshotCommand.d.ts +31 -31
- package/dist-types/commands/CopyOptionGroupCommand.d.ts +14 -14
- package/dist-types/commands/CreateBlueGreenDeploymentCommand.d.ts +1 -127
- package/dist-types/commands/CreateCustomDBEngineVersionCommand.d.ts +1 -0
- package/dist-types/commands/CreateDBClusterCommand.d.ts +83 -84
- package/dist-types/commands/CreateDBClusterEndpointCommand.d.ts +17 -17
- package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +11 -11
- package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +25 -25
- package/dist-types/commands/CreateDBInstanceCommand.d.ts +72 -72
- package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts +11 -11
- package/dist-types/commands/CreateDBParameterGroupCommand.d.ts +11 -11
- package/dist-types/commands/CreateDBProxyCommand.d.ts +1 -0
- package/dist-types/commands/CreateDBProxyEndpointCommand.d.ts +1 -0
- package/dist-types/commands/CreateDBSecurityGroupCommand.d.ts +6 -6
- package/dist-types/commands/CreateDBShardGroupCommand.d.ts +1 -0
- package/dist-types/commands/CreateDBSnapshotCommand.d.ts +29 -29
- package/dist-types/commands/CreateDBSubnetGroupCommand.d.ts +25 -25
- package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +17 -17
- package/dist-types/commands/CreateGlobalClusterCommand.d.ts +15 -15
- package/dist-types/commands/CreateIntegrationCommand.d.ts +14 -14
- package/dist-types/commands/CreateOptionGroupCommand.d.ts +15 -15
- package/dist-types/commands/CreateTenantDatabaseCommand.d.ts +1 -0
- package/dist-types/commands/DeleteBlueGreenDeploymentCommand.d.ts +1 -140
- package/dist-types/commands/DeleteCustomDBEngineVersionCommand.d.ts +1 -0
- package/dist-types/commands/DeleteDBClusterAutomatedBackupCommand.d.ts +1 -0
- package/dist-types/commands/DeleteDBClusterCommand.d.ts +14 -14
- package/dist-types/commands/DeleteDBClusterEndpointCommand.d.ts +14 -14
- package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +7 -4
- package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +24 -24
- package/dist-types/commands/DeleteDBInstanceAutomatedBackupCommand.d.ts +26 -26
- package/dist-types/commands/DeleteDBInstanceCommand.d.ts +9 -9
- package/dist-types/commands/DeleteDBParameterGroupCommand.d.ts +7 -4
- package/dist-types/commands/DeleteDBProxyCommand.d.ts +1 -0
- package/dist-types/commands/DeleteDBProxyEndpointCommand.d.ts +1 -0
- package/dist-types/commands/DeleteDBSecurityGroupCommand.d.ts +7 -4
- package/dist-types/commands/DeleteDBShardGroupCommand.d.ts +1 -0
- package/dist-types/commands/DeleteDBSnapshotCommand.d.ts +29 -29
- package/dist-types/commands/DeleteDBSubnetGroupCommand.d.ts +7 -4
- package/dist-types/commands/DeleteEventSubscriptionCommand.d.ts +15 -15
- package/dist-types/commands/DeleteGlobalClusterCommand.d.ts +14 -14
- package/dist-types/commands/DeleteIntegrationCommand.d.ts +12 -12
- package/dist-types/commands/DeleteOptionGroupCommand.d.ts +7 -4
- package/dist-types/commands/DeleteTenantDatabaseCommand.d.ts +1 -0
- package/dist-types/commands/DeregisterDBProxyTargetsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +50 -50
- package/dist-types/commands/DescribeBlueGreenDeploymentsCommand.d.ts +1 -215
- package/dist-types/commands/DescribeCertificatesCommand.d.ts +1 -52
- package/dist-types/commands/DescribeDBClusterAutomatedBackupsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeDBClusterBacktracksCommand.d.ts +17 -17
- package/dist-types/commands/DescribeDBClusterEndpointsCommand.d.ts +28 -29
- package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +25 -25
- package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +24 -24
- package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +9 -9
- package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +43 -43
- package/dist-types/commands/DescribeDBClustersCommand.d.ts +64 -64
- package/dist-types/commands/DescribeDBEngineVersionsCommand.d.ts +21 -21
- package/dist-types/commands/DescribeDBInstanceAutomatedBackupsCommand.d.ts +26 -26
- package/dist-types/commands/DescribeDBInstancesCommand.d.ts +14 -14
- package/dist-types/commands/DescribeDBLogFilesCommand.d.ts +23 -23
- package/dist-types/commands/DescribeDBParameterGroupsCommand.d.ts +21 -21
- package/dist-types/commands/DescribeDBParametersCommand.d.ts +21 -21
- package/dist-types/commands/DescribeDBProxiesCommand.d.ts +1 -0
- package/dist-types/commands/DescribeDBProxyEndpointsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeDBProxyTargetGroupsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeDBProxyTargetsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeDBRecommendationsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeDBSecurityGroupsCommand.d.ts +7 -4
- package/dist-types/commands/DescribeDBShardGroupsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeDBSnapshotAttributesCommand.d.ts +9 -9
- package/dist-types/commands/DescribeDBSnapshotTenantDatabasesCommand.d.ts +1 -0
- package/dist-types/commands/DescribeDBSnapshotsCommand.d.ts +27 -27
- package/dist-types/commands/DescribeDBSubnetGroupsCommand.d.ts +27 -27
- package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +13 -13
- package/dist-types/commands/DescribeEngineDefaultParametersCommand.d.ts +13 -13
- package/dist-types/commands/DescribeEventCategoriesCommand.d.ts +18 -18
- package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +14 -14
- package/dist-types/commands/DescribeEventsCommand.d.ts +18 -18
- package/dist-types/commands/DescribeExportTasksCommand.d.ts +27 -27
- package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +14 -14
- package/dist-types/commands/DescribeIntegrationsCommand.d.ts +13 -13
- package/dist-types/commands/DescribeOptionGroupOptionsCommand.d.ts +31 -31
- package/dist-types/commands/DescribeOptionGroupsCommand.d.ts +13 -13
- package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +21 -21
- package/dist-types/commands/DescribePendingMaintenanceActionsCommand.d.ts +9 -9
- package/dist-types/commands/DescribeReservedDBInstancesCommand.d.ts +23 -23
- package/dist-types/commands/DescribeReservedDBInstancesOfferingsCommand.d.ts +17 -17
- package/dist-types/commands/DescribeSourceRegionsCommand.d.ts +89 -89
- package/dist-types/commands/DescribeTenantDatabasesCommand.d.ts +1 -0
- package/dist-types/commands/DescribeValidDBInstanceModificationsCommand.d.ts +14 -14
- package/dist-types/commands/DisableHttpEndpointCommand.d.ts +1 -0
- package/dist-types/commands/DownloadDBLogFilePortionCommand.d.ts +8 -5
- package/dist-types/commands/EnableHttpEndpointCommand.d.ts +1 -0
- package/dist-types/commands/FailoverDBClusterCommand.d.ts +6 -6
- package/dist-types/commands/FailoverGlobalClusterCommand.d.ts +1 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +9 -9
- package/dist-types/commands/ModifyActivityStreamCommand.d.ts +1 -0
- package/dist-types/commands/ModifyCertificatesCommand.d.ts +13 -13
- package/dist-types/commands/ModifyCurrentDBClusterCapacityCommand.d.ts +10 -10
- package/dist-types/commands/ModifyCustomDBEngineVersionCommand.d.ts +1 -0
- package/dist-types/commands/ModifyDBClusterCommand.d.ts +50 -50
- package/dist-types/commands/ModifyDBClusterEndpointCommand.d.ts +15 -15
- package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +12 -12
- package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +11 -11
- package/dist-types/commands/ModifyDBInstanceCommand.d.ts +31 -31
- package/dist-types/commands/ModifyDBParameterGroupCommand.d.ts +9 -9
- package/dist-types/commands/ModifyDBProxyCommand.d.ts +1 -0
- package/dist-types/commands/ModifyDBProxyEndpointCommand.d.ts +1 -0
- package/dist-types/commands/ModifyDBProxyTargetGroupCommand.d.ts +1 -0
- package/dist-types/commands/ModifyDBRecommendationCommand.d.ts +1 -0
- package/dist-types/commands/ModifyDBShardGroupCommand.d.ts +1 -0
- package/dist-types/commands/ModifyDBSnapshotAttributeCommand.d.ts +20 -21
- package/dist-types/commands/ModifyDBSnapshotCommand.d.ts +28 -28
- package/dist-types/commands/ModifyDBSubnetGroupCommand.d.ts +29 -29
- package/dist-types/commands/ModifyEventSubscriptionCommand.d.ts +15 -15
- package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +15 -15
- package/dist-types/commands/ModifyIntegrationCommand.d.ts +14 -14
- package/dist-types/commands/ModifyOptionGroupCommand.d.ts +9 -9
- package/dist-types/commands/ModifyTenantDatabaseCommand.d.ts +1 -0
- package/dist-types/commands/PromoteReadReplicaCommand.d.ts +9 -9
- package/dist-types/commands/PromoteReadReplicaDBClusterCommand.d.ts +1 -0
- package/dist-types/commands/PurchaseReservedDBInstancesOfferingCommand.d.ts +23 -23
- package/dist-types/commands/RebootDBClusterCommand.d.ts +1 -0
- package/dist-types/commands/RebootDBInstanceCommand.d.ts +14 -14
- package/dist-types/commands/RebootDBShardGroupCommand.d.ts +1 -0
- package/dist-types/commands/RegisterDBProxyTargetsCommand.d.ts +1 -0
- package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +22 -22
- package/dist-types/commands/RemoveRoleFromDBClusterCommand.d.ts +8 -5
- package/dist-types/commands/RemoveRoleFromDBInstanceCommand.d.ts +1 -0
- package/dist-types/commands/RemoveSourceIdentifierFromSubscriptionCommand.d.ts +16 -16
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +8 -5
- package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +6 -6
- package/dist-types/commands/ResetDBParameterGroupCommand.d.ts +6 -6
- package/dist-types/commands/RestoreDBClusterFromS3Command.d.ts +47 -47
- package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +44 -44
- package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +48 -45
- package/dist-types/commands/RestoreDBInstanceFromDBSnapshotCommand.d.ts +23 -23
- package/dist-types/commands/RestoreDBInstanceFromS3Command.d.ts +1 -0
- package/dist-types/commands/RestoreDBInstanceToPointInTimeCommand.d.ts +62 -62
- package/dist-types/commands/RevokeDBSecurityGroupIngressCommand.d.ts +6 -6
- package/dist-types/commands/StartActivityStreamCommand.d.ts +12 -12
- package/dist-types/commands/StartDBClusterCommand.d.ts +10 -10
- package/dist-types/commands/StartDBInstanceAutomatedBackupsReplicationCommand.d.ts +25 -25
- package/dist-types/commands/StartDBInstanceCommand.d.ts +6 -6
- package/dist-types/commands/StartExportTaskCommand.d.ts +17 -17
- package/dist-types/commands/StopActivityStreamCommand.d.ts +8 -8
- package/dist-types/commands/StopDBClusterCommand.d.ts +10 -10
- package/dist-types/commands/StopDBInstanceAutomatedBackupsReplicationCommand.d.ts +26 -26
- package/dist-types/commands/StopDBInstanceCommand.d.ts +6 -6
- package/dist-types/commands/SwitchoverBlueGreenDeploymentCommand.d.ts +1 -138
- package/dist-types/commands/SwitchoverGlobalClusterCommand.d.ts +1 -0
- package/dist-types/commands/SwitchoverReadReplicaCommand.d.ts +1 -0
- package/package.json +2 -2
|
@@ -76,40 +76,40 @@ declare const RemoveSourceIdentifierFromSubscriptionCommand_base: {
|
|
|
76
76
|
* @throws {@link RDSServiceException}
|
|
77
77
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
78
78
|
*
|
|
79
|
-
*
|
|
79
|
+
*
|
|
80
80
|
* @example To remove a source identifier from a subscription
|
|
81
81
|
* ```javascript
|
|
82
82
|
* // The following example removes the specified source identifier from an existing subscription.
|
|
83
83
|
* const input = {
|
|
84
|
-
*
|
|
85
|
-
*
|
|
84
|
+
* SourceIdentifier: "test-instance-repl",
|
|
85
|
+
* SubscriptionName: "my-instance-events"
|
|
86
86
|
* };
|
|
87
87
|
* const command = new RemoveSourceIdentifierFromSubscriptionCommand(input);
|
|
88
88
|
* const response = await client.send(command);
|
|
89
|
-
* /* response
|
|
89
|
+
* /* response is
|
|
90
90
|
* {
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
*
|
|
95
|
-
*
|
|
91
|
+
* EventSubscription: {
|
|
92
|
+
* CustSubscriptionId: "my-instance-events",
|
|
93
|
+
* CustomerAwsId: "123456789012",
|
|
94
|
+
* Enabled: false,
|
|
95
|
+
* EventCategoriesList: [
|
|
96
96
|
* "backup",
|
|
97
97
|
* "recovery"
|
|
98
98
|
* ],
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
99
|
+
* EventSubscriptionArn: "arn:aws:rds:us-east-1:123456789012:es:my-instance-events",
|
|
100
|
+
* SnsTopicArn: "arn:aws:sns:us-east-1:123456789012:interesting-events",
|
|
101
|
+
* SourceIdsList: [
|
|
102
102
|
* "test-instance"
|
|
103
103
|
* ],
|
|
104
|
-
*
|
|
105
|
-
*
|
|
106
|
-
*
|
|
104
|
+
* SourceType: "db-instance",
|
|
105
|
+
* Status: "modifying",
|
|
106
|
+
* SubscriptionCreationTime: "Tue Jul 31 23:22:01 UTC 2018"
|
|
107
107
|
* }
|
|
108
108
|
* }
|
|
109
109
|
* *\/
|
|
110
|
-
* // example id: to-remove-a-source-identifier-from-a-subscription-1680072062459
|
|
111
110
|
* ```
|
|
112
111
|
*
|
|
112
|
+
* @public
|
|
113
113
|
*/
|
|
114
114
|
export declare class RemoveSourceIdentifierFromSubscriptionCommand extends RemoveSourceIdentifierFromSubscriptionCommand_base {
|
|
115
115
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -89,22 +89,25 @@ declare const RemoveTagsFromResourceCommand_base: {
|
|
|
89
89
|
* @throws {@link RDSServiceException}
|
|
90
90
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
91
91
|
*
|
|
92
|
-
*
|
|
92
|
+
*
|
|
93
93
|
* @example To remove tags from a resource
|
|
94
94
|
* ```javascript
|
|
95
95
|
* // The following example removes tags from a resource.
|
|
96
96
|
* const input = {
|
|
97
|
-
*
|
|
98
|
-
*
|
|
97
|
+
* ResourceName: "arn:aws:rds:us-east-1:123456789012:db:mydbinstance",
|
|
98
|
+
* TagKeys: [
|
|
99
99
|
* "Name",
|
|
100
100
|
* "Environment"
|
|
101
101
|
* ]
|
|
102
102
|
* };
|
|
103
103
|
* const command = new RemoveTagsFromResourceCommand(input);
|
|
104
|
-
* await client.send(command);
|
|
105
|
-
*
|
|
104
|
+
* const response = await client.send(command);
|
|
105
|
+
* /* response is
|
|
106
|
+
* { /* metadata only *\/ }
|
|
107
|
+
* *\/
|
|
106
108
|
* ```
|
|
107
109
|
*
|
|
110
|
+
* @public
|
|
108
111
|
*/
|
|
109
112
|
export declare class RemoveTagsFromResourceCommand extends RemoveTagsFromResourceCommand_base {
|
|
110
113
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -97,24 +97,24 @@ declare const ResetDBClusterParameterGroupCommand_base: {
|
|
|
97
97
|
* @throws {@link RDSServiceException}
|
|
98
98
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
99
99
|
*
|
|
100
|
-
*
|
|
100
|
+
*
|
|
101
101
|
* @example To reset all parameters to their default values
|
|
102
102
|
* ```javascript
|
|
103
103
|
* // The following example resets all parameter values in a customer-created DB cluster parameter group to their default values.
|
|
104
104
|
* const input = {
|
|
105
|
-
*
|
|
106
|
-
*
|
|
105
|
+
* DBClusterParameterGroupName: "mydbclpg",
|
|
106
|
+
* ResetAllParameters: true
|
|
107
107
|
* };
|
|
108
108
|
* const command = new ResetDBClusterParameterGroupCommand(input);
|
|
109
109
|
* const response = await client.send(command);
|
|
110
|
-
* /* response
|
|
110
|
+
* /* response is
|
|
111
111
|
* {
|
|
112
|
-
*
|
|
112
|
+
* DBClusterParameterGroupName: "mydbclpg"
|
|
113
113
|
* }
|
|
114
114
|
* *\/
|
|
115
|
-
* // example id: to-reset-all-parameters-to-their-default-values-1680070254216
|
|
116
115
|
* ```
|
|
117
116
|
*
|
|
117
|
+
* @public
|
|
118
118
|
*/
|
|
119
119
|
export declare class ResetDBClusterParameterGroupCommand extends ResetDBClusterParameterGroupCommand_base {
|
|
120
120
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -89,24 +89,24 @@ declare const ResetDBParameterGroupCommand_base: {
|
|
|
89
89
|
* @throws {@link RDSServiceException}
|
|
90
90
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
91
91
|
*
|
|
92
|
-
*
|
|
92
|
+
*
|
|
93
93
|
* @example To reset all parameters to their default values
|
|
94
94
|
* ```javascript
|
|
95
95
|
* // The following example resets all parameter values in a customer-created DB parameter group to their default values.
|
|
96
96
|
* const input = {
|
|
97
|
-
*
|
|
98
|
-
*
|
|
97
|
+
* DBParameterGroupName: "mypg",
|
|
98
|
+
* ResetAllParameters: true
|
|
99
99
|
* };
|
|
100
100
|
* const command = new ResetDBParameterGroupCommand(input);
|
|
101
101
|
* const response = await client.send(command);
|
|
102
|
-
* /* response
|
|
102
|
+
* /* response is
|
|
103
103
|
* {
|
|
104
|
-
*
|
|
104
|
+
* DBParameterGroupName: "mypg"
|
|
105
105
|
* }
|
|
106
106
|
* *\/
|
|
107
|
-
* // example id: to-reset-all-parameters-to-their-default-values-1680069721142
|
|
108
107
|
* ```
|
|
109
108
|
*
|
|
109
|
+
* @public
|
|
110
110
|
*/
|
|
111
111
|
export declare class ResetDBParameterGroupCommand extends ResetDBParameterGroupCommand_base {
|
|
112
112
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -367,73 +367,73 @@ declare const RestoreDBClusterFromS3Command_base: {
|
|
|
367
367
|
* @throws {@link RDSServiceException}
|
|
368
368
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
369
369
|
*
|
|
370
|
-
*
|
|
370
|
+
*
|
|
371
371
|
* @example To restore an Amazon Aurora DB cluster from Amazon S3
|
|
372
372
|
* ```javascript
|
|
373
373
|
* // The following example restores an Amazon Aurora MySQL version 5.7-compatible DB cluster from a MySQL 5.7 DB backup file in Amazon S3.
|
|
374
374
|
* const input = {
|
|
375
|
-
*
|
|
376
|
-
*
|
|
377
|
-
*
|
|
378
|
-
*
|
|
379
|
-
*
|
|
380
|
-
*
|
|
381
|
-
*
|
|
382
|
-
*
|
|
383
|
-
*
|
|
375
|
+
* DBClusterIdentifier: "cluster-s3-restore",
|
|
376
|
+
* Engine: "aurora-mysql",
|
|
377
|
+
* MasterUserPassword: "mypassword",
|
|
378
|
+
* MasterUsername: "admin",
|
|
379
|
+
* S3BucketName: "mybucket",
|
|
380
|
+
* S3IngestionRoleArn: "arn:aws:iam::123456789012:role/service-role/TestBackup",
|
|
381
|
+
* S3Prefix: "test-backup",
|
|
382
|
+
* SourceEngine: "mysql",
|
|
383
|
+
* SourceEngineVersion: "5.7.28"
|
|
384
384
|
* };
|
|
385
385
|
* const command = new RestoreDBClusterFromS3Command(input);
|
|
386
386
|
* const response = await client.send(command);
|
|
387
|
-
* /* response
|
|
387
|
+
* /* response is
|
|
388
388
|
* {
|
|
389
|
-
*
|
|
390
|
-
*
|
|
391
|
-
*
|
|
392
|
-
*
|
|
389
|
+
* DBCluster: {
|
|
390
|
+
* AllocatedStorage: 1,
|
|
391
|
+
* AssociatedRoles: [],
|
|
392
|
+
* AvailabilityZones: [
|
|
393
393
|
* "us-west-2c",
|
|
394
394
|
* "us-west-2a",
|
|
395
395
|
* "us-west-2b"
|
|
396
396
|
* ],
|
|
397
|
-
*
|
|
398
|
-
*
|
|
399
|
-
*
|
|
400
|
-
*
|
|
401
|
-
*
|
|
402
|
-
*
|
|
403
|
-
*
|
|
404
|
-
*
|
|
405
|
-
*
|
|
406
|
-
*
|
|
407
|
-
*
|
|
408
|
-
*
|
|
409
|
-
*
|
|
410
|
-
*
|
|
411
|
-
*
|
|
412
|
-
*
|
|
413
|
-
*
|
|
414
|
-
*
|
|
415
|
-
*
|
|
416
|
-
*
|
|
417
|
-
*
|
|
418
|
-
*
|
|
419
|
-
*
|
|
420
|
-
*
|
|
421
|
-
*
|
|
422
|
-
*
|
|
423
|
-
*
|
|
424
|
-
*
|
|
425
|
-
*
|
|
397
|
+
* BackupRetentionPeriod: 1,
|
|
398
|
+
* ClusterCreateTime: "2020-07-27T14:22:08.095Z",
|
|
399
|
+
* CopyTagsToSnapshot: false,
|
|
400
|
+
* CrossAccountClone: false,
|
|
401
|
+
* DBClusterArn: "arn:aws:rds:us-west-2:123456789012:cluster:cluster-s3-restore",
|
|
402
|
+
* DBClusterIdentifier: "cluster-s3-restore",
|
|
403
|
+
* DBClusterMembers: [],
|
|
404
|
+
* DBClusterParameterGroup: "default.aurora-mysql5.7",
|
|
405
|
+
* DBSubnetGroup: "default",
|
|
406
|
+
* DbClusterResourceId: "cluster-SU5THYQQHOWCXZZDGXREXAMPLE",
|
|
407
|
+
* DeletionProtection: false,
|
|
408
|
+
* DomainMemberships: [],
|
|
409
|
+
* Endpoint: "cluster-s3-restore.cluster-co3xyzabc123.us-west-2.rds.amazonaws.com",
|
|
410
|
+
* Engine: "aurora-mysql",
|
|
411
|
+
* EngineMode: "provisioned",
|
|
412
|
+
* EngineVersion: "5.7.12",
|
|
413
|
+
* HostedZoneId: "Z1PVIF0EXAMPLE",
|
|
414
|
+
* HttpEndpointEnabled: false,
|
|
415
|
+
* IAMDatabaseAuthenticationEnabled: false,
|
|
416
|
+
* MasterUsername: "admin",
|
|
417
|
+
* MultiAZ: false,
|
|
418
|
+
* Port: 3306,
|
|
419
|
+
* PreferredBackupWindow: "11:15-11:45",
|
|
420
|
+
* PreferredMaintenanceWindow: "thu:12:19-thu:12:49",
|
|
421
|
+
* ReadReplicaIdentifiers: [],
|
|
422
|
+
* ReaderEndpoint: "cluster-s3-restore.cluster-ro-co3xyzabc123.us-west-2.rds.amazonaws.com",
|
|
423
|
+
* Status: "creating",
|
|
424
|
+
* StorageEncrypted: false,
|
|
425
|
+
* VpcSecurityGroups: [
|
|
426
426
|
* {
|
|
427
|
-
*
|
|
428
|
-
*
|
|
427
|
+
* Status: "active",
|
|
428
|
+
* VpcSecurityGroupId: "sg-########"
|
|
429
429
|
* }
|
|
430
430
|
* ]
|
|
431
431
|
* }
|
|
432
432
|
* }
|
|
433
433
|
* *\/
|
|
434
|
-
* // example id: to-restore-an-amazon-aurora-db-cluster-from-amazon-s3-1680069516445
|
|
435
434
|
* ```
|
|
436
435
|
*
|
|
436
|
+
* @public
|
|
437
437
|
*/
|
|
438
438
|
export declare class RestoreDBClusterFromS3Command extends RestoreDBClusterFromS3Command_base {
|
|
439
439
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -393,70 +393,70 @@ declare const RestoreDBClusterFromSnapshotCommand_base: {
|
|
|
393
393
|
* @throws {@link RDSServiceException}
|
|
394
394
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
395
395
|
*
|
|
396
|
-
*
|
|
396
|
+
*
|
|
397
397
|
* @example To restore a DB cluster from a snapshot
|
|
398
398
|
* ```javascript
|
|
399
399
|
* // The following example restores an Aurora PostgreSQL DB cluster compatible with PostgreSQL version 10.7 from a DB cluster snapshot named test-instance-snapshot.
|
|
400
400
|
* const input = {
|
|
401
|
-
*
|
|
402
|
-
*
|
|
403
|
-
*
|
|
404
|
-
*
|
|
401
|
+
* DBClusterIdentifier: "newdbcluster",
|
|
402
|
+
* Engine: "aurora-postgresql",
|
|
403
|
+
* EngineVersion: "10.7",
|
|
404
|
+
* SnapshotIdentifier: "test-instance-snapshot"
|
|
405
405
|
* };
|
|
406
406
|
* const command = new RestoreDBClusterFromSnapshotCommand(input);
|
|
407
407
|
* const response = await client.send(command);
|
|
408
|
-
* /* response
|
|
408
|
+
* /* response is
|
|
409
409
|
* {
|
|
410
|
-
*
|
|
411
|
-
*
|
|
412
|
-
*
|
|
413
|
-
*
|
|
410
|
+
* DBCluster: {
|
|
411
|
+
* AllocatedStorage: 1,
|
|
412
|
+
* AssociatedRoles: [],
|
|
413
|
+
* AvailabilityZones: [
|
|
414
414
|
* "us-west-2c",
|
|
415
415
|
* "us-west-2a",
|
|
416
416
|
* "us-west-2b"
|
|
417
417
|
* ],
|
|
418
|
-
*
|
|
419
|
-
*
|
|
420
|
-
*
|
|
421
|
-
*
|
|
422
|
-
*
|
|
423
|
-
*
|
|
424
|
-
*
|
|
425
|
-
*
|
|
426
|
-
*
|
|
427
|
-
*
|
|
428
|
-
*
|
|
429
|
-
*
|
|
430
|
-
*
|
|
431
|
-
*
|
|
432
|
-
*
|
|
433
|
-
*
|
|
434
|
-
*
|
|
435
|
-
*
|
|
436
|
-
*
|
|
437
|
-
*
|
|
438
|
-
*
|
|
439
|
-
*
|
|
440
|
-
*
|
|
441
|
-
*
|
|
442
|
-
*
|
|
443
|
-
*
|
|
444
|
-
*
|
|
445
|
-
*
|
|
446
|
-
*
|
|
447
|
-
*
|
|
448
|
-
*
|
|
418
|
+
* BackupRetentionPeriod: 7,
|
|
419
|
+
* ClusterCreateTime: "2020-06-05T15:06:58.634Z",
|
|
420
|
+
* CopyTagsToSnapshot: false,
|
|
421
|
+
* CrossAccountClone: false,
|
|
422
|
+
* DBClusterArn: "arn:aws:rds:us-west-2:123456789012:cluster:newdbcluster",
|
|
423
|
+
* DBClusterIdentifier: "newdbcluster",
|
|
424
|
+
* DBClusterMembers: [],
|
|
425
|
+
* DBClusterParameterGroup: "default.aurora-postgresql10",
|
|
426
|
+
* DBSubnetGroup: "default",
|
|
427
|
+
* DatabaseName: "",
|
|
428
|
+
* DbClusterResourceId: "cluster-5DSB5IFQDDUVAWOUWM1EXAMPLE",
|
|
429
|
+
* DeletionProtection: false,
|
|
430
|
+
* DomainMemberships: [],
|
|
431
|
+
* Endpoint: "newdbcluster.cluster-############.us-west-2.rds.amazonaws.com",
|
|
432
|
+
* Engine: "aurora-postgresql",
|
|
433
|
+
* EngineMode: "provisioned",
|
|
434
|
+
* EngineVersion: "10.7",
|
|
435
|
+
* HostedZoneId: "Z1PVIF0EXAMPLE",
|
|
436
|
+
* HttpEndpointEnabled: false,
|
|
437
|
+
* IAMDatabaseAuthenticationEnabled: false,
|
|
438
|
+
* KmsKeyId: "arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6",
|
|
439
|
+
* MasterUsername: "postgres",
|
|
440
|
+
* MultiAZ: false,
|
|
441
|
+
* Port: 5432,
|
|
442
|
+
* PreferredBackupWindow: "09:33-10:03",
|
|
443
|
+
* PreferredMaintenanceWindow: "sun:12:22-sun:12:52",
|
|
444
|
+
* ReadReplicaIdentifiers: [],
|
|
445
|
+
* ReaderEndpoint: "newdbcluster.cluster-ro-############.us-west-2.rds.amazonaws.com",
|
|
446
|
+
* Status: "creating",
|
|
447
|
+
* StorageEncrypted: true,
|
|
448
|
+
* VpcSecurityGroups: [
|
|
449
449
|
* {
|
|
450
|
-
*
|
|
451
|
-
*
|
|
450
|
+
* Status: "active",
|
|
451
|
+
* VpcSecurityGroupId: "sg-########"
|
|
452
452
|
* }
|
|
453
453
|
* ]
|
|
454
454
|
* }
|
|
455
455
|
* }
|
|
456
456
|
* *\/
|
|
457
|
-
* // example id: to-restore-a-db-cluster-from-a-snapshot-1680069287853
|
|
458
457
|
* ```
|
|
459
458
|
*
|
|
459
|
+
* @public
|
|
460
460
|
*/
|
|
461
461
|
export declare class RestoreDBClusterFromSnapshotCommand extends RestoreDBClusterFromSnapshotCommand_base {
|
|
462
462
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -31,7 +31,10 @@ declare const RestoreDBClusterToPointInTimeCommand_base: {
|
|
|
31
31
|
* in time before <code>LatestRestorableTime</code> for up to
|
|
32
32
|
* <code>BackupRetentionPeriod</code> days. The target DB cluster is created from the
|
|
33
33
|
* source DB cluster with the same configuration as the original DB cluster, except that
|
|
34
|
-
* the new DB cluster is created with the default DB security group
|
|
34
|
+
* the new DB cluster is created with the default DB security group. Unless the
|
|
35
|
+
* <code>RestoreType</code> is set to <code>copy-on-write</code>, the restore may occur in a
|
|
36
|
+
* different Availability Zone (AZ) from the original DB cluster. The AZ where RDS restores
|
|
37
|
+
* the DB cluster depends on the AZs in the specified subnet group.</p>
|
|
35
38
|
* <note>
|
|
36
39
|
* <p>For Aurora, this operation only restores the DB cluster, not the DB instances for that DB
|
|
37
40
|
* cluster. You must invoke the <code>CreateDBInstance</code> operation to create DB
|
|
@@ -392,70 +395,70 @@ declare const RestoreDBClusterToPointInTimeCommand_base: {
|
|
|
392
395
|
* @throws {@link RDSServiceException}
|
|
393
396
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
394
397
|
*
|
|
395
|
-
*
|
|
398
|
+
*
|
|
396
399
|
* @example To restore a DB cluster to a specified time
|
|
397
400
|
* ```javascript
|
|
398
401
|
* // The following example restores the DB cluster named database-4 to the latest possible time. Using copy-on-write as the restore type restores the new DB cluster as a clone of the source DB cluster.
|
|
399
402
|
* const input = {
|
|
400
|
-
*
|
|
401
|
-
*
|
|
402
|
-
*
|
|
403
|
-
*
|
|
403
|
+
* DBClusterIdentifier: "sample-cluster-clone",
|
|
404
|
+
* RestoreType: "copy-on-write",
|
|
405
|
+
* SourceDBClusterIdentifier: "database-4",
|
|
406
|
+
* UseLatestRestorableTime: true
|
|
404
407
|
* };
|
|
405
408
|
* const command = new RestoreDBClusterToPointInTimeCommand(input);
|
|
406
409
|
* const response = await client.send(command);
|
|
407
|
-
* /* response
|
|
410
|
+
* /* response is
|
|
408
411
|
* {
|
|
409
|
-
*
|
|
410
|
-
*
|
|
411
|
-
*
|
|
412
|
-
*
|
|
412
|
+
* DBCluster: {
|
|
413
|
+
* AllocatedStorage: 1,
|
|
414
|
+
* AssociatedRoles: [],
|
|
415
|
+
* AvailabilityZones: [
|
|
413
416
|
* "us-west-2c",
|
|
414
417
|
* "us-west-2a",
|
|
415
418
|
* "us-west-2b"
|
|
416
419
|
* ],
|
|
417
|
-
*
|
|
418
|
-
*
|
|
419
|
-
*
|
|
420
|
-
*
|
|
421
|
-
*
|
|
422
|
-
*
|
|
423
|
-
*
|
|
424
|
-
*
|
|
425
|
-
*
|
|
426
|
-
*
|
|
427
|
-
*
|
|
428
|
-
*
|
|
429
|
-
*
|
|
430
|
-
*
|
|
431
|
-
*
|
|
432
|
-
*
|
|
433
|
-
*
|
|
434
|
-
*
|
|
435
|
-
*
|
|
436
|
-
*
|
|
437
|
-
*
|
|
438
|
-
*
|
|
439
|
-
*
|
|
440
|
-
*
|
|
441
|
-
*
|
|
442
|
-
*
|
|
443
|
-
*
|
|
444
|
-
*
|
|
445
|
-
*
|
|
446
|
-
*
|
|
447
|
-
*
|
|
420
|
+
* BackupRetentionPeriod: 7,
|
|
421
|
+
* CloneGroupId: "8d19331a-099a-45a4-b4aa-11aa22bb33cc44dd",
|
|
422
|
+
* ClusterCreateTime: "2020-03-10T19:57:38.967Z",
|
|
423
|
+
* CopyTagsToSnapshot: false,
|
|
424
|
+
* CrossAccountClone: false,
|
|
425
|
+
* DBClusterArn: "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-clone",
|
|
426
|
+
* DBClusterIdentifier: "sample-cluster-clone",
|
|
427
|
+
* DBClusterMembers: [],
|
|
428
|
+
* DBClusterParameterGroup: "default.aurora-postgresql10",
|
|
429
|
+
* DBSubnetGroup: "default",
|
|
430
|
+
* DatabaseName: "",
|
|
431
|
+
* DbClusterResourceId: "cluster-BIZ77GDSA2XBSTNPFW1EXAMPLE",
|
|
432
|
+
* DeletionProtection: false,
|
|
433
|
+
* Endpoint: "sample-cluster-clone.cluster-############.us-west-2.rds.amazonaws.com",
|
|
434
|
+
* Engine: "aurora-postgresql",
|
|
435
|
+
* EngineMode: "provisioned",
|
|
436
|
+
* EngineVersion: "10.7",
|
|
437
|
+
* HostedZoneId: "Z1PVIF0EXAMPLE",
|
|
438
|
+
* HttpEndpointEnabled: false,
|
|
439
|
+
* IAMDatabaseAuthenticationEnabled: false,
|
|
440
|
+
* KmsKeyId: "arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6",
|
|
441
|
+
* MasterUsername: "postgres",
|
|
442
|
+
* MultiAZ: false,
|
|
443
|
+
* Port: 5432,
|
|
444
|
+
* PreferredBackupWindow: "09:33-10:03",
|
|
445
|
+
* PreferredMaintenanceWindow: "sun:12:22-sun:12:52",
|
|
446
|
+
* ReadReplicaIdentifiers: [],
|
|
447
|
+
* ReaderEndpoint: "sample-cluster-clone.cluster-ro-############.us-west-2.rds.amazonaws.com",
|
|
448
|
+
* Status: "creating",
|
|
449
|
+
* StorageEncrypted: true,
|
|
450
|
+
* VpcSecurityGroups: [
|
|
448
451
|
* {
|
|
449
|
-
*
|
|
450
|
-
*
|
|
452
|
+
* Status: "active",
|
|
453
|
+
* VpcSecurityGroupId: "sg-########"
|
|
451
454
|
* }
|
|
452
455
|
* ]
|
|
453
456
|
* }
|
|
454
457
|
* }
|
|
455
458
|
* *\/
|
|
456
|
-
* // example id: to-restore-a-db-cluster-to-a-specified-time-1680069105508
|
|
457
459
|
* ```
|
|
458
460
|
*
|
|
461
|
+
* @public
|
|
459
462
|
*/
|
|
460
463
|
export declare class RestoreDBClusterToPointInTimeCommand extends RestoreDBClusterToPointInTimeCommand_base {
|
|
461
464
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -439,42 +439,42 @@ declare const RestoreDBInstanceFromDBSnapshotCommand_base: {
|
|
|
439
439
|
* @throws {@link RDSServiceException}
|
|
440
440
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
441
441
|
*
|
|
442
|
-
*
|
|
442
|
+
*
|
|
443
443
|
* @example To restore a DB instance from a DB snapshot
|
|
444
444
|
* ```javascript
|
|
445
445
|
* // The following example creates a new DB instance named db7-new-instance with the db.t3.small DB instance class from the specified DB snapshot. The source DB instance from which the snapshot was taken uses a deprecated DB instance class, so you can't upgrade it.
|
|
446
446
|
* const input = {
|
|
447
|
-
*
|
|
448
|
-
*
|
|
449
|
-
*
|
|
447
|
+
* DBInstanceClass: "db.t3.small",
|
|
448
|
+
* DBInstanceIdentifier: "db7-new-instance",
|
|
449
|
+
* DBSnapshotIdentifier: "db7-test-snapshot"
|
|
450
450
|
* };
|
|
451
451
|
* const command = new RestoreDBInstanceFromDBSnapshotCommand(input);
|
|
452
452
|
* const response = await client.send(command);
|
|
453
|
-
* /* response
|
|
453
|
+
* /* response is
|
|
454
454
|
* {
|
|
455
|
-
*
|
|
456
|
-
*
|
|
457
|
-
*
|
|
458
|
-
*
|
|
459
|
-
*
|
|
460
|
-
*
|
|
461
|
-
*
|
|
462
|
-
*
|
|
463
|
-
*
|
|
464
|
-
*
|
|
465
|
-
*
|
|
466
|
-
*
|
|
467
|
-
*
|
|
468
|
-
*
|
|
469
|
-
*
|
|
470
|
-
*
|
|
471
|
-
*
|
|
455
|
+
* DBInstance: {
|
|
456
|
+
* AssociatedRoles: [],
|
|
457
|
+
* AutoMinorVersionUpgrade: true,
|
|
458
|
+
* DBInstanceArn: "arn:aws:rds:us-west-2:123456789012:db:db7-new-instance",
|
|
459
|
+
* DBInstanceClass: "db.t3.small",
|
|
460
|
+
* DBInstanceIdentifier: "db7-new-instance",
|
|
461
|
+
* DBInstanceStatus: "creating",
|
|
462
|
+
* DeletionProtection: false,
|
|
463
|
+
* Engine: "mysql",
|
|
464
|
+
* EngineVersion: "5.7.22",
|
|
465
|
+
* IAMDatabaseAuthenticationEnabled: false,
|
|
466
|
+
* LicenseModel: "general-public-license",
|
|
467
|
+
* MultiAZ: false,
|
|
468
|
+
* PendingModifiedValues: { /* empty *\/ },
|
|
469
|
+
* PerformanceInsightsEnabled: false,
|
|
470
|
+
* PreferredMaintenanceWindow: "mon:07:37-mon:08:07",
|
|
471
|
+
* ReadReplicaDBInstanceIdentifiers: []
|
|
472
472
|
* }
|
|
473
473
|
* }
|
|
474
474
|
* *\/
|
|
475
|
-
* // example id: to-restore-a-db-instance-from-a-db-snapshot-1680093236214
|
|
476
475
|
* ```
|
|
477
476
|
*
|
|
477
|
+
* @public
|
|
478
478
|
*/
|
|
479
479
|
export declare class RestoreDBInstanceFromDBSnapshotCommand extends RestoreDBInstanceFromDBSnapshotCommand_base {
|
|
480
480
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -423,6 +423,7 @@ declare const RestoreDBInstanceFromS3Command_base: {
|
|
|
423
423
|
* @throws {@link RDSServiceException}
|
|
424
424
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
425
425
|
*
|
|
426
|
+
*
|
|
426
427
|
* @public
|
|
427
428
|
*/
|
|
428
429
|
export declare class RestoreDBInstanceFromS3Command extends RestoreDBInstanceFromS3Command_base {
|