@aws-sdk/client-rds 3.441.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 (103) 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 +653 -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 +637 -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/CreateDBInstanceCommand.d.ts +7 -0
  39. package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts +6 -0
  40. package/dist-types/commands/CreateDBSnapshotCommand.d.ts +1 -0
  41. package/dist-types/commands/CreateTenantDatabaseCommand.d.ts +122 -0
  42. package/dist-types/commands/DeleteDBInstanceAutomatedBackupCommand.d.ts +1 -0
  43. package/dist-types/commands/DeleteDBInstanceCommand.d.ts +2 -0
  44. package/dist-types/commands/DeleteDBSnapshotCommand.d.ts +1 -0
  45. package/dist-types/commands/DeleteTenantDatabaseCommand.d.ts +111 -0
  46. package/dist-types/commands/DescribeDBClusterAutomatedBackupsCommand.d.ts +2 -1
  47. package/dist-types/commands/DescribeDBClusterBacktracksCommand.d.ts +1 -1
  48. package/dist-types/commands/DescribeDBClusterEndpointsCommand.d.ts +1 -1
  49. package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +1 -1
  50. package/dist-types/commands/DescribeDBInstanceAutomatedBackupsCommand.d.ts +1 -0
  51. package/dist-types/commands/DescribeDBInstancesCommand.d.ts +2 -0
  52. package/dist-types/commands/DescribeDBSnapshotTenantDatabasesCommand.d.ts +117 -0
  53. package/dist-types/commands/DescribeDBSnapshotsCommand.d.ts +1 -0
  54. package/dist-types/commands/DescribeTenantDatabasesCommand.d.ts +114 -0
  55. package/dist-types/commands/ListTagsForResourceCommand.d.ts +6 -0
  56. package/dist-types/commands/ModifyDBInstanceCommand.d.ts +7 -0
  57. package/dist-types/commands/ModifyDBSnapshotCommand.d.ts +1 -0
  58. package/dist-types/commands/ModifyTenantDatabaseCommand.d.ts +114 -0
  59. package/dist-types/commands/PromoteReadReplicaCommand.d.ts +2 -0
  60. package/dist-types/commands/RebootDBInstanceCommand.d.ts +2 -0
  61. package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +6 -0
  62. package/dist-types/commands/RestoreDBInstanceFromDBSnapshotCommand.d.ts +6 -0
  63. package/dist-types/commands/RestoreDBInstanceFromS3Command.d.ts +2 -0
  64. package/dist-types/commands/RestoreDBInstanceToPointInTimeCommand.d.ts +6 -0
  65. package/dist-types/commands/StartDBInstanceAutomatedBackupsReplicationCommand.d.ts +1 -0
  66. package/dist-types/commands/StartDBInstanceCommand.d.ts +2 -0
  67. package/dist-types/commands/StopDBInstanceAutomatedBackupsReplicationCommand.d.ts +1 -0
  68. package/dist-types/commands/StopDBInstanceCommand.d.ts +2 -0
  69. package/dist-types/commands/SwitchoverReadReplicaCommand.d.ts +2 -0
  70. package/dist-types/commands/index.d.ts +5 -0
  71. package/dist-types/index.d.ts +2 -0
  72. package/dist-types/models/models_0.d.ts +333 -388
  73. package/dist-types/models/models_1.d.ts +1132 -335
  74. package/dist-types/pagination/DescribeDBSnapshotTenantDatabasesPaginator.d.ts +7 -0
  75. package/dist-types/pagination/DescribeTenantDatabasesPaginator.d.ts +7 -0
  76. package/dist-types/pagination/index.d.ts +2 -0
  77. package/dist-types/protocols/Aws_query.d.ts +45 -0
  78. package/dist-types/ts3.4/RDS.d.ts +91 -0
  79. package/dist-types/ts3.4/RDSClient.d.ts +30 -0
  80. package/dist-types/ts3.4/commands/CreateTenantDatabaseCommand.d.ts +42 -0
  81. package/dist-types/ts3.4/commands/DeleteTenantDatabaseCommand.d.ts +42 -0
  82. package/dist-types/ts3.4/commands/DescribeDBClusterAutomatedBackupsCommand.d.ts +2 -4
  83. package/dist-types/ts3.4/commands/DescribeDBClusterBacktracksCommand.d.ts +1 -1
  84. package/dist-types/ts3.4/commands/DescribeDBClusterEndpointsCommand.d.ts +1 -1
  85. package/dist-types/ts3.4/commands/DescribeDBClusterParameterGroupsCommand.d.ts +1 -1
  86. package/dist-types/ts3.4/commands/DescribeDBSnapshotTenantDatabasesCommand.d.ts +42 -0
  87. package/dist-types/ts3.4/commands/DescribeTenantDatabasesCommand.d.ts +42 -0
  88. package/dist-types/ts3.4/commands/ModifyTenantDatabaseCommand.d.ts +42 -0
  89. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  90. package/dist-types/ts3.4/index.d.ts +2 -0
  91. package/dist-types/ts3.4/models/models_0.d.ts +97 -67
  92. package/dist-types/ts3.4/models/models_1.d.ts +129 -1
  93. package/dist-types/ts3.4/pagination/DescribeDBSnapshotTenantDatabasesPaginator.d.ts +11 -0
  94. package/dist-types/ts3.4/pagination/DescribeTenantDatabasesPaginator.d.ts +11 -0
  95. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  96. package/dist-types/ts3.4/protocols/Aws_query.d.ts +60 -0
  97. package/dist-types/ts3.4/waiters/index.d.ts +2 -0
  98. package/dist-types/ts3.4/waiters/waitForTenantDatabaseAvailable.d.ts +11 -0
  99. package/dist-types/ts3.4/waiters/waitForTenantDatabaseDeleted.d.ts +11 -0
  100. package/dist-types/waiters/index.d.ts +2 -0
  101. package/dist-types/waiters/waitForTenantDatabaseAvailable.d.ts +14 -0
  102. package/dist-types/waiters/waitForTenantDatabaseDeleted.d.ts +14 -0
  103. package/package.json +4 -4
@@ -1,156 +1,173 @@
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, RdsCustomClusterConfiguration, 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
4
  /**
5
5
  * @public
6
- * <p>Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.</p>
7
6
  */
