@aws-sdk/client-rds 3.439.0 → 3.445.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 (117) hide show
  1. package/README.md +40 -0
  2. package/dist-cjs/RDS.js +10 -0
  3. package/dist-cjs/commands/CreateTenantDatabaseCommand.js +52 -0
  4. package/dist-cjs/commands/DeleteTenantDatabaseCommand.js +52 -0
  5. package/dist-cjs/commands/DescribeDBSnapshotTenantDatabasesCommand.js +51 -0
  6. package/dist-cjs/commands/DescribeTenantDatabasesCommand.js +52 -0
  7. package/dist-cjs/commands/ModifyTenantDatabaseCommand.js +52 -0
  8. package/dist-cjs/commands/index.js +5 -0
  9. package/dist-cjs/models/models_0.js +83 -20
  10. package/dist-cjs/models/models_1.js +37 -1
  11. package/dist-cjs/pagination/DescribeDBSnapshotTenantDatabasesPaginator.js +29 -0
  12. package/dist-cjs/pagination/DescribeTenantDatabasesPaginator.js +29 -0
  13. package/dist-cjs/pagination/index.js +2 -0
  14. package/dist-cjs/protocols/Aws_query.js +700 -7
  15. package/dist-cjs/waiters/index.js +2 -0
  16. package/dist-cjs/waiters/waitForTenantDatabaseAvailable.js +89 -0
  17. package/dist-cjs/waiters/waitForTenantDatabaseDeleted.js +39 -0
  18. package/dist-es/RDS.js +10 -0
  19. package/dist-es/commands/CreateTenantDatabaseCommand.js +48 -0
  20. package/dist-es/commands/DeleteTenantDatabaseCommand.js +48 -0
  21. package/dist-es/commands/DescribeDBSnapshotTenantDatabasesCommand.js +47 -0
  22. package/dist-es/commands/DescribeTenantDatabasesCommand.js +48 -0
  23. package/dist-es/commands/ModifyTenantDatabaseCommand.js +48 -0
  24. package/dist-es/commands/index.js +5 -0
  25. package/dist-es/models/models_0.js +71 -16
  26. package/dist-es/models/models_1.js +32 -0
  27. package/dist-es/pagination/DescribeDBSnapshotTenantDatabasesPaginator.js +25 -0
  28. package/dist-es/pagination/DescribeTenantDatabasesPaginator.js +25 -0
  29. package/dist-es/pagination/index.js +2 -0
  30. package/dist-es/protocols/Aws_query.js +684 -2
  31. package/dist-es/waiters/index.js +2 -0
  32. package/dist-es/waiters/waitForTenantDatabaseAvailable.js +84 -0
  33. package/dist-es/waiters/waitForTenantDatabaseDeleted.js +34 -0
  34. package/dist-types/RDS.d.ts +35 -0
  35. package/dist-types/RDSClient.d.ts +7 -2
  36. package/dist-types/commands/AddTagsToResourceCommand.d.ts +6 -0
  37. package/dist-types/commands/CopyDBSnapshotCommand.d.ts +1 -0
  38. package/dist-types/commands/CreateDBClusterCommand.d.ts +12 -0
  39. package/dist-types/commands/CreateDBInstanceCommand.d.ts +7 -0
  40. package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts +6 -0
  41. package/dist-types/commands/CreateDBSnapshotCommand.d.ts +1 -0
  42. package/dist-types/commands/CreateTenantDatabaseCommand.d.ts +122 -0
  43. package/dist-types/commands/DeleteDBClusterCommand.d.ts +8 -0
  44. package/dist-types/commands/DeleteDBInstanceAutomatedBackupCommand.d.ts +1 -0
  45. package/dist-types/commands/DeleteDBInstanceCommand.d.ts +2 -0
  46. package/dist-types/commands/DeleteDBSnapshotCommand.d.ts +1 -0
  47. package/dist-types/commands/DeleteTenantDatabaseCommand.d.ts +111 -0
  48. package/dist-types/commands/DescribeDBClusterAutomatedBackupsCommand.d.ts +2 -1
  49. package/dist-types/commands/DescribeDBClusterBacktracksCommand.d.ts +1 -1
  50. package/dist-types/commands/DescribeDBClusterEndpointsCommand.d.ts +1 -1
  51. package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +1 -1
  52. package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +1 -2
  53. package/dist-types/commands/DescribeDBClustersCommand.d.ts +8 -0
  54. package/dist-types/commands/DescribeDBInstanceAutomatedBackupsCommand.d.ts +1 -0
  55. package/dist-types/commands/DescribeDBInstancesCommand.d.ts +2 -0
  56. package/dist-types/commands/DescribeDBSnapshotTenantDatabasesCommand.d.ts +117 -0
  57. package/dist-types/commands/DescribeDBSnapshotsCommand.d.ts +1 -0
  58. package/dist-types/commands/DescribeTenantDatabasesCommand.d.ts +114 -0
  59. package/dist-types/commands/FailoverDBClusterCommand.d.ts +8 -0
  60. package/dist-types/commands/ListTagsForResourceCommand.d.ts +6 -0
  61. package/dist-types/commands/ModifyDBClusterCommand.d.ts +8 -0
  62. package/dist-types/commands/ModifyDBInstanceCommand.d.ts +7 -0
  63. package/dist-types/commands/ModifyDBSnapshotCommand.d.ts +1 -0
  64. package/dist-types/commands/ModifyTenantDatabaseCommand.d.ts +114 -0
  65. package/dist-types/commands/PromoteReadReplicaCommand.d.ts +2 -0
  66. package/dist-types/commands/PromoteReadReplicaDBClusterCommand.d.ts +8 -0
  67. package/dist-types/commands/RebootDBClusterCommand.d.ts +8 -0
  68. package/dist-types/commands/RebootDBInstanceCommand.d.ts +2 -0
  69. package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +6 -0
  70. package/dist-types/commands/RestoreDBClusterFromS3Command.d.ts +8 -0
  71. package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +12 -0
  72. package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +12 -0
  73. package/dist-types/commands/RestoreDBInstanceFromDBSnapshotCommand.d.ts +6 -0
  74. package/dist-types/commands/RestoreDBInstanceFromS3Command.d.ts +2 -0
  75. package/dist-types/commands/RestoreDBInstanceToPointInTimeCommand.d.ts +6 -0
  76. package/dist-types/commands/StartDBClusterCommand.d.ts +8 -0
  77. package/dist-types/commands/StartDBInstanceAutomatedBackupsReplicationCommand.d.ts +1 -0
  78. package/dist-types/commands/StartDBInstanceCommand.d.ts +2 -0
  79. package/dist-types/commands/StopDBClusterCommand.d.ts +8 -0
  80. package/dist-types/commands/StopDBInstanceAutomatedBackupsReplicationCommand.d.ts +1 -0
  81. package/dist-types/commands/StopDBInstanceCommand.d.ts +2 -0
  82. package/dist-types/commands/SwitchoverReadReplicaCommand.d.ts +2 -0
  83. package/dist-types/commands/index.d.ts +5 -0
  84. package/dist-types/index.d.ts +2 -0
  85. package/dist-types/models/models_0.d.ts +364 -408
  86. package/dist-types/models/models_1.d.ts +944 -117
  87. package/dist-types/pagination/DescribeDBSnapshotTenantDatabasesPaginator.d.ts +7 -0
  88. package/dist-types/pagination/DescribeTenantDatabasesPaginator.d.ts +7 -0
  89. package/dist-types/pagination/index.d.ts +2 -0
  90. package/dist-types/protocols/Aws_query.d.ts +45 -0
  91. package/dist-types/ts3.4/RDS.d.ts +91 -0
  92. package/dist-types/ts3.4/RDSClient.d.ts +30 -0
  93. package/dist-types/ts3.4/commands/CreateTenantDatabaseCommand.d.ts +42 -0
  94. package/dist-types/ts3.4/commands/DeleteTenantDatabaseCommand.d.ts +42 -0
  95. package/dist-types/ts3.4/commands/DescribeDBClusterAutomatedBackupsCommand.d.ts +2 -4
  96. package/dist-types/ts3.4/commands/DescribeDBClusterBacktracksCommand.d.ts +1 -1
  97. package/dist-types/ts3.4/commands/DescribeDBClusterEndpointsCommand.d.ts +1 -1
  98. package/dist-types/ts3.4/commands/DescribeDBClusterParameterGroupsCommand.d.ts +1 -1
  99. package/dist-types/ts3.4/commands/DescribeDBClusterParametersCommand.d.ts +4 -2
  100. package/dist-types/ts3.4/commands/DescribeDBSnapshotTenantDatabasesCommand.d.ts +42 -0
  101. package/dist-types/ts3.4/commands/DescribeTenantDatabasesCommand.d.ts +42 -0
  102. package/dist-types/ts3.4/commands/ModifyTenantDatabaseCommand.d.ts +42 -0
  103. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  104. package/dist-types/ts3.4/index.d.ts +2 -0
  105. package/dist-types/ts3.4/models/models_0.d.ts +104 -71
  106. package/dist-types/ts3.4/models/models_1.d.ts +136 -1
  107. package/dist-types/ts3.4/pagination/DescribeDBSnapshotTenantDatabasesPaginator.d.ts +11 -0
  108. package/dist-types/ts3.4/pagination/DescribeTenantDatabasesPaginator.d.ts +11 -0
  109. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  110. package/dist-types/ts3.4/protocols/Aws_query.d.ts +60 -0
  111. package/dist-types/ts3.4/waiters/index.d.ts +2 -0
  112. package/dist-types/ts3.4/waiters/waitForTenantDatabaseAvailable.d.ts +11 -0
  113. package/dist-types/ts3.4/waiters/waitForTenantDatabaseDeleted.d.ts +11 -0
  114. package/dist-types/waiters/index.d.ts +2 -0
  115. package/dist-types/waiters/waitForTenantDatabaseAvailable.d.ts +14 -0
  116. package/dist-types/waiters/waitForTenantDatabaseDeleted.d.ts +14 -0
  117. package/package.json +4 -4
