@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
|
@@ -67,19 +67,22 @@ declare const AddRoleToDBClusterCommand_base: {
|
|
|
67
67
|
* @throws {@link RDSServiceException}
|
|
68
68
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
69
69
|
*
|
|
70
|
-
*
|
|
70
|
+
*
|
|
71
71
|
* @example To associate an AWS Identity and Access Management (IAM) role with a DB cluster
|
|
72
72
|
* ```javascript
|
|
73
73
|
* // The following example associates a role with a DB cluster.
|
|
74
74
|
* const input = {
|
|
75
|
-
*
|
|
76
|
-
*
|
|
75
|
+
* DBClusterIdentifier: "mydbcluster",
|
|
76
|
+
* RoleArn: "arn:aws:iam::123456789012:role/RDSLoadFromS3"
|
|
77
77
|
* };
|
|
78
78
|
* const command = new AddRoleToDBClusterCommand(input);
|
|
79
|
-
* await client.send(command);
|
|
80
|
-
*
|
|
79
|
+
* const response = await client.send(command);
|
|
80
|
+
* /* response is
|
|
81
|
+
* { /* metadata only *\/ }
|
|
82
|
+
* *\/
|
|
81
83
|
* ```
|
|
82
84
|
*
|
|
85
|
+
* @public
|
|
83
86
|
*/
|
|
84
87
|
export declare class AddRoleToDBClusterCommand extends AddRoleToDBClusterCommand_base {
|
|
85
88
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -71,20 +71,23 @@ declare const AddRoleToDBInstanceCommand_base: {
|
|
|
71
71
|
* @throws {@link RDSServiceException}
|
|
72
72
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
73
73
|
*
|
|
74
|
-
*
|
|
74
|
+
*
|
|
75
75
|
* @example To associate an AWS Identity and Access Management (IAM) role with a DB instance
|
|
76
76
|
* ```javascript
|
|
77
77
|
* // The following example adds the role to a DB instance named test-instance.
|
|
78
78
|
* const input = {
|
|
79
|
-
*
|
|
80
|
-
*
|
|
81
|
-
*
|
|
79
|
+
* DBInstanceIdentifier: "test-instance",
|
|
80
|
+
* FeatureName: "S3_INTEGRATION",
|
|
81
|
+
* RoleArn: "arn:aws:iam::111122223333:role/rds-s3-integration-role"
|
|
82
82
|
* };
|
|
83
83
|
* const command = new AddRoleToDBInstanceCommand(input);
|
|
84
|
-
* await client.send(command);
|
|
85
|
-
*
|
|
84
|
+
* const response = await client.send(command);
|
|
85
|
+
* /* response is
|
|
86
|
+
* { /* metadata only *\/ }
|
|
87
|
+
* *\/
|
|
86
88
|
* ```
|
|
87
89
|
*
|
|
90
|
+
* @public
|
|
88
91
|
*/
|
|
89
92
|
export declare class AddRoleToDBInstanceCommand extends AddRoleToDBInstanceCommand_base {
|
|
90
93
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -76,41 +76,41 @@ declare const AddSourceIdentifierToSubscriptionCommand_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 add a source identifier to a subscription
|
|
81
81
|
* ```javascript
|
|
82
82
|
* // The following example adds another source identifier to 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 AddSourceIdentifierToSubscriptionCommand(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
|
* "test-instance-repl"
|
|
104
104
|
* ],
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
105
|
+
* SourceType: "db-instance",
|
|
106
|
+
* Status: "modifying",
|
|
107
|
+
* SubscriptionCreationTime: "Tue Jul 31 23:22:01 UTC 2018"
|
|
108
108
|
* }
|
|
109
109
|
* }
|
|
110
110
|
* *\/
|
|
111
|
-
* // example id: to-add-a-source-identifier-to-a-subscription-1679691771786
|
|
112
111
|
* ```
|
|
113
112
|
*
|
|
113
|
+
* @public
|
|
114
114
|
*/
|
|
115
115
|
export declare class AddSourceIdentifierToSubscriptionCommand extends AddSourceIdentifierToSubscriptionCommand_base {
|
|
116
116
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -93,24 +93,27 @@ declare const AddTagsToResourceCommand_base: {
|
|
|
93
93
|
* @throws {@link RDSServiceException}
|
|
94
94
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
95
95
|
*
|
|
96
|
-
*
|
|
96
|
+
*
|
|
97
97
|
* @example To add tags to a resource
|
|
98
98
|
* ```javascript
|
|
99
99
|
* // This example adds a tag to an option group.
|
|
100
100
|
* const input = {
|
|
101
|
-
*
|
|
102
|
-
*
|
|
101
|
+
* ResourceName: "arn:aws:rds:us-east-1:992648334831:og:mymysqloptiongroup",
|
|
102
|
+
* Tags: [
|
|
103
103
|
* {
|
|
104
|
-
*
|
|
105
|
-
*
|
|
104
|
+
* Key: "Staging",
|
|
105
|
+
* Value: "LocationDB"
|
|
106
106
|
* }
|
|
107
107
|
* ]
|
|
108
108
|
* };
|
|
109
109
|
* const command = new AddTagsToResourceCommand(input);
|
|
110
|
-
* await client.send(command);
|
|
111
|
-
*
|
|
110
|
+
* const response = await client.send(command);
|
|
111
|
+
* /* response is
|
|
112
|
+
* { /* metadata only *\/ }
|
|
113
|
+
* *\/
|
|
112
114
|
* ```
|
|
113
115
|
*
|
|
116
|
+
* @public
|
|
114
117
|
*/
|
|
115
118
|
export declare class AddTagsToResourceCommand extends AddTagsToResourceCommand_base {
|
|
116
119
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -77,35 +77,35 @@ declare const ApplyPendingMaintenanceActionCommand_base: {
|
|
|
77
77
|
* @throws {@link RDSServiceException}
|
|
78
78
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
79
79
|
*
|
|
80
|
-
*
|
|
80
|
+
*
|
|
81
81
|
* @example To apply pending maintenance actions
|
|
82
82
|
* ```javascript
|
|
83
83
|
* // The following example applies the pending maintenance actions for a DB cluster.
|
|
84
84
|
* const input = {
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
85
|
+
* ApplyAction: "system-update",
|
|
86
|
+
* OptInType: "immediate",
|
|
87
|
+
* ResourceIdentifier: "arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster"
|
|
88
88
|
* };
|
|
89
89
|
* const command = new ApplyPendingMaintenanceActionCommand(input);
|
|
90
90
|
* const response = await client.send(command);
|
|
91
|
-
* /* response
|
|
91
|
+
* /* response is
|
|
92
92
|
* {
|
|
93
|
-
*
|
|
94
|
-
*
|
|
93
|
+
* ResourcePendingMaintenanceActions: {
|
|
94
|
+
* PendingMaintenanceActionDetails: [
|
|
95
95
|
* {
|
|
96
|
-
*
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
*
|
|
96
|
+
* Action: "system-update",
|
|
97
|
+
* CurrentApplyDate: "2021-01-23T01:07:36.100Z",
|
|
98
|
+
* Description: "Upgrade to Aurora PostgreSQL 3.3.2",
|
|
99
|
+
* OptInStatus: "immediate"
|
|
100
100
|
* }
|
|
101
101
|
* ],
|
|
102
|
-
*
|
|
102
|
+
* ResourceIdentifier: "arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster"
|
|
103
103
|
* }
|
|
104
104
|
* }
|
|
105
105
|
* *\/
|
|
106
|
-
* // example id: to-apply-pending-maintenance-actions-1679692228896
|
|
107
106
|
* ```
|
|
108
107
|
*
|
|
108
|
+
* @public
|
|
109
109
|
*/
|
|
110
110
|
export declare class ApplyPendingMaintenanceActionCommand extends ApplyPendingMaintenanceActionCommand_base {
|
|
111
111
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -107,24 +107,24 @@ declare const AuthorizeDBSecurityGroupIngressCommand_base: {
|
|
|
107
107
|
* @throws {@link RDSServiceException}
|
|
108
108
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
109
109
|
*
|
|
110
|
-
*
|
|
110
|
+
*
|
|
111
111
|
* @example To authorize DB security group integress
|
|
112
112
|
* ```javascript
|
|
113
113
|
* // This example authorizes access to the specified security group by the specified CIDR block.
|
|
114
114
|
* const input = {
|
|
115
|
-
*
|
|
116
|
-
*
|
|
115
|
+
* CIDRIP: "203.0.113.5/32",
|
|
116
|
+
* DBSecurityGroupName: "mydbsecuritygroup"
|
|
117
117
|
* };
|
|
118
118
|
* const command = new AuthorizeDBSecurityGroupIngressCommand(input);
|
|
119
119
|
* const response = await client.send(command);
|
|
120
|
-
* /* response
|
|
120
|
+
* /* response is
|
|
121
121
|
* {
|
|
122
|
-
*
|
|
122
|
+
* DBSecurityGroup: { /* empty *\/ }
|
|
123
123
|
* }
|
|
124
124
|
* *\/
|
|
125
|
-
* // example id: authorize-db-security-group-ingress-ebf9ab91-8912-4b07-a32e-ca150668164f
|
|
126
125
|
* ```
|
|
127
126
|
*
|
|
127
|
+
* @public
|
|
128
128
|
*/
|
|
129
129
|
export declare class AuthorizeDBSecurityGroupIngressCommand extends AuthorizeDBSecurityGroupIngressCommand_base {
|
|
130
130
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -76,6 +76,7 @@ declare const BacktrackDBClusterCommand_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
|
* @public
|
|
80
81
|
*/
|
|
81
82
|
export declare class BacktrackDBClusterCommand extends BacktrackDBClusterCommand_base {
|
|
@@ -78,32 +78,32 @@ declare const CancelExportTaskCommand_base: {
|
|
|
78
78
|
* @throws {@link RDSServiceException}
|
|
79
79
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
80
80
|
*
|
|
81
|
-
*
|
|
81
|
+
*
|
|
82
82
|
* @example To cancel a snapshot export to Amazon S3
|
|
83
83
|
* ```javascript
|
|
84
84
|
* // The following example cancels an export task in progress that is exporting a snapshot to Amazon S3.
|
|
85
85
|
* const input = {
|
|
86
|
-
*
|
|
86
|
+
* ExportTaskIdentifier: "my-s3-export-1"
|
|
87
87
|
* };
|
|
88
88
|
* const command = new CancelExportTaskCommand(input);
|
|
89
89
|
* const response = await client.send(command);
|
|
90
|
-
* /* response
|
|
90
|
+
* /* response is
|
|
91
91
|
* {
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
*
|
|
95
|
-
*
|
|
96
|
-
*
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
92
|
+
* ExportTaskIdentifier: "my-s3-export-1",
|
|
93
|
+
* IamRoleArn: "arn:aws:iam::123456789012:role/service-role/export-snap-S3-role",
|
|
94
|
+
* KmsKeyId: "arn:aws:kms:us-east-1:123456789012:key/abcd0000-7bfd-4594-af38-aabbccddeeff",
|
|
95
|
+
* PercentProgress: 0,
|
|
96
|
+
* S3Bucket: "mybucket",
|
|
97
|
+
* S3Prefix: "",
|
|
98
|
+
* SnapshotTime: "2019-03-24T20:01:09.815Z",
|
|
99
|
+
* SourceArn: "arn:aws:rds:us-east-1:123456789012:snapshot:publisher-final-snapshot",
|
|
100
|
+
* Status: "CANCELING",
|
|
101
|
+
* TotalExtractedDataInGB: 0
|
|
102
102
|
* }
|
|
103
103
|
* *\/
|
|
104
|
-
* // example id: to-cancel-a-snapshot-export-to-amazon-s3-1679694286587
|
|
105
104
|
* ```
|
|
106
105
|
*
|
|
106
|
+
* @public
|
|
107
107
|
*/
|
|
108
108
|
export declare class CancelExportTaskCommand extends CancelExportTaskCommand_base {
|
|
109
109
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -83,30 +83,30 @@ declare const CopyDBClusterParameterGroupCommand_base: {
|
|
|
83
83
|
* @throws {@link RDSServiceException}
|
|
84
84
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
85
85
|
*
|
|
86
|
-
*
|
|
86
|
+
*
|
|
87
87
|
* @example To copy a DB cluster parameter group
|
|
88
88
|
* ```javascript
|
|
89
89
|
* // This example copies a DB cluster parameter group.
|
|
90
90
|
* const input = {
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
91
|
+
* SourceDBClusterParameterGroupIdentifier: "mydbclusterparametergroup",
|
|
92
|
+
* TargetDBClusterParameterGroupDescription: "My DB cluster parameter group copy",
|
|
93
|
+
* TargetDBClusterParameterGroupIdentifier: "mydbclusterparametergroup-copy"
|
|
94
94
|
* };
|
|
95
95
|
* const command = new CopyDBClusterParameterGroupCommand(input);
|
|
96
96
|
* const response = await client.send(command);
|
|
97
|
-
* /* response
|
|
97
|
+
* /* response is
|
|
98
98
|
* {
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
99
|
+
* DBClusterParameterGroup: {
|
|
100
|
+
* DBClusterParameterGroupArn: "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup-copy",
|
|
101
|
+
* DBClusterParameterGroupName: "mydbclusterparametergroup-copy",
|
|
102
|
+
* DBParameterGroupFamily: "aurora-mysql5.7",
|
|
103
|
+
* Description: "My DB cluster parameter group copy"
|
|
104
104
|
* }
|
|
105
105
|
* }
|
|
106
106
|
* *\/
|
|
107
|
-
* // example id: copy-db-cluster-parameter-group-6fefaffe-cde9-4dba-9f0b-d3f593572fe4
|
|
108
107
|
* ```
|
|
109
108
|
*
|
|
109
|
+
* @public
|
|
110
110
|
*/
|
|
111
111
|
export declare class CopyDBClusterParameterGroupCommand extends CopyDBClusterParameterGroupCommand_base {
|
|
112
112
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -154,49 +154,49 @@ declare const CopyDBClusterSnapshotCommand_base: {
|
|
|
154
154
|
* @throws {@link RDSServiceException}
|
|
155
155
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
156
156
|
*
|
|
157
|
-
*
|
|
157
|
+
*
|
|
158
158
|
* @example To copy a DB cluster snapshot
|
|
159
159
|
* ```javascript
|
|
160
160
|
* // The following example creates a copy of a DB cluster snapshot, including its tags.
|
|
161
161
|
* const input = {
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
*
|
|
162
|
+
* CopyTags: true,
|
|
163
|
+
* SourceDBClusterSnapshotIdentifier: "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:myaurora-2019-06-04-09-16",
|
|
164
|
+
* TargetDBClusterSnapshotIdentifier: "myclustersnapshotcopy"
|
|
165
165
|
* };
|
|
166
166
|
* const command = new CopyDBClusterSnapshotCommand(input);
|
|
167
167
|
* const response = await client.send(command);
|
|
168
|
-
* /* response
|
|
168
|
+
* /* response is
|
|
169
169
|
* {
|
|
170
|
-
*
|
|
171
|
-
*
|
|
172
|
-
*
|
|
170
|
+
* DBClusterSnapshot: {
|
|
171
|
+
* AllocatedStorage: 0,
|
|
172
|
+
* AvailabilityZones: [
|
|
173
173
|
* "us-east-1a",
|
|
174
174
|
* "us-east-1b",
|
|
175
175
|
* "us-east-1e"
|
|
176
176
|
* ],
|
|
177
|
-
*
|
|
178
|
-
*
|
|
179
|
-
*
|
|
180
|
-
*
|
|
181
|
-
*
|
|
182
|
-
*
|
|
183
|
-
*
|
|
184
|
-
*
|
|
185
|
-
*
|
|
186
|
-
*
|
|
187
|
-
*
|
|
188
|
-
*
|
|
189
|
-
*
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
*
|
|
193
|
-
*
|
|
177
|
+
* ClusterCreateTime: "2019-04-15T14:18:42.785Z",
|
|
178
|
+
* DBClusterIdentifier: "myaurora",
|
|
179
|
+
* DBClusterSnapshotArn: "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:myclustersnapshotcopy",
|
|
180
|
+
* DBClusterSnapshotIdentifier: "myclustersnapshotcopy",
|
|
181
|
+
* Engine: "aurora-mysql",
|
|
182
|
+
* EngineVersion: "5.7.mysql_aurora.2.04.2",
|
|
183
|
+
* IAMDatabaseAuthenticationEnabled: false,
|
|
184
|
+
* KmsKeyId: "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE",
|
|
185
|
+
* LicenseModel: "aurora-mysql",
|
|
186
|
+
* MasterUsername: "myadmin",
|
|
187
|
+
* PercentProgress: 100,
|
|
188
|
+
* Port: 0,
|
|
189
|
+
* SnapshotCreateTime: "2019-06-04T09:16:42.649Z",
|
|
190
|
+
* SnapshotType: "manual",
|
|
191
|
+
* Status: "available",
|
|
192
|
+
* StorageEncrypted: true,
|
|
193
|
+
* VpcId: "vpc-123example"
|
|
194
194
|
* }
|
|
195
195
|
* }
|
|
196
196
|
* *\/
|
|
197
|
-
* // example id: to-copy-a-db-cluster-snapshot-1679695109979
|
|
198
197
|
* ```
|
|
199
198
|
*
|
|
199
|
+
* @public
|
|
200
200
|
*/
|
|
201
201
|
export declare class CopyDBClusterSnapshotCommand extends CopyDBClusterSnapshotCommand_base {
|
|
202
202
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -83,30 +83,30 @@ declare const CopyDBParameterGroupCommand_base: {
|
|
|
83
83
|
* @throws {@link RDSServiceException}
|
|
84
84
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
85
85
|
*
|
|
86
|
-
*
|
|
86
|
+
*
|
|
87
87
|
* @example To copy a DB parameter group
|
|
88
88
|
* ```javascript
|
|
89
89
|
* // The following example makes a copy of a DB parameter group.
|
|
90
90
|
* const input = {
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
91
|
+
* SourceDBParameterGroupIdentifier: "mydbpg",
|
|
92
|
+
* TargetDBParameterGroupDescription: "Copy of mydbpg parameter group",
|
|
93
|
+
* TargetDBParameterGroupIdentifier: "mydbpgcopy"
|
|
94
94
|
* };
|
|
95
95
|
* const command = new CopyDBParameterGroupCommand(input);
|
|
96
96
|
* const response = await client.send(command);
|
|
97
|
-
* /* response
|
|
97
|
+
* /* response is
|
|
98
98
|
* {
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
99
|
+
* DBParameterGroup: {
|
|
100
|
+
* DBParameterGroupArn: "arn:aws:rds:us-east-1:814387698303:pg:mydbpgcopy",
|
|
101
|
+
* DBParameterGroupFamily: "mysql5.7",
|
|
102
|
+
* DBParameterGroupName: "mydbpgcopy",
|
|
103
|
+
* Description: "Copy of mydbpg parameter group"
|
|
104
104
|
* }
|
|
105
105
|
* }
|
|
106
106
|
* *\/
|
|
107
|
-
* // example id: to-copy-a-db-parameter-group-1679695426993
|
|
108
107
|
* ```
|
|
109
108
|
*
|
|
109
|
+
* @public
|
|
110
110
|
*/
|
|
111
111
|
export declare class CopyDBParameterGroupCommand extends CopyDBParameterGroupCommand_base {
|
|
112
112
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -143,50 +143,50 @@ declare const CopyDBSnapshotCommand_base: {
|
|
|
143
143
|
* @throws {@link RDSServiceException}
|
|
144
144
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
145
145
|
*
|
|
146
|
-
*
|
|
146
|
+
*
|
|
147
147
|
* @example To copy a DB snapshot
|
|
148
148
|
* ```javascript
|
|
149
149
|
* // The following example creates a copy of a DB snapshot.
|
|
150
150
|
* const input = {
|
|
151
|
-
*
|
|
152
|
-
*
|
|
151
|
+
* SourceDBSnapshotIdentifier: "rds:database-mysql-2019-06-06-08-38",
|
|
152
|
+
* TargetDBSnapshotIdentifier: "mydbsnapshotcopy"
|
|
153
153
|
* };
|
|
154
154
|
* const command = new CopyDBSnapshotCommand(input);
|
|
155
155
|
* const response = await client.send(command);
|
|
156
|
-
* /* response
|
|
156
|
+
* /* response is
|
|
157
157
|
* {
|
|
158
|
-
*
|
|
159
|
-
*
|
|
160
|
-
*
|
|
161
|
-
*
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
*
|
|
165
|
-
*
|
|
166
|
-
*
|
|
167
|
-
*
|
|
168
|
-
*
|
|
169
|
-
*
|
|
170
|
-
*
|
|
171
|
-
*
|
|
172
|
-
*
|
|
173
|
-
*
|
|
174
|
-
*
|
|
175
|
-
*
|
|
176
|
-
*
|
|
177
|
-
*
|
|
178
|
-
*
|
|
179
|
-
*
|
|
180
|
-
*
|
|
181
|
-
*
|
|
182
|
-
*
|
|
183
|
-
*
|
|
158
|
+
* DBSnapshot: {
|
|
159
|
+
* AllocatedStorage: 100,
|
|
160
|
+
* AvailabilityZone: "us-east-1f",
|
|
161
|
+
* DBInstanceIdentifier: "database-mysql",
|
|
162
|
+
* DBSnapshotArn: "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshotcopy",
|
|
163
|
+
* DBSnapshotIdentifier: "mydbsnapshotcopy",
|
|
164
|
+
* DbiResourceId: "db-ZI7UJ5BLKMBYFGX7FDENCKADC4",
|
|
165
|
+
* Encrypted: true,
|
|
166
|
+
* Engine: "mysql",
|
|
167
|
+
* EngineVersion: "5.6.40",
|
|
168
|
+
* IAMDatabaseAuthenticationEnabled: false,
|
|
169
|
+
* InstanceCreateTime: "2019-04-30T15:45:53.663Z",
|
|
170
|
+
* Iops: 1000,
|
|
171
|
+
* KmsKeyId: "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE",
|
|
172
|
+
* LicenseModel: "general-public-license",
|
|
173
|
+
* MasterUsername: "admin",
|
|
174
|
+
* OptionGroupName: "default:mysql-5-6",
|
|
175
|
+
* PercentProgress: 0,
|
|
176
|
+
* Port: 3306,
|
|
177
|
+
* ProcessorFeatures: [],
|
|
178
|
+
* SnapshotType: "manual",
|
|
179
|
+
* SourceDBSnapshotIdentifier: "arn:aws:rds:us-east-1:123456789012:snapshot:rds:database-mysql-2019-06-06-08-38",
|
|
180
|
+
* SourceRegion: "us-east-1",
|
|
181
|
+
* Status: "creating",
|
|
182
|
+
* StorageType: "io1",
|
|
183
|
+
* VpcId: "vpc-6594f31c"
|
|
184
184
|
* }
|
|
185
185
|
* }
|
|
186
186
|
* *\/
|
|
187
|
-
* // example id: to-copy-a-db-snapshot-1679695661487
|
|
188
187
|
* ```
|
|
189
188
|
*
|
|
189
|
+
* @public
|
|
190
190
|
*/
|
|
191
191
|
export declare class CopyDBSnapshotCommand extends CopyDBSnapshotCommand_base {
|
|
192
192
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -117,33 +117,33 @@ declare const CopyOptionGroupCommand_base: {
|
|
|
117
117
|
* @throws {@link RDSServiceException}
|
|
118
118
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
119
119
|
*
|
|
120
|
-
*
|
|
120
|
+
*
|
|
121
121
|
* @example To copy an option group
|
|
122
122
|
* ```javascript
|
|
123
123
|
* // The following example makes a copy of an option group.
|
|
124
124
|
* const input = {
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
125
|
+
* SourceOptionGroupIdentifier: "myoptiongroup",
|
|
126
|
+
* TargetOptionGroupDescription: "My option group copy",
|
|
127
|
+
* TargetOptionGroupIdentifier: "new-option-group"
|
|
128
128
|
* };
|
|
129
129
|
* const command = new CopyOptionGroupCommand(input);
|
|
130
130
|
* const response = await client.send(command);
|
|
131
|
-
* /* response
|
|
131
|
+
* /* response is
|
|
132
132
|
* {
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
*
|
|
133
|
+
* OptionGroup: {
|
|
134
|
+
* AllowsVpcAndNonVpcInstanceMemberships: true,
|
|
135
|
+
* EngineName: "oracle-ee",
|
|
136
|
+
* MajorEngineVersion: "11.2",
|
|
137
|
+
* OptionGroupArn: "arn:aws:rds:us-east-1:123456789012:og:new-option-group",
|
|
138
|
+
* OptionGroupDescription: "My option group copy",
|
|
139
|
+
* OptionGroupName: "new-option-group",
|
|
140
|
+
* Options: []
|
|
141
141
|
* }
|
|
142
142
|
* }
|
|
143
143
|
* *\/
|
|
144
|
-
* // example id: to-copy-an-option-group-1679695800102
|
|
145
144
|
* ```
|
|
146
145
|
*
|
|
146
|
+
* @public
|
|
147
147
|
*/
|
|
148
148
|
export declare class CopyOptionGroupCommand extends CopyOptionGroupCommand_base {
|
|
149
149
|
/** @internal type navigation helper, not in runtime. */
|