8
- export interface DBClusterParameterGroupDetails {
9
- /**
10
- * @public
11
- * <p>Provides a list of parameters for the DB cluster parameter group.</p>
12
- */
13
- Parameters?: Parameter[];
7
+ export interface DescribeDBClusterAutomatedBackupsMessage {
14
8
  /**
15
9
  * @public
16
- * <p>An optional pagination token provided by a previous
17
- * <code>DescribeDBClusterParameters</code> request.
18
- * If this parameter is specified, the response includes
19
- * only records beyond the marker,
20
- * up to the value specified by <code>MaxRecords</code>.</p>
10
+ * <p>The resource ID of the DB cluster that is the source of the automated backup. This parameter isn't case-sensitive.</p>
21
11
  */
22
- Marker?: string;
23
- }
24
- /**
25
- * @public
26
- * <p></p>
27
- */
28
- export interface DescribeDBClusterParametersMessage {
12
+ DbClusterResourceId?: string;
29
13
  /**
30
14
  * @public
31
- * <p>The name of a specific DB cluster parameter group to return parameter details for.</p>
32
- * <p>Constraints:</p>
33
- * <ul>
34
- * <li>
35
- * <p>If supplied, must match the name of an existing DBClusterParameterGroup.</p>
36
- * </li>
37
- * </ul>
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>
38
18
  */
39
- DBClusterParameterGroupName: string | undefined;
19
+ DBClusterIdentifier?: string;
40
20
  /**
41
21
  * @public
42
- * <p>A specific source to return parameters for.</p>
43
- * <p>Valid Values:</p>
22
+ * <p>A filter that specifies which resources to return based on status.</p>
23
+ * <p>Supported filters are the following:</p>
44
24
  * <ul>
45
25
  * <li>
46
26
  * <p>
47
- * <code>customer</code>
27
+ * <code>status</code>
48
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>
49
35
  * </li>
50
36
  * <li>
51
37
  * <p>
52
- * <code>engine</code>
53
- * </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>
54
40
  * </li>
55
41
  * <li>
56
42
  * <p>
57
- * <code>service</code>
58
- * </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>
59
45
  * </li>
60
46
  * </ul>
61
- */
62
- Source?: string;
63
- /**
64
- * @public
65
- * <p>This parameter isn't currently supported.</p>
47
+ * <p>Returns all resources by default. The status for each resource is specified in the response.</p>
66
48
  */
67
49
  Filters?: Filter[];
68
50
  /**
69
51
  * @public
70
- * <p>The maximum number of records to include in the response.
71
- * If more records exist than the specified <code>MaxRecords</code> value,
72
- * a pagination token called a marker is included in the response so you can retrieve the remaining results.</p>
73
- * <p>Default: 100</p>
74
- * <p>Constraints: Minimum 20, maximum 100.</p>
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>
75
54
  */
76
55
  MaxRecords?: number;
77
56
  /**
78
57
  * @public
79
- * <p>An optional pagination token provided by a previous
80
- * <code>DescribeDBClusterParameters</code> request.
81
- * If this parameter is specified, the response includes
82
- * only records beyond the marker,
83
- * up to the value specified by <code>MaxRecords</code>.</p>
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>
84
60
  */
85
61
  Marker?: string;
86
62
  }
87
63
  /**
88
64
  * @public
89
- * <p>Contains the result of a successful invocation of the <code>DescribeDBClusters</code> action.</p>
65
+ * <p>Contains the result of a successful invocation of the <code>DescribeDBClusterBacktracks</code> action.</p>
90
66
  */
91
- export interface DBClusterMessage {
67
+ export interface DBClusterBacktrackMessage {
92
68
  /**
93
69
  * @public
94
- * <p>A pagination token that can be used in a later <code>DescribeDBClusters</code> request.</p>
70
+ * <p>A pagination token that can be used in a later <code>DescribeDBClusterBacktracks</code> request.</p>
95
71
  */
96
72
  Marker?: string;
97
73
  /**
98
74
  * @public
99
- * <p>Contains a list of DB clusters for the user.</p>
75
+ * <p>Contains a list of backtracks for the user.</p>
100
76
  */
101
- DBClusters?: DBCluster[];
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>);
102
91
  }
103
92
  /**
104
93
  * @public
105
94
  * <p></p>
106
95
  */
107
- export interface DescribeDBClustersMessage {
96
+ export interface DescribeDBClusterBacktracksMessage {
108
97
  /**
109
98
  * @public
110
- * <p>The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified,
111
- * information for only the specific DB cluster is returned. This parameter isn't case-sensitive.</p>
99
+ * <p>The DB cluster identifier of the DB cluster to be described. This parameter is
100
+ * stored as a lowercase string.</p>
112
101
  * <p>Constraints:</p>
113
102
  * <ul>
114
103
  * <li>
115
- * <p>If supplied, must match an existing DB cluster identifier.</p>
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>
116
111
  * </li>
117
112
  * </ul>
113
+ * <p>Example: <code>my-cluster1</code>
114
+ * </p>
118
115
  */
119
- DBClusterIdentifier?: string;
116
+ DBClusterIdentifier: string | undefined;
120
117
  /**
121
118
  * @public
122
- * <p>A filter that specifies one or more DB clusters to describe.</p>
123
- * <p>Supported Filters:</p>
119
+ * <p>If specified, this value is the backtrack identifier of the backtrack to be
120
+ * described.</p>
121
+ * <p>Constraints:</p>
124
122
  * <ul>
125
123
  * <li>
126
- * <p>
127
- * <code>clone-group-id</code> - Accepts clone group identifiers.
128
- * The results list only includes information about
129
- * the DB clusters associated with these clone groups.</p>
130
- * </li>
131
- * <li>
132
- * <p>
133
- * <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB
134
- * cluster Amazon Resource Names (ARNs). The results list only includes information about
135
- * the DB clusters identified by these ARNs.</p>
136
- * </li>
137
- * <li>
138
- * <p>
139
- * <code>db-cluster-resource-id</code> - Accepts DB cluster resource identifiers.
140
- * The results list will only include information about the DB clusters identified
141
- * by these DB cluster resource identifiers.</p>
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>
142
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>
143
138
  * <li>
144
139
  * <p>
145
- * <code>domain</code> - Accepts Active Directory directory IDs.
146
- * The results list only includes information about
147
- * the DB clusters associated with these domains.</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>
148
143
  * </li>
149
144
  * <li>
150
145
  * <p>
151
- * <code>engine</code> - Accepts engine names.
152
- * The results list only includes information about
153
- * the DB clusters for these engines.</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>
154
171
  * </li>
155
172
  * </ul>
156
173
  */
@@ -159,7 +176,7 @@ export interface DescribeDBClustersMessage {
159
176
  * @public
160
177
  * <p>The maximum number of records to include in the response.
161
178
  * If more records exist than the specified <code>MaxRecords</code> value,
162
- * a pagination token called a marker is included in the response so you can retrieve the remaining results.</p>
179
+ * a pagination token called a marker is included in the response so you can retrieve the remaining results.</p>
163
180
  * <p>Default: 100</p>
164
181
  * <p>Constraints: Minimum 20, maximum 100.</p>
165
182
  */
@@ -167,156 +184,532 @@ export interface DescribeDBClustersMessage {
167
184
  /**
168
185
  * @public
169
186
  * <p>An optional pagination token provided by a previous
170
- * <code>DescribeDBClusters</code> request.
187
+ * <code>DescribeDBClusterBacktracks</code> request.
171
188
  * If this parameter is specified, the response includes
172
189
  * only records beyond the marker,
173
190
  * up to the value specified by <code>MaxRecords</code>.</p>
174
191
  */
175
192
  Marker?: string;
176
- /**
177
- * @public
178
- * <p>Specifies whether the output includes information about clusters
179
- * shared from other Amazon Web Services accounts.</p>
180
- */
181
- IncludeShared?: boolean;
182
193
  }
183
194
  /**
184
195
  * @public
185
- * <p></p>
186
196
  */
187
- export interface DescribeDBClusterSnapshotAttributesMessage {
197
+ export interface DBClusterEndpointMessage {
188
198
  /**
189
199
  * @public
190
- * <p>The identifier for the DB cluster snapshot to describe the attributes for.</p>
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>
191
205
  */
192
- DBClusterSnapshotIdentifier: string | undefined;
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[];
193
213
  }
194
214
  /**
195
215
  * @public
196
- * <p>Contains the name and values of a manual DB cluster snapshot attribute.</p>
197
- * <p>Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts
198
- * to restore a manual DB cluster snapshot. For more information, see the <code>ModifyDBClusterSnapshotAttribute</code>
199
- * API action.</p>
200
216
  */
201
- export interface DBClusterSnapshotAttribute {
217
+ export interface DescribeDBClusterEndpointsMessage {
202
218
  /**
203
219
  * @public
204
- * <p>The name of the manual DB cluster snapshot attribute.</p>
205
- * <p>The attribute named <code>restore</code> refers to the list of Amazon Web Services accounts that
206
- * have permission to copy or restore the manual DB cluster snapshot. For more information,
207
- * see the <code>ModifyDBClusterSnapshotAttribute</code>
208
- * API action.</p>
220
+ * <p>The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is
221
+ * stored as a lowercase string.</p>
209
222
  */
210
- AttributeName?: string;
223
+ DBClusterIdentifier?: string;
211
224
  /**
212
225
  * @public
213
- * <p>The value(s) for the manual DB cluster snapshot attribute.</p>
214
- * <p>If the <code>AttributeName</code> field is set to <code>restore</code>, then this element
215
- * returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual
216
- * DB cluster snapshot. If a value of <code>all</code> is in the list, then the manual DB cluster snapshot
217
- * is public and available for any Amazon Web Services account to copy or restore.</p>
226
+ * <p>The identifier of the endpoint to describe. This parameter is stored as a lowercase string.</p>
218
227
  */
219
- AttributeValues?: string[];
220
- }
221
- /**
222
- * @public
223
- * <p>Contains the results of a successful call to the <code>DescribeDBClusterSnapshotAttributes</code>
224
- * API action.</p>
225
- * <p>Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts
226
- * to copy or restore a manual DB cluster snapshot. For more information, see the <code>ModifyDBClusterSnapshotAttribute</code>
227
- * API action.</p>
228
- */
229
- export interface DBClusterSnapshotAttributesResult {
228
+ DBClusterEndpointIdentifier?: string;
230
229
  /**
231
230
  * @public
232
- * <p>The identifier of the manual DB cluster snapshot that the attributes apply to.</p>
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>
233
238
  */
234
- DBClusterSnapshotIdentifier?: string;
239
+ Filters?: Filter[];
235
240
  /**
236
241
  * @public
237
- * <p>The list of attributes and values for the manual DB cluster snapshot.</p>
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>
238
247
  */
239
- DBClusterSnapshotAttributes?: DBClusterSnapshotAttribute[];
240
- }
241
- /**
242
- * @public
243
- */
244
- export interface DescribeDBClusterSnapshotAttributesResult {
248
+ MaxRecords?: number;
245
249
  /**
246
250
  * @public
247
- * <p>Contains the results of a successful call to the <code>DescribeDBClusterSnapshotAttributes</code>
248
- * API action.</p>
249
- * <p>Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts
250
- * to copy or restore a manual DB cluster snapshot. For more information, see the <code>ModifyDBClusterSnapshotAttribute</code>
251
- * API action.</p>
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>
252
256
  */
253
- DBClusterSnapshotAttributesResult?: DBClusterSnapshotAttributesResult;
257
+ Marker?: string;
254
258
  }
255
259
  /**
256
260
  * @public
257
- * <p>Provides a list of DB cluster snapshots for the user as the result of a call to the <code>DescribeDBClusterSnapshots</code> action.</p>
261
+ * <p></p>
258
262
  */
259
- export interface DBClusterSnapshotMessage {
263
+ export interface DBClusterParameterGroupsMessage {
260
264
  /**
261
265
  * @public
262
266
  * <p>An optional pagination token provided by a previous
263
- * <code>DescribeDBClusterSnapshots</code> request.
264
- * If this parameter is specified, the response includes
265
- * only records beyond the marker,
266
- * up to the value specified by <code>MaxRecords</code>.</p>
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>
267
271
  */
268
272
  Marker?: string;
269
273
  /**
270
274
  * @public
271
- * <p>Provides a list of DB cluster snapshots for the user.</p>
275
+ * <p>A list of DB cluster parameter groups.</p>
272
276
  */
273
- DBClusterSnapshots?: DBClusterSnapshot[];
277
+ DBClusterParameterGroups?: DBClusterParameterGroup[];
274
278
  }
275
279
  /**
276
280
  * @public
277
281
  * <p></p>
278
282
  */
279
- export interface DescribeDBClusterSnapshotsMessage {
283
+ export interface DescribeDBClusterParameterGroupsMessage {
280
284
  /**
281
285
  * @public
282
- * <p>The ID of the DB cluster to retrieve the list of DB cluster snapshots for.
283
- * This parameter can't be used in conjunction with the
284
- * <code>DBClusterSnapshotIdentifier</code> parameter.
285
- * This parameter isn't case-sensitive.</p>
286
+ * <p>The name of a specific DB cluster parameter group to return details for.</p>
286
287
  * <p>Constraints:</p>
287
288
  * <ul>
288
289
  * <li>
289
- * <p>If supplied, must match the identifier of an existing DBCluster.</p>
290
+ * <p>If supplied, must match the name of an existing DBClusterParameterGroup.</p>
290
291
  * </li>
291
292
  * </ul>
292
293
  */
293
- DBClusterIdentifier?: string;
294
+ DBClusterParameterGroupName?: string;
294
295
  /**
295
296
  * @public
296
- * <p>A specific DB cluster snapshot identifier to describe.
297
- * This parameter can't be used in conjunction with the
298
- * <code>DBClusterIdentifier</code> parameter.
299
- * This value is stored as a lowercase string.</p>
300
- * <p>Constraints:</p>
301
- * <ul>
302
- * <li>
303
- * <p>If supplied, must match the identifier of an existing DBClusterSnapshot.</p>
304
- * </li>
305
- * <li>
306
- * <p>If this identifier is for an automated snapshot, the <code>SnapshotType</code> parameter must also be specified.</p>
307
- * </li>
308
- * </ul>
297
+ * <p>This parameter isn't currently supported.</p>
309
298
  */
310
- DBClusterSnapshotIdentifier?: string;
299
+ Filters?: Filter[];
311
300
  /**
312
301
  * @public
313
- * <p>The type of DB cluster snapshots to be returned. You can specify one of the following values:</p>
314
- * <ul>
315
- * <li>
316
- * <p>
317
- * <code>automated</code> - Return all DB cluster snapshots that have been automatically taken by
318
- * Amazon RDS for my Amazon Web Services account.</p>
319
- * </li>
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
+ }
417
+ /**
418
+ * @public
419
+ * <p></p>
420
+ */
421
+ export interface DescribeDBClusterParametersMessage {
422
+ /**
423
+ * @public
424
+ * <p>The name of a specific DB cluster parameter group to return parameter details for.</p>
425
+ * <p>Constraints:</p>
426
+ * <ul>
427
+ * <li>
428
+ * <p>If supplied, must match the name of an existing DBClusterParameterGroup.</p>
429
+ * </li>
430
+ * </ul>
431
+ */
432
+ DBClusterParameterGroupName: string | undefined;
433
+ /**
434
+ * @public
435
+ * <p>A specific source to return parameters for.</p>
436
+ * <p>Valid Values:</p>
437
+ * <ul>
438
+ * <li>
439
+ * <p>
440
+ * <code>customer</code>
441
+ * </p>
442
+ * </li>
443
+ * <li>
444
+ * <p>
445
+ * <code>engine</code>
446
+ * </p>
447
+ * </li>
448
+ * <li>
449
+ * <p>
450
+ * <code>service</code>
451
+ * </p>
452
+ * </li>
453
+ * </ul>
454
+ */
455
+ Source?: string;
456
+ /**
457
+ * @public
458
+ * <p>This parameter isn't currently supported.</p>
459
+ */
460
+ Filters?: Filter[];
461
+ /**
462
+ * @public
463
+ * <p>The maximum number of records to include in the response.
464
+ * If more records exist than the specified <code>MaxRecords</code> value,
465
+ * a pagination token called a marker is included in the response so you can retrieve the remaining results.</p>
466
+ * <p>Default: 100</p>
467
+ * <p>Constraints: Minimum 20, maximum 100.</p>
468
+ */
469
+ MaxRecords?: number;
470
+ /**
471
+ * @public
472
+ * <p>An optional pagination token provided by a previous
473
+ * <code>DescribeDBClusterParameters</code> request.
474
+ * If this parameter is specified, the response includes
475
+ * only records beyond the marker,
476
+ * up to the value specified by <code>MaxRecords</code>.</p>
477
+ */
478
+ Marker?: string;
479
+ }
480
+ /**
481
+ * @public
482
+ * <p>Contains the result of a successful invocation of the <code>DescribeDBClusters</code> action.</p>
483
+ */
484
+ export interface DBClusterMessage {
485
+ /**
486
+ * @public
487
+ * <p>A pagination token that can be used in a later <code>DescribeDBClusters</code> request.</p>
488
+ */
489
+ Marker?: string;
490
+ /**
491
+ * @public
492
+ * <p>Contains a list of DB clusters for the user.</p>
493
+ */
494
+ DBClusters?: DBCluster[];
495
+ }
496
+ /**
497
+ * @public
498
+ * <p></p>
499
+ */
500
+ export interface DescribeDBClustersMessage {
501
+ /**
502
+ * @public
503
+ * <p>The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified,
504
+ * information for only the specific DB cluster is returned. This parameter isn't case-sensitive.</p>
505
+ * <p>Constraints:</p>
506
+ * <ul>
507
+ * <li>
508
+ * <p>If supplied, must match an existing DB cluster identifier.</p>
509
+ * </li>
510
+ * </ul>
511
+ */
512
+ DBClusterIdentifier?: string;
513
+ /**
514
+ * @public
515
+ * <p>A filter that specifies one or more DB clusters to describe.</p>
516
+ * <p>Supported Filters:</p>
517
+ * <ul>
518
+ * <li>
519
+ * <p>
520
+ * <code>clone-group-id</code> - Accepts clone group identifiers.
521
+ * The results list only includes information about
522
+ * the DB clusters associated with these clone groups.</p>
523
+ * </li>
524
+ * <li>
525
+ * <p>
526
+ * <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB
527
+ * cluster Amazon Resource Names (ARNs). The results list only includes information about
528
+ * the DB clusters identified by these ARNs.</p>
529
+ * </li>
530
+ * <li>
531
+ * <p>
532
+ * <code>db-cluster-resource-id</code> - Accepts DB cluster resource identifiers.
533
+ * The results list will only include information about the DB clusters identified
534
+ * by these DB cluster resource identifiers.</p>
535
+ * </li>
536
+ * <li>
537
+ * <p>
538
+ * <code>domain</code> - Accepts Active Directory directory IDs.
539
+ * The results list only includes information about
540
+ * the DB clusters associated with these domains.</p>
541
+ * </li>
542
+ * <li>
543
+ * <p>
544
+ * <code>engine</code> - Accepts engine names.
545
+ * The results list only includes information about
546
+ * the DB clusters for these engines.</p>
547
+ * </li>
548
+ * </ul>
549
+ */
550
+ Filters?: Filter[];
551
+ /**
552
+ * @public
553
+ * <p>The maximum number of records to include in the response.
554
+ * If more records exist than the specified <code>MaxRecords</code> value,
555
+ * a pagination token called a marker is included in the response so you can retrieve the remaining results.</p>
556
+ * <p>Default: 100</p>
557
+ * <p>Constraints: Minimum 20, maximum 100.</p>
558
+ */
559
+ MaxRecords?: number;
560
+ /**
561
+ * @public
562
+ * <p>An optional pagination token provided by a previous
563
+ * <code>DescribeDBClusters</code> request.
564
+ * If this parameter is specified, the response includes
565
+ * only records beyond the marker,
566
+ * up to the value specified by <code>MaxRecords</code>.</p>
567
+ */
568
+ Marker?: string;
569
+ /**
570
+ * @public
571
+ * <p>Specifies whether the output includes information about clusters
572
+ * shared from other Amazon Web Services accounts.</p>
573
+ */
574
+ IncludeShared?: boolean;
575
+ }
576
+ /**
577
+ * @public
578
+ * <p></p>
579
+ */
580
+ export interface DescribeDBClusterSnapshotAttributesMessage {
581
+ /**
582
+ * @public
583
+ * <p>The identifier for the DB cluster snapshot to describe the attributes for.</p>
584
+ */
585
+ DBClusterSnapshotIdentifier: string | undefined;
586
+ }
587
+ /**
588
+ * @public
589
+ * <p>Contains the name and values of a manual DB cluster snapshot attribute.</p>
590
+ * <p>Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts
591
+ * to restore a manual DB cluster snapshot. For more information, see the <code>ModifyDBClusterSnapshotAttribute</code>
592
+ * API action.</p>
593
+ */
594
+ export interface DBClusterSnapshotAttribute {
595
+ /**
596
+ * @public
597
+ * <p>The name of the manual DB cluster snapshot attribute.</p>
598
+ * <p>The attribute named <code>restore</code> refers to the list of Amazon Web Services accounts that
599
+ * have permission to copy or restore the manual DB cluster snapshot. For more information,
600
+ * see the <code>ModifyDBClusterSnapshotAttribute</code>
601
+ * API action.</p>
602
+ */
603
+ AttributeName?: string;
604
+ /**
605
+ * @public
606
+ * <p>The value(s) for the manual DB cluster snapshot attribute.</p>
607
+ * <p>If the <code>AttributeName</code> field is set to <code>restore</code>, then this element
608
+ * returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual
609
+ * DB cluster snapshot. If a value of <code>all</code> is in the list, then the manual DB cluster snapshot
610
+ * is public and available for any Amazon Web Services account to copy or restore.</p>
611
+ */
612
+ AttributeValues?: string[];
613
+ }
614
+ /**
615
+ * @public
616
+ * <p>Contains the results of a successful call to the <code>DescribeDBClusterSnapshotAttributes</code>
617
+ * API action.</p>
618
+ * <p>Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts
619
+ * to copy or restore a manual DB cluster snapshot. For more information, see the <code>ModifyDBClusterSnapshotAttribute</code>
620
+ * API action.</p>
621
+ */
622
+ export interface DBClusterSnapshotAttributesResult {
623
+ /**
624
+ * @public
625
+ * <p>The identifier of the manual DB cluster snapshot that the attributes apply to.</p>
626
+ */
627
+ DBClusterSnapshotIdentifier?: string;
628
+ /**
629
+ * @public
630
+ * <p>The list of attributes and values for the manual DB cluster snapshot.</p>
631
+ */
632
+ DBClusterSnapshotAttributes?: DBClusterSnapshotAttribute[];
633
+ }
634
+ /**
635
+ * @public
636
+ */
637
+ export interface DescribeDBClusterSnapshotAttributesResult {
638
+ /**
639
+ * @public
640
+ * <p>Contains the results of a successful call to the <code>DescribeDBClusterSnapshotAttributes</code>
641
+ * API action.</p>
642
+ * <p>Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts
643
+ * to copy or restore a manual DB cluster snapshot. For more information, see the <code>ModifyDBClusterSnapshotAttribute</code>
644
+ * API action.</p>
645
+ */
646
+ DBClusterSnapshotAttributesResult?: DBClusterSnapshotAttributesResult;
647
+ }
648
+ /**
649
+ * @public
650
+ * <p>Provides a list of DB cluster snapshots for the user as the result of a call to the <code>DescribeDBClusterSnapshots</code> action.</p>
651
+ */
652
+ export interface DBClusterSnapshotMessage {
653
+ /**
654
+ * @public
655
+ * <p>An optional pagination token provided by a previous
656
+ * <code>DescribeDBClusterSnapshots</code> request.
657
+ * If this parameter is specified, the response includes
658
+ * only records beyond the marker,
659
+ * up to the value specified by <code>MaxRecords</code>.</p>
660
+ */
661
+ Marker?: string;
662
+ /**
663
+ * @public
664
+ * <p>Provides a list of DB cluster snapshots for the user.</p>
665
+ */
666
+ DBClusterSnapshots?: DBClusterSnapshot[];
667
+ }
668
+ /**
669
+ * @public
670
+ * <p></p>
671
+ */
672
+ export interface DescribeDBClusterSnapshotsMessage {
673
+ /**
674
+ * @public
675
+ * <p>The ID of the DB cluster to retrieve the list of DB cluster snapshots for.
676
+ * This parameter can't be used in conjunction with the
677
+ * <code>DBClusterSnapshotIdentifier</code> parameter.
678
+ * This parameter isn't case-sensitive.</p>
679
+ * <p>Constraints:</p>
680
+ * <ul>
681
+ * <li>
682
+ * <p>If supplied, must match the identifier of an existing DBCluster.</p>
683
+ * </li>
684
+ * </ul>
685
+ */
686
+ DBClusterIdentifier?: string;
687
+ /**
688
+ * @public
689
+ * <p>A specific DB cluster snapshot identifier to describe.
690
+ * This parameter can't be used in conjunction with the
691
+ * <code>DBClusterIdentifier</code> parameter.
692
+ * This value is stored as a lowercase string.</p>
693
+ * <p>Constraints:</p>
694
+ * <ul>
695
+ * <li>
696
+ * <p>If supplied, must match the identifier of an existing DBClusterSnapshot.</p>
697
+ * </li>
698
+ * <li>
699
+ * <p>If this identifier is for an automated snapshot, the <code>SnapshotType</code> parameter must also be specified.</p>
700
+ * </li>
701
+ * </ul>
702
+ */
703
+ DBClusterSnapshotIdentifier?: string;
704
+ /**
705
+ * @public
706
+ * <p>The type of DB cluster snapshots to be returned. You can specify one of the following values:</p>
707
+ * <ul>
708
+ * <li>
709
+ * <p>
710
+ * <code>automated</code> - Return all DB cluster snapshots that have been automatically taken by
711
+ * Amazon RDS for my Amazon Web Services account.</p>
712
+ * </li>
320
713
  * <li>
321
714
  * <p>
322
715
  * <code>manual</code> - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.</p>
@@ -1433,63 +1826,189 @@ export interface DBProxyTarget {
1433
1826
  TargetArn?: string;
1434
1827
  /**
1435
1828
  * @public
1436
- * <p>The writer endpoint for the RDS DB instance or Aurora DB cluster.</p>
1829
+ * <p>The writer endpoint for the RDS DB instance or Aurora DB cluster.</p>
1830
+ */
1831
+ Endpoint?: string;
1832
+ /**
1833
+ * @public
1834
+ * <p>The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.</p>
1835
+ */
1836
+ TrackedClusterId?: string;
1837
+ /**
1838
+ * @public
1839
+ * <p>The identifier representing the target. It can be the instance identifier for an RDS DB instance,
1840
+ * or the cluster identifier for an Aurora DB cluster.</p>
1841
+ */
1842
+ RdsResourceId?: string;
1843
+ /**
1844
+ * @public
1845
+ * <p>The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.</p>
1846
+ */
1847
+ Port?: number;
1848
+ /**
1849
+ * @public
1850
+ * <p>Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.</p>
1851
+ */
1852
+ Type?: TargetType;
1853
+ /**
1854
+ * @public
1855
+ * <p>A value that indicates whether the target of the proxy can be used for read/write or read-only operations.</p>
1856
+ */
1857
+ Role?: TargetRole;
1858
+ /**
1859
+ * @public
1860
+ * <p>Information about the connection health of the RDS Proxy target.</p>
1861
+ */
1862
+ TargetHealth?: TargetHealth;
1863
+ }
1864
+ /**
1865
+ * @public
1866
+ */
1867
+ export interface DescribeDBProxyTargetsResponse {
1868
+ /**
1869
+ * @public
1870
+ * <p>An arbitrary number of <code>DBProxyTarget</code> objects, containing details of the corresponding targets.</p>
1871
+ */
1872
+ Targets?: DBProxyTarget[];
1873
+ /**
1874
+ * @public
1875
+ * <p>An optional pagination token provided by a previous request.
1876
+ * If this parameter is specified, the response includes only records beyond the marker,
1877
+ * up to the value specified by <code>MaxRecords</code>.</p>
1878
+ */
1879
+ Marker?: string;
1880
+ }
1881
+ /**
1882
+ * @public
1883
+ * <p>Contains the result of a successful invocation of the <code>DescribeDBSecurityGroups</code> action.</p>
1884
+ */
1885
+ export interface DBSecurityGroupMessage {
1886
+ /**
1887
+ * @public
1888
+ * <p>An optional pagination token provided by a previous request.
1889
+ * If this parameter is specified, the response includes
1890
+ * only records beyond the marker,
1891
+ * up to the value specified by <code>MaxRecords</code>.</p>
1892
+ */
1893
+ Marker?: string;
1894
+ /**
1895
+ * @public
1896
+ * <p>A list of <code>DBSecurityGroup</code> instances.</p>
1897
+ */
1898
+ DBSecurityGroups?: DBSecurityGroup[];
1899
+ }
1900
+ /**
1901
+ * @public
1902
+ * <p></p>
1903
+ */
1904
+ export interface DescribeDBSecurityGroupsMessage {
1905
+ /**
1906
+ * @public
1907
+ * <p>The name of the DB security group to return details for.</p>
1437
1908
  */
1438
- Endpoint?: string;
1909
+ DBSecurityGroupName?: string;
1439
1910
  /**
1440
1911
  * @public
1441
- * <p>The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.</p>
1912
+ * <p>This parameter isn't currently supported.</p>
1442
1913
  */
1443
- TrackedClusterId?: string;
1914
+ Filters?: Filter[];
1444
1915
  /**
1445
1916
  * @public
1446
- * <p>The identifier representing the target. It can be the instance identifier for an RDS DB instance,
1447
- * or the cluster identifier for an Aurora DB cluster.</p>
1917
+ * <p>The maximum number of records to include in the response.
1918
+ * If more records exist than the specified <code>MaxRecords</code> value,
1919
+ * a pagination token called a marker is included in the response so that
1920
+ * you can retrieve the remaining results.</p>
1921
+ * <p>Default: 100</p>
1922
+ * <p>Constraints: Minimum 20, maximum 100.</p>
1448
1923
  */
1449
- RdsResourceId?: string;
1924
+ MaxRecords?: number;
1450
1925
  /**
1451
1926
  * @public
1452
- * <p>The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.</p>
1927
+ * <p>An optional pagination token provided by a previous
1928
+ * <code>DescribeDBSecurityGroups</code> request.
1929
+ * If this parameter is specified, the response includes
1930
+ * only records beyond the marker,
1931
+ * up to the value specified by <code>MaxRecords</code>.</p>
1453
1932
  */
1454
- Port?: number;
1933
+ Marker?: string;
1934
+ }
1935
+ /**
1936
+ * @public
1937
+ * <p></p>
1938
+ */
1939
+ export interface DescribeDBSnapshotAttributesMessage {
1455
1940
  /**
1456
1941
  * @public
1457
- * <p>Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.</p>
1942
+ * <p>The identifier for the DB snapshot to describe the attributes for.</p>
1458
1943
  */
1459
- Type?: TargetType;
1944
+ DBSnapshotIdentifier: string | undefined;
1945
+ }
1946
+ /**
1947
+ * @public
1948
+ * <p>Contains the name and values of a manual DB snapshot attribute</p>
1949
+ * <p>Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts
1950
+ * to restore a manual DB snapshot. For more information, see the <code>ModifyDBSnapshotAttribute</code>
1951
+ * API.</p>
1952
+ */
1953
+ export interface DBSnapshotAttribute {
1460
1954
  /**
1461
1955
  * @public
1462
- * <p>A value that indicates whether the target of the proxy can be used for read/write or read-only operations.</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>
1463
1961
  */
1464
- Role?: TargetRole;
1962
+ AttributeName?: string;
1465
1963
  /**
1466
1964
  * @public
1467
- * <p>Information about the connection health of the RDS Proxy target.</p>
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>
1468
1970
  */
1469
- TargetHealth?: TargetHealth;
1971
+ AttributeValues?: string[];
1470
1972
  }
1471
1973
  /**
1472
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>
1473
1980
  */
1474
- export interface DescribeDBProxyTargetsResponse {
1981
+ export interface DBSnapshotAttributesResult {
1475
1982
  /**
1476
1983
  * @public
1477
- * <p>An arbitrary number of <code>DBProxyTarget</code> objects, containing details of the corresponding targets.</p>
1984
+ * <p>The identifier of the manual DB snapshot that the attributes apply to.</p>
1478
1985
  */
1479
- Targets?: DBProxyTarget[];
1986
+ DBSnapshotIdentifier?: string;
1480
1987
  /**
1481
1988
  * @public
1482
- * <p>An optional pagination token provided by a previous request.
1483
- * If this parameter is specified, the response includes only records beyond the marker,
1484
- * up to the value specified by <code>MaxRecords</code>.</p>
1989
+ * <p>The list of attributes and values for the manual DB snapshot.</p>
1485
1990
  */
1486
- Marker?: string;
1991
+ DBSnapshotAttributes?: DBSnapshotAttribute[];
1487
1992
  }
1488
1993
  /**
1489
1994
  * @public
1490
- * <p>Contains the result of a successful invocation of the <code>DescribeDBSecurityGroups</code> action.</p>
1491
1995
  */
1492
- export interface DBSecurityGroupMessage {
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 {
1493
2012
  /**
1494
2013
  * @public
1495
2014
  * <p>An optional pagination token provided by a previous request.
@@ -1500,23 +2019,112 @@ export interface DBSecurityGroupMessage {
1500
2019
  Marker?: string;
1501
2020
  /**
1502
2021
  * @public
1503
- * <p>A list of <code>DBSecurityGroup</code> instances.</p>
2022
+ * <p>A list of <code>DBSnapshot</code> instances.</p>
1504
2023
  */
1505
- DBSecurityGroups?: DBSecurityGroup[];
2024
+ DBSnapshots?: DBSnapshot[];
1506
2025
  }
1507
2026
  /**
1508
2027
  * @public
1509
2028
  * <p></p>
1510
2029
  */
1511
- export interface DescribeDBSecurityGroupsMessage {
2030
+ export interface DescribeDBSnapshotsMessage {
1512
2031
  /**
1513
2032
  * @public
1514
- * <p>The name of the DB security group to return details for.</p>
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>
1515
2041
  */
1516
- DBSecurityGroupName?: string;
2042
+ DBInstanceIdentifier?: string;
1517
2043
  /**
1518
2044
  * @public
1519
- * <p>This parameter isn't currently supported.</p>
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>
1520
2128
  */
1521
2129
  Filters?: Filter[];
1522
2130
  /**
@@ -1532,248 +2140,250 @@ export interface DescribeDBSecurityGroupsMessage {
1532
2140
  /**
1533
2141
  * @public
1534
2142
  * <p>An optional pagination token provided by a previous
1535
- * <code>DescribeDBSecurityGroups</code> request.
1536
- * If this parameter is specified, the response includes
2143
+ * <code>DescribeDBSnapshots</code> request.
2144
+ * If this parameter is specified, the response includes
1537
2145
  * only records beyond the marker,
1538
2146
  * up to the value specified by <code>MaxRecords</code>.</p>
1539
2147
  */
1540
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;
1541
2172
  }
1542
2173
  /**
1543
2174
  * @public
1544
- * <p></p>
2175
+ * <p>Contains the details of a tenant database in a snapshot of a DB instance.</p>
1545
2176
  */
1546
- export interface DescribeDBSnapshotAttributesMessage {
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>
2213
+ */
2214
+ TenantDBName?: string;
1547
2215
  /**
1548
2216
  * @public
1549
- * <p>The identifier for the DB snapshot to describe the attributes for.</p>
2217
+ * <p>The master username of the tenant database.</p>
1550
2218
  */
1551
- DBSnapshotIdentifier: string | undefined;
1552
- }
1553
- /**
1554
- * @public
1555
- * <p>Contains the name and values of a manual DB snapshot attribute</p>
1556
- * <p>Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts
1557
- * to restore a manual DB snapshot. For more information, see the <code>ModifyDBSnapshotAttribute</code>
1558
- * API.</p>
1559
- */
1560
- export interface DBSnapshotAttribute {
2219
+ MasterUsername?: string;
1561
2220
  /**
1562
2221
  * @public
1563
- * <p>The name of the manual DB snapshot attribute.</p>
1564
- * <p>The attribute named <code>restore</code> refers to the list of Amazon Web Services accounts that
1565
- * have permission to copy or restore the manual DB cluster snapshot. For more information,
1566
- * see the <code>ModifyDBSnapshotAttribute</code>
1567
- * API action.</p>
2222
+ * <p>The resource ID of the tenant database.</p>
1568
2223
  */
1569
- AttributeName?: string;
2224
+ TenantDatabaseResourceId?: string;
1570
2225
  /**
1571
2226
  * @public
1572
- * <p>The value or values for the manual DB snapshot attribute.</p>
1573
- * <p>If the <code>AttributeName</code> field is set to <code>restore</code>, then this element
1574
- * returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual
1575
- * DB snapshot. If a value of <code>all</code> is in the list, then the manual DB snapshot
1576
- * is public and available for any Amazon Web Services account to copy or restore.</p>
2227
+ * <p>The name of the character set of a tenant database.</p>
1577
2228
  */
1578
- AttributeValues?: string[];
1579
- }
1580
- /**
1581
- * @public
1582
- * <p>Contains the results of a successful call to the <code>DescribeDBSnapshotAttributes</code>
1583
- * API action.</p>
1584
- * <p>Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts
1585
- * to copy or restore a manual DB snapshot. For more information, see the <code>ModifyDBSnapshotAttribute</code>
1586
- * API action.</p>
1587
- */
1588
- export interface DBSnapshotAttributesResult {
2229
+ CharacterSetName?: string;
1589
2230
  /**
1590
2231
  * @public
1591
- * <p>The identifier of the manual DB snapshot that the attributes apply to.</p>
2232
+ * <p>The Amazon Resource Name (ARN) for the snapshot tenant database.</p>
1592
2233
  */
1593
- DBSnapshotIdentifier?: string;
2234
+ DBSnapshotTenantDatabaseARN?: string;
1594
2235
  /**
1595
2236
  * @public
1596
- * <p>The list of attributes and values for the manual DB snapshot.</p>
2237
+ * <p>The <code>NCHAR</code> character set name of the tenant database.</p>
1597
2238
  */
1598
- DBSnapshotAttributes?: DBSnapshotAttribute[];
1599
- }
1600
- /**
1601
- * @public
1602
- */
1603
- export interface DescribeDBSnapshotAttributesResult {
2239
+ NcharCharacterSetName?: string;
1604
2240
  /**
1605
2241
  * @public
1606
- * <p>Contains the results of a successful call to the <code>DescribeDBSnapshotAttributes</code>
1607
- * API action.</p>
1608
- * <p>Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts
1609
- * to copy or restore a manual DB snapshot. For more information, see the <code>ModifyDBSnapshotAttribute</code>
1610
- * API action.</p>
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>
1611
2245
  */
1612
- DBSnapshotAttributesResult?: DBSnapshotAttributesResult;
2246
+ TagList?: Tag[];
1613
2247
  }
1614
2248
  /**
1615
2249
  * @public
1616
- * <p>Contains the result of a successful invocation of the <code>DescribeDBSnapshots</code> action.</p>
1617
2250
  */
1618
- export interface DBSnapshotMessage {
2251
+ export interface DBSnapshotTenantDatabasesMessage {
1619
2252
  /**
1620
2253
  * @public
1621
- * <p>An optional pagination token provided by a previous request.
1622
- * If this parameter is specified, the response includes
1623
- * only records beyond the marker,
1624
- * 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>
1625
2257
  */
1626
2258
  Marker?: string;
1627
2259
  /**
1628
2260
  * @public
1629
- * <p>A list of <code>DBSnapshot</code> instances.</p>
2261
+ * <p>A list of DB snapshot tenant databases.</p>
1630
2262
  */
1631
- DBSnapshots?: DBSnapshot[];
2263
+ DBSnapshotTenantDatabases?: DBSnapshotTenantDatabase[];
1632
2264
  }
1633
2265
  /**
1634
2266
  * @public
1635
- * <p></p>
1636
2267
  */
1637
- export interface DescribeDBSnapshotsMessage {
2268
+ export interface DescribeDBSnapshotTenantDatabasesMessage {
1638
2269
  /**
1639
2270
  * @public
1640
- * <p>The ID of the DB instance to retrieve the list of DB snapshots for.
1641
- * 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>
1642
2273
  * <p>Constraints:</p>
1643
2274
  * <ul>
1644
2275
  * <li>
1645
- * <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>
1646
2277
  * </li>
1647
2278
  * </ul>
1648
2279
  */
1649
2280
  DBInstanceIdentifier?: string;
1650
2281
  /**
1651
2282
  * @public
1652
- * <p>A specific DB snapshot identifier to describe.
1653
- * 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>
1654
2285
  * <p>Constraints:</p>
1655
2286
  * <ul>
1656
2287
  * <li>
1657
- * <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>
1658
2289
  * </li>
1659
2290
  * <li>
1660
- * <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>
1661
2293
  * </li>
1662
2294
  * </ul>
1663
2295
  */
1664
2296
  DBSnapshotIdentifier?: string;
1665
2297
  /**
1666
2298
  * @public
1667
- * <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>
1668
2301
  * <ul>
1669
2302
  * <li>
1670
2303
  * <p>
1671
- * <code>automated</code> - Return all DB snapshots that have been automatically taken by
1672
- * 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>
1673
2306
  * </li>
1674
2307
  * <li>
1675
2308
  * <p>
1676
- * <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>
1677
2311
  * </li>
1678
2312
  * <li>
1679
2313
  * <p>
1680
- * <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>
1681
2316
  * </li>
1682
2317
  * <li>
1683
2318
  * <p>
1684
- * <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>
1685
2320
  * </li>
1686
2321
  * <li>
1687
2322
  * <p>
1688
- * <code>awsbackup</code> - Return the DB snapshots managed by the Amazon Web Services Backup service.</p>
1689
- * <p>For information about Amazon Web Services Backup, see the
1690
- * <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html">
1691
- * <i>Amazon Web Services Backup Developer Guide.</i>
1692
- * </a>
1693
- * </p>
1694
- * <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>
1695
2325
  * </li>
1696
2326
  * </ul>
1697
- * <p>If you don't specify a <code>SnapshotType</code> value, then both automated and manual snapshots are
1698
- * returned. Shared and public DB snapshots are not included in the returned results by default.
1699
- * You can include shared snapshots with these results by enabling the <code>IncludeShared</code>
1700
- * parameter. You can include public snapshots with these results by enabling the
1701
- * <code>IncludePublic</code> parameter.</p>
1702
- * <p>The <code>IncludeShared</code> and <code>IncludePublic</code> parameters don't apply for <code>SnapshotType</code> values
1703
- * of <code>manual</code> or <code>automated</code>. The <code>IncludePublic</code> parameter doesn't apply when <code>SnapshotType</code> is
1704
- * set to <code>shared</code>. The <code>IncludeShared</code> parameter doesn't apply when <code>SnapshotType</code> is set to
1705
- * <code>public</code>.</p>
1706
2327
  */
1707
2328
  SnapshotType?: string;
1708
2329
  /**
1709
2330
  * @public
1710
- * <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>
1711
2332
  * <p>Supported filters:</p>
1712
2333
  * <ul>
1713
2334
  * <li>
1714
2335
  * <p>
1715
- * <code>db-instance-id</code> - Accepts DB instance identifiers and DB
1716
- * 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>
1717
2339
  * </li>
1718
2340
  * <li>
1719
2341
  * <p>
1720
- * <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>
1721
2345
  * </li>
1722
2346
  * <li>
1723
2347
  * <p>
1724
- * <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>
1725
2352
  * </li>
1726
2353
  * <li>
1727
2354
  * <p>
1728
- * <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>
1729
2357
  * </li>
1730
2358
  * <li>
1731
2359
  * <p>
1732
- * <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>
1733
2365
  * </li>
1734
2366
  * </ul>
1735
2367
  */
1736
2368
  Filters?: Filter[];
1737
2369
  /**
1738
2370
  * @public
1739
- * <p>The maximum number of records to include in the response.
1740
- * If more records exist than the specified <code>MaxRecords</code> value,
1741
- * a pagination token called a marker is included in the response so that
1742
- * you can retrieve the remaining results.</p>
1743
- * <p>Default: 100</p>
1744
- * <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>
1745
2374
  */
1746
2375
  MaxRecords?: number;
1747
2376
  /**
1748
2377
  * @public
1749
2378
  * <p>An optional pagination token provided by a previous
1750
- * <code>DescribeDBSnapshots</code> request.
1751
- * If this parameter is specified, the response includes
1752
- * only records beyond the marker,
1753
- * 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>
1754
2382
  */
1755
2383
  Marker?: string;
1756
2384
  /**
1757
2385
  * @public
1758
- * <p>Specifies whether to include shared manual DB cluster snapshots
1759
- * from other Amazon Web Services accounts that this Amazon Web Services account has been given
1760
- * permission to copy or restore. By default, these snapshots are not included.</p>
1761
- * <p>You can give an Amazon Web Services account permission to restore a manual DB snapshot from
1762
- * another Amazon Web Services account by using the <code>ModifyDBSnapshotAttribute</code> API action.</p>
1763
- * <p>This setting doesn't apply to RDS Custom.</p>
1764
- */
1765
- IncludeShared?: boolean;
1766
- /**
1767
- * @public
1768
- * <p>Specifies whether to include manual DB cluster snapshots that are public and can be copied
1769
- * or restored by any Amazon Web Services account. By default, the public snapshots are not included.</p>
1770
- * <p>You can share a manual DB snapshot as public by using the <a>ModifyDBSnapshotAttribute</a> API.</p>
1771
- * <p>This setting doesn't apply to RDS Custom.</p>
1772
- */
1773
- IncludePublic?: boolean;
1774
- /**
1775
- * @public
1776
- * <p>A specific DB resource ID to describe.</p>
2386
+ * <p>A specific DB resource identifier to describe.</p>
1777
2387
  */
1778
2388
  DbiResourceId?: string;
1779
2389
  }
@@ -3984,6 +4594,84 @@ export interface SourceRegionMessage {
3984
4594
  */
3985
4595
  SourceRegions?: SourceRegion[];
3986
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
+ }
3987
4675
  /**
3988
4676
  * @public
3989
4677
  * <p></p>
@@ -5473,8 +6161,8 @@ export interface ModifyDBInstanceMessage {
5473
6161
  * <ul>
5474
6162
  * <li>
5475
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
5476
- * specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to modify the DB instance class,
5477
- * 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>
5478
6166
  * </li>
5479
6167
  * </ul>
5480
6168
  */
@@ -5738,8 +6426,8 @@ export interface ModifyDBInstanceMessage {
5738
6426
  * <ul>
5739
6427
  * <li>
5740
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
5741
- * specified DB instance class. Otherwise, the operation returns an error. In this case, first run the operation to modify the DB instance class,
5742
- * 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>
5743
6431
  * </li>
5744
6432
  * </ul>
5745
6433
  */
@@ -6409,6 +7097,23 @@ export interface ModifyDBInstanceMessage {
6409
7097
  * <p>Indicates whether the DB instance has a dedicated log volume (DLV) enabled.</p>
6410
7098
  */
6411
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;
6412
7117
  }
6413
7118
  /**
6414
7119
  * @public
@@ -7056,6 +7761,86 @@ export interface ModifyOptionGroupResult {
7056
7761
  */
7057
7762
  OptionGroup?: OptionGroup;
7058
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
+ }
7059
7844
  /**
7060
7845
  * @public
7061
7846
  * <p></p>
@@ -11172,3 +11957,15 @@ export interface SwitchoverReadReplicaResult {
11172
11957
  */
11173
11958
  DBInstance?: DBInstance;
11174
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;