@aws-sdk/client-docdb 3.295.0 → 3.297.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/protocols/Aws_query.js +135 -592
- package/dist-es/protocols/Aws_query.js +135 -592
- package/dist-types/DocDB.d.ts +54 -0
- package/dist-types/DocDBClient.d.ts +24 -4
- package/dist-types/commands/AddSourceIdentifierToSubscriptionCommand.d.ts +16 -0
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +16 -0
- package/dist-types/commands/ApplyPendingMaintenanceActionCommand.d.ts +16 -0
- package/dist-types/commands/CopyDBClusterParameterGroupCommand.d.ts +16 -0
- package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +16 -0
- package/dist-types/commands/CreateDBClusterCommand.d.ts +16 -0
- package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +16 -0
- package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +16 -0
- package/dist-types/commands/CreateDBInstanceCommand.d.ts +16 -0
- package/dist-types/commands/CreateDBSubnetGroupCommand.d.ts +16 -0
- package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +16 -0
- package/dist-types/commands/CreateGlobalClusterCommand.d.ts +16 -0
- package/dist-types/commands/DeleteDBClusterCommand.d.ts +16 -0
- package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +16 -0
- package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +16 -0
- package/dist-types/commands/DeleteDBInstanceCommand.d.ts +16 -0
- package/dist-types/commands/DeleteDBSubnetGroupCommand.d.ts +16 -0
- package/dist-types/commands/DeleteEventSubscriptionCommand.d.ts +16 -0
- package/dist-types/commands/DeleteGlobalClusterCommand.d.ts +16 -0
- package/dist-types/commands/DescribeCertificatesCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBClustersCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBEngineVersionsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBInstancesCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBSubnetGroupsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +16 -0
- package/dist-types/commands/DescribeEventCategoriesCommand.d.ts +16 -0
- package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeEventsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +16 -0
- package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +16 -0
- package/dist-types/commands/DescribePendingMaintenanceActionsCommand.d.ts +16 -0
- package/dist-types/commands/FailoverDBClusterCommand.d.ts +16 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
- package/dist-types/commands/ModifyDBClusterCommand.d.ts +16 -0
- package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +16 -0
- package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +16 -0
- package/dist-types/commands/ModifyDBInstanceCommand.d.ts +16 -0
- package/dist-types/commands/ModifyDBSubnetGroupCommand.d.ts +16 -0
- package/dist-types/commands/ModifyEventSubscriptionCommand.d.ts +16 -0
- package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +16 -0
- package/dist-types/commands/RebootDBInstanceCommand.d.ts +16 -0
- package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +16 -0
- package/dist-types/commands/RemoveSourceIdentifierFromSubscriptionCommand.d.ts +16 -0
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +16 -0
- package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +16 -0
- package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +16 -0
- package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +16 -0
- package/dist-types/commands/StartDBClusterCommand.d.ts +16 -0
- package/dist-types/commands/StopDBClusterCommand.d.ts +16 -0
- package/dist-types/models/DocDBServiceException.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +274 -2
- package/dist-types/pagination/DescribeCertificatesPaginator.d.ts +3 -0
- package/dist-types/pagination/DescribeDBClusterParameterGroupsPaginator.d.ts +3 -0
- package/dist-types/pagination/DescribeDBClusterParametersPaginator.d.ts +3 -0
- package/dist-types/pagination/DescribeDBClusterSnapshotsPaginator.d.ts +3 -0
- package/dist-types/pagination/DescribeDBClustersPaginator.d.ts +3 -0
- package/dist-types/pagination/DescribeDBEngineVersionsPaginator.d.ts +3 -0
- package/dist-types/pagination/DescribeDBInstancesPaginator.d.ts +3 -0
- package/dist-types/pagination/DescribeDBSubnetGroupsPaginator.d.ts +3 -0
- package/dist-types/pagination/DescribeEventSubscriptionsPaginator.d.ts +3 -0
- package/dist-types/pagination/DescribeEventsPaginator.d.ts +3 -0
- package/dist-types/pagination/DescribeGlobalClustersPaginator.d.ts +3 -0
- package/dist-types/pagination/DescribeOrderableDBInstanceOptionsPaginator.d.ts +3 -0
- package/dist-types/pagination/DescribePendingMaintenanceActionsPaginator.d.ts +3 -0
- package/dist-types/pagination/Interfaces.d.ts +3 -0
- package/package.json +31 -31
package/dist-types/DocDB.d.ts
CHANGED
|
@@ -54,10 +54,12 @@ import { StartDBClusterCommandInput, StartDBClusterCommandOutput } from "./comma
|
|
|
54
54
|
import { StopDBClusterCommandInput, StopDBClusterCommandOutput } from "./commands/StopDBClusterCommand";
|
|
55
55
|
import { DocDBClient } from "./DocDBClient";
|
|
56
56
|
/**
|
|
57
|
+
* @public
|
|
57
58
|
* <p>Amazon DocumentDB API documentation</p>
|
|
58
59
|
*/
|
|
59
60
|
export declare class DocDB extends DocDBClient {
|
|
60
61
|
/**
|
|
62
|
+
* @public
|
|
61
63
|
* <p>Adds a source identifier to an existing event notification
|
|
62
64
|
* subscription.</p>
|
|
63
65
|
*/
|
|
@@ -65,6 +67,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
65
67
|
addSourceIdentifierToSubscription(args: AddSourceIdentifierToSubscriptionCommandInput, cb: (err: any, data?: AddSourceIdentifierToSubscriptionCommandOutput) => void): void;
|
|
66
68
|
addSourceIdentifierToSubscription(args: AddSourceIdentifierToSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddSourceIdentifierToSubscriptionCommandOutput) => void): void;
|
|
67
69
|
/**
|
|
70
|
+
* @public
|
|
68
71
|
* <p>Adds metadata tags to an Amazon DocumentDB resource. You can use these tags
|
|
69
72
|
* with cost allocation reporting to track costs that are associated
|
|
70
73
|
* with Amazon DocumentDB resources or in a <code>Condition</code> statement in
|
|
@@ -74,6 +77,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
74
77
|
addTagsToResource(args: AddTagsToResourceCommandInput, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void): void;
|
|
75
78
|
addTagsToResource(args: AddTagsToResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void): void;
|
|
76
79
|
/**
|
|
80
|
+
* @public
|
|
77
81
|
* <p>Applies a pending maintenance action to a resource (for example,
|
|
78
82
|
* to an Amazon DocumentDB instance).</p>
|
|
79
83
|
*/
|
|
@@ -81,12 +85,14 @@ export declare class DocDB extends DocDBClient {
|
|
|
81
85
|
applyPendingMaintenanceAction(args: ApplyPendingMaintenanceActionCommandInput, cb: (err: any, data?: ApplyPendingMaintenanceActionCommandOutput) => void): void;
|
|
82
86
|
applyPendingMaintenanceAction(args: ApplyPendingMaintenanceActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ApplyPendingMaintenanceActionCommandOutput) => void): void;
|
|
83
87
|
/**
|
|
88
|
+
* @public
|
|
84
89
|
* <p>Copies the specified cluster parameter group.</p>
|
|
85
90
|
*/
|
|
86
91
|
copyDBClusterParameterGroup(args: CopyDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions): Promise<CopyDBClusterParameterGroupCommandOutput>;
|
|
87
92
|
copyDBClusterParameterGroup(args: CopyDBClusterParameterGroupCommandInput, cb: (err: any, data?: CopyDBClusterParameterGroupCommandOutput) => void): void;
|
|
88
93
|
copyDBClusterParameterGroup(args: CopyDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyDBClusterParameterGroupCommandOutput) => void): void;
|
|
89
94
|
/**
|
|
95
|
+
* @public
|
|
90
96
|
* <p>Copies a snapshot of a cluster.</p>
|
|
91
97
|
*
|
|
92
98
|
* <p>To copy a cluster snapshot from a shared manual cluster snapshot,
|
|
@@ -104,12 +110,14 @@ export declare class DocDB extends DocDBClient {
|
|
|
104
110
|
copyDBClusterSnapshot(args: CopyDBClusterSnapshotCommandInput, cb: (err: any, data?: CopyDBClusterSnapshotCommandOutput) => void): void;
|
|
105
111
|
copyDBClusterSnapshot(args: CopyDBClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyDBClusterSnapshotCommandOutput) => void): void;
|
|
106
112
|
/**
|
|
113
|
+
* @public
|
|
107
114
|
* <p>Creates a new Amazon DocumentDB cluster.</p>
|
|
108
115
|
*/
|
|
109
116
|
createDBCluster(args: CreateDBClusterCommandInput, options?: __HttpHandlerOptions): Promise<CreateDBClusterCommandOutput>;
|
|
110
117
|
createDBCluster(args: CreateDBClusterCommandInput, cb: (err: any, data?: CreateDBClusterCommandOutput) => void): void;
|
|
111
118
|
createDBCluster(args: CreateDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBClusterCommandOutput) => void): void;
|
|
112
119
|
/**
|
|
120
|
+
* @public
|
|
113
121
|
* <p>Creates a new cluster parameter group.</p>
|
|
114
122
|
* <p>Parameters in a cluster parameter group apply to all of the
|
|
115
123
|
* instances in a cluster.</p>
|
|
@@ -134,18 +142,21 @@ export declare class DocDB extends DocDBClient {
|
|
|
134
142
|
createDBClusterParameterGroup(args: CreateDBClusterParameterGroupCommandInput, cb: (err: any, data?: CreateDBClusterParameterGroupCommandOutput) => void): void;
|
|
135
143
|
createDBClusterParameterGroup(args: CreateDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBClusterParameterGroupCommandOutput) => void): void;
|
|
136
144
|
/**
|
|
145
|
+
* @public
|
|
137
146
|
* <p>Creates a snapshot of a cluster. </p>
|
|
138
147
|
*/
|
|
139
148
|
createDBClusterSnapshot(args: CreateDBClusterSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<CreateDBClusterSnapshotCommandOutput>;
|
|
140
149
|
createDBClusterSnapshot(args: CreateDBClusterSnapshotCommandInput, cb: (err: any, data?: CreateDBClusterSnapshotCommandOutput) => void): void;
|
|
141
150
|
createDBClusterSnapshot(args: CreateDBClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBClusterSnapshotCommandOutput) => void): void;
|
|
142
151
|
/**
|
|
152
|
+
* @public
|
|
143
153
|
* <p>Creates a new instance.</p>
|
|
144
154
|
*/
|
|
145
155
|
createDBInstance(args: CreateDBInstanceCommandInput, options?: __HttpHandlerOptions): Promise<CreateDBInstanceCommandOutput>;
|
|
146
156
|
createDBInstance(args: CreateDBInstanceCommandInput, cb: (err: any, data?: CreateDBInstanceCommandOutput) => void): void;
|
|
147
157
|
createDBInstance(args: CreateDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBInstanceCommandOutput) => void): void;
|
|
148
158
|
/**
|
|
159
|
+
* @public
|
|
149
160
|
* <p>Creates a new subnet group. subnet groups must contain at least one subnet in at
|
|
150
161
|
* least two Availability Zones in the Amazon Web Services Region.</p>
|
|
151
162
|
*/
|
|
@@ -153,6 +164,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
153
164
|
createDBSubnetGroup(args: CreateDBSubnetGroupCommandInput, cb: (err: any, data?: CreateDBSubnetGroupCommandOutput) => void): void;
|
|
154
165
|
createDBSubnetGroup(args: CreateDBSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBSubnetGroupCommandOutput) => void): void;
|
|
155
166
|
/**
|
|
167
|
+
* @public
|
|
156
168
|
* <p>Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.</p>
|
|
157
169
|
* <p>You can specify the type of source (<code>SourceType</code>) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (<code>SourceIds</code>) that trigger the events, and you can provide a list of event categories (<code>EventCategories</code>) for events that you want to be notified of. For example, you can specify <code>SourceType = db-instance</code>, <code>SourceIds = mydbinstance1, mydbinstance2</code> and <code>EventCategories = Availability, Backup</code>.</p>
|
|
158
170
|
* <p>If you specify both the <code>SourceType</code> and <code>SourceIds</code> (such as <code>SourceType = db-instance</code> and <code>SourceIdentifier = myDBInstance1</code>), you are notified of all the <code>db-instance</code> events for the specified source. If you specify a <code>SourceType</code> but do not specify a <code>SourceIdentifier</code>, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the <code>SourceType</code> or the <code>SourceIdentifier</code>, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.</p>
|
|
@@ -161,6 +173,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
161
173
|
createEventSubscription(args: CreateEventSubscriptionCommandInput, cb: (err: any, data?: CreateEventSubscriptionCommandOutput) => void): void;
|
|
162
174
|
createEventSubscription(args: CreateEventSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventSubscriptionCommandOutput) => void): void;
|
|
163
175
|
/**
|
|
176
|
+
* @public
|
|
164
177
|
* <p>Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.</p>
|
|
165
178
|
* <p></p>
|
|
166
179
|
* <p>You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster. </p>
|
|
@@ -172,6 +185,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
172
185
|
createGlobalCluster(args: CreateGlobalClusterCommandInput, cb: (err: any, data?: CreateGlobalClusterCommandOutput) => void): void;
|
|
173
186
|
createGlobalCluster(args: CreateGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGlobalClusterCommandOutput) => void): void;
|
|
174
187
|
/**
|
|
188
|
+
* @public
|
|
175
189
|
* <p>Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.</p>
|
|
176
190
|
* <p></p>
|
|
177
191
|
*/
|
|
@@ -179,12 +193,14 @@ export declare class DocDB extends DocDBClient {
|
|
|
179
193
|
deleteDBCluster(args: DeleteDBClusterCommandInput, cb: (err: any, data?: DeleteDBClusterCommandOutput) => void): void;
|
|
180
194
|
deleteDBCluster(args: DeleteDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBClusterCommandOutput) => void): void;
|
|
181
195
|
/**
|
|
196
|
+
* @public
|
|
182
197
|
* <p>Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.</p>
|
|
183
198
|
*/
|
|
184
199
|
deleteDBClusterParameterGroup(args: DeleteDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDBClusterParameterGroupCommandOutput>;
|
|
185
200
|
deleteDBClusterParameterGroup(args: DeleteDBClusterParameterGroupCommandInput, cb: (err: any, data?: DeleteDBClusterParameterGroupCommandOutput) => void): void;
|
|
186
201
|
deleteDBClusterParameterGroup(args: DeleteDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBClusterParameterGroupCommandOutput) => void): void;
|
|
187
202
|
/**
|
|
203
|
+
* @public
|
|
188
204
|
* <p>Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.</p>
|
|
189
205
|
* <note>
|
|
190
206
|
* <p>The cluster snapshot must be in the <code>available</code> state to be deleted.</p>
|
|
@@ -194,12 +210,14 @@ export declare class DocDB extends DocDBClient {
|
|
|
194
210
|
deleteDBClusterSnapshot(args: DeleteDBClusterSnapshotCommandInput, cb: (err: any, data?: DeleteDBClusterSnapshotCommandOutput) => void): void;
|
|
195
211
|
deleteDBClusterSnapshot(args: DeleteDBClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBClusterSnapshotCommandOutput) => void): void;
|
|
196
212
|
/**
|
|
213
|
+
* @public
|
|
197
214
|
* <p>Deletes a previously provisioned instance.</p>
|
|
198
215
|
*/
|
|
199
216
|
deleteDBInstance(args: DeleteDBInstanceCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDBInstanceCommandOutput>;
|
|
200
217
|
deleteDBInstance(args: DeleteDBInstanceCommandInput, cb: (err: any, data?: DeleteDBInstanceCommandOutput) => void): void;
|
|
201
218
|
deleteDBInstance(args: DeleteDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBInstanceCommandOutput) => void): void;
|
|
202
219
|
/**
|
|
220
|
+
* @public
|
|
203
221
|
* <p>Deletes a subnet group.</p>
|
|
204
222
|
* <note>
|
|
205
223
|
* <p>The specified database subnet group must not be associated with any DB
|
|
@@ -210,12 +228,14 @@ export declare class DocDB extends DocDBClient {
|
|
|
210
228
|
deleteDBSubnetGroup(args: DeleteDBSubnetGroupCommandInput, cb: (err: any, data?: DeleteDBSubnetGroupCommandOutput) => void): void;
|
|
211
229
|
deleteDBSubnetGroup(args: DeleteDBSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBSubnetGroupCommandOutput) => void): void;
|
|
212
230
|
/**
|
|
231
|
+
* @public
|
|
213
232
|
* <p>Deletes an Amazon DocumentDB event notification subscription.</p>
|
|
214
233
|
*/
|
|
215
234
|
deleteEventSubscription(args: DeleteEventSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEventSubscriptionCommandOutput>;
|
|
216
235
|
deleteEventSubscription(args: DeleteEventSubscriptionCommandInput, cb: (err: any, data?: DeleteEventSubscriptionCommandOutput) => void): void;
|
|
217
236
|
deleteEventSubscription(args: DeleteEventSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventSubscriptionCommandOutput) => void): void;
|
|
218
237
|
/**
|
|
238
|
+
* @public
|
|
219
239
|
* <p>Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.</p>
|
|
220
240
|
* <note>
|
|
221
241
|
* <p>This action only applies to Amazon DocumentDB clusters.</p>
|
|
@@ -225,18 +245,21 @@ export declare class DocDB extends DocDBClient {
|
|
|
225
245
|
deleteGlobalCluster(args: DeleteGlobalClusterCommandInput, cb: (err: any, data?: DeleteGlobalClusterCommandOutput) => void): void;
|
|
226
246
|
deleteGlobalCluster(args: DeleteGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGlobalClusterCommandOutput) => void): void;
|
|
227
247
|
/**
|
|
248
|
+
* @public
|
|
228
249
|
* <p>Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.</p>
|
|
229
250
|
*/
|
|
230
251
|
describeCertificates(args: DescribeCertificatesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCertificatesCommandOutput>;
|
|
231
252
|
describeCertificates(args: DescribeCertificatesCommandInput, cb: (err: any, data?: DescribeCertificatesCommandOutput) => void): void;
|
|
232
253
|
describeCertificates(args: DescribeCertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCertificatesCommandOutput) => void): void;
|
|
233
254
|
/**
|
|
255
|
+
* @public
|
|
234
256
|
* <p>Returns a list of <code>DBClusterParameterGroup</code> descriptions. If a <code>DBClusterParameterGroupName</code> parameter is specified, the list contains only the description of the specified cluster parameter group. </p>
|
|
235
257
|
*/
|
|
236
258
|
describeDBClusterParameterGroups(args: DescribeDBClusterParameterGroupsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDBClusterParameterGroupsCommandOutput>;
|
|
237
259
|
describeDBClusterParameterGroups(args: DescribeDBClusterParameterGroupsCommandInput, cb: (err: any, data?: DescribeDBClusterParameterGroupsCommandOutput) => void): void;
|
|
238
260
|
describeDBClusterParameterGroups(args: DescribeDBClusterParameterGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterParameterGroupsCommandOutput) => void): void;
|
|
239
261
|
/**
|
|
262
|
+
* @public
|
|
240
263
|
* <p>Returns the detailed parameter list for a particular cluster parameter
|
|
241
264
|
* group.</p>
|
|
242
265
|
*/
|
|
@@ -244,6 +267,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
244
267
|
describeDBClusterParameters(args: DescribeDBClusterParametersCommandInput, cb: (err: any, data?: DescribeDBClusterParametersCommandOutput) => void): void;
|
|
245
268
|
describeDBClusterParameters(args: DescribeDBClusterParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterParametersCommandOutput) => void): void;
|
|
246
269
|
/**
|
|
270
|
+
* @public
|
|
247
271
|
* <p>Returns information about provisioned Amazon DocumentDB clusters. This API
|
|
248
272
|
* operation supports pagination. For certain management features
|
|
249
273
|
* such as cluster and instance lifecycle management, Amazon DocumentDB leverages
|
|
@@ -255,6 +279,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
255
279
|
describeDBClusters(args: DescribeDBClustersCommandInput, cb: (err: any, data?: DescribeDBClustersCommandOutput) => void): void;
|
|
256
280
|
describeDBClusters(args: DescribeDBClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClustersCommandOutput) => void): void;
|
|
257
281
|
/**
|
|
282
|
+
* @public
|
|
258
283
|
* <p>Returns a list of cluster snapshot attribute names and values for a manual DB
|
|
259
284
|
* cluster snapshot.</p>
|
|
260
285
|
* <p>When you share snapshots with other Amazon Web Services accounts,
|
|
@@ -264,24 +289,28 @@ export declare class DocDB extends DocDBClient {
|
|
|
264
289
|
describeDBClusterSnapshotAttributes(args: DescribeDBClusterSnapshotAttributesCommandInput, cb: (err: any, data?: DescribeDBClusterSnapshotAttributesCommandOutput) => void): void;
|
|
265
290
|
describeDBClusterSnapshotAttributes(args: DescribeDBClusterSnapshotAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterSnapshotAttributesCommandOutput) => void): void;
|
|
266
291
|
/**
|
|
292
|
+
* @public
|
|
267
293
|
* <p>Returns information about cluster snapshots. This API operation supports pagination.</p>
|
|
268
294
|
*/
|
|
269
295
|
describeDBClusterSnapshots(args: DescribeDBClusterSnapshotsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDBClusterSnapshotsCommandOutput>;
|
|
270
296
|
describeDBClusterSnapshots(args: DescribeDBClusterSnapshotsCommandInput, cb: (err: any, data?: DescribeDBClusterSnapshotsCommandOutput) => void): void;
|
|
271
297
|
describeDBClusterSnapshots(args: DescribeDBClusterSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterSnapshotsCommandOutput) => void): void;
|
|
272
298
|
/**
|
|
299
|
+
* @public
|
|
273
300
|
* <p>Returns a list of the available engines.</p>
|
|
274
301
|
*/
|
|
275
302
|
describeDBEngineVersions(args: DescribeDBEngineVersionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDBEngineVersionsCommandOutput>;
|
|
276
303
|
describeDBEngineVersions(args: DescribeDBEngineVersionsCommandInput, cb: (err: any, data?: DescribeDBEngineVersionsCommandOutput) => void): void;
|
|
277
304
|
describeDBEngineVersions(args: DescribeDBEngineVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBEngineVersionsCommandOutput) => void): void;
|
|
278
305
|
/**
|
|
306
|
+
* @public
|
|
279
307
|
* <p>Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.</p>
|
|
280
308
|
*/
|
|
281
309
|
describeDBInstances(args: DescribeDBInstancesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDBInstancesCommandOutput>;
|
|
282
310
|
describeDBInstances(args: DescribeDBInstancesCommandInput, cb: (err: any, data?: DescribeDBInstancesCommandOutput) => void): void;
|
|
283
311
|
describeDBInstances(args: DescribeDBInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBInstancesCommandOutput) => void): void;
|
|
284
312
|
/**
|
|
313
|
+
* @public
|
|
285
314
|
* <p>Returns a list of <code>DBSubnetGroup</code> descriptions. If a
|
|
286
315
|
* <code>DBSubnetGroupName</code> is specified, the list will contain only the descriptions of the specified <code>DBSubnetGroup</code>.</p>
|
|
287
316
|
*/
|
|
@@ -289,6 +318,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
289
318
|
describeDBSubnetGroups(args: DescribeDBSubnetGroupsCommandInput, cb: (err: any, data?: DescribeDBSubnetGroupsCommandOutput) => void): void;
|
|
290
319
|
describeDBSubnetGroups(args: DescribeDBSubnetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBSubnetGroupsCommandOutput) => void): void;
|
|
291
320
|
/**
|
|
321
|
+
* @public
|
|
292
322
|
* <p>Returns the default engine and system parameter information for the cluster database
|
|
293
323
|
* engine.</p>
|
|
294
324
|
*/
|
|
@@ -296,6 +326,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
296
326
|
describeEngineDefaultClusterParameters(args: DescribeEngineDefaultClusterParametersCommandInput, cb: (err: any, data?: DescribeEngineDefaultClusterParametersCommandOutput) => void): void;
|
|
297
327
|
describeEngineDefaultClusterParameters(args: DescribeEngineDefaultClusterParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEngineDefaultClusterParametersCommandOutput) => void): void;
|
|
298
328
|
/**
|
|
329
|
+
* @public
|
|
299
330
|
* <p>Displays a list of categories for all event source types, or, if specified, for a
|
|
300
331
|
* specified source type. </p>
|
|
301
332
|
*/
|
|
@@ -303,12 +334,14 @@ export declare class DocDB extends DocDBClient {
|
|
|
303
334
|
describeEventCategories(args: DescribeEventCategoriesCommandInput, cb: (err: any, data?: DescribeEventCategoriesCommandOutput) => void): void;
|
|
304
335
|
describeEventCategories(args: DescribeEventCategoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventCategoriesCommandOutput) => void): void;
|
|
305
336
|
/**
|
|
337
|
+
* @public
|
|
306
338
|
* <p>Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.</p>
|
|
307
339
|
*/
|
|
308
340
|
describeEvents(args: DescribeEventsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventsCommandOutput>;
|
|
309
341
|
describeEvents(args: DescribeEventsCommandInput, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void;
|
|
310
342
|
describeEvents(args: DescribeEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void;
|
|
311
343
|
/**
|
|
344
|
+
* @public
|
|
312
345
|
* <p>Lists all the subscription descriptions for a customer account. The description for a subscription includes <code>SubscriptionName</code>, <code>SNSTopicARN</code>, <code>CustomerID</code>, <code>SourceType</code>, <code>SourceID</code>, <code>CreationTime</code>, and <code>Status</code>.</p>
|
|
313
346
|
* <p>If you specify a <code>SubscriptionName</code>, lists the description for that subscription.</p>
|
|
314
347
|
*/
|
|
@@ -316,6 +349,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
316
349
|
describeEventSubscriptions(args: DescribeEventSubscriptionsCommandInput, cb: (err: any, data?: DescribeEventSubscriptionsCommandOutput) => void): void;
|
|
317
350
|
describeEventSubscriptions(args: DescribeEventSubscriptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventSubscriptionsCommandOutput) => void): void;
|
|
318
351
|
/**
|
|
352
|
+
* @public
|
|
319
353
|
* <p>Returns information about Amazon DocumentDB global clusters. This API supports pagination.</p>
|
|
320
354
|
* <note>
|
|
321
355
|
* <p>This action only applies to Amazon DocumentDB clusters.</p>
|
|
@@ -325,12 +359,14 @@ export declare class DocDB extends DocDBClient {
|
|
|
325
359
|
describeGlobalClusters(args: DescribeGlobalClustersCommandInput, cb: (err: any, data?: DescribeGlobalClustersCommandOutput) => void): void;
|
|
326
360
|
describeGlobalClusters(args: DescribeGlobalClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGlobalClustersCommandOutput) => void): void;
|
|
327
361
|
/**
|
|
362
|
+
* @public
|
|
328
363
|
* <p>Returns a list of orderable instance options for the specified engine.</p>
|
|
329
364
|
*/
|
|
330
365
|
describeOrderableDBInstanceOptions(args: DescribeOrderableDBInstanceOptionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeOrderableDBInstanceOptionsCommandOutput>;
|
|
331
366
|
describeOrderableDBInstanceOptions(args: DescribeOrderableDBInstanceOptionsCommandInput, cb: (err: any, data?: DescribeOrderableDBInstanceOptionsCommandOutput) => void): void;
|
|
332
367
|
describeOrderableDBInstanceOptions(args: DescribeOrderableDBInstanceOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrderableDBInstanceOptionsCommandOutput) => void): void;
|
|
333
368
|
/**
|
|
369
|
+
* @public
|
|
334
370
|
* <p>Returns a list of resources (for example, instances) that have at least one pending
|
|
335
371
|
* maintenance action.</p>
|
|
336
372
|
*/
|
|
@@ -338,6 +374,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
338
374
|
describePendingMaintenanceActions(args: DescribePendingMaintenanceActionsCommandInput, cb: (err: any, data?: DescribePendingMaintenanceActionsCommandOutput) => void): void;
|
|
339
375
|
describePendingMaintenanceActions(args: DescribePendingMaintenanceActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePendingMaintenanceActionsCommandOutput) => void): void;
|
|
340
376
|
/**
|
|
377
|
+
* @public
|
|
341
378
|
* <p>Forces a failover for a cluster.</p>
|
|
342
379
|
* <p>A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).</p>
|
|
343
380
|
* <p>If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.</p>
|
|
@@ -346,12 +383,14 @@ export declare class DocDB extends DocDBClient {
|
|
|
346
383
|
failoverDBCluster(args: FailoverDBClusterCommandInput, cb: (err: any, data?: FailoverDBClusterCommandOutput) => void): void;
|
|
347
384
|
failoverDBCluster(args: FailoverDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FailoverDBClusterCommandOutput) => void): void;
|
|
348
385
|
/**
|
|
386
|
+
* @public
|
|
349
387
|
* <p>Lists all tags on an Amazon DocumentDB resource.</p>
|
|
350
388
|
*/
|
|
351
389
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
352
390
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
353
391
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
354
392
|
/**
|
|
393
|
+
* @public
|
|
355
394
|
* <p>Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database
|
|
356
395
|
* configuration parameters by specifying these parameters and the new values in the
|
|
357
396
|
* request. </p>
|
|
@@ -360,6 +399,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
360
399
|
modifyDBCluster(args: ModifyDBClusterCommandInput, cb: (err: any, data?: ModifyDBClusterCommandOutput) => void): void;
|
|
361
400
|
modifyDBCluster(args: ModifyDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBClusterCommandOutput) => void): void;
|
|
362
401
|
/**
|
|
402
|
+
* @public
|
|
363
403
|
* <p> Modifies the parameters of a cluster parameter group. To modify more than one
|
|
364
404
|
* parameter, submit a list of the following: <code>ParameterName</code>,
|
|
365
405
|
* <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20
|
|
@@ -384,6 +424,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
384
424
|
modifyDBClusterParameterGroup(args: ModifyDBClusterParameterGroupCommandInput, cb: (err: any, data?: ModifyDBClusterParameterGroupCommandOutput) => void): void;
|
|
385
425
|
modifyDBClusterParameterGroup(args: ModifyDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBClusterParameterGroupCommandOutput) => void): void;
|
|
386
426
|
/**
|
|
427
|
+
* @public
|
|
387
428
|
* <p>Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.</p>
|
|
388
429
|
* <p>To share a manual cluster snapshot with other Amazon Web Services accounts, specify <code>restore</code> as the <code>AttributeName</code>, and use the <code>ValuesToAdd</code> parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual cluster snapshot. Use the value <code>all</code> to make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Do not add the <code>all</code> value for any manual cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the <code>ValuesToAdd</code> parameter. You can't use <code>all</code> as a value for that parameter in this case.</p>
|
|
389
430
|
*/
|
|
@@ -391,24 +432,28 @@ export declare class DocDB extends DocDBClient {
|
|
|
391
432
|
modifyDBClusterSnapshotAttribute(args: ModifyDBClusterSnapshotAttributeCommandInput, cb: (err: any, data?: ModifyDBClusterSnapshotAttributeCommandOutput) => void): void;
|
|
392
433
|
modifyDBClusterSnapshotAttribute(args: ModifyDBClusterSnapshotAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBClusterSnapshotAttributeCommandOutput) => void): void;
|
|
393
434
|
/**
|
|
435
|
+
* @public
|
|
394
436
|
* <p>Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.</p>
|
|
395
437
|
*/
|
|
396
438
|
modifyDBInstance(args: ModifyDBInstanceCommandInput, options?: __HttpHandlerOptions): Promise<ModifyDBInstanceCommandOutput>;
|
|
397
439
|
modifyDBInstance(args: ModifyDBInstanceCommandInput, cb: (err: any, data?: ModifyDBInstanceCommandOutput) => void): void;
|
|
398
440
|
modifyDBInstance(args: ModifyDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBInstanceCommandOutput) => void): void;
|
|
399
441
|
/**
|
|
442
|
+
* @public
|
|
400
443
|
* <p>Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.</p>
|
|
401
444
|
*/
|
|
402
445
|
modifyDBSubnetGroup(args: ModifyDBSubnetGroupCommandInput, options?: __HttpHandlerOptions): Promise<ModifyDBSubnetGroupCommandOutput>;
|
|
403
446
|
modifyDBSubnetGroup(args: ModifyDBSubnetGroupCommandInput, cb: (err: any, data?: ModifyDBSubnetGroupCommandOutput) => void): void;
|
|
404
447
|
modifyDBSubnetGroup(args: ModifyDBSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBSubnetGroupCommandOutput) => void): void;
|
|
405
448
|
/**
|
|
449
|
+
* @public
|
|
406
450
|
* <p>Modifies an existing Amazon DocumentDB event notification subscription.</p>
|
|
407
451
|
*/
|
|
408
452
|
modifyEventSubscription(args: ModifyEventSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<ModifyEventSubscriptionCommandOutput>;
|
|
409
453
|
modifyEventSubscription(args: ModifyEventSubscriptionCommandInput, cb: (err: any, data?: ModifyEventSubscriptionCommandOutput) => void): void;
|
|
410
454
|
modifyEventSubscription(args: ModifyEventSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyEventSubscriptionCommandOutput) => void): void;
|
|
411
455
|
/**
|
|
456
|
+
* @public
|
|
412
457
|
* <p>Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.</p>
|
|
413
458
|
* <note>
|
|
414
459
|
* <p>This action only applies to Amazon DocumentDB clusters.</p>
|
|
@@ -418,6 +463,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
418
463
|
modifyGlobalCluster(args: ModifyGlobalClusterCommandInput, cb: (err: any, data?: ModifyGlobalClusterCommandOutput) => void): void;
|
|
419
464
|
modifyGlobalCluster(args: ModifyGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyGlobalClusterCommandOutput) => void): void;
|
|
420
465
|
/**
|
|
466
|
+
* @public
|
|
421
467
|
* <p>You might need to reboot your instance, usually for maintenance reasons. For
|
|
422
468
|
* example, if you make certain changes, or if you change the cluster parameter group
|
|
423
469
|
* that is associated with the instance, you must reboot the instance for the changes to
|
|
@@ -430,6 +476,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
430
476
|
rebootDBInstance(args: RebootDBInstanceCommandInput, cb: (err: any, data?: RebootDBInstanceCommandOutput) => void): void;
|
|
431
477
|
rebootDBInstance(args: RebootDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebootDBInstanceCommandOutput) => void): void;
|
|
432
478
|
/**
|
|
479
|
+
* @public
|
|
433
480
|
* <p>Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region. </p>
|
|
434
481
|
* <note>
|
|
435
482
|
* <p>This action only applies to Amazon DocumentDB clusters.</p>
|
|
@@ -439,6 +486,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
439
486
|
removeFromGlobalCluster(args: RemoveFromGlobalClusterCommandInput, cb: (err: any, data?: RemoveFromGlobalClusterCommandOutput) => void): void;
|
|
440
487
|
removeFromGlobalCluster(args: RemoveFromGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveFromGlobalClusterCommandOutput) => void): void;
|
|
441
488
|
/**
|
|
489
|
+
* @public
|
|
442
490
|
* <p>Removes a source identifier from an existing Amazon DocumentDB event notification
|
|
443
491
|
* subscription.</p>
|
|
444
492
|
*/
|
|
@@ -446,12 +494,14 @@ export declare class DocDB extends DocDBClient {
|
|
|
446
494
|
removeSourceIdentifierFromSubscription(args: RemoveSourceIdentifierFromSubscriptionCommandInput, cb: (err: any, data?: RemoveSourceIdentifierFromSubscriptionCommandOutput) => void): void;
|
|
447
495
|
removeSourceIdentifierFromSubscription(args: RemoveSourceIdentifierFromSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveSourceIdentifierFromSubscriptionCommandOutput) => void): void;
|
|
448
496
|
/**
|
|
497
|
+
* @public
|
|
449
498
|
* <p>Removes metadata tags from an Amazon DocumentDB resource.</p>
|
|
450
499
|
*/
|
|
451
500
|
removeTagsFromResource(args: RemoveTagsFromResourceCommandInput, options?: __HttpHandlerOptions): Promise<RemoveTagsFromResourceCommandOutput>;
|
|
452
501
|
removeTagsFromResource(args: RemoveTagsFromResourceCommandInput, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void): void;
|
|
453
502
|
removeTagsFromResource(args: RemoveTagsFromResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void): void;
|
|
454
503
|
/**
|
|
504
|
+
* @public
|
|
455
505
|
* <p> Modifies the parameters of a cluster parameter group to the default value. To
|
|
456
506
|
* reset specific parameters, submit a list of the following: <code>ParameterName</code>
|
|
457
507
|
* and <code>ApplyMethod</code>. To reset the entire cluster parameter group, specify
|
|
@@ -465,6 +515,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
465
515
|
resetDBClusterParameterGroup(args: ResetDBClusterParameterGroupCommandInput, cb: (err: any, data?: ResetDBClusterParameterGroupCommandOutput) => void): void;
|
|
466
516
|
resetDBClusterParameterGroup(args: ResetDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetDBClusterParameterGroupCommandOutput) => void): void;
|
|
467
517
|
/**
|
|
518
|
+
* @public
|
|
468
519
|
* <p>Creates a new cluster from a snapshot or cluster snapshot.</p>
|
|
469
520
|
* <p>If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.</p>
|
|
470
521
|
* <p>If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.</p>
|
|
@@ -473,6 +524,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
473
524
|
restoreDBClusterFromSnapshot(args: RestoreDBClusterFromSnapshotCommandInput, cb: (err: any, data?: RestoreDBClusterFromSnapshotCommandOutput) => void): void;
|
|
474
525
|
restoreDBClusterFromSnapshot(args: RestoreDBClusterFromSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreDBClusterFromSnapshotCommandOutput) => void): void;
|
|
475
526
|
/**
|
|
527
|
+
* @public
|
|
476
528
|
* <p>Restores a cluster to an arbitrary point in time. Users can restore to any point in
|
|
477
529
|
* time before <code>LatestRestorableTime</code> for up to
|
|
478
530
|
* <code>BackupRetentionPeriod</code> days. The target cluster is created from the
|
|
@@ -483,6 +535,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
483
535
|
restoreDBClusterToPointInTime(args: RestoreDBClusterToPointInTimeCommandInput, cb: (err: any, data?: RestoreDBClusterToPointInTimeCommandOutput) => void): void;
|
|
484
536
|
restoreDBClusterToPointInTime(args: RestoreDBClusterToPointInTimeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreDBClusterToPointInTimeCommandOutput) => void): void;
|
|
485
537
|
/**
|
|
538
|
+
* @public
|
|
486
539
|
* <p>Restarts the stopped cluster that is specified by <code>DBClusterIdentifier</code>.
|
|
487
540
|
* For more information, see <a href="https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html">Stopping and
|
|
488
541
|
* Starting an Amazon DocumentDB Cluster</a>.</p>
|
|
@@ -491,6 +544,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
491
544
|
startDBCluster(args: StartDBClusterCommandInput, cb: (err: any, data?: StartDBClusterCommandOutput) => void): void;
|
|
492
545
|
startDBCluster(args: StartDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDBClusterCommandOutput) => void): void;
|
|
493
546
|
/**
|
|
547
|
+
* @public
|
|
494
548
|
* <p>Stops the running cluster that is specified by <code>DBClusterIdentifier</code>. The
|
|
495
549
|
* cluster must be in the <i>available</i> state. For more information, see
|
|
496
550
|
* <a href="https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html">Stopping and
|
|
@@ -61,15 +61,24 @@ import { RestoreDBClusterToPointInTimeCommandInput, RestoreDBClusterToPointInTim
|
|
|
61
61
|
import { StartDBClusterCommandInput, StartDBClusterCommandOutput } from "./commands/StartDBClusterCommand";
|
|
62
62
|
import { StopDBClusterCommandInput, StopDBClusterCommandOutput } from "./commands/StopDBClusterCommand";
|
|
63
63
|
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
64
|
+
/**
|
|
65
|
+
* @public
|
|
66
|
+
*/
|
|
64
67
|
export type ServiceInputTypes = AddSourceIdentifierToSubscriptionCommandInput | AddTagsToResourceCommandInput | ApplyPendingMaintenanceActionCommandInput | CopyDBClusterParameterGroupCommandInput | CopyDBClusterSnapshotCommandInput | CreateDBClusterCommandInput | CreateDBClusterParameterGroupCommandInput | CreateDBClusterSnapshotCommandInput | CreateDBInstanceCommandInput | CreateDBSubnetGroupCommandInput | CreateEventSubscriptionCommandInput | CreateGlobalClusterCommandInput | DeleteDBClusterCommandInput | DeleteDBClusterParameterGroupCommandInput | DeleteDBClusterSnapshotCommandInput | DeleteDBInstanceCommandInput | DeleteDBSubnetGroupCommandInput | DeleteEventSubscriptionCommandInput | DeleteGlobalClusterCommandInput | DescribeCertificatesCommandInput | DescribeDBClusterParameterGroupsCommandInput | DescribeDBClusterParametersCommandInput | DescribeDBClusterSnapshotAttributesCommandInput | DescribeDBClusterSnapshotsCommandInput | DescribeDBClustersCommandInput | DescribeDBEngineVersionsCommandInput | DescribeDBInstancesCommandInput | DescribeDBSubnetGroupsCommandInput | DescribeEngineDefaultClusterParametersCommandInput | DescribeEventCategoriesCommandInput | DescribeEventSubscriptionsCommandInput | DescribeEventsCommandInput | DescribeGlobalClustersCommandInput | DescribeOrderableDBInstanceOptionsCommandInput | DescribePendingMaintenanceActionsCommandInput | FailoverDBClusterCommandInput | ListTagsForResourceCommandInput | ModifyDBClusterCommandInput | ModifyDBClusterParameterGroupCommandInput | ModifyDBClusterSnapshotAttributeCommandInput | ModifyDBInstanceCommandInput | ModifyDBSubnetGroupCommandInput | ModifyEventSubscriptionCommandInput | ModifyGlobalClusterCommandInput | RebootDBInstanceCommandInput | RemoveFromGlobalClusterCommandInput | RemoveSourceIdentifierFromSubscriptionCommandInput | RemoveTagsFromResourceCommandInput | ResetDBClusterParameterGroupCommandInput | RestoreDBClusterFromSnapshotCommandInput | RestoreDBClusterToPointInTimeCommandInput | StartDBClusterCommandInput | StopDBClusterCommandInput;
|
|
68
|
+
/**
|
|
69
|
+
* @public
|
|
70
|
+
*/
|
|
65
71
|
export type ServiceOutputTypes = AddSourceIdentifierToSubscriptionCommandOutput | AddTagsToResourceCommandOutput | ApplyPendingMaintenanceActionCommandOutput | CopyDBClusterParameterGroupCommandOutput | CopyDBClusterSnapshotCommandOutput | CreateDBClusterCommandOutput | CreateDBClusterParameterGroupCommandOutput | CreateDBClusterSnapshotCommandOutput | CreateDBInstanceCommandOutput | CreateDBSubnetGroupCommandOutput | CreateEventSubscriptionCommandOutput | CreateGlobalClusterCommandOutput | DeleteDBClusterCommandOutput | DeleteDBClusterParameterGroupCommandOutput | DeleteDBClusterSnapshotCommandOutput | DeleteDBInstanceCommandOutput | DeleteDBSubnetGroupCommandOutput | DeleteEventSubscriptionCommandOutput | DeleteGlobalClusterCommandOutput | DescribeCertificatesCommandOutput | DescribeDBClusterParameterGroupsCommandOutput | DescribeDBClusterParametersCommandOutput | DescribeDBClusterSnapshotAttributesCommandOutput | DescribeDBClusterSnapshotsCommandOutput | DescribeDBClustersCommandOutput | DescribeDBEngineVersionsCommandOutput | DescribeDBInstancesCommandOutput | DescribeDBSubnetGroupsCommandOutput | DescribeEngineDefaultClusterParametersCommandOutput | DescribeEventCategoriesCommandOutput | DescribeEventSubscriptionsCommandOutput | DescribeEventsCommandOutput | DescribeGlobalClustersCommandOutput | DescribeOrderableDBInstanceOptionsCommandOutput | DescribePendingMaintenanceActionsCommandOutput | FailoverDBClusterCommandOutput | ListTagsForResourceCommandOutput | ModifyDBClusterCommandOutput | ModifyDBClusterParameterGroupCommandOutput | ModifyDBClusterSnapshotAttributeCommandOutput | ModifyDBInstanceCommandOutput | ModifyDBSubnetGroupCommandOutput | ModifyEventSubscriptionCommandOutput | ModifyGlobalClusterCommandOutput | RebootDBInstanceCommandOutput | RemoveFromGlobalClusterCommandOutput | RemoveSourceIdentifierFromSubscriptionCommandOutput | RemoveTagsFromResourceCommandOutput | ResetDBClusterParameterGroupCommandOutput | RestoreDBClusterFromSnapshotCommandOutput | RestoreDBClusterToPointInTimeCommandOutput | StartDBClusterCommandOutput | StopDBClusterCommandOutput;
|
|
72
|
+
/**
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
66
75
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
67
76
|
/**
|
|
68
77
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
69
78
|
*/
|
|
70
79
|
requestHandler?: __HttpHandler;
|
|
71
80
|
/**
|
|
72
|
-
* A constructor for a class implementing the {@link
|
|
81
|
+
* A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
|
|
73
82
|
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
|
|
74
83
|
* @internal
|
|
75
84
|
*/
|
|
@@ -159,23 +168,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
159
168
|
*/
|
|
160
169
|
logger?: __Logger;
|
|
161
170
|
/**
|
|
162
|
-
* The {@link
|
|
171
|
+
* The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
|
|
163
172
|
*/
|
|
164
173
|
defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
|
|
165
174
|
}
|
|
175
|
+
/**
|
|
176
|
+
* @public
|
|
177
|
+
*/
|
|
166
178
|
type DocDBClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
|
|
167
179
|
/**
|
|
168
|
-
*
|
|
180
|
+
* @public
|
|
181
|
+
*
|
|
182
|
+
* The configuration interface of DocDBClient class constructor that set the region, credentials and other options.
|
|
169
183
|
*/
|
|
170
184
|
export interface DocDBClientConfig extends DocDBClientConfigType {
|
|
171
185
|
}
|
|
186
|
+
/**
|
|
187
|
+
* @public
|
|
188
|
+
*/
|
|
172
189
|
type DocDBClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
|
|
173
190
|
/**
|
|
174
|
-
*
|
|
191
|
+
* @public
|
|
192
|
+
*
|
|
193
|
+
* The resolved configuration interface of DocDBClient class. This is resolved and normalized from the {@link DocDBClientConfig | constructor configuration interface}.
|
|
175
194
|
*/
|
|
176
195
|
export interface DocDBClientResolvedConfig extends DocDBClientResolvedConfigType {
|
|
177
196
|
}
|
|
178
197
|
/**
|
|
198
|
+
* @public
|
|
179
199
|
* <p>Amazon DocumentDB API documentation</p>
|
|
180
200
|
*/
|
|
181
201
|
export declare class DocDBClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, DocDBClientResolvedConfig> {
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
|
|
5
5
|
import { AddSourceIdentifierToSubscriptionMessage, AddSourceIdentifierToSubscriptionResult } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link AddSourceIdentifierToSubscriptionCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface AddSourceIdentifierToSubscriptionCommandInput extends AddSourceIdentifierToSubscriptionMessage {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link AddSourceIdentifierToSubscriptionCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface AddSourceIdentifierToSubscriptionCommandOutput extends AddSourceIdentifierToSubscriptionResult, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Adds a source identifier to an existing event notification
|
|
18
23
|
* subscription.</p>
|
|
19
24
|
* @example
|
|
@@ -26,6 +31,8 @@ export interface AddSourceIdentifierToSubscriptionCommandOutput extends AddSourc
|
|
|
26
31
|
* const response = await client.send(command);
|
|
27
32
|
* ```
|
|
28
33
|
*
|
|
34
|
+
* @param AddSourceIdentifierToSubscriptionCommandInput - {@link AddSourceIdentifierToSubscriptionCommandInput}
|
|
35
|
+
* @returns {@link AddSourceIdentifierToSubscriptionCommandOutput}
|
|
29
36
|
* @see {@link AddSourceIdentifierToSubscriptionCommandInput} for command's `input` shape.
|
|
30
37
|
* @see {@link AddSourceIdentifierToSubscriptionCommandOutput} for command's `response` shape.
|
|
31
38
|
* @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
|
|
@@ -41,11 +48,20 @@ export interface AddSourceIdentifierToSubscriptionCommandOutput extends AddSourc
|
|
|
41
48
|
export declare class AddSourceIdentifierToSubscriptionCommand extends $Command<AddSourceIdentifierToSubscriptionCommandInput, AddSourceIdentifierToSubscriptionCommandOutput, DocDBClientResolvedConfig> {
|
|
42
49
|
readonly input: AddSourceIdentifierToSubscriptionCommandInput;
|
|
43
50
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
51
|
+
/**
|
|
52
|
+
* @public
|
|
53
|
+
*/
|
|
44
54
|
constructor(input: AddSourceIdentifierToSubscriptionCommandInput);
|
|
45
55
|
/**
|
|
46
56
|
* @internal
|
|
47
57
|
*/
|
|
48
58
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AddSourceIdentifierToSubscriptionCommandInput, AddSourceIdentifierToSubscriptionCommandOutput>;
|
|
59
|
+
/**
|
|
60
|
+
* @internal
|
|
61
|
+
*/
|
|
49
62
|
private serialize;
|
|
63
|
+
/**
|
|
64
|
+
* @internal
|
|
65
|
+
*/
|
|
50
66
|
private deserialize;
|
|
51
67
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
|
|
5
5
|
import { AddTagsToResourceMessage } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link AddTagsToResourceCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface AddTagsToResourceCommandInput extends AddTagsToResourceMessage {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link AddTagsToResourceCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface AddTagsToResourceCommandOutput extends __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Adds metadata tags to an Amazon DocumentDB resource. You can use these tags
|
|
18
23
|
* with cost allocation reporting to track costs that are associated
|
|
19
24
|
* with Amazon DocumentDB resources or in a <code>Condition</code> statement in
|
|
@@ -28,6 +33,8 @@ export interface AddTagsToResourceCommandOutput extends __MetadataBearer {
|
|
|
28
33
|
* const response = await client.send(command);
|
|
29
34
|
* ```
|
|
30
35
|
*
|
|
36
|
+
* @param AddTagsToResourceCommandInput - {@link AddTagsToResourceCommandInput}
|
|
37
|
+
* @returns {@link AddTagsToResourceCommandOutput}
|
|
31
38
|
* @see {@link AddTagsToResourceCommandInput} for command's `input` shape.
|
|
32
39
|
* @see {@link AddTagsToResourceCommandOutput} for command's `response` shape.
|
|
33
40
|
* @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
|
|
@@ -49,11 +56,20 @@ export interface AddTagsToResourceCommandOutput extends __MetadataBearer {
|
|
|
49
56
|
export declare class AddTagsToResourceCommand extends $Command<AddTagsToResourceCommandInput, AddTagsToResourceCommandOutput, DocDBClientResolvedConfig> {
|
|
50
57
|
readonly input: AddTagsToResourceCommandInput;
|
|
51
58
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
59
|
+
/**
|
|
60
|
+
* @public
|
|
61
|
+
*/
|
|
52
62
|
constructor(input: AddTagsToResourceCommandInput);
|
|
53
63
|
/**
|
|
54
64
|
* @internal
|
|
55
65
|
*/
|
|
56
66
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AddTagsToResourceCommandInput, AddTagsToResourceCommandOutput>;
|
|
67
|
+
/**
|
|
68
|
+
* @internal
|
|
69
|
+
*/
|
|
57
70
|
private serialize;
|
|
71
|
+
/**
|
|
72
|
+
* @internal
|
|
73
|
+
*/
|
|
58
74
|
private deserialize;
|
|
59
75
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { DocDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBClient";
|
|
5
5
|
import { ApplyPendingMaintenanceActionMessage, ApplyPendingMaintenanceActionResult } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link ApplyPendingMaintenanceActionCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface ApplyPendingMaintenanceActionCommandInput extends ApplyPendingMaintenanceActionMessage {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link ApplyPendingMaintenanceActionCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface ApplyPendingMaintenanceActionCommandOutput extends ApplyPendingMaintenanceActionResult, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Applies a pending maintenance action to a resource (for example,
|
|
18
23
|
* to an Amazon DocumentDB instance).</p>
|
|
19
24
|
* @example
|
|
@@ -26,6 +31,8 @@ export interface ApplyPendingMaintenanceActionCommandOutput extends ApplyPending
|
|
|
26
31
|
* const response = await client.send(command);
|
|
27
32
|
* ```
|
|
28
33
|
*
|
|
34
|
+
* @param ApplyPendingMaintenanceActionCommandInput - {@link ApplyPendingMaintenanceActionCommandInput}
|
|
35
|
+
* @returns {@link ApplyPendingMaintenanceActionCommandOutput}
|
|
29
36
|
* @see {@link ApplyPendingMaintenanceActionCommandInput} for command's `input` shape.
|
|
30
37
|
* @see {@link ApplyPendingMaintenanceActionCommandOutput} for command's `response` shape.
|
|
31
38
|
* @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
|
|
@@ -45,11 +52,20 @@ export interface ApplyPendingMaintenanceActionCommandOutput extends ApplyPending
|
|
|
45
52
|
export declare class ApplyPendingMaintenanceActionCommand extends $Command<ApplyPendingMaintenanceActionCommandInput, ApplyPendingMaintenanceActionCommandOutput, DocDBClientResolvedConfig> {
|
|
46
53
|
readonly input: ApplyPendingMaintenanceActionCommandInput;
|
|
47
54
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
55
|
+
/**
|
|
56
|
+
* @public
|
|
57
|
+
*/
|
|
48
58
|
constructor(input: ApplyPendingMaintenanceActionCommandInput);
|
|
49
59
|
/**
|
|
50
60
|
* @internal
|
|
51
61
|
*/
|
|
52
62
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DocDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ApplyPendingMaintenanceActionCommandInput, ApplyPendingMaintenanceActionCommandOutput>;
|
|
63
|
+
/**
|
|
64
|
+
* @internal
|
|
65
|
+
*/
|
|
53
66
|
private serialize;
|
|
67
|
+
/**
|
|
68
|
+
* @internal
|
|
69
|
+
*/
|
|
54
70
|
private deserialize;
|
|
55
71
|
}
|