@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.
Files changed (142) hide show
  1. package/dist-types/commands/AddRoleToDBClusterCommand.d.ts +4 -0
  2. package/dist-types/commands/AddRoleToDBInstanceCommand.d.ts +4 -0
  3. package/dist-types/commands/AddSourceIdentifierToSubscriptionCommand.d.ts +21 -0
  4. package/dist-types/commands/AddTagsToResourceCommand.d.ts +4 -0
  5. package/dist-types/commands/ApplyPendingMaintenanceActionCommand.d.ts +18 -0
  6. package/dist-types/commands/AuthorizeDBSecurityGroupIngressCommand.d.ts +26 -0
  7. package/dist-types/commands/BacktrackDBClusterCommand.d.ts +11 -0
  8. package/dist-types/commands/CancelExportTaskCommand.d.ts +23 -0
  9. package/dist-types/commands/CopyDBClusterParameterGroupCommand.d.ts +11 -0
  10. package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +37 -0
  11. package/dist-types/commands/CopyDBParameterGroupCommand.d.ts +11 -0
  12. package/dist-types/commands/CopyDBSnapshotCommand.d.ts +50 -0
  13. package/dist-types/commands/CopyOptionGroupCommand.d.ts +52 -0
  14. package/dist-types/commands/CreateBlueGreenDeploymentCommand.d.ts +34 -0
  15. package/dist-types/commands/CreateCustomDBEngineVersionCommand.d.ts +83 -0
  16. package/dist-types/commands/CreateDBClusterCommand.d.ts +151 -127
  17. package/dist-types/commands/CreateDBClusterEndpointCommand.d.ts +19 -0
  18. package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +11 -0
  19. package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +37 -0
  20. package/dist-types/commands/CreateDBInstanceCommand.d.ts +216 -0
  21. package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts +216 -0
  22. package/dist-types/commands/CreateDBParameterGroupCommand.d.ts +11 -0
  23. package/dist-types/commands/CreateDBProxyCommand.d.ts +35 -0
  24. package/dist-types/commands/CreateDBProxyEndpointCommand.d.ts +22 -0
  25. package/dist-types/commands/CreateDBSecurityGroupCommand.d.ts +26 -0
  26. package/dist-types/commands/CreateDBSnapshotCommand.d.ts +50 -0
  27. package/dist-types/commands/CreateDBSubnetGroupCommand.d.ts +27 -0
  28. package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +21 -0
  29. package/dist-types/commands/CreateGlobalClusterCommand.d.ts +31 -0
  30. package/dist-types/commands/CreateOptionGroupCommand.d.ts +52 -0
  31. package/dist-types/commands/DeleteBlueGreenDeploymentCommand.d.ts +34 -0
  32. package/dist-types/commands/DeleteCustomDBEngineVersionCommand.d.ts +83 -0
  33. package/dist-types/commands/DeleteDBClusterCommand.d.ts +151 -0
  34. package/dist-types/commands/DeleteDBClusterEndpointCommand.d.ts +19 -0
  35. package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +4 -0
  36. package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +37 -0
  37. package/dist-types/commands/DeleteDBInstanceAutomatedBackupCommand.d.ts +42 -0
  38. package/dist-types/commands/DeleteDBInstanceCommand.d.ts +216 -0
  39. package/dist-types/commands/DeleteDBParameterGroupCommand.d.ts +4 -0
  40. package/dist-types/commands/DeleteDBProxyCommand.d.ts +35 -0
  41. package/dist-types/commands/DeleteDBProxyEndpointCommand.d.ts +22 -0
  42. package/dist-types/commands/DeleteDBSecurityGroupCommand.d.ts +4 -0
  43. package/dist-types/commands/DeleteDBSnapshotCommand.d.ts +50 -0
  44. package/dist-types/commands/DeleteDBSubnetGroupCommand.d.ts +4 -0
  45. package/dist-types/commands/DeleteEventSubscriptionCommand.d.ts +21 -0
  46. package/dist-types/commands/DeleteGlobalClusterCommand.d.ts +31 -0
  47. package/dist-types/commands/DeleteOptionGroupCommand.d.ts +4 -0
  48. package/dist-types/commands/DeregisterDBProxyTargetsCommand.d.ts +4 -0
  49. package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +12 -0
  50. package/dist-types/commands/DescribeBlueGreenDeploymentsCommand.d.ts +37 -0
  51. package/dist-types/commands/DescribeCertificatesCommand.d.ts +18 -0
  52. package/dist-types/commands/DescribeDBClusterBacktracksCommand.d.ts +16 -0
  53. package/dist-types/commands/DescribeDBClusterEndpointsCommand.d.ts +24 -0
  54. package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +14 -0
  55. package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +23 -0
  56. package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +16 -0
  57. package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +40 -0
  58. package/dist-types/commands/DescribeDBClustersCommand.d.ts +154 -0
  59. package/dist-types/commands/DescribeDBEngineVersionsCommand.d.ts +88 -0
  60. package/dist-types/commands/DescribeDBInstanceAutomatedBackupsCommand.d.ts +45 -0
  61. package/dist-types/commands/DescribeDBInstancesCommand.d.ts +219 -0
  62. package/dist-types/commands/DescribeDBLogFilesCommand.d.ts +13 -0
  63. package/dist-types/commands/DescribeDBParameterGroupsCommand.d.ts +14 -0
  64. package/dist-types/commands/DescribeDBParametersCommand.d.ts +23 -0
  65. package/dist-types/commands/DescribeDBProxiesCommand.d.ts +38 -0
  66. package/dist-types/commands/DescribeDBProxyEndpointsCommand.d.ts +25 -0
  67. package/dist-types/commands/DescribeDBProxyTargetGroupsCommand.d.ts +26 -0
  68. package/dist-types/commands/DescribeDBProxyTargetsCommand.d.ts +22 -0
  69. package/dist-types/commands/DescribeDBSecurityGroupsCommand.d.ts +29 -0
  70. package/dist-types/commands/DescribeDBSnapshotAttributesCommand.d.ts +16 -0
  71. package/dist-types/commands/DescribeDBSnapshotsCommand.d.ts +53 -0
  72. package/dist-types/commands/DescribeDBSubnetGroupsCommand.d.ts +30 -0
  73. package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +26 -0
  74. package/dist-types/commands/DescribeEngineDefaultParametersCommand.d.ts +26 -0
  75. package/dist-types/commands/DescribeEventCategoriesCommand.d.ts +13 -0
  76. package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +24 -0
  77. package/dist-types/commands/DescribeEventsCommand.d.ts +18 -0
  78. package/dist-types/commands/DescribeExportTasksCommand.d.ts +28 -0
  79. package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +34 -0
  80. package/dist-types/commands/DescribeOptionGroupOptionsCommand.d.ts +52 -0
  81. package/dist-types/commands/DescribeOptionGroupsCommand.d.ts +55 -0
  82. package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +61 -0
  83. package/dist-types/commands/DescribePendingMaintenanceActionsCommand.d.ts +21 -0
  84. package/dist-types/commands/DescribeReservedDBInstancesCommand.d.ts +31 -0
  85. package/dist-types/commands/DescribeReservedDBInstancesOfferingsCommand.d.ts +25 -0
  86. package/dist-types/commands/DescribeSourceRegionsCommand.d.ts +14 -0
  87. package/dist-types/commands/DescribeValidDBInstanceModificationsCommand.d.ts +53 -0
  88. package/dist-types/commands/DownloadDBLogFilePortionCommand.d.ts +8 -0
  89. package/dist-types/commands/FailoverDBClusterCommand.d.ts +151 -0
  90. package/dist-types/commands/FailoverGlobalClusterCommand.d.ts +31 -0
  91. package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
  92. package/dist-types/commands/ModifyActivityStreamCommand.d.ts +11 -0
  93. package/dist-types/commands/ModifyCertificatesCommand.d.ts +15 -0
  94. package/dist-types/commands/ModifyCurrentDBClusterCapacityCommand.d.ts +10 -0
  95. package/dist-types/commands/ModifyCustomDBEngineVersionCommand.d.ts +83 -0
  96. package/dist-types/commands/ModifyDBClusterCommand.d.ts +151 -0
  97. package/dist-types/commands/ModifyDBClusterEndpointCommand.d.ts +19 -0
  98. package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +6 -0
  99. package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +16 -0
  100. package/dist-types/commands/ModifyDBInstanceCommand.d.ts +216 -49
  101. package/dist-types/commands/ModifyDBParameterGroupCommand.d.ts +6 -0
  102. package/dist-types/commands/ModifyDBProxyCommand.d.ts +35 -0
  103. package/dist-types/commands/ModifyDBProxyEndpointCommand.d.ts +22 -0
  104. package/dist-types/commands/ModifyDBProxyTargetGroupCommand.d.ts +23 -0
  105. package/dist-types/commands/ModifyDBSnapshotAttributeCommand.d.ts +16 -0
  106. package/dist-types/commands/ModifyDBSnapshotCommand.d.ts +50 -0
  107. package/dist-types/commands/ModifyDBSubnetGroupCommand.d.ts +27 -0
  108. package/dist-types/commands/ModifyEventSubscriptionCommand.d.ts +21 -0
  109. package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +31 -0
  110. package/dist-types/commands/ModifyOptionGroupCommand.d.ts +52 -0
  111. package/dist-types/commands/PromoteReadReplicaCommand.d.ts +216 -0
  112. package/dist-types/commands/PromoteReadReplicaDBClusterCommand.d.ts +151 -0
  113. package/dist-types/commands/PurchaseReservedDBInstancesOfferingCommand.d.ts +28 -0
  114. package/dist-types/commands/RebootDBClusterCommand.d.ts +151 -0
  115. package/dist-types/commands/RebootDBInstanceCommand.d.ts +216 -0
  116. package/dist-types/commands/RegisterDBProxyTargetsCommand.d.ts +21 -0
  117. package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +31 -0
  118. package/dist-types/commands/RemoveRoleFromDBClusterCommand.d.ts +4 -0
  119. package/dist-types/commands/RemoveRoleFromDBInstanceCommand.d.ts +4 -0
  120. package/dist-types/commands/RemoveSourceIdentifierFromSubscriptionCommand.d.ts +21 -0
  121. package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +4 -0
  122. package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +6 -0
  123. package/dist-types/commands/ResetDBParameterGroupCommand.d.ts +6 -0
  124. package/dist-types/commands/RestoreDBClusterFromS3Command.d.ts +151 -0
  125. package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +151 -0
  126. package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +151 -0
  127. package/dist-types/commands/RestoreDBInstanceFromDBSnapshotCommand.d.ts +216 -0
  128. package/dist-types/commands/RestoreDBInstanceFromS3Command.d.ts +216 -0
  129. package/dist-types/commands/RestoreDBInstanceToPointInTimeCommand.d.ts +216 -0
  130. package/dist-types/commands/RevokeDBSecurityGroupIngressCommand.d.ts +26 -0
  131. package/dist-types/commands/StartActivityStreamCommand.d.ts +11 -0
  132. package/dist-types/commands/StartDBClusterCommand.d.ts +151 -0
  133. package/dist-types/commands/StartDBInstanceAutomatedBackupsReplicationCommand.d.ts +42 -0
  134. package/dist-types/commands/StartDBInstanceCommand.d.ts +216 -0
  135. package/dist-types/commands/StartExportTaskCommand.d.ts +23 -0
  136. package/dist-types/commands/StopActivityStreamCommand.d.ts +8 -0
  137. package/dist-types/commands/StopDBClusterCommand.d.ts +151 -0
  138. package/dist-types/commands/StopDBInstanceAutomatedBackupsReplicationCommand.d.ts +42 -0
  139. package/dist-types/commands/StopDBInstanceCommand.d.ts +216 -0
  140. package/dist-types/commands/SwitchoverBlueGreenDeploymentCommand.d.ts +34 -0
  141. package/dist-types/commands/SwitchoverReadReplicaCommand.d.ts +216 -0
  142. package/package.json +17 -17