@@ -1,6 +1,419 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
- import { ActivityStreamMode, ActivityStreamPolicyStatus, ActivityStreamStatus, AutomationMode, AvailabilityZone, BlueGreenDeployment, Certificate, DBCluster, DBClusterSnapshot, DBEngineVersion, DBInstance, DBInstanceAutomatedBackup, DBParameterGroup, DBProxy, DBProxyEndpoint, DBSecurityGroup, DBSnapshot, DBSubnetGroup, EventSubscription, ExportSourceType, ExportTask, Filter, GlobalCluster, Integration, OptionGroup, OptionSetting, Parameter, ProcessorFeature, ReplicaMode, ResourcePendingMaintenanceActions, ScalingConfiguration, ServerlessV2ScalingConfiguration, Tag, UserAuthConfig } from "./models_0";
2
+ import { ActivityStreamMode, ActivityStreamPolicyStatus, ActivityStreamStatus, AutomationMode, AvailabilityZone, BlueGreenDeployment, Certificate, DBCluster, DBClusterBacktrack, DBClusterEndpoint, DBClusterParameterGroup, DBClusterSnapshot, DBEngineVersion, DBInstance, DBInstanceAutomatedBackup, DBParameterGroup, DBProxy, DBProxyEndpoint, DBSecurityGroup, DBSnapshot, DBSubnetGroup, EventSubscription, ExportSourceType, ExportTask, Filter, GlobalCluster, Integration, OptionGroup, OptionSetting, ProcessorFeature, RdsCustomClusterConfiguration, ReplicaMode, ResourcePendingMaintenanceActions, ScalingConfiguration, ServerlessV2ScalingConfiguration, Tag, TenantDatabase, UserAuthConfig } from "./models_0";
3
3
  import { RDSServiceException as __BaseException } from "./RDSServiceException";
