/
docs-2.json
1790 lines (1790 loc) · 158 KB
/
docs-2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version": "2.0",
"service": "<p>Amazon DocumentDB API documentation</p>",
"operations": {
"AddSourceIdentifierToSubscription": "<p>Adds a source identifier to an existing event notification subscription.</p>",
"AddTagsToResource": "<p>Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources or in a <code>Condition</code> statement in an Identity and Access Management (IAM) policy for Amazon DocumentDB.</p>",
"ApplyPendingMaintenanceAction": "<p>Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).</p>",
"CopyDBClusterParameterGroup": "<p>Copies the specified cluster parameter group.</p>",
"CopyDBClusterSnapshot": "<p>Copies a snapshot of a cluster.</p> <p>To copy a cluster snapshot from a shared manual cluster snapshot, <code>SourceDBClusterSnapshotIdentifier</code> must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted or not, in the same Amazon Web Services Region.</p> <p>To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by <code>TargetDBClusterSnapshotIdentifier</code> while that cluster snapshot is in the <i>copying</i> status.</p>",
"CreateDBCluster": "<p>Creates a new Amazon DocumentDB cluster.</p>",
"CreateDBClusterParameterGroup": "<p>Creates a new cluster parameter group.</p> <p>Parameters in a cluster parameter group apply to all of the instances in a cluster.</p> <p>A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the <code>default.docdb3.6</code> cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you 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\"> create a new parameter group</a> or <a href=\"https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-copy.html\"> copy an existing parameter group</a>, modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see <a href=\"https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-modify.html\"> Modifying Amazon DocumentDB Cluster Parameter Groups</a>. </p>",
"CreateDBClusterSnapshot": "<p>Creates a snapshot of a cluster. </p>",
"CreateDBInstance": "<p>Creates a new instance.</p>",
"CreateDBSubnetGroup": "<p>Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.</p>",
"CreateEventSubscription": "<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> <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> <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>",
"CreateGlobalCluster": "<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> <p/> <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> <note> <p>This action only applies to Amazon DocumentDB clusters.</p> </note>",
"DeleteDBCluster": "<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> <p/>",
"DeleteDBClusterParameterGroup": "<p>Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.</p>",
"DeleteDBClusterSnapshot": "<p>Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.</p> <note> <p>The cluster snapshot must be in the <code>available</code> state to be deleted.</p> </note>",
"DeleteDBInstance": "<p>Deletes a previously provisioned instance.</p>",
"DeleteDBSubnetGroup": "<p>Deletes a subnet group.</p> <note> <p>The specified database subnet group must not be associated with any DB instances.</p> </note>",
"DeleteEventSubscription": "<p>Deletes an Amazon DocumentDB event notification subscription.</p>",
"DeleteGlobalCluster": "<p>Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.</p> <note> <p>This action only applies to Amazon DocumentDB clusters.</p> </note>",
"DescribeCertificates": "<p>Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.</p>",
"DescribeDBClusterParameterGroups": "<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>",
"DescribeDBClusterParameters": "<p>Returns the detailed parameter list for a particular cluster parameter group.</p>",
"DescribeDBClusterSnapshotAttributes": "<p>Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.</p> <p>When you share snapshots with other Amazon Web Services accounts, <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>",
"DescribeDBClusterSnapshots": "<p>Returns information about cluster snapshots. This API operation supports pagination.</p>",
"DescribeDBClusters": "<p>Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the <code>filterName=engine,Values=docdb</code> filter parameter to return only Amazon DocumentDB clusters.</p>",
"DescribeDBEngineVersions": "<p>Returns a list of the available engines.</p>",
"DescribeDBInstances": "<p>Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.</p>",
"DescribeDBSubnetGroups": "<p>Returns a list of <code>DBSubnetGroup</code> descriptions. If a <code>DBSubnetGroupName</code> is specified, the list will contain only the descriptions of the specified <code>DBSubnetGroup</code>.</p>",
"DescribeEngineDefaultClusterParameters": "<p>Returns the default engine and system parameter information for the cluster database engine.</p>",
"DescribeEventCategories": "<p>Displays a list of categories for all event source types, or, if specified, for a specified source type. </p>",
"DescribeEventSubscriptions": "<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> <p>If you specify a <code>SubscriptionName</code>, lists the description for that subscription.</p>",
"DescribeEvents": "<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>",
"DescribeGlobalClusters": "<p>Returns information about Amazon DocumentDB global clusters. This API supports pagination.</p> <note> <p>This action only applies to Amazon DocumentDB clusters.</p> </note>",
"DescribeOrderableDBInstanceOptions": "<p>Returns a list of orderable instance options for the specified engine.</p>",
"DescribePendingMaintenanceActions": "<p>Returns a list of resources (for example, instances) that have at least one pending maintenance action.</p>",
"FailoverDBCluster": "<p>Forces a failover for a cluster.</p> <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> <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>",
"ListTagsForResource": "<p>Lists all tags on an Amazon DocumentDB resource.</p>",
"ModifyDBCluster": "<p>Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. </p>",
"ModifyDBClusterParameterGroup": "<p> Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following: <code>ParameterName</code>, <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request. </p> <note> <p>Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.</p> </note> <important> <p>After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter.</p> </important>",
"ModifyDBClusterSnapshotAttribute": "<p>Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.</p> <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>",
"ModifyDBInstance": "<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>",
"ModifyDBSubnetGroup": "<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>",
"ModifyEventSubscription": "<p>Modifies an existing Amazon DocumentDB event notification subscription.</p>",
"ModifyGlobalCluster": "<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> <note> <p>This action only applies to Amazon DocumentDB clusters.</p> </note>",
"RebootDBInstance": "<p>You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect. </p> <p>Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to <i>rebooting</i>. </p>",
"RemoveFromGlobalCluster": "<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> <note> <p>This action only applies to Amazon DocumentDB clusters.</p> </note>",
"RemoveSourceIdentifierFromSubscription": "<p>Removes a source identifier from an existing Amazon DocumentDB event notification subscription.</p>",
"RemoveTagsFromResource": "<p>Removes metadata tags from an Amazon DocumentDB resource.</p>",
"ResetDBClusterParameterGroup": "<p> Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: <code>ParameterName</code> and <code>ApplyMethod</code>. To reset the entire cluster parameter group, specify the <code>DBClusterParameterGroupName</code> and <code>ResetAllParameters</code> parameters. </p> <p> When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to <code>pending-reboot</code> to take effect on the next DB instance reboot.</p>",
"RestoreDBClusterFromSnapshot": "<p>Creates a new cluster from a snapshot or cluster snapshot.</p> <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> <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>",
"RestoreDBClusterToPointInTime": "<p>Restores a cluster to an arbitrary point in time. Users can restore to any point in time before <code>LatestRestorableTime</code> for up to <code>BackupRetentionPeriod</code> days. The target cluster is created from the source cluster with the same configuration as the original cluster, except that the new cluster is created with the default security group. </p>",
"StartDBCluster": "<p>Restarts the stopped cluster that is specified by <code>DBClusterIdentifier</code>. For more information, see <a href=\"https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html\">Stopping and Starting an Amazon DocumentDB Cluster</a>.</p>",
"StopDBCluster": "<p>Stops the running cluster that is specified by <code>DBClusterIdentifier</code>. The cluster must be in the <i>available</i> state. For more information, see <a href=\"https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html\">Stopping and Starting an Amazon DocumentDB Cluster</a>.</p>"
},
"shapes": {
"AddSourceIdentifierToSubscriptionMessage": {
"base": "<p>Represents the input to <a>AddSourceIdentifierToSubscription</a>. </p>",
"refs": {
}
},
"AddSourceIdentifierToSubscriptionResult": {
"base": null,
"refs": {
}
},
"AddTagsToResourceMessage": {
"base": "<p>Represents the input to <a>AddTagsToResource</a>. </p>",
"refs": {
}
},
"ApplyMethod": {
"base": null,
"refs": {
"Parameter$ApplyMethod": "<p>Indicates when to apply parameter updates.</p>"
}
},
"ApplyPendingMaintenanceActionMessage": {
"base": "<p>Represents the input to <a>ApplyPendingMaintenanceAction</a>. </p>",
"refs": {
}
},
"ApplyPendingMaintenanceActionResult": {
"base": null,
"refs": {
}
},
"AttributeValueList": {
"base": null,
"refs": {
"DBClusterSnapshotAttribute$AttributeValues": "<p>The values for the manual cluster snapshot attribute.</p> <p>If the <code>AttributeName</code> field is set to <code>restore</code>, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If a value of <code>all</code> is in the list, then the manual cluster snapshot is public and available for any Amazon Web Services account to copy or restore.</p>",
"ModifyDBClusterSnapshotAttributeMessage$ValuesToAdd": "<p>A list of cluster snapshot attributes to add to the attribute specified by <code>AttributeName</code>.</p> <p>To authorize other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account IDs. To make the manual cluster snapshot restorable by any Amazon Web Services account, set it to <code>all</code>. Do not add the <code>all</code> value for any manual cluster snapshots that contain private information that you don't want to be available to all Amazon Web Services accounts.</p>",
"ModifyDBClusterSnapshotAttributeMessage$ValuesToRemove": "<p>A list of cluster snapshot attributes to remove from the attribute specified by <code>AttributeName</code>.</p> <p>To remove authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account identifiers. To remove authorization for any Amazon Web Services account to copy or restore the cluster snapshot, set it to <code>all</code> . If you specify <code>all</code>, an Amazon Web Services account whose account ID is explicitly added to the <code>restore</code> attribute can still copy or restore a manual cluster snapshot.</p>"
}
},
"AuthorizationNotFoundFault": {
"base": "<p>The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.</p> <p>Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.</p>",
"refs": {
}
},
"AvailabilityZone": {
"base": "<p>Information about an Availability Zone.</p>",
"refs": {
"AvailabilityZoneList$member": null,
"Subnet$SubnetAvailabilityZone": "<p>Specifies the Availability Zone for the subnet.</p>"
}
},
"AvailabilityZoneList": {
"base": null,
"refs": {
"OrderableDBInstanceOption$AvailabilityZones": "<p>A list of Availability Zones for an instance.</p>"
}
},
"AvailabilityZones": {
"base": null,
"refs": {
"CreateDBClusterMessage$AvailabilityZones": "<p>A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.</p>",
"DBCluster$AvailabilityZones": "<p>Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.</p>",
"DBClusterSnapshot$AvailabilityZones": "<p>Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.</p>",
"RestoreDBClusterFromSnapshotMessage$AvailabilityZones": "<p>Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.</p>"
}
},
"Boolean": {
"base": null,
"refs": {
"DBCluster$MultiAZ": "<p>Specifies whether the cluster has instances in multiple Availability Zones.</p>",
"DBCluster$StorageEncrypted": "<p>Specifies whether the cluster is encrypted.</p>",
"DBCluster$DeletionProtection": "<p>Specifies whether this cluster can be deleted. If <code>DeletionProtection</code> is enabled, the cluster cannot be deleted unless it is modified and <code>DeletionProtection</code> is disabled. <code>DeletionProtection</code> protects clusters from being accidentally deleted.</p>",
"DBClusterMember$IsClusterWriter": "<p>A value that is <code>true</code> if the cluster member is the primary instance for the cluster and <code>false</code> otherwise.</p>",
"DBClusterSnapshot$StorageEncrypted": "<p>Specifies whether the cluster snapshot is encrypted.</p>",
"DBEngineVersion$SupportsLogExportsToCloudwatchLogs": "<p>A value that indicates whether the engine version supports exporting the log types specified by <code>ExportableLogTypes</code> to CloudWatch Logs.</p>",
"DBInstance$AutoMinorVersionUpgrade": "<p>Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.</p>",
"DBInstance$PubliclyAccessible": "<p>Not supported. Amazon DocumentDB does not currently support public endpoints. The value of <code>PubliclyAccessible</code> is always <code>false</code>.</p>",
"DBInstance$StorageEncrypted": "<p>Specifies whether or not the instance is encrypted.</p>",
"DBInstanceStatusInfo$Normal": "<p>A Boolean value that is <code>true</code> if the instance is operating normally, or <code>false</code> if the instance is in an error state.</p>",
"DeleteDBClusterMessage$SkipFinalSnapshot": "<p> Determines whether a final cluster snapshot is created before the cluster is deleted. If <code>true</code> is specified, no cluster snapshot is created. If <code>false</code> is specified, a cluster snapshot is created before the DB cluster is deleted. </p> <note> <p>If <code>SkipFinalSnapshot</code> is <code>false</code>, you must specify a <code>FinalDBSnapshotIdentifier</code> parameter.</p> </note> <p>Default: <code>false</code> </p>",
"DescribeDBClusterSnapshotsMessage$IncludeShared": "<p>Set to <code>true</code> to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise <code>false</code>. The default is <code>false</code>.</p>",
"DescribeDBClusterSnapshotsMessage$IncludePublic": "<p>Set to <code>true</code> to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise <code>false</code>. The default is <code>false</code>.</p>",
"DescribeDBEngineVersionsMessage$DefaultOnly": "<p>Indicates that only the default version of the specified engine or engine and major version combination is returned.</p>",
"EventSubscription$Enabled": "<p>A Boolean value indicating whether the subscription is enabled. A value of <code>true</code> indicates that the subscription is enabled.</p>",
"GlobalClusterMember$IsWriter": "<p> Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated. </p>",
"ModifyDBClusterMessage$ApplyImmediately": "<p>A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the cluster. If this parameter is set to <code>false</code>, changes to the cluster are applied during the next maintenance window.</p> <p>The <code>ApplyImmediately</code> parameter affects only the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values. If you set this parameter value to <code>false</code>, the changes to the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the <code>ApplyImmediately</code> parameter.</p> <p>Default: <code>false</code> </p>",
"ModifyDBInstanceMessage$ApplyImmediately": "<p>Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the instance. </p> <p> If this parameter is set to <code>false</code>, changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.</p> <p>Default: <code>false</code> </p>",
"OrderableDBInstanceOption$Vpc": "<p>Indicates whether an instance is in a virtual private cloud (VPC).</p>",
"Parameter$IsModifiable": "<p> Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. </p>",
"ResetDBClusterParameterGroupMessage$ResetAllParameters": "<p>A value that is set to <code>true</code> to reset all parameters in the cluster parameter group to their default values, and <code>false</code> otherwise. You can't use this parameter if there is a list of parameter names specified for the <code>Parameters</code> parameter.</p>",
"RestoreDBClusterToPointInTimeMessage$UseLatestRestorableTime": "<p>A value that is set to <code>true</code> to restore the cluster to the latest restorable backup time, and <code>false</code> otherwise. </p> <p>Default: <code>false</code> </p> <p>Constraints: Cannot be specified if the <code>RestoreToTime</code> parameter is provided.</p>",
"UpgradeTarget$AutoUpgrade": "<p>A value that indicates whether the target version is applied to any source DB instances that have <code>AutoMinorVersionUpgrade</code> set to <code>true</code>.</p>",
"UpgradeTarget$IsMajorVersionUpgrade": "<p>A value that indicates whether a database engine is upgraded to a major version.</p>"
}
},
"BooleanOptional": {
"base": null,
"refs": {
"CopyDBClusterSnapshotMessage$CopyTags": "<p>Set to <code>true</code> to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise <code>false</code>. The default is <code>false</code>.</p>",
"CreateDBClusterMessage$StorageEncrypted": "<p>Specifies whether the cluster is encrypted.</p>",
"CreateDBClusterMessage$DeletionProtection": "<p>Specifies whether this cluster can be deleted. If <code>DeletionProtection</code> is enabled, the cluster cannot be deleted unless it is modified and <code>DeletionProtection</code> is disabled. <code>DeletionProtection</code> protects clusters from being accidentally deleted.</p>",
"CreateDBInstanceMessage$AutoMinorVersionUpgrade": "<p>This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.</p> <p>Default: <code>false</code> </p>",
"CreateDBInstanceMessage$CopyTagsToSnapshot": "<p>A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.</p>",
"CreateDBInstanceMessage$EnablePerformanceInsights": "<p>A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see <a href=\"https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html\">Using Amazon Performance Insights</a>.</p>",
"CreateEventSubscriptionMessage$Enabled": "<p> A Boolean value; set to <code>true</code> to activate the subscription, set to <code>false</code> to create the subscription but not active it. </p>",
"CreateGlobalClusterMessage$DeletionProtection": "<p>The deletion protection setting for the new global cluster. The global cluster can't be deleted when deletion protection is enabled. </p>",
"CreateGlobalClusterMessage$StorageEncrypted": "<p>The storage encryption setting for the new global cluster. </p>",
"DBInstance$CopyTagsToSnapshot": "<p>A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.</p>",
"DescribeDBEngineVersionsMessage$ListSupportedCharacterSets": "<p>If this parameter is specified and the requested engine supports the <code>CharacterSetName</code> parameter for <code>CreateDBInstance</code>, the response includes a list of supported character sets for each engine version. </p>",
"DescribeDBEngineVersionsMessage$ListSupportedTimezones": "<p>If this parameter is specified and the requested engine supports the <code>TimeZone</code> parameter for <code>CreateDBInstance</code>, the response includes a list of supported time zones for each engine version. </p>",
"DescribeOrderableDBInstanceOptionsMessage$Vpc": "<p>The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.</p>",
"GlobalCluster$StorageEncrypted": "<p>The storage encryption setting for the global cluster.</p>",
"GlobalCluster$DeletionProtection": "<p>The deletion protection setting for the new global cluster.</p>",
"ModifyDBClusterMessage$DeletionProtection": "<p>Specifies whether this cluster can be deleted. If <code>DeletionProtection</code> is enabled, the cluster cannot be deleted unless it is modified and <code>DeletionProtection</code> is disabled. <code>DeletionProtection</code> protects clusters from being accidentally deleted.</p>",
"ModifyDBInstanceMessage$AutoMinorVersionUpgrade": "<p>This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.</p>",
"ModifyDBInstanceMessage$CopyTagsToSnapshot": "<p>A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.</p>",
"ModifyDBInstanceMessage$EnablePerformanceInsights": "<p>A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see <a href=\"https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html\">Using Amazon Performance Insights</a>.</p>",
"ModifyEventSubscriptionMessage$Enabled": "<p> A Boolean value; set to <code>true</code> to activate the subscription. </p>",
"ModifyGlobalClusterMessage$DeletionProtection": "<p>Indicates if the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled. </p>",
"PendingModifiedValues$MultiAZ": "<p>Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.</p>",
"RebootDBInstanceMessage$ForceFailover": "<p> When <code>true</code>, the reboot is conducted through a Multi-AZ failover. </p> <p>Constraint: You can't specify <code>true</code> if the instance is not configured for Multi-AZ.</p>",
"RestoreDBClusterFromSnapshotMessage$DeletionProtection": "<p>Specifies whether this cluster can be deleted. If <code>DeletionProtection</code> is enabled, the cluster cannot be deleted unless it is modified and <code>DeletionProtection</code> is disabled. <code>DeletionProtection</code> protects clusters from being accidentally deleted.</p>",
"RestoreDBClusterToPointInTimeMessage$DeletionProtection": "<p>Specifies whether this cluster can be deleted. If <code>DeletionProtection</code> is enabled, the cluster cannot be deleted unless it is modified and <code>DeletionProtection</code> is disabled. <code>DeletionProtection</code> protects clusters from being accidentally deleted.</p>"
}
},
"Certificate": {
"base": "<p>A certificate authority (CA) certificate for an Amazon Web Services account.</p>",
"refs": {
"CertificateList$member": null
}
},
"CertificateList": {
"base": null,
"refs": {
"CertificateMessage$Certificates": "<p>A list of certificates for this Amazon Web Services account.</p>"
}
},
"CertificateMessage": {
"base": null,
"refs": {
}
},
"CertificateNotFoundFault": {
"base": "<p> <code>CertificateIdentifier</code> doesn't refer to an existing certificate. </p>",
"refs": {
}
},
"CloudwatchLogsExportConfiguration": {
"base": "<p>The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster.</p> <p>The <code>EnableLogTypes</code> and <code>DisableLogTypes</code> arrays determine which logs are exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the engine that is being used.</p>",
"refs": {
"ModifyDBClusterMessage$CloudwatchLogsExportConfiguration": "<p>The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The <code>EnableLogTypes</code> and <code>DisableLogTypes</code> arrays determine which logs are exported (or not exported) to CloudWatch Logs.</p>"
}
},
"CopyDBClusterParameterGroupMessage": {
"base": "<p>Represents the input to <a>CopyDBClusterParameterGroup</a>. </p>",
"refs": {
}
},
"CopyDBClusterParameterGroupResult": {
"base": null,
"refs": {
}
},
"CopyDBClusterSnapshotMessage": {
"base": "<p>Represents the input to <a>CopyDBClusterSnapshot</a>. </p>",
"refs": {
}
},
"CopyDBClusterSnapshotResult": {
"base": null,
"refs": {
}
},
"CreateDBClusterMessage": {
"base": "<p>Represents the input to <a>CreateDBCluster</a>. </p>",
"refs": {
}
},
"CreateDBClusterParameterGroupMessage": {
"base": "<p>Represents the input of <a>CreateDBClusterParameterGroup</a>.</p>",
"refs": {
}
},
"CreateDBClusterParameterGroupResult": {
"base": null,
"refs": {
}
},
"CreateDBClusterResult": {
"base": null,
"refs": {
}
},
"CreateDBClusterSnapshotMessage": {
"base": "<p>Represents the input of <a>CreateDBClusterSnapshot</a>.</p>",
"refs": {
}
},
"CreateDBClusterSnapshotResult": {
"base": null,
"refs": {
}
},
"CreateDBInstanceMessage": {
"base": "<p>Represents the input to <a>CreateDBInstance</a>.</p>",
"refs": {
}
},
"CreateDBInstanceResult": {
"base": null,
"refs": {
}
},
"CreateDBSubnetGroupMessage": {
"base": "<p>Represents the input to <a>CreateDBSubnetGroup</a>.</p>",
"refs": {
}
},
"CreateDBSubnetGroupResult": {
"base": null,
"refs": {
}
},
"CreateEventSubscriptionMessage": {
"base": "<p>Represents the input to <a>CreateEventSubscription</a>.</p>",
"refs": {
}
},
"CreateEventSubscriptionResult": {
"base": null,
"refs": {
}
},
"CreateGlobalClusterMessage": {
"base": "<p>Represents the input to <a>CreateGlobalCluster</a>.</p>",
"refs": {
}
},
"CreateGlobalClusterResult": {
"base": null,
"refs": {
}
},
"DBCluster": {
"base": "<p>Detailed information about a cluster. </p>",
"refs": {
"CreateDBClusterResult$DBCluster": null,
"DBClusterList$member": null,
"DeleteDBClusterResult$DBCluster": null,
"FailoverDBClusterResult$DBCluster": null,
"ModifyDBClusterResult$DBCluster": null,
"RestoreDBClusterFromSnapshotResult$DBCluster": null,
"RestoreDBClusterToPointInTimeResult$DBCluster": null,
"StartDBClusterResult$DBCluster": null,
"StopDBClusterResult$DBCluster": null
}
},
"DBClusterAlreadyExistsFault": {
"base": "<p>You already have a cluster with the given identifier.</p>",
"refs": {
}
},
"DBClusterList": {
"base": null,
"refs": {
"DBClusterMessage$DBClusters": "<p>A list of clusters.</p>"
}
},
"DBClusterMember": {
"base": "<p>Contains information about an instance that is part of a cluster.</p>",
"refs": {
"DBClusterMemberList$member": null
}
},
"DBClusterMemberList": {
"base": null,
"refs": {
"DBCluster$DBClusterMembers": "<p>Provides the list of instances that make up the cluster.</p>"
}
},
"DBClusterMessage": {
"base": "<p>Represents the output of <a>DescribeDBClusters</a>.</p>",
"refs": {
}
},
"DBClusterNotFoundFault": {
"base": "<p> <code>DBClusterIdentifier</code> doesn't refer to an existing cluster. </p>",
"refs": {
}
},
"DBClusterParameterGroup": {
"base": "<p>Detailed information about a cluster parameter group. </p>",
"refs": {
"CopyDBClusterParameterGroupResult$DBClusterParameterGroup": null,
"CreateDBClusterParameterGroupResult$DBClusterParameterGroup": null,
"DBClusterParameterGroupList$member": null
}
},
"DBClusterParameterGroupDetails": {
"base": "<p>Represents the output of <a>DBClusterParameterGroup</a>.</p>",
"refs": {
}
},
"DBClusterParameterGroupList": {
"base": null,
"refs": {
"DBClusterParameterGroupsMessage$DBClusterParameterGroups": "<p>A list of cluster parameter groups.</p>"
}
},
"DBClusterParameterGroupNameMessage": {
"base": "<p>Contains the name of a cluster parameter group.</p>",
"refs": {
}
},
"DBClusterParameterGroupNotFoundFault": {
"base": "<p> <code>DBClusterParameterGroupName</code> doesn't refer to an existing cluster parameter group. </p>",
"refs": {
}
},
"DBClusterParameterGroupsMessage": {
"base": "<p>Represents the output of <a>DBClusterParameterGroups</a>.</p>",
"refs": {
}
},
"DBClusterQuotaExceededFault": {
"base": "<p>The cluster can't be created because you have reached the maximum allowed quota of clusters.</p>",
"refs": {
}
},
"DBClusterRole": {
"base": "<p>Describes an Identity and Access Management (IAM) role that is associated with a cluster.</p>",
"refs": {
"DBClusterRoles$member": null
}
},
"DBClusterRoles": {
"base": null,
"refs": {
"DBCluster$AssociatedRoles": "<p>Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.</p>"
}
},
"DBClusterSnapshot": {
"base": "<p>Detailed information about a cluster snapshot. </p>",
"refs": {
"CopyDBClusterSnapshotResult$DBClusterSnapshot": null,
"CreateDBClusterSnapshotResult$DBClusterSnapshot": null,
"DBClusterSnapshotList$member": null,
"DeleteDBClusterSnapshotResult$DBClusterSnapshot": null
}
},
"DBClusterSnapshotAlreadyExistsFault": {
"base": "<p>You already have a cluster snapshot with the given identifier.</p>",
"refs": {
}
},
"DBClusterSnapshotAttribute": {
"base": "<p>Contains the name and values of a manual cluster snapshot attribute.</p> <p>Manual cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual cluster snapshot.</p>",
"refs": {
"DBClusterSnapshotAttributeList$member": null
}
},
"DBClusterSnapshotAttributeList": {
"base": null,
"refs": {
"DBClusterSnapshotAttributesResult$DBClusterSnapshotAttributes": "<p>The list of attributes and values for the cluster snapshot.</p>"
}
},
"DBClusterSnapshotAttributesResult": {
"base": "<p>Detailed information about the attributes that are associated with a cluster snapshot.</p>",
"refs": {
"DescribeDBClusterSnapshotAttributesResult$DBClusterSnapshotAttributesResult": null,
"ModifyDBClusterSnapshotAttributeResult$DBClusterSnapshotAttributesResult": null
}
},
"DBClusterSnapshotList": {
"base": null,
"refs": {
"DBClusterSnapshotMessage$DBClusterSnapshots": "<p>Provides a list of cluster snapshots.</p>"
}
},
"DBClusterSnapshotMessage": {
"base": "<p>Represents the output of <a>DescribeDBClusterSnapshots</a>.</p>",
"refs": {
}
},
"DBClusterSnapshotNotFoundFault": {
"base": "<p> <code>DBClusterSnapshotIdentifier</code> doesn't refer to an existing cluster snapshot. </p>",
"refs": {
}
},
"DBEngineVersion": {
"base": "<p> Detailed information about an engine version. </p>",
"refs": {
"DBEngineVersionList$member": null
}
},
"DBEngineVersionList": {
"base": null,
"refs": {
"DBEngineVersionMessage$DBEngineVersions": "<p>Detailed information about one or more engine versions.</p>"
}
},
"DBEngineVersionMessage": {
"base": "<p>Represents the output of <a>DescribeDBEngineVersions</a>.</p>",
"refs": {
}
},
"DBInstance": {
"base": "<p>Detailed information about an instance. </p>",
"refs": {
"CreateDBInstanceResult$DBInstance": null,
"DBInstanceList$member": null,
"DeleteDBInstanceResult$DBInstance": null,
"ModifyDBInstanceResult$DBInstance": null,
"RebootDBInstanceResult$DBInstance": null
}
},
"DBInstanceAlreadyExistsFault": {
"base": "<p>You already have a instance with the given identifier.</p>",
"refs": {
}
},
"DBInstanceList": {
"base": null,
"refs": {
"DBInstanceMessage$DBInstances": "<p>Detailed information about one or more instances. </p>"
}
},
"DBInstanceMessage": {
"base": "<p>Represents the output of <a>DescribeDBInstances</a>.</p>",
"refs": {
}
},
"DBInstanceNotFoundFault": {
"base": "<p> <code>DBInstanceIdentifier</code> doesn't refer to an existing instance. </p>",
"refs": {
}
},
"DBInstanceStatusInfo": {
"base": "<p>Provides a list of status information for an instance.</p>",
"refs": {
"DBInstanceStatusInfoList$member": null
}
},
"DBInstanceStatusInfoList": {
"base": null,
"refs": {
"DBInstance$StatusInfos": "<p>The status of a read replica. If the instance is not a read replica, this is blank.</p>"
}
},
"DBParameterGroupAlreadyExistsFault": {
"base": "<p>A parameter group with the same name already exists.</p>",
"refs": {
}
},
"DBParameterGroupNotFoundFault": {
"base": "<p> <code>DBParameterGroupName</code> doesn't refer to an existing parameter group. </p>",
"refs": {
}
},
"DBParameterGroupQuotaExceededFault": {
"base": "<p>This request would cause you to exceed the allowed number of parameter groups.</p>",
"refs": {
}
},
"DBSecurityGroupNotFoundFault": {
"base": "<p> <code>DBSecurityGroupName</code> doesn't refer to an existing security group. </p>",
"refs": {
}
},
"DBSnapshotAlreadyExistsFault": {
"base": "<p> <code>DBSnapshotIdentifier</code> is already being used by an existing snapshot. </p>",
"refs": {
}
},
"DBSnapshotNotFoundFault": {
"base": "<p> <code>DBSnapshotIdentifier</code> doesn't refer to an existing snapshot. </p>",
"refs": {
}
},
"DBSubnetGroup": {
"base": "<p>Detailed information about a subnet group. </p>",
"refs": {
"CreateDBSubnetGroupResult$DBSubnetGroup": null,
"DBInstance$DBSubnetGroup": "<p>Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.</p>",
"DBSubnetGroups$member": null,
"ModifyDBSubnetGroupResult$DBSubnetGroup": null
}
},
"DBSubnetGroupAlreadyExistsFault": {
"base": "<p> <code>DBSubnetGroupName</code> is already being used by an existing subnet group. </p>",
"refs": {
}
},
"DBSubnetGroupDoesNotCoverEnoughAZs": {
"base": "<p>Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.</p>",
"refs": {
}
},
"DBSubnetGroupMessage": {
"base": "<p>Represents the output of <a>DescribeDBSubnetGroups</a>.</p>",
"refs": {
}
},
"DBSubnetGroupNotFoundFault": {
"base": "<p> <code>DBSubnetGroupName</code> doesn't refer to an existing subnet group. </p>",
"refs": {
}
},
"DBSubnetGroupQuotaExceededFault": {
"base": "<p>The request would cause you to exceed the allowed number of subnet groups.</p>",
"refs": {
}
},
"DBSubnetGroups": {
"base": null,
"refs": {
"DBSubnetGroupMessage$DBSubnetGroups": "<p>Detailed information about one or more subnet groups.</p>"
}
},
"DBSubnetQuotaExceededFault": {
"base": "<p>The request would cause you to exceed the allowed number of subnets in a subnet group.</p>",
"refs": {
}
},
"DBUpgradeDependencyFailureFault": {
"base": "<p>The upgrade failed because a resource that the depends on can't be modified.</p>",
"refs": {
}
},
"DeleteDBClusterMessage": {
"base": "<p>Represents the input to <a>DeleteDBCluster</a>.</p>",
"refs": {
}
},
"DeleteDBClusterParameterGroupMessage": {
"base": "<p>Represents the input to <a>DeleteDBClusterParameterGroup</a>.</p>",
"refs": {
}
},
"DeleteDBClusterResult": {
"base": null,
"refs": {
}
},
"DeleteDBClusterSnapshotMessage": {
"base": "<p>Represents the input to <a>DeleteDBClusterSnapshot</a>.</p>",
"refs": {
}
},
"DeleteDBClusterSnapshotResult": {
"base": null,
"refs": {
}
},
"DeleteDBInstanceMessage": {
"base": "<p>Represents the input to <a>DeleteDBInstance</a>.</p>",
"refs": {
}
},
"DeleteDBInstanceResult": {
"base": null,
"refs": {
}
},
"DeleteDBSubnetGroupMessage": {
"base": "<p>Represents the input to <a>DeleteDBSubnetGroup</a>.</p>",
"refs": {
}
},
"DeleteEventSubscriptionMessage": {
"base": "<p>Represents the input to <a>DeleteEventSubscription</a>.</p>",
"refs": {
}
},
"DeleteEventSubscriptionResult": {
"base": null,
"refs": {
}
},
"DeleteGlobalClusterMessage": {
"base": "<p>Represents the input to <a>DeleteGlobalCluster</a>.</p>",
"refs": {
}
},
"DeleteGlobalClusterResult": {
"base": null,
"refs": {
}
},
"DescribeCertificatesMessage": {
"base": null,
"refs": {
}
},
"DescribeDBClusterParameterGroupsMessage": {
"base": "<p>Represents the input to <a>DescribeDBClusterParameterGroups</a>.</p>",
"refs": {
}
},
"DescribeDBClusterParametersMessage": {
"base": "<p>Represents the input to <a>DescribeDBClusterParameters</a>.</p>",
"refs": {
}
},
"DescribeDBClusterSnapshotAttributesMessage": {
"base": "<p>Represents the input to <a>DescribeDBClusterSnapshotAttributes</a>.</p>",
"refs": {
}
},
"DescribeDBClusterSnapshotAttributesResult": {
"base": null,
"refs": {
}
},
"DescribeDBClusterSnapshotsMessage": {
"base": "<p>Represents the input to <a>DescribeDBClusterSnapshots</a>.</p>",
"refs": {
}
},
"DescribeDBClustersMessage": {
"base": "<p>Represents the input to <a>DescribeDBClusters</a>.</p>",
"refs": {
}
},
"DescribeDBEngineVersionsMessage": {
"base": "<p>Represents the input to <a>DescribeDBEngineVersions</a>.</p>",
"refs": {
}
},
"DescribeDBInstancesMessage": {
"base": "<p>Represents the input to <a>DescribeDBInstances</a>.</p>",
"refs": {
}
},
"DescribeDBSubnetGroupsMessage": {
"base": "<p>Represents the input to <a>DescribeDBSubnetGroups</a>.</p>",
"refs": {
}
},
"DescribeEngineDefaultClusterParametersMessage": {
"base": "<p>Represents the input to <a>DescribeEngineDefaultClusterParameters</a>.</p>",
"refs": {
}
},
"DescribeEngineDefaultClusterParametersResult": {
"base": null,
"refs": {
}
},
"DescribeEventCategoriesMessage": {
"base": "<p>Represents the input to <a>DescribeEventCategories</a>.</p>",
"refs": {
}
},
"DescribeEventSubscriptionsMessage": {
"base": "<p>Represents the input to <a>DescribeEventSubscriptions</a>.</p>",
"refs": {
}
},
"DescribeEventsMessage": {
"base": "<p>Represents the input to <a>DescribeEvents</a>.</p>",
"refs": {
}
},
"DescribeGlobalClustersMessage": {
"base": null,
"refs": {
}
},
"DescribeOrderableDBInstanceOptionsMessage": {
"base": "<p>Represents the input to <a>DescribeOrderableDBInstanceOptions</a>.</p>",
"refs": {
}
},
"DescribePendingMaintenanceActionsMessage": {
"base": "<p>Represents the input to <a>DescribePendingMaintenanceActions</a>.</p>",
"refs": {
}
},
"Endpoint": {
"base": "<p>Network information for accessing a cluster or instance. Client programs must specify a valid endpoint to access these Amazon DocumentDB resources.</p>",
"refs": {
"DBInstance$Endpoint": "<p>Specifies the connection endpoint.</p>"
}
},
"EngineDefaults": {
"base": "<p>Contains the result of a successful invocation of the <code>DescribeEngineDefaultClusterParameters</code> operation. </p>",
"refs": {
"DescribeEngineDefaultClusterParametersResult$EngineDefaults": null
}
},
"Event": {
"base": "<p>Detailed information about an event.</p>",
"refs": {
"EventList$member": null
}
},
"EventCategoriesList": {
"base": null,
"refs": {
"CreateEventSubscriptionMessage$EventCategories": "<p> A list of event categories for a <code>SourceType</code> that you want to subscribe to. </p>",
"DescribeEventsMessage$EventCategories": "<p>A list of event categories that trigger notifications for an event notification subscription.</p>",
"Event$EventCategories": "<p>Specifies the category for the event.</p>",
"EventCategoriesMap$EventCategories": "<p>The event categories for the specified source type.</p>",
"EventSubscription$EventCategoriesList": "<p>A list of event categories for the Amazon DocumentDB event notification subscription.</p>",
"ModifyEventSubscriptionMessage$EventCategories": "<p> A list of event categories for a <code>SourceType</code> that you want to subscribe to.</p>"
}
},
"EventCategoriesMap": {
"base": "<p>An event source type, accompanied by one or more event category names.</p>",
"refs": {
"EventCategoriesMapList$member": null
}
},
"EventCategoriesMapList": {
"base": null,
"refs": {
"EventCategoriesMessage$EventCategoriesMapList": "<p>A list of event category maps.</p>"
}
},
"EventCategoriesMessage": {
"base": "<p>Represents the output of <a>DescribeEventCategories</a>.</p>",
"refs": {
}
},
"EventList": {
"base": null,
"refs": {
"EventsMessage$Events": "<p>Detailed information about one or more events. </p>"
}
},
"EventSubscription": {
"base": "<p>Detailed information about an event to which you have subscribed.</p>",
"refs": {
"AddSourceIdentifierToSubscriptionResult$EventSubscription": null,
"CreateEventSubscriptionResult$EventSubscription": null,
"DeleteEventSubscriptionResult$EventSubscription": null,
"EventSubscriptionsList$member": null,
"ModifyEventSubscriptionResult$EventSubscription": null,
"RemoveSourceIdentifierFromSubscriptionResult$EventSubscription": null
}
},
"EventSubscriptionQuotaExceededFault": {
"base": "<p>You have reached the maximum number of event subscriptions. </p>",
"refs": {
}
},
"EventSubscriptionsList": {
"base": null,
"refs": {
"EventSubscriptionsMessage$EventSubscriptionsList": "<p>A list of event subscriptions.</p>"
}
},
"EventSubscriptionsMessage": {
"base": "<p>Represents the output of <a>DescribeEventSubscriptions</a>.</p>",
"refs": {
}
},
"EventsMessage": {
"base": "<p>Represents the output of <a>DescribeEvents</a>.</p>",
"refs": {
}
},
"FailoverDBClusterMessage": {
"base": "<p>Represents the input to <a>FailoverDBCluster</a>.</p>",
"refs": {
}
},
"FailoverDBClusterResult": {
"base": null,
"refs": {
}
},
"Filter": {
"base": "<p>A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.</p> <p>Wildcards are not supported in filters.</p>",
"refs": {
"FilterList$member": null
}
},
"FilterList": {
"base": null,
"refs": {
"DescribeCertificatesMessage$Filters": "<p>This parameter is not currently supported.</p>",
"DescribeDBClusterParameterGroupsMessage$Filters": "<p>This parameter is not currently supported.</p>",
"DescribeDBClusterParametersMessage$Filters": "<p>This parameter is not currently supported.</p>",
"DescribeDBClusterSnapshotsMessage$Filters": "<p>This parameter is not currently supported.</p>",
"DescribeDBClustersMessage$Filters": "<p>A filter that specifies one or more clusters to describe.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.</p> </li> </ul>",
"DescribeDBEngineVersionsMessage$Filters": "<p>This parameter is not currently supported.</p>",
"DescribeDBInstancesMessage$Filters": "<p>A filter that specifies one or more instances to describe.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.</p> </li> <li> <p> <code>db-instance-id</code> - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.</p> </li> </ul>",
"DescribeDBSubnetGroupsMessage$Filters": "<p>This parameter is not currently supported.</p>",
"DescribeEngineDefaultClusterParametersMessage$Filters": "<p>This parameter is not currently supported.</p>",
"DescribeEventCategoriesMessage$Filters": "<p>This parameter is not currently supported.</p>",
"DescribeEventSubscriptionsMessage$Filters": "<p>This parameter is not currently supported.</p>",
"DescribeEventsMessage$Filters": "<p>This parameter is not currently supported.</p>",
"DescribeGlobalClustersMessage$Filters": "<p>A filter that specifies one or more global DB clusters to describe.</p> <p>Supported filters: <code>db-cluster-id</code> accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.</p>",
"DescribeOrderableDBInstanceOptionsMessage$Filters": "<p>This parameter is not currently supported.</p>",
"DescribePendingMaintenanceActionsMessage$Filters": "<p>A filter that specifies one or more resources to return pending maintenance actions for.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the clusters identified by these ARNs.</p> </li> <li> <p> <code>db-instance-id</code> - Accepts instance identifiers and instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs.</p> </li> </ul>",
"ListTagsForResourceMessage$Filters": "<p>This parameter is not currently supported.</p>"
}
},
"FilterValueList": {
"base": null,
"refs": {
"Filter$Values": "<p>One or more filter values. Filter values are case sensitive.</p>"
}
},
"GlobalCluster": {
"base": "<p>A data type representing an Amazon DocumentDB global cluster.</p>",
"refs": {
"CreateGlobalClusterResult$GlobalCluster": null,
"DeleteGlobalClusterResult$GlobalCluster": null,
"GlobalClusterList$member": null,
"ModifyGlobalClusterResult$GlobalCluster": null,
"RemoveFromGlobalClusterResult$GlobalCluster": null
}
},
"GlobalClusterAlreadyExistsFault": {
"base": "<p>The <code>GlobalClusterIdentifier</code> already exists. Choose a new global cluster identifier (unique name) to create a new global cluster. </p>",
"refs": {
}
},
"GlobalClusterIdentifier": {
"base": null,
"refs": {
"CreateDBClusterMessage$GlobalClusterIdentifier": "<p>The cluster identifier of the new global cluster.</p>",
"CreateGlobalClusterMessage$GlobalClusterIdentifier": "<p>The cluster identifier of the new global cluster.</p>",
"DeleteGlobalClusterMessage$GlobalClusterIdentifier": "<p>The cluster identifier of the global cluster being deleted.</p>",
"DescribeGlobalClustersMessage$GlobalClusterIdentifier": "<p>The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive.</p>",
"GlobalCluster$GlobalClusterIdentifier": "<p>Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster. </p>",
"ModifyGlobalClusterMessage$GlobalClusterIdentifier": "<p>The identifier for the global cluster being modified. This parameter isn't case-sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing global cluster.</p> </li> </ul>",
"ModifyGlobalClusterMessage$NewGlobalClusterIdentifier": "<p>The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens</p> <p>The first character must be a letter</p> <p>Can't end with a hyphen or contain two consecutive hyphens</p> </li> </ul> <p>Example: <code>my-cluster2</code> </p>",
"RemoveFromGlobalClusterMessage$GlobalClusterIdentifier": "<p>The cluster identifier to detach from the Amazon DocumentDB global cluster. </p>"
}
},
"GlobalClusterList": {
"base": null,
"refs": {
"GlobalClustersMessage$GlobalClusters": "<p/>"
}
},
"GlobalClusterMember": {
"base": "<p>A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters. </p>",
"refs": {
"GlobalClusterMemberList$member": null
}
},
"GlobalClusterMemberList": {
"base": null,
"refs": {
"GlobalCluster$GlobalClusterMembers": "<p>The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item. </p>"
}
},
"GlobalClusterNotFoundFault": {
"base": "<p>The <code>GlobalClusterIdentifier</code> doesn't refer to an existing global cluster.</p>",
"refs": {
}
},
"GlobalClusterQuotaExceededFault": {
"base": "<p>The number of global clusters for this account is already at the maximum allowed.</p>",
"refs": {
}
},
"GlobalClustersMessage": {
"base": null,
"refs": {
}
},
"InstanceQuotaExceededFault": {
"base": "<p>The request would cause you to exceed the allowed number of instances.</p>",
"refs": {
}
},
"InsufficientDBClusterCapacityFault": {
"base": "<p>The cluster doesn't have enough capacity for the current operation.</p>",
"refs": {
}
},
"InsufficientDBInstanceCapacityFault": {
"base": "<p>The specified instance class isn't available in the specified Availability Zone.</p>",
"refs": {
}
},
"InsufficientStorageClusterCapacityFault": {
"base": "<p>There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available. </p>",
"refs": {
}
},
"Integer": {
"base": null,
"refs": {
"DBClusterSnapshot$Port": "<p>Specifies the port that the cluster was listening on at the time of the snapshot.</p>",
"DBClusterSnapshot$PercentProgress": "<p>Specifies the percentage of the estimated data that has been transferred.</p>",
"DBInstance$BackupRetentionPeriod": "<p>Specifies the number of days for which automatic snapshots are retained.</p>",
"Endpoint$Port": "<p>Specifies the port that the database engine is listening on.</p>"
}
},
"IntegerOptional": {
"base": null,
"refs": {
"CreateDBClusterMessage$BackupRetentionPeriod": "<p>The number of days for which automated backups are retained. You must specify a minimum value of 1.</p> <p>Default: 1</p> <p>Constraints:</p> <ul> <li> <p>Must be a value from 1 to 35.</p> </li> </ul>",
"CreateDBClusterMessage$Port": "<p>The port number on which the instances in the cluster accept connections.</p>",
"CreateDBInstanceMessage$PromotionTier": "<p>A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.</p> <p>Default: 1</p> <p>Valid values: 0-15</p>",
"DBCluster$BackupRetentionPeriod": "<p>Specifies the number of days for which automatic snapshots are retained.</p>",
"DBCluster$Port": "<p>Specifies the port that the database engine is listening on.</p>",
"DBClusterMember$PromotionTier": "<p>A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance. </p>",
"DBInstance$PromotionTier": "<p>A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.</p>",
"DescribeCertificatesMessage$MaxRecords": "<p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints:</p> <ul> <li> <p>Minimum: 20</p> </li> <li> <p>Maximum: 100</p> </li> </ul>",
"DescribeDBClusterParameterGroupsMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
"DescribeDBClusterParametersMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
"DescribeDBClusterSnapshotsMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
"DescribeDBClustersMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
"DescribeDBEngineVersionsMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
"DescribeDBInstancesMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
"DescribeDBSubnetGroupsMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
"DescribeEngineDefaultClusterParametersMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
"DescribeEventSubscriptionsMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
"DescribeEventsMessage$Duration": "<p>The number of minutes to retrieve events for.</p> <p>Default: 60</p>",
"DescribeEventsMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
"DescribeGlobalClustersMessage$MaxRecords": "<p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. </p>",
"DescribeOrderableDBInstanceOptionsMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
"DescribePendingMaintenanceActionsMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
"ModifyDBClusterMessage$BackupRetentionPeriod": "<p>The number of days for which automated backups are retained. You must specify a minimum value of 1.</p> <p>Default: 1</p> <p>Constraints:</p> <ul> <li> <p>Must be a value from 1 to 35.</p> </li> </ul>",
"ModifyDBClusterMessage$Port": "<p>The port number on which the cluster accepts connections.</p> <p>Constraints: Must be a value from <code>1150</code> to <code>65535</code>. </p> <p>Default: The same port as the original cluster.</p>",
"ModifyDBInstanceMessage$PromotionTier": "<p>A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.</p> <p>Default: 1</p> <p>Valid values: 0-15</p>",
"PendingModifiedValues$AllocatedStorage": "<p> Contains the new <code>AllocatedStorage</code> size for then instance that will be applied or is currently being applied. </p>",
"PendingModifiedValues$Port": "<p>Specifies the pending port for the instance.</p>",
"PendingModifiedValues$BackupRetentionPeriod": "<p>Specifies the pending number of days for which automated backups are retained.</p>",
"PendingModifiedValues$Iops": "<p>Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.</p>",
"RestoreDBClusterFromSnapshotMessage$Port": "<p>The port number on which the new cluster accepts connections.</p> <p>Constraints: Must be a value from <code>1150</code> to <code>65535</code>.</p> <p>Default: The same port as the original cluster.</p>",
"RestoreDBClusterToPointInTimeMessage$Port": "<p>The port number on which the new cluster accepts connections.</p> <p>Constraints: Must be a value from <code>1150</code> to <code>65535</code>. </p> <p>Default: The default port for the engine.</p>"
}
},
"InvalidDBClusterSnapshotStateFault": {
"base": "<p>The provided value isn't a valid cluster snapshot state.</p>",
"refs": {
}
},
"InvalidDBClusterStateFault": {
"base": "<p>The cluster isn't in a valid state.</p>",
"refs": {