@aws-sdk/client-docdb 3.306.0 → 3.309.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/commands/AddSourceIdentifierToSubscriptionCommand.js +2 -2
- package/dist-cjs/commands/AddTagsToResourceCommand.js +2 -2
- package/dist-cjs/commands/ApplyPendingMaintenanceActionCommand.js +2 -2
- package/dist-cjs/commands/CopyDBClusterParameterGroupCommand.js +2 -2
- package/dist-cjs/commands/CopyDBClusterSnapshotCommand.js +2 -2
- package/dist-cjs/commands/CreateDBClusterCommand.js +2 -2
- package/dist-cjs/commands/CreateDBClusterParameterGroupCommand.js +2 -2
- package/dist-cjs/commands/CreateDBClusterSnapshotCommand.js +2 -2
- package/dist-cjs/commands/CreateDBInstanceCommand.js +2 -2
- package/dist-cjs/commands/CreateDBSubnetGroupCommand.js +2 -2
- package/dist-cjs/commands/CreateEventSubscriptionCommand.js +2 -2
- package/dist-cjs/commands/CreateGlobalClusterCommand.js +2 -2
- package/dist-cjs/commands/DeleteDBClusterCommand.js +2 -2
- package/dist-cjs/commands/DeleteDBClusterParameterGroupCommand.js +2 -2
- package/dist-cjs/commands/DeleteDBClusterSnapshotCommand.js +2 -2
- package/dist-cjs/commands/DeleteDBInstanceCommand.js +2 -2
- package/dist-cjs/commands/DeleteDBSubnetGroupCommand.js +2 -2
- package/dist-cjs/commands/DeleteEventSubscriptionCommand.js +2 -2
- package/dist-cjs/commands/DeleteGlobalClusterCommand.js +2 -2
- package/dist-cjs/commands/DescribeCertificatesCommand.js +2 -2
- package/dist-cjs/commands/DescribeDBClusterParameterGroupsCommand.js +2 -2
- package/dist-cjs/commands/DescribeDBClusterParametersCommand.js +2 -2
- package/dist-cjs/commands/DescribeDBClusterSnapshotAttributesCommand.js +2 -2
- package/dist-cjs/commands/DescribeDBClusterSnapshotsCommand.js +2 -2
- package/dist-cjs/commands/DescribeDBClustersCommand.js +2 -2
- package/dist-cjs/commands/DescribeDBEngineVersionsCommand.js +2 -2
- package/dist-cjs/commands/DescribeDBInstancesCommand.js +2 -2
- package/dist-cjs/commands/DescribeDBSubnetGroupsCommand.js +2 -2
- package/dist-cjs/commands/DescribeEngineDefaultClusterParametersCommand.js +2 -2
- package/dist-cjs/commands/DescribeEventCategoriesCommand.js +2 -2
- package/dist-cjs/commands/DescribeEventSubscriptionsCommand.js +2 -2
- package/dist-cjs/commands/DescribeEventsCommand.js +2 -2
- package/dist-cjs/commands/DescribeGlobalClustersCommand.js +2 -2
- package/dist-cjs/commands/DescribeOrderableDBInstanceOptionsCommand.js +2 -2
- package/dist-cjs/commands/DescribePendingMaintenanceActionsCommand.js +2 -2
- package/dist-cjs/commands/FailoverDBClusterCommand.js +2 -2
- package/dist-cjs/commands/ListTagsForResourceCommand.js +2 -2
- package/dist-cjs/commands/ModifyDBClusterCommand.js +2 -2
- package/dist-cjs/commands/ModifyDBClusterParameterGroupCommand.js +2 -2
- package/dist-cjs/commands/ModifyDBClusterSnapshotAttributeCommand.js +2 -2
- package/dist-cjs/commands/ModifyDBInstanceCommand.js +2 -2
- package/dist-cjs/commands/ModifyDBSubnetGroupCommand.js +2 -2
- package/dist-cjs/commands/ModifyEventSubscriptionCommand.js +2 -2
- package/dist-cjs/commands/ModifyGlobalClusterCommand.js +2 -2
- package/dist-cjs/commands/RebootDBInstanceCommand.js +2 -2
- package/dist-cjs/commands/RemoveFromGlobalClusterCommand.js +2 -2
- package/dist-cjs/commands/RemoveSourceIdentifierFromSubscriptionCommand.js +2 -2
- package/dist-cjs/commands/RemoveTagsFromResourceCommand.js +2 -2
- package/dist-cjs/commands/ResetDBClusterParameterGroupCommand.js +2 -2
- package/dist-cjs/commands/RestoreDBClusterFromSnapshotCommand.js +2 -2
- package/dist-cjs/commands/RestoreDBClusterToPointInTimeCommand.js +2 -2
- package/dist-cjs/commands/StartDBClusterCommand.js +2 -2
- package/dist-cjs/commands/StopDBClusterCommand.js +2 -2
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +13 -1
- package/dist-cjs/protocols/Aws_query.js +1132 -1129
- package/dist-es/commands/AddSourceIdentifierToSubscriptionCommand.js +3 -3
- package/dist-es/commands/AddTagsToResourceCommand.js +3 -3
- package/dist-es/commands/ApplyPendingMaintenanceActionCommand.js +3 -3
- package/dist-es/commands/CopyDBClusterParameterGroupCommand.js +3 -3
- package/dist-es/commands/CopyDBClusterSnapshotCommand.js +3 -3
- package/dist-es/commands/CreateDBClusterCommand.js +3 -3
- package/dist-es/commands/CreateDBClusterParameterGroupCommand.js +3 -3
- package/dist-es/commands/CreateDBClusterSnapshotCommand.js +3 -3
- package/dist-es/commands/CreateDBInstanceCommand.js +3 -3
- package/dist-es/commands/CreateDBSubnetGroupCommand.js +3 -3
- package/dist-es/commands/CreateEventSubscriptionCommand.js +3 -3
- package/dist-es/commands/CreateGlobalClusterCommand.js +3 -3
- package/dist-es/commands/DeleteDBClusterCommand.js +3 -3
- package/dist-es/commands/DeleteDBClusterParameterGroupCommand.js +3 -3
- package/dist-es/commands/DeleteDBClusterSnapshotCommand.js +3 -3
- package/dist-es/commands/DeleteDBInstanceCommand.js +3 -3
- package/dist-es/commands/DeleteDBSubnetGroupCommand.js +3 -3
- package/dist-es/commands/DeleteEventSubscriptionCommand.js +3 -3
- package/dist-es/commands/DeleteGlobalClusterCommand.js +3 -3
- package/dist-es/commands/DescribeCertificatesCommand.js +3 -3
- package/dist-es/commands/DescribeDBClusterParameterGroupsCommand.js +3 -3
- package/dist-es/commands/DescribeDBClusterParametersCommand.js +3 -3
- package/dist-es/commands/DescribeDBClusterSnapshotAttributesCommand.js +3 -3
- package/dist-es/commands/DescribeDBClusterSnapshotsCommand.js +3 -3
- package/dist-es/commands/DescribeDBClustersCommand.js +3 -3
- package/dist-es/commands/DescribeDBEngineVersionsCommand.js +3 -3
- package/dist-es/commands/DescribeDBInstancesCommand.js +3 -3
- package/dist-es/commands/DescribeDBSubnetGroupsCommand.js +3 -3
- package/dist-es/commands/DescribeEngineDefaultClusterParametersCommand.js +3 -3
- package/dist-es/commands/DescribeEventCategoriesCommand.js +3 -3
- package/dist-es/commands/DescribeEventSubscriptionsCommand.js +3 -3
- package/dist-es/commands/DescribeEventsCommand.js +3 -3
- package/dist-es/commands/DescribeGlobalClustersCommand.js +3 -3
- package/dist-es/commands/DescribeOrderableDBInstanceOptionsCommand.js +3 -3
- package/dist-es/commands/DescribePendingMaintenanceActionsCommand.js +3 -3
- package/dist-es/commands/FailoverDBClusterCommand.js +3 -3
- package/dist-es/commands/ListTagsForResourceCommand.js +3 -3
- package/dist-es/commands/ModifyDBClusterCommand.js +3 -3
- package/dist-es/commands/ModifyDBClusterParameterGroupCommand.js +3 -3
- package/dist-es/commands/ModifyDBClusterSnapshotAttributeCommand.js +3 -3
- package/dist-es/commands/ModifyDBInstanceCommand.js +3 -3
- package/dist-es/commands/ModifyDBSubnetGroupCommand.js +3 -3
- package/dist-es/commands/ModifyEventSubscriptionCommand.js +3 -3
- package/dist-es/commands/ModifyGlobalClusterCommand.js +3 -3
- package/dist-es/commands/RebootDBInstanceCommand.js +3 -3
- package/dist-es/commands/RemoveFromGlobalClusterCommand.js +3 -3
- package/dist-es/commands/RemoveSourceIdentifierFromSubscriptionCommand.js +3 -3
- package/dist-es/commands/RemoveTagsFromResourceCommand.js +3 -3
- package/dist-es/commands/ResetDBClusterParameterGroupCommand.js +3 -3
- package/dist-es/commands/RestoreDBClusterFromSnapshotCommand.js +3 -3
- package/dist-es/commands/RestoreDBClusterToPointInTimeCommand.js +3 -3
- package/dist-es/commands/StartDBClusterCommand.js +3 -3
- package/dist-es/commands/StopDBClusterCommand.js +3 -3
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +12 -0
- package/dist-es/protocols/Aws_query.js +1023 -1020
- package/dist-types/DocDB.d.ts +36 -38
- package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +2 -4
- package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +2 -2
- package/dist-types/commands/CreateDBInstanceCommand.d.ts +1 -1
- package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +2 -2
- package/dist-types/commands/CreateGlobalClusterCommand.d.ts +4 -4
- package/dist-types/commands/DeleteDBClusterCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +2 -2
- package/dist-types/commands/DeleteDBSubnetGroupCommand.d.ts +2 -2
- package/dist-types/commands/DeleteGlobalClusterCommand.d.ts +2 -2
- package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEventsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +2 -2
- package/dist-types/commands/FailoverDBClusterCommand.d.ts +2 -2
- package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +5 -5
- package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBInstanceCommand.d.ts +1 -1
- package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +2 -2
- package/dist-types/commands/RebootDBInstanceCommand.d.ts +1 -1
- package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +2 -2
- package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +2 -2
- package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +3 -2
- package/dist-types/models/models_0.d.ts +438 -414
- package/dist-types/protocols/Aws_query.d.ts +424 -106
- package/dist-types/ts3.4/models/models_0.d.ts +15 -8
- package/dist-types/ts3.4/protocols/Aws_query.d.ts +106 -106
- package/package.json +6 -6
package/dist-types/DocDB.d.ts
CHANGED
|
@@ -94,14 +94,12 @@ export declare class DocDB extends DocDBClient {
|
|
|
94
94
|
/**
|
|
95
95
|
* @public
|
|
96
96
|
* <p>Copies a snapshot of a cluster.</p>
|
|
97
|
-
*
|
|
98
|
-
* <p>To copy a cluster snapshot from a shared manual cluster snapshot,
|
|
97
|
+
* <p>To copy a cluster snapshot from a shared manual cluster snapshot,
|
|
99
98
|
* <code>SourceDBClusterSnapshotIdentifier</code> must be the Amazon
|
|
100
99
|
* Resource Name (ARN) of the shared cluster snapshot. You can only
|
|
101
100
|
* copy a shared DB cluster snapshot, whether encrypted or not, in the
|
|
102
101
|
* same Amazon Web Services Region.</p>
|
|
103
|
-
*
|
|
104
|
-
* <p>To cancel the copy operation after it is in progress, delete the
|
|
102
|
+
* <p>To cancel the copy operation after it is in progress, delete the
|
|
105
103
|
* target cluster snapshot identified by
|
|
106
104
|
* <code>TargetDBClusterSnapshotIdentifier</code> while that cluster
|
|
107
105
|
* snapshot is in the <i>copying</i> status.</p>
|
|
@@ -119,9 +117,9 @@ export declare class DocDB extends DocDBClient {
|
|
|
119
117
|
/**
|
|
120
118
|
* @public
|
|
121
119
|
* <p>Creates a new cluster parameter group.</p>
|
|
122
|
-
*
|
|
120
|
+
* <p>Parameters in a cluster parameter group apply to all of the
|
|
123
121
|
* instances in a cluster.</p>
|
|
124
|
-
*
|
|
122
|
+
* <p>A cluster parameter group is initially created with the default
|
|
125
123
|
* parameters for the database engine used by instances in the cluster.
|
|
126
124
|
* In Amazon DocumentDB, you cannot make modifications directly to the
|
|
127
125
|
* <code>default.docdb3.6</code> cluster parameter group. If your
|
|
@@ -166,8 +164,8 @@ export declare class DocDB extends DocDBClient {
|
|
|
166
164
|
/**
|
|
167
165
|
* @public
|
|
168
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>
|
|
169
|
-
*
|
|
170
|
-
*
|
|
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>
|
|
171
169
|
*/
|
|
172
170
|
createEventSubscription(args: CreateEventSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<CreateEventSubscriptionCommandOutput>;
|
|
173
171
|
createEventSubscription(args: CreateEventSubscriptionCommandInput, cb: (err: any, data?: CreateEventSubscriptionCommandOutput) => void): void;
|
|
@@ -175,11 +173,11 @@ export declare class DocDB extends DocDBClient {
|
|
|
175
173
|
/**
|
|
176
174
|
* @public
|
|
177
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>
|
|
178
|
-
*
|
|
179
|
-
*
|
|
180
|
-
*
|
|
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>
|
|
181
179
|
* <p>This action only applies to Amazon DocumentDB clusters.</p>
|
|
182
|
-
*
|
|
180
|
+
* </note>
|
|
183
181
|
*/
|
|
184
182
|
createGlobalCluster(args: CreateGlobalClusterCommandInput, options?: __HttpHandlerOptions): Promise<CreateGlobalClusterCommandOutput>;
|
|
185
183
|
createGlobalCluster(args: CreateGlobalClusterCommandInput, cb: (err: any, data?: CreateGlobalClusterCommandOutput) => void): void;
|
|
@@ -187,7 +185,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
187
185
|
/**
|
|
188
186
|
* @public
|
|
189
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>
|
|
190
|
-
*
|
|
188
|
+
* <p></p>
|
|
191
189
|
*/
|
|
192
190
|
deleteDBCluster(args: DeleteDBClusterCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDBClusterCommandOutput>;
|
|
193
191
|
deleteDBCluster(args: DeleteDBClusterCommandInput, cb: (err: any, data?: DeleteDBClusterCommandOutput) => void): void;
|
|
@@ -202,9 +200,9 @@ export declare class DocDB extends DocDBClient {
|
|
|
202
200
|
/**
|
|
203
201
|
* @public
|
|
204
202
|
* <p>Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.</p>
|
|
205
|
-
*
|
|
203
|
+
* <note>
|
|
206
204
|
* <p>The cluster snapshot must be in the <code>available</code> state to be deleted.</p>
|
|
207
|
-
*
|
|
205
|
+
* </note>
|
|
208
206
|
*/
|
|
209
207
|
deleteDBClusterSnapshot(args: DeleteDBClusterSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDBClusterSnapshotCommandOutput>;
|
|
210
208
|
deleteDBClusterSnapshot(args: DeleteDBClusterSnapshotCommandInput, cb: (err: any, data?: DeleteDBClusterSnapshotCommandOutput) => void): void;
|
|
@@ -219,10 +217,10 @@ export declare class DocDB extends DocDBClient {
|
|
|
219
217
|
/**
|
|
220
218
|
* @public
|
|
221
219
|
* <p>Deletes a subnet group.</p>
|
|
222
|
-
*
|
|
220
|
+
* <note>
|
|
223
221
|
* <p>The specified database subnet group must not be associated with any DB
|
|
224
222
|
* instances.</p>
|
|
225
|
-
*
|
|
223
|
+
* </note>
|
|
226
224
|
*/
|
|
227
225
|
deleteDBSubnetGroup(args: DeleteDBSubnetGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDBSubnetGroupCommandOutput>;
|
|
228
226
|
deleteDBSubnetGroup(args: DeleteDBSubnetGroupCommandInput, cb: (err: any, data?: DeleteDBSubnetGroupCommandOutput) => void): void;
|
|
@@ -237,9 +235,9 @@ export declare class DocDB extends DocDBClient {
|
|
|
237
235
|
/**
|
|
238
236
|
* @public
|
|
239
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>
|
|
240
|
-
*
|
|
238
|
+
* <note>
|
|
241
239
|
* <p>This action only applies to Amazon DocumentDB clusters.</p>
|
|
242
|
-
*
|
|
240
|
+
* </note>
|
|
243
241
|
*/
|
|
244
242
|
deleteGlobalCluster(args: DeleteGlobalClusterCommandInput, options?: __HttpHandlerOptions): Promise<DeleteGlobalClusterCommandOutput>;
|
|
245
243
|
deleteGlobalCluster(args: DeleteGlobalClusterCommandInput, cb: (err: any, data?: DeleteGlobalClusterCommandOutput) => void): void;
|
|
@@ -282,7 +280,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
282
280
|
* @public
|
|
283
281
|
* <p>Returns a list of cluster snapshot attribute names and values for a manual DB
|
|
284
282
|
* cluster snapshot.</p>
|
|
285
|
-
*
|
|
283
|
+
* <p>When you share snapshots with other Amazon Web Services accounts,
|
|
286
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>
|
|
287
285
|
*/
|
|
288
286
|
describeDBClusterSnapshotAttributes(args: DescribeDBClusterSnapshotAttributesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDBClusterSnapshotAttributesCommandOutput>;
|
|
@@ -343,7 +341,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
343
341
|
/**
|
|
344
342
|
* @public
|
|
345
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>
|
|
346
|
-
*
|
|
344
|
+
* <p>If you specify a <code>SubscriptionName</code>, lists the description for that subscription.</p>
|
|
347
345
|
*/
|
|
348
346
|
describeEventSubscriptions(args: DescribeEventSubscriptionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventSubscriptionsCommandOutput>;
|
|
349
347
|
describeEventSubscriptions(args: DescribeEventSubscriptionsCommandInput, cb: (err: any, data?: DescribeEventSubscriptionsCommandOutput) => void): void;
|
|
@@ -351,9 +349,9 @@ export declare class DocDB extends DocDBClient {
|
|
|
351
349
|
/**
|
|
352
350
|
* @public
|
|
353
351
|
* <p>Returns information about Amazon DocumentDB global clusters. This API supports pagination.</p>
|
|
354
|
-
*
|
|
352
|
+
* <note>
|
|
355
353
|
* <p>This action only applies to Amazon DocumentDB clusters.</p>
|
|
356
|
-
*
|
|
354
|
+
* </note>
|
|
357
355
|
*/
|
|
358
356
|
describeGlobalClusters(args: DescribeGlobalClustersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGlobalClustersCommandOutput>;
|
|
359
357
|
describeGlobalClusters(args: DescribeGlobalClustersCommandInput, cb: (err: any, data?: DescribeGlobalClustersCommandOutput) => void): void;
|
|
@@ -376,8 +374,8 @@ export declare class DocDB extends DocDBClient {
|
|
|
376
374
|
/**
|
|
377
375
|
* @public
|
|
378
376
|
* <p>Forces a failover for a cluster.</p>
|
|
379
|
-
*
|
|
380
|
-
*
|
|
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>
|
|
381
379
|
*/
|
|
382
380
|
failoverDBCluster(args: FailoverDBClusterCommandInput, options?: __HttpHandlerOptions): Promise<FailoverDBClusterCommandOutput>;
|
|
383
381
|
failoverDBCluster(args: FailoverDBClusterCommandInput, cb: (err: any, data?: FailoverDBClusterCommandOutput) => void): void;
|
|
@@ -404,13 +402,13 @@ export declare class DocDB extends DocDBClient {
|
|
|
404
402
|
* parameter, submit a list of the following: <code>ParameterName</code>,
|
|
405
403
|
* <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20
|
|
406
404
|
* parameters can be modified in a single request. </p>
|
|
407
|
-
*
|
|
405
|
+
* <note>
|
|
408
406
|
* <p>Changes to dynamic parameters are applied immediately. Changes to static
|
|
409
407
|
* parameters require a reboot or maintenance window
|
|
410
408
|
*
|
|
411
409
|
* before the change can take effect.</p>
|
|
412
|
-
*
|
|
413
|
-
*
|
|
410
|
+
* </note>
|
|
411
|
+
* <important>
|
|
414
412
|
* <p>After you create a cluster parameter group, you should wait at least 5 minutes
|
|
415
413
|
* before creating your first cluster that uses that cluster parameter group as
|
|
416
414
|
* the default parameter group. This allows Amazon DocumentDB to fully complete the create action
|
|
@@ -418,7 +416,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
418
416
|
* especially important for parameters that are critical when creating the default
|
|
419
417
|
* database for a cluster, such as the character set for the default database
|
|
420
418
|
* defined by the <code>character_set_database</code> parameter.</p>
|
|
421
|
-
*
|
|
419
|
+
* </important>
|
|
422
420
|
*/
|
|
423
421
|
modifyDBClusterParameterGroup(args: ModifyDBClusterParameterGroupCommandInput, options?: __HttpHandlerOptions): Promise<ModifyDBClusterParameterGroupCommandOutput>;
|
|
424
422
|
modifyDBClusterParameterGroup(args: ModifyDBClusterParameterGroupCommandInput, cb: (err: any, data?: ModifyDBClusterParameterGroupCommandOutput) => void): void;
|
|
@@ -426,7 +424,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
426
424
|
/**
|
|
427
425
|
* @public
|
|
428
426
|
* <p>Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.</p>
|
|
429
|
-
*
|
|
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>
|
|
430
428
|
*/
|
|
431
429
|
modifyDBClusterSnapshotAttribute(args: ModifyDBClusterSnapshotAttributeCommandInput, options?: __HttpHandlerOptions): Promise<ModifyDBClusterSnapshotAttributeCommandOutput>;
|
|
432
430
|
modifyDBClusterSnapshotAttribute(args: ModifyDBClusterSnapshotAttributeCommandInput, cb: (err: any, data?: ModifyDBClusterSnapshotAttributeCommandOutput) => void): void;
|
|
@@ -455,9 +453,9 @@ export declare class DocDB extends DocDBClient {
|
|
|
455
453
|
/**
|
|
456
454
|
* @public
|
|
457
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>
|
|
458
|
-
*
|
|
456
|
+
* <note>
|
|
459
457
|
* <p>This action only applies to Amazon DocumentDB clusters.</p>
|
|
460
|
-
*
|
|
458
|
+
* </note>
|
|
461
459
|
*/
|
|
462
460
|
modifyGlobalCluster(args: ModifyGlobalClusterCommandInput, options?: __HttpHandlerOptions): Promise<ModifyGlobalClusterCommandOutput>;
|
|
463
461
|
modifyGlobalCluster(args: ModifyGlobalClusterCommandInput, cb: (err: any, data?: ModifyGlobalClusterCommandOutput) => void): void;
|
|
@@ -468,7 +466,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
468
466
|
* example, if you make certain changes, or if you change the cluster parameter group
|
|
469
467
|
* that is associated with the instance, you must reboot the instance for the changes to
|
|
470
468
|
* take effect. </p>
|
|
471
|
-
*
|
|
469
|
+
* <p>Rebooting an instance restarts the database engine service. Rebooting an instance
|
|
472
470
|
* results in a momentary outage, during which the instance status is set to
|
|
473
471
|
* <i>rebooting</i>. </p>
|
|
474
472
|
*/
|
|
@@ -478,9 +476,9 @@ export declare class DocDB extends DocDBClient {
|
|
|
478
476
|
/**
|
|
479
477
|
* @public
|
|
480
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>
|
|
481
|
-
*
|
|
479
|
+
* <note>
|
|
482
480
|
* <p>This action only applies to Amazon DocumentDB clusters.</p>
|
|
483
|
-
*
|
|
481
|
+
* </note>
|
|
484
482
|
*/
|
|
485
483
|
removeFromGlobalCluster(args: RemoveFromGlobalClusterCommandInput, options?: __HttpHandlerOptions): Promise<RemoveFromGlobalClusterCommandOutput>;
|
|
486
484
|
removeFromGlobalCluster(args: RemoveFromGlobalClusterCommandInput, cb: (err: any, data?: RemoveFromGlobalClusterCommandOutput) => void): void;
|
|
@@ -507,7 +505,7 @@ export declare class DocDB extends DocDBClient {
|
|
|
507
505
|
* and <code>ApplyMethod</code>. To reset the entire cluster parameter group, specify
|
|
508
506
|
* the <code>DBClusterParameterGroupName</code> and <code>ResetAllParameters</code>
|
|
509
507
|
* parameters. </p>
|
|
510
|
-
*
|
|
508
|
+
* <p> When you reset the entire group, dynamic parameters are updated immediately and
|
|
511
509
|
* static parameters are set to <code>pending-reboot</code> to take effect on the next DB
|
|
512
510
|
* instance reboot.</p>
|
|
513
511
|
*/
|
|
@@ -517,8 +515,8 @@ export declare class DocDB extends DocDBClient {
|
|
|
517
515
|
/**
|
|
518
516
|
* @public
|
|
519
517
|
* <p>Creates a new cluster from a snapshot or cluster snapshot.</p>
|
|
520
|
-
*
|
|
521
|
-
*
|
|
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>
|
|
522
520
|
*/
|
|
523
521
|
restoreDBClusterFromSnapshot(args: RestoreDBClusterFromSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<RestoreDBClusterFromSnapshotCommandOutput>;
|
|
524
522
|
restoreDBClusterFromSnapshot(args: RestoreDBClusterFromSnapshotCommandInput, cb: (err: any, data?: RestoreDBClusterFromSnapshotCommandOutput) => void): void;
|
|
@@ -20,14 +20,12 @@ export interface CopyDBClusterSnapshotCommandOutput extends CopyDBClusterSnapsho
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Copies a snapshot of a cluster.</p>
|
|
23
|
-
*
|
|
24
|
-
* <p>To copy a cluster snapshot from a shared manual cluster snapshot,
|
|
23
|
+
* <p>To copy a cluster snapshot from a shared manual cluster snapshot,
|
|
25
24
|
* <code>SourceDBClusterSnapshotIdentifier</code> must be the Amazon
|
|
26
25
|
* Resource Name (ARN) of the shared cluster snapshot. You can only
|
|
27
26
|
* copy a shared DB cluster snapshot, whether encrypted or not, in the
|
|
28
27
|
* same Amazon Web Services Region.</p>
|
|
29
|
-
*
|
|
30
|
-
* <p>To cancel the copy operation after it is in progress, delete the
|
|
28
|
+
* <p>To cancel the copy operation after it is in progress, delete the
|
|
31
29
|
* target cluster snapshot identified by
|
|
32
30
|
* <code>TargetDBClusterSnapshotIdentifier</code> while that cluster
|
|
33
31
|
* snapshot is in the <i>copying</i> status.</p>
|
|
@@ -20,9 +20,9 @@ export interface CreateDBClusterParameterGroupCommandOutput extends CreateDBClus
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Creates a new cluster parameter group.</p>
|
|
23
|
-
*
|
|
23
|
+
* <p>Parameters in a cluster parameter group apply to all of the
|
|
24
24
|
* instances in a cluster.</p>
|
|
25
|
-
*
|
|
25
|
+
* <p>A cluster parameter group is initially created with the default
|
|
26
26
|
* parameters for the database engine used by instances in the cluster.
|
|
27
27
|
* In Amazon DocumentDB, you cannot make modifications directly to the
|
|
28
28
|
* <code>default.docdb3.6</code> cluster parameter group. If your
|
|
@@ -57,7 +57,7 @@ export interface CreateDBInstanceCommandOutput extends CreateDBInstanceResult, _
|
|
|
57
57
|
*
|
|
58
58
|
* @throws {@link AuthorizationNotFoundFault} (client fault)
|
|
59
59
|
* <p>The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.</p>
|
|
60
|
-
*
|
|
60
|
+
* <p>Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.</p>
|
|
61
61
|
*
|
|
62
62
|
* @throws {@link DBClusterNotFoundFault} (client fault)
|
|
63
63
|
* <p>
|
|
@@ -20,8 +20,8 @@ export interface CreateEventSubscriptionCommandOutput extends CreateEventSubscri
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <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>
|
|
23
|
-
*
|
|
24
|
-
*
|
|
23
|
+
* <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>
|
|
24
|
+
* <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>
|
|
25
25
|
* @example
|
|
26
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
27
27
|
* ```javascript
|
|
@@ -20,11 +20,11 @@ export interface CreateGlobalClusterCommandOutput extends CreateGlobalClusterRes
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <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>
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
23
|
+
* <p></p>
|
|
24
|
+
* <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>
|
|
25
|
+
* <note>
|
|
26
26
|
* <p>This action only applies to Amazon DocumentDB clusters.</p>
|
|
27
|
-
*
|
|
27
|
+
* </note>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -20,7 +20,7 @@ export interface DeleteDBClusterCommandOutput extends DeleteDBClusterResult, __M
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <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>
|
|
23
|
-
*
|
|
23
|
+
* <p></p>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
26
|
* ```javascript
|
|
@@ -20,9 +20,9 @@ export interface DeleteDBClusterSnapshotCommandOutput extends DeleteDBClusterSna
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.</p>
|
|
23
|
-
*
|
|
23
|
+
* <note>
|
|
24
24
|
* <p>The cluster snapshot must be in the <code>available</code> state to be deleted.</p>
|
|
25
|
-
*
|
|
25
|
+
* </note>
|
|
26
26
|
* @example
|
|
27
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
28
28
|
* ```javascript
|
|
@@ -20,10 +20,10 @@ export interface DeleteDBSubnetGroupCommandOutput extends __MetadataBearer {
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Deletes a subnet group.</p>
|
|
23
|
-
*
|
|
23
|
+
* <note>
|
|
24
24
|
* <p>The specified database subnet group must not be associated with any DB
|
|
25
25
|
* instances.</p>
|
|
26
|
-
*
|
|
26
|
+
* </note>
|
|
27
27
|
* @example
|
|
28
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
29
|
* ```javascript
|
|
@@ -20,9 +20,9 @@ export interface DeleteGlobalClusterCommandOutput extends DeleteGlobalClusterRes
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.</p>
|
|
23
|
-
*
|
|
23
|
+
* <note>
|
|
24
24
|
* <p>This action only applies to Amazon DocumentDB clusters.</p>
|
|
25
|
-
*
|
|
25
|
+
* </note>
|
|
26
26
|
* @example
|
|
27
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
28
28
|
* ```javascript
|
|
@@ -21,7 +21,7 @@ export interface DescribeDBClusterSnapshotAttributesCommandOutput extends Descri
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Returns a list of cluster snapshot attribute names and values for a manual DB
|
|
23
23
|
* cluster snapshot.</p>
|
|
24
|
-
*
|
|
24
|
+
* <p>When you share snapshots with other Amazon Web Services accounts,
|
|
25
25
|
* <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>
|
|
26
26
|
* @example
|
|
27
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -20,7 +20,7 @@ export interface DescribeEventSubscriptionsCommandOutput extends EventSubscripti
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <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>
|
|
23
|
-
*
|
|
23
|
+
* <p>If you specify a <code>SubscriptionName</code>, lists the description for that subscription.</p>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
26
|
* ```javascript
|
|
@@ -28,7 +28,7 @@ export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBe
|
|
|
28
28
|
* const client = new DocDBClient(config);
|
|
29
29
|
* const input = { // DescribeEventsMessage
|
|
30
30
|
* SourceIdentifier: "STRING_VALUE",
|
|
31
|
-
* SourceType: "
|
|
31
|
+
* SourceType: "db-instance" || "db-parameter-group" || "db-security-group" || "db-snapshot" || "db-cluster" || "db-cluster-snapshot",
|
|
32
32
|
* StartTime: new Date("TIMESTAMP"),
|
|
33
33
|
* EndTime: new Date("TIMESTAMP"),
|
|
34
34
|
* Duration: Number("int"),
|
|
@@ -20,9 +20,9 @@ export interface DescribeGlobalClustersCommandOutput extends GlobalClustersMessa
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Returns information about Amazon DocumentDB global clusters. This API supports pagination.</p>
|
|
23
|
-
*
|
|
23
|
+
* <note>
|
|
24
24
|
* <p>This action only applies to Amazon DocumentDB clusters.</p>
|
|
25
|
-
*
|
|
25
|
+
* </note>
|
|
26
26
|
* @example
|
|
27
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
28
28
|
* ```javascript
|
|
@@ -20,8 +20,8 @@ export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult,
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Forces a failover for a cluster.</p>
|
|
23
|
-
*
|
|
24
|
-
*
|
|
23
|
+
* <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>
|
|
24
|
+
* <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>
|
|
25
25
|
* @example
|
|
26
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
27
27
|
* ```javascript
|
|
@@ -23,13 +23,13 @@ export interface ModifyDBClusterParameterGroupCommandOutput extends DBClusterPar
|
|
|
23
23
|
* parameter, submit a list of the following: <code>ParameterName</code>,
|
|
24
24
|
* <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20
|
|
25
25
|
* parameters can be modified in a single request. </p>
|
|
26
|
-
*
|
|
26
|
+
* <note>
|
|
27
27
|
* <p>Changes to dynamic parameters are applied immediately. Changes to static
|
|
28
28
|
* parameters require a reboot or maintenance window
|
|
29
29
|
*
|
|
30
30
|
* before the change can take effect.</p>
|
|
31
|
-
*
|
|
32
|
-
*
|
|
31
|
+
* </note>
|
|
32
|
+
* <important>
|
|
33
33
|
* <p>After you create a cluster parameter group, you should wait at least 5 minutes
|
|
34
34
|
* before creating your first cluster that uses that cluster parameter group as
|
|
35
35
|
* the default parameter group. This allows Amazon DocumentDB to fully complete the create action
|
|
@@ -37,7 +37,7 @@ export interface ModifyDBClusterParameterGroupCommandOutput extends DBClusterPar
|
|
|
37
37
|
* especially important for parameters that are critical when creating the default
|
|
38
38
|
* database for a cluster, such as the character set for the default database
|
|
39
39
|
* defined by the <code>character_set_database</code> parameter.</p>
|
|
40
|
-
*
|
|
40
|
+
* </important>
|
|
41
41
|
* @example
|
|
42
42
|
* Use a bare-bones client and the command you need to make an API call.
|
|
43
43
|
* ```javascript
|
|
@@ -57,7 +57,7 @@ export interface ModifyDBClusterParameterGroupCommandOutput extends DBClusterPar
|
|
|
57
57
|
* AllowedValues: "STRING_VALUE",
|
|
58
58
|
* IsModifiable: true || false,
|
|
59
59
|
* MinimumEngineVersion: "STRING_VALUE",
|
|
60
|
-
* ApplyMethod: "
|
|
60
|
+
* ApplyMethod: "immediate" || "pending-reboot",
|
|
61
61
|
* },
|
|
62
62
|
* ],
|
|
63
63
|
* };
|
|
@@ -20,7 +20,7 @@ export interface ModifyDBClusterSnapshotAttributeCommandOutput extends ModifyDBC
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.</p>
|
|
23
|
-
*
|
|
23
|
+
* <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>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
26
|
* ```javascript
|
|
@@ -51,7 +51,7 @@ export interface ModifyDBInstanceCommandOutput extends ModifyDBInstanceResult, _
|
|
|
51
51
|
*
|
|
52
52
|
* @throws {@link AuthorizationNotFoundFault} (client fault)
|
|
53
53
|
* <p>The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.</p>
|
|
54
|
-
*
|
|
54
|
+
* <p>Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.</p>
|
|
55
55
|
*
|
|
56
56
|
* @throws {@link CertificateNotFoundFault} (client fault)
|
|
57
57
|
* <p>
|
|
@@ -20,9 +20,9 @@ export interface ModifyGlobalClusterCommandOutput extends ModifyGlobalClusterRes
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <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>
|
|
23
|
-
*
|
|
23
|
+
* <note>
|
|
24
24
|
* <p>This action only applies to Amazon DocumentDB clusters.</p>
|
|
25
|
-
*
|
|
25
|
+
* </note>
|
|
26
26
|
* @example
|
|
27
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
28
28
|
* ```javascript
|
|
@@ -23,7 +23,7 @@ export interface RebootDBInstanceCommandOutput extends RebootDBInstanceResult, _
|
|
|
23
23
|
* example, if you make certain changes, or if you change the cluster parameter group
|
|
24
24
|
* that is associated with the instance, you must reboot the instance for the changes to
|
|
25
25
|
* take effect. </p>
|
|
26
|
-
*
|
|
26
|
+
* <p>Rebooting an instance restarts the database engine service. Rebooting an instance
|
|
27
27
|
* results in a momentary outage, during which the instance status is set to
|
|
28
28
|
* <i>rebooting</i>. </p>
|
|
29
29
|
* @example
|
|
@@ -20,9 +20,9 @@ export interface RemoveFromGlobalClusterCommandOutput extends RemoveFromGlobalCl
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <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>
|
|
23
|
-
*
|
|
23
|
+
* <note>
|
|
24
24
|
* <p>This action only applies to Amazon DocumentDB clusters.</p>
|
|
25
|
-
*
|
|
25
|
+
* </note>
|
|
26
26
|
* @example
|
|
27
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
28
28
|
* ```javascript
|
|
@@ -24,7 +24,7 @@ export interface ResetDBClusterParameterGroupCommandOutput extends DBClusterPara
|
|
|
24
24
|
* and <code>ApplyMethod</code>. To reset the entire cluster parameter group, specify
|
|
25
25
|
* the <code>DBClusterParameterGroupName</code> and <code>ResetAllParameters</code>
|
|
26
26
|
* parameters. </p>
|
|
27
|
-
*
|
|
27
|
+
* <p> When you reset the entire group, dynamic parameters are updated immediately and
|
|
28
28
|
* static parameters are set to <code>pending-reboot</code> to take effect on the next DB
|
|
29
29
|
* instance reboot.</p>
|
|
30
30
|
* @example
|
|
@@ -47,7 +47,7 @@ export interface ResetDBClusterParameterGroupCommandOutput extends DBClusterPara
|
|
|
47
47
|
* AllowedValues: "STRING_VALUE",
|
|
48
48
|
* IsModifiable: true || false,
|
|
49
49
|
* MinimumEngineVersion: "STRING_VALUE",
|
|
50
|
-
* ApplyMethod: "
|
|
50
|
+
* ApplyMethod: "immediate" || "pending-reboot",
|
|
51
51
|
* },
|
|
52
52
|
* ],
|
|
53
53
|
* };
|
|
@@ -20,8 +20,8 @@ export interface RestoreDBClusterFromSnapshotCommandOutput extends RestoreDBClus
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Creates a new cluster from a snapshot or cluster snapshot.</p>
|
|
23
|
-
*
|
|
24
|
-
*
|
|
23
|
+
* <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>
|
|
24
|
+
* <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>
|
|
25
25
|
* @example
|
|
26
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
27
27
|
* ```javascript
|
|
@@ -52,6 +52,7 @@ export interface RestoreDBClusterFromSnapshotCommandOutput extends RestoreDBClus
|
|
|
52
52
|
* "STRING_VALUE",
|
|
53
53
|
* ],
|
|
54
54
|
* DeletionProtection: true || false,
|
|
55
|
+
* DBClusterParameterGroupName: "STRING_VALUE",
|
|
55
56
|
* };
|
|
56
57
|
* const command = new RestoreDBClusterFromSnapshotCommand(input);
|
|
57
58
|
* const response = await client.send(command);
|