@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
|
@@ -90,45 +90,45 @@ declare const DescribeEventsCommand_base: {
|
|
|
90
90
|
* @throws {@link RDSServiceException}
|
|
91
91
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
92
92
|
*
|
|
93
|
-
*
|
|
93
|
+
*
|
|
94
94
|
* @example To describe events
|
|
95
95
|
* ```javascript
|
|
96
96
|
* // The following retrieves details for the events that have occurred for the specified DB instance.
|
|
97
97
|
* const input = {
|
|
98
|
-
*
|
|
99
|
-
*
|
|
98
|
+
* SourceIdentifier: "test-instance",
|
|
99
|
+
* SourceType: "db-instance"
|
|
100
100
|
* };
|
|
101
101
|
* const command = new DescribeEventsCommand(input);
|
|
102
102
|
* const response = await client.send(command);
|
|
103
|
-
* /* response
|
|
103
|
+
* /* response is
|
|
104
104
|
* {
|
|
105
|
-
*
|
|
105
|
+
* Events: [
|
|
106
106
|
* {
|
|
107
|
-
*
|
|
108
|
-
*
|
|
107
|
+
* Date: "2018-07-31T23:09:23.983Z",
|
|
108
|
+
* EventCategories: [
|
|
109
109
|
* "backup"
|
|
110
110
|
* ],
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
*
|
|
111
|
+
* Message: "Backing up DB instance",
|
|
112
|
+
* SourceArn: "arn:aws:rds:us-east-1:123456789012:db:test-instance",
|
|
113
|
+
* SourceIdentifier: "test-instance",
|
|
114
|
+
* SourceType: "db-instance"
|
|
115
115
|
* },
|
|
116
116
|
* {
|
|
117
|
-
*
|
|
118
|
-
*
|
|
117
|
+
* Date: "2018-07-31T23:15:13.049Z",
|
|
118
|
+
* EventCategories: [
|
|
119
119
|
* "backup"
|
|
120
120
|
* ],
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
121
|
+
* Message: "Finished DB Instance backup",
|
|
122
|
+
* SourceArn: "arn:aws:rds:us-east-1:123456789012:db:test-instance",
|
|
123
|
+
* SourceIdentifier: "test-instance",
|
|
124
|
+
* SourceType: "db-instance"
|
|
125
125
|
* }
|
|
126
126
|
* ]
|
|
127
127
|
* }
|
|
128
128
|
* *\/
|
|
129
|
-
* // example id: to-describe-events-1680281559411
|
|
130
129
|
* ```
|
|
131
130
|
*
|
|
131
|
+
* @public
|
|
132
132
|
*/
|
|
133
133
|
export declare class DescribeEventsCommand extends DescribeEventsCommand_base {
|
|
134
134
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -92,48 +92,48 @@ declare const DescribeExportTasksCommand_base: {
|
|
|
92
92
|
* @throws {@link RDSServiceException}
|
|
93
93
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
94
94
|
*
|
|
95
|
-
*
|
|
95
|
+
*
|
|
96
96
|
* @example To describe snapshot export tasks
|
|
97
97
|
* ```javascript
|
|
98
98
|
* // The following example returns information about snapshot exports to Amazon S3.
|
|
99
|
-
* const input = {};
|
|
99
|
+
* const input = { /* empty *\/ };
|
|
100
100
|
* const command = new DescribeExportTasksCommand(input);
|
|
101
101
|
* const response = await client.send(command);
|
|
102
|
-
* /* response
|
|
102
|
+
* /* response is
|
|
103
103
|
* {
|
|
104
|
-
*
|
|
104
|
+
* ExportTasks: [
|
|
105
105
|
* {
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
*
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
*
|
|
106
|
+
* ExportTaskIdentifier: "test-snapshot-export",
|
|
107
|
+
* IamRoleArn: "arn:aws:iam::123456789012:role/service-role/ExportRole",
|
|
108
|
+
* KmsKeyId: "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff",
|
|
109
|
+
* PercentProgress: 100,
|
|
110
|
+
* S3Bucket: "mybucket",
|
|
111
|
+
* S3Prefix: "",
|
|
112
|
+
* SnapshotTime: "2020-03-02T18:26:28.163Z",
|
|
113
|
+
* SourceArn: "arn:aws:rds:us-west-2:123456789012:snapshot:test-snapshot",
|
|
114
|
+
* Status: "COMPLETE",
|
|
115
|
+
* TaskEndTime: "2020-03-02T19:10:31.985Z",
|
|
116
|
+
* TaskStartTime: "2020-03-02T18:57:56.896Z",
|
|
117
|
+
* TotalExtractedDataInGB: 0
|
|
118
118
|
* },
|
|
119
119
|
* {
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
128
|
-
*
|
|
129
|
-
*
|
|
120
|
+
* ExportTaskIdentifier: "my-s3-export",
|
|
121
|
+
* IamRoleArn: "arn:aws:iam::123456789012:role/service-role/ExportRole",
|
|
122
|
+
* KmsKeyId: "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff",
|
|
123
|
+
* PercentProgress: 0,
|
|
124
|
+
* S3Bucket: "mybucket",
|
|
125
|
+
* S3Prefix: "",
|
|
126
|
+
* SnapshotTime: "2020-03-27T20:48:42.023Z",
|
|
127
|
+
* SourceArn: "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test",
|
|
128
|
+
* Status: "STARTING",
|
|
129
|
+
* TotalExtractedDataInGB: 0
|
|
130
130
|
* }
|
|
131
131
|
* ]
|
|
132
132
|
* }
|
|
133
133
|
* *\/
|
|
134
|
-
* // example id: to-describe-snapshot-export-tasks-1680282299489
|
|
135
134
|
* ```
|
|
136
135
|
*
|
|
136
|
+
* @public
|
|
137
137
|
*/
|
|
138
138
|
export declare class DescribeExportTasksCommand extends DescribeExportTasksCommand_base {
|
|
139
139
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -110,33 +110,33 @@ declare const DescribeGlobalClustersCommand_base: {
|
|
|
110
110
|
* @throws {@link RDSServiceException}
|
|
111
111
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
112
112
|
*
|
|
113
|
-
*
|
|
113
|
+
*
|
|
114
114
|
* @example To describe global DB clusters
|
|
115
115
|
* ```javascript
|
|
116
116
|
* // The following example lists Aurora global DB clusters in the current AWS Region.
|
|
117
|
-
* const input = {};
|
|
117
|
+
* const input = { /* empty *\/ };
|
|
118
118
|
* const command = new DescribeGlobalClustersCommand(input);
|
|
119
119
|
* const response = await client.send(command);
|
|
120
|
-
* /* response
|
|
120
|
+
* /* response is
|
|
121
121
|
* {
|
|
122
|
-
*
|
|
122
|
+
* GlobalClusters: [
|
|
123
123
|
* {
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
128
|
-
*
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
124
|
+
* DeletionProtection: false,
|
|
125
|
+
* Engine: "aurora-mysql",
|
|
126
|
+
* EngineVersion: "5.7.mysql_aurora.2.07.2",
|
|
127
|
+
* GlobalClusterArn: "arn:aws:rds::123456789012:global-cluster:myglobalcluster",
|
|
128
|
+
* GlobalClusterIdentifier: "myglobalcluster",
|
|
129
|
+
* GlobalClusterMembers: [],
|
|
130
|
+
* GlobalClusterResourceId: "cluster-f5982077e3b5aabb",
|
|
131
|
+
* Status: "available",
|
|
132
|
+
* StorageEncrypted: false
|
|
133
133
|
* }
|
|
134
134
|
* ]
|
|
135
135
|
* }
|
|
136
136
|
* *\/
|
|
137
|
-
* // example id: to-describe-global-db-clusters-1680282459184
|
|
138
137
|
* ```
|
|
139
138
|
*
|
|
139
|
+
* @public
|
|
140
140
|
*/
|
|
141
141
|
export declare class DescribeGlobalClustersCommand extends DescribeGlobalClustersCommand_base {
|
|
142
142
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -95,34 +95,34 @@ declare const DescribeIntegrationsCommand_base: {
|
|
|
95
95
|
* @throws {@link RDSServiceException}
|
|
96
96
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
97
97
|
*
|
|
98
|
-
*
|
|
98
|
+
*
|
|
99
99
|
* @example To describe a zero-ETL integration
|
|
100
100
|
* ```javascript
|
|
101
101
|
* // The following example retrieves information about a zero-ETL integration with Amazon Redshift.
|
|
102
102
|
* const input = {
|
|
103
|
-
*
|
|
103
|
+
* IntegrationIdentifier: "5b9f3d79-7392-4a3e-896c-58eaa1b53231"
|
|
104
104
|
* };
|
|
105
105
|
* const command = new DescribeIntegrationsCommand(input);
|
|
106
106
|
* const response = await client.send(command);
|
|
107
|
-
* /* response
|
|
107
|
+
* /* response is
|
|
108
108
|
* {
|
|
109
|
-
*
|
|
109
|
+
* Integrations: [
|
|
110
110
|
* {
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
*
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
111
|
+
* CreateTime: "2023-12-28T17:20:20.629Z",
|
|
112
|
+
* IntegrationArn: "arn:aws:rds:us-east-1:123456789012:integration:5b9f3d79-7392-4a3e-896c-58eaa1b53231",
|
|
113
|
+
* IntegrationName: "my-integration",
|
|
114
|
+
* KMSKeyId: "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa",
|
|
115
|
+
* SourceArn: "arn:aws:rds:us-east-1:123456789012:cluster:my-cluster",
|
|
116
|
+
* Status: "active",
|
|
117
|
+
* Tags: [],
|
|
118
|
+
* TargetArn: "arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8"
|
|
119
119
|
* }
|
|
120
120
|
* ]
|
|
121
121
|
* }
|
|
122
122
|
* *\/
|
|
123
|
-
* // example id: to-describe-a-zero-etl-integration-1679688377231
|
|
124
123
|
* ```
|
|
125
124
|
*
|
|
125
|
+
* @public
|
|
126
126
|
*/
|
|
127
127
|
export declare class DescribeIntegrationsCommand extends DescribeIntegrationsCommand_base {
|
|
128
128
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -111,57 +111,57 @@ declare const DescribeOptionGroupOptionsCommand_base: {
|
|
|
111
111
|
* @throws {@link RDSServiceException}
|
|
112
112
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
113
113
|
*
|
|
114
|
-
*
|
|
114
|
+
*
|
|
115
115
|
* @example To describe all available options
|
|
116
116
|
* ```javascript
|
|
117
117
|
* // The following example lists the options for an RDS for MySQL version 8.0 DB instance.
|
|
118
118
|
* const input = {
|
|
119
|
-
*
|
|
120
|
-
*
|
|
119
|
+
* EngineName: "mysql",
|
|
120
|
+
* MajorEngineVersion: "8.0"
|
|
121
121
|
* };
|
|
122
122
|
* const command = new DescribeOptionGroupOptionsCommand(input);
|
|
123
123
|
* const response = await client.send(command);
|
|
124
|
-
* /* response
|
|
124
|
+
* /* response is
|
|
125
125
|
* {
|
|
126
|
-
*
|
|
126
|
+
* OptionGroupOptions: [
|
|
127
127
|
* {
|
|
128
|
-
*
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
133
|
-
*
|
|
128
|
+
* Description: "MariaDB Audit Plugin",
|
|
129
|
+
* EngineName: "mysql",
|
|
130
|
+
* MajorEngineVersion: "8.0",
|
|
131
|
+
* MinimumRequiredMinorEngineVersion: "25",
|
|
132
|
+
* Name: "MARIADB_AUDIT_PLUGIN",
|
|
133
|
+
* OptionGroupOptionSettings: [
|
|
134
134
|
* {
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
*
|
|
135
|
+
* ApplyType: "DYNAMIC",
|
|
136
|
+
* IsModifiable: true,
|
|
137
|
+
* IsRequired: false,
|
|
138
|
+
* MinimumEngineVersionPerAllowedValue: [],
|
|
139
|
+
* SettingDescription: "Include specified users",
|
|
140
|
+
* SettingName: "SERVER_AUDIT_INCL_USERS"
|
|
141
141
|
* },
|
|
142
142
|
* {
|
|
143
|
-
*
|
|
144
|
-
*
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
*
|
|
143
|
+
* ApplyType: "DYNAMIC",
|
|
144
|
+
* IsModifiable: true,
|
|
145
|
+
* IsRequired: false,
|
|
146
|
+
* MinimumEngineVersionPerAllowedValue: [],
|
|
147
|
+
* SettingDescription: "Exclude specified users",
|
|
148
|
+
* SettingName: "SERVER_AUDIT_EXCL_USERS"
|
|
149
149
|
* }
|
|
150
150
|
* ],
|
|
151
|
-
*
|
|
152
|
-
*
|
|
153
|
-
*
|
|
154
|
-
*
|
|
155
|
-
*
|
|
156
|
-
*
|
|
157
|
-
*
|
|
151
|
+
* OptionsConflictsWith: [],
|
|
152
|
+
* OptionsDependedOn: [],
|
|
153
|
+
* Permanent: false,
|
|
154
|
+
* Persistent: false,
|
|
155
|
+
* PortRequired: false,
|
|
156
|
+
* RequiresAutoMinorEngineVersionUpgrade: false,
|
|
157
|
+
* VpcOnly: false
|
|
158
158
|
* }
|
|
159
159
|
* ]
|
|
160
160
|
* }
|
|
161
161
|
* *\/
|
|
162
|
-
* // example id: to-describe-all-available-options-1680286049492
|
|
163
162
|
* ```
|
|
164
163
|
*
|
|
164
|
+
* @public
|
|
165
165
|
*/
|
|
166
166
|
export declare class DescribeOptionGroupOptionsCommand extends DescribeOptionGroupOptionsCommand_base {
|
|
167
167
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -118,34 +118,34 @@ declare const DescribeOptionGroupsCommand_base: {
|
|
|
118
118
|
* @throws {@link RDSServiceException}
|
|
119
119
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
120
120
|
*
|
|
121
|
-
*
|
|
121
|
+
*
|
|
122
122
|
* @example To describe the available option groups
|
|
123
123
|
* ```javascript
|
|
124
124
|
* // The following example lists the options groups for an Oracle Database 19c instance.
|
|
125
125
|
* const input = {
|
|
126
|
-
*
|
|
127
|
-
*
|
|
126
|
+
* EngineName: "oracle-ee",
|
|
127
|
+
* MajorEngineVersion: "19"
|
|
128
128
|
* };
|
|
129
129
|
* const command = new DescribeOptionGroupsCommand(input);
|
|
130
130
|
* const response = await client.send(command);
|
|
131
|
-
* /* response
|
|
131
|
+
* /* response is
|
|
132
132
|
* {
|
|
133
|
-
*
|
|
133
|
+
* OptionGroupsList: [
|
|
134
134
|
* {
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
*
|
|
135
|
+
* AllowsVpcAndNonVpcInstanceMemberships: true,
|
|
136
|
+
* EngineName: "oracle-ee",
|
|
137
|
+
* MajorEngineVersion: "19",
|
|
138
|
+
* OptionGroupArn: "arn:aws:rds:us-west-1:111122223333:og:default:oracle-ee-19",
|
|
139
|
+
* OptionGroupDescription: "Default option group for oracle-ee 19",
|
|
140
|
+
* OptionGroupName: "default:oracle-ee-19",
|
|
141
|
+
* Options: []
|
|
142
142
|
* }
|
|
143
143
|
* ]
|
|
144
144
|
* }
|
|
145
145
|
* *\/
|
|
146
|
-
* // example id: to-describe-the-available-option-groups-1680283066000
|
|
147
146
|
* ```
|
|
148
147
|
*
|
|
148
|
+
* @public
|
|
149
149
|
*/
|
|
150
150
|
export declare class DescribeOptionGroupsCommand extends DescribeOptionGroupsCommand_base {
|
|
151
151
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -125,55 +125,55 @@ declare const DescribeOrderableDBInstanceOptionsCommand_base: {
|
|
|
125
125
|
* @throws {@link RDSServiceException}
|
|
126
126
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
127
127
|
*
|
|
128
|
-
*
|
|
128
|
+
*
|
|
129
129
|
* @example To describe orderable DB instance options
|
|
130
130
|
* ```javascript
|
|
131
131
|
* // The following example retrieves details about the orderable options for a DB instances running the MySQL DB engine.
|
|
132
132
|
* const input = {
|
|
133
|
-
*
|
|
133
|
+
* Engine: "mysql"
|
|
134
134
|
* };
|
|
135
135
|
* const command = new DescribeOrderableDBInstanceOptionsCommand(input);
|
|
136
136
|
* const response = await client.send(command);
|
|
137
|
-
* /* response
|
|
137
|
+
* /* response is
|
|
138
138
|
* {
|
|
139
|
-
*
|
|
139
|
+
* OrderableDBInstanceOptions: [
|
|
140
140
|
* {
|
|
141
|
-
*
|
|
141
|
+
* AvailabilityZones: [
|
|
142
142
|
* {
|
|
143
|
-
*
|
|
143
|
+
* Name: "us-east-1a"
|
|
144
144
|
* },
|
|
145
145
|
* {
|
|
146
|
-
*
|
|
146
|
+
* Name: "us-east-1b"
|
|
147
147
|
* },
|
|
148
148
|
* {
|
|
149
|
-
*
|
|
149
|
+
* Name: "us-east-1c"
|
|
150
150
|
* },
|
|
151
151
|
* {
|
|
152
|
-
*
|
|
152
|
+
* Name: "us-east-1d"
|
|
153
153
|
* },
|
|
154
154
|
* {
|
|
155
|
-
*
|
|
155
|
+
* Name: "us-east-1e"
|
|
156
156
|
* },
|
|
157
157
|
* {
|
|
158
|
-
*
|
|
158
|
+
* Name: "us-east-1f"
|
|
159
159
|
* }
|
|
160
160
|
* ],
|
|
161
|
-
*
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
*
|
|
165
|
-
*
|
|
166
|
-
*
|
|
167
|
-
*
|
|
168
|
-
*
|
|
169
|
-
*
|
|
161
|
+
* DBInstanceClass: "db.m4.10xlarge",
|
|
162
|
+
* Engine: "mysql",
|
|
163
|
+
* EngineVersion: "5.7.33",
|
|
164
|
+
* LicenseModel: "general-public-license",
|
|
165
|
+
* MultiAZCapable: true,
|
|
166
|
+
* ReadReplicaCapable: true,
|
|
167
|
+
* StorageType: "gp2",
|
|
168
|
+
* SupportsStorageEncryption: true,
|
|
169
|
+
* Vpc: true
|
|
170
170
|
* }
|
|
171
171
|
* ]
|
|
172
172
|
* }
|
|
173
173
|
* *\/
|
|
174
|
-
* // example id: to-describe-orderable-db-instance-options-1680283253165
|
|
175
174
|
* ```
|
|
176
175
|
*
|
|
176
|
+
* @public
|
|
177
177
|
*/
|
|
178
178
|
export declare class DescribeOrderableDBInstanceOptionsCommand extends DescribeOrderableDBInstanceOptionsCommand_base {
|
|
179
179
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -87,31 +87,31 @@ declare const DescribePendingMaintenanceActionsCommand_base: {
|
|
|
87
87
|
* @throws {@link RDSServiceException}
|
|
88
88
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
89
89
|
*
|
|
90
|
-
*
|
|
90
|
+
*
|
|
91
91
|
* @example To list resources with at least one pending maintenance action
|
|
92
92
|
* ```javascript
|
|
93
93
|
* // The following example lists the pending maintenace action for a DB instance.
|
|
94
|
-
* const input = {};
|
|
94
|
+
* const input = { /* empty *\/ };
|
|
95
95
|
* const command = new DescribePendingMaintenanceActionsCommand(input);
|
|
96
96
|
* const response = await client.send(command);
|
|
97
|
-
* /* response
|
|
97
|
+
* /* response is
|
|
98
98
|
* {
|
|
99
|
-
*
|
|
99
|
+
* PendingMaintenanceActions: [
|
|
100
100
|
* {
|
|
101
|
-
*
|
|
101
|
+
* PendingMaintenanceActionDetails: [
|
|
102
102
|
* {
|
|
103
|
-
*
|
|
104
|
-
*
|
|
103
|
+
* Action: "system-update",
|
|
104
|
+
* Description: "Upgrade to Aurora PostgreSQL 2.4.2"
|
|
105
105
|
* }
|
|
106
106
|
* ],
|
|
107
|
-
*
|
|
107
|
+
* ResourceIdentifier: "arn:aws:rds:us-west-2:123456789012:cluster:global-db1-cl1"
|
|
108
108
|
* }
|
|
109
109
|
* ]
|
|
110
110
|
* }
|
|
111
111
|
* *\/
|
|
112
|
-
* // example id: to-list-resources-with-at-least-one-pending-maintenance-action-1680283544475
|
|
113
112
|
* ```
|
|
114
113
|
*
|
|
114
|
+
* @public
|
|
115
115
|
*/
|
|
116
116
|
export declare class DescribePendingMaintenanceActionsCommand extends DescribePendingMaintenanceActionsCommand_base {
|
|
117
117
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -99,45 +99,45 @@ declare const DescribeReservedDBInstancesCommand_base: {
|
|
|
99
99
|
* @throws {@link RDSServiceException}
|
|
100
100
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
101
101
|
*
|
|
102
|
-
*
|
|
102
|
+
*
|
|
103
103
|
* @example To describe reserved DB instances
|
|
104
104
|
* ```javascript
|
|
105
105
|
* // The following example retrieves details about any reserved DB instances in the current AWS account.
|
|
106
|
-
* const input = {};
|
|
106
|
+
* const input = { /* empty *\/ };
|
|
107
107
|
* const command = new DescribeReservedDBInstancesCommand(input);
|
|
108
108
|
* const response = await client.send(command);
|
|
109
|
-
* /* response
|
|
109
|
+
* /* response is
|
|
110
110
|
* {
|
|
111
|
-
*
|
|
111
|
+
* ReservedDBInstances: [
|
|
112
112
|
* {
|
|
113
|
-
*
|
|
114
|
-
*
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
113
|
+
* CurrencyCode: "USD",
|
|
114
|
+
* DBInstanceClass: "db.t3.micro",
|
|
115
|
+
* DBInstanceCount: 1,
|
|
116
|
+
* Duration: 31536000,
|
|
117
|
+
* FixedPrice: 0,
|
|
118
|
+
* LeaseId: "a1b2c3d4-6b69-4a59-be89-5e11aa446666",
|
|
119
|
+
* MultiAZ: false,
|
|
120
|
+
* OfferingType: "No Upfront",
|
|
121
|
+
* ProductDescription: "sqlserver-ex(li)",
|
|
122
|
+
* RecurringCharges: [
|
|
123
123
|
* {
|
|
124
|
-
*
|
|
125
|
-
*
|
|
124
|
+
* RecurringChargeAmount: 0.014,
|
|
125
|
+
* RecurringChargeFrequency: "Hourly"
|
|
126
126
|
* }
|
|
127
127
|
* ],
|
|
128
|
-
*
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
133
|
-
*
|
|
128
|
+
* ReservedDBInstanceArn: "arn:aws:rds:us-west-2:123456789012:ri:myreservedinstance",
|
|
129
|
+
* ReservedDBInstanceId: "myreservedinstance",
|
|
130
|
+
* ReservedDBInstancesOfferingId: "12ab34cd-59af-4b2c-a660-1abcdef23456",
|
|
131
|
+
* StartTime: "2020-06-01T13:44:21.436Z",
|
|
132
|
+
* State: "payment-pending",
|
|
133
|
+
* UsagePrice: 0
|
|
134
134
|
* }
|
|
135
135
|
* ]
|
|
136
136
|
* }
|
|
137
137
|
* *\/
|
|
138
|
-
* // example id: to-describe-reserved-db-instances-1680283668105
|
|
139
138
|
* ```
|
|
140
139
|
*
|
|
140
|
+
* @public
|
|
141
141
|
*/
|
|
142
142
|
export declare class DescribeReservedDBInstancesCommand extends DescribeReservedDBInstancesCommand_base {
|
|
143
143
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -91,41 +91,41 @@ declare const DescribeReservedDBInstancesOfferingsCommand_base: {
|
|
|
91
91
|
* @throws {@link RDSServiceException}
|
|
92
92
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
93
93
|
*
|
|
94
|
-
*
|
|
94
|
+
*
|
|
95
95
|
* @example To describe reserved DB instance offerings
|
|
96
96
|
* ```javascript
|
|
97
97
|
* // The following example retrieves details about reserved DB instance options for RDS for Oracle.
|
|
98
98
|
* const input = {
|
|
99
|
-
*
|
|
99
|
+
* ProductDescription: "oracle"
|
|
100
100
|
* };
|
|
101
101
|
* const command = new DescribeReservedDBInstancesOfferingsCommand(input);
|
|
102
102
|
* const response = await client.send(command);
|
|
103
|
-
* /* response
|
|
103
|
+
* /* response is
|
|
104
104
|
* {
|
|
105
|
-
*
|
|
105
|
+
* ReservedDBInstancesOfferings: [
|
|
106
106
|
* {
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
*
|
|
107
|
+
* CurrencyCode: "USD",
|
|
108
|
+
* DBInstanceClass: "db.m4.xlarge",
|
|
109
|
+
* Duration: 31536000,
|
|
110
|
+
* FixedPrice: 4089,
|
|
111
|
+
* MultiAZ: true,
|
|
112
|
+
* OfferingType: "Partial Upfront",
|
|
113
|
+
* ProductDescription: "oracle-se2(li)",
|
|
114
|
+
* RecurringCharges: [
|
|
115
115
|
* {
|
|
116
|
-
*
|
|
117
|
-
*
|
|
116
|
+
* RecurringChargeAmount: 0.594,
|
|
117
|
+
* RecurringChargeFrequency: "Hourly"
|
|
118
118
|
* }
|
|
119
119
|
* ],
|
|
120
|
-
*
|
|
121
|
-
*
|
|
120
|
+
* ReservedDBInstancesOfferingId: "005bdee3-9ef4-4182-aa0c-58ef7cb6c2f8",
|
|
121
|
+
* UsagePrice: 0
|
|
122
122
|
* }
|
|
123
123
|
* ]
|
|
124
124
|
* }
|
|
125
125
|
* *\/
|
|
126
|
-
* // example id: to-describe-reserved-db-instance-offerings-1680283755054
|
|
127
126
|
* ```
|
|
128
127
|
*
|
|
128
|
+
* @public
|
|
129
129
|
*/
|
|
130
130
|
export declare class DescribeReservedDBInstancesOfferingsCommand extends DescribeReservedDBInstancesOfferingsCommand_base {
|
|
131
131
|
/** @internal type navigation helper, not in runtime. */
|