@aws-sdk/client-docdb 3.315.0 → 3.319.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/DocDB.js +57 -742
- package/dist-es/DocDB.js +57 -742
- package/dist-types/DocDB.d.ts +60 -233
- package/dist-types/ts3.4/DocDB.d.ts +2 -1
- package/package.json +9 -9
package/dist-types/DocDB.d.ts
CHANGED
|
@@ -53,502 +53,329 @@ import { RestoreDBClusterToPointInTimeCommandInput, RestoreDBClusterToPointInTim
|
|
|
53
53
|
import { StartDBClusterCommandInput, StartDBClusterCommandOutput } from "./commands/StartDBClusterCommand";
|
|
54
54
|
import { StopDBClusterCommandInput, StopDBClusterCommandOutput } from "./commands/StopDBClusterCommand";
|
|
55
55
|
import { DocDBClient } from "./DocDBClient";
|
|
56
|
-
|
|
57
|
-
* @public
|
|
58
|
-
* <p>Amazon DocumentDB API documentation</p>
|
|
59
|
-
*/
|
|
60
|
-
export declare class DocDB extends DocDBClient {
|
|
56
|
+
export interface DocDB {
|
|
61
57
|
/**
|
|
62
|
-
* @
|
|
63
|
-
* <p>Adds a source identifier to an existing event notification
|
|
64
|
-
* subscription.</p>
|
|
58
|
+
* @see {@link AddSourceIdentifierToSubscriptionCommand}
|
|
65
59
|
*/
|
|
66
60
|
addSourceIdentifierToSubscription(args: AddSourceIdentifierToSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<AddSourceIdentifierToSubscriptionCommandOutput>;
|
|
67
61
|
addSourceIdentifierToSubscription(args: AddSourceIdentifierToSubscriptionCommandInput, cb: (err: any, data?: AddSourceIdentifierToSubscriptionCommandOutput) => void): void;
|
|
68
62
|
addSourceIdentifierToSubscription(args: AddSourceIdentifierToSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddSourceIdentifierToSubscriptionCommandOutput) => void): void;
|
|
69
63
|
/**
|
|
70
|
-
* @
|
|
71
|
-
* <p>Adds metadata tags to an Amazon DocumentDB resource. You can use these tags
|
|
72
|
-
* with cost allocation reporting to track costs that are associated
|
|
73
|
-
* with Amazon DocumentDB resources or in a <code>Condition</code> statement in
|
|
74
|
-
* an Identity and Access Management (IAM) policy for Amazon DocumentDB.</p>
|
|
64
|
+
* @see {@link AddTagsToResourceCommand}
|
|
75
65
|
*/
|
|
76
66
|
addTagsToResource(args: AddTagsToResourceCommandInput, options?: __HttpHandlerOptions): Promise<AddTagsToResourceCommandOutput>;
|
|
77
67
|
addTagsToResource(args: AddTagsToResourceCommandInput, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void): void;
|
|
78
68
|
addTagsToResource(args: AddTagsToResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsToResourceCommandOutput) => void): void;
|
|
79
69
|
/**
|
|
80
|
-
* @
|
|
81
|
-
* <p>Applies a pending maintenance action to a resource (for example,
|
|
82
|
-
* to an Amazon DocumentDB instance).</p>
|
|
70
|
+
* @see {@link ApplyPendingMaintenanceActionCommand}
|
|
83
71
|
*/
|
|
84
72
|
applyPendingMaintenanceAction(args: ApplyPendingMaintenanceActionCommandInput, options?: __HttpHandlerOptions): Promise<ApplyPendingMaintenanceActionCommandOutput>;
|
|
85
73
|
applyPendingMaintenanceAction(args: ApplyPendingMaintenanceActionCommandInput, cb: (err: any, data?: ApplyPendingMaintenanceActionCommandOutput) => void): void;
|
|
86
74
|
applyPendingMaintenanceAction(args: ApplyPendingMaintenanceActionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ApplyPendingMaintenanceActionCommandOutput) => void): void;
|
|
87
75
|
/**
|
|
88
|
-
* @
|
|
89
|
-
* <p>Copies the specified cluster parameter group.</p>
|
|
76
|
+
* @see {@link CopyDBClusterParameterGroupCommand}
|
|
90
77
|
*/
|
|
91
78
|
copyDBClusterParameterGroup(args: CopyDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions): Promise<CopyDBClusterParameterGroupCommandOutput>;
|
|
92
79
|
copyDBClusterParameterGroup(args: CopyDBClusterParameterGroupCommandInput, cb: (err: any, data?: CopyDBClusterParameterGroupCommandOutput) => void): void;
|
|
93
80
|
copyDBClusterParameterGroup(args: CopyDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyDBClusterParameterGroupCommandOutput) => void): void;
|
|
94
81
|
/**
|
|
95
|
-
* @
|
|
96
|
-
* <p>Copies a snapshot of a cluster.</p>
|
|
97
|
-
* <p>To copy a cluster snapshot from a shared manual cluster snapshot,
|
|
98
|
-
* <code>SourceDBClusterSnapshotIdentifier</code> must be the Amazon
|
|
99
|
-
* Resource Name (ARN) of the shared cluster snapshot. You can only
|
|
100
|
-
* copy a shared DB cluster snapshot, whether encrypted or not, in the
|
|
101
|
-
* same Amazon Web Services Region.</p>
|
|
102
|
-
* <p>To cancel the copy operation after it is in progress, delete the
|
|
103
|
-
* target cluster snapshot identified by
|
|
104
|
-
* <code>TargetDBClusterSnapshotIdentifier</code> while that cluster
|
|
105
|
-
* snapshot is in the <i>copying</i> status.</p>
|
|
82
|
+
* @see {@link CopyDBClusterSnapshotCommand}
|
|
106
83
|
*/
|
|
107
84
|
copyDBClusterSnapshot(args: CopyDBClusterSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<CopyDBClusterSnapshotCommandOutput>;
|
|
108
85
|
copyDBClusterSnapshot(args: CopyDBClusterSnapshotCommandInput, cb: (err: any, data?: CopyDBClusterSnapshotCommandOutput) => void): void;
|
|
109
86
|
copyDBClusterSnapshot(args: CopyDBClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyDBClusterSnapshotCommandOutput) => void): void;
|
|
110
87
|
/**
|
|
111
|
-
* @
|
|
112
|
-
* <p>Creates a new Amazon DocumentDB cluster.</p>
|
|
88
|
+
* @see {@link CreateDBClusterCommand}
|
|
113
89
|
*/
|
|
114
90
|
createDBCluster(args: CreateDBClusterCommandInput, options?: __HttpHandlerOptions): Promise<CreateDBClusterCommandOutput>;
|
|
115
91
|
createDBCluster(args: CreateDBClusterCommandInput, cb: (err: any, data?: CreateDBClusterCommandOutput) => void): void;
|
|
116
92
|
createDBCluster(args: CreateDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBClusterCommandOutput) => void): void;
|
|
117
93
|
/**
|
|
118
|
-
* @
|
|
119
|
-
* <p>Creates a new cluster parameter group.</p>
|
|
120
|
-
* <p>Parameters in a cluster parameter group apply to all of the
|
|
121
|
-
* instances in a cluster.</p>
|
|
122
|
-
* <p>A cluster parameter group is initially created with the default
|
|
123
|
-
* parameters for the database engine used by instances in the cluster.
|
|
124
|
-
* In Amazon DocumentDB, you cannot make modifications directly to the
|
|
125
|
-
* <code>default.docdb3.6</code> cluster parameter group. If your
|
|
126
|
-
* Amazon DocumentDB cluster is using the default cluster parameter group and you
|
|
127
|
-
* want to modify a value in it, you must first <a href="https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-create.html">
|
|
128
|
-
* create a new parameter group</a>
|
|
129
|
-
* or <a href="https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-copy.html">
|
|
130
|
-
* copy an existing parameter group</a>,
|
|
131
|
-
* modify it, and then apply the modified parameter group to your
|
|
132
|
-
* cluster. For the new cluster parameter group and associated settings
|
|
133
|
-
* to take effect, you must then reboot the instances in the cluster
|
|
134
|
-
* without failover. For more information,
|
|
135
|
-
* see <a href="https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-modify.html">
|
|
136
|
-
* Modifying Amazon DocumentDB Cluster Parameter Groups</a>.
|
|
137
|
-
* </p>
|
|
94
|
+
* @see {@link CreateDBClusterParameterGroupCommand}
|
|
138
95
|
*/
|
|
139
96
|
createDBClusterParameterGroup(args: CreateDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateDBClusterParameterGroupCommandOutput>;
|
|
140
97
|
createDBClusterParameterGroup(args: CreateDBClusterParameterGroupCommandInput, cb: (err: any, data?: CreateDBClusterParameterGroupCommandOutput) => void): void;
|
|
141
98
|
createDBClusterParameterGroup(args: CreateDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBClusterParameterGroupCommandOutput) => void): void;
|
|
142
99
|
/**
|
|
143
|
-
* @
|
|
144
|
-
* <p>Creates a snapshot of a cluster. </p>
|
|
100
|
+
* @see {@link CreateDBClusterSnapshotCommand}
|
|
145
101
|
*/
|
|
146
102
|
createDBClusterSnapshot(args: CreateDBClusterSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<CreateDBClusterSnapshotCommandOutput>;
|
|
147
103
|
createDBClusterSnapshot(args: CreateDBClusterSnapshotCommandInput, cb: (err: any, data?: CreateDBClusterSnapshotCommandOutput) => void): void;
|
|
148
104
|
createDBClusterSnapshot(args: CreateDBClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBClusterSnapshotCommandOutput) => void): void;
|
|
149
105
|
/**
|
|
150
|
-
* @
|
|
151
|
-
* <p>Creates a new instance.</p>
|
|
106
|
+
* @see {@link CreateDBInstanceCommand}
|
|
152
107
|
*/
|
|
153
108
|
createDBInstance(args: CreateDBInstanceCommandInput, options?: __HttpHandlerOptions): Promise<CreateDBInstanceCommandOutput>;
|
|
154
109
|
createDBInstance(args: CreateDBInstanceCommandInput, cb: (err: any, data?: CreateDBInstanceCommandOutput) => void): void;
|
|
155
110
|
createDBInstance(args: CreateDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBInstanceCommandOutput) => void): void;
|
|
156
111
|
/**
|
|
157
|
-
* @
|
|
158
|
-
* <p>Creates a new subnet group. subnet groups must contain at least one subnet in at
|
|
159
|
-
* least two Availability Zones in the Amazon Web Services Region.</p>
|
|
112
|
+
* @see {@link CreateDBSubnetGroupCommand}
|
|
160
113
|
*/
|
|
161
114
|
createDBSubnetGroup(args: CreateDBSubnetGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateDBSubnetGroupCommandOutput>;
|
|
162
115
|
createDBSubnetGroup(args: CreateDBSubnetGroupCommandInput, cb: (err: any, data?: CreateDBSubnetGroupCommandOutput) => void): void;
|
|
163
116
|
createDBSubnetGroup(args: CreateDBSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDBSubnetGroupCommandOutput) => void): void;
|
|
164
117
|
/**
|
|
165
|
-
* @
|
|
166
|
-
* <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>
|
|
167
|
-
* <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>
|
|
168
|
-
* <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>
|
|
118
|
+
* @see {@link CreateEventSubscriptionCommand}
|
|
169
119
|
*/
|
|
170
120
|
createEventSubscription(args: CreateEventSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<CreateEventSubscriptionCommandOutput>;
|
|
171
121
|
createEventSubscription(args: CreateEventSubscriptionCommandInput, cb: (err: any, data?: CreateEventSubscriptionCommandOutput) => void): void;
|
|
172
122
|
createEventSubscription(args: CreateEventSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEventSubscriptionCommandOutput) => void): void;
|
|
173
123
|
/**
|
|
174
|
-
* @
|
|
175
|
-
* <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>
|
|
176
|
-
* <p></p>
|
|
177
|
-
* <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>
|
|
178
|
-
* <note>
|
|
179
|
-
* <p>This action only applies to Amazon DocumentDB clusters.</p>
|
|
180
|
-
* </note>
|
|
124
|
+
* @see {@link CreateGlobalClusterCommand}
|
|
181
125
|
*/
|
|
182
126
|
createGlobalCluster(args: CreateGlobalClusterCommandInput, options?: __HttpHandlerOptions): Promise<CreateGlobalClusterCommandOutput>;
|
|
183
127
|
createGlobalCluster(args: CreateGlobalClusterCommandInput, cb: (err: any, data?: CreateGlobalClusterCommandOutput) => void): void;
|
|
184
128
|
createGlobalCluster(args: CreateGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGlobalClusterCommandOutput) => void): void;
|
|
185
129
|
/**
|
|
186
|
-
* @
|
|
187
|
-
* <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>
|
|
188
|
-
* <p></p>
|
|
130
|
+
* @see {@link DeleteDBClusterCommand}
|
|
189
131
|
*/
|
|
190
132
|
deleteDBCluster(args: DeleteDBClusterCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDBClusterCommandOutput>;
|
|
191
133
|
deleteDBCluster(args: DeleteDBClusterCommandInput, cb: (err: any, data?: DeleteDBClusterCommandOutput) => void): void;
|
|
192
134
|
deleteDBCluster(args: DeleteDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBClusterCommandOutput) => void): void;
|
|
193
135
|
/**
|
|
194
|
-
* @
|
|
195
|
-
* <p>Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.</p>
|
|
136
|
+
* @see {@link DeleteDBClusterParameterGroupCommand}
|
|
196
137
|
*/
|
|
197
138
|
deleteDBClusterParameterGroup(args: DeleteDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDBClusterParameterGroupCommandOutput>;
|
|
198
139
|
deleteDBClusterParameterGroup(args: DeleteDBClusterParameterGroupCommandInput, cb: (err: any, data?: DeleteDBClusterParameterGroupCommandOutput) => void): void;
|
|
199
140
|
deleteDBClusterParameterGroup(args: DeleteDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBClusterParameterGroupCommandOutput) => void): void;
|
|
200
141
|
/**
|
|
201
|
-
* @
|
|
202
|
-
* <p>Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.</p>
|
|
203
|
-
* <note>
|
|
204
|
-
* <p>The cluster snapshot must be in the <code>available</code> state to be deleted.</p>
|
|
205
|
-
* </note>
|
|
142
|
+
* @see {@link DeleteDBClusterSnapshotCommand}
|
|
206
143
|
*/
|
|
207
144
|
deleteDBClusterSnapshot(args: DeleteDBClusterSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDBClusterSnapshotCommandOutput>;
|
|
208
145
|
deleteDBClusterSnapshot(args: DeleteDBClusterSnapshotCommandInput, cb: (err: any, data?: DeleteDBClusterSnapshotCommandOutput) => void): void;
|
|
209
146
|
deleteDBClusterSnapshot(args: DeleteDBClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBClusterSnapshotCommandOutput) => void): void;
|
|
210
147
|
/**
|
|
211
|
-
* @
|
|
212
|
-
* <p>Deletes a previously provisioned instance.</p>
|
|
148
|
+
* @see {@link DeleteDBInstanceCommand}
|
|
213
149
|
*/
|
|
214
150
|
deleteDBInstance(args: DeleteDBInstanceCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDBInstanceCommandOutput>;
|
|
215
151
|
deleteDBInstance(args: DeleteDBInstanceCommandInput, cb: (err: any, data?: DeleteDBInstanceCommandOutput) => void): void;
|
|
216
152
|
deleteDBInstance(args: DeleteDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBInstanceCommandOutput) => void): void;
|
|
217
153
|
/**
|
|
218
|
-
* @
|
|
219
|
-
* <p>Deletes a subnet group.</p>
|
|
220
|
-
* <note>
|
|
221
|
-
* <p>The specified database subnet group must not be associated with any DB
|
|
222
|
-
* instances.</p>
|
|
223
|
-
* </note>
|
|
154
|
+
* @see {@link DeleteDBSubnetGroupCommand}
|
|
224
155
|
*/
|
|
225
156
|
deleteDBSubnetGroup(args: DeleteDBSubnetGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDBSubnetGroupCommandOutput>;
|
|
226
157
|
deleteDBSubnetGroup(args: DeleteDBSubnetGroupCommandInput, cb: (err: any, data?: DeleteDBSubnetGroupCommandOutput) => void): void;
|
|
227
158
|
deleteDBSubnetGroup(args: DeleteDBSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDBSubnetGroupCommandOutput) => void): void;
|
|
228
159
|
/**
|
|
229
|
-
* @
|
|
230
|
-
* <p>Deletes an Amazon DocumentDB event notification subscription.</p>
|
|
160
|
+
* @see {@link DeleteEventSubscriptionCommand}
|
|
231
161
|
*/
|
|
232
162
|
deleteEventSubscription(args: DeleteEventSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEventSubscriptionCommandOutput>;
|
|
233
163
|
deleteEventSubscription(args: DeleteEventSubscriptionCommandInput, cb: (err: any, data?: DeleteEventSubscriptionCommandOutput) => void): void;
|
|
234
164
|
deleteEventSubscription(args: DeleteEventSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEventSubscriptionCommandOutput) => void): void;
|
|
235
165
|
/**
|
|
236
|
-
* @
|
|
237
|
-
* <p>Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.</p>
|
|
238
|
-
* <note>
|
|
239
|
-
* <p>This action only applies to Amazon DocumentDB clusters.</p>
|
|
240
|
-
* </note>
|
|
166
|
+
* @see {@link DeleteGlobalClusterCommand}
|
|
241
167
|
*/
|
|
242
168
|
deleteGlobalCluster(args: DeleteGlobalClusterCommandInput, options?: __HttpHandlerOptions): Promise<DeleteGlobalClusterCommandOutput>;
|
|
243
169
|
deleteGlobalCluster(args: DeleteGlobalClusterCommandInput, cb: (err: any, data?: DeleteGlobalClusterCommandOutput) => void): void;
|
|
244
170
|
deleteGlobalCluster(args: DeleteGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGlobalClusterCommandOutput) => void): void;
|
|
245
171
|
/**
|
|
246
|
-
* @
|
|
247
|
-
* <p>Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.</p>
|
|
172
|
+
* @see {@link DescribeCertificatesCommand}
|
|
248
173
|
*/
|
|
249
174
|
describeCertificates(args: DescribeCertificatesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCertificatesCommandOutput>;
|
|
250
175
|
describeCertificates(args: DescribeCertificatesCommandInput, cb: (err: any, data?: DescribeCertificatesCommandOutput) => void): void;
|
|
251
176
|
describeCertificates(args: DescribeCertificatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCertificatesCommandOutput) => void): void;
|
|
252
177
|
/**
|
|
253
|
-
* @
|
|
254
|
-
* <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>
|
|
178
|
+
* @see {@link DescribeDBClusterParameterGroupsCommand}
|
|
255
179
|
*/
|
|
256
180
|
describeDBClusterParameterGroups(args: DescribeDBClusterParameterGroupsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDBClusterParameterGroupsCommandOutput>;
|
|
257
181
|
describeDBClusterParameterGroups(args: DescribeDBClusterParameterGroupsCommandInput, cb: (err: any, data?: DescribeDBClusterParameterGroupsCommandOutput) => void): void;
|
|
258
182
|
describeDBClusterParameterGroups(args: DescribeDBClusterParameterGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterParameterGroupsCommandOutput) => void): void;
|
|
259
183
|
/**
|
|
260
|
-
* @
|
|
261
|
-
* <p>Returns the detailed parameter list for a particular cluster parameter
|
|
262
|
-
* group.</p>
|
|
184
|
+
* @see {@link DescribeDBClusterParametersCommand}
|
|
263
185
|
*/
|
|
264
186
|
describeDBClusterParameters(args: DescribeDBClusterParametersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDBClusterParametersCommandOutput>;
|
|
265
187
|
describeDBClusterParameters(args: DescribeDBClusterParametersCommandInput, cb: (err: any, data?: DescribeDBClusterParametersCommandOutput) => void): void;
|
|
266
188
|
describeDBClusterParameters(args: DescribeDBClusterParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterParametersCommandOutput) => void): void;
|
|
267
189
|
/**
|
|
268
|
-
* @
|
|
269
|
-
* <p>Returns information about provisioned Amazon DocumentDB clusters. This API
|
|
270
|
-
* operation supports pagination. For certain management features
|
|
271
|
-
* such as cluster and instance lifecycle management, Amazon DocumentDB leverages
|
|
272
|
-
* operational technology that is shared with Amazon RDS and Amazon
|
|
273
|
-
* Neptune. Use the <code>filterName=engine,Values=docdb</code> filter
|
|
274
|
-
* parameter to return only Amazon DocumentDB clusters.</p>
|
|
190
|
+
* @see {@link DescribeDBClustersCommand}
|
|
275
191
|
*/
|
|
276
192
|
describeDBClusters(args: DescribeDBClustersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDBClustersCommandOutput>;
|
|
277
193
|
describeDBClusters(args: DescribeDBClustersCommandInput, cb: (err: any, data?: DescribeDBClustersCommandOutput) => void): void;
|
|
278
194
|
describeDBClusters(args: DescribeDBClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClustersCommandOutput) => void): void;
|
|
279
195
|
/**
|
|
280
|
-
* @
|
|
281
|
-
* <p>Returns a list of cluster snapshot attribute names and values for a manual DB
|
|
282
|
-
* cluster snapshot.</p>
|
|
283
|
-
* <p>When you share snapshots with other Amazon Web Services accounts,
|
|
284
|
-
* <code>DescribeDBClusterSnapshotAttributes</code> returns the <code>restore</code> attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If <code>all</code> is included in the list of values for the <code>restore</code> attribute, then the manual cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.</p>
|
|
196
|
+
* @see {@link DescribeDBClusterSnapshotAttributesCommand}
|
|
285
197
|
*/
|
|
286
198
|
describeDBClusterSnapshotAttributes(args: DescribeDBClusterSnapshotAttributesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDBClusterSnapshotAttributesCommandOutput>;
|
|
287
199
|
describeDBClusterSnapshotAttributes(args: DescribeDBClusterSnapshotAttributesCommandInput, cb: (err: any, data?: DescribeDBClusterSnapshotAttributesCommandOutput) => void): void;
|
|
288
200
|
describeDBClusterSnapshotAttributes(args: DescribeDBClusterSnapshotAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterSnapshotAttributesCommandOutput) => void): void;
|
|
289
201
|
/**
|
|
290
|
-
* @
|
|
291
|
-
* <p>Returns information about cluster snapshots. This API operation supports pagination.</p>
|
|
202
|
+
* @see {@link DescribeDBClusterSnapshotsCommand}
|
|
292
203
|
*/
|
|
293
204
|
describeDBClusterSnapshots(args: DescribeDBClusterSnapshotsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDBClusterSnapshotsCommandOutput>;
|
|
294
205
|
describeDBClusterSnapshots(args: DescribeDBClusterSnapshotsCommandInput, cb: (err: any, data?: DescribeDBClusterSnapshotsCommandOutput) => void): void;
|
|
295
206
|
describeDBClusterSnapshots(args: DescribeDBClusterSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBClusterSnapshotsCommandOutput) => void): void;
|
|
296
207
|
/**
|
|
297
|
-
* @
|
|
298
|
-
* <p>Returns a list of the available engines.</p>
|
|
208
|
+
* @see {@link DescribeDBEngineVersionsCommand}
|
|
299
209
|
*/
|
|
300
210
|
describeDBEngineVersions(args: DescribeDBEngineVersionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDBEngineVersionsCommandOutput>;
|
|
301
211
|
describeDBEngineVersions(args: DescribeDBEngineVersionsCommandInput, cb: (err: any, data?: DescribeDBEngineVersionsCommandOutput) => void): void;
|
|
302
212
|
describeDBEngineVersions(args: DescribeDBEngineVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBEngineVersionsCommandOutput) => void): void;
|
|
303
213
|
/**
|
|
304
|
-
* @
|
|
305
|
-
* <p>Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.</p>
|
|
214
|
+
* @see {@link DescribeDBInstancesCommand}
|
|
306
215
|
*/
|
|
307
216
|
describeDBInstances(args: DescribeDBInstancesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDBInstancesCommandOutput>;
|
|
308
217
|
describeDBInstances(args: DescribeDBInstancesCommandInput, cb: (err: any, data?: DescribeDBInstancesCommandOutput) => void): void;
|
|
309
218
|
describeDBInstances(args: DescribeDBInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBInstancesCommandOutput) => void): void;
|
|
310
219
|
/**
|
|
311
|
-
* @
|
|
312
|
-
* <p>Returns a list of <code>DBSubnetGroup</code> descriptions. If a
|
|
313
|
-
* <code>DBSubnetGroupName</code> is specified, the list will contain only the descriptions of the specified <code>DBSubnetGroup</code>.</p>
|
|
220
|
+
* @see {@link DescribeDBSubnetGroupsCommand}
|
|
314
221
|
*/
|
|
315
222
|
describeDBSubnetGroups(args: DescribeDBSubnetGroupsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDBSubnetGroupsCommandOutput>;
|
|
316
223
|
describeDBSubnetGroups(args: DescribeDBSubnetGroupsCommandInput, cb: (err: any, data?: DescribeDBSubnetGroupsCommandOutput) => void): void;
|
|
317
224
|
describeDBSubnetGroups(args: DescribeDBSubnetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDBSubnetGroupsCommandOutput) => void): void;
|
|
318
225
|
/**
|
|
319
|
-
* @
|
|
320
|
-
* <p>Returns the default engine and system parameter information for the cluster database
|
|
321
|
-
* engine.</p>
|
|
226
|
+
* @see {@link DescribeEngineDefaultClusterParametersCommand}
|
|
322
227
|
*/
|
|
323
228
|
describeEngineDefaultClusterParameters(args: DescribeEngineDefaultClusterParametersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEngineDefaultClusterParametersCommandOutput>;
|
|
324
229
|
describeEngineDefaultClusterParameters(args: DescribeEngineDefaultClusterParametersCommandInput, cb: (err: any, data?: DescribeEngineDefaultClusterParametersCommandOutput) => void): void;
|
|
325
230
|
describeEngineDefaultClusterParameters(args: DescribeEngineDefaultClusterParametersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEngineDefaultClusterParametersCommandOutput) => void): void;
|
|
326
231
|
/**
|
|
327
|
-
* @
|
|
328
|
-
* <p>Displays a list of categories for all event source types, or, if specified, for a
|
|
329
|
-
* specified source type. </p>
|
|
232
|
+
* @see {@link DescribeEventCategoriesCommand}
|
|
330
233
|
*/
|
|
331
234
|
describeEventCategories(args: DescribeEventCategoriesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventCategoriesCommandOutput>;
|
|
332
235
|
describeEventCategories(args: DescribeEventCategoriesCommandInput, cb: (err: any, data?: DescribeEventCategoriesCommandOutput) => void): void;
|
|
333
236
|
describeEventCategories(args: DescribeEventCategoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventCategoriesCommandOutput) => void): void;
|
|
334
237
|
/**
|
|
335
|
-
* @
|
|
336
|
-
* <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>
|
|
238
|
+
* @see {@link DescribeEventsCommand}
|
|
337
239
|
*/
|
|
338
240
|
describeEvents(args: DescribeEventsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventsCommandOutput>;
|
|
339
241
|
describeEvents(args: DescribeEventsCommandInput, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void;
|
|
340
242
|
describeEvents(args: DescribeEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsCommandOutput) => void): void;
|
|
341
243
|
/**
|
|
342
|
-
* @
|
|
343
|
-
* <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>
|
|
344
|
-
* <p>If you specify a <code>SubscriptionName</code>, lists the description for that subscription.</p>
|
|
244
|
+
* @see {@link DescribeEventSubscriptionsCommand}
|
|
345
245
|
*/
|
|
346
246
|
describeEventSubscriptions(args: DescribeEventSubscriptionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventSubscriptionsCommandOutput>;
|
|
347
247
|
describeEventSubscriptions(args: DescribeEventSubscriptionsCommandInput, cb: (err: any, data?: DescribeEventSubscriptionsCommandOutput) => void): void;
|
|
348
248
|
describeEventSubscriptions(args: DescribeEventSubscriptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventSubscriptionsCommandOutput) => void): void;
|
|
349
249
|
/**
|
|
350
|
-
* @
|
|
351
|
-
* <p>Returns information about Amazon DocumentDB global clusters. This API supports pagination.</p>
|
|
352
|
-
* <note>
|
|
353
|
-
* <p>This action only applies to Amazon DocumentDB clusters.</p>
|
|
354
|
-
* </note>
|
|
250
|
+
* @see {@link DescribeGlobalClustersCommand}
|
|
355
251
|
*/
|
|
356
252
|
describeGlobalClusters(args: DescribeGlobalClustersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGlobalClustersCommandOutput>;
|
|
357
253
|
describeGlobalClusters(args: DescribeGlobalClustersCommandInput, cb: (err: any, data?: DescribeGlobalClustersCommandOutput) => void): void;
|
|
358
254
|
describeGlobalClusters(args: DescribeGlobalClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGlobalClustersCommandOutput) => void): void;
|
|
359
255
|
/**
|
|
360
|
-
* @
|
|
361
|
-
* <p>Returns a list of orderable instance options for the specified engine.</p>
|
|
256
|
+
* @see {@link DescribeOrderableDBInstanceOptionsCommand}
|
|
362
257
|
*/
|
|
363
258
|
describeOrderableDBInstanceOptions(args: DescribeOrderableDBInstanceOptionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeOrderableDBInstanceOptionsCommandOutput>;
|
|
364
259
|
describeOrderableDBInstanceOptions(args: DescribeOrderableDBInstanceOptionsCommandInput, cb: (err: any, data?: DescribeOrderableDBInstanceOptionsCommandOutput) => void): void;
|
|
365
260
|
describeOrderableDBInstanceOptions(args: DescribeOrderableDBInstanceOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrderableDBInstanceOptionsCommandOutput) => void): void;
|
|
366
261
|
/**
|
|
367
|
-
* @
|
|
368
|
-
* <p>Returns a list of resources (for example, instances) that have at least one pending
|
|
369
|
-
* maintenance action.</p>
|
|
262
|
+
* @see {@link DescribePendingMaintenanceActionsCommand}
|
|
370
263
|
*/
|
|
371
264
|
describePendingMaintenanceActions(args: DescribePendingMaintenanceActionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribePendingMaintenanceActionsCommandOutput>;
|
|
372
265
|
describePendingMaintenanceActions(args: DescribePendingMaintenanceActionsCommandInput, cb: (err: any, data?: DescribePendingMaintenanceActionsCommandOutput) => void): void;
|
|
373
266
|
describePendingMaintenanceActions(args: DescribePendingMaintenanceActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePendingMaintenanceActionsCommandOutput) => void): void;
|
|
374
267
|
/**
|
|
375
|
-
* @
|
|
376
|
-
* <p>Forces a failover for a cluster.</p>
|
|
377
|
-
* <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>
|
|
378
|
-
* <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>
|
|
268
|
+
* @see {@link FailoverDBClusterCommand}
|
|
379
269
|
*/
|
|
380
270
|
failoverDBCluster(args: FailoverDBClusterCommandInput, options?: __HttpHandlerOptions): Promise<FailoverDBClusterCommandOutput>;
|
|
381
271
|
failoverDBCluster(args: FailoverDBClusterCommandInput, cb: (err: any, data?: FailoverDBClusterCommandOutput) => void): void;
|
|
382
272
|
failoverDBCluster(args: FailoverDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FailoverDBClusterCommandOutput) => void): void;
|
|
383
273
|
/**
|
|
384
|
-
* @
|
|
385
|
-
* <p>Lists all tags on an Amazon DocumentDB resource.</p>
|
|
274
|
+
* @see {@link ListTagsForResourceCommand}
|
|
386
275
|
*/
|
|
387
276
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
388
277
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
389
278
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
390
279
|
/**
|
|
391
|
-
* @
|
|
392
|
-
* <p>Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database
|
|
393
|
-
* configuration parameters by specifying these parameters and the new values in the
|
|
394
|
-
* request. </p>
|
|
280
|
+
* @see {@link ModifyDBClusterCommand}
|
|
395
281
|
*/
|
|
396
282
|
modifyDBCluster(args: ModifyDBClusterCommandInput, options?: __HttpHandlerOptions): Promise<ModifyDBClusterCommandOutput>;
|
|
397
283
|
modifyDBCluster(args: ModifyDBClusterCommandInput, cb: (err: any, data?: ModifyDBClusterCommandOutput) => void): void;
|
|
398
284
|
modifyDBCluster(args: ModifyDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBClusterCommandOutput) => void): void;
|
|
399
285
|
/**
|
|
400
|
-
* @
|
|
401
|
-
* <p> Modifies the parameters of a cluster parameter group. To modify more than one
|
|
402
|
-
* parameter, submit a list of the following: <code>ParameterName</code>,
|
|
403
|
-
* <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20
|
|
404
|
-
* parameters can be modified in a single request. </p>
|
|
405
|
-
* <note>
|
|
406
|
-
* <p>Changes to dynamic parameters are applied immediately. Changes to static
|
|
407
|
-
* parameters require a reboot or maintenance window
|
|
408
|
-
*
|
|
409
|
-
* before the change can take effect.</p>
|
|
410
|
-
* </note>
|
|
411
|
-
* <important>
|
|
412
|
-
* <p>After you create a cluster parameter group, you should wait at least 5 minutes
|
|
413
|
-
* before creating your first cluster that uses that cluster parameter group as
|
|
414
|
-
* the default parameter group. This allows Amazon DocumentDB to fully complete the create action
|
|
415
|
-
* before the parameter group is used as the default for a new cluster. This step is
|
|
416
|
-
* especially important for parameters that are critical when creating the default
|
|
417
|
-
* database for a cluster, such as the character set for the default database
|
|
418
|
-
* defined by the <code>character_set_database</code> parameter.</p>
|
|
419
|
-
* </important>
|
|
286
|
+
* @see {@link ModifyDBClusterParameterGroupCommand}
|
|
420
287
|
*/
|
|
421
288
|
modifyDBClusterParameterGroup(args: ModifyDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions): Promise<ModifyDBClusterParameterGroupCommandOutput>;
|
|
422
289
|
modifyDBClusterParameterGroup(args: ModifyDBClusterParameterGroupCommandInput, cb: (err: any, data?: ModifyDBClusterParameterGroupCommandOutput) => void): void;
|
|
423
290
|
modifyDBClusterParameterGroup(args: ModifyDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBClusterParameterGroupCommandOutput) => void): void;
|
|
424
291
|
/**
|
|
425
|
-
* @
|
|
426
|
-
* <p>Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.</p>
|
|
427
|
-
* <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>
|
|
292
|
+
* @see {@link ModifyDBClusterSnapshotAttributeCommand}
|
|
428
293
|
*/
|
|
429
294
|
modifyDBClusterSnapshotAttribute(args: ModifyDBClusterSnapshotAttributeCommandInput, options?: __HttpHandlerOptions): Promise<ModifyDBClusterSnapshotAttributeCommandOutput>;
|
|
430
295
|
modifyDBClusterSnapshotAttribute(args: ModifyDBClusterSnapshotAttributeCommandInput, cb: (err: any, data?: ModifyDBClusterSnapshotAttributeCommandOutput) => void): void;
|
|
431
296
|
modifyDBClusterSnapshotAttribute(args: ModifyDBClusterSnapshotAttributeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBClusterSnapshotAttributeCommandOutput) => void): void;
|
|
432
297
|
/**
|
|
433
|
-
* @
|
|
434
|
-
* <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>
|
|
298
|
+
* @see {@link ModifyDBInstanceCommand}
|
|
435
299
|
*/
|
|
436
300
|
modifyDBInstance(args: ModifyDBInstanceCommandInput, options?: __HttpHandlerOptions): Promise<ModifyDBInstanceCommandOutput>;
|
|
437
301
|
modifyDBInstance(args: ModifyDBInstanceCommandInput, cb: (err: any, data?: ModifyDBInstanceCommandOutput) => void): void;
|
|
438
302
|
modifyDBInstance(args: ModifyDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBInstanceCommandOutput) => void): void;
|
|
439
303
|
/**
|
|
440
|
-
* @
|
|
441
|
-
* <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>
|
|
304
|
+
* @see {@link ModifyDBSubnetGroupCommand}
|
|
442
305
|
*/
|
|
443
306
|
modifyDBSubnetGroup(args: ModifyDBSubnetGroupCommandInput, options?: __HttpHandlerOptions): Promise<ModifyDBSubnetGroupCommandOutput>;
|
|
444
307
|
modifyDBSubnetGroup(args: ModifyDBSubnetGroupCommandInput, cb: (err: any, data?: ModifyDBSubnetGroupCommandOutput) => void): void;
|
|
445
308
|
modifyDBSubnetGroup(args: ModifyDBSubnetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyDBSubnetGroupCommandOutput) => void): void;
|
|
446
309
|
/**
|
|
447
|
-
* @
|
|
448
|
-
* <p>Modifies an existing Amazon DocumentDB event notification subscription.</p>
|
|
310
|
+
* @see {@link ModifyEventSubscriptionCommand}
|
|
449
311
|
*/
|
|
450
312
|
modifyEventSubscription(args: ModifyEventSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<ModifyEventSubscriptionCommandOutput>;
|
|
451
313
|
modifyEventSubscription(args: ModifyEventSubscriptionCommandInput, cb: (err: any, data?: ModifyEventSubscriptionCommandOutput) => void): void;
|
|
452
314
|
modifyEventSubscription(args: ModifyEventSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyEventSubscriptionCommandOutput) => void): void;
|
|
453
315
|
/**
|
|
454
|
-
* @
|
|
455
|
-
* <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>
|
|
456
|
-
* <note>
|
|
457
|
-
* <p>This action only applies to Amazon DocumentDB clusters.</p>
|
|
458
|
-
* </note>
|
|
316
|
+
* @see {@link ModifyGlobalClusterCommand}
|
|
459
317
|
*/
|
|
460
318
|
modifyGlobalCluster(args: ModifyGlobalClusterCommandInput, options?: __HttpHandlerOptions): Promise<ModifyGlobalClusterCommandOutput>;
|
|
461
319
|
modifyGlobalCluster(args: ModifyGlobalClusterCommandInput, cb: (err: any, data?: ModifyGlobalClusterCommandOutput) => void): void;
|
|
462
320
|
modifyGlobalCluster(args: ModifyGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyGlobalClusterCommandOutput) => void): void;
|
|
463
321
|
/**
|
|
464
|
-
* @
|
|
465
|
-
* <p>You might need to reboot your instance, usually for maintenance reasons. For
|
|
466
|
-
* example, if you make certain changes, or if you change the cluster parameter group
|
|
467
|
-
* that is associated with the instance, you must reboot the instance for the changes to
|
|
468
|
-
* take effect. </p>
|
|
469
|
-
* <p>Rebooting an instance restarts the database engine service. Rebooting an instance
|
|
470
|
-
* results in a momentary outage, during which the instance status is set to
|
|
471
|
-
* <i>rebooting</i>. </p>
|
|
322
|
+
* @see {@link RebootDBInstanceCommand}
|
|
472
323
|
*/
|
|
473
324
|
rebootDBInstance(args: RebootDBInstanceCommandInput, options?: __HttpHandlerOptions): Promise<RebootDBInstanceCommandOutput>;
|
|
474
325
|
rebootDBInstance(args: RebootDBInstanceCommandInput, cb: (err: any, data?: RebootDBInstanceCommandOutput) => void): void;
|
|
475
326
|
rebootDBInstance(args: RebootDBInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RebootDBInstanceCommandOutput) => void): void;
|
|
476
327
|
/**
|
|
477
|
-
* @
|
|
478
|
-
* <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>
|
|
479
|
-
* <note>
|
|
480
|
-
* <p>This action only applies to Amazon DocumentDB clusters.</p>
|
|
481
|
-
* </note>
|
|
328
|
+
* @see {@link RemoveFromGlobalClusterCommand}
|
|
482
329
|
*/
|
|
483
330
|
removeFromGlobalCluster(args: RemoveFromGlobalClusterCommandInput, options?: __HttpHandlerOptions): Promise<RemoveFromGlobalClusterCommandOutput>;
|
|
484
331
|
removeFromGlobalCluster(args: RemoveFromGlobalClusterCommandInput, cb: (err: any, data?: RemoveFromGlobalClusterCommandOutput) => void): void;
|
|
485
332
|
removeFromGlobalCluster(args: RemoveFromGlobalClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveFromGlobalClusterCommandOutput) => void): void;
|
|
486
333
|
/**
|
|
487
|
-
* @
|
|
488
|
-
* <p>Removes a source identifier from an existing Amazon DocumentDB event notification
|
|
489
|
-
* subscription.</p>
|
|
334
|
+
* @see {@link RemoveSourceIdentifierFromSubscriptionCommand}
|
|
490
335
|
*/
|
|
491
336
|
removeSourceIdentifierFromSubscription(args: RemoveSourceIdentifierFromSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<RemoveSourceIdentifierFromSubscriptionCommandOutput>;
|
|
492
337
|
removeSourceIdentifierFromSubscription(args: RemoveSourceIdentifierFromSubscriptionCommandInput, cb: (err: any, data?: RemoveSourceIdentifierFromSubscriptionCommandOutput) => void): void;
|
|
493
338
|
removeSourceIdentifierFromSubscription(args: RemoveSourceIdentifierFromSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveSourceIdentifierFromSubscriptionCommandOutput) => void): void;
|
|
494
339
|
/**
|
|
495
|
-
* @
|
|
496
|
-
* <p>Removes metadata tags from an Amazon DocumentDB resource.</p>
|
|
340
|
+
* @see {@link RemoveTagsFromResourceCommand}
|
|
497
341
|
*/
|
|
498
342
|
removeTagsFromResource(args: RemoveTagsFromResourceCommandInput, options?: __HttpHandlerOptions): Promise<RemoveTagsFromResourceCommandOutput>;
|
|
499
343
|
removeTagsFromResource(args: RemoveTagsFromResourceCommandInput, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void): void;
|
|
500
344
|
removeTagsFromResource(args: RemoveTagsFromResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsFromResourceCommandOutput) => void): void;
|
|
501
345
|
/**
|
|
502
|
-
* @
|
|
503
|
-
* <p> Modifies the parameters of a cluster parameter group to the default value. To
|
|
504
|
-
* reset specific parameters, submit a list of the following: <code>ParameterName</code>
|
|
505
|
-
* and <code>ApplyMethod</code>. To reset the entire cluster parameter group, specify
|
|
506
|
-
* the <code>DBClusterParameterGroupName</code> and <code>ResetAllParameters</code>
|
|
507
|
-
* parameters. </p>
|
|
508
|
-
* <p> When you reset the entire group, dynamic parameters are updated immediately and
|
|
509
|
-
* static parameters are set to <code>pending-reboot</code> to take effect on the next DB
|
|
510
|
-
* instance reboot.</p>
|
|
346
|
+
* @see {@link ResetDBClusterParameterGroupCommand}
|
|
511
347
|
*/
|
|
512
348
|
resetDBClusterParameterGroup(args: ResetDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions): Promise<ResetDBClusterParameterGroupCommandOutput>;
|
|
513
349
|
resetDBClusterParameterGroup(args: ResetDBClusterParameterGroupCommandInput, cb: (err: any, data?: ResetDBClusterParameterGroupCommandOutput) => void): void;
|
|
514
350
|
resetDBClusterParameterGroup(args: ResetDBClusterParameterGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetDBClusterParameterGroupCommandOutput) => void): void;
|
|
515
351
|
/**
|
|
516
|
-
* @
|
|
517
|
-
* <p>Creates a new cluster from a snapshot or cluster snapshot.</p>
|
|
518
|
-
* <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>
|
|
519
|
-
* <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>
|
|
352
|
+
* @see {@link RestoreDBClusterFromSnapshotCommand}
|
|
520
353
|
*/
|
|
521
354
|
restoreDBClusterFromSnapshot(args: RestoreDBClusterFromSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<RestoreDBClusterFromSnapshotCommandOutput>;
|
|
522
355
|
restoreDBClusterFromSnapshot(args: RestoreDBClusterFromSnapshotCommandInput, cb: (err: any, data?: RestoreDBClusterFromSnapshotCommandOutput) => void): void;
|
|
523
356
|
restoreDBClusterFromSnapshot(args: RestoreDBClusterFromSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreDBClusterFromSnapshotCommandOutput) => void): void;
|
|
524
357
|
/**
|
|
525
|
-
* @
|
|
526
|
-
* <p>Restores a cluster to an arbitrary point in time. Users can restore to any point in
|
|
527
|
-
* time before <code>LatestRestorableTime</code> for up to
|
|
528
|
-
* <code>BackupRetentionPeriod</code> days. The target cluster is created from the
|
|
529
|
-
* source cluster with the same configuration as the original cluster, except that
|
|
530
|
-
* the new cluster is created with the default security group. </p>
|
|
358
|
+
* @see {@link RestoreDBClusterToPointInTimeCommand}
|
|
531
359
|
*/
|
|
532
360
|
restoreDBClusterToPointInTime(args: RestoreDBClusterToPointInTimeCommandInput, options?: __HttpHandlerOptions): Promise<RestoreDBClusterToPointInTimeCommandOutput>;
|
|
533
361
|
restoreDBClusterToPointInTime(args: RestoreDBClusterToPointInTimeCommandInput, cb: (err: any, data?: RestoreDBClusterToPointInTimeCommandOutput) => void): void;
|
|
534
362
|
restoreDBClusterToPointInTime(args: RestoreDBClusterToPointInTimeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreDBClusterToPointInTimeCommandOutput) => void): void;
|
|
535
363
|
/**
|
|
536
|
-
* @
|
|
537
|
-
* <p>Restarts the stopped cluster that is specified by <code>DBClusterIdentifier</code>.
|
|
538
|
-
* For more information, see <a href="https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html">Stopping and
|
|
539
|
-
* Starting an Amazon DocumentDB Cluster</a>.</p>
|
|
364
|
+
* @see {@link StartDBClusterCommand}
|
|
540
365
|
*/
|
|
541
366
|
startDBCluster(args: StartDBClusterCommandInput, options?: __HttpHandlerOptions): Promise<StartDBClusterCommandOutput>;
|
|
542
367
|
startDBCluster(args: StartDBClusterCommandInput, cb: (err: any, data?: StartDBClusterCommandOutput) => void): void;
|
|
543
368
|
startDBCluster(args: StartDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDBClusterCommandOutput) => void): void;
|
|
544
369
|
/**
|
|
545
|
-
* @
|
|
546
|
-
* <p>Stops the running cluster that is specified by <code>DBClusterIdentifier</code>. The
|
|
547
|
-
* cluster must be in the <i>available</i> state. For more information, see
|
|
548
|
-
* <a href="https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html">Stopping and
|
|
549
|
-
* Starting an Amazon DocumentDB Cluster</a>.</p>
|
|
370
|
+
* @see {@link StopDBClusterCommand}
|
|
550
371
|
*/
|
|
551
372
|
stopDBCluster(args: StopDBClusterCommandInput, options?: __HttpHandlerOptions): Promise<StopDBClusterCommandOutput>;
|
|
552
373
|
stopDBCluster(args: StopDBClusterCommandInput, cb: (err: any, data?: StopDBClusterCommandOutput) => void): void;
|
|
553
374
|
stopDBCluster(args: StopDBClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDBClusterCommandOutput) => void): void;
|
|
554
375
|
}
|
|
376
|
+
/**
|
|
377
|
+
* @public
|
|
378
|
+
* <p>Amazon DocumentDB API documentation</p>
|
|
379
|
+
*/
|
|
380
|
+
export declare class DocDB extends DocDBClient implements DocDB {
|
|
381
|
+
}
|
|
@@ -212,7 +212,7 @@ import {
|
|
|
212
212
|
StopDBClusterCommandOutput,
|
|
213
213
|
} from "./commands/StopDBClusterCommand";
|
|
214
214
|
import { DocDBClient } from "./DocDBClient";
|
|
215
|
-
export
|
|
215
|
+
export interface DocDB {
|
|
216
216
|
addSourceIdentifierToSubscription(
|
|
217
217
|
args: AddSourceIdentifierToSubscriptionCommandInput,
|
|
218
218
|
options?: __HttpHandlerOptions
|
|
@@ -939,3 +939,4 @@ export declare class DocDB extends DocDBClient {
|
|
|
939
939
|
cb: (err: any, data?: StopDBClusterCommandOutput) => void
|
|
940
940
|
): void;
|
|
941
941
|
}
|
|
942
|
+
export declare class DocDB extends DocDBClient implements DocDB {}
|