4
+ /**
5
+ * @public
6
+ */
7
+ export interface DescribeDBClusterAutomatedBackupsMessage {
8
+ /**
9
+ * @public
10
+ * <p>The resource ID of the DB cluster that is the source of the automated backup. This parameter isn't case-sensitive.</p>
11
+ */
12
+ DbClusterResourceId?: string;
13
+ /**
14
+ * @public
15
+ * <p>(Optional) The user-supplied DB cluster identifier. If this parameter is specified, it must
16
+ * match the identifier of an existing DB cluster. It returns information from the
17
+ * specific DB cluster's automated backup. This parameter isn't case-sensitive.</p>
18
+ */
19
+ DBClusterIdentifier?: string;
20
+ /**
21
+ * @public
22
+ * <p>A filter that specifies which resources to return based on status.</p>
23
+ * <p>Supported filters are the following:</p>
24
+ * <ul>
25
+ * <li>
26
+ * <p>
27
+ * <code>status</code>
28
+ * </p>
29
+ * <ul>
30
+ * <li>
31
+ * <p>
32
+ * <code>retained</code> - Automated backups for deleted clusters and after backup replication is stopped.</p>
33
+ * </li>
34
+ * </ul>
35
+ * </li>
36
+ * <li>
37
+ * <p>
38
+ * <code>db-cluster-id</code> - Accepts DB cluster identifiers and Amazon Resource Names (ARNs).
39
+ * The results list includes only information about the DB cluster automated backups identified by these ARNs.</p>
40
+ * </li>
41
+ * <li>
42
+ * <p>
43
+ * <code>db-cluster-resource-id</code> - Accepts DB resource identifiers and Amazon Resource Names (ARNs).
44
+ * The results list includes only information about the DB cluster resources identified by these ARNs.</p>
45
+ * </li>
46
+ * </ul>
47
+ * <p>Returns all resources by default. The status for each resource is specified in the response.</p>
48
+ */
49
+ Filters?: Filter[];
50
+ /**
51
+ * @public
52
+ * <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code>
53
+ * value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.</p>
54
+ */
55
+ MaxRecords?: number;
56
+ /**
57
+ * @public
58
+ * <p>The pagination token provided in the previous request. If this parameter is specified the response includes only
59
+ * records beyond the marker, up to <code>MaxRecords</code>.</p>
60
+ */
61
+ Marker?: string;
62
+ }
63
+ /**
64
+ * @public
65
+ * <p>Contains the result of a successful invocation of the <code>DescribeDBClusterBacktracks</code> action.</p>
66
+ */
67
+ export interface DBClusterBacktrackMessage {
68
+ /**
69
+ * @public
70
+ * <p>A pagination token that can be used in a later <code>DescribeDBClusterBacktracks</code> request.</p>
71
+ */
72
+ Marker?: string;
73
+ /**
74
+ * @public
75
+ * <p>Contains a list of backtracks for the user.</p>
76
+ */
77
+ DBClusterBacktracks?: DBClusterBacktrack[];
78
+ }
79
+ /**
80
+ * @public
81
+ * <p>
82
+ * <code>BacktrackIdentifier</code> doesn't refer to an existing backtrack.</p>
83
+ */
84
+ export declare class DBClusterBacktrackNotFoundFault extends __BaseException {
85
+ readonly name: "DBClusterBacktrackNotFoundFault";
86
+ readonly $fault: "client";
87
+ /**
88
+ * @internal
89
+ */
90
+ constructor(opts: __ExceptionOptionType<DBClusterBacktrackNotFoundFault, __BaseException>);
91
+ }
92
+ /**
93
+ * @public
94
+ * <p></p>
95
+ */
96
+ export interface DescribeDBClusterBacktracksMessage {
97
+ /**
98
+ * @public
99
+ * <p>The DB cluster identifier of the DB cluster to be described. This parameter is
100
+ * stored as a lowercase string.</p>
101
+ * <p>Constraints:</p>
102
+ * <ul>
103
+ * <li>
104
+ * <p>Must contain from 1 to 63 alphanumeric characters or hyphens.</p>
105
+ * </li>
106
+ * <li>
107
+ * <p>First character must be a letter.</p>
108
+ * </li>
109
+ * <li>
110
+ * <p>Can't end with a hyphen or contain two consecutive hyphens.</p>
111
+ * </li>
112
+ * </ul>
113
+ * <p>Example: <code>my-cluster1</code>
114
+ * </p>
115
+ */
116
+ DBClusterIdentifier: string | undefined;
117
+ /**
118
+ * @public
119
+ * <p>If specified, this value is the backtrack identifier of the backtrack to be
120
+ * described.</p>
121
+ * <p>Constraints:</p>
122
+ * <ul>
123
+ * <li>
124
+ * <p>Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see
125
+ * <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">Universally unique
126
+ * identifier</a>.</p>
127
+ * </li>
128
+ * </ul>
129
+ * <p>Example: <code>123e4567-e89b-12d3-a456-426655440000</code>
130
+ * </p>
131
+ */
132
+ BacktrackIdentifier?: string;
133
+ /**
134
+ * @public
135
+ * <p>A filter that specifies one or more DB clusters to describe. Supported filters
136
+ * include the following:</p>
137
+ * <ul>
138
+ * <li>
139
+ * <p>
140
+ * <code>db-cluster-backtrack-id</code> - Accepts backtrack identifiers. The
141
+ * results list includes information about only the backtracks identified by these
142
+ * identifiers.</p>
143
+ * </li>
144
+ * <li>
145
+ * <p>
146
+ * <code>db-cluster-backtrack-status</code> - Accepts any of the following backtrack status values:</p>
147
+ * <ul>
148
+ * <li>
149
+ * <p>
150
+ * <code>applying</code>
151
+ * </p>
152
+ * </li>
153
+ * <li>
154
+ * <p>
155
+ * <code>completed</code>
156
+ * </p>
157
+ * </li>
158
+ * <li>
159
+ * <p>
160
+ * <code>failed</code>
161
+ * </p>
162
+ * </li>
163
+ * <li>
164
+ * <p>
165
+ * <code>pending</code>
166
+ * </p>
167
+ * </li>
168
+ * </ul>
169
+ * <p>The results list includes information about only the backtracks identified
170
+ * by these values.</p>
171
+ * </li>
172
+ * </ul>
173
+ */
174
+ Filters?: Filter[];
175
+ /**
176
+ * @public
177
+ * <p>The maximum number of records to include in the response.
178
+ * If more records exist than the specified <code>MaxRecords</code> value,
179
+ * a pagination token called a marker is included in the response so you can retrieve the remaining results.</p>
180
+ * <p>Default: 100</p>
181
+ * <p>Constraints: Minimum 20, maximum 100.</p>
182
+ */
183
+ MaxRecords?: number;
184
+ /**
185
+ * @public
186
+ * <p>An optional pagination token provided by a previous
187
+ * <code>DescribeDBClusterBacktracks</code> request.
188
+ * If this parameter is specified, the response includes
189
+ * only records beyond the marker,
190
+ * up to the value specified by <code>MaxRecords</code>.</p>
191
+ */
192
+ Marker?: string;
193
+ }
194
+ /**
195
+ * @public
196
+ */
197
+ export interface DBClusterEndpointMessage {
198
+ /**
199
+ * @public
200
+ * <p>An optional pagination token provided by a previous
201
+ * <code>DescribeDBClusterEndpoints</code> request.
202
+ * If this parameter is specified, the response includes
203
+ * only records beyond the marker,
204
+ * up to the value specified by <code>MaxRecords</code>.</p>
205
+ */
206
+ Marker?: string;
207
+ /**
208
+ * @public
209
+ * <p>Contains the details of the endpoints associated with the cluster
210
+ * and matching any filter conditions.</p>
211
+ */
212
+ DBClusterEndpoints?: DBClusterEndpoint[];
213
+ }
214
+ /**
215
+ * @public
216
+ */
217
+ export interface DescribeDBClusterEndpointsMessage {
218
+ /**
219
+ * @public
220
+ * <p>The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is
221
+ * stored as a lowercase string.</p>
222
+ */
223
+ DBClusterIdentifier?: string;
224
+ /**
225
+ * @public
226
+ * <p>The identifier of the endpoint to describe. This parameter is stored as a lowercase string.</p>
227
+ */
228
+ DBClusterEndpointIdentifier?: string;
229
+ /**
230
+ * @public
231
+ * <p>A set of name-value pairs that define which endpoints to include in the output.
232
+ * The filters are specified as name-value pairs, in the format
233
+ * <code>Name=<i>endpoint_type</i>,Values=<i>endpoint_type1</i>,<i>endpoint_type2</i>,...</code>.
234
+ * <code>Name</code> can be one of: <code>db-cluster-endpoint-type</code>, <code>db-cluster-endpoint-custom-type</code>, <code>db-cluster-endpoint-id</code>, <code>db-cluster-endpoint-status</code>.
235
+ * <code>Values</code> for the <code> db-cluster-endpoint-type</code> filter can be one or more of: <code>reader</code>, <code>writer</code>, <code>custom</code>.
236
+ * <code>Values</code> for the <code>db-cluster-endpoint-custom-type</code> filter can be one or more of: <code>reader</code>, <code>any</code>.
237
+ * <code>Values</code> for the <code>db-cluster-endpoint-status</code> filter can be one or more of: <code>available</code>, <code>creating</code>, <code>deleting</code>, <code>inactive</code>, <code>modifying</code>.</p>
238
+ */
239
+ Filters?: Filter[];
240
+ /**
241
+ * @public
242
+ * <p>The maximum number of records to include in the response.
243
+ * If more records exist than the specified <code>MaxRecords</code> value,
244
+ * a pagination token called a marker is included in the response so you can retrieve the remaining results.</p>
245
+ * <p>Default: 100</p>
246
+ * <p>Constraints: Minimum 20, maximum 100.</p>
247
+ */
248
+ MaxRecords?: number;
249
+ /**
250
+ * @public
251
+ * <p>An optional pagination token provided by a previous
252
+ * <code>DescribeDBClusterEndpoints</code> request.
253
+ * If this parameter is specified, the response includes
254
+ * only records beyond the marker,
255
+ * up to the value specified by <code>MaxRecords</code>.</p>
256
+ */
257
+ Marker?: string;
258
+ }
259
+ /**
260
+ * @public
261
+ * <p></p>
262
+ */
263
+ export interface DBClusterParameterGroupsMessage {
264
+ /**
265
+ * @public
266
+ * <p>An optional pagination token provided by a previous
267
+ * <code>DescribeDBClusterParameterGroups</code> request.
268
+ * If this parameter is specified, the response includes
269
+ * only records beyond the marker,
270
+ * up to the value specified by <code>MaxRecords</code>.</p>
271
+ */
272
+ Marker?: string;
273
+ /**
274
+ * @public
275
+ * <p>A list of DB cluster parameter groups.</p>
276
+ */
277
+ DBClusterParameterGroups?: DBClusterParameterGroup[];
278
+ }
279
+ /**
280
+ * @public
281
+ * <p></p>
282
+ */
283
+ export interface DescribeDBClusterParameterGroupsMessage {
284
+ /**
285
+ * @public
286
+ * <p>The name of a specific DB cluster parameter group to return details for.</p>
287
+ * <p>Constraints:</p>
288
+ * <ul>
289
+ * <li>
290
+ * <p>If supplied, must match the name of an existing DBClusterParameterGroup.</p>
291
+ * </li>
292
+ * </ul>
293
+ */
294
+ DBClusterParameterGroupName?: string;
295
+ /**
296
+ * @public
297
+ * <p>This parameter isn't currently supported.</p>
298
+ */
299
+ Filters?: Filter[];
300
+ /**
301
+ * @public
302
+ * <p>The maximum number of records to include in the response.
303
+ * If more records exist than the specified <code>MaxRecords</code> value,
304
+ * a pagination token called a marker is included in the response so you can retrieve the remaining results.</p>
305
+ * <p>Default: 100</p>
306
+ * <p>Constraints: Minimum 20, maximum 100.</p>
307
+ */
308
+ MaxRecords?: number;
309
+ /**
310
+ * @public
311
+ * <p>An optional pagination token provided by a previous
312
+ * <code>DescribeDBClusterParameterGroups</code> request.
313
+ * If this parameter is specified, the response includes
314
+ * only records beyond the marker,
315
+ * up to the value specified by <code>MaxRecords</code>.</p>
316
+ */
317
+ Marker?: string;
318
+ }
319
+ /**
320
+ * @public
321
+ * @enum
322
+ */
323
+ export declare const ApplyMethod: {
324
+ readonly immediate: "immediate";
325
+ readonly pending_reboot: "pending-reboot";
326
+ };
327
+ /**
328
+ * @public
329
+ */
330
+ export type ApplyMethod = (typeof ApplyMethod)[keyof typeof ApplyMethod];
331
+ /**
332
+ * @public
333
+ * <p>This data type is used as a request parameter in the
334
+ * <code>ModifyDBParameterGroup</code> and <code>ResetDBParameterGroup</code> actions.</p>
335
+ * <p>This data type is used as a response element in the
336
+ * <code>DescribeEngineDefaultParameters</code> and <code>DescribeDBParameters</code> actions.</p>
337
+ */
338
+ export interface Parameter {
339
+ /**
340
+ * @public
341
+ * <p>The name of the parameter.</p>
342
+ */
343
+ ParameterName?: string;
344
+ /**
345
+ * @public
346
+ * <p>The value of the parameter.</p>
347
+ */
348
+ ParameterValue?: string;
349
+ /**
350
+ * @public
351
+ * <p>Provides a description of the parameter.</p>
352
+ */
353
+ Description?: string;
354
+ /**
355
+ * @public
356
+ * <p>The source of the parameter value.</p>
357
+ */
358
+ Source?: string;
359
+ /**
360
+ * @public
361
+ * <p>Specifies the engine specific parameters type.</p>
362
+ */
363
+ ApplyType?: string;
364
+ /**
365
+ * @public
366
+ * <p>Specifies the valid data type for the parameter.</p>
367
+ */
368
+ DataType?: string;
369
+ /**
370
+ * @public
371
+ * <p>Specifies the valid range of values for the parameter.</p>
372
+ */
373
+ AllowedValues?: string;
374
+ /**
375
+ * @public
376
+ * <p>Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be modified.
377
+ * Some parameters have security or operational implications
378
+ * that prevent them from being changed.</p>
379
+ */
380
+ IsModifiable?: boolean;
381
+ /**
382
+ * @public
383
+ * <p>The earliest engine version to which the parameter can apply.</p>
384
+ */
385
+ MinimumEngineVersion?: string;
386
+ /**
387
+ * @public
388
+ * <p>Indicates when to apply parameter updates.</p>
389
+ */
390
+ ApplyMethod?: ApplyMethod;
391
+ /**
392
+ * @public
393
+ * <p>The valid DB engine modes.</p>
394
+ */
395
+ SupportedEngineModes?: string[];
396
+ }
397
+ /**
398
+ * @public
399
+ * <p>Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.</p>
400
+ */
401
+ export interface DBClusterParameterGroupDetails {
402
+ /**
403
+ * @public
404
+ * <p>Provides a list of parameters for the DB cluster parameter group.</p>
405
+ */
406
+ Parameters?: Parameter[];
407
+ /**
408
+ * @public
409
+ * <p>An optional pagination token provided by a previous
410
+ * <code>DescribeDBClusterParameters</code> request.
411
+ * If this parameter is specified, the response includes
412
+ * only records beyond the marker,
413
+ * up to the value specified by <code>MaxRecords</code>.</p>
414
+ */
415
+ Marker?: string;
416
+ }
4
417
  /**
5
418
  * @public
6
419
  * <p></p>
@@ -1540,220 +1953,437 @@ export interface DescribeDBSnapshotAttributesMessage {
1540
1953
  export interface DBSnapshotAttribute {
1541
1954
  /**
1542
1955
  * @public
1543
- * <p>The name of the manual DB snapshot attribute.</p>
1544
- * <p>The attribute named <code>restore</code> refers to the list of Amazon Web Services accounts that
1545
- * have permission to copy or restore the manual DB cluster snapshot. For more information,
1546
- * see the <code>ModifyDBSnapshotAttribute</code>
1547
- * API action.</p>
1956
+ * <p>The name of the manual DB snapshot attribute.</p>
1957
+ * <p>The attribute named <code>restore</code> refers to the list of Amazon Web Services accounts that
1958
+ * have permission to copy or restore the manual DB cluster snapshot. For more information,
1959
+ * see the <code>ModifyDBSnapshotAttribute</code>
1960
+ * API action.</p>
1961
+ */
1962
+ AttributeName?: string;
1963
+ /**
1964
+ * @public
1965
+ * <p>The value or values for the manual DB snapshot attribute.</p>
1966
+ * <p>If the <code>AttributeName</code> field is set to <code>restore</code>, then this element
1967
+ * returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual
1968
+ * DB snapshot. If a value of <code>all</code> is in the list, then the manual DB snapshot
1969
+ * is public and available for any Amazon Web Services account to copy or restore.</p>
1970
+ */
1971
+ AttributeValues?: string[];
1972
+ }
1973
+ /**
1974
+ * @public
1975
+ * <p>Contains the results of a successful call to the <code>DescribeDBSnapshotAttributes</code>
1976
+ * API action.</p>
1977
+ * <p>Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts
1978
+ * to copy or restore a manual DB snapshot. For more information, see the <code>ModifyDBSnapshotAttribute</code>
1979
+ * API action.</p>
1980
+ */
1981
+ export interface DBSnapshotAttributesResult {
1982
+ /**
1983
+ * @public
1984
+ * <p>The identifier of the manual DB snapshot that the attributes apply to.</p>
1985
+ */
1986
+ DBSnapshotIdentifier?: string;
1987
+ /**
1988
+ * @public
1989
+ * <p>The list of attributes and values for the manual DB snapshot.</p>
1990
+ */
1991
+ DBSnapshotAttributes?: DBSnapshotAttribute[];
1992
+ }
1993
+ /**
1994
+ * @public
1995
+ */
1996
+ export interface DescribeDBSnapshotAttributesResult {
1997
+ /**
1998
+ * @public
1999
+ * <p>Contains the results of a successful call to the <code>DescribeDBSnapshotAttributes</code>
2000
+ * API action.</p>
2001
+ * <p>Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts
2002
+ * to copy or restore a manual DB snapshot. For more information, see the <code>ModifyDBSnapshotAttribute</code>
2003
+ * API action.</p>
2004
+ */
2005
+ DBSnapshotAttributesResult?: DBSnapshotAttributesResult;
2006
+ }
2007
+ /**
2008
+ * @public
2009
+ * <p>Contains the result of a successful invocation of the <code>DescribeDBSnapshots</code> action.</p>
2010
+ */
2011
+ export interface DBSnapshotMessage {
2012
+ /**
2013
+ * @public
2014
+ * <p>An optional pagination token provided by a previous request.
2015
+ * If this parameter is specified, the response includes
2016
+ * only records beyond the marker,
2017
+ * up to the value specified by <code>MaxRecords</code>.</p>
2018
+ */
2019
+ Marker?: string;
2020
+ /**
2021
+ * @public
2022
+ * <p>A list of <code>DBSnapshot</code> instances.</p>
2023
+ */
2024
+ DBSnapshots?: DBSnapshot[];
2025
+ }
2026
+ /**
2027
+ * @public
2028
+ * <p></p>
2029
+ */
2030
+ export interface DescribeDBSnapshotsMessage {
2031
+ /**
2032
+ * @public
2033
+ * <p>The ID of the DB instance to retrieve the list of DB snapshots for.
2034
+ * This parameter isn't case-sensitive.</p>
2035
+ * <p>Constraints:</p>
2036
+ * <ul>
2037
+ * <li>
2038
+ * <p>If supplied, must match the identifier of an existing DBInstance.</p>
2039
+ * </li>
2040
+ * </ul>
2041
+ */
2042
+ DBInstanceIdentifier?: string;
2043
+ /**
2044
+ * @public
2045
+ * <p>A specific DB snapshot identifier to describe.
2046
+ * This value is stored as a lowercase string.</p>
2047
+ * <p>Constraints:</p>
2048
+ * <ul>
2049
+ * <li>
2050
+ * <p>If supplied, must match the identifier of an existing DBSnapshot.</p>
2051
+ * </li>
2052
+ * <li>
2053
+ * <p>If this identifier is for an automated snapshot, the <code>SnapshotType</code> parameter must also be specified.</p>
2054
+ * </li>
2055
+ * </ul>
2056
+ */
2057
+ DBSnapshotIdentifier?: string;
2058
+ /**
2059
+ * @public
2060
+ * <p>The type of snapshots to be returned. You can specify one of the following values:</p>
2061
+ * <ul>
2062
+ * <li>
2063
+ * <p>
2064
+ * <code>automated</code> - Return all DB snapshots that have been automatically taken by
2065
+ * Amazon RDS for my Amazon Web Services account.</p>
2066
+ * </li>
2067
+ * <li>
2068
+ * <p>
2069
+ * <code>manual</code> - Return all DB snapshots that have been taken by my Amazon Web Services account.</p>
2070
+ * </li>
2071
+ * <li>
2072
+ * <p>
2073
+ * <code>shared</code> - Return all manual DB snapshots that have been shared to my Amazon Web Services account.</p>
2074
+ * </li>
2075
+ * <li>
2076
+ * <p>
2077
+ * <code>public</code> - Return all DB snapshots that have been marked as public.</p>
2078
+ * </li>
2079
+ * <li>
2080
+ * <p>
2081
+ * <code>awsbackup</code> - Return the DB snapshots managed by the Amazon Web Services Backup service.</p>
2082
+ * <p>For information about Amazon Web Services Backup, see the
2083
+ * <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html">
2084
+ * <i>Amazon Web Services Backup Developer Guide.</i>
2085
+ * </a>
2086
+ * </p>
2087
+ * <p>The <code>awsbackup</code> type does not apply to Aurora.</p>
2088
+ * </li>
2089
+ * </ul>
2090
+ * <p>If you don't specify a <code>SnapshotType</code> value, then both automated and manual snapshots are
2091
+ * returned. Shared and public DB snapshots are not included in the returned results by default.
2092
+ * You can include shared snapshots with these results by enabling the <code>IncludeShared</code>
2093
+ * parameter. You can include public snapshots with these results by enabling the
2094
+ * <code>IncludePublic</code> parameter.</p>
2095
+ * <p>The <code>IncludeShared</code> and <code>IncludePublic</code> parameters don't apply for <code>SnapshotType</code> values
2096
+ * of <code>manual</code> or <code>automated</code>. The <code>IncludePublic</code> parameter doesn't apply when <code>SnapshotType</code> is
2097
+ * set to <code>shared</code>. The <code>IncludeShared</code> parameter doesn't apply when <code>SnapshotType</code> is set to
2098
+ * <code>public</code>.</p>
2099
+ */
2100
+ SnapshotType?: string;
2101
+ /**
2102
+ * @public
2103
+ * <p>A filter that specifies one or more DB snapshots to describe.</p>
2104
+ * <p>Supported filters:</p>
2105
+ * <ul>
2106
+ * <li>
2107
+ * <p>
2108
+ * <code>db-instance-id</code> - Accepts DB instance identifiers and DB
2109
+ * instance Amazon Resource Names (ARNs).</p>
2110
+ * </li>
2111
+ * <li>
2112
+ * <p>
2113
+ * <code>db-snapshot-id</code> - Accepts DB snapshot identifiers.</p>
2114
+ * </li>
2115
+ * <li>
2116
+ * <p>
2117
+ * <code>dbi-resource-id</code> - Accepts identifiers of source DB instances.</p>
2118
+ * </li>
2119
+ * <li>
2120
+ * <p>
2121
+ * <code>snapshot-type</code> - Accepts types of DB snapshots.</p>
2122
+ * </li>
2123
+ * <li>
2124
+ * <p>
2125
+ * <code>engine</code> - Accepts names of database engines.</p>
2126
+ * </li>
2127
+ * </ul>
2128
+ */
2129
+ Filters?: Filter[];
2130
+ /**
2131
+ * @public
2132
+ * <p>The maximum number of records to include in the response.
2133
+ * If more records exist than the specified <code>MaxRecords</code> value,
2134
+ * a pagination token called a marker is included in the response so that
2135
+ * you can retrieve the remaining results.</p>
2136
+ * <p>Default: 100</p>
2137
+ * <p>Constraints: Minimum 20, maximum 100.</p>
2138
+ */
2139
+ MaxRecords?: number;
2140
+ /**
2141
+ * @public
2142
+ * <p>An optional pagination token provided by a previous
2143
+ * <code>DescribeDBSnapshots</code> request.
2144
+ * If this parameter is specified, the response includes
2145
+ * only records beyond the marker,
2146
+ * up to the value specified by <code>MaxRecords</code>.</p>
2147
+ */
2148
+ Marker?: string;
2149
+ /**
2150
+ * @public
2151
+ * <p>Specifies whether to include shared manual DB cluster snapshots
2152
+ * from other Amazon Web Services accounts that this Amazon Web Services account has been given
2153
+ * permission to copy or restore. By default, these snapshots are not included.</p>
2154
+ * <p>You can give an Amazon Web Services account permission to restore a manual DB snapshot from
2155
+ * another Amazon Web Services account by using the <code>ModifyDBSnapshotAttribute</code> API action.</p>
2156
+ * <p>This setting doesn't apply to RDS Custom.</p>
2157
+ */
2158
+ IncludeShared?: boolean;
2159
+ /**
2160
+ * @public
2161
+ * <p>Specifies whether to include manual DB cluster snapshots that are public and can be copied
2162
+ * or restored by any Amazon Web Services account. By default, the public snapshots are not included.</p>
2163
+ * <p>You can share a manual DB snapshot as public by using the <a>ModifyDBSnapshotAttribute</a> API.</p>
2164
+ * <p>This setting doesn't apply to RDS Custom.</p>
2165
+ */
2166
+ IncludePublic?: boolean;
2167
+ /**
2168
+ * @public
2169
+ * <p>A specific DB resource ID to describe.</p>
2170
+ */
2171
+ DbiResourceId?: string;
2172
+ }
2173
+ /**
2174
+ * @public
2175
+ * <p>Contains the details of a tenant database in a snapshot of a DB instance.</p>
2176
+ */
2177
+ export interface DBSnapshotTenantDatabase {
2178
+ /**
2179
+ * @public
2180
+ * <p>The identifier for the snapshot of the DB instance.</p>
2181
+ */
2182
+ DBSnapshotIdentifier?: string;
2183
+ /**
2184
+ * @public
2185
+ * <p>The ID for the DB instance that contains the tenant databases.</p>
2186
+ */
2187
+ DBInstanceIdentifier?: string;
2188
+ /**
2189
+ * @public
2190
+ * <p>The resource identifier of the source CDB instance. This identifier can't be changed
2191
+ * and is unique to an Amazon Web Services Region.</p>
2192
+ */
2193
+ DbiResourceId?: string;
2194
+ /**
2195
+ * @public
2196
+ * <p>The name of the database engine.</p>
2197
+ */
2198
+ EngineName?: string;
2199
+ /**
2200
+ * @public
2201
+ * <p>The type of DB snapshot.</p>
2202
+ */
2203
+ SnapshotType?: string;
2204
+ /**
2205
+ * @public
2206
+ * <p>The time the DB snapshot was taken, specified in Coordinated Universal Time (UTC). If
2207
+ * you copy the snapshot, the creation time changes.</p>
2208
+ */
2209
+ TenantDatabaseCreateTime?: Date;
2210
+ /**
2211
+ * @public
2212
+ * <p>The name of the tenant database.</p>
1548
2213
  */
1549
- AttributeName?: string;
2214
+ TenantDBName?: string;
1550
2215
  /**
1551
2216
  * @public
1552
- * <p>The value or values for the manual DB snapshot attribute.</p>
1553
- * <p>If the <code>AttributeName</code> field is set to <code>restore</code>, then this element
1554
- * returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual
1555
- * DB snapshot. If a value of <code>all</code> is in the list, then the manual DB snapshot
1556
- * is public and available for any Amazon Web Services account to copy or restore.</p>
2217
+ * <p>The master username of the tenant database.</p>
1557
2218
  */
1558
- AttributeValues?: string[];
1559
- }
1560
- /**
1561
- * @public
1562
- * <p>Contains the results of a successful call to the <code>DescribeDBSnapshotAttributes</code>
1563
- * API action.</p>
1564
- * <p>Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts
1565
- * to copy or restore a manual DB snapshot. For more information, see the <code>ModifyDBSnapshotAttribute</code>
1566
- * API action.</p>
1567
- */
1568
- export interface DBSnapshotAttributesResult {
2219
+ MasterUsername?: string;
1569
2220
  /**
1570
2221
  * @public
1571
- * <p>The identifier of the manual DB snapshot that the attributes apply to.</p>
2222
+ * <p>The resource ID of the tenant database.</p>
1572
2223
  */
1573
- DBSnapshotIdentifier?: string;
2224
+ TenantDatabaseResourceId?: string;
1574
2225
  /**
1575
2226
  * @public
1576
- * <p>The list of attributes and values for the manual DB snapshot.</p>
2227
+ * <p>The name of the character set of a tenant database.</p>
1577
2228
  */
1578
- DBSnapshotAttributes?: DBSnapshotAttribute[];
1579
- }
1580
- /**
1581
- * @public
1582
- */
1583
- export interface DescribeDBSnapshotAttributesResult {
2229
+ CharacterSetName?: string;
1584
2230
  /**
1585
2231
  * @public
1586
- * <p>Contains the results of a successful call to the <code>DescribeDBSnapshotAttributes</code>
1587
- * API action.</p>
1588
- * <p>Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts
1589
- * to copy or restore a manual DB snapshot. For more information, see the <code>ModifyDBSnapshotAttribute</code>
1590
- * API action.</p>
2232
+ * <p>The Amazon Resource Name (ARN) for the snapshot tenant database.</p>
1591
2233
  */
1592
- DBSnapshotAttributesResult?: DBSnapshotAttributesResult;
2234
+ DBSnapshotTenantDatabaseARN?: string;
2235
+ /**
2236
+ * @public
2237
+ * <p>The <code>NCHAR</code> character set name of the tenant database.</p>
2238
+ */
2239
+ NcharCharacterSetName?: string;
2240
+ /**
2241
+ * @public
2242
+ * <p>A list of tags.
2243
+ * For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html">Tagging Amazon RDS Resources</a> in the <i>Amazon RDS User Guide.</i>
2244
+ * </p>
2245
+ */
2246
+ TagList?: Tag[];
1593
2247
  }