@@ -113,6 +113,155 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
113
113
  * };
114
114
  * const command = new CreateDBClusterCommand(input);
115
115
  * const response = await client.send(command);
116
+ * // { // CreateDBClusterResult
117
+ * // DBCluster: { // DBCluster
118
+ * // AllocatedStorage: Number("int"),
119
+ * // AvailabilityZones: [ // AvailabilityZones
120
+ * // "STRING_VALUE",
121
+ * // ],
122
+ * // BackupRetentionPeriod: Number("int"),
123
+ * // CharacterSetName: "STRING_VALUE",
124
+ * // DatabaseName: "STRING_VALUE",
125
+ * // DBClusterIdentifier: "STRING_VALUE",
126
+ * // DBClusterParameterGroup: "STRING_VALUE",
127
+ * // DBSubnetGroup: "STRING_VALUE",
128
+ * // Status: "STRING_VALUE",
129
+ * // AutomaticRestartTime: new Date("TIMESTAMP"),
130
+ * // PercentProgress: "STRING_VALUE",
131
+ * // EarliestRestorableTime: new Date("TIMESTAMP"),
132
+ * // Endpoint: "STRING_VALUE",
133
+ * // ReaderEndpoint: "STRING_VALUE",
134
+ * // CustomEndpoints: [ // StringList
135
+ * // "STRING_VALUE",
136
+ * // ],
137
+ * // MultiAZ: true || false,
138
+ * // Engine: "STRING_VALUE",
139
+ * // EngineVersion: "STRING_VALUE",
140
+ * // LatestRestorableTime: new Date("TIMESTAMP"),
141
+ * // Port: Number("int"),
142
+ * // MasterUsername: "STRING_VALUE",
143
+ * // DBClusterOptionGroupMemberships: [ // DBClusterOptionGroupMemberships
144
+ * // { // DBClusterOptionGroupStatus
145
+ * // DBClusterOptionGroupName: "STRING_VALUE",
146
+ * // Status: "STRING_VALUE",
147
+ * // },
148
+ * // ],
149
+ * // PreferredBackupWindow: "STRING_VALUE",
150
+ * // PreferredMaintenanceWindow: "STRING_VALUE",
151
+ * // ReplicationSourceIdentifier: "STRING_VALUE",
152
+ * // ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
153
+ * // "STRING_VALUE",
154
+ * // ],
155
+ * // DBClusterMembers: [ // DBClusterMemberList
156
+ * // { // DBClusterMember
157
+ * // DBInstanceIdentifier: "STRING_VALUE",
158
+ * // IsClusterWriter: true || false,
159
+ * // DBClusterParameterGroupStatus: "STRING_VALUE",
160
+ * // PromotionTier: Number("int"),
161
+ * // },
162
+ * // ],
163
+ * // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
164
+ * // { // VpcSecurityGroupMembership
165
+ * // VpcSecurityGroupId: "STRING_VALUE",
166
+ * // Status: "STRING_VALUE",
167
+ * // },
168
+ * // ],
169
+ * // HostedZoneId: "STRING_VALUE",
170
+ * // StorageEncrypted: true || false,
171
+ * // KmsKeyId: "STRING_VALUE",
172
+ * // DbClusterResourceId: "STRING_VALUE",
173
+ * // DBClusterArn: "STRING_VALUE",
174
+ * // AssociatedRoles: [ // DBClusterRoles
175
+ * // { // DBClusterRole
176
+ * // RoleArn: "STRING_VALUE",
177
+ * // Status: "STRING_VALUE",
178
+ * // FeatureName: "STRING_VALUE",
179
+ * // },
180
+ * // ],
181
+ * // IAMDatabaseAuthenticationEnabled: true || false,
182
+ * // CloneGroupId: "STRING_VALUE",
183
+ * // ClusterCreateTime: new Date("TIMESTAMP"),
184
+ * // EarliestBacktrackTime: new Date("TIMESTAMP"),
185
+ * // BacktrackWindow: Number("long"),
186
+ * // BacktrackConsumedChangeRecords: Number("long"),
187
+ * // EnabledCloudwatchLogsExports: [ // LogTypeList
188
+ * // "STRING_VALUE",
189
+ * // ],
190
+ * // Capacity: Number("int"),
191
+ * // EngineMode: "STRING_VALUE",
192
+ * // ScalingConfigurationInfo: { // ScalingConfigurationInfo
193
+ * // MinCapacity: Number("int"),
194
+ * // MaxCapacity: Number("int"),
195
+ * // AutoPause: true || false,
196
+ * // SecondsUntilAutoPause: Number("int"),
197
+ * // TimeoutAction: "STRING_VALUE",
198
+ * // SecondsBeforeTimeout: Number("int"),
199
+ * // },
200
+ * // DeletionProtection: true || false,
201
+ * // HttpEndpointEnabled: true || false,
202
+ * // ActivityStreamMode: "sync" || "async",
203
+ * // ActivityStreamStatus: "stopped" || "starting" || "started" || "stopping",
204
+ * // ActivityStreamKmsKeyId: "STRING_VALUE",
205
+ * // ActivityStreamKinesisStreamName: "STRING_VALUE",
206
+ * // CopyTagsToSnapshot: true || false,
207
+ * // CrossAccountClone: true || false,
208
+ * // DomainMemberships: [ // DomainMembershipList
209
+ * // { // DomainMembership
210
+ * // Domain: "STRING_VALUE",
211
+ * // Status: "STRING_VALUE",
212
+ * // FQDN: "STRING_VALUE",
213
+ * // IAMRoleName: "STRING_VALUE",
214
+ * // },
215
+ * // ],
216
+ * // TagList: [ // TagList
217
+ * // { // Tag
218
+ * // Key: "STRING_VALUE",
219
+ * // Value: "STRING_VALUE",
220
+ * // },
221
+ * // ],
222
+ * // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown",
223
+ * // GlobalWriteForwardingRequested: true || false,
224
+ * // PendingModifiedValues: { // ClusterPendingModifiedValues
225
+ * // PendingCloudwatchLogsExports: { // PendingCloudwatchLogsExports
226
+ * // LogTypesToEnable: [
227
+ * // "STRING_VALUE",
228
+ * // ],
229
+ * // LogTypesToDisable: [
230
+ * // "STRING_VALUE",
231
+ * // ],
232
+ * // },
233
+ * // DBClusterIdentifier: "STRING_VALUE",
234
+ * // MasterUserPassword: "STRING_VALUE",
235
+ * // IAMDatabaseAuthenticationEnabled: true || false,
236
+ * // EngineVersion: "STRING_VALUE",
237
+ * // BackupRetentionPeriod: Number("int"),
238
+ * // AllocatedStorage: Number("int"),
239
+ * // Iops: Number("int"),
240
+ * // },
241
+ * // DBClusterInstanceClass: "STRING_VALUE",
242
+ * // StorageType: "STRING_VALUE",
243
+ * // Iops: Number("int"),
244
+ * // PubliclyAccessible: true || false,
245
+ * // AutoMinorVersionUpgrade: true || false,
246
+ * // MonitoringInterval: Number("int"),
247
+ * // MonitoringRoleArn: "STRING_VALUE",
248
+ * // PerformanceInsightsEnabled: true || false,
249
+ * // PerformanceInsightsKMSKeyId: "STRING_VALUE",
250
+ * // PerformanceInsightsRetentionPeriod: Number("int"),
251
+ * // ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfigurationInfo
252
+ * // MinCapacity: Number("double"),
253
+ * // MaxCapacity: Number("double"),
254
+ * // },
255
+ * // NetworkType: "STRING_VALUE",
256
+ * // DBSystemId: "STRING_VALUE",
257
+ * // MasterUserSecret: { // MasterUserSecret
258
+ * // SecretArn: "STRING_VALUE",
259
+ * // SecretStatus: "STRING_VALUE",
260
+ * // KmsKeyId: "STRING_VALUE",
261
+ * // },
262
+ * // },
263
+ * // };
264
+ *
116
265
  * ```
117
266
  *
118
267
  * @param CreateDBClusterCommandInput - {@link CreateDBClusterCommandInput}
@@ -186,133 +335,8 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
186
335
  * <p>The request would result in the user exceeding the allowed amount of storage
187
336
  * available across all DB instances.</p>
188
337
  *
189
- *
190
- * @example To create a MySQL 5.7--compatible DB cluster
191
- * ```javascript
192
- * // The following example create a MySQL 5.7-compatible DB cluster.
193
- * const input = {
194
- * "DBClusterIdentifier": "sample-cluster",
195
- * "DBSubnetGroupName": "default",
196
- * "Engine": "aurora-mysql",
197
- * "EngineVersion": "5.7.12",
198
- * "MasterUserPassword": "mypassword",
199
- * "MasterUsername": "admin",
200
- * "VpcSecurityGroupIds": [
201
- * "sg-0b91305example"
202
- * ]
203
- * };
204
- * const command = new CreateDBClusterCommand(input);
205
- * const response = await client.send(command);
206
- * /* response ==
207
- * {
208
- * "DBCluster": {
209
- * "AllocatedStorage": 1,
210
- * "AssociatedRoles": [],
211
- * "AvailabilityZones": [
212
- * "us-east-1a",
213
- * "us-east-1b",
214
- * "us-east-1e"
215
- * ],
216
- * "BackupRetentionPeriod": 1,
217
- * "ClusterCreateTime": "2019-06-07T23:21:33.048Z",
218
- * "CopyTagsToSnapshot": false,
219
- * "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster",
220
- * "DBClusterIdentifier": "sample-cluster",
221
- * "DBClusterMembers": [],
222
- * "DBClusterParameterGroup": "default.aurora-mysql5.7",
223
- * "DBSubnetGroup": "default",
224
- * "DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE",
225
- * "DeletionProtection": false,
226
- * "Endpoint": "sample-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com",
227
- * "Engine": "aurora-mysql",
228
- * "EngineMode": "provisioned",
229
- * "EngineVersion": "5.7.12",
230
- * "HostedZoneId": "Z2R2ITUGPM61AM",
231
- * "HttpEndpointEnabled": false,
232
- * "IAMDatabaseAuthenticationEnabled": false,
233
- * "MasterUsername": "master",
234
- * "MultiAZ": false,
235
- * "Port": 3306,
236
- * "PreferredBackupWindow": "09:12-09:42",
237
- * "PreferredMaintenanceWindow": "mon:04:31-mon:05:01",
238
- * "ReadReplicaIdentifiers": [],
239
- * "ReaderEndpoint": "sample-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com",
240
- * "Status": "creating",
241
- * "StorageEncrypted": false,
242
- * "VpcSecurityGroups": [
243
- * {
244
- * "Status": "active",
245
- * "VpcSecurityGroupId": "sg-0b91305example"
246
- * }
247
- * ]
248
- * }
249
- * }
250
- * *\/
251
- * // example id: to-create-a-mysql-57--compatible-db-cluster-1679699416154
252
- * ```
253
- *
254
- * @example To create a PostgreSQL--compatible DB cluster
255
- * ```javascript
256
- * // The following creates a PostgreSQL-compatible DB cluster.
257
- * const input = {
258
- * "DBClusterIdentifier": "sample-pg-cluster",
259
- * "DBSubnetGroupName": "default",
260
- * "Engine": "aurora-postgresql",
261
- * "MasterUserPassword": "mypassword",
262
- * "MasterUsername": "admin",
263
- * "VpcSecurityGroupIds": [
264
- * "sg-0b91305example"
265
- * ]
266
- * };
267
- * const command = new CreateDBClusterCommand(input);
268
- * const response = await client.send(command);
269
- * /* response ==
270
- * {
271
- * "DBCluster": {
272
- * "AllocatedStorage": 1,
273
- * "AssociatedRoles": [],
274
- * "AvailabilityZones": [
275
- * "us-east-1a",
276
- * "us-east-1b",
277
- * "us-east-1c"
278
- * ],
279
- * "BackupRetentionPeriod": 1,
280
- * "ClusterCreateTime": "2019-06-07T23:26:08.371Z",
281
- * "CopyTagsToSnapshot": false,
282
- * "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-pg-cluster",
283
- * "DBClusterIdentifier": "sample-pg-cluster",
284
- * "DBClusterMembers": [],
285
- * "DBClusterParameterGroup": "default.aurora-postgresql9.6",
286
- * "DBSubnetGroup": "default",
287
- * "DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE",
288
- * "DeletionProtection": false,
289
- * "Endpoint": "sample-pg-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com",
290
- * "Engine": "aurora-postgresql",
291
- * "EngineMode": "provisioned",
292
- * "EngineVersion": "9.6.9",
293
- * "HostedZoneId": "Z2R2ITUGPM61AM",
294
- * "HttpEndpointEnabled": false,
295
- * "IAMDatabaseAuthenticationEnabled": false,
296
- * "MasterUsername": "master",
297
- * "MultiAZ": false,
298
- * "Port": 5432,
299
- * "PreferredBackupWindow": "09:56-10:26",
300
- * "PreferredMaintenanceWindow": "wed:03:33-wed:04:03",
301
- * "ReadReplicaIdentifiers": [],
302
- * "ReaderEndpoint": "sample-pg-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com",
303
- * "Status": "creating",
304
- * "StorageEncrypted": false,
305
- * "VpcSecurityGroups": [
306
- * {
307
- * "Status": "active",
308
- * "VpcSecurityGroupId": "sg-0b91305example"
309
- * }
310
- * ]
311
- * }
312
- * }
313
- * *\/
314
- * // example id: to-create-a-postgresql--compatible-db-cluster-1679700161087
315
- * ```
338
+ * @throws {@link RDSServiceException}
339
+ * <p>Base exception class for all service exceptions from RDS service.</p>
316
340
  *
317
341
  * @example To create a MySQL 5.7-compatible DB cluster
318
342
  * ```javascript
@@ -48,6 +48,23 @@ export interface CreateDBClusterEndpointCommandOutput extends DBClusterEndpoint,
48
48
  * };
49
49
  * const command = new CreateDBClusterEndpointCommand(input);
50
50
  * const response = await client.send(command);
51
+ * // { // DBClusterEndpoint
52
+ * // DBClusterEndpointIdentifier: "STRING_VALUE",
53
+ * // DBClusterIdentifier: "STRING_VALUE",
54
+ * // DBClusterEndpointResourceIdentifier: "STRING_VALUE",
55
+ * // Endpoint: "STRING_VALUE",
56
+ * // Status: "STRING_VALUE",
57
+ * // EndpointType: "STRING_VALUE",
58
+ * // CustomEndpointType: "STRING_VALUE",
59
+ * // StaticMembers: [ // StringList
60
+ * // "STRING_VALUE",
61
+ * // ],
62
+ * // ExcludedMembers: [
63
+ * // "STRING_VALUE",
64
+ * // ],
65
+ * // DBClusterEndpointArn: "STRING_VALUE",
66
+ * // };
67
+ *
51
68
  * ```
52
69
  *
53
70
  * @param CreateDBClusterEndpointCommandInput - {@link CreateDBClusterEndpointCommandInput}
@@ -76,6 +93,8 @@ export interface CreateDBClusterEndpointCommandOutput extends DBClusterEndpoint,
76
93
  * @throws {@link InvalidDBInstanceStateFault} (client fault)
77
94
  * <p>The DB instance isn't in a valid state.</p>
78
95
  *
96
+ * @throws {@link RDSServiceException}
97
+ * <p>Base exception class for all service exceptions from RDS service.</p>
79
98
  *
80
99
  * @example To create a custom DB cluster endpoint
81
100
  * ```javascript
@@ -68,6 +68,15 @@ export interface CreateDBClusterParameterGroupCommandOutput extends CreateDBClus
68
68
  * };
69
69
  * const command = new CreateDBClusterParameterGroupCommand(input);
70
70
  * const response = await client.send(command);
71
+ * // { // CreateDBClusterParameterGroupResult
72
+ * // DBClusterParameterGroup: { // DBClusterParameterGroup
73
+ * // DBClusterParameterGroupName: "STRING_VALUE",
74
+ * // DBParameterGroupFamily: "STRING_VALUE",
75
+ * // Description: "STRING_VALUE",
76
+ * // DBClusterParameterGroupArn: "STRING_VALUE",
77
+ * // },
78
+ * // };
79
+ *
71
80
  * ```
72
81
  *
73
82
  * @param CreateDBClusterParameterGroupCommandInput - {@link CreateDBClusterParameterGroupCommandInput}
@@ -83,6 +92,8 @@ export interface CreateDBClusterParameterGroupCommandOutput extends CreateDBClus
83
92
  * <p>The request would result in the user exceeding the allowed number of DB parameter
84
93
  * groups.</p>
85
94
  *
95
+ * @throws {@link RDSServiceException}
96
+ * <p>Base exception class for all service exceptions from RDS service.</p>
86
97
  *
87
98
  * @example To create a DB cluster parameter group
88
99
  * ```javascript
@@ -43,6 +43,41 @@ export interface CreateDBClusterSnapshotCommandOutput extends CreateDBClusterSna
43
43
  * };
44
44
  * const command = new CreateDBClusterSnapshotCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // CreateDBClusterSnapshotResult
47
+ * // DBClusterSnapshot: { // DBClusterSnapshot
48
+ * // AvailabilityZones: [ // AvailabilityZones
49
+ * // "STRING_VALUE",
50
+ * // ],
51
+ * // DBClusterSnapshotIdentifier: "STRING_VALUE",
52
+ * // DBClusterIdentifier: "STRING_VALUE",
53
+ * // SnapshotCreateTime: new Date("TIMESTAMP"),
54
+ * // Engine: "STRING_VALUE",
55
+ * // EngineMode: "STRING_VALUE",
56
+ * // AllocatedStorage: Number("int"),
57
+ * // Status: "STRING_VALUE",
58
+ * // Port: Number("int"),
59
+ * // VpcId: "STRING_VALUE",
60
+ * // ClusterCreateTime: new Date("TIMESTAMP"),
61
+ * // MasterUsername: "STRING_VALUE",
62
+ * // EngineVersion: "STRING_VALUE",
63
+ * // LicenseModel: "STRING_VALUE",
64
+ * // SnapshotType: "STRING_VALUE",
65
+ * // PercentProgress: Number("int"),
66
+ * // StorageEncrypted: true || false,
67
+ * // KmsKeyId: "STRING_VALUE",
68
+ * // DBClusterSnapshotArn: "STRING_VALUE",
69
+ * // SourceDBClusterSnapshotArn: "STRING_VALUE",
70
+ * // IAMDatabaseAuthenticationEnabled: true || false,
71
+ * // TagList: [ // TagList
72
+ * // { // Tag
73
+ * // Key: "STRING_VALUE",
74
+ * // Value: "STRING_VALUE",
75
+ * // },
76
+ * // ],
77
+ * // DBSystemId: "STRING_VALUE",
78
+ * // },
79
+ * // };
80
+ *
46
81
  * ```
47
82
  *
48
83
  * @param CreateDBClusterSnapshotCommandInput - {@link CreateDBClusterSnapshotCommandInput}
@@ -68,6 +103,8 @@ export interface CreateDBClusterSnapshotCommandOutput extends CreateDBClusterSna
68
103
  * <p>The request would result in the user exceeding the allowed number of DB
69
104
  * snapshots.</p>
70
105
  *
106
+ * @throws {@link RDSServiceException}
107
+ * <p>Base exception class for all service exceptions from RDS service.</p>
71
108
  *
72
109
  * @example To create a DB cluster snapshot
73
110
  * ```javascript
@@ -109,6 +109,220 @@ export interface CreateDBInstanceCommandOutput extends CreateDBInstanceResult, _
109
109
  * };
110
110
  * const command = new CreateDBInstanceCommand(input);
111
111
  * const response = await client.send(command);
112
+ * // { // CreateDBInstanceResult
113
+ * // DBInstance: { // DBInstance
114
+ * // DBInstanceIdentifier: "STRING_VALUE",
115
+ * // DBInstanceClass: "STRING_VALUE",
116
+ * // Engine: "STRING_VALUE",
117
+ * // DBInstanceStatus: "STRING_VALUE",
118
+ * // AutomaticRestartTime: new Date("TIMESTAMP"),
119
+ * // MasterUsername: "STRING_VALUE",
120
+ * // DBName: "STRING_VALUE",
121
+ * // Endpoint: { // Endpoint
122
+ * // Address: "STRING_VALUE",
123
+ * // Port: Number("int"),
124
+ * // HostedZoneId: "STRING_VALUE",
125
+ * // },
126
+ * // AllocatedStorage: Number("int"),
127
+ * // InstanceCreateTime: new Date("TIMESTAMP"),
128
+ * // PreferredBackupWindow: "STRING_VALUE",
129
+ * // BackupRetentionPeriod: Number("int"),
130
+ * // DBSecurityGroups: [ // DBSecurityGroupMembershipList
131
+ * // { // DBSecurityGroupMembership
132
+ * // DBSecurityGroupName: "STRING_VALUE",
133
+ * // Status: "STRING_VALUE",
134
+ * // },
135
+ * // ],
136
+ * // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
137
+ * // { // VpcSecurityGroupMembership
138
+ * // VpcSecurityGroupId: "STRING_VALUE",
139
+ * // Status: "STRING_VALUE",
140
+ * // },
141
+ * // ],
142
+ * // DBParameterGroups: [ // DBParameterGroupStatusList
143
+ * // { // DBParameterGroupStatus
144
+ * // DBParameterGroupName: "STRING_VALUE",
145
+ * // ParameterApplyStatus: "STRING_VALUE",
146
+ * // },
147
+ * // ],
148
+ * // AvailabilityZone: "STRING_VALUE",
149
+ * // DBSubnetGroup: { // DBSubnetGroup
150
+ * // DBSubnetGroupName: "STRING_VALUE",
151
+ * // DBSubnetGroupDescription: "STRING_VALUE",
152
+ * // VpcId: "STRING_VALUE",
153
+ * // SubnetGroupStatus: "STRING_VALUE",
154
+ * // Subnets: [ // SubnetList
155
+ * // { // Subnet
156
+ * // SubnetIdentifier: "STRING_VALUE",
157
+ * // SubnetAvailabilityZone: { // AvailabilityZone
158
+ * // Name: "STRING_VALUE",
159
+ * // },
160
+ * // SubnetOutpost: { // Outpost
161
+ * // Arn: "STRING_VALUE",
162
+ * // },
163
+ * // SubnetStatus: "STRING_VALUE",
164
+ * // },
165
+ * // ],
166
+ * // DBSubnetGroupArn: "STRING_VALUE",
167
+ * // SupportedNetworkTypes: [ // StringList
168
+ * // "STRING_VALUE",
169
+ * // ],
170
+ * // },
171
+ * // PreferredMaintenanceWindow: "STRING_VALUE",
172
+ * // PendingModifiedValues: { // PendingModifiedValues
173
+ * // DBInstanceClass: "STRING_VALUE",
174
+ * // AllocatedStorage: Number("int"),
175
+ * // MasterUserPassword: "STRING_VALUE",
176
+ * // Port: Number("int"),
177
+ * // BackupRetentionPeriod: Number("int"),
178
+ * // MultiAZ: true || false,
179
+ * // EngineVersion: "STRING_VALUE",
180
+ * // LicenseModel: "STRING_VALUE",
181
+ * // Iops: Number("int"),
182
+ * // DBInstanceIdentifier: "STRING_VALUE",
183
+ * // StorageType: "STRING_VALUE",
184
+ * // CACertificateIdentifier: "STRING_VALUE",
185
+ * // DBSubnetGroupName: "STRING_VALUE",
186
+ * // PendingCloudwatchLogsExports: { // PendingCloudwatchLogsExports
187
+ * // LogTypesToEnable: [ // LogTypeList
188
+ * // "STRING_VALUE",
189
+ * // ],
190
+ * // LogTypesToDisable: [
191
+ * // "STRING_VALUE",
192
+ * // ],
193
+ * // },
194
+ * // ProcessorFeatures: [ // ProcessorFeatureList
195
+ * // { // ProcessorFeature
196
+ * // Name: "STRING_VALUE",
197
+ * // Value: "STRING_VALUE",
198
+ * // },
199
+ * // ],
200
+ * // IAMDatabaseAuthenticationEnabled: true || false,
201
+ * // AutomationMode: "full" || "all-paused",
202
+ * // ResumeFullAutomationModeTime: new Date("TIMESTAMP"),
203
+ * // StorageThroughput: Number("int"),
204
+ * // },
205
+ * // LatestRestorableTime: new Date("TIMESTAMP"),
206
+ * // MultiAZ: true || false,
207
+ * // EngineVersion: "STRING_VALUE",
208
+ * // AutoMinorVersionUpgrade: true || false,
209
+ * // ReadReplicaSourceDBInstanceIdentifier: "STRING_VALUE",
210
+ * // ReadReplicaDBInstanceIdentifiers: [ // ReadReplicaDBInstanceIdentifierList
211
+ * // "STRING_VALUE",
212
+ * // ],
213
+ * // ReadReplicaDBClusterIdentifiers: [ // ReadReplicaDBClusterIdentifierList
214
+ * // "STRING_VALUE",
215
+ * // ],
216
+ * // ReplicaMode: "open-read-only" || "mounted",
217
+ * // LicenseModel: "STRING_VALUE",
218
+ * // Iops: Number("int"),
219
+ * // OptionGroupMemberships: [ // OptionGroupMembershipList
220
+ * // { // OptionGroupMembership
221
+ * // OptionGroupName: "STRING_VALUE",
222
+ * // Status: "STRING_VALUE",
223
+ * // },
224
+ * // ],
225
+ * // CharacterSetName: "STRING_VALUE",
226
+ * // NcharCharacterSetName: "STRING_VALUE",
227
+ * // SecondaryAvailabilityZone: "STRING_VALUE",
228
+ * // PubliclyAccessible: true || false,
229
+ * // StatusInfos: [ // DBInstanceStatusInfoList
230
+ * // { // DBInstanceStatusInfo
231
+ * // StatusType: "STRING_VALUE",
232
+ * // Normal: true || false,
233
+ * // Status: "STRING_VALUE",
234
+ * // Message: "STRING_VALUE",
235
+ * // },
236
+ * // ],
237
+ * // StorageType: "STRING_VALUE",
238
+ * // TdeCredentialArn: "STRING_VALUE",
239
+ * // DbInstancePort: Number("int"),
240
+ * // DBClusterIdentifier: "STRING_VALUE",
241
+ * // StorageEncrypted: true || false,
242
+ * // KmsKeyId: "STRING_VALUE",
243
+ * // DbiResourceId: "STRING_VALUE",
244
+ * // CACertificateIdentifier: "STRING_VALUE",
245
+ * // DomainMemberships: [ // DomainMembershipList
246
+ * // { // DomainMembership
247
+ * // Domain: "STRING_VALUE",
248
+ * // Status: "STRING_VALUE",
249
+ * // FQDN: "STRING_VALUE",
250
+ * // IAMRoleName: "STRING_VALUE",
251
+ * // },
252
+ * // ],
253
+ * // CopyTagsToSnapshot: true || false,
254
+ * // MonitoringInterval: Number("int"),
255
+ * // EnhancedMonitoringResourceArn: "STRING_VALUE",
256
+ * // MonitoringRoleArn: "STRING_VALUE",
257
+ * // PromotionTier: Number("int"),
258
+ * // DBInstanceArn: "STRING_VALUE",
259
+ * // Timezone: "STRING_VALUE",
260
+ * // IAMDatabaseAuthenticationEnabled: true || false,
261
+ * // PerformanceInsightsEnabled: true || false,
262
+ * // PerformanceInsightsKMSKeyId: "STRING_VALUE",
263
+ * // PerformanceInsightsRetentionPeriod: Number("int"),
264
+ * // EnabledCloudwatchLogsExports: [
265
+ * // "STRING_VALUE",
266
+ * // ],
267
+ * // ProcessorFeatures: [
268
+ * // {
269
+ * // Name: "STRING_VALUE",
270
+ * // Value: "STRING_VALUE",
271
+ * // },
272
+ * // ],
273
+ * // DeletionProtection: true || false,
274
+ * // AssociatedRoles: [ // DBInstanceRoles
275
+ * // { // DBInstanceRole
276
+ * // RoleArn: "STRING_VALUE",
277
+ * // FeatureName: "STRING_VALUE",
278
+ * // Status: "STRING_VALUE",
279
+ * // },
280
+ * // ],
281
+ * // ListenerEndpoint: {
282
+ * // Address: "STRING_VALUE",
283
+ * // Port: Number("int"),
284
+ * // HostedZoneId: "STRING_VALUE",
285
+ * // },
286
+ * // MaxAllocatedStorage: Number("int"),
287
+ * // TagList: [ // TagList
288
+ * // { // Tag
289
+ * // Key: "STRING_VALUE",
290
+ * // Value: "STRING_VALUE",
291
+ * // },
292
+ * // ],
293
+ * // DBInstanceAutomatedBackupsReplications: [ // DBInstanceAutomatedBackupsReplicationList
294
+ * // { // DBInstanceAutomatedBackupsReplication
295
+ * // DBInstanceAutomatedBackupsArn: "STRING_VALUE",
296
+ * // },
297
+ * // ],
298
+ * // CustomerOwnedIpEnabled: true || false,
299
+ * // AwsBackupRecoveryPointArn: "STRING_VALUE",
300
+ * // ActivityStreamStatus: "stopped" || "starting" || "started" || "stopping",
301
+ * // ActivityStreamKmsKeyId: "STRING_VALUE",
302
+ * // ActivityStreamKinesisStreamName: "STRING_VALUE",
303
+ * // ActivityStreamMode: "sync" || "async",
304
+ * // ActivityStreamEngineNativeAuditFieldsIncluded: true || false,
305
+ * // AutomationMode: "full" || "all-paused",
306
+ * // ResumeFullAutomationModeTime: new Date("TIMESTAMP"),
307
+ * // CustomIamInstanceProfile: "STRING_VALUE",
308
+ * // BackupTarget: "STRING_VALUE",
309
+ * // NetworkType: "STRING_VALUE",
310
+ * // ActivityStreamPolicyStatus: "locked" || "unlocked" || "locking-policy" || "unlocking-policy",
311
+ * // StorageThroughput: Number("int"),
312
+ * // DBSystemId: "STRING_VALUE",
313
+ * // MasterUserSecret: { // MasterUserSecret
314
+ * // SecretArn: "STRING_VALUE",
315
+ * // SecretStatus: "STRING_VALUE",
316
+ * // KmsKeyId: "STRING_VALUE",
317
+ * // },
318
+ * // CertificateDetails: { // CertificateDetails
319
+ * // CAIdentifier: "STRING_VALUE",
320
+ * // ValidTill: new Date("TIMESTAMP"),
321
+ * // },
322
+ * // ReadReplicaSourceDBClusterIdentifier: "STRING_VALUE",
323
+ * // },
324
+ * // };
325
+ *
112
326
  * ```
113
327
  *
114
328
  * @param CreateDBInstanceCommandInput - {@link CreateDBInstanceCommandInput}
@@ -195,6 +409,8 @@ export interface CreateDBInstanceCommandOutput extends CreateDBInstanceResult, _
195
409
  * <p>Storage of the <code>StorageType</code> specified can't be associated
196
410
  * with the DB instance.</p>
197
411
  *
412
+ * @throws {@link RDSServiceException}
413
+ * <p>Base exception class for all service exceptions from RDS service.</p>
198
414
  *
199
415
  * @example To create a DB instance
200
416
  * ```javascript