@aws-sdk/client-rds 3.321.1 → 3.326.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 +4 -0
- package/dist-types/commands/AddRoleToDBInstanceCommand.d.ts +4 -0
- package/dist-types/commands/AddSourceIdentifierToSubscriptionCommand.d.ts +21 -0
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +4 -0
- package/dist-types/commands/ApplyPendingMaintenanceActionCommand.d.ts +18 -0
- package/dist-types/commands/AuthorizeDBSecurityGroupIngressCommand.d.ts +26 -0
- package/dist-types/commands/BacktrackDBClusterCommand.d.ts +11 -0
- package/dist-types/commands/CancelExportTaskCommand.d.ts +23 -0
- package/dist-types/commands/CopyDBClusterParameterGroupCommand.d.ts +11 -0
- package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +37 -0
- package/dist-types/commands/CopyDBParameterGroupCommand.d.ts +11 -0
- package/dist-types/commands/CopyDBSnapshotCommand.d.ts +50 -0
- package/dist-types/commands/CopyOptionGroupCommand.d.ts +52 -0
- package/dist-types/commands/CreateBlueGreenDeploymentCommand.d.ts +34 -0
- package/dist-types/commands/CreateCustomDBEngineVersionCommand.d.ts +83 -0
- package/dist-types/commands/CreateDBClusterCommand.d.ts +151 -127
- package/dist-types/commands/CreateDBClusterEndpointCommand.d.ts +19 -0
- package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +11 -0
- package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +37 -0
- package/dist-types/commands/CreateDBInstanceCommand.d.ts +216 -0
- package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts +216 -0
- package/dist-types/commands/CreateDBParameterGroupCommand.d.ts +11 -0
- package/dist-types/commands/CreateDBProxyCommand.d.ts +35 -0
- package/dist-types/commands/CreateDBProxyEndpointCommand.d.ts +22 -0
- package/dist-types/commands/CreateDBSecurityGroupCommand.d.ts +26 -0
- package/dist-types/commands/CreateDBSnapshotCommand.d.ts +50 -0
- package/dist-types/commands/CreateDBSubnetGroupCommand.d.ts +27 -0
- package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +21 -0
- package/dist-types/commands/CreateGlobalClusterCommand.d.ts +31 -0
- package/dist-types/commands/CreateOptionGroupCommand.d.ts +52 -0
- package/dist-types/commands/DeleteBlueGreenDeploymentCommand.d.ts +34 -0
- package/dist-types/commands/DeleteCustomDBEngineVersionCommand.d.ts +83 -0
- package/dist-types/commands/DeleteDBClusterCommand.d.ts +151 -0
- package/dist-types/commands/DeleteDBClusterEndpointCommand.d.ts +19 -0
- package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +4 -0
- package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +37 -0
- package/dist-types/commands/DeleteDBInstanceAutomatedBackupCommand.d.ts +42 -0
- package/dist-types/commands/DeleteDBInstanceCommand.d.ts +216 -0
- package/dist-types/commands/DeleteDBParameterGroupCommand.d.ts +4 -0
- package/dist-types/commands/DeleteDBProxyCommand.d.ts +35 -0
- package/dist-types/commands/DeleteDBProxyEndpointCommand.d.ts +22 -0
- package/dist-types/commands/DeleteDBSecurityGroupCommand.d.ts +4 -0
- package/dist-types/commands/DeleteDBSnapshotCommand.d.ts +50 -0
- package/dist-types/commands/DeleteDBSubnetGroupCommand.d.ts +4 -0
- package/dist-types/commands/DeleteEventSubscriptionCommand.d.ts +21 -0
- package/dist-types/commands/DeleteGlobalClusterCommand.d.ts +31 -0
- package/dist-types/commands/DeleteOptionGroupCommand.d.ts +4 -0
- package/dist-types/commands/DeregisterDBProxyTargetsCommand.d.ts +4 -0
- package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +12 -0
- package/dist-types/commands/DescribeBlueGreenDeploymentsCommand.d.ts +37 -0
- package/dist-types/commands/DescribeCertificatesCommand.d.ts +18 -0
- package/dist-types/commands/DescribeDBClusterBacktracksCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBClusterEndpointsCommand.d.ts +24 -0
- package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +14 -0
- package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +23 -0
- package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +40 -0
- package/dist-types/commands/DescribeDBClustersCommand.d.ts +154 -0
- package/dist-types/commands/DescribeDBEngineVersionsCommand.d.ts +88 -0
- package/dist-types/commands/DescribeDBInstanceAutomatedBackupsCommand.d.ts +45 -0
- package/dist-types/commands/DescribeDBInstancesCommand.d.ts +219 -0
- package/dist-types/commands/DescribeDBLogFilesCommand.d.ts +13 -0
- package/dist-types/commands/DescribeDBParameterGroupsCommand.d.ts +14 -0
- package/dist-types/commands/DescribeDBParametersCommand.d.ts +23 -0
- package/dist-types/commands/DescribeDBProxiesCommand.d.ts +38 -0
- package/dist-types/commands/DescribeDBProxyEndpointsCommand.d.ts +25 -0
- package/dist-types/commands/DescribeDBProxyTargetGroupsCommand.d.ts +26 -0
- package/dist-types/commands/DescribeDBProxyTargetsCommand.d.ts +22 -0
- package/dist-types/commands/DescribeDBSecurityGroupsCommand.d.ts +29 -0
- package/dist-types/commands/DescribeDBSnapshotAttributesCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBSnapshotsCommand.d.ts +53 -0
- package/dist-types/commands/DescribeDBSubnetGroupsCommand.d.ts +30 -0
- package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +26 -0
- package/dist-types/commands/DescribeEngineDefaultParametersCommand.d.ts +26 -0
- package/dist-types/commands/DescribeEventCategoriesCommand.d.ts +13 -0
- package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +24 -0
- package/dist-types/commands/DescribeEventsCommand.d.ts +18 -0
- package/dist-types/commands/DescribeExportTasksCommand.d.ts +28 -0
- package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +34 -0
- package/dist-types/commands/DescribeOptionGroupOptionsCommand.d.ts +52 -0
- package/dist-types/commands/DescribeOptionGroupsCommand.d.ts +55 -0
- package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +61 -0
- package/dist-types/commands/DescribePendingMaintenanceActionsCommand.d.ts +21 -0
- package/dist-types/commands/DescribeReservedDBInstancesCommand.d.ts +31 -0
- package/dist-types/commands/DescribeReservedDBInstancesOfferingsCommand.d.ts +25 -0
- package/dist-types/commands/DescribeSourceRegionsCommand.d.ts +14 -0
- package/dist-types/commands/DescribeValidDBInstanceModificationsCommand.d.ts +53 -0
- package/dist-types/commands/DownloadDBLogFilePortionCommand.d.ts +8 -0
- package/dist-types/commands/FailoverDBClusterCommand.d.ts +151 -0
- package/dist-types/commands/FailoverGlobalClusterCommand.d.ts +31 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
- package/dist-types/commands/ModifyActivityStreamCommand.d.ts +11 -0
- package/dist-types/commands/ModifyCertificatesCommand.d.ts +15 -0
- package/dist-types/commands/ModifyCurrentDBClusterCapacityCommand.d.ts +10 -0
- package/dist-types/commands/ModifyCustomDBEngineVersionCommand.d.ts +83 -0
- package/dist-types/commands/ModifyDBClusterCommand.d.ts +151 -0
- package/dist-types/commands/ModifyDBClusterEndpointCommand.d.ts +19 -0
- package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +6 -0
- package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +16 -0
- package/dist-types/commands/ModifyDBInstanceCommand.d.ts +216 -49
- package/dist-types/commands/ModifyDBParameterGroupCommand.d.ts +6 -0
- package/dist-types/commands/ModifyDBProxyCommand.d.ts +35 -0
- package/dist-types/commands/ModifyDBProxyEndpointCommand.d.ts +22 -0
- package/dist-types/commands/ModifyDBProxyTargetGroupCommand.d.ts +23 -0
- package/dist-types/commands/ModifyDBSnapshotAttributeCommand.d.ts +16 -0
- package/dist-types/commands/ModifyDBSnapshotCommand.d.ts +50 -0
- package/dist-types/commands/ModifyDBSubnetGroupCommand.d.ts +27 -0
- package/dist-types/commands/ModifyEventSubscriptionCommand.d.ts +21 -0
- package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +31 -0
- package/dist-types/commands/ModifyOptionGroupCommand.d.ts +52 -0
- package/dist-types/commands/PromoteReadReplicaCommand.d.ts +216 -0
- package/dist-types/commands/PromoteReadReplicaDBClusterCommand.d.ts +151 -0
- package/dist-types/commands/PurchaseReservedDBInstancesOfferingCommand.d.ts +28 -0
- package/dist-types/commands/RebootDBClusterCommand.d.ts +151 -0
- package/dist-types/commands/RebootDBInstanceCommand.d.ts +216 -0
- package/dist-types/commands/RegisterDBProxyTargetsCommand.d.ts +21 -0
- package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +31 -0
- package/dist-types/commands/RemoveRoleFromDBClusterCommand.d.ts +4 -0
- package/dist-types/commands/RemoveRoleFromDBInstanceCommand.d.ts +4 -0
- package/dist-types/commands/RemoveSourceIdentifierFromSubscriptionCommand.d.ts +21 -0
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +4 -0
- package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +6 -0
- package/dist-types/commands/ResetDBParameterGroupCommand.d.ts +6 -0
- package/dist-types/commands/RestoreDBClusterFromS3Command.d.ts +151 -0
- package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +151 -0
- package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +151 -0
- package/dist-types/commands/RestoreDBInstanceFromDBSnapshotCommand.d.ts +216 -0
- package/dist-types/commands/RestoreDBInstanceFromS3Command.d.ts +216 -0
- package/dist-types/commands/RestoreDBInstanceToPointInTimeCommand.d.ts +216 -0
- package/dist-types/commands/RevokeDBSecurityGroupIngressCommand.d.ts +26 -0
- package/dist-types/commands/StartActivityStreamCommand.d.ts +11 -0
- package/dist-types/commands/StartDBClusterCommand.d.ts +151 -0
- package/dist-types/commands/StartDBInstanceAutomatedBackupsReplicationCommand.d.ts +42 -0
- package/dist-types/commands/StartDBInstanceCommand.d.ts +216 -0
- package/dist-types/commands/StartExportTaskCommand.d.ts +23 -0
- package/dist-types/commands/StopActivityStreamCommand.d.ts +8 -0
- package/dist-types/commands/StopDBClusterCommand.d.ts +151 -0
- package/dist-types/commands/StopDBInstanceAutomatedBackupsReplicationCommand.d.ts +42 -0
- package/dist-types/commands/StopDBInstanceCommand.d.ts +216 -0
- package/dist-types/commands/SwitchoverBlueGreenDeploymentCommand.d.ts +34 -0
- package/dist-types/commands/SwitchoverReadReplicaCommand.d.ts +216 -0
- package/package.json +17 -17
|
@@ -37,6 +37,35 @@ export interface RemoveFromGlobalClusterCommandOutput extends RemoveFromGlobalCl
|
|
|
37
37
|
* };
|
|
38
38
|
* const command = new RemoveFromGlobalClusterCommand(input);
|
|
39
39
|
* const response = await client.send(command);
|
|
40
|
+
* // { // RemoveFromGlobalClusterResult
|
|
41
|
+
* // GlobalCluster: { // GlobalCluster
|
|
42
|
+
* // GlobalClusterIdentifier: "STRING_VALUE",
|
|
43
|
+
* // GlobalClusterResourceId: "STRING_VALUE",
|
|
44
|
+
* // GlobalClusterArn: "STRING_VALUE",
|
|
45
|
+
* // Status: "STRING_VALUE",
|
|
46
|
+
* // Engine: "STRING_VALUE",
|
|
47
|
+
* // EngineVersion: "STRING_VALUE",
|
|
48
|
+
* // DatabaseName: "STRING_VALUE",
|
|
49
|
+
* // StorageEncrypted: true || false,
|
|
50
|
+
* // DeletionProtection: true || false,
|
|
51
|
+
* // GlobalClusterMembers: [ // GlobalClusterMemberList
|
|
52
|
+
* // { // GlobalClusterMember
|
|
53
|
+
* // DBClusterArn: "STRING_VALUE",
|
|
54
|
+
* // Readers: [ // ReadersArnList
|
|
55
|
+
* // "STRING_VALUE",
|
|
56
|
+
* // ],
|
|
57
|
+
* // IsWriter: true || false,
|
|
58
|
+
* // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown",
|
|
59
|
+
* // },
|
|
60
|
+
* // ],
|
|
61
|
+
* // FailoverState: { // FailoverState
|
|
62
|
+
* // Status: "pending" || "failing-over" || "cancelling",
|
|
63
|
+
* // FromDbClusterArn: "STRING_VALUE",
|
|
64
|
+
* // ToDbClusterArn: "STRING_VALUE",
|
|
65
|
+
* // },
|
|
66
|
+
* // },
|
|
67
|
+
* // };
|
|
68
|
+
*
|
|
40
69
|
* ```
|
|
41
70
|
*
|
|
42
71
|
* @param RemoveFromGlobalClusterCommandInput - {@link RemoveFromGlobalClusterCommandInput}
|
|
@@ -55,6 +84,8 @@ export interface RemoveFromGlobalClusterCommandOutput extends RemoveFromGlobalCl
|
|
|
55
84
|
* @throws {@link InvalidGlobalClusterStateFault} (client fault)
|
|
56
85
|
* <p>The global cluster is in an invalid state and can't perform the requested operation.</p>
|
|
57
86
|
*
|
|
87
|
+
* @throws {@link RDSServiceException}
|
|
88
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
58
89
|
*
|
|
59
90
|
* @example To detach an Aurora secondary cluster from an Aurora global database cluster
|
|
60
91
|
* ```javascript
|
|
@@ -41,6 +41,8 @@ export interface RemoveRoleFromDBClusterCommandOutput extends __MetadataBearer {
|
|
|
41
41
|
* };
|
|
42
42
|
* const command = new RemoveRoleFromDBClusterCommand(input);
|
|
43
43
|
* const response = await client.send(command);
|
|
44
|
+
* // {};
|
|
45
|
+
*
|
|
44
46
|
* ```
|
|
45
47
|
*
|
|
46
48
|
* @param RemoveRoleFromDBClusterCommandInput - {@link RemoveRoleFromDBClusterCommandInput}
|
|
@@ -59,6 +61,8 @@ export interface RemoveRoleFromDBClusterCommandOutput extends __MetadataBearer {
|
|
|
59
61
|
* @throws {@link InvalidDBClusterStateFault} (client fault)
|
|
60
62
|
* <p>The requested operation can't be performed while the cluster is in this state.</p>
|
|
61
63
|
*
|
|
64
|
+
* @throws {@link RDSServiceException}
|
|
65
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
62
66
|
*
|
|
63
67
|
* @example To disassociate an Identity and Access Management (IAM) role from a DB cluster
|
|
64
68
|
* ```javascript
|
|
@@ -33,6 +33,8 @@ export interface RemoveRoleFromDBInstanceCommandOutput extends __MetadataBearer
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new RemoveRoleFromDBInstanceCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // {};
|
|
37
|
+
*
|
|
36
38
|
* ```
|
|
37
39
|
*
|
|
38
40
|
* @param RemoveRoleFromDBInstanceCommandInput - {@link RemoveRoleFromDBInstanceCommandInput}
|
|
@@ -52,6 +54,8 @@ export interface RemoveRoleFromDBInstanceCommandOutput extends __MetadataBearer
|
|
|
52
54
|
* @throws {@link InvalidDBInstanceStateFault} (client fault)
|
|
53
55
|
* <p>The DB instance isn't in a valid state.</p>
|
|
54
56
|
*
|
|
57
|
+
* @throws {@link RDSServiceException}
|
|
58
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
55
59
|
*
|
|
56
60
|
*/
|
|
57
61
|
export declare class RemoveRoleFromDBInstanceCommand extends $Command<RemoveRoleFromDBInstanceCommandInput, RemoveRoleFromDBInstanceCommandOutput, RDSClientResolvedConfig> {
|
|
@@ -32,6 +32,25 @@ export interface RemoveSourceIdentifierFromSubscriptionCommandOutput extends Rem
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new RemoveSourceIdentifierFromSubscriptionCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // RemoveSourceIdentifierFromSubscriptionResult
|
|
36
|
+
* // EventSubscription: { // EventSubscription
|
|
37
|
+
* // CustomerAwsId: "STRING_VALUE",
|
|
38
|
+
* // CustSubscriptionId: "STRING_VALUE",
|
|
39
|
+
* // SnsTopicArn: "STRING_VALUE",
|
|
40
|
+
* // Status: "STRING_VALUE",
|
|
41
|
+
* // SubscriptionCreationTime: "STRING_VALUE",
|
|
42
|
+
* // SourceType: "STRING_VALUE",
|
|
43
|
+
* // SourceIdsList: [ // SourceIdsList
|
|
44
|
+
* // "STRING_VALUE",
|
|
45
|
+
* // ],
|
|
46
|
+
* // EventCategoriesList: [ // EventCategoriesList
|
|
47
|
+
* // "STRING_VALUE",
|
|
48
|
+
* // ],
|
|
49
|
+
* // Enabled: true || false,
|
|
50
|
+
* // EventSubscriptionArn: "STRING_VALUE",
|
|
51
|
+
* // },
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
35
54
|
* ```
|
|
36
55
|
*
|
|
37
56
|
* @param RemoveSourceIdentifierFromSubscriptionCommandInput - {@link RemoveSourceIdentifierFromSubscriptionCommandInput}
|
|
@@ -46,6 +65,8 @@ export interface RemoveSourceIdentifierFromSubscriptionCommandOutput extends Rem
|
|
|
46
65
|
* @throws {@link SubscriptionNotFoundFault} (client fault)
|
|
47
66
|
* <p>The subscription name does not exist.</p>
|
|
48
67
|
*
|
|
68
|
+
* @throws {@link RDSServiceException}
|
|
69
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
49
70
|
*
|
|
50
71
|
* @example To remove a source identifier from a subscription
|
|
51
72
|
* ```javascript
|
|
@@ -38,6 +38,8 @@ export interface RemoveTagsFromResourceCommandOutput extends __MetadataBearer {
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new RemoveTagsFromResourceCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // {};
|
|
42
|
+
*
|
|
41
43
|
* ```
|
|
42
44
|
*
|
|
43
45
|
* @param RemoveTagsFromResourceCommandInput - {@link RemoveTagsFromResourceCommandInput}
|
|
@@ -68,6 +70,8 @@ export interface RemoveTagsFromResourceCommandOutput extends __MetadataBearer {
|
|
|
68
70
|
* <p>
|
|
69
71
|
* <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot.</p>
|
|
70
72
|
*
|
|
73
|
+
* @throws {@link RDSServiceException}
|
|
74
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
71
75
|
*
|
|
72
76
|
* @example To remove tags from a resource
|
|
73
77
|
* ```javascript
|
|
@@ -64,6 +64,10 @@ export interface ResetDBClusterParameterGroupCommandOutput extends DBClusterPara
|
|
|
64
64
|
* };
|
|
65
65
|
* const command = new ResetDBClusterParameterGroupCommand(input);
|
|
66
66
|
* const response = await client.send(command);
|
|
67
|
+
* // { // DBClusterParameterGroupNameMessage
|
|
68
|
+
* // DBClusterParameterGroupName: "STRING_VALUE",
|
|
69
|
+
* // };
|
|
70
|
+
*
|
|
67
71
|
* ```
|
|
68
72
|
*
|
|
69
73
|
* @param ResetDBClusterParameterGroupCommandInput - {@link ResetDBClusterParameterGroupCommandInput}
|
|
@@ -82,6 +86,8 @@ export interface ResetDBClusterParameterGroupCommandOutput extends DBClusterPara
|
|
|
82
86
|
* to delete the parameter group, you can't delete it when the parameter group is in
|
|
83
87
|
* this state.</p>
|
|
84
88
|
*
|
|
89
|
+
* @throws {@link RDSServiceException}
|
|
90
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
85
91
|
*
|
|
86
92
|
* @example To reset all parameters to their default values
|
|
87
93
|
* ```javascript
|
|
@@ -56,6 +56,10 @@ export interface ResetDBParameterGroupCommandOutput extends DBParameterGroupName
|
|
|
56
56
|
* };
|
|
57
57
|
* const command = new ResetDBParameterGroupCommand(input);
|
|
58
58
|
* const response = await client.send(command);
|
|
59
|
+
* // { // DBParameterGroupNameMessage
|
|
60
|
+
* // DBParameterGroupName: "STRING_VALUE",
|
|
61
|
+
* // };
|
|
62
|
+
*
|
|
59
63
|
* ```
|
|
60
64
|
*
|
|
61
65
|
* @param ResetDBParameterGroupCommandInput - {@link ResetDBParameterGroupCommandInput}
|
|
@@ -74,6 +78,8 @@ export interface ResetDBParameterGroupCommandOutput extends DBParameterGroupName
|
|
|
74
78
|
* to delete the parameter group, you can't delete it when the parameter group is in
|
|
75
79
|
* this state.</p>
|
|
76
80
|
*
|
|
81
|
+
* @throws {@link RDSServiceException}
|
|
82
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
77
83
|
*
|
|
78
84
|
* @example To reset all parameters to their default values
|
|
79
85
|
* ```javascript
|
|
@@ -96,6 +96,155 @@ export interface RestoreDBClusterFromS3CommandOutput extends RestoreDBClusterFro
|
|
|
96
96
|
* };
|
|
97
97
|
* const command = new RestoreDBClusterFromS3Command(input);
|
|
98
98
|
* const response = await client.send(command);
|
|
99
|
+
* // { // RestoreDBClusterFromS3Result
|
|
100
|
+
* // DBCluster: { // DBCluster
|
|
101
|
+
* // AllocatedStorage: Number("int"),
|
|
102
|
+
* // AvailabilityZones: [ // AvailabilityZones
|
|
103
|
+
* // "STRING_VALUE",
|
|
104
|
+
* // ],
|
|
105
|
+
* // BackupRetentionPeriod: Number("int"),
|
|
106
|
+
* // CharacterSetName: "STRING_VALUE",
|
|
107
|
+
* // DatabaseName: "STRING_VALUE",
|
|
108
|
+
* // DBClusterIdentifier: "STRING_VALUE",
|
|
109
|
+
* // DBClusterParameterGroup: "STRING_VALUE",
|
|
110
|
+
* // DBSubnetGroup: "STRING_VALUE",
|
|
111
|
+
* // Status: "STRING_VALUE",
|
|
112
|
+
* // AutomaticRestartTime: new Date("TIMESTAMP"),
|
|
113
|
+
* // PercentProgress: "STRING_VALUE",
|
|
114
|
+
* // EarliestRestorableTime: new Date("TIMESTAMP"),
|
|
115
|
+
* // Endpoint: "STRING_VALUE",
|
|
116
|
+
* // ReaderEndpoint: "STRING_VALUE",
|
|
117
|
+
* // CustomEndpoints: [ // StringList
|
|
118
|
+
* // "STRING_VALUE",
|
|
119
|
+
* // ],
|
|
120
|
+
* // MultiAZ: true || false,
|
|
121
|
+
* // Engine: "STRING_VALUE",
|
|
122
|
+
* // EngineVersion: "STRING_VALUE",
|
|
123
|
+
* // LatestRestorableTime: new Date("TIMESTAMP"),
|
|
124
|
+
* // Port: Number("int"),
|
|
125
|
+
* // MasterUsername: "STRING_VALUE",
|
|
126
|
+
* // DBClusterOptionGroupMemberships: [ // DBClusterOptionGroupMemberships
|
|
127
|
+
* // { // DBClusterOptionGroupStatus
|
|
128
|
+
* // DBClusterOptionGroupName: "STRING_VALUE",
|
|
129
|
+
* // Status: "STRING_VALUE",
|
|
130
|
+
* // },
|
|
131
|
+
* // ],
|
|
132
|
+
* // PreferredBackupWindow: "STRING_VALUE",
|
|
133
|
+
* // PreferredMaintenanceWindow: "STRING_VALUE",
|
|
134
|
+
* // ReplicationSourceIdentifier: "STRING_VALUE",
|
|
135
|
+
* // ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
|
|
136
|
+
* // "STRING_VALUE",
|
|
137
|
+
* // ],
|
|
138
|
+
* // DBClusterMembers: [ // DBClusterMemberList
|
|
139
|
+
* // { // DBClusterMember
|
|
140
|
+
* // DBInstanceIdentifier: "STRING_VALUE",
|
|
141
|
+
* // IsClusterWriter: true || false,
|
|
142
|
+
* // DBClusterParameterGroupStatus: "STRING_VALUE",
|
|
143
|
+
* // PromotionTier: Number("int"),
|
|
144
|
+
* // },
|
|
145
|
+
* // ],
|
|
146
|
+
* // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
|
|
147
|
+
* // { // VpcSecurityGroupMembership
|
|
148
|
+
* // VpcSecurityGroupId: "STRING_VALUE",
|
|
149
|
+
* // Status: "STRING_VALUE",
|
|
150
|
+
* // },
|
|
151
|
+
* // ],
|
|
152
|
+
* // HostedZoneId: "STRING_VALUE",
|
|
153
|
+
* // StorageEncrypted: true || false,
|
|
154
|
+
* // KmsKeyId: "STRING_VALUE",
|
|
155
|
+
* // DbClusterResourceId: "STRING_VALUE",
|
|
156
|
+
* // DBClusterArn: "STRING_VALUE",
|
|
157
|
+
* // AssociatedRoles: [ // DBClusterRoles
|
|
158
|
+
* // { // DBClusterRole
|
|
159
|
+
* // RoleArn: "STRING_VALUE",
|
|
160
|
+
* // Status: "STRING_VALUE",
|
|
161
|
+
* // FeatureName: "STRING_VALUE",
|
|
162
|
+
* // },
|
|
163
|
+
* // ],
|
|
164
|
+
* // IAMDatabaseAuthenticationEnabled: true || false,
|
|
165
|
+
* // CloneGroupId: "STRING_VALUE",
|
|
166
|
+
* // ClusterCreateTime: new Date("TIMESTAMP"),
|
|
167
|
+
* // EarliestBacktrackTime: new Date("TIMESTAMP"),
|
|
168
|
+
* // BacktrackWindow: Number("long"),
|
|
169
|
+
* // BacktrackConsumedChangeRecords: Number("long"),
|
|
170
|
+
* // EnabledCloudwatchLogsExports: [ // LogTypeList
|
|
171
|
+
* // "STRING_VALUE",
|
|
172
|
+
* // ],
|
|
173
|
+
* // Capacity: Number("int"),
|
|
174
|
+
* // EngineMode: "STRING_VALUE",
|
|
175
|
+
* // ScalingConfigurationInfo: { // ScalingConfigurationInfo
|
|
176
|
+
* // MinCapacity: Number("int"),
|
|
177
|
+
* // MaxCapacity: Number("int"),
|
|
178
|
+
* // AutoPause: true || false,
|
|
179
|
+
* // SecondsUntilAutoPause: Number("int"),
|
|
180
|
+
* // TimeoutAction: "STRING_VALUE",
|
|
181
|
+
* // SecondsBeforeTimeout: Number("int"),
|
|
182
|
+
* // },
|
|
183
|
+
* // DeletionProtection: true || false,
|
|
184
|
+
* // HttpEndpointEnabled: true || false,
|
|
185
|
+
* // ActivityStreamMode: "sync" || "async",
|
|
186
|
+
* // ActivityStreamStatus: "stopped" || "starting" || "started" || "stopping",
|
|
187
|
+
* // ActivityStreamKmsKeyId: "STRING_VALUE",
|
|
188
|
+
* // ActivityStreamKinesisStreamName: "STRING_VALUE",
|
|
189
|
+
* // CopyTagsToSnapshot: true || false,
|
|
190
|
+
* // CrossAccountClone: true || false,
|
|
191
|
+
* // DomainMemberships: [ // DomainMembershipList
|
|
192
|
+
* // { // DomainMembership
|
|
193
|
+
* // Domain: "STRING_VALUE",
|
|
194
|
+
* // Status: "STRING_VALUE",
|
|
195
|
+
* // FQDN: "STRING_VALUE",
|
|
196
|
+
* // IAMRoleName: "STRING_VALUE",
|
|
197
|
+
* // },
|
|
198
|
+
* // ],
|
|
199
|
+
* // TagList: [ // TagList
|
|
200
|
+
* // { // Tag
|
|
201
|
+
* // Key: "STRING_VALUE",
|
|
202
|
+
* // Value: "STRING_VALUE",
|
|
203
|
+
* // },
|
|
204
|
+
* // ],
|
|
205
|
+
* // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown",
|
|
206
|
+
* // GlobalWriteForwardingRequested: true || false,
|
|
207
|
+
* // PendingModifiedValues: { // ClusterPendingModifiedValues
|
|
208
|
+
* // PendingCloudwatchLogsExports: { // PendingCloudwatchLogsExports
|
|
209
|
+
* // LogTypesToEnable: [
|
|
210
|
+
* // "STRING_VALUE",
|
|
211
|
+
* // ],
|
|
212
|
+
* // LogTypesToDisable: [
|
|
213
|
+
* // "STRING_VALUE",
|
|
214
|
+
* // ],
|
|
215
|
+
* // },
|
|
216
|
+
* // DBClusterIdentifier: "STRING_VALUE",
|
|
217
|
+
* // MasterUserPassword: "STRING_VALUE",
|
|
218
|
+
* // IAMDatabaseAuthenticationEnabled: true || false,
|
|
219
|
+
* // EngineVersion: "STRING_VALUE",
|
|
220
|
+
* // BackupRetentionPeriod: Number("int"),
|
|
221
|
+
* // AllocatedStorage: Number("int"),
|
|
222
|
+
* // Iops: Number("int"),
|
|
223
|
+
* // },
|
|
224
|
+
* // DBClusterInstanceClass: "STRING_VALUE",
|
|
225
|
+
* // StorageType: "STRING_VALUE",
|
|
226
|
+
* // Iops: Number("int"),
|
|
227
|
+
* // PubliclyAccessible: true || false,
|
|
228
|
+
* // AutoMinorVersionUpgrade: true || false,
|
|
229
|
+
* // MonitoringInterval: Number("int"),
|
|
230
|
+
* // MonitoringRoleArn: "STRING_VALUE",
|
|
231
|
+
* // PerformanceInsightsEnabled: true || false,
|
|
232
|
+
* // PerformanceInsightsKMSKeyId: "STRING_VALUE",
|
|
233
|
+
* // PerformanceInsightsRetentionPeriod: Number("int"),
|
|
234
|
+
* // ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfigurationInfo
|
|
235
|
+
* // MinCapacity: Number("double"),
|
|
236
|
+
* // MaxCapacity: Number("double"),
|
|
237
|
+
* // },
|
|
238
|
+
* // NetworkType: "STRING_VALUE",
|
|
239
|
+
* // DBSystemId: "STRING_VALUE",
|
|
240
|
+
* // MasterUserSecret: { // MasterUserSecret
|
|
241
|
+
* // SecretArn: "STRING_VALUE",
|
|
242
|
+
* // SecretStatus: "STRING_VALUE",
|
|
243
|
+
* // KmsKeyId: "STRING_VALUE",
|
|
244
|
+
* // },
|
|
245
|
+
* // },
|
|
246
|
+
* // };
|
|
247
|
+
*
|
|
99
248
|
* ```
|
|
100
249
|
*
|
|
101
250
|
* @param RestoreDBClusterFromS3CommandInput - {@link RestoreDBClusterFromS3CommandInput}
|
|
@@ -157,6 +306,8 @@ export interface RestoreDBClusterFromS3CommandOutput extends RestoreDBClusterFro
|
|
|
157
306
|
* <p>The request would result in the user exceeding the allowed amount of storage
|
|
158
307
|
* available across all DB instances.</p>
|
|
159
308
|
*
|
|
309
|
+
* @throws {@link RDSServiceException}
|
|
310
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
160
311
|
*
|
|
161
312
|
* @example To restore an Amazon Aurora DB cluster from Amazon S3
|
|
162
313
|
* ```javascript
|
|
@@ -97,6 +97,155 @@ export interface RestoreDBClusterFromSnapshotCommandOutput extends RestoreDBClus
|
|
|
97
97
|
* };
|
|
98
98
|
* const command = new RestoreDBClusterFromSnapshotCommand(input);
|
|
99
99
|
* const response = await client.send(command);
|
|
100
|
+
* // { // RestoreDBClusterFromSnapshotResult
|
|
101
|
+
* // DBCluster: { // DBCluster
|
|
102
|
+
* // AllocatedStorage: Number("int"),
|
|
103
|
+
* // AvailabilityZones: [ // AvailabilityZones
|
|
104
|
+
* // "STRING_VALUE",
|
|
105
|
+
* // ],
|
|
106
|
+
* // BackupRetentionPeriod: Number("int"),
|
|
107
|
+
* // CharacterSetName: "STRING_VALUE",
|
|
108
|
+
* // DatabaseName: "STRING_VALUE",
|
|
109
|
+
* // DBClusterIdentifier: "STRING_VALUE",
|
|
110
|
+
* // DBClusterParameterGroup: "STRING_VALUE",
|
|
111
|
+
* // DBSubnetGroup: "STRING_VALUE",
|
|
112
|
+
* // Status: "STRING_VALUE",
|
|
113
|
+
* // AutomaticRestartTime: new Date("TIMESTAMP"),
|
|
114
|
+
* // PercentProgress: "STRING_VALUE",
|
|
115
|
+
* // EarliestRestorableTime: new Date("TIMESTAMP"),
|
|
116
|
+
* // Endpoint: "STRING_VALUE",
|
|
117
|
+
* // ReaderEndpoint: "STRING_VALUE",
|
|
118
|
+
* // CustomEndpoints: [ // StringList
|
|
119
|
+
* // "STRING_VALUE",
|
|
120
|
+
* // ],
|
|
121
|
+
* // MultiAZ: true || false,
|
|
122
|
+
* // Engine: "STRING_VALUE",
|
|
123
|
+
* // EngineVersion: "STRING_VALUE",
|
|
124
|
+
* // LatestRestorableTime: new Date("TIMESTAMP"),
|
|
125
|
+
* // Port: Number("int"),
|
|
126
|
+
* // MasterUsername: "STRING_VALUE",
|
|
127
|
+
* // DBClusterOptionGroupMemberships: [ // DBClusterOptionGroupMemberships
|
|
128
|
+
* // { // DBClusterOptionGroupStatus
|
|
129
|
+
* // DBClusterOptionGroupName: "STRING_VALUE",
|
|
130
|
+
* // Status: "STRING_VALUE",
|
|
131
|
+
* // },
|
|
132
|
+
* // ],
|
|
133
|
+
* // PreferredBackupWindow: "STRING_VALUE",
|
|
134
|
+
* // PreferredMaintenanceWindow: "STRING_VALUE",
|
|
135
|
+
* // ReplicationSourceIdentifier: "STRING_VALUE",
|
|
136
|
+
* // ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
|
|
137
|
+
* // "STRING_VALUE",
|
|
138
|
+
* // ],
|
|
139
|
+
* // DBClusterMembers: [ // DBClusterMemberList
|
|
140
|
+
* // { // DBClusterMember
|
|
141
|
+
* // DBInstanceIdentifier: "STRING_VALUE",
|
|
142
|
+
* // IsClusterWriter: true || false,
|
|
143
|
+
* // DBClusterParameterGroupStatus: "STRING_VALUE",
|
|
144
|
+
* // PromotionTier: Number("int"),
|
|
145
|
+
* // },
|
|
146
|
+
* // ],
|
|
147
|
+
* // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
|
|
148
|
+
* // { // VpcSecurityGroupMembership
|
|
149
|
+
* // VpcSecurityGroupId: "STRING_VALUE",
|
|
150
|
+
* // Status: "STRING_VALUE",
|
|
151
|
+
* // },
|
|
152
|
+
* // ],
|
|
153
|
+
* // HostedZoneId: "STRING_VALUE",
|
|
154
|
+
* // StorageEncrypted: true || false,
|
|
155
|
+
* // KmsKeyId: "STRING_VALUE",
|
|
156
|
+
* // DbClusterResourceId: "STRING_VALUE",
|
|
157
|
+
* // DBClusterArn: "STRING_VALUE",
|
|
158
|
+
* // AssociatedRoles: [ // DBClusterRoles
|
|
159
|
+
* // { // DBClusterRole
|
|
160
|
+
* // RoleArn: "STRING_VALUE",
|
|
161
|
+
* // Status: "STRING_VALUE",
|
|
162
|
+
* // FeatureName: "STRING_VALUE",
|
|
163
|
+
* // },
|
|
164
|
+
* // ],
|
|
165
|
+
* // IAMDatabaseAuthenticationEnabled: true || false,
|
|
166
|
+
* // CloneGroupId: "STRING_VALUE",
|
|
167
|
+
* // ClusterCreateTime: new Date("TIMESTAMP"),
|
|
168
|
+
* // EarliestBacktrackTime: new Date("TIMESTAMP"),
|
|
169
|
+
* // BacktrackWindow: Number("long"),
|
|
170
|
+
* // BacktrackConsumedChangeRecords: Number("long"),
|
|
171
|
+
* // EnabledCloudwatchLogsExports: [ // LogTypeList
|
|
172
|
+
* // "STRING_VALUE",
|
|
173
|
+
* // ],
|
|
174
|
+
* // Capacity: Number("int"),
|
|
175
|
+
* // EngineMode: "STRING_VALUE",
|
|
176
|
+
* // ScalingConfigurationInfo: { // ScalingConfigurationInfo
|
|
177
|
+
* // MinCapacity: Number("int"),
|
|
178
|
+
* // MaxCapacity: Number("int"),
|
|
179
|
+
* // AutoPause: true || false,
|
|
180
|
+
* // SecondsUntilAutoPause: Number("int"),
|
|
181
|
+
* // TimeoutAction: "STRING_VALUE",
|
|
182
|
+
* // SecondsBeforeTimeout: Number("int"),
|
|
183
|
+
* // },
|
|
184
|
+
* // DeletionProtection: true || false,
|
|
185
|
+
* // HttpEndpointEnabled: true || false,
|
|
186
|
+
* // ActivityStreamMode: "sync" || "async",
|
|
187
|
+
* // ActivityStreamStatus: "stopped" || "starting" || "started" || "stopping",
|
|
188
|
+
* // ActivityStreamKmsKeyId: "STRING_VALUE",
|
|
189
|
+
* // ActivityStreamKinesisStreamName: "STRING_VALUE",
|
|
190
|
+
* // CopyTagsToSnapshot: true || false,
|
|
191
|
+
* // CrossAccountClone: true || false,
|
|
192
|
+
* // DomainMemberships: [ // DomainMembershipList
|
|
193
|
+
* // { // DomainMembership
|
|
194
|
+
* // Domain: "STRING_VALUE",
|
|
195
|
+
* // Status: "STRING_VALUE",
|
|
196
|
+
* // FQDN: "STRING_VALUE",
|
|
197
|
+
* // IAMRoleName: "STRING_VALUE",
|
|
198
|
+
* // },
|
|
199
|
+
* // ],
|
|
200
|
+
* // TagList: [ // TagList
|
|
201
|
+
* // { // Tag
|
|
202
|
+
* // Key: "STRING_VALUE",
|
|
203
|
+
* // Value: "STRING_VALUE",
|
|
204
|
+
* // },
|
|
205
|
+
* // ],
|
|
206
|
+
* // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown",
|
|
207
|
+
* // GlobalWriteForwardingRequested: true || false,
|
|
208
|
+
* // PendingModifiedValues: { // ClusterPendingModifiedValues
|
|
209
|
+
* // PendingCloudwatchLogsExports: { // PendingCloudwatchLogsExports
|
|
210
|
+
* // LogTypesToEnable: [
|
|
211
|
+
* // "STRING_VALUE",
|
|
212
|
+
* // ],
|
|
213
|
+
* // LogTypesToDisable: [
|
|
214
|
+
* // "STRING_VALUE",
|
|
215
|
+
* // ],
|
|
216
|
+
* // },
|
|
217
|
+
* // DBClusterIdentifier: "STRING_VALUE",
|
|
218
|
+
* // MasterUserPassword: "STRING_VALUE",
|
|
219
|
+
* // IAMDatabaseAuthenticationEnabled: true || false,
|
|
220
|
+
* // EngineVersion: "STRING_VALUE",
|
|
221
|
+
* // BackupRetentionPeriod: Number("int"),
|
|
222
|
+
* // AllocatedStorage: Number("int"),
|
|
223
|
+
* // Iops: Number("int"),
|
|
224
|
+
* // },
|
|
225
|
+
* // DBClusterInstanceClass: "STRING_VALUE",
|
|
226
|
+
* // StorageType: "STRING_VALUE",
|
|
227
|
+
* // Iops: Number("int"),
|
|
228
|
+
* // PubliclyAccessible: true || false,
|
|
229
|
+
* // AutoMinorVersionUpgrade: true || false,
|
|
230
|
+
* // MonitoringInterval: Number("int"),
|
|
231
|
+
* // MonitoringRoleArn: "STRING_VALUE",
|
|
232
|
+
* // PerformanceInsightsEnabled: true || false,
|
|
233
|
+
* // PerformanceInsightsKMSKeyId: "STRING_VALUE",
|
|
234
|
+
* // PerformanceInsightsRetentionPeriod: Number("int"),
|
|
235
|
+
* // ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfigurationInfo
|
|
236
|
+
* // MinCapacity: Number("double"),
|
|
237
|
+
* // MaxCapacity: Number("double"),
|
|
238
|
+
* // },
|
|
239
|
+
* // NetworkType: "STRING_VALUE",
|
|
240
|
+
* // DBSystemId: "STRING_VALUE",
|
|
241
|
+
* // MasterUserSecret: { // MasterUserSecret
|
|
242
|
+
* // SecretArn: "STRING_VALUE",
|
|
243
|
+
* // SecretStatus: "STRING_VALUE",
|
|
244
|
+
* // KmsKeyId: "STRING_VALUE",
|
|
245
|
+
* // },
|
|
246
|
+
* // },
|
|
247
|
+
* // };
|
|
248
|
+
*
|
|
100
249
|
* ```
|
|
101
250
|
*
|
|
102
251
|
* @param RestoreDBClusterFromSnapshotCommandInput - {@link RestoreDBClusterFromSnapshotCommandInput}
|
|
@@ -170,6 +319,8 @@ export interface RestoreDBClusterFromSnapshotCommandOutput extends RestoreDBClus
|
|
|
170
319
|
* <p>The request would result in the user exceeding the allowed amount of storage
|
|
171
320
|
* available across all DB instances.</p>
|
|
172
321
|
*
|
|
322
|
+
* @throws {@link RDSServiceException}
|
|
323
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
173
324
|
*
|
|
174
325
|
* @example To restore a DB cluster from a snapshot
|
|
175
326
|
* ```javascript
|