1594
2248
  /**
1595
2249
  * @public
1596
- * <p>Contains the result of a successful invocation of the <code>DescribeDBSnapshots</code> action.</p>
1597
2250
  */
1598
- export interface DBSnapshotMessage {
2251
+ export interface DBSnapshotTenantDatabasesMessage {
1599
2252
  /**
1600
2253
  * @public
1601
- * <p>An optional pagination token provided by a previous request.
1602
- * If this parameter is specified, the response includes
1603
- * only records beyond the marker,
1604
- * up to the value specified by <code>MaxRecords</code>.</p>
2254
+ * <p>An optional pagination token provided by a previous request. If this parameter is
2255
+ * specified, the response includes only records beyond the marker, up to the value
2256
+ * specified by <code>MaxRecords</code>.</p>
1605
2257
  */
1606
2258
  Marker?: string;
1607
2259
  /**
1608
2260
  * @public
1609
- * <p>A list of <code>DBSnapshot</code> instances.</p>
2261
+ * <p>A list of DB snapshot tenant databases.</p>
1610
2262
  */
1611
- DBSnapshots?: DBSnapshot[];
2263
+ DBSnapshotTenantDatabases?: DBSnapshotTenantDatabase[];
1612
2264
  }
1613
2265
  /**
1614
2266
  * @public
1615
- * <p></p>
1616
2267
  */
1617
- export interface DescribeDBSnapshotsMessage {
2268
+ export interface DescribeDBSnapshotTenantDatabasesMessage {
1618
2269
  /**
1619
2270
  * @public
1620
- * <p>The ID of the DB instance to retrieve the list of DB snapshots for.
1621
- * This parameter isn't case-sensitive.</p>
2271
+ * <p>The ID of the DB instance used to create the DB snapshots. This parameter isn't
2272
+ * case-sensitive.</p>
1622
2273
  * <p>Constraints:</p>
1623
2274
  * <ul>
1624
2275
  * <li>
1625
- * <p>If supplied, must match the identifier of an existing DBInstance.</p>
2276
+ * <p>If supplied, must match the identifier of an existing <code>DBInstance</code>.</p>
1626
2277
  * </li>
1627
2278
  * </ul>
1628
2279
  */
1629
2280
  DBInstanceIdentifier?: string;
1630
2281
  /**
1631
2282
  * @public
1632
- * <p>A specific DB snapshot identifier to describe.
1633
- * This value is stored as a lowercase string.</p>
2283
+ * <p>The ID of a DB snapshot that contains the tenant databases to describe. This value is
2284
+ * stored as a lowercase string.</p>
1634
2285
  * <p>Constraints:</p>
1635
2286
  * <ul>
1636
2287
  * <li>
1637
- * <p>If supplied, must match the identifier of an existing DBSnapshot.</p>
2288
+ * <p>If you specify this parameter, the value must match the ID of an existing DB snapshot.</p>
1638
2289
  * </li>
1639
2290
  * <li>
1640
- * <p>If this identifier is for an automated snapshot, the <code>SnapshotType</code> parameter must also be specified.</p>
2291
+ * <p>If you specify an automatic snapshot, you must also specify
2292
+ * <code>SnapshotType</code>.</p>
1641
2293
  * </li>
1642
2294
  * </ul>
1643
2295
  */
1644
2296
  DBSnapshotIdentifier?: string;
1645
2297
  /**
1646
2298
  * @public
1647
- * <p>The type of snapshots to be returned. You can specify one of the following values:</p>
2299
+ * <p>The type of DB snapshots to be returned. You can specify one of the following
2300
+ * values:</p>
1648
2301
  * <ul>
1649
2302
  * <li>
1650
2303
  * <p>
1651
- * <code>automated</code> - Return all DB snapshots that have been automatically taken by
1652
- * Amazon RDS for my Amazon Web Services account.</p>
2304
+ * <code>automated</code> All DB snapshots that have been automatically taken
2305
+ * by Amazon RDS for my Amazon Web Services account.</p>
1653
2306
  * </li>
1654
2307
  * <li>
1655
2308
  * <p>
1656
- * <code>manual</code> - Return all DB snapshots that have been taken by my Amazon Web Services account.</p>
2309
+ * <code>manual</code> All DB snapshots that have been taken by my Amazon Web
2310
+ * Services account.</p>
1657
2311
  * </li>
1658
2312
  * <li>
1659
2313
  * <p>
1660
- * <code>shared</code> - Return all manual DB snapshots that have been shared to my Amazon Web Services account.</p>
2314
+ * <code>shared</code> All manual DB snapshots that have been shared to my
2315
+ * Amazon Web Services account.</p>
1661
2316
  * </li>
1662
2317
  * <li>
1663
2318
  * <p>
1664
- * <code>public</code> - Return all DB snapshots that have been marked as public.</p>
2319
+ * <code>public</code> All DB snapshots that have been marked as public.</p>
1665
2320
  * </li>
1666
2321
  * <li>
1667
2322
  * <p>
1668
- * <code>awsbackup</code> - Return the DB snapshots managed by the Amazon Web Services Backup service.</p>
1669
- * <p>For information about Amazon Web Services Backup, see the
1670
- * <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html">
1671
- * <i>Amazon Web Services Backup Developer Guide.</i>
1672
- * </a>
1673
- * </p>
1674
- * <p>The <code>awsbackup</code> type does not apply to Aurora.</p>
2323
+ * <code>awsbackup</code> All DB snapshots managed by the Amazon Web Services Backup
2324
+ * service.</p>
1675
2325
  * </li>
1676
2326
  * </ul>
1677
- * <p>If you don't specify a <code>SnapshotType</code> value, then both automated and manual snapshots are
1678
- * returned. Shared and public DB snapshots are not included in the returned results by default.
1679
- * You can include shared snapshots with these results by enabling the <code>IncludeShared</code>
1680
- * parameter. You can include public snapshots with these results by enabling the
1681
- * <code>IncludePublic</code> parameter.</p>
1682
- * <p>The <code>IncludeShared</code> and <code>IncludePublic</code> parameters don't apply for <code>SnapshotType</code> values
1683
- * of <code>manual</code> or <code>automated</code>. The <code>IncludePublic</code> parameter doesn't apply when <code>SnapshotType</code> is
1684
- * set to <code>shared</code>. The <code>IncludeShared</code> parameter doesn't apply when <code>SnapshotType</code> is set to
1685
- * <code>public</code>.</p>
1686
2327
  */
1687
2328
  SnapshotType?: string;
1688
2329
  /**
1689
2330
  * @public
1690
- * <p>A filter that specifies one or more DB snapshots to describe.</p>
2331
+ * <p>A filter that specifies one or more tenant databases to describe.</p>
1691
2332
  * <p>Supported filters:</p>
1692
2333
  * <ul>
1693
2334
  * <li>
1694
2335
  * <p>
1695
- * <code>db-instance-id</code> - Accepts DB instance identifiers and DB
1696
- * instance Amazon Resource Names (ARNs).</p>
2336
+ * <code>tenant-db-name</code> - Tenant database names. The results list only
2337
+ * includes information about the tenant databases that match these tenant DB
2338
+ * names.</p>
1697
2339
  * </li>
1698
2340
  * <li>
1699
2341
  * <p>
1700
- * <code>db-snapshot-id</code> - Accepts DB snapshot identifiers.</p>
2342
+ * <code>tenant-database-resource-id</code> - Tenant database resource
2343
+ * identifiers. The results list only includes information about the tenant
2344
+ * databases contained within the DB snapshots.</p>
1701
2345
  * </li>
1702
2346
  * <li>
1703
2347
  * <p>
1704
- * <code>dbi-resource-id</code> - Accepts identifiers of source DB instances.</p>
2348
+ * <code>dbi-resource-id</code> - DB instance resource identifiers. The results
2349
+ * list only includes information about snapshots containing tenant databases
2350
+ * contained within the DB instances identified by these resource
2351
+ * identifiers.</p>
1705
2352
  * </li>
1706
2353
  * <li>
1707
2354
  * <p>
1708
- * <code>snapshot-type</code> - Accepts types of DB snapshots.</p>
2355
+ * <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance
2356
+ * Amazon Resource Names (ARNs).</p>
1709
2357
  * </li>
1710
2358
  * <li>
1711
2359
  * <p>
1712
- * <code>engine</code> - Accepts names of database engines.</p>
2360
+ * <code>db-snapshot-id</code> - Accepts DB snapshot identifiers.</p>
2361
+ * </li>
2362
+ * <li>
2363
+ * <p>
2364
+ * <code>snapshot-type</code> - Accepts types of DB snapshots.</p>
1713
2365
  * </li>
1714
2366
  * </ul>
1715
2367
  */
1716
2368
  Filters?: Filter[];
1717
2369
  /**
1718
2370
  * @public
1719
- * <p>The maximum number of records to include in the response.
1720
- * If more records exist than the specified <code>MaxRecords</code> value,
1721
- * a pagination token called a marker is included in the response so that
1722
- * you can retrieve the remaining results.</p>
1723
- * <p>Default: 100</p>
1724
- * <p>Constraints: Minimum 20, maximum 100.</p>
2371
+ * <p>The maximum number of records to include in the response. If more records exist than
2372
+ * the specified <code>MaxRecords</code> value, a pagination token called a marker is
2373
+ * included in the response so that you can retrieve the remaining results.</p>
1725
2374
  */
1726
2375
  MaxRecords?: number;
1727
2376
  /**
1728
2377
  * @public
1729
2378
  * <p>An optional pagination token provided by a previous
1730
- * <code>DescribeDBSnapshots</code> request.
1731
- * If this parameter is specified, the response includes
1732
- * only records beyond the marker,
1733
- * up to the value specified by <code>MaxRecords</code>.</p>
2379
+ * <code>DescribeDBSnapshotTenantDatabases</code> request. If this parameter is
2380
+ * specified, the response includes only records beyond the marker, up to the value
2381
+ * specified by <code>MaxRecords</code>.</p>
1734
2382
  */
1735
2383
  Marker?: string;
1736
2384
  /**
1737
2385
  * @public
1738
- * <p>Specifies whether to include shared manual DB cluster snapshots
1739
- * from other Amazon Web Services accounts that this Amazon Web Services account has been given
1740
- * permission to copy or restore. By default, these snapshots are not included.</p>
1741
- * <p>You can give an Amazon Web Services account permission to restore a manual DB snapshot from
1742
- * another Amazon Web Services account by using the <code>ModifyDBSnapshotAttribute</code> API action.</p>
1743
- * <p>This setting doesn't apply to RDS Custom.</p>
1744
- */
1745
- IncludeShared?: boolean;
1746
- /**
1747
- * @public
1748
- * <p>Specifies whether to include manual DB cluster snapshots that are public and can be copied
1749
- * or restored by any Amazon Web Services account. By default, the public snapshots are not included.</p>
1750
- * <p>You can share a manual DB snapshot as public by using the <a>ModifyDBSnapshotAttribute</a> API.</p>
1751
- * <p>This setting doesn't apply to RDS Custom.</p>
1752
- */
1753
- IncludePublic?: boolean;
1754
- /**
1755
- * @public
1756
- * <p>A specific DB resource ID to describe.</p>
2386
+ * <p>A specific DB resource identifier to describe.</p>
1757
2387
  */
1758
2388
  DbiResourceId?: string;
1759
2389
  }
@@ -3964,6 +4594,84 @@ export interface SourceRegionMessage {
3964
4594
  */
3965
4595
  SourceRegions?: SourceRegion[];
3966
4596
  }
4597
+ /**
4598
+ * @public
4599
+ */
4600
+ export interface DescribeTenantDatabasesMessage {
4601
+ /**
4602
+ * @public
4603
+ * <p>The user-supplied DB instance identifier, which must match the identifier of an
4604
+ * existing instance owned by the Amazon Web Services account. This parameter isn't
4605
+ * case-sensitive.</p>
4606
+ */
4607
+ DBInstanceIdentifier?: string;
4608
+ /**
4609
+ * @public
4610
+ * <p>The user-supplied tenant database name, which must match the name of an existing
4611
+ * tenant database on the specified DB instance owned by your Amazon Web Services account. This parameter
4612
+ * isn’t case-sensitive.</p>
4613
+ */
4614
+ TenantDBName?: string;
4615
+ /**
4616
+ * @public
4617
+ * <p>A filter that specifies one or more database tenants to describe.</p>
4618
+ * <p>Supported filters:</p>
4619
+ * <ul>
4620
+ * <li>
4621
+ * <p>
4622
+ * <code>tenant-db-name</code> - Tenant database names. The results list only
4623
+ * includes information about the tenant databases that match these tenant DB
4624
+ * names.</p>
4625
+ * </li>
4626
+ * <li>
4627
+ * <p>
4628
+ * <code>tenant-database-resource-id</code> - Tenant database resource
4629
+ * identifiers.</p>
4630
+ * </li>
4631
+ * <li>
4632
+ * <p>
4633
+ * <code>dbi-resource-id</code> - DB instance resource identifiers. The results
4634
+ * list only includes information about the tenants contained within the DB
4635
+ * instances identified by these resource identifiers.</p>
4636
+ * </li>
4637
+ * </ul>
4638
+ */
4639
+ Filters?: Filter[];
4640
+ /**
4641
+ * @public
4642
+ * <p>An optional pagination token provided by a previous
4643
+ * <code>DescribeTenantDatabases</code> request. If this parameter is specified, the
4644
+ * response includes only records beyond the marker, up to the value specified by
4645
+ * <code>MaxRecords</code>.</p>
4646
+ */
4647
+ Marker?: string;
4648
+ /**
4649
+ * @public
4650
+ * <p>The maximum number of records to include in the response. If more records exist than
4651
+ * the specified <code>MaxRecords</code> value, a pagination token called a marker is
4652
+ * included in the response so that you can retrieve the remaining results.</p>
4653
+ */
4654
+ MaxRecords?: number;
4655
+ }
4656
+ /**
4657
+ * @public
4658
+ */
4659
+ export interface TenantDatabasesMessage {
4660
+ /**
4661
+ * @public
4662
+ * <p>An optional pagination token provided by a previous
4663
+ * <code>DescribeTenantDatabases</code> request. If this parameter is specified, the
4664
+ * response includes only records beyond the marker, up to the value specified by
4665
+ * <code>MaxRecords</code>.</p>
4666
+ */
4667
+ Marker?: string;
4668
+ /**
4669
+ * @public
4670
+ * <p>An array of the tenant databases requested by the <code>DescribeTenantDatabases</code>
4671
+ * operation.</p>
4672
+ */
4673
+ TenantDatabases?: TenantDatabase[];
4674
+ }
3967
4675
  /**
3968
4676
  * @public
3969
4677
  * <p></p>
@@ -5453,8 +6161,8 @@ export interface ModifyDBInstanceMessage {
5453
6161
  * <ul>
5454
6162
  * <li>
5455
6163
  * <p>If you are modifying the DB instance class and upgrading the engine version at the same time, the currently running engine version must be supported on the
5456
- * specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to modify the DB instance class,
5457
- * and then run it again to upgrade the engine version.</p>
6164
+ * specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version,
6165
+ * and then run it again to modify the DB instance class.</p>
5458
6166
  * </li>
5459
6167
  * </ul>
5460
6168
  */
@@ -5718,8 +6426,8 @@ export interface ModifyDBInstanceMessage {
5718
6426
  * <ul>
5719
6427
  * <li>
5720
6428
  * <p>If you are upgrading the engine version and modifying the DB instance class at the same time, the currently running engine version must be supported on the
5721
- * specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to modify the DB instance class,
5722
- * and then run it again to upgrade the engine version.</p>
6429
+ * specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to upgrade the engine version,
6430
+ * and then run it again to modify the DB instance class.</p>
5723
6431
  * </li>
5724
6432
  * </ul>
5725
6433
  */
@@ -6389,6 +7097,23 @@ export interface ModifyDBInstanceMessage {
6389
7097
  * <p>Indicates whether the DB instance has a dedicated log volume (DLV) enabled.</p>
6390
7098
  */
6391
7099
  DedicatedLogVolume?: boolean;
7100
+ /**
7101
+ * @public
7102
+ * <p>Specifies whether the to convert your DB instance from the single-tenant configuration
7103
+ * to the multi-tenant configuration. This parameter is supported only for RDS for Oracle
7104
+ * CDB instances.</p>
7105
+ * <p>During the conversion, RDS creates an initial tenant database and associates the DB
7106
+ * name, master user name, character set, and national character set metadata with this
7107
+ * database. The tags associated with the instance also propagate to the initial tenant
7108
+ * database. You can add more tenant databases to your DB instance by using the
7109
+ * <code>CreateTenantDatabase</code> operation.</p>
7110
+ * <important>
7111
+ * <p>The conversion to the multi-tenant configuration is permanent and irreversible, so
7112
+ * you can't later convert back to the single-tenant configuration. When you specify
7113
+ * this parameter, you must also specify <code>ApplyImmediately</code>.</p>
7114
+ * </important>
7115
+ */
7116
+ MultiTenant?: boolean;
6392
7117
  }
6393
7118
  /**
6394
7119
  * @public
@@ -7036,6 +7761,86 @@ export interface ModifyOptionGroupResult {
7036
7761
  */
7037
7762
  OptionGroup?: OptionGroup;
7038
7763
  }
7764
+ /**
7765
+ * @public
7766
+ */
7767
+ export interface ModifyTenantDatabaseMessage {
7768
+ /**
7769
+ * @public
7770
+ * <p>The identifier of the DB instance that contains the tenant database that you are
7771
+ * modifying. This parameter isn't case-sensitive.</p>
7772
+ * <p>Constraints:</p>
7773
+ * <ul>
7774
+ * <li>
7775
+ * <p>Must match the identifier of an existing DB instance.</p>
7776
+ * </li>
7777
+ * </ul>
7778
+ */
7779
+ DBInstanceIdentifier: string | undefined;
7780
+ /**
7781
+ * @public
7782
+ * <p>The user-supplied name of the tenant database that you want to modify. This parameter
7783
+ * isn’t case-sensitive.</p>
7784
+ * <p>Constraints:</p>
7785
+ * <ul>
7786
+ * <li>
7787
+ * <p>Must match the identifier of an existing tenant database.</p>
7788
+ * </li>
7789
+ * </ul>
7790
+ */
7791
+ TenantDBName: string | undefined;
7792
+ /**
7793
+ * @public
7794
+ * <p>The new password for the master user of the specified tenant database in your DB
7795
+ * instance.</p>
7796
+ * <note>
7797
+ * <p>Amazon RDS operations never return the password, so this action provides a way to regain
7798
+ * access to a tenant database user if the password is lost. This includes restoring
7799
+ * privileges that might have been accidentally revoked.</p>
7800
+ * </note>
7801
+ * <p>Constraints:</p>
7802
+ * <ul>
7803
+ * <li>
7804
+ * <p>Can include any printable ASCII character except <code>/</code>, <code>"</code> (double
7805
+ * quote), <code>@</code>, <code>&</code> (ampersand), and <code>'</code>
7806
+ * (single quote).</p>
7807
+ * </li>
7808
+ * </ul>
7809
+ * <p>Length constraints:</p>
7810
+ * <ul>
7811
+ * <li>
7812
+ * <p>Must contain between 8 and 30 characters. </p>
7813
+ * </li>
7814
+ * </ul>
7815
+ */
7816
+ MasterUserPassword?: string;
7817
+ /**
7818
+ * @public
7819
+ * <p>The new name of the tenant database when renaming a tenant database. This parameter
7820
+ * isn’t case-sensitive.</p>
7821
+ * <p>Constraints:</p>
7822
+ * <ul>
7823
+ * <li>
7824
+ * <p>Can't be the string null or any other reserved word.</p>
7825
+ * </li>
7826
+ * <li>
7827
+ * <p>Can't be longer than 8 characters.</p>
7828
+ * </li>
7829
+ * </ul>
7830
+ */
7831
+ NewTenantDBName?: string;
7832
+ }
7833
+ /**
7834
+ * @public
7835
+ */
7836
+ export interface ModifyTenantDatabaseResult {
7837
+ /**
7838
+ * @public
7839
+ * <p>A tenant database in the DB instance. This data type is an element in the response to
7840
+ * the <code>DescribeTenantDatabases</code> action.</p>
7841
+ */
7842
+ TenantDatabase?: TenantDatabase;
7843
+ }
7039
7844
  /**
7040
7845
  * @public
7041
7846
  * <p></p>
@@ -8408,6 +9213,11 @@ export interface RestoreDBClusterFromSnapshotMessage {
8408
9213
  * <p>Valid for: Aurora DB clusters only</p>
8409
9214
  */
8410
9215
  NetworkType?: string;
9216
+ /**
9217
+ * @public
9218
+ * <p>Reserved for future use.</p>
9219
+ */
9220
+ RdsCustomClusterConfiguration?: RdsCustomClusterConfiguration;
8411
9221
  }
8412
9222
  /**
8413
9223
  * @public
@@ -8802,6 +9612,11 @@ export interface RestoreDBClusterToPointInTimeMessage {
8802
9612
  * <p>The resource ID of the source DB cluster from which to restore.</p>
8803
9613
  */
8804
9614
  SourceDbClusterResourceId?: string;
9615
+ /**
9616
+ * @public
9617
+ * <p>Reserved for future use.</p>
9618
+ */
9619
+ RdsCustomClusterConfiguration?: RdsCustomClusterConfiguration;
8805
9620
  }
8806
9621
  /**
8807
9622
  * @public
@@ -11142,3 +11957,15 @@ export interface SwitchoverReadReplicaResult {
11142
11957
  */
11143
11958
  DBInstance?: DBInstance;
11144
11959
  }
11960
+ /**
11961
+ * @internal
11962
+ */
11963
+ export declare const TenantDatabasesMessageFilterSensitiveLog: (obj: TenantDatabasesMessage) => any;
11964
+ /**
11965
+ * @internal
11966
+ */
11967
+ export declare const ModifyTenantDatabaseMessageFilterSensitiveLog: (obj: ModifyTenantDatabaseMessage) => any;
11968
+ /**
11969
+ * @internal
11970
+ */
11971
+ export declare const ModifyTenantDatabaseResultFilterSensitiveLog: (obj: ModifyTenantDatabaseResult) => any;