@aws-sdk/client-docdb 3.379.1 → 3.385.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist-types/models/models_0.d.ts +514 -0
  2. package/package.json +5 -5
package/dist-types/models/models_0.d.ts CHANGED
@@ -7,11 +7,13 @@ import { DocDBServiceException as __BaseException } from "./DocDBServiceExceptio
7
7
  */
8
8
  export interface AddSourceIdentifierToSubscriptionMessage {
9
9
  /**
10
+ * @public
10
11
  * <p>The name of the Amazon DocumentDB event notification subscription that you
11
12
  * want to add a source identifier to.</p>
12
13
  */
13
14
  SubscriptionName: string | undefined;
14
15
  /**
16
+ * @public
15
17
  * <p>The identifier of the event source to be added:</p>
16
18
  * <ul>
17
19
  * <li>
@@ -40,19 +42,23 @@ export interface AddSourceIdentifierToSubscriptionMessage {
40
42
  */
41
43
  export interface EventSubscription {
42
44
  /**
45
+ * @public
43
46
  * <p>The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification
44
47
  * subscription.</p>
45
48
  */
46
49
  CustomerAwsId?: string;
47
50
  /**
51
+ * @public
48
52
  * <p>The Amazon DocumentDB event notification subscription ID.</p>
49
53
  */
50
54
  CustSubscriptionId?: string;
51
55
  /**
56
+ * @public
52
57
  * <p>The topic ARN of the Amazon DocumentDB event notification subscription.</p>
53
58
  */
54
59
  SnsTopicArn?: string;
55
60
  /**
61
+ * @public
56
62
  * <p>The status of the Amazon DocumentDB event notification subscription.</p>
57
63
  * <p>Constraints:</p>
58
64
  * <p>Can be one of the following: <code>creating</code>, <code>modifying</code>,
@@ -65,27 +71,33 @@ export interface EventSubscription {
65
71
  */
66
72
  Status?: string;
67
73
  /**
74
+ * @public
68
75
  * <p>The time at which the Amazon DocumentDB event notification subscription was created.</p>
69
76
  */
70
77
  SubscriptionCreationTime?: string;
71
78
  /**
79
+ * @public
72
80
  * <p>The source type for the Amazon DocumentDB event notification subscription.</p>
73
81
  */
74
82
  SourceType?: string;
75
83
  /**
84
+ * @public
76
85
  * <p>A list of source IDs for the Amazon DocumentDB event notification subscription.</p>
77
86
  */
78
87
  SourceIdsList?: string[];
79
88
  /**
89
+ * @public
80
90
  * <p>A list of event categories for the Amazon DocumentDB event notification subscription.</p>
81
91
  */
82
92
  EventCategoriesList?: string[];
83
93
  /**
94
+ * @public
84
95
  * <p>A Boolean value indicating whether the subscription is enabled. A value of
85
96
  * <code>true</code> indicates that the subscription is enabled.</p>
86
97
  */
87
98
  Enabled?: boolean;
88
99
  /**
100
+ * @public
89
101
  * <p>The Amazon Resource Name (ARN) for the event subscription.</p>
90
102
  */
91
103
  EventSubscriptionArn?: string;
@@ -95,6 +107,7 @@ export interface EventSubscription {
95
107
  */
96
108
  export interface AddSourceIdentifierToSubscriptionResult {
97
109
  /**
110
+ * @public
98
111
  * <p>Detailed information about an event to which you have subscribed.</p>
99
112
  */
100
113
  EventSubscription?: EventSubscription;
@@ -129,10 +142,12 @@ export declare class SubscriptionNotFoundFault extends __BaseException {
129
142
  */
130
143
  export interface Tag {
131
144
  /**
145
+ * @public
132
146
  * <p>The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "<code>aws:</code>" or "<code>rds:</code>". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p\{L\}\\p\{Z\}\\p\{N\}_.:/=+\\-]*)$").</p>
133
147
  */
134
148
  Key?: string;
135
149
  /**
150
+ * @public
136
151
  * <p>The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "<code>aws:</code>" or "<code>rds:</code>". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p\{L\}\\p\{Z\}\\p\{N\}_.:/=+\\-]*)$").</p>
137
152
  */
138
153
  Value?: string;
@@ -144,11 +159,13 @@ export interface Tag {
144
159
  */
145
160
  export interface AddTagsToResourceMessage {
146
161
  /**
162
+ * @public
147
163
  * <p>The Amazon DocumentDB resource that the tags are added to. This value is an
148
164
  * Amazon Resource Name .</p>
149
165
  */
150
166
  ResourceName: string | undefined;
151
167
  /**
168
+ * @public
152
169
  * <p>The tags to be assigned to the Amazon DocumentDB resource.</p>
153
170
  */
154
171
  Tags: Tag[] | undefined;
@@ -199,17 +216,20 @@ export declare class DBSnapshotNotFoundFault extends __BaseException {
199
216
  */
200
217
  export interface ApplyPendingMaintenanceActionMessage {
201
218
  /**
219
+ * @public
202
220
  * <p>The Amazon Resource Name (ARN) of the resource that the pending
203
221
  * maintenance action applies to.</p>
204
222
  */
205
223
  ResourceIdentifier: string | undefined;
206
224
  /**
225
+ * @public
207
226
  * <p>The pending maintenance action to apply to this resource.</p>
208
227
  * <p>Valid values: <code>system-update</code>, <code>db-upgrade</code>
209
228
  * </p>
210
229
  */
211
230
  ApplyAction: string | undefined;
212
231
  /**
232
+ * @public
213
233
  * <p>A value that specifies the type of opt-in request or undoes an
214
234
  * opt-in request. An opt-in request of type <code>immediate</code>
215
235
  * can't be undone.</p>
@@ -241,16 +261,19 @@ export interface ApplyPendingMaintenanceActionMessage {
241
261
  */
242
262
  export interface PendingMaintenanceAction {
243
263
  /**
264
+ * @public
244
265
  * <p>The type of pending maintenance action that is available for the resource.</p>
245
266
  */
246
267
  Action?: string;
247
268
  /**
269
+ * @public
248
270
  * <p>The date of the maintenance window when the action is applied. The maintenance action
249
271
  * is applied to the resource during its first maintenance window after this date. If this
250
272
  * date is specified, any <code>next-maintenance</code> opt-in requests are ignored.</p>
251
273
  */
252
274
  AutoAppliedAfterDate?: Date;
253
275
  /**
276
+ * @public
254
277
  * <p>The date when the maintenance action is automatically applied. The maintenance action
255
278
  * is applied to the resource on this date regardless of the maintenance window for the
256
279
  * resource. If this date is specified, any <code>immediate</code> opt-in requests are
@@ -258,15 +281,18 @@ export interface PendingMaintenanceAction {
258
281
  */
259
282
  ForcedApplyDate?: Date;
260
283
  /**
284
+ * @public
261
285
  * <p>Indicates the type of opt-in request that has been received for the resource.</p>
262
286
  */
263
287
  OptInStatus?: string;
264
288
  /**
289
+ * @public
265
290
  * <p>The effective date when the pending maintenance action is applied to the
266
291
  * resource.</p>
267
292
  */
268
293
  CurrentApplyDate?: Date;
269
294
  /**
295
+ * @public
270
296
  * <p>A description providing more detail about the maintenance action.</p>
271
297
  */
272
298
  Description?: string;
@@ -278,11 +304,13 @@ export interface PendingMaintenanceAction {
278
304
  */
279
305
  export interface ResourcePendingMaintenanceActions {
280
306
  /**
307
+ * @public
281
308
  * <p>The Amazon Resource Name (ARN) of the resource that has pending
282
309
  * maintenance actions.</p>
283
310
  */
284
311
  ResourceIdentifier?: string;
285
312
  /**
313
+ * @public
286
314
  * <p>A list that provides details about the pending maintenance actions
287
315
  * for the resource.</p>
288
316
  */
@@ -293,6 +321,7 @@ export interface ResourcePendingMaintenanceActions {
293
321
  */
294
322
  export interface ApplyPendingMaintenanceActionResult {
295
323
  /**
324
+ * @public
296
325
  * <p>Represents the output of <a>ApplyPendingMaintenanceAction</a>.
297
326
  * </p>
298
327
  */
@@ -342,6 +371,7 @@ export declare class ResourceNotFoundFault extends __BaseException {
342
371
  */
343
372
  export interface CopyDBClusterParameterGroupMessage {
344
373
  /**
374
+ * @public
345
375
  * <p>The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.</p>
346
376
  * <p>Constraints:</p>
347
377
  * <ul>
@@ -358,6 +388,7 @@ export interface CopyDBClusterParameterGroupMessage {
358
388
  */
359
389
  SourceDBClusterParameterGroupIdentifier: string | undefined;
360
390
  /**
391
+ * @public
361
392
  * <p>The identifier for the copied cluster parameter group.</p>
362
393
  * <p>Constraints:</p>
363
394
  * <ul>
@@ -381,10 +412,12 @@ export interface CopyDBClusterParameterGroupMessage {
381
412
  */
382
413
  TargetDBClusterParameterGroupIdentifier: string | undefined;
383
414
  /**
415
+ * @public
384
416
  * <p>A description for the copied cluster parameter group.</p>
385
417
  */
386
418
  TargetDBClusterParameterGroupDescription: string | undefined;
387
419
  /**
420
+ * @public
388
421
  * <p>The tags that are to be assigned to the parameter group.</p>
389
422
  */
390
423
  Tags?: Tag[];
@@ -395,20 +428,24 @@ export interface CopyDBClusterParameterGroupMessage {
395
428
  */
396
429
  export interface DBClusterParameterGroup {
397
430
  /**
431
+ * @public
398
432
  * <p>Provides the name of the cluster parameter group.</p>
399
433
  */
400
434
  DBClusterParameterGroupName?: string;
401
435
  /**
436
+ * @public
402
437
  * <p>Provides the name of the parameter group family that this cluster parameter
403
438
  * group is compatible with.</p>
404
439
  */
405
440
  DBParameterGroupFamily?: string;
406
441
  /**
442
+ * @public
407
443
  * <p>Provides the customer-specified description for this cluster parameter
408
444
  * group.</p>
409
445
  */
410
446
  Description?: string;
411
447
  /**
448
+ * @public
412
449
  * <p>The Amazon Resource Name (ARN) for the cluster parameter group.</p>
413
450
  */
414
451
  DBClusterParameterGroupArn?: string;
@@ -418,6 +455,7 @@ export interface DBClusterParameterGroup {
418
455
  */
419
456
  export interface CopyDBClusterParameterGroupResult {
420
457
  /**
458
+ * @public
421
459
  * <p>Detailed information about a cluster parameter group. </p>
422
460
  */
423
461
  DBClusterParameterGroup?: DBClusterParameterGroup;
@@ -466,6 +504,7 @@ export declare class DBParameterGroupQuotaExceededFault extends __BaseException
466
504
  */
467
505
  export interface CopyDBClusterSnapshotMessage {
468
506
  /**
507
+ * @public
469
508
  * <p>The identifier of the cluster snapshot to copy. This parameter is
470
509
  * not case sensitive.</p>
471
510
  * <p>Constraints:</p>
@@ -486,6 +525,7 @@ export interface CopyDBClusterSnapshotMessage {
486
525
  */
487
526
  SourceDBClusterSnapshotIdentifier: string | undefined;
488
527
  /**
528
+ * @public
489
529
  * <p>The identifier of the new cluster snapshot to create from the
490
530
  * source cluster snapshot. This parameter is not case sensitive.</p>
491
531
  * <p>Constraints:</p>
@@ -507,6 +547,7 @@ export interface CopyDBClusterSnapshotMessage {
507
547
  */
508
548
  TargetDBClusterSnapshotIdentifier: string | undefined;
509
549
  /**
550
+ * @public
510
551
  * <p>The KMS key ID for an encrypted cluster snapshot. The KMS
511
552
  * key ID is the Amazon Resource Name (ARN), KMS key identifier, or
512
553
  * the KMS key alias for the KMS encryption key. </p>
@@ -517,6 +558,7 @@ export interface CopyDBClusterSnapshotMessage {
517
558
  */
518
559
  KmsKeyId?: string;
519
560
  /**
561
+ * @public
520
562
  * <p>The URL that contains a Signature Version 4 signed request for the<code>CopyDBClusterSnapshot</code> API action in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use the <code>PreSignedUrl</code> parameter when copying a cluster snapshot from another Amazon Web Services Region.</p>
521
563
  * <p>If you are using an Amazon Web Services SDK tool or the CLI, you can specify
522
564
  * <code>SourceRegion</code> (or <code>--source-region</code> for the
@@ -557,12 +599,14 @@ export interface CopyDBClusterSnapshotMessage {
557
599
  */
558
600
  PreSignedUrl?: string;
559
601
  /**
602
+ * @public
560
603
  * <p>Set to <code>true</code> to copy all tags from the source cluster
561
604
  * snapshot to the target cluster snapshot, and otherwise
562
605
  * <code>false</code>. The default is <code>false</code>.</p>
563
606
  */
564
607
  CopyTags?: boolean;
565
608
  /**
609
+ * @public
566
610
  * <p>The tags to be assigned to the cluster snapshot.</p>
567
611
  */
568
612
  Tags?: Tag[];
@@ -573,75 +617,92 @@ export interface CopyDBClusterSnapshotMessage {
573
617
  */
574
618
  export interface DBClusterSnapshot {
575
619
  /**
620
+ * @public
576
621
  * <p>Provides the list of Amazon EC2 Availability Zones that instances in the cluster
577
622
  * snapshot can be restored in.</p>
578
623
  */
579
624
  AvailabilityZones?: string[];
580
625
  /**
626
+ * @public
581
627
  * <p>Specifies the identifier for the cluster snapshot.</p>
582
628
  */
583
629
  DBClusterSnapshotIdentifier?: string;
584
630
  /**
631
+ * @public
585
632
  * <p>Specifies the cluster identifier of the cluster that this cluster snapshot
586
633
  * was created from.</p>
587
634
  */
588
635
  DBClusterIdentifier?: string;
589
636
  /**
637
+ * @public
590
638
  * <p>Provides the time when the snapshot was taken, in UTC.</p>
591
639
  */
592
640
  SnapshotCreateTime?: Date;
593
641
  /**
642
+ * @public
594
643
  * <p>Specifies the name of the database engine.</p>
595
644
  */
596
645
  Engine?: string;
597
646
  /**
647
+ * @public
598
648
  * <p>Specifies the status of this cluster snapshot.</p>
599
649
  */
600
650
  Status?: string;
601
651
  /**
652
+ * @public
602
653
  * <p>Specifies the port that the cluster was listening on at the time of the
603
654
  * snapshot.</p>
604
655
  */
605
656
  Port?: number;
606
657
  /**
658
+ * @public
607
659
  * <p>Provides the virtual private cloud (VPC) ID that is associated with the cluster
608
660
  * snapshot.</p>
609
661
  */
610
662
  VpcId?: string;
611
663
  /**
664
+ * @public
612
665
  * <p>Specifies the time when the cluster was created, in Universal Coordinated Time
613
666
  * (UTC).</p>
614
667
  */
615
668
  ClusterCreateTime?: Date;
616
669
  /**
670
+ * @public
617
671
  * <p>Provides the master user name for the cluster snapshot.</p>
618
672
  */
619
673
  MasterUsername?: string;
620
674
  /**
675
+ * @public
621
676
  * <p>Provides the version of the database engine for this cluster snapshot.</p>
622
677
  */
623
678
  EngineVersion?: string;
624
679
  /**
680
+ * @public
625
681
  * <p>Provides the type of the cluster snapshot.</p>
626
682
  */
627
683
  SnapshotType?: string;
628
684
  /**
685
+ * @public
629
686
  * <p>Specifies the percentage of the estimated data that has been transferred.</p>
630
687
  */
631
688
  PercentProgress?: number;
632
689
  /**
690
+ * @public
633
691
  * <p>Specifies whether the cluster snapshot is encrypted.</p>
634
692
  */
635
693
  StorageEncrypted?: boolean;
636
694
  /**
695
+ * @public
637
696
  * <p>If <code>StorageEncrypted</code> is <code>true</code>, the KMS key identifier for the encrypted cluster snapshot.</p>
638
697
  */
639
698
  KmsKeyId?: string;
640
699
  /**
700
+ * @public
641
701
  * <p>The Amazon Resource Name (ARN) for the cluster snapshot.</p>
642
702
  */
643
703
  DBClusterSnapshotArn?: string;
644
704
  /**
705
+ * @public
645
706
  * <p>If the cluster snapshot was copied from a source cluster snapshot, the ARN for
646
707
  * the source cluster snapshot; otherwise, a null value.</p>
647
708
  */
@@ -652,6 +713,7 @@ export interface DBClusterSnapshot {
652
713
  */
653
714
  export interface CopyDBClusterSnapshotResult {
654
715
  /**
716
+ * @public
655
717
  * <p>Detailed information about a cluster snapshot. </p>
656
718
  */
657
719
  DBClusterSnapshot?: DBClusterSnapshot;
@@ -724,11 +786,13 @@ export declare class SnapshotQuotaExceededFault extends __BaseException {
724
786
  */
725
787
  export interface CreateDBClusterMessage {
726
788
  /**
789
+ * @public
727
790
  * <p>A list of Amazon EC2 Availability Zones that instances in the
728
791
  * cluster can be created in.</p>
729
792
  */
730
793
  AvailabilityZones?: string[];
731
794
  /**
795
+ * @public
732
796
  * <p>The number of days for which automated backups are retained. You
733
797
  * must specify a minimum value of 1.</p>
734
798
  * <p>Default: 1</p>
@@ -741,6 +805,7 @@ export interface CreateDBClusterMessage {
741
805
  */
742
806
  BackupRetentionPeriod?: number;
743
807
  /**
808
+ * @public
744
809
  * <p>The cluster identifier. This parameter is stored as a lowercase
745
810
  * string.</p>
746
811
  * <p>Constraints:</p>
@@ -762,16 +827,19 @@ export interface CreateDBClusterMessage {
762
827
  */
763
828
  DBClusterIdentifier: string | undefined;
764
829
  /**
830
+ * @public
765
831
  * <p>The name of the cluster parameter group to associate with this
766
832
  * cluster.</p>
767
833
  */
768
834
  DBClusterParameterGroupName?: string;
769
835
  /**
836
+ * @public
770
837
  * <p>A list of EC2 VPC security groups to associate with this cluster.
771
838
  * </p>
772
839
  */
773
840
  VpcSecurityGroupIds?: string[];
774
841
  /**
842
+ * @public
775
843
  * <p>A subnet group to associate with this cluster.</p>
776
844
  * <p>Constraints: Must match the name of an existing
777
845
  * <code>DBSubnetGroup</code>. Must not be default.</p>
@@ -780,21 +848,25 @@ export interface CreateDBClusterMessage {
780
848
  */
781
849
  DBSubnetGroupName?: string;
782
850
  /**
851
+ * @public
783
852
  * <p>The name of the database engine to be used for this cluster.</p>
784
853
  * <p>Valid values: <code>docdb</code>
785
854
  * </p>
786
855
  */
787
856
  Engine: string | undefined;
788
857
  /**
858
+ * @public
789
859
  * <p>The version number of the database engine to use. The <code>--engine-version</code> will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.</p>
790
860
  */
791
861
  EngineVersion?: string;
792
862
  /**
863
+ * @public
793
864
  * <p>The port number on which the instances in the cluster accept
794
865
  * connections.</p>
795
866
  */
796
867
  Port?: number;
797
868
  /**
869
+ * @public
798
870
  * <p>The name of the master user for the cluster.</p>
799
871
  * <p>Constraints:</p>
800
872
  * <ul>
@@ -812,6 +884,7 @@ export interface CreateDBClusterMessage {
812
884
  */
813
885
  MasterUsername?: string;
814
886
  /**
887
+ * @public
815
888
  * <p>The password for the master database user. This password can
816
889
  * contain any printable ASCII character except forward slash (/),
817
890
  * double quote ("), or the "at" symbol (@).</p>
@@ -819,6 +892,7 @@ export interface CreateDBClusterMessage {
819
892
  */
820
893
  MasterUserPassword?: string;
821
894
  /**
895
+ * @public
822
896
  * <p>The daily time range during which automated backups are created if
823
897
  * automated backups are enabled using the <code>BackupRetentionPeriod</code> parameter. </p>
824
898
  * <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. </p>
@@ -841,6 +915,7 @@ export interface CreateDBClusterMessage {
841
915
  */
842
916
  PreferredBackupWindow?: string;
843
917
  /**
918
+ * @public
844
919
  * <p>The weekly time range during which system maintenance can occur,
845
920
  * in Universal Coordinated Time (UTC).</p>
846
921
  * <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code>
@@ -851,14 +926,17 @@ export interface CreateDBClusterMessage {
851
926
  */
852
927
  PreferredMaintenanceWindow?: string;
853
928
  /**
929
+ * @public
854
930
  * <p>The tags to be assigned to the cluster.</p>
855
931
  */
856
932
  Tags?: Tag[];
857
933
  /**
934
+ * @public
858
935
  * <p>Specifies whether the cluster is encrypted.</p>
859
936
  */
860
937
  StorageEncrypted?: boolean;
861
938
  /**
939
+ * @public
862
940
  * <p>The KMS key identifier for an encrypted cluster.</p>
863
941
  * <p>The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key.</p>
864
942
  * <p>If an encryption key is not specified in <code>KmsKeyId</code>:
@@ -874,11 +952,13 @@ export interface CreateDBClusterMessage {
874
952
  */
875
953
  KmsKeyId?: string;
876
954
  /**
955
+ * @public
877
956
  * <p>Not currently supported.
878
957
  * </p>
879
958
  */
880
959
  PreSignedUrl?: string;
881
960
  /**
961
+ * @public
882
962
  * <p>A list of log types that need to be enabled for exporting to Amazon
883
963
  * CloudWatch Logs. You can enable audit logs or profiler logs. For more
884
964
  * information, see <a href="https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html">
@@ -889,6 +969,7 @@ export interface CreateDBClusterMessage {
889
969
  */
890
970
  EnableCloudwatchLogsExports?: string[];
891
971
  /**
972
+ * @public
892
973
  * <p>Specifies whether this cluster can be deleted. If
893
974
  * <code>DeletionProtection</code> is enabled, the cluster cannot be
894
975
  * deleted unless it is modified and <code>DeletionProtection</code> is
@@ -897,6 +978,7 @@ export interface CreateDBClusterMessage {
897
978
  */
898
979
  DeletionProtection?: boolean;
899
980
  /**
981
+ * @public
900
982
  * <p>The cluster identifier of the new global cluster.</p>
901
983
  */
902
984
  GlobalClusterIdentifier?: string;
@@ -908,11 +990,13 @@ export interface CreateDBClusterMessage {
908
990
  */
909
991
  export interface DBClusterRole {
910
992
  /**
993
+ * @public
911
994
  * <p>The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB
912
995
  * cluster.</p>
913
996
  */
914
997
  RoleArn?: string;
915
998
  /**
999
+ * @public
916
1000
  * <p>Describes the state of association between the IAMrole and the cluster. The <code>Status</code> property returns one of the following values:</p>
917
1001
  * <ul>
918
1002
  * <li>
@@ -937,20 +1021,24 @@ export interface DBClusterRole {
937
1021
  */
938
1022
  export interface DBClusterMember {
939
1023
  /**
1024
+ * @public
940
1025
  * <p>Specifies the instance identifier for this member of the cluster.</p>
941
1026
  */
942
1027
  DBInstanceIdentifier?: string;
943
1028
  /**
1029
+ * @public
944
1030
  * <p>A value that is <code>true</code> if the cluster member is the primary instance for
945
1031
  * the cluster and <code>false</code> otherwise.</p>
946
1032
  */
947
1033
  IsClusterWriter?: boolean;
948
1034
  /**
1035
+ * @public
949
1036
  * <p>Specifies the status of the cluster parameter group for this member of the DB
950
1037
  * cluster.</p>
951
1038
  */
952
1039
  DBClusterParameterGroupStatus?: string;
953
1040
  /**
1041
+ * @public
954
1042
  * <p>A value that specifies the order in which an Amazon DocumentDB replica is promoted to the
955
1043
  * primary instance after a failure of the existing primary instance. </p>
956
1044
  */
@@ -963,10 +1051,12 @@ export interface DBClusterMember {
963
1051
  */
964
1052
  export interface VpcSecurityGroupMembership {
965
1053
  /**
1054
+ * @public
966
1055
  * <p>The name of the VPC security group.</p>
967
1056
  */
968
1057
  VpcSecurityGroupId?: string;
969
1058
  /**
1059
+ * @public
970
1060
  * <p>The status of the VPC security group.</p>
971
1061
  */
972
1062
  Status?: string;
@@ -977,142 +1067,174 @@ export interface VpcSecurityGroupMembership {
977
1067
  */
978
1068
  export interface DBCluster {
979
1069
  /**
1070
+ * @public
980
1071
  * <p>Provides the list of Amazon EC2 Availability Zones that instances in the cluster
981
1072
  * can be created in.</p>
982
1073
  */
983
1074
  AvailabilityZones?: string[];
984
1075
  /**
1076
+ * @public
985
1077
  * <p>Specifies the number of days for which automatic snapshots are retained.</p>
986
1078
  */
987
1079
  BackupRetentionPeriod?: number;
988
1080
  /**
1081
+ * @public
989
1082
  * <p>Contains a user-supplied cluster identifier. This identifier is the unique key that
990
1083
  * identifies a cluster.</p>
991
1084
  */
992
1085
  DBClusterIdentifier?: string;
993
1086
  /**
1087
+ * @public
994
1088
  * <p>Specifies the name of the cluster parameter group for the cluster.</p>
995
1089
  */
996
1090
  DBClusterParameterGroup?: string;
997
1091
  /**
1092
+ * @public
998
1093
  * <p>Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.</p>
999
1094
  */
1000
1095
  DBSubnetGroup?: string;
1001
1096
  /**
1097
+ * @public
1002
1098
  * <p>Specifies the current state of this cluster.</p>
1003
1099
  */
1004
1100
  Status?: string;
1005
1101
  /**
1102
+ * @public
1006
1103
  * <p>Specifies the progress of the operation as a percentage.</p>
1007
1104
  */
1008
1105
  PercentProgress?: string;
1009
1106
  /**
1107
+ * @public
1010
1108
  * <p>The earliest time to which a database can be restored with point-in-time
1011
1109
  * restore.</p>
1012
1110
  */
1013
1111
  EarliestRestorableTime?: Date;
1014
1112
  /**
1113
+ * @public
1015
1114
  * <p>Specifies the connection endpoint for the primary instance of the cluster.</p>
1016
1115
  */
1017
1116
  Endpoint?: string;
1018
1117
  /**
1118
+ * @public
1019
1119
  * <p>The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster. </p>
1020
1120
  * <p>If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.</p>
1021
1121
  */
1022
1122
  ReaderEndpoint?: string;
1023
1123
  /**
1124
+ * @public
1024
1125
  * <p>Specifies whether the cluster has instances in multiple Availability Zones.</p>
1025
1126
  */
1026
1127
  MultiAZ?: boolean;
1027
1128
  /**
1129
+ * @public
1028
1130
  * <p>Provides the name of the database engine to be used for this cluster.</p>
1029
1131
  */
1030
1132
  Engine?: string;
1031
1133
  /**
1134
+ * @public
1032
1135
  * <p>Indicates the database engine version.</p>
1033
1136
  */
1034
1137
  EngineVersion?: string;
1035
1138
  /**
1139
+ * @public
1036
1140
  * <p>Specifies the latest time to which a database can be restored with point-in-time
1037
1141
  * restore.</p>
1038
1142
  */
1039
1143
  LatestRestorableTime?: Date;
1040
1144
  /**
1145
+ * @public
1041
1146
  * <p>Specifies the port that the database engine is listening on.</p>
1042
1147
  */
1043
1148
  Port?: number;
1044
1149
  /**
1150
+ * @public
1045
1151
  * <p>Contains the master user name for the cluster.</p>
1046
1152
  */
1047
1153
  MasterUsername?: string;
1048
1154
  /**
1155
+ * @public
1049
1156
  * <p>Specifies the daily time range during which automated backups are created if automated
1050
1157
  * backups are enabled, as determined by the <code>BackupRetentionPeriod</code>. </p>
1051
1158
  */
1052
1159
  PreferredBackupWindow?: string;
1053
1160
  /**
1161
+ * @public
1054
1162
  * <p>Specifies the weekly time range during which system maintenance can occur, in
1055
1163
  * Universal Coordinated Time (UTC).</p>
1056
1164
  */
1057
1165
  PreferredMaintenanceWindow?: string;
1058
1166
  /**
1167
+ * @public
1059
1168
  * <p>Contains the identifier of the source cluster if this cluster is a secondary cluster.</p>
1060
1169
  */
1061
1170
  ReplicationSourceIdentifier?: string;
1062
1171
  /**
1172
+ * @public
1063
1173
  * <p>Contains one or more identifiers of the secondary clusters that are associated with this cluster.</p>
1064
1174
  */
1065
1175
  ReadReplicaIdentifiers?: string[];
1066
1176
  /**
1177
+ * @public
1067
1178
  * <p>Provides the list of instances that make up the cluster.</p>
1068
1179
  */
1069
1180
  DBClusterMembers?: DBClusterMember[];
1070
1181
  /**
1182
+ * @public
1071
1183
  * <p>Provides a list of virtual private cloud (VPC) security groups that the cluster
1072
1184
  * belongs to.</p>
1073
1185
  */
1074
1186
  VpcSecurityGroups?: VpcSecurityGroupMembership[];
1075
1187
  /**
1188
+ * @public
1076
1189
  * <p>Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.</p>
1077
1190
  */
1078
1191
  HostedZoneId?: string;
1079
1192
  /**
1193
+ * @public
1080
1194
  * <p>Specifies whether the cluster is encrypted.</p>
1081
1195
  */
1082
1196
  StorageEncrypted?: boolean;
1083
1197
  /**
1198
+ * @public
1084
1199
  * <p>If <code>StorageEncrypted</code> is <code>true</code>, the KMS key identifier for
1085
1200
  * the encrypted cluster.</p>
1086
1201
  */
1087
1202
  KmsKeyId?: string;
1088
1203
  /**
1204
+ * @public
1089
1205
  * <p>The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is
1090
1206
  * found in CloudTrail log entries whenever the KMS key for the cluster is accessed.</p>
1091
1207
  */
1092
1208
  DbClusterResourceId?: string;
1093
1209
  /**
1210
+ * @public
1094
1211
  * <p>The Amazon Resource Name (ARN) for the cluster.</p>
1095
1212
  */
1096
1213
  DBClusterArn?: string;
1097
1214
  /**
1215
+ * @public
1098
1216
  * <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>
1099
1217
  */
1100
1218
  AssociatedRoles?: DBClusterRole[];
1101
1219
  /**
1220
+ * @public
1102
1221
  * <p>Identifies the clone group to which the DB cluster is associated.</p>
1103
1222
  */
1104
1223
  CloneGroupId?: string;
1105
1224
  /**
1225
+ * @public
1106
1226
  * <p>Specifies the time when the cluster was created, in Universal Coordinated Time
1107
1227
  * (UTC).</p>
1108
1228
  */
1109
1229
  ClusterCreateTime?: Date;
1110
1230
  /**
1231
+ * @public
1111
1232
  * <p>A list of log types that this cluster is configured to export to Amazon CloudWatch
1112
1233
  * Logs.</p>
1113
1234
  */
1114
1235
  EnabledCloudwatchLogsExports?: string[];
1115
1236
  /**
1237
+ * @public
1116
1238
  * <p>Specifies whether this cluster can be deleted. If <code>DeletionProtection</code> is
1117
1239
  * enabled, the cluster cannot be deleted unless it is modified and
1118
1240
  * <code>DeletionProtection</code> is disabled. <code>DeletionProtection</code>
@@ -1125,6 +1247,7 @@ export interface DBCluster {
1125
1247
  */
1126
1248
  export interface CreateDBClusterResult {
1127
1249
  /**
1250
+ * @public
1128
1251
  * <p>Detailed information about a cluster. </p>
1129
1252
  */
1130
1253
  DBCluster?: DBCluster;
@@ -1284,6 +1407,7 @@ export declare class StorageQuotaExceededFault extends __BaseException {
1284
1407
  */
1285
1408
  export interface CreateDBClusterParameterGroupMessage {
1286
1409
  /**
1410
+ * @public
1287
1411
  * <p>The name of the cluster parameter group.</p>
1288
1412
  * <p>Constraints:</p>
1289
1413
  * <ul>
@@ -1298,14 +1422,17 @@ export interface CreateDBClusterParameterGroupMessage {
1298
1422
  */
1299
1423
  DBClusterParameterGroupName: string | undefined;
1300
1424
  /**
1425
+ * @public
1301
1426
  * <p>The cluster parameter group family name.</p>
1302
1427
  */
1303
1428
  DBParameterGroupFamily: string | undefined;
1304
1429
  /**
1430
+ * @public
1305
1431
  * <p>The description for the cluster parameter group.</p>
1306
1432
  */
1307
1433
  Description: string | undefined;
1308
1434
  /**
1435
+ * @public
1309
1436
  * <p>The tags to be assigned to the cluster parameter group.</p>
1310
1437
  */
1311
1438
  Tags?: Tag[];
@@ -1315,6 +1442,7 @@ export interface CreateDBClusterParameterGroupMessage {
1315
1442
  */
1316
1443
  export interface CreateDBClusterParameterGroupResult {
1317
1444
  /**
1445
+ * @public
1318
1446
  * <p>Detailed information about a cluster parameter group. </p>
1319
1447
  */
1320
1448
  DBClusterParameterGroup?: DBClusterParameterGroup;
@@ -1325,6 +1453,7 @@ export interface CreateDBClusterParameterGroupResult {
1325
1453
  */
1326
1454
  export interface CreateDBClusterSnapshotMessage {
1327
1455
  /**
1456
+ * @public
1328
1457
  * <p>The identifier of the cluster snapshot. This parameter is stored
1329
1458
  * as a lowercase string.</p>
1330
1459
  * <p>Constraints:</p>
@@ -1345,6 +1474,7 @@ export interface CreateDBClusterSnapshotMessage {
1345
1474
  */
1346
1475
  DBClusterSnapshotIdentifier: string | undefined;
1347
1476
  /**
1477
+ * @public
1348
1478
  * <p>The identifier of the cluster to create a snapshot for. This
1349
1479
  * parameter is not case sensitive.</p>
1350
1480
  * <p>Constraints:</p>
@@ -1359,6 +1489,7 @@ export interface CreateDBClusterSnapshotMessage {
1359
1489
  */
1360
1490
  DBClusterIdentifier: string | undefined;
1361
1491
  /**
1492
+ * @public
1362
1493
  * <p>The tags to be assigned to the cluster snapshot.</p>
1363
1494
  */
1364
1495
  Tags?: Tag[];
@@ -1368,6 +1499,7 @@ export interface CreateDBClusterSnapshotMessage {
1368
1499
  */
1369
1500
  export interface CreateDBClusterSnapshotResult {
1370
1501
  /**
1502
+ * @public
1371
1503
  * <p>Detailed information about a cluster snapshot. </p>
1372
1504
  */
1373
1505
  DBClusterSnapshot?: DBClusterSnapshot;
@@ -1391,6 +1523,7 @@ export declare class AuthorizationNotFoundFault extends __BaseException {
1391
1523
  */
1392
1524
  export interface CreateDBInstanceMessage {
1393
1525
  /**
1526
+ * @public
1394
1527
  * <p>The instance identifier. This parameter is stored as a lowercase string.</p>
1395
1528
  * <p>Constraints:</p>
1396
1529
  * <ul>
@@ -1409,17 +1542,20 @@ export interface CreateDBInstanceMessage {
1409
1542
  */
1410
1543
  DBInstanceIdentifier: string | undefined;
1411
1544
  /**
1545
+ * @public
1412
1546
  * <p>The compute and memory capacity of the instance; for example,
1413
1547
  * <code>db.r5.large</code>. </p>
1414
1548
  */
1415
1549
  DBInstanceClass: string | undefined;
1416
1550
  /**
1551
+ * @public
1417
1552
  * <p>The name of the database engine to be used for this instance.</p>
1418
1553
  * <p>Valid value: <code>docdb</code>
1419
1554
  * </p>
1420
1555
  */
1421
1556
  Engine: string | undefined;
1422
1557
  /**
1558
+ * @public
1423
1559
  * <p>The Amazon EC2 Availability Zone that the instance is created in. </p>
1424
1560
  * <p>Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.</p>
1425
1561
  * <p>Example: <code>us-east-1d</code>
@@ -1427,6 +1563,7 @@ export interface CreateDBInstanceMessage {
1427
1563
  */
1428
1564
  AvailabilityZone?: string;
1429
1565
  /**
1566
+ * @public
1430
1567
  * <p>The time range each week during which system maintenance can occur, in Universal
1431
1568
  * Coordinated Time (UTC).</p>
1432
1569
  * <p> Format: <code>ddd:hh24:mi-ddd:hh24:mi</code>
@@ -1438,25 +1575,30 @@ export interface CreateDBInstanceMessage {
1438
1575
  */
1439
1576
  PreferredMaintenanceWindow?: string;
1440
1577
  /**
1578
+ * @public
1441
1579
  * <p>This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.</p>
1442
1580
  * <p>Default: <code>false</code>
1443
1581
  * </p>
1444
1582
  */
1445
1583
  AutoMinorVersionUpgrade?: boolean;
1446
1584
  /**
1585
+ * @public
1447
1586
  * <p>The tags to be assigned to the instance. You can assign up to
1448
1587
  * 10 tags to an instance.</p>
1449
1588
  */
1450
1589
  Tags?: Tag[];
1451
1590
  /**
1591
+ * @public
1452
1592
  * <p>The identifier of the cluster that the instance will belong to.</p>
1453
1593
  */
1454
1594
  DBClusterIdentifier: string | undefined;
1455
1595
  /**
1596
+ * @public
1456
1597
  * <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>
1457
1598
  */
1458
1599
  CopyTagsToSnapshot?: boolean;
1459
1600
  /**
1601
+ * @public
1460
1602
  * <p>A value that specifies the order in which an Amazon DocumentDB replica is promoted to the
1461
1603
  * primary instance after a failure of the existing primary instance.</p>
1462
1604
  * <p>Default: 1</p>
@@ -1464,12 +1606,14 @@ export interface CreateDBInstanceMessage {
1464
1606
  */
1465
1607
  PromotionTier?: number;
1466
1608
  /**
1609
+ * @public
1467
1610
  * <p>A value that indicates whether to enable Performance Insights for the DB Instance. For
1468
1611
  * more information, see <a href="https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html">Using Amazon
1469
1612
  * Performance Insights</a>.</p>
1470
1613
  */
1471
1614
  EnablePerformanceInsights?: boolean;
1472
1615
  /**
1616
+ * @public
1473
1617
  * <p>The KMS key identifier for encryption of Performance Insights
1474
1618
  * data.</p>
1475
1619
  * <p>The KMS key identifier is the key ARN, key ID, alias ARN, or alias name
@@ -1487,6 +1631,7 @@ export interface CreateDBInstanceMessage {
1487
1631
  */
1488
1632
  export interface AvailabilityZone {
1489
1633
  /**
1634
+ * @public
1490
1635
  * <p>The name of the Availability Zone.</p>
1491
1636
  */
1492
1637
  Name?: string;
@@ -1497,14 +1642,17 @@ export interface AvailabilityZone {
1497
1642
  */
1498
1643
  export interface Subnet {
1499
1644
  /**
1645
+ * @public
1500
1646
  * <p>Specifies the identifier of the subnet.</p>
1501
1647
  */
1502
1648
  SubnetIdentifier?: string;
1503
1649
  /**
1650
+ * @public
1504
1651
  * <p>Specifies the Availability Zone for the subnet.</p>
1505
1652
  */
1506
1653
  SubnetAvailabilityZone?: AvailabilityZone;
1507
1654
  /**
1655
+ * @public
1508
1656
  * <p>Specifies the status of the subnet.</p>
1509
1657
  */
1510
1658
  SubnetStatus?: string;
@@ -1515,26 +1663,32 @@ export interface Subnet {
1515
1663
  */
1516
1664
  export interface DBSubnetGroup {
1517
1665
  /**
1666
+ * @public
1518
1667
  * <p>The name of the subnet group.</p>
1519
1668
  */
1520
1669
  DBSubnetGroupName?: string;
1521
1670
  /**
1671
+ * @public
1522
1672
  * <p>Provides the description of the subnet group.</p>
1523
1673
  */
1524
1674
  DBSubnetGroupDescription?: string;
1525
1675
  /**
1676
+ * @public
1526
1677
  * <p>Provides the virtual private cloud (VPC) ID of the subnet group.</p>
1527
1678
  */
1528
1679
  VpcId?: string;
1529
1680
  /**
1681
+ * @public
1530
1682
  * <p>Provides the status of the subnet group.</p>
1531
1683
  */
1532
1684
  SubnetGroupStatus?: string;
1533
1685
  /**
1686
+ * @public
1534
1687
  * <p>Detailed information about one or more subnets within a subnet group.</p>
1535
1688
  */
1536
1689
  Subnets?: Subnet[];
1537
1690
  /**
1691
+ * @public
1538
1692
  * <p>The Amazon Resource Name (ARN) for the DB subnet group.</p>
1539
1693
  */
1540
1694
  DBSubnetGroupArn?: string;
@@ -1546,14 +1700,17 @@ export interface DBSubnetGroup {
1546
1700
  */
1547
1701
  export interface Endpoint {
1548
1702
  /**
1703
+ * @public
1549
1704
  * <p>Specifies the DNS address of the instance.</p>
1550
1705
  */
1551
1706
  Address?: string;
1552
1707
  /**
1708
+ * @public
1553
1709
  * <p>Specifies the port that the database engine is listening on.</p>
1554
1710
  */
1555
1711
  Port?: number;
1556
1712
  /**
1713
+ * @public
1557
1714
  * <p>Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.</p>
1558
1715
  */
1559
1716
  HostedZoneId?: string;
@@ -1565,11 +1722,13 @@ export interface Endpoint {
1565
1722
  */
1566
1723
  export interface PendingCloudwatchLogsExports {
1567
1724
  /**
1725
+ * @public
1568
1726
  * <p>Log types that are in the process of being deactivated. After they are deactivated,
1569
1727
  * these log types aren't exported to CloudWatch Logs.</p>
1570
1728
  */
1571
1729
  LogTypesToEnable?: string[];
1572
1730
  /**
1731
+ * @public
1573
1732
  * <p>Log types that are in the process of being enabled. After they are enabled, these log
1574
1733
  * types are exported to Amazon CloudWatch Logs.</p>
1575
1734
  */
@@ -1582,37 +1741,45 @@ export interface PendingCloudwatchLogsExports {
1582
1741
  */
1583
1742
  export interface PendingModifiedValues {
1584
1743
  /**
1744
+ * @public
1585
1745
  * <p> Contains the new <code>DBInstanceClass</code> for the instance that will be
1586
1746
  * applied or is currently being applied. </p>
1587
1747
  */
1588
1748
  DBInstanceClass?: string;
1589
1749
  /**
1750
+ * @public
1590
1751
  * <p> Contains the new <code>AllocatedStorage</code> size for then instance that will be
1591
1752
  * applied or is currently being applied. </p>
1592
1753
  */
1593
1754
  AllocatedStorage?: number;
1594
1755
  /**
1756
+ * @public
1595
1757
  * <p>Contains the pending or currently in-progress change of the master credentials for the
1596
1758
  * instance.</p>
1597
1759
  */
1598
1760
  MasterUserPassword?: string;
1599
1761
  /**
1762
+ * @public
1600
1763
  * <p>Specifies the pending port for the instance.</p>
1601
1764
  */
1602
1765
  Port?: number;
1603
1766
  /**
1767
+ * @public
1604
1768
  * <p>Specifies the pending number of days for which automated backups are retained.</p>
1605
1769
  */
1606
1770
  BackupRetentionPeriod?: number;
1607
1771
  /**
1772
+ * @public
1608
1773
  * <p>Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.</p>
1609
1774
  */
1610
1775
  MultiAZ?: boolean;
1611
1776
  /**
1777
+ * @public
1612
1778
  * <p>Indicates the database engine version.</p>
1613
1779
  */
1614
1780
  EngineVersion?: string;
1615
1781
  /**
1782
+ * @public
1616
1783
  * <p>The license model for the instance.</p>
1617
1784
  * <p>Valid values: <code>license-included</code>, <code>bring-your-own-license</code>,
1618
1785
  * <code>general-public-license</code>
@@ -1620,29 +1787,35 @@ export interface PendingModifiedValues {
1620
1787
  */
1621
1788
  LicenseModel?: string;
1622
1789
  /**
1790
+ * @public
1623
1791
  * <p>Specifies the new Provisioned IOPS value for the instance that will be applied or
1624
1792
  * is currently being applied.</p>
1625
1793
  */
1626
1794
  Iops?: number;
1627
1795
  /**
1796
+ * @public
1628
1797
  * <p> Contains the new <code>DBInstanceIdentifier</code> for the instance that will be
1629
1798
  * applied or is currently being applied. </p>
1630
1799
  */
1631
1800
  DBInstanceIdentifier?: string;
1632
1801
  /**
1802
+ * @public
1633
1803
  * <p>Specifies the storage type to be associated with the instance.</p>
1634
1804
  */
1635
1805
  StorageType?: string;
1636
1806
  /**
1807
+ * @public
1637
1808
  * <p>Specifies the identifier of the certificate authority (CA) certificate for the DB
1638
1809
  * instance.</p>
1639
1810
  */
1640
1811
  CACertificateIdentifier?: string;
1641
1812
  /**
1813
+ * @public
1642
1814
  * <p>The new subnet group for the instance. </p>
1643
1815
  */
1644
1816
  DBSubnetGroupName?: string;
1645
1817
  /**
1818
+ * @public
1646
1819
  * <p>A list of the log types whose configuration is still pending. These log types are in
1647
1820
  * the process of being activated or deactivated.</p>
1648
1821
  */
@@ -1654,21 +1827,25 @@ export interface PendingModifiedValues {
1654
1827
  */
1655
1828
  export interface DBInstanceStatusInfo {
1656
1829
  /**
1830
+ * @public
1657
1831
  * <p>This value is currently "<code>read replication</code>."</p>
1658
1832
  */
1659
1833
  StatusType?: string;
1660
1834
  /**
1835
+ * @public
1661
1836
  * <p>A Boolean value that is <code>true</code> if the instance is operating normally, or
1662
1837
  * <code>false</code> if the instance is in an error state.</p>
1663
1838
  */
1664
1839
  Normal?: boolean;
1665
1840
  /**
1841
+ * @public
1666
1842
  * <p>Status of the instance. For a <code>StatusType</code> of read replica, the values
1667
1843
  * can be <code>replicating</code>, error, <code>stopped</code>, or
1668
1844
  * <code>terminated</code>.</p>
1669
1845
  */
1670
1846
  Status?: string;
1671
1847
  /**
1848
+ * @public
1672
1849
  * <p>Details of the error if there is an error for the instance. If the instance is not in
1673
1850
  * an error state, this value is blank.</p>
1674
1851
  */
@@ -1680,121 +1857,148 @@ export interface DBInstanceStatusInfo {
1680
1857
  */
1681
1858
  export interface DBInstance {
1682
1859
  /**
1860
+ * @public
1683
1861
  * <p>Contains a user-provided database identifier. This identifier is the unique key that
1684
1862
  * identifies an instance.</p>
1685
1863
  */
1686
1864
  DBInstanceIdentifier?: string;
1687
1865
  /**
1866
+ * @public
1688
1867
  * <p>Contains the name of the compute and memory capacity class of the instance.</p>
1689
1868
  */
1690
1869
  DBInstanceClass?: string;
1691
1870
  /**
1871
+ * @public
1692
1872
  * <p>Provides the name of the database engine to be used for this instance.</p>
1693
1873
  */
1694
1874
  Engine?: string;
1695
1875
  /**
1876
+ * @public
1696
1877
  * <p>Specifies the current state of this database.</p>
1697
1878
  */
1698
1879
  DBInstanceStatus?: string;
1699
1880
  /**
1881
+ * @public
1700
1882
  * <p>Specifies the connection endpoint.</p>
1701
1883
  */
1702
1884
  Endpoint?: Endpoint;
1703
1885
  /**
1886
+ * @public
1704
1887
  * <p>Provides the date and time that the instance was created.</p>
1705
1888
  */
1706
1889
  InstanceCreateTime?: Date;
1707
1890
  /**
1891
+ * @public
1708
1892
  * <p> Specifies the daily time range during which automated backups are created if
1709
1893
  * automated backups are enabled, as determined by the <code>BackupRetentionPeriod</code>.
1710
1894
  * </p>
1711
1895
  */
1712
1896
  PreferredBackupWindow?: string;
1713
1897
  /**
1898
+ * @public
1714
1899
  * <p>Specifies the number of days for which automatic snapshots are retained.</p>
1715
1900
  */
1716
1901
  BackupRetentionPeriod?: number;
1717
1902
  /**
1903
+ * @public
1718
1904
  * <p>Provides a list of VPC security group elements that the instance belongs to.</p>
1719
1905
  */
1720
1906
  VpcSecurityGroups?: VpcSecurityGroupMembership[];
1721
1907
  /**
1908
+ * @public
1722
1909
  * <p>Specifies the name of the Availability Zone that the instance is located in.</p>
1723
1910
  */
1724
1911
  AvailabilityZone?: string;
1725
1912
  /**
1913
+ * @public
1726
1914
  * <p>Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.</p>
1727
1915
  */
1728
1916
  DBSubnetGroup?: DBSubnetGroup;
1729
1917
  /**
1918
+ * @public
1730
1919
  * <p>Specifies the weekly time range during which system maintenance can occur, in
1731
1920
  * Universal Coordinated Time (UTC).</p>
1732
1921
  */
1733
1922
  PreferredMaintenanceWindow?: string;
1734
1923
  /**
1924
+ * @public
1735
1925
  * <p>Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.</p>
1736
1926
  */
1737
1927
  PendingModifiedValues?: PendingModifiedValues;
1738
1928
  /**
1929
+ * @public
1739
1930
  * <p>Specifies the latest time to which a database can be restored with point-in-time
1740
1931
  * restore.</p>
1741
1932
  */
1742
1933
  LatestRestorableTime?: Date;
1743
1934
  /**
1935
+ * @public
1744
1936
  * <p>Indicates the database engine version.</p>
1745
1937
  */
1746
1938
  EngineVersion?: string;
1747
1939
  /**
1940
+ * @public
1748
1941
  * <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>
1749
1942
  */
1750
1943
  AutoMinorVersionUpgrade?: boolean;
1751
1944
  /**
1945
+ * @public
1752
1946
  * <p>Not supported. Amazon DocumentDB does not currently support public endpoints. The value
1753
1947
  * of <code>PubliclyAccessible</code> is always <code>false</code>.</p>
1754
1948
  */
1755
1949
  PubliclyAccessible?: boolean;
1756
1950
  /**
1951
+ * @public
1757
1952
  * <p>The status of a read replica. If the instance is not a read replica, this is
1758
1953
  * blank.</p>
1759
1954
  */
1760
1955
  StatusInfos?: DBInstanceStatusInfo[];
1761
1956
  /**
1957
+ * @public
1762
1958
  * <p>Contains the name of the cluster that the instance is a member of if the
1763
1959
  * instance is a member of a cluster.</p>
1764
1960
  */
1765
1961
  DBClusterIdentifier?: string;
1766
1962
  /**
1963
+ * @public
1767
1964
  * <p>Specifies whether or not the instance is encrypted.</p>
1768
1965
  */
1769
1966
  StorageEncrypted?: boolean;
1770
1967
  /**
1968
+ * @public
1771
1969
  * <p> If <code>StorageEncrypted</code> is <code>true</code>, the KMS key identifier for
1772
1970
  * the encrypted instance. </p>
1773
1971
  */
1774
1972
  KmsKeyId?: string;
1775
1973
  /**
1974
+ * @public
1776
1975
  * <p>The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is
1777
1976
  * accessed.</p>
1778
1977
  */
1779
1978
  DbiResourceId?: string;
1780
1979
  /**
1980
+ * @public
1781
1981
  * <p>The identifier of the CA certificate for this DB instance.</p>
1782
1982
  */
1783
1983
  CACertificateIdentifier?: string;
1784
1984
  /**
1985
+ * @public
1785
1986
  * <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>
1786
1987
  */
1787
1988
  CopyTagsToSnapshot?: boolean;
1788
1989
  /**
1990
+ * @public
1789
1991
  * <p>A value that specifies the order in which an Amazon DocumentDB replica is promoted to the
1790
1992
  * primary instance after a failure of the existing primary instance.</p>
1791
1993
  */
1792
1994
  PromotionTier?: number;
1793
1995
  /**
1996
+ * @public
1794
1997
  * <p>The Amazon Resource Name (ARN) for the instance.</p>
1795
1998
  */
1796
1999
  DBInstanceArn?: string;
1797
2000
  /**
2001
+ * @public
1798
2002
  * <p>A list of log types that this instance is configured to export to CloudWatch Logs.</p>
1799
2003
  */
1800
2004
  EnabledCloudwatchLogsExports?: string[];
@@ -1804,6 +2008,7 @@ export interface DBInstance {
1804
2008
  */
1805
2009
  export interface CreateDBInstanceResult {
1806
2010
  /**
2011
+ * @public
1807
2012
  * <p>Detailed information about an instance. </p>
1808
2013
  */
1809
2014
  DBInstance?: DBInstance;
@@ -1876,6 +2081,7 @@ export declare class StorageTypeNotSupportedFault extends __BaseException {
1876
2081
  */
1877
2082
  export interface CreateDBSubnetGroupMessage {
1878
2083
  /**
2084
+ * @public
1879
2085
  * <p>The name for the subnet group. This value is stored as a lowercase string.</p>
1880
2086
  * <p>Constraints: Must contain no more than 255 letters, numbers, periods, underscores,
1881
2087
  * spaces, or hyphens. Must not be default.</p>
@@ -1884,14 +2090,17 @@ export interface CreateDBSubnetGroupMessage {
1884
2090
  */
1885
2091
  DBSubnetGroupName: string | undefined;
1886
2092
  /**
2093
+ * @public
1887
2094
  * <p>The description for the subnet group.</p>
1888
2095
  */
1889
2096
  DBSubnetGroupDescription: string | undefined;
1890
2097
  /**
2098
+ * @public
1891
2099
  * <p>The Amazon EC2 subnet IDs for the subnet group.</p>
1892
2100
  */
1893
2101
  SubnetIds: string[] | undefined;
1894
2102
  /**
2103
+ * @public
1895
2104
  * <p>The tags to be assigned to the subnet group.</p>
1896
2105
  */
1897
2106
  Tags?: Tag[];
@@ -1901,6 +2110,7 @@ export interface CreateDBSubnetGroupMessage {
1901
2110
  */
1902
2111
  export interface CreateDBSubnetGroupResult {
1903
2112
  /**
2113
+ * @public
1904
2114
  * <p>Detailed information about a subnet group. </p>
1905
2115
  */
1906
2116
  DBSubnetGroup?: DBSubnetGroup;
@@ -1948,15 +2158,18 @@ export declare class DBSubnetQuotaExceededFault extends __BaseException {
1948
2158
  */
1949
2159
  export interface CreateEventSubscriptionMessage {
1950
2160
  /**
2161
+ * @public
1951
2162
  * <p>The name of the subscription.</p>
1952
2163
  * <p>Constraints: The name must be fewer than 255 characters.</p>
1953
2164
  */
1954
2165
  SubscriptionName: string | undefined;
1955
2166
  /**
2167
+ * @public
1956
2168
  * <p>The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.</p>
1957
2169
  */
1958
2170
  SnsTopicArn: string | undefined;
1959
2171
  /**
2172
+ * @public
1960
2173
  * <p>The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to <code>db-instance</code>. If this value is not specified, all events are returned.</p>
1961
2174
  * <p>Valid values: <code>db-instance</code>, <code>db-cluster</code>,
1962
2175
  * <code>db-parameter-group</code>, <code>db-security-group</code>,
@@ -1965,10 +2178,12 @@ export interface CreateEventSubscriptionMessage {
1965
2178
  */
1966
2179
  SourceType?: string;
1967
2180
  /**
2181
+ * @public
1968
2182
  * <p> A list of event categories for a <code>SourceType</code> that you want to subscribe to. </p>
1969
2183
  */
1970
2184
  EventCategories?: string[];
1971
2185
  /**
2186
+ * @public
1972
2187
  * <p>The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a
1973
2188
  * hyphen or contain two consecutive hyphens.</p>
1974
2189
  * <p>Constraints:</p>
@@ -1997,10 +2212,12 @@ export interface CreateEventSubscriptionMessage {
1997
2212
  */
1998
2213
  SourceIds?: string[];
1999
2214
  /**
2215
+ * @public
2000
2216
  * <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>
2001
2217
  */
2002
2218
  Enabled?: boolean;
2003
2219
  /**
2220
+ * @public
2004
2221
  * <p>The tags to be assigned to the event subscription.</p>
2005
2222
  */
2006
2223
  Tags?: Tag[];
@@ -2010,6 +2227,7 @@ export interface CreateEventSubscriptionMessage {
2010
2227
  */
2011
2228
  export interface CreateEventSubscriptionResult {
2012
2229
  /**
2230
+ * @public
2013
2231
  * <p>Detailed information about an event to which you have subscribed.</p>
2014
2232
  */
2015
2233
  EventSubscription?: EventSubscription;
@@ -2092,30 +2310,37 @@ export declare class SubscriptionCategoryNotFoundFault extends __BaseException {
2092
2310
  */
2093
2311
  export interface CreateGlobalClusterMessage {
2094
2312
  /**
2313
+ * @public
2095
2314
  * <p>The cluster identifier of the new global cluster.</p>
2096
2315
  */
2097
2316
  GlobalClusterIdentifier: string | undefined;
2098
2317
  /**
2318
+ * @public
2099
2319
  * <p>The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. This parameter is optional.</p>
2100
2320
  */
2101
2321
  SourceDBClusterIdentifier?: string;
2102
2322
  /**
2323
+ * @public
2103
2324
  * <p>The name of the database engine to be used for this cluster.</p>
2104
2325
  */
2105
2326
  Engine?: string;
2106
2327
  /**
2328
+ * @public
2107
2329
  * <p>The engine version of the global cluster.</p>
2108
2330
  */
2109
2331
  EngineVersion?: string;
2110
2332
  /**
2333
+ * @public
2111
2334
  * <p>The deletion protection setting for the new global cluster. The global cluster can't be deleted when deletion protection is enabled. </p>
2112
2335
  */
2113
2336
  DeletionProtection?: boolean;
2114
2337
  /**
2338
+ * @public
2115
2339
  * <p>The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon DocumentDB will not create a database in the global cluster you are creating.</p>
2116
2340
  */
2117
2341
  DatabaseName?: string;
2118
2342
  /**
2343
+ * @public
2119
2344
  * <p>The storage encryption setting for the new global cluster. </p>
2120
2345
  */
2121
2346
  StorageEncrypted?: boolean;
@@ -2126,14 +2351,17 @@ export interface CreateGlobalClusterMessage {
2126
2351
  */
2127
2352
  export interface GlobalClusterMember {
2128
2353
  /**
2354
+ * @public
2129
2355
  * <p>The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.</p>
2130
2356
  */
2131
2357
  DBClusterArn?: string;
2132
2358
  /**
2359
+ * @public
2133
2360
  * <p>The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.</p>
2134
2361
  */
2135
2362
  Readers?: string[];
2136
2363
  /**
2364
+ * @public
2137
2365
  * <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>
2138
2366
  */
2139
2367
  IsWriter?: boolean;
@@ -2144,42 +2372,52 @@ export interface GlobalClusterMember {
2144
2372
  */
2145
2373
  export interface GlobalCluster {
2146
2374
  /**
2375
+ * @public
2147
2376
  * <p>Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster. </p>
2148
2377
  */
2149
2378
  GlobalClusterIdentifier?: string;
2150
2379
  /**
2380
+ * @public
2151
2381
  * <p>The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed. </p>
2152
2382
  */
2153
2383
  GlobalClusterResourceId?: string;
2154
2384
  /**
2385
+ * @public
2155
2386
  * <p>The Amazon Resource Name (ARN) for the global cluster.</p>
2156
2387
  */
2157
2388
  GlobalClusterArn?: string;
2158
2389
  /**
2390
+ * @public
2159
2391
  * <p>Specifies the current state of this global cluster.</p>
2160
2392
  */
2161
2393
  Status?: string;
2162
2394
  /**
2395
+ * @public
2163
2396
  * <p>The Amazon DocumentDB database engine used by the global cluster. </p>
2164
2397
  */
2165
2398
  Engine?: string;
2166
2399
  /**
2400
+ * @public
2167
2401
  * <p>Indicates the database engine version.</p>
2168
2402
  */
2169
2403
  EngineVersion?: string;
2170
2404
  /**
2405
+ * @public
2171
2406
  * <p>The default database name within the new global cluster.</p>
2172
2407
  */
2173
2408
  DatabaseName?: string;
2174
2409
  /**
2410
+ * @public
2175
2411
  * <p>The storage encryption setting for the global cluster.</p>
2176
2412
  */
2177
2413
  StorageEncrypted?: boolean;
2178
2414
  /**
2415
+ * @public
2179
2416
  * <p>The deletion protection setting for the new global cluster.</p>
2180
2417
  */
2181
2418
  DeletionProtection?: boolean;
2182
2419
  /**
2420
+ * @public
2183
2421
  * <p>The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item. </p>
2184
2422
  */
2185
2423
  GlobalClusterMembers?: GlobalClusterMember[];
@@ -2189,6 +2427,7 @@ export interface GlobalCluster {
2189
2427
  */
2190
2428
  export interface CreateGlobalClusterResult {
2191
2429
  /**
2430
+ * @public
2192
2431
  * <p>A data type representing an Amazon DocumentDB global cluster.</p>
2193
2432
  */
2194
2433
  GlobalCluster?: GlobalCluster;
@@ -2223,6 +2462,7 @@ export declare class GlobalClusterQuotaExceededFault extends __BaseException {
2223
2462
  */
2224
2463
  export interface DeleteDBClusterMessage {
2225
2464
  /**
2465
+ * @public
2226
2466
  * <p>The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.</p>
2227
2467
  * <p>Constraints:</p>
2228
2468
  * <ul>
@@ -2233,6 +2473,7 @@ export interface DeleteDBClusterMessage {
2233
2473
  */
2234
2474
  DBClusterIdentifier: string | undefined;
2235
2475
  /**
2476
+ * @public
2236
2477
  * <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>
2237
2478
  * <note>
2238
2479
  * <p>If <code>SkipFinalSnapshot</code> is <code>false</code>, you must specify a <code>FinalDBSnapshotIdentifier</code> parameter.</p>
@@ -2242,6 +2483,7 @@ export interface DeleteDBClusterMessage {
2242
2483
  */
2243
2484
  SkipFinalSnapshot?: boolean;
2244
2485
  /**
2486
+ * @public
2245
2487
  * <p> The cluster snapshot identifier of the new cluster snapshot created when <code>SkipFinalSnapshot</code> is set to <code>false</code>. </p>
2246
2488
  * <note>
2247
2489
  * <p> Specifying this parameter and also setting the <code>SkipFinalShapshot</code> parameter to <code>true</code> results in an error. </p>
@@ -2266,6 +2508,7 @@ export interface DeleteDBClusterMessage {
2266
2508
  */
2267
2509
  export interface DeleteDBClusterResult {
2268
2510
  /**
2511
+ * @public
2269
2512
  * <p>Detailed information about a cluster. </p>
2270
2513
  */
2271
2514
  DBCluster?: DBCluster;
@@ -2276,6 +2519,7 @@ export interface DeleteDBClusterResult {
2276
2519
  */
2277
2520
  export interface DeleteDBClusterParameterGroupMessage {
2278
2521
  /**
2522
+ * @public
2279
2523
  * <p>The name of the cluster parameter group.</p>
2280
2524
  * <p>Constraints:</p>
2281
2525
  * <ul>
@@ -2310,6 +2554,7 @@ export declare class InvalidDBParameterGroupStateFault extends __BaseException {
2310
2554
  */
2311
2555
  export interface DeleteDBClusterSnapshotMessage {
2312
2556
  /**
2557
+ * @public
2313
2558
  * <p>The identifier of the cluster snapshot to delete.</p>
2314
2559
  * <p>Constraints: Must be the name of an existing cluster snapshot in the <code>available</code> state.</p>
2315
2560
  */
@@ -2320,6 +2565,7 @@ export interface DeleteDBClusterSnapshotMessage {
2320
2565
  */
2321
2566
  export interface DeleteDBClusterSnapshotResult {
2322
2567
  /**
2568
+ * @public
2323
2569
  * <p>Detailed information about a cluster snapshot. </p>
2324
2570
  */
2325
2571
  DBClusterSnapshot?: DBClusterSnapshot;
@@ -2343,6 +2589,7 @@ export declare class DBSnapshotAlreadyExistsFault extends __BaseException {
2343
2589
  */
2344
2590
  export interface DeleteDBInstanceMessage {
2345
2591
  /**
2592
+ * @public
2346
2593
  * <p>The instance identifier for the instance to be deleted. This parameter isn't
2347
2594
  * case sensitive.</p>
2348
2595
  * <p>Constraints:</p>
@@ -2359,6 +2606,7 @@ export interface DeleteDBInstanceMessage {
2359
2606
  */
2360
2607
  export interface DeleteDBInstanceResult {
2361
2608
  /**
2609
+ * @public
2362
2610
  * <p>Detailed information about an instance. </p>
2363
2611
  */
2364
2612
  DBInstance?: DBInstance;
@@ -2369,6 +2617,7 @@ export interface DeleteDBInstanceResult {
2369
2617
  */
2370
2618
  export interface DeleteDBSubnetGroupMessage {
2371
2619
  /**
2620
+ * @public
2372
2621
  * <p>The name of the database subnet group to delete.</p>
2373
2622
  * <note>
2374
2623
  * <p>You can't delete the default subnet group.</p>
@@ -2398,6 +2647,7 @@ export declare class InvalidDBSubnetStateFault extends __BaseException {
2398
2647
  */
2399
2648
  export interface DeleteEventSubscriptionMessage {
2400
2649
  /**
2650
+ * @public
2401
2651
  * <p>The name of the Amazon DocumentDB event notification subscription that you want to delete.</p>
2402
2652
  */
2403
2653
  SubscriptionName: string | undefined;
@@ -2407,6 +2657,7 @@ export interface DeleteEventSubscriptionMessage {
2407
2657
  */
2408
2658
  export interface DeleteEventSubscriptionResult {
2409
2659
  /**
2660
+ * @public
2410
2661
  * <p>Detailed information about an event to which you have subscribed.</p>
2411
2662
  */
2412
2663
  EventSubscription?: EventSubscription;
@@ -2430,6 +2681,7 @@ export declare class InvalidEventSubscriptionStateFault extends __BaseException
2430
2681
  */
2431
2682
  export interface DeleteGlobalClusterMessage {
2432
2683
  /**
2684
+ * @public
2433
2685
  * <p>The cluster identifier of the global cluster being deleted.</p>
2434
2686
  */
2435
2687
  GlobalClusterIdentifier: string | undefined;
@@ -2439,6 +2691,7 @@ export interface DeleteGlobalClusterMessage {
2439
2691
  */
2440
2692
  export interface DeleteGlobalClusterResult {
2441
2693
  /**
2694
+ * @public
2442
2695
  * <p>A data type representing an Amazon DocumentDB global cluster.</p>
2443
2696
  */
2444
2697
  GlobalCluster?: GlobalCluster;
@@ -2449,34 +2702,40 @@ export interface DeleteGlobalClusterResult {
2449
2702
  */
2450
2703
  export interface Certificate {
2451
2704
  /**
2705
+ * @public
2452
2706
  * <p>The unique key that identifies a certificate.</p>
2453
2707
  * <p>Example: <code>rds-ca-2019</code>
2454
2708
  * </p>
2455
2709
  */
2456
2710
  CertificateIdentifier?: string;
2457
2711
  /**
2712
+ * @public
2458
2713
  * <p>The type of the certificate.</p>
2459
2714
  * <p>Example: <code>CA</code>
2460
2715
  * </p>
2461
2716
  */
2462
2717
  CertificateType?: string;
2463
2718
  /**
2719
+ * @public
2464
2720
  * <p>The thumbprint of the certificate.</p>
2465
2721
  */
2466
2722
  Thumbprint?: string;
2467
2723
  /**
2724
+ * @public
2468
2725
  * <p>The starting date-time from which the certificate is valid.</p>
2469
2726
  * <p>Example: <code>2019-07-31T17:57:09Z</code>
2470
2727
  * </p>
2471
2728
  */
2472
2729
  ValidFrom?: Date;
2473
2730
  /**
2731
+ * @public
2474
2732
  * <p>The date-time after which the certificate is no longer valid.</p>
2475
2733
  * <p>Example: <code>2024-07-31T17:57:09Z</code>
2476
2734
  * </p>
2477
2735
  */
2478
2736
  ValidTill?: Date;
2479
2737
  /**
2738
+ * @public
2480
2739
  * <p>The Amazon Resource Name (ARN) for the certificate.</p>
2481
2740
  * <p>Example: <code>arn:aws:rds:us-east-1::cert:rds-ca-2019</code>
2482
2741
  * </p>
@@ -2488,10 +2747,12 @@ export interface Certificate {
2488
2747
  */
2489
2748
  export interface CertificateMessage {
2490
2749
  /**
2750
+ * @public
2491
2751
  * <p>A list of certificates for this Amazon Web Services account.</p>
2492
2752
  */
2493
2753
  Certificates?: Certificate[];
2494
2754
  /**
2755
+ * @public
2495
2756
  * <p>An optional pagination token provided if the number of records retrieved is greater than <code>MaxRecords</code>. If this parameter is specified, the marker specifies the next record in the list. Including the value of <code>Marker</code> in the next call to <code>DescribeCertificates</code> results in the next page of certificates.</p>
2496
2757
  */
2497
2758
  Marker?: string;
@@ -2517,10 +2778,12 @@ export declare class CertificateNotFoundFault extends __BaseException {
2517
2778
  */
2518
2779
  export interface Filter {
2519
2780
  /**
2781
+ * @public
2520
2782
  * <p>The name of the filter. Filter names are case sensitive.</p>
2521
2783
  */
2522
2784
  Name: string | undefined;
2523
2785
  /**
2786
+ * @public
2524
2787
  * <p>One or more filter values. Filter values are case sensitive.</p>
2525
2788
  */
2526
2789
  Values: string[] | undefined;
@@ -2530,6 +2793,7 @@ export interface Filter {
2530
2793
  */
2531
2794
  export interface DescribeCertificatesMessage {
2532
2795
  /**
2796
+ * @public
2533
2797
  * <p>The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to <code>MaxRecords</code> certificates is returned. This parameter is not case sensitive.</p>
2534
2798
  * <p>Constraints</p>
2535
2799
  * <ul>
@@ -2540,10 +2804,12 @@ export interface DescribeCertificatesMessage {
2540
2804
  */
2541
2805
  CertificateIdentifier?: string;
2542
2806
  /**
2807
+ * @public
2543
2808
  * <p>This parameter is not currently supported.</p>
2544
2809
  */
2545
2810
  Filters?: Filter[];
2546
2811
  /**
2812
+ * @public
2547
2813
  * <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>
2548
2814
  * <p>Default: 100</p>
2549
2815
  * <p>Constraints:</p>
@@ -2558,6 +2824,7 @@ export interface DescribeCertificatesMessage {
2558
2824
  */
2559
2825
  MaxRecords?: number;
2560
2826
  /**
2827
+ * @public
2561
2828
  * <p>An optional pagination token provided by a previous <code>DescribeCertificates</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
2562
2829
  */
2563
2830
  Marker?: string;
@@ -2568,12 +2835,14 @@ export interface DescribeCertificatesMessage {
2568
2835
  */
2569
2836
  export interface DBClusterParameterGroupsMessage {
2570
2837
  /**
2838
+ * @public
2571
2839
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
2572
2840
  * includes only records beyond the marker, up to the value specified by
2573
2841
  * <code>MaxRecords</code>.</p>
2574
2842
  */
2575
2843
  Marker?: string;
2576
2844
  /**
2845
+ * @public
2577
2846
  * <p>A list of cluster parameter groups.</p>
2578
2847
  */
2579
2848
  DBClusterParameterGroups?: DBClusterParameterGroup[];
@@ -2584,6 +2853,7 @@ export interface DBClusterParameterGroupsMessage {
2584
2853
  */
2585
2854
  export interface DescribeDBClusterParameterGroupsMessage {
2586
2855
  /**
2856
+ * @public
2587
2857
  * <p>The name of a specific cluster parameter group to return details for.</p>
2588
2858
  * <p>Constraints:</p>
2589
2859
  * <ul>
@@ -2595,10 +2865,12 @@ export interface DescribeDBClusterParameterGroupsMessage {
2595
2865
  */
2596
2866
  DBClusterParameterGroupName?: string;
2597
2867
  /**
2868
+ * @public
2598
2869
  * <p>This parameter is not currently supported.</p>
2599
2870
  */
2600
2871
  Filters?: Filter[];
2601
2872
  /**
2873
+ * @public
2602
2874
  * <p> The maximum number of records to include in the response. If more records exist than
2603
2875
  * the specified <code>MaxRecords</code> value, a pagination token (marker) is included
2604
2876
  * in the response so that the remaining results can be retrieved.</p>
@@ -2607,6 +2879,7 @@ export interface DescribeDBClusterParameterGroupsMessage {
2607
2879
  */
2608
2880
  MaxRecords?: number;
2609
2881
  /**
2882
+ * @public
2610
2883
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
2611
2884
  * includes only records beyond the marker, up to the value specified by
2612
2885
  * <code>MaxRecords</code>.</p>
@@ -2631,44 +2904,54 @@ export type ApplyMethod = (typeof ApplyMethod)[keyof typeof ApplyMethod];
2631
2904
  */
2632
2905
  export interface Parameter {
2633
2906
  /**
2907
+ * @public
2634
2908
  * <p>Specifies the name of the parameter.</p>
2635
2909
  */
2636
2910
  ParameterName?: string;
2637
2911
  /**
2912
+ * @public
2638
2913
  * <p>Specifies the value of the parameter.</p>
2639
2914
  */
2640
2915
  ParameterValue?: string;
2641
2916
  /**
2917
+ * @public
2642
2918
  * <p>Provides a description of the parameter.</p>
2643
2919
  */
2644
2920
  Description?: string;
2645
2921
  /**
2922
+ * @public
2646
2923
  * <p>Indicates the source of the parameter value.</p>
2647
2924
  */
2648
2925
  Source?: string;
2649
2926
  /**
2927
+ * @public
2650
2928
  * <p>Specifies the engine-specific parameters type.</p>
2651
2929
  */
2652
2930
  ApplyType?: string;
2653
2931
  /**
2932
+ * @public
2654
2933
  * <p>Specifies the valid data type for the parameter.</p>
2655
2934
  */
2656
2935
  DataType?: string;
2657
2936
  /**
2937
+ * @public
2658
2938
  * <p>Specifies the valid range of values for the parameter.</p>
2659
2939
  */
2660
2940
  AllowedValues?: string;
2661
2941
  /**
2942
+ * @public
2662
2943
  * <p> Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can
2663
2944
  * be modified. Some parameters have security or operational implications that prevent them
2664
2945
  * from being changed. </p>
2665
2946
  */
2666
2947
  IsModifiable?: boolean;
2667
2948
  /**
2949
+ * @public
2668
2950
  * <p>The earliest engine version to which the parameter can apply.</p>
2669
2951
  */
2670
2952
  MinimumEngineVersion?: string;
2671
2953
  /**
2954
+ * @public
2672
2955
  * <p>Indicates when to apply parameter updates.</p>
2673
2956
  */
2674
2957
  ApplyMethod?: ApplyMethod | string;
@@ -2679,10 +2962,12 @@ export interface Parameter {
2679
2962
  */
2680
2963
  export interface DBClusterParameterGroupDetails {
2681
2964
  /**
2965
+ * @public
2682
2966
  * <p>Provides a list of parameters for the cluster parameter group.</p>
2683
2967
  */
2684
2968
  Parameters?: Parameter[];
2685
2969
  /**
2970
+ * @public
2686
2971
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
2687
2972
  * includes only records beyond the marker, up to the value specified by
2688
2973
  * <code>MaxRecords</code>.</p>
@@ -2695,6 +2980,7 @@ export interface DBClusterParameterGroupDetails {
2695
2980
  */
2696
2981
  export interface DescribeDBClusterParametersMessage {
2697
2982
  /**
2983
+ * @public
2698
2984
  * <p>The name of a specific cluster parameter group to return parameter details for.</p>
2699
2985
  * <p>Constraints:</p>
2700
2986
  * <ul>
@@ -2705,15 +2991,18 @@ export interface DescribeDBClusterParametersMessage {
2705
2991
  */
2706
2992
  DBClusterParameterGroupName: string | undefined;
2707
2993
  /**
2994
+ * @public
2708
2995
  * <p> A value that indicates to return only parameters for a specific source. Parameter sources can be <code>engine</code>, <code>service</code>, or <code>customer</code>.
2709
2996
  * </p>
2710
2997
  */
2711
2998
  Source?: string;
2712
2999
  /**
3000
+ * @public
2713
3001
  * <p>This parameter is not currently supported.</p>
2714
3002
  */
2715
3003
  Filters?: Filter[];
2716
3004
  /**
3005
+ * @public
2717
3006
  * <p> The maximum number of records to include in the response. If more records exist than
2718
3007
  * the specified <code>MaxRecords</code> value, a pagination token (marker) is included
2719
3008
  * in the response so that the remaining results can be retrieved.</p>
@@ -2722,6 +3011,7 @@ export interface DescribeDBClusterParametersMessage {
2722
3011
  */
2723
3012
  MaxRecords?: number;
2724
3013
  /**
3014
+ * @public
2725
3015
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
2726
3016
  * includes only records beyond the marker, up to the value specified by
2727
3017
  * <code>MaxRecords</code>.</p>
@@ -2734,12 +3024,14 @@ export interface DescribeDBClusterParametersMessage {
2734
3024
  */
2735
3025
  export interface DBClusterMessage {
2736
3026
  /**
3027
+ * @public
2737
3028
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
2738
3029
  * includes only records beyond the marker, up to the value specified by
2739
3030
  * <code>MaxRecords</code>.</p>
2740
3031
  */
2741
3032
  Marker?: string;
2742
3033
  /**
3034
+ * @public
2743
3035
  * <p>A list of clusters.</p>
2744
3036
  */
2745
3037
  DBClusters?: DBCluster[];
@@ -2750,6 +3042,7 @@ export interface DBClusterMessage {
2750
3042
  */
2751
3043
  export interface DescribeDBClustersMessage {
2752
3044
  /**
3045
+ * @public
2753
3046
  * <p>The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.</p>
2754
3047
  * <p>Constraints:</p>
2755
3048
  * <ul>
@@ -2760,6 +3053,7 @@ export interface DescribeDBClustersMessage {
2760
3053
  */
2761
3054
  DBClusterIdentifier?: string;
2762
3055
  /**
3056
+ * @public
2763
3057
  * <p>A filter that specifies one or more clusters to describe.</p>
2764
3058
  * <p>Supported filters:</p>
2765
3059
  * <ul>
@@ -2771,6 +3065,7 @@ export interface DescribeDBClustersMessage {
2771
3065
  */
2772
3066
  Filters?: Filter[];
2773
3067
  /**
3068
+ * @public
2774
3069
  * <p> The maximum number of records to include in the response. If more records exist than
2775
3070
  * the specified <code>MaxRecords</code> value, a pagination token (marker) is included
2776
3071
  * in the response so that the remaining results can be retrieved.</p>
@@ -2779,6 +3074,7 @@ export interface DescribeDBClustersMessage {
2779
3074
  */
2780
3075
  MaxRecords?: number;
2781
3076
  /**
3077
+ * @public
2782
3078
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
2783
3079
  * includes only records beyond the marker, up to the value specified by
2784
3080
  * <code>MaxRecords</code>.</p>
@@ -2791,6 +3087,7 @@ export interface DescribeDBClustersMessage {
2791
3087
  */
2792
3088
  export interface DescribeDBClusterSnapshotAttributesMessage {
2793
3089
  /**
3090
+ * @public
2794
3091
  * <p>The identifier for the cluster snapshot to describe the attributes for.</p>
2795
3092
  */
2796
3093
  DBClusterSnapshotIdentifier: string | undefined;
@@ -2802,11 +3099,13 @@ export interface DescribeDBClusterSnapshotAttributesMessage {
2802
3099
  */
2803
3100
  export interface DBClusterSnapshotAttribute {
2804
3101
  /**
3102
+ * @public
2805
3103
  * <p>The name of the manual cluster snapshot attribute.</p>
2806
3104
  * <p>The attribute named <code>restore</code> refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual cluster snapshot.</p>
2807
3105
  */
2808
3106
  AttributeName?: string;
2809
3107
  /**
3108
+ * @public
2810
3109
  * <p>The values for the manual cluster snapshot attribute.</p>
2811
3110
  * <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>
2812
3111
  */
@@ -2819,10 +3118,12 @@ export interface DBClusterSnapshotAttribute {
2819
3118
  */
2820
3119
  export interface DBClusterSnapshotAttributesResult {
2821
3120
  /**
3121
+ * @public
2822
3122
  * <p>The identifier of the cluster snapshot that the attributes apply to.</p>
2823
3123
  */
2824
3124
  DBClusterSnapshotIdentifier?: string;
2825
3125
  /**
3126
+ * @public
2826
3127
  * <p>The list of attributes and values for the cluster snapshot.</p>
2827
3128
  */
2828
3129
  DBClusterSnapshotAttributes?: DBClusterSnapshotAttribute[];
@@ -2832,6 +3133,7 @@ export interface DBClusterSnapshotAttributesResult {
2832
3133
  */
2833
3134
  export interface DescribeDBClusterSnapshotAttributesResult {
2834
3135
  /**
3136
+ * @public
2835
3137
  * <p>Detailed information about the attributes that are associated with a cluster
2836
3138
  * snapshot.</p>
2837
3139
  */
@@ -2843,12 +3145,14 @@ export interface DescribeDBClusterSnapshotAttributesResult {
2843
3145
  */
2844
3146
  export interface DBClusterSnapshotMessage {
2845
3147
  /**
3148
+ * @public
2846
3149
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
2847
3150
  * includes only records beyond the marker, up to the value specified by
2848
3151
  * <code>MaxRecords</code>.</p>
2849
3152
  */
2850
3153
  Marker?: string;
2851
3154
  /**
3155
+ * @public
2852
3156
  * <p>Provides a list of cluster snapshots.</p>
2853
3157
  */
2854
3158
  DBClusterSnapshots?: DBClusterSnapshot[];
@@ -2859,6 +3163,7 @@ export interface DBClusterSnapshotMessage {
2859
3163
  */
2860
3164
  export interface DescribeDBClusterSnapshotsMessage {
2861
3165
  /**
3166
+ * @public
2862
3167
  * <p>The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the <code>DBClusterSnapshotIdentifier</code> parameter. This parameter is not case sensitive. </p>
2863
3168
  * <p>Constraints:</p>
2864
3169
  * <ul>
@@ -2870,6 +3175,7 @@ export interface DescribeDBClusterSnapshotsMessage {
2870
3175
  */
2871
3176
  DBClusterIdentifier?: string;
2872
3177
  /**
3178
+ * @public
2873
3179
  * <p>A specific cluster snapshot identifier to describe. This parameter can't be used with the <code>DBClusterIdentifier</code> parameter. This value is stored as a lowercase string. </p>
2874
3180
  * <p>Constraints:</p>
2875
3181
  * <ul>
@@ -2885,6 +3191,7 @@ export interface DescribeDBClusterSnapshotsMessage {
2885
3191
  */
2886
3192
  DBClusterSnapshotIdentifier?: string;
2887
3193
  /**
3194
+ * @public
2888
3195
  * <p>The type of cluster snapshots to be returned. You can specify one of the following values:</p>
2889
3196
  * <ul>
2890
3197
  * <li>
@@ -2909,10 +3216,12 @@ export interface DescribeDBClusterSnapshotsMessage {
2909
3216
  */
2910
3217
  SnapshotType?: string;
2911
3218
  /**
3219
+ * @public
2912
3220
  * <p>This parameter is not currently supported.</p>
2913
3221
  */
2914
3222
  Filters?: Filter[];
2915
3223
  /**
3224
+ * @public
2916
3225
  * <p> The maximum number of records to include in the response. If more records exist than
2917
3226
  * the specified <code>MaxRecords</code> value, a pagination token (marker) is included
2918
3227
  * in the response so that the remaining results can be retrieved.</p>
@@ -2921,16 +3230,19 @@ export interface DescribeDBClusterSnapshotsMessage {
2921
3230
  */
2922
3231
  MaxRecords?: number;
2923
3232
  /**
3233
+ * @public
2924
3234
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
2925
3235
  * includes only records beyond the marker, up to the value specified by
2926
3236
  * <code>MaxRecords</code>.</p>
2927
3237
  */
2928
3238
  Marker?: string;
2929
3239
  /**
3240
+ * @public
2930
3241
  * <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>
2931
3242
  */
2932
3243
  IncludeShared?: boolean;
2933
3244
  /**
3245
+ * @public
2934
3246
  * <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>
2935
3247
  */
2936
3248
  IncludePublic?: boolean;
@@ -2941,22 +3253,27 @@ export interface DescribeDBClusterSnapshotsMessage {
2941
3253
  */
2942
3254
  export interface UpgradeTarget {
2943
3255
  /**
3256
+ * @public
2944
3257
  * <p>The name of the upgrade target database engine.</p>
2945
3258
  */
2946
3259
  Engine?: string;
2947
3260
  /**
3261
+ * @public
2948
3262
  * <p>The version number of the upgrade target database engine.</p>
2949
3263
  */
2950
3264
  EngineVersion?: string;
2951
3265
  /**
3266
+ * @public
2952
3267
  * <p>The version of the database engine that an instance can be upgraded to.</p>
2953
3268
  */
2954
3269
  Description?: string;
2955
3270
  /**
3271
+ * @public
2956
3272
  * <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>
2957
3273
  */
2958
3274
  AutoUpgrade?: boolean;
2959
3275
  /**
3276
+ * @public
2960
3277
  * <p>A value that indicates whether a database engine is upgraded to a major
2961
3278
  * version.</p>
2962
3279
  */
@@ -2968,35 +3285,43 @@ export interface UpgradeTarget {
2968
3285
  */
2969
3286
  export interface DBEngineVersion {
2970
3287
  /**
3288
+ * @public
2971
3289
  * <p>The name of the database engine.</p>
2972
3290
  */
2973
3291
  Engine?: string;
2974
3292
  /**
3293
+ * @public
2975
3294
  * <p>The version number of the database engine.</p>
2976
3295
  */
2977
3296
  EngineVersion?: string;
2978
3297
  /**
3298
+ * @public
2979
3299
  * <p>The name of the parameter group family for the database engine.</p>
2980
3300
  */
2981
3301
  DBParameterGroupFamily?: string;
2982
3302
  /**
3303
+ * @public
2983
3304
  * <p>The description of the database engine.</p>
2984
3305
  */
2985
3306
  DBEngineDescription?: string;
2986
3307
  /**
3308
+ * @public
2987
3309
  * <p>The description of the database engine version.</p>
2988
3310
  */
2989
3311
  DBEngineVersionDescription?: string;
2990
3312
  /**
3313
+ * @public
2991
3314
  * <p>A list of engine versions that this database engine version can be upgraded to.</p>
2992
3315
  */
2993
3316
  ValidUpgradeTarget?: UpgradeTarget[];
2994
3317
  /**
3318
+ * @public
2995
3319
  * <p>The types of logs that the database engine has available for export to Amazon
2996
3320
  * CloudWatch Logs.</p>
2997
3321
  */
2998
3322
  ExportableLogTypes?: string[];
2999
3323
  /**
3324
+ * @public
3000
3325
  * <p>A value that indicates whether the engine version supports exporting the log types
3001
3326
  * specified by <code>ExportableLogTypes</code> to CloudWatch Logs.</p>
3002
3327
  */
@@ -3008,12 +3333,14 @@ export interface DBEngineVersion {
3008
3333
  */
3009
3334
  export interface DBEngineVersionMessage {
3010
3335
  /**
3336
+ * @public
3011
3337
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
3012
3338
  * includes only records beyond the marker, up to the value specified by
3013
3339
  * <code>MaxRecords</code>.</p>
3014
3340
  */
3015
3341
  Marker?: string;
3016
3342
  /**
3343
+ * @public
3017
3344
  * <p>Detailed information about one or more engine versions.</p>
3018
3345
  */
3019
3346
  DBEngineVersions?: DBEngineVersion[];
@@ -3024,16 +3351,19 @@ export interface DBEngineVersionMessage {
3024
3351
  */
3025
3352
  export interface DescribeDBEngineVersionsMessage {
3026
3353
  /**
3354
+ * @public
3027
3355
  * <p>The database engine to return.</p>
3028
3356
  */
3029
3357
  Engine?: string;
3030
3358
  /**
3359
+ * @public
3031
3360
  * <p>The database engine version to return.</p>
3032
3361
  * <p>Example: <code>3.6.0</code>
3033
3362
  * </p>
3034
3363
  */
3035
3364
  EngineVersion?: string;
3036
3365
  /**
3366
+ * @public
3037
3367
  * <p>The name of a specific parameter group family to return details for.</p>
3038
3368
  * <p>Constraints:</p>
3039
3369
  * <ul>
@@ -3045,10 +3375,12 @@ export interface DescribeDBEngineVersionsMessage {
3045
3375
  */
3046
3376
  DBParameterGroupFamily?: string;
3047
3377
  /**
3378
+ * @public
3048
3379
  * <p>This parameter is not currently supported.</p>
3049
3380
  */
3050
3381
  Filters?: Filter[];
3051
3382
  /**
3383
+ * @public
3052
3384
  * <p> The maximum number of records to include in the response. If more records exist than
3053
3385
  * the specified <code>MaxRecords</code> value, a pagination token (marker) is included
3054
3386
  * in the response so that the remaining results can be retrieved.</p>
@@ -3057,21 +3389,25 @@ export interface DescribeDBEngineVersionsMessage {
3057
3389
  */
3058
3390
  MaxRecords?: number;
3059
3391
  /**
3392
+ * @public
3060
3393
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
3061
3394
  * includes only records beyond the marker, up to the value specified by
3062
3395
  * <code>MaxRecords</code>.</p>
3063
3396
  */
3064
3397
  Marker?: string;
3065
3398
  /**
3399
+ * @public
3066
3400
  * <p>Indicates that only the default version of the specified engine or engine and major
3067
3401
  * version combination is returned.</p>
3068
3402
  */
3069
3403
  DefaultOnly?: boolean;
3070
3404
  /**
3405
+ * @public
3071
3406
  * <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>
3072
3407
  */
3073
3408
  ListSupportedCharacterSets?: boolean;
3074
3409
  /**
3410
+ * @public
3075
3411
  * <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>
3076
3412
  */
3077
3413
  ListSupportedTimezones?: boolean;
@@ -3082,12 +3418,14 @@ export interface DescribeDBEngineVersionsMessage {
3082
3418
  */
3083
3419
  export interface DBInstanceMessage {
3084
3420
  /**
3421
+ * @public
3085
3422
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
3086
3423
  * includes only records beyond the marker, up to the value specified by
3087
3424
  * <code>MaxRecords</code>.</p>
3088
3425
  */
3089
3426
  Marker?: string;
3090
3427
  /**
3428
+ * @public
3091
3429
  * <p>Detailed information about one or more instances. </p>
3092
3430
  */
3093
3431
  DBInstances?: DBInstance[];
@@ -3098,6 +3436,7 @@ export interface DBInstanceMessage {
3098
3436
  */
3099
3437
  export interface DescribeDBInstancesMessage {
3100
3438
  /**
3439
+ * @public
3101
3440
  * <p>The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.</p>
3102
3441
  * <p>Constraints:</p>
3103
3442
  * <ul>
@@ -3109,6 +3448,7 @@ export interface DescribeDBInstancesMessage {
3109
3448
  */
3110
3449
  DBInstanceIdentifier?: string;
3111
3450
  /**
3451
+ * @public
3112
3452
  * <p>A filter that specifies one or more instances to describe.</p>
3113
3453
  * <p>Supported filters:</p>
3114
3454
  * <ul>
@@ -3124,6 +3464,7 @@ export interface DescribeDBInstancesMessage {
3124
3464
  */
3125
3465
  Filters?: Filter[];
3126
3466
  /**
3467
+ * @public
3127
3468
  * <p> The maximum number of records to include in the response. If more records exist than
3128
3469
  * the specified <code>MaxRecords</code> value, a pagination token (marker) is included
3129
3470
  * in the response so that the remaining results can be retrieved.</p>
@@ -3132,6 +3473,7 @@ export interface DescribeDBInstancesMessage {
3132
3473
  */
3133
3474
  MaxRecords?: number;
3134
3475
  /**
3476
+ * @public
3135
3477
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
3136
3478
  * includes only records beyond the marker, up to the value specified by
3137
3479
  * <code>MaxRecords</code>.</p>
@@ -3144,12 +3486,14 @@ export interface DescribeDBInstancesMessage {
3144
3486
  */
3145
3487
  export interface DBSubnetGroupMessage {
3146
3488
  /**
3489
+ * @public
3147
3490
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
3148
3491
  * includes only records beyond the marker, up to the value specified by
3149
3492
  * <code>MaxRecords</code>.</p>
3150
3493
  */
3151
3494
  Marker?: string;
3152
3495
  /**
3496
+ * @public
3153
3497
  * <p>Detailed information about one or more subnet groups.</p>
3154
3498
  */
3155
3499
  DBSubnetGroups?: DBSubnetGroup[];
@@ -3160,14 +3504,17 @@ export interface DBSubnetGroupMessage {
3160
3504
  */
3161
3505
  export interface DescribeDBSubnetGroupsMessage {
3162
3506
  /**
3507
+ * @public
3163
3508
  * <p>The name of the subnet group to return details for.</p>
3164
3509
  */
3165
3510
  DBSubnetGroupName?: string;
3166
3511
  /**
3512
+ * @public
3167
3513
  * <p>This parameter is not currently supported.</p>
3168
3514
  */
3169
3515
  Filters?: Filter[];
3170
3516
  /**
3517
+ * @public
3171
3518
  * <p> The maximum number of records to include in the response. If more records exist than
3172
3519
  * the specified <code>MaxRecords</code> value, a pagination token (marker) is included
3173
3520
  * in the response so that the remaining results can be retrieved.</p>
@@ -3176,6 +3523,7 @@ export interface DescribeDBSubnetGroupsMessage {
3176
3523
  */
3177
3524
  MaxRecords?: number;
3178
3525
  /**
3526
+ * @public
3179
3527
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
3180
3528
  * includes only records beyond the marker, up to the value specified by
3181
3529
  * <code>MaxRecords</code>.</p>
@@ -3188,15 +3536,18 @@ export interface DescribeDBSubnetGroupsMessage {
3188
3536
  */
3189
3537
  export interface DescribeEngineDefaultClusterParametersMessage {
3190
3538
  /**
3539
+ * @public
3191
3540
  * <p>The name of the cluster parameter group family to return the engine parameter
3192
3541
  * information for.</p>
3193
3542
  */
3194
3543
  DBParameterGroupFamily: string | undefined;
3195
3544
  /**
3545
+ * @public
3196
3546
  * <p>This parameter is not currently supported.</p>
3197
3547
  */
3198
3548
  Filters?: Filter[];
3199
3549
  /**
3550
+ * @public
3200
3551
  * <p> The maximum number of records to include in the response. If more records exist than
3201
3552
  * the specified <code>MaxRecords</code> value, a pagination token (marker) is included
3202
3553
  * in the response so that the remaining results can be retrieved.</p>
@@ -3205,6 +3556,7 @@ export interface DescribeEngineDefaultClusterParametersMessage {
3205
3556
  */
3206
3557
  MaxRecords?: number;
3207
3558
  /**
3559
+ * @public
3208
3560
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
3209
3561
  * includes only records beyond the marker, up to the value specified by
3210
3562
  * <code>MaxRecords</code>.</p>
@@ -3218,16 +3570,19 @@ export interface DescribeEngineDefaultClusterParametersMessage {
3218
3570
  */
3219
3571
  export interface EngineDefaults {
3220
3572
  /**
3573
+ * @public
3221
3574
  * <p>The name of the cluster parameter group family to return the engine parameter information for.</p>
3222
3575
  */
3223
3576
  DBParameterGroupFamily?: string;
3224
3577
  /**
3578
+ * @public
3225
3579
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
3226
3580
  * includes only records beyond the marker, up to the value specified by
3227
3581
  * <code>MaxRecords</code>.</p>
3228
3582
  */
3229
3583
  Marker?: string;
3230
3584
  /**
3585
+ * @public
3231
3586
  * <p>The parameters of a particular cluster parameter group family.</p>
3232
3587
  */
3233
3588
  Parameters?: Parameter[];
@@ -3237,6 +3592,7 @@ export interface EngineDefaults {
3237
3592
  */
3238
3593
  export interface DescribeEngineDefaultClusterParametersResult {
3239
3594
  /**
3595
+ * @public
3240
3596
  * <p>Contains the result of a successful invocation of the
3241
3597
  * <code>DescribeEngineDefaultClusterParameters</code> operation. </p>
3242
3598
  */
@@ -3248,12 +3604,14 @@ export interface DescribeEngineDefaultClusterParametersResult {
3248
3604
  */
3249
3605
  export interface DescribeEventCategoriesMessage {
3250
3606
  /**
3607
+ * @public
3251
3608
  * <p>The type of source that is generating the events.</p>
3252
3609
  * <p>Valid values: <code>db-instance</code>, <code>db-parameter-group</code>, <code>db-security-group</code>
3253
3610
  * </p>
3254
3611
  */
3255
3612
  SourceType?: string;
3256
3613
  /**
3614
+ * @public
3257
3615
  * <p>This parameter is not currently supported.</p>
3258
3616
  */
3259
3617
  Filters?: Filter[];
@@ -3264,10 +3622,12 @@ export interface DescribeEventCategoriesMessage {
3264
3622
  */
3265
3623
  export interface EventCategoriesMap {
3266
3624
  /**
3625
+ * @public
3267
3626
  * <p>The source type that the returned categories belong to.</p>
3268
3627
  */
3269
3628
  SourceType?: string;
3270
3629
  /**
3630
+ * @public
3271
3631
  * <p>The event categories for the specified source type.</p>
3272
3632
  */
3273
3633
  EventCategories?: string[];
@@ -3278,6 +3638,7 @@ export interface EventCategoriesMap {
3278
3638
  */
3279
3639
  export interface EventCategoriesMessage {
3280
3640
  /**
3641
+ * @public
3281
3642
  * <p>A list of event category maps.</p>
3282
3643
  */
3283
3644
  EventCategoriesMapList?: EventCategoriesMap[];
@@ -3304,6 +3665,7 @@ export type SourceType = (typeof SourceType)[keyof typeof SourceType];
3304
3665
  */
3305
3666
  export interface DescribeEventsMessage {
3306
3667
  /**
3668
+ * @public
3307
3669
  * <p>The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.</p>
3308
3670
  * <p>Constraints:</p>
3309
3671
  * <ul>
@@ -3333,35 +3695,42 @@ export interface DescribeEventsMessage {
3333
3695
  */
3334
3696
  SourceIdentifier?: string;
3335
3697
  /**
3698
+ * @public
3336
3699
  * <p>The event source to retrieve events for. If no value is specified, all events are returned.</p>
3337
3700
  */
3338
3701
  SourceType?: SourceType | string;
3339
3702
  /**
3703
+ * @public
3340
3704
  * <p> The beginning of the time interval to retrieve events for, specified in ISO 8601 format. </p>
3341
3705
  * <p>Example: 2009-07-08T18:00Z</p>
3342
3706
  */
3343
3707
  StartTime?: Date;
3344
3708
  /**
3709
+ * @public
3345
3710
  * <p> The end of the time interval for which to retrieve events, specified in ISO 8601
3346
3711
  * format. </p>
3347
3712
  * <p>Example: 2009-07-08T18:00Z</p>
3348
3713
  */
3349
3714
  EndTime?: Date;
3350
3715
  /**
3716
+ * @public
3351
3717
  * <p>The number of minutes to retrieve events for.</p>
3352
3718
  * <p>Default: 60</p>
3353
3719
  */
3354
3720
  Duration?: number;
3355
3721
  /**
3722
+ * @public
3356
3723
  * <p>A list of event categories that trigger notifications for an event notification
3357
3724
  * subscription.</p>
3358
3725
  */
3359
3726
  EventCategories?: string[];
3360
3727
  /**
3728
+ * @public
3361
3729
  * <p>This parameter is not currently supported.</p>
3362
3730
  */
3363
3731
  Filters?: Filter[];
3364
3732
  /**
3733
+ * @public
3365
3734
  * <p> The maximum number of records to include in the response. If more records exist than
3366
3735
  * the specified <code>MaxRecords</code> value, a pagination token (marker) is included
3367
3736
  * in the response so that the remaining results can be retrieved.</p>
@@ -3370,6 +3739,7 @@ export interface DescribeEventsMessage {
3370
3739
  */
3371
3740
  MaxRecords?: number;
3372
3741
  /**
3742
+ * @public
3373
3743
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
3374
3744
  * includes only records beyond the marker, up to the value specified by
3375
3745
  * <code>MaxRecords</code>.</p>
@@ -3382,26 +3752,32 @@ export interface DescribeEventsMessage {
3382
3752
  */
3383
3753
  export interface Event {
3384
3754
  /**
3755
+ * @public
3385
3756
  * <p>Provides the identifier for the source of the event.</p>
3386
3757
  */
3387
3758
  SourceIdentifier?: string;
3388
3759
  /**
3760
+ * @public
3389
3761
  * <p>Specifies the source type for this event.</p>
3390
3762
  */
3391
3763
  SourceType?: SourceType | string;
3392
3764
  /**
3765
+ * @public
3393
3766
  * <p>Provides the text of this event.</p>
3394
3767
  */
3395
3768
  Message?: string;
3396
3769
  /**
3770
+ * @public
3397
3771
  * <p>Specifies the category for the event.</p>
3398
3772
  */
3399
3773
  EventCategories?: string[];
3400
3774
  /**
3775
+ * @public
3401
3776
  * <p>Specifies the date and time of the event.</p>
3402
3777
  */
3403
3778
  Date?: Date;
3404
3779
  /**
3780
+ * @public
3405
3781
  * <p>The Amazon Resource Name (ARN) for the event.</p>
3406
3782
  */
3407
3783
  SourceArn?: string;
@@ -3412,12 +3788,14 @@ export interface Event {
3412
3788
  */
3413
3789
  export interface EventsMessage {
3414
3790
  /**
3791
+ * @public
3415
3792
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
3416
3793
  * includes only records beyond the marker, up to the value specified by
3417
3794
  * <code>MaxRecords</code>.</p>
3418
3795
  */
3419
3796
  Marker?: string;
3420
3797
  /**
3798
+ * @public
3421
3799
  * <p>Detailed information about one or more events. </p>
3422
3800
  */
3423
3801
  Events?: Event[];
@@ -3428,15 +3806,18 @@ export interface EventsMessage {
3428
3806
  */
3429
3807
  export interface DescribeEventSubscriptionsMessage {
3430
3808
  /**
3809
+ * @public
3431
3810
  * <p>The name of the Amazon DocumentDB event notification subscription that you want to
3432
3811
  * describe.</p>
3433
3812
  */
3434
3813
  SubscriptionName?: string;
3435
3814
  /**
3815
+ * @public
3436
3816
  * <p>This parameter is not currently supported.</p>
3437
3817
  */
3438
3818
  Filters?: Filter[];
3439
3819
  /**
3820
+ * @public
3440
3821
  * <p> The maximum number of records to include in the response. If more records exist than
3441
3822
  * the specified <code>MaxRecords</code> value, a pagination token (marker) is included
3442
3823
  * in the response so that the remaining results can be retrieved.</p>
@@ -3445,6 +3826,7 @@ export interface DescribeEventSubscriptionsMessage {
3445
3826
  */
3446
3827
  MaxRecords?: number;
3447
3828
  /**
3829
+ * @public
3448
3830
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
3449
3831
  * includes only records beyond the marker, up to the value specified by
3450
3832
  * <code>MaxRecords</code>.</p>
@@ -3457,12 +3839,14 @@ export interface DescribeEventSubscriptionsMessage {
3457
3839
  */
3458
3840
  export interface EventSubscriptionsMessage {
3459
3841
  /**
3842
+ * @public
3460
3843
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
3461
3844
  * includes only records beyond the marker, up to the value specified by
3462
3845
  * <code>MaxRecords</code>.</p>
3463
3846
  */
3464
3847
  Marker?: string;
3465
3848
  /**
3849
+ * @public
3466
3850
  * <p>A list of event subscriptions.</p>
3467
3851
  */
3468
3852
  EventSubscriptionsList?: EventSubscription[];
@@ -3472,19 +3856,23 @@ export interface EventSubscriptionsMessage {
3472
3856
  */
3473
3857
  export interface DescribeGlobalClustersMessage {
3474
3858
  /**
3859
+ * @public
3475
3860
  * <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>
3476
3861
  */
3477
3862
  GlobalClusterIdentifier?: string;
3478
3863
  /**
3864
+ * @public
3479
3865
  * <p>A filter that specifies one or more global DB clusters to describe.</p>
3480
3866
  * <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>
3481
3867
  */
3482
3868
  Filters?: Filter[];
3483
3869
  /**
3870
+ * @public
3484
3871
  * <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>
3485
3872
  */
3486
3873
  MaxRecords?: number;
3487
3874
  /**
3875
+ * @public
3488
3876
  * <p>An optional pagination token provided by a previous <code>DescribeGlobalClusters</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
3489
3877
  */
3490
3878
  Marker?: string;
@@ -3494,10 +3882,12 @@ export interface DescribeGlobalClustersMessage {
3494
3882
  */
3495
3883
  export interface GlobalClustersMessage {
3496
3884
  /**
3885
+ * @public
3497
3886
  * <p></p>
3498
3887
  */
3499
3888
  Marker?: string;
3500
3889
  /**
3890
+ * @public
3501
3891
  * <p></p>
3502
3892
  */
3503
3893
  GlobalClusters?: GlobalCluster[];
@@ -3508,34 +3898,41 @@ export interface GlobalClustersMessage {
3508
3898
  */
3509
3899
  export interface DescribeOrderableDBInstanceOptionsMessage {
3510
3900
  /**
3901
+ * @public
3511
3902
  * <p>The name of the engine to retrieve instance options for.</p>
3512
3903
  */
3513
3904
  Engine: string | undefined;
3514
3905
  /**
3906
+ * @public
3515
3907
  * <p>The engine version filter value. Specify this parameter to show only the available
3516
3908
  * offerings that match the specified engine version.</p>
3517
3909
  */
3518
3910
  EngineVersion?: string;
3519
3911
  /**
3912
+ * @public
3520
3913
  * <p>The instance class filter value. Specify this parameter to show only the available
3521
3914
  * offerings that match the specified instance class.</p>
3522
3915
  */
3523
3916
  DBInstanceClass?: string;
3524
3917
  /**
3918
+ * @public
3525
3919
  * <p>The license model filter value. Specify this parameter to show only the available
3526
3920
  * offerings that match the specified license model.</p>
3527
3921
  */
3528
3922
  LicenseModel?: string;
3529
3923
  /**
3924
+ * @public
3530
3925
  * <p>The virtual private cloud (VPC) filter value. Specify this parameter to show only the
3531
3926
  * available VPC or non-VPC offerings.</p>
3532
3927
  */
3533
3928
  Vpc?: boolean;
3534
3929
  /**
3930
+ * @public
3535
3931
  * <p>This parameter is not currently supported.</p>
3536
3932
  */
3537
3933
  Filters?: Filter[];
3538
3934
  /**
3935
+ * @public
3539
3936
  * <p> The maximum number of records to include in the response. If more records exist than
3540
3937
  * the specified <code>MaxRecords</code> value, a pagination token (marker) is included
3541
3938
  * in the response so that the remaining results can be retrieved.</p>
@@ -3544,6 +3941,7 @@ export interface DescribeOrderableDBInstanceOptionsMessage {
3544
3941
  */
3545
3942
  MaxRecords?: number;
3546
3943
  /**
3944
+ * @public
3547
3945
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
3548
3946
  * includes only records beyond the marker, up to the value specified by
3549
3947
  * <code>MaxRecords</code>.</p>
@@ -3556,26 +3954,32 @@ export interface DescribeOrderableDBInstanceOptionsMessage {
3556
3954
  */
3557
3955
  export interface OrderableDBInstanceOption {
3558
3956
  /**
3957
+ * @public
3559
3958
  * <p>The engine type of an instance.</p>
3560
3959
  */
3561
3960
  Engine?: string;
3562
3961
  /**
3962
+ * @public
3563
3963
  * <p>The engine version of an instance.</p>
3564
3964
  */
3565
3965
  EngineVersion?: string;
3566
3966
  /**
3967
+ * @public
3567
3968
  * <p>The instance class for an instance.</p>
3568
3969
  */
3569
3970
  DBInstanceClass?: string;
3570
3971
  /**
3972
+ * @public
3571
3973
  * <p>The license model for an instance.</p>
3572
3974
  */
3573
3975
  LicenseModel?: string;
3574
3976
  /**
3977
+ * @public
3575
3978
  * <p>A list of Availability Zones for an instance.</p>
3576
3979
  */
3577
3980
  AvailabilityZones?: AvailabilityZone[];
3578
3981
  /**
3982
+ * @public
3579
3983
  * <p>Indicates whether an instance is in a virtual private cloud (VPC).</p>
3580
3984
  */
3581
3985
  Vpc?: boolean;
@@ -3586,10 +3990,12 @@ export interface OrderableDBInstanceOption {
3586
3990
  */
3587
3991
  export interface OrderableDBInstanceOptionsMessage {
3588
3992
  /**
3993
+ * @public
3589
3994
  * <p>The options that are available for a particular orderable instance.</p>
3590
3995
  */
3591
3996
  OrderableDBInstanceOptions?: OrderableDBInstanceOption[];
3592
3997
  /**
3998
+ * @public
3593
3999
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
3594
4000
  * includes only records beyond the marker, up to the value specified by
3595
4001
  * <code>MaxRecords</code>.</p>
@@ -3602,10 +4008,12 @@ export interface OrderableDBInstanceOptionsMessage {
3602
4008
  */
3603
4009
  export interface DescribePendingMaintenanceActionsMessage {
3604
4010
  /**
4011
+ * @public
3605
4012
  * <p>The ARN of a resource to return pending maintenance actions for.</p>
3606
4013
  */
3607
4014
  ResourceIdentifier?: string;
3608
4015
  /**
4016
+ * @public
3609
4017
  * <p>A filter that specifies one or more resources to return pending maintenance actions
3610
4018
  * for.</p>
3611
4019
  * <p>Supported filters:</p>
@@ -3626,12 +4034,14 @@ export interface DescribePendingMaintenanceActionsMessage {
3626
4034
  */
3627
4035
  Filters?: Filter[];
3628
4036
  /**
4037
+ * @public
3629
4038
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
3630
4039
  * includes only records beyond the marker, up to the value specified by
3631
4040
  * <code>MaxRecords</code>.</p>
3632
4041
  */
3633
4042
  Marker?: string;
3634
4043
  /**
4044
+ * @public
3635
4045
  * <p> The maximum number of records to include in the response. If more records exist than
3636
4046
  * the specified <code>MaxRecords</code> value, a pagination token (marker) is included
3637
4047
  * in the response so that the remaining results can be retrieved.</p>
@@ -3646,10 +4056,12 @@ export interface DescribePendingMaintenanceActionsMessage {
3646
4056
  */
3647
4057
  export interface PendingMaintenanceActionsMessage {
3648
4058
  /**
4059
+ * @public
3649
4060
  * <p>The maintenance actions to be applied.</p>
3650
4061
  */
3651
4062
  PendingMaintenanceActions?: ResourcePendingMaintenanceActions[];
3652
4063
  /**
4064
+ * @public
3653
4065
  * <p>An optional pagination token provided by a previous request. If this parameter is specified, the response
3654
4066
  * includes only records beyond the marker, up to the value specified by
3655
4067
  * <code>MaxRecords</code>.</p>
@@ -3662,6 +4074,7 @@ export interface PendingMaintenanceActionsMessage {
3662
4074
  */
3663
4075
  export interface FailoverDBClusterMessage {
3664
4076
  /**
4077
+ * @public
3665
4078
  * <p>A cluster identifier to force a failover for. This parameter is not case sensitive.</p>
3666
4079
  * <p>Constraints:</p>
3667
4080
  * <ul>
@@ -3672,6 +4085,7 @@ export interface FailoverDBClusterMessage {
3672
4085
  */
3673
4086
  DBClusterIdentifier?: string;
3674
4087
  /**
4088
+ * @public
3675
4089
  * <p>The name of the instance to promote to the primary instance.</p>
3676
4090
  * <p>You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For
3677
4091
  * example, <code>mydbcluster-replica1</code>.</p>
@@ -3683,6 +4097,7 @@ export interface FailoverDBClusterMessage {
3683
4097
  */
3684
4098
  export interface FailoverDBClusterResult {
3685
4099
  /**
4100
+ * @public
3686
4101
  * <p>Detailed information about a cluster. </p>
3687
4102
  */
3688
4103
  DBCluster?: DBCluster;
@@ -3693,11 +4108,13 @@ export interface FailoverDBClusterResult {
3693
4108
  */
3694
4109
  export interface ListTagsForResourceMessage {
3695
4110
  /**
4111
+ * @public
3696
4112
  * <p>The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name
3697
4113
  * (ARN).</p>
3698
4114
  */
3699
4115
  ResourceName: string | undefined;
3700
4116
  /**
4117
+ * @public
3701
4118
  * <p>This parameter is not currently supported.</p>
3702
4119
  */
3703
4120
  Filters?: Filter[];
@@ -3708,6 +4125,7 @@ export interface ListTagsForResourceMessage {
3708
4125
  */
3709
4126
  export interface TagListMessage {
3710
4127
  /**
4128
+ * @public
3711
4129
  * <p>A list of one or more tags.</p>
3712
4130
  */
3713
4131
  TagList?: Tag[];
@@ -3734,10 +4152,12 @@ export declare class InvalidDBSecurityGroupStateFault extends __BaseException {
3734
4152
  */
3735
4153
  export interface CloudwatchLogsExportConfiguration {
3736
4154
  /**
4155
+ * @public
3737
4156
  * <p>The list of log types to enable.</p>
3738
4157
  */
3739
4158
  EnableLogTypes?: string[];
3740
4159
  /**
4160
+ * @public
3741
4161
  * <p>The list of log types to disable.</p>
3742
4162
  */
3743
4163
  DisableLogTypes?: string[];
@@ -3748,6 +4168,7 @@ export interface CloudwatchLogsExportConfiguration {
3748
4168
  */
3749
4169
  export interface ModifyDBClusterMessage {
3750
4170
  /**
4171
+ * @public
3751
4172
  * <p>The cluster identifier for the cluster that is being modified. This parameter is
3752
4173
  * not case sensitive.</p>
3753
4174
  * <p>Constraints:</p>
@@ -3759,6 +4180,7 @@ export interface ModifyDBClusterMessage {
3759
4180
  */
3760
4181
  DBClusterIdentifier: string | undefined;
3761
4182
  /**
4183
+ * @public
3762
4184
  * <p>The new cluster identifier for the cluster when renaming a cluster. This
3763
4185
  * value is stored as a lowercase string.</p>
3764
4186
  * <p>Constraints:</p>
@@ -3778,6 +4200,7 @@ export interface ModifyDBClusterMessage {
3778
4200
  */
3779
4201
  NewDBClusterIdentifier?: string;
3780
4202
  /**
4203
+ * @public
3781
4204
  * <p>A value that specifies whether the changes in this request and any pending changes are
3782
4205
  * asynchronously applied as soon as possible, regardless of the
3783
4206
  * <code>PreferredMaintenanceWindow</code> setting for the cluster. If this
@@ -3794,6 +4217,7 @@ export interface ModifyDBClusterMessage {
3794
4217
  */
3795
4218
  ApplyImmediately?: boolean;
3796
4219
  /**
4220
+ * @public
3797
4221
  * <p>The number of days for which automated backups are retained. You must specify a
3798
4222
  * minimum value of 1.</p>
3799
4223
  * <p>Default: 1</p>
@@ -3806,21 +4230,25 @@ export interface ModifyDBClusterMessage {
3806
4230
  */
3807
4231
  BackupRetentionPeriod?: number;
3808
4232
  /**
4233
+ * @public
3809
4234
  * <p>The name of the cluster parameter group to use for the cluster.</p>
3810
4235
  */
3811
4236
  DBClusterParameterGroupName?: string;
3812
4237
  /**
4238
+ * @public
3813
4239
  * <p>A list of virtual private cloud (VPC) security groups that the cluster will belong
3814
4240
  * to.</p>
3815
4241
  */
3816
4242
  VpcSecurityGroupIds?: string[];
3817
4243
  /**
4244
+ * @public
3818
4245
  * <p>The port number on which the cluster accepts connections.</p>
3819
4246
  * <p>Constraints: Must be a value from <code>1150</code> to <code>65535</code>. </p>
3820
4247
  * <p>Default: The same port as the original cluster.</p>
3821
4248
  */
3822
4249
  Port?: number;
3823
4250
  /**
4251
+ * @public
3824
4252
  * <p>The password for the master database user. This password can contain any printable
3825
4253
  * ASCII character except forward slash (/), double quote ("), or the "at" symbol
3826
4254
  * (@).</p>
@@ -3828,6 +4256,7 @@ export interface ModifyDBClusterMessage {
3828
4256
  */
3829
4257
  MasterUserPassword?: string;
3830
4258
  /**
4259
+ * @public
3831
4260
  * <p>The daily time range during which automated backups are created if automated backups
3832
4261
  * are enabled, using the <code>BackupRetentionPeriod</code> parameter. </p>
3833
4262
  * <p>The default is a 30-minute window selected at random from an 8-hour block of time for
@@ -3850,6 +4279,7 @@ export interface ModifyDBClusterMessage {
3850
4279
  */
3851
4280
  PreferredBackupWindow?: string;
3852
4281
  /**
4282
+ * @public
3853
4283
  * <p>The weekly time range during which system maintenance can occur, in Universal
3854
4284
  * Coordinated Time (UTC).</p>
3855
4285
  * <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code>
@@ -3861,6 +4291,7 @@ export interface ModifyDBClusterMessage {
3861
4291
  */
3862
4292
  PreferredMaintenanceWindow?: string;
3863
4293
  /**
4294
+ * @public
3864
4295
  * <p>The configuration setting for the log types to be enabled for export to Amazon
3865
4296
  * CloudWatch Logs for a specific instance or cluster. The
3866
4297
  * <code>EnableLogTypes</code> and <code>DisableLogTypes</code> arrays determine which
@@ -3868,6 +4299,7 @@ export interface ModifyDBClusterMessage {
3868
4299
  */
3869
4300
  CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration;
3870
4301
  /**
4302
+ * @public
3871
4303
  * <p>The version number of the database engine to which you want to upgrade.
3872
4304
  * Changing this parameter results in an outage. The change is applied during
3873
4305
  * the next maintenance window unless <code>ApplyImmediately</code> is enabled.</p>
@@ -3878,6 +4310,7 @@ export interface ModifyDBClusterMessage {
3878
4310
  */
3879
4311
  EngineVersion?: string;
3880
4312
  /**
4313
+ * @public
3881
4314
  * <p>A value that indicates whether major version upgrades are allowed.</p>
3882
4315
  * <p>Constraints: You must allow major version upgrades when specifying a value for the
3883
4316
  * <code>EngineVersion</code> parameter that is a different major version than the DB
@@ -3885,6 +4318,7 @@ export interface ModifyDBClusterMessage {
3885
4318
  */
3886
4319
  AllowMajorVersionUpgrade?: boolean;
3887
4320
  /**
4321
+ * @public
3888
4322
  * <p>Specifies whether this cluster can be deleted. If <code>DeletionProtection</code> is
3889
4323
  * enabled, the cluster cannot be deleted unless it is modified and
3890
4324
  * <code>DeletionProtection</code> is disabled. <code>DeletionProtection</code>
@@ -3897,6 +4331,7 @@ export interface ModifyDBClusterMessage {
3897
4331
  */
3898
4332
  export interface ModifyDBClusterResult {
3899
4333
  /**
4334
+ * @public
3900
4335
  * <p>Detailed information about a cluster. </p>
3901
4336
  */
3902
4337
  DBCluster?: DBCluster;
@@ -3907,6 +4342,7 @@ export interface ModifyDBClusterResult {
3907
4342
  */
3908
4343
  export interface DBClusterParameterGroupNameMessage {
3909
4344
  /**
4345
+ * @public
3910
4346
  * <p>The name of a cluster parameter group.</p>
3911
4347
  * <p>Constraints:</p>
3912
4348
  * <ul>
@@ -3932,10 +4368,12 @@ export interface DBClusterParameterGroupNameMessage {
3932
4368
  */
3933
4369
  export interface ModifyDBClusterParameterGroupMessage {
3934
4370
  /**
4371
+ * @public
3935
4372
  * <p>The name of the cluster parameter group to modify.</p>
3936
4373
  */
3937
4374
  DBClusterParameterGroupName: string | undefined;
3938
4375
  /**
4376
+ * @public
3939
4377
  * <p>A list of parameters in the cluster parameter group to modify.</p>
3940
4378
  */
3941
4379
  Parameters: Parameter[] | undefined;
@@ -3946,21 +4384,25 @@ export interface ModifyDBClusterParameterGroupMessage {
3946
4384
  */
3947
4385
  export interface ModifyDBClusterSnapshotAttributeMessage {
3948
4386
  /**
4387
+ * @public
3949
4388
  * <p>The identifier for the cluster snapshot to modify the attributes for.</p>
3950
4389
  */
3951
4390
  DBClusterSnapshotIdentifier: string | undefined;
3952
4391
  /**
4392
+ * @public
3953
4393
  * <p>The name of the cluster snapshot attribute to modify.</p>
3954
4394
  * <p>To manage authorization for other Amazon Web Services accounts to copy or restore a manual cluster
3955
4395
  * snapshot, set this value to <code>restore</code>.</p>
3956
4396
  */
3957
4397
  AttributeName: string | undefined;
3958
4398
  /**
4399
+ * @public
3959
4400
  * <p>A list of cluster snapshot attributes to add to the attribute specified by <code>AttributeName</code>.</p>
3960
4401
  * <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>
3961
4402
  */
3962
4403
  ValuesToAdd?: string[];
3963
4404
  /**
4405
+ * @public
3964
4406
  * <p>A list of cluster snapshot attributes to remove from the attribute specified by <code>AttributeName</code>.</p>
3965
4407
  * <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>
3966
4408
  */
@@ -3971,6 +4413,7 @@ export interface ModifyDBClusterSnapshotAttributeMessage {
3971
4413
  */
3972
4414
  export interface ModifyDBClusterSnapshotAttributeResult {
3973
4415
  /**
4416
+ * @public
3974
4417
  * <p>Detailed information about the attributes that are associated with a cluster
3975
4418
  * snapshot.</p>
3976
4419
  */
@@ -4008,6 +4451,7 @@ export declare class DBUpgradeDependencyFailureFault extends __BaseException {
4008
4451
  */
4009
4452
  export interface ModifyDBInstanceMessage {
4010
4453
  /**
4454
+ * @public
4011
4455
  * <p>The instance identifier. This value is stored as a lowercase string.</p>
4012
4456
  * <p>Constraints:</p>
4013
4457
  * <ul>
@@ -4018,6 +4462,7 @@ export interface ModifyDBInstanceMessage {
4018
4462
  */
4019
4463
  DBInstanceIdentifier: string | undefined;
4020
4464
  /**
4465
+ * @public
4021
4466
  * <p>The new compute and memory capacity of the instance; for example, <code>db.r5.large</code>. Not all instance classes are available in all Amazon Web Services Regions. </p>
4022
4467
  * <p>If you modify the instance class, an outage occurs during the change. The change is
4023
4468
  * applied during the next maintenance window, unless <code>ApplyImmediately</code> is
@@ -4026,6 +4471,7 @@ export interface ModifyDBInstanceMessage {
4026
4471
  */
4027
4472
  DBInstanceClass?: string;
4028
4473
  /**
4474
+ * @public
4029
4475
  * <p>Specifies whether the modifications in this request and any pending modifications are
4030
4476
  * asynchronously applied as soon as possible, regardless of the
4031
4477
  * <code>PreferredMaintenanceWindow</code> setting for the instance. </p>
@@ -4037,6 +4483,7 @@ export interface ModifyDBInstanceMessage {
4037
4483
  */
4038
4484
  ApplyImmediately?: boolean;
4039
4485
  /**
4486
+ * @public
4040
4487
  * <p>The weekly time range (in UTC) during which system maintenance can occur, which might
4041
4488
  * result in an outage. Changing this parameter doesn't result in an outage except in the
4042
4489
  * following situation, and the change is asynchronously applied as soon as possible. If
@@ -4053,10 +4500,12 @@ export interface ModifyDBInstanceMessage {
4053
4500
  */
4054
4501
  PreferredMaintenanceWindow?: string;
4055
4502
  /**
4503
+ * @public
4056
4504
  * <p>This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.</p>
4057
4505
  */
4058
4506
  AutoMinorVersionUpgrade?: boolean;
4059
4507
  /**
4508
+ * @public
4060
4509
  * <p> The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set <code>Apply Immediately</code> to <code>true</code>. It occurs during the next maintenance window if you set <code>Apply Immediately</code> to <code>false</code>. This value is stored as a lowercase string. </p>
4061
4510
  * <p>Constraints:</p>
4062
4511
  * <ul>
@@ -4075,26 +4524,31 @@ export interface ModifyDBInstanceMessage {
4075
4524
  */
4076
4525
  NewDBInstanceIdentifier?: string;
4077
4526
  /**
4527
+ * @public
4078
4528
  * <p>Indicates the certificate that needs to be associated with the instance.</p>
4079
4529
  */
4080
4530
  CACertificateIdentifier?: string;
4081
4531
  /**
4532
+ * @public
4082
4533
  * <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>
4083
4534
  */
4084
4535
  CopyTagsToSnapshot?: boolean;
4085
4536
  /**
4537
+ * @public
4086
4538
  * <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>
4087
4539
  * <p>Default: 1</p>
4088
4540
  * <p>Valid values: 0-15</p>
4089
4541
  */
4090
4542
  PromotionTier?: number;
4091
4543
  /**
4544
+ * @public
4092
4545
  * <p>A value that indicates whether to enable Performance Insights for the DB Instance. For
4093
4546
  * more information, see <a href="https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html">Using Amazon
4094
4547
  * Performance Insights</a>.</p>
4095
4548
  */
4096
4549
  EnablePerformanceInsights?: boolean;
4097
4550
  /**
4551
+ * @public
4098
4552
  * <p>The KMS key identifier for encryption of Performance Insights
4099
4553
  * data.</p>
4100
4554
  * <p>The KMS key identifier is the key ARN, key ID, alias ARN, or alias name
@@ -4111,6 +4565,7 @@ export interface ModifyDBInstanceMessage {
4111
4565
  */
4112
4566
  export interface ModifyDBInstanceResult {
4113
4567
  /**
4568
+ * @public
4114
4569
  * <p>Detailed information about an instance. </p>
4115
4570
  */
4116
4571
  DBInstance?: DBInstance;
@@ -4121,6 +4576,7 @@ export interface ModifyDBInstanceResult {
4121
4576
  */
4122
4577
  export interface ModifyDBSubnetGroupMessage {
4123
4578
  /**
4579
+ * @public
4124
4580
  * <p>The name for the subnet group. This value is stored as a lowercase string. You can't modify the default subnet group. </p>
4125
4581
  * <p>Constraints: Must match the name of an existing <code>DBSubnetGroup</code>. Must not be default.</p>
4126
4582
  * <p>Example: <code>mySubnetgroup</code>
@@ -4128,10 +4584,12 @@ export interface ModifyDBSubnetGroupMessage {
4128
4584
  */
4129
4585
  DBSubnetGroupName: string | undefined;
4130
4586
  /**
4587
+ * @public
4131
4588
  * <p>The description for the subnet group.</p>
4132
4589
  */
4133
4590
  DBSubnetGroupDescription?: string;
4134
4591
  /**
4592
+ * @public
4135
4593
  * <p>The Amazon EC2 subnet IDs for the subnet group.</p>
4136
4594
  */
4137
4595
  SubnetIds: string[] | undefined;
@@ -4141,6 +4599,7 @@ export interface ModifyDBSubnetGroupMessage {
4141
4599
  */
4142
4600
  export interface ModifyDBSubnetGroupResult {
4143
4601
  /**
4602
+ * @public
4144
4603
  * <p>Detailed information about a subnet group. </p>
4145
4604
  */
4146
4605
  DBSubnetGroup?: DBSubnetGroup;
@@ -4163,26 +4622,31 @@ export declare class SubnetAlreadyInUse extends __BaseException {
4163
4622
  */
4164
4623
  export interface ModifyEventSubscriptionMessage {
4165
4624
  /**
4625
+ * @public
4166
4626
  * <p>The name of the Amazon DocumentDB event notification subscription.</p>
4167
4627
  */
4168
4628
  SubscriptionName: string | undefined;
4169
4629
  /**
4630
+ * @public
4170
4631
  * <p>The Amazon Resource Name (ARN) of the SNS topic created for event notification. The
4171
4632
  * ARN is created by Amazon SNS when you create a topic and subscribe to it.</p>
4172
4633
  */
4173
4634
  SnsTopicArn?: string;
4174
4635
  /**
4636
+ * @public
4175
4637
  * <p>The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, set this parameter to <code>db-instance</code>. If this value is not specified, all events are returned.</p>
4176
4638
  * <p>Valid values: <code>db-instance</code>, <code>db-parameter-group</code>, <code>db-security-group</code>
4177
4639
  * </p>
4178
4640
  */
4179
4641
  SourceType?: string;
4180
4642
  /**
4643
+ * @public
4181
4644
  * <p> A list of event categories for a <code>SourceType</code> that you want to subscribe
4182
4645
  * to.</p>
4183
4646
  */
4184
4647
  EventCategories?: string[];
4185
4648
  /**
4649
+ * @public
4186
4650
  * <p> A Boolean value; set to <code>true</code> to activate the subscription. </p>
4187
4651
  */
4188
4652
  Enabled?: boolean;
@@ -4192,6 +4656,7 @@ export interface ModifyEventSubscriptionMessage {
4192
4656
  */
4193
4657
  export interface ModifyEventSubscriptionResult {
4194
4658
  /**
4659
+ * @public
4195
4660
  * <p>Detailed information about an event to which you have subscribed.</p>
4196
4661
  */
4197
4662
  EventSubscription?: EventSubscription;
@@ -4202,6 +4667,7 @@ export interface ModifyEventSubscriptionResult {
4202
4667
  */
4203
4668
  export interface ModifyGlobalClusterMessage {
4204
4669
  /**
4670
+ * @public
4205
4671
  * <p>The identifier for the global cluster being modified. This parameter isn't case-sensitive.</p>
4206
4672
  * <p>Constraints:</p>
4207
4673
  * <ul>
@@ -4212,6 +4678,7 @@ export interface ModifyGlobalClusterMessage {
4212
4678
  */
4213
4679
  GlobalClusterIdentifier: string | undefined;
4214
4680
  /**
4681
+ * @public
4215
4682
  * <p>The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.</p>
4216
4683
  * <ul>
4217
4684
  * <li>
@@ -4225,6 +4692,7 @@ export interface ModifyGlobalClusterMessage {
4225
4692
  */
4226
4693
  NewGlobalClusterIdentifier?: string;
4227
4694
  /**
4695
+ * @public
4228
4696
  * <p>Indicates if the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled. </p>
4229
4697
  */
4230
4698
  DeletionProtection?: boolean;
@@ -4234,6 +4702,7 @@ export interface ModifyGlobalClusterMessage {
4234
4702
  */
4235
4703
  export interface ModifyGlobalClusterResult {
4236
4704
  /**
4705
+ * @public
4237
4706
  * <p>A data type representing an Amazon DocumentDB global cluster.</p>
4238
4707
  */
4239
4708
  GlobalCluster?: GlobalCluster;
@@ -4244,6 +4713,7 @@ export interface ModifyGlobalClusterResult {
4244
4713
  */
4245
4714
  export interface RebootDBInstanceMessage {
4246
4715
  /**
4716
+ * @public
4247
4717
  * <p>The instance identifier. This parameter is stored as a lowercase string.</p>
4248
4718
  * <p>Constraints:</p>
4249
4719
  * <ul>
@@ -4254,6 +4724,7 @@ export interface RebootDBInstanceMessage {
4254
4724
  */
4255
4725
  DBInstanceIdentifier: string | undefined;
4256
4726
  /**
4727
+ * @public
4257
4728
  * <p> When <code>true</code>, the reboot is conducted through a Multi-AZ failover. </p>
4258
4729
  * <p>Constraint: You can't specify <code>true</code> if the instance is not configured for
4259
4730
  * Multi-AZ.</p>
@@ -4265,6 +4736,7 @@ export interface RebootDBInstanceMessage {
4265
4736
  */
4266
4737
  export interface RebootDBInstanceResult {
4267
4738
  /**
4739
+ * @public
4268
4740
  * <p>Detailed information about an instance. </p>
4269
4741
  */
4270
4742
  DBInstance?: DBInstance;
@@ -4275,10 +4747,12 @@ export interface RebootDBInstanceResult {
4275
4747
  */
4276
4748
  export interface RemoveFromGlobalClusterMessage {
4277
4749
  /**
4750
+ * @public
4278
4751
  * <p>The cluster identifier to detach from the Amazon DocumentDB global cluster. </p>
4279
4752
  */
4280
4753
  GlobalClusterIdentifier: string | undefined;
4281
4754
  /**
4755
+ * @public
4282
4756
  * <p>The Amazon Resource Name (ARN) identifying the cluster that was detached from the Amazon DocumentDB global cluster. </p>
4283
4757
  */
4284
4758
  DbClusterIdentifier: string | undefined;
@@ -4288,6 +4762,7 @@ export interface RemoveFromGlobalClusterMessage {
4288
4762
  */
4289
4763
  export interface RemoveFromGlobalClusterResult {
4290
4764
  /**
4765
+ * @public
4291
4766
  * <p>A data type representing an Amazon DocumentDB global cluster.</p>
4292
4767
  */
4293
4768
  GlobalCluster?: GlobalCluster;
@@ -4298,11 +4773,13 @@ export interface RemoveFromGlobalClusterResult {
4298
4773
  */
4299
4774
  export interface RemoveSourceIdentifierFromSubscriptionMessage {
4300
4775
  /**
4776
+ * @public
4301
4777
  * <p>The name of the Amazon DocumentDB event notification subscription that you want to remove a
4302
4778
  * source identifier from.</p>
4303
4779
  */
4304
4780
  SubscriptionName: string | undefined;
4305
4781
  /**
4782
+ * @public
4306
4783
  * <p> The source identifier to be removed from the subscription, such as the instance
4307
4784
  * identifier for an instance, or the name of a security group. </p>
4308
4785
  */
@@ -4313,6 +4790,7 @@ export interface RemoveSourceIdentifierFromSubscriptionMessage {
4313
4790
  */
4314
4791
  export interface RemoveSourceIdentifierFromSubscriptionResult {
4315
4792
  /**
4793
+ * @public
4316
4794
  * <p>Detailed information about an event to which you have subscribed.</p>
4317
4795
  */
4318
4796
  EventSubscription?: EventSubscription;
@@ -4323,11 +4801,13 @@ export interface RemoveSourceIdentifierFromSubscriptionResult {
4323
4801
  */
4324
4802
  export interface RemoveTagsFromResourceMessage {
4325
4803
  /**
4804
+ * @public
4326
4805
  * <p>The Amazon DocumentDB resource that the tags are removed from. This value is an Amazon Resource
4327
4806
  * Name (ARN).</p>
4328
4807
  */
4329
4808
  ResourceName: string | undefined;
4330
4809
  /**
4810
+ * @public
4331
4811
  * <p>The tag key (name) of the tag to be removed.</p>
4332
4812
  */
4333
4813
  TagKeys: string[] | undefined;
@@ -4338,10 +4818,12 @@ export interface RemoveTagsFromResourceMessage {
4338
4818
  */
4339
4819
  export interface ResetDBClusterParameterGroupMessage {
4340
4820
  /**
4821
+ * @public
4341
4822
  * <p>The name of the cluster parameter group to reset.</p>
4342
4823
  */
4343
4824
  DBClusterParameterGroupName: string | undefined;
4344
4825
  /**
4826
+ * @public
4345
4827
  * <p>A value that is set to <code>true</code> to reset all parameters in the cluster
4346
4828
  * parameter group to their default values, and <code>false</code> otherwise. You can't use
4347
4829
  * this parameter if there is a list of parameter names specified for the
@@ -4349,6 +4831,7 @@ export interface ResetDBClusterParameterGroupMessage {
4349
4831
  */
4350
4832
  ResetAllParameters?: boolean;
4351
4833
  /**
4834
+ * @public
4352
4835
  * <p>A list of parameter names in the cluster parameter group to reset to the default
4353
4836
  * values. You can't use this parameter if the <code>ResetAllParameters</code> parameter is
4354
4837
  * set to <code>true</code>.</p>
@@ -4398,11 +4881,13 @@ export declare class InvalidRestoreFault extends __BaseException {
4398
4881
  */
4399
4882
  export interface RestoreDBClusterFromSnapshotMessage {
4400
4883
  /**
4884
+ * @public
4401
4885
  * <p>Provides the list of Amazon EC2 Availability Zones that instances in the restored DB
4402
4886
  * cluster can be created in.</p>
4403
4887
  */
4404
4888
  AvailabilityZones?: string[];
4405
4889
  /**
4890
+ * @public
4406
4891
  * <p>The name of the cluster to create from the snapshot or cluster snapshot. This
4407
4892
  * parameter isn't case sensitive.</p>
4408
4893
  * <p>Constraints:</p>
@@ -4422,6 +4907,7 @@ export interface RestoreDBClusterFromSnapshotMessage {
4422
4907
  */
4423
4908
  DBClusterIdentifier: string | undefined;
4424
4909
  /**
4910
+ * @public
4425
4911
  * <p>The identifier for the snapshot or cluster snapshot to restore from.</p>
4426
4912
  * <p>You can use either the name or the Amazon Resource Name (ARN) to specify a cluster
4427
4913
  * snapshot. However, you can use only the ARN to specify a snapshot.</p>
@@ -4434,22 +4920,26 @@ export interface RestoreDBClusterFromSnapshotMessage {
4434
4920
  */
4435
4921
  SnapshotIdentifier: string | undefined;
4436
4922
  /**
4923
+ * @public
4437
4924
  * <p>The database engine to use for the new cluster.</p>
4438
4925
  * <p>Default: The same as source.</p>
4439
4926
  * <p>Constraint: Must be compatible with the engine of the source.</p>
4440
4927
  */
4441
4928
  Engine: string | undefined;
4442
4929
  /**
4930
+ * @public
4443
4931
  * <p>The version of the database engine to use for the new cluster.</p>
4444
4932
  */
4445
4933
  EngineVersion?: string;
4446
4934
  /**
4935
+ * @public
4447
4936
  * <p>The port number on which the new cluster accepts connections.</p>
4448
4937
  * <p>Constraints: Must be a value from <code>1150</code> to <code>65535</code>.</p>
4449
4938
  * <p>Default: The same port as the original cluster.</p>
4450
4939
  */
4451
4940
  Port?: number;
4452
4941
  /**
4942
+ * @public
4453
4943
  * <p>The name of the subnet group to use for the new cluster.</p>
4454
4944
  * <p>Constraints: If provided, must match the name of an existing
4455
4945
  * <code>DBSubnetGroup</code>.</p>
@@ -4458,15 +4948,18 @@ export interface RestoreDBClusterFromSnapshotMessage {
4458
4948
  */
4459
4949
  DBSubnetGroupName?: string;
4460
4950
  /**
4951
+ * @public
4461
4952
  * <p>A list of virtual private cloud (VPC) security groups that the new cluster will
4462
4953
  * belong to.</p>
4463
4954
  */
4464
4955
  VpcSecurityGroupIds?: string[];
4465
4956
  /**
4957
+ * @public
4466
4958
  * <p>The tags to be assigned to the restored cluster.</p>
4467
4959
  */
4468
4960
  Tags?: Tag[];
4469
4961
  /**
4962
+ * @public
4470
4963
  * <p>The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.</p>
4471
4964
  * <p>The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.</p>
4472
4965
  * <p>If you do not specify a value for the <code>KmsKeyId</code> parameter, then the
@@ -4484,14 +4977,17 @@ export interface RestoreDBClusterFromSnapshotMessage {
4484
4977
  */
4485
4978
  KmsKeyId?: string;
4486
4979
  /**
4980
+ * @public
4487
4981
  * <p>A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.</p>
4488
4982
  */
4489
4983
  EnableCloudwatchLogsExports?: string[];
4490
4984
  /**
4985
+ * @public
4491
4986
  * <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>
4492
4987
  */
4493
4988
  DeletionProtection?: boolean;
4494
4989
  /**
4990
+ * @public
4495
4991
  * <p>The name of the DB cluster parameter group to associate with this DB cluster.</p>
4496
4992
  * <p>
4497
4993
  * <i>Type:</i> String.       <i>Required:</i> No.</p>
@@ -4508,6 +5004,7 @@ export interface RestoreDBClusterFromSnapshotMessage {
4508
5004
  */
4509
5005
  export interface RestoreDBClusterFromSnapshotResult {
4510
5006
  /**
5007
+ * @public
4511
5008
  * <p>Detailed information about a cluster. </p>
4512
5009
  */
4513
5010
  DBCluster?: DBCluster;
@@ -4518,6 +5015,7 @@ export interface RestoreDBClusterFromSnapshotResult {
4518
5015
  */
4519
5016
  export interface RestoreDBClusterToPointInTimeMessage {
4520
5017
  /**
5018
+ * @public
4521
5019
  * <p>The name of the new cluster to be created.</p>
4522
5020
  * <p>Constraints:</p>
4523
5021
  * <ul>
@@ -4534,6 +5032,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
4534
5032
  */
4535
5033
  DBClusterIdentifier: string | undefined;
4536
5034
  /**
5035
+ * @public
4537
5036
  * <p>The type of restore to be performed. You can specify one of the following values:</p>
4538
5037
  * <ul>
4539
5038
  * <li>
@@ -4553,6 +5052,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
4553
5052
  */
4554
5053
  RestoreType?: string;
4555
5054
  /**
5055
+ * @public
4556
5056
  * <p>The identifier of the source cluster from which to restore.</p>
4557
5057
  * <p>Constraints:</p>
4558
5058
  * <ul>
@@ -4563,6 +5063,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
4563
5063
  */
4564
5064
  SourceDBClusterIdentifier: string | undefined;
4565
5065
  /**
5066
+ * @public
4566
5067
  * <p>The date and time to restore the cluster to.</p>
4567
5068
  * <p>Valid values: A time in Universal Coordinated Time (UTC) format.</p>
4568
5069
  * <p>Constraints:</p>
@@ -4585,6 +5086,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
4585
5086
  */
4586
5087
  RestoreToTime?: Date;
4587
5088
  /**
5089
+ * @public
4588
5090
  * <p>A value that is set to <code>true</code> to restore the cluster to the latest
4589
5091
  * restorable backup time, and <code>false</code> otherwise. </p>
4590
5092
  * <p>Default: <code>false</code>
@@ -4594,12 +5096,14 @@ export interface RestoreDBClusterToPointInTimeMessage {
4594
5096
  */
4595
5097
  UseLatestRestorableTime?: boolean;
4596
5098
  /**
5099
+ * @public
4597
5100
  * <p>The port number on which the new cluster accepts connections.</p>
4598
5101
  * <p>Constraints: Must be a value from <code>1150</code> to <code>65535</code>. </p>
4599
5102
  * <p>Default: The default port for the engine.</p>
4600
5103
  */
4601
5104
  Port?: number;
4602
5105
  /**
5106
+ * @public
4603
5107
  * <p>The subnet group name to use for the new cluster.</p>
4604
5108
  * <p>Constraints: If provided, must match the name of an existing
4605
5109
  * <code>DBSubnetGroup</code>.</p>
@@ -4608,14 +5112,17 @@ export interface RestoreDBClusterToPointInTimeMessage {
4608
5112
  */
4609
5113
  DBSubnetGroupName?: string;
4610
5114
  /**
5115
+ * @public
4611
5116
  * <p>A list of VPC security groups that the new cluster belongs to.</p>
4612
5117
  */
4613
5118
  VpcSecurityGroupIds?: string[];
4614
5119
  /**
5120
+ * @public
4615
5121
  * <p>The tags to be assigned to the restored cluster.</p>
4616
5122
  */
4617
5123
  Tags?: Tag[];
4618
5124
  /**
5125
+ * @public
4619
5126
  * <p>The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.</p>
4620
5127
  * <p>The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.</p>
4621
5128
  * <p>You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the <code>KmsKeyId</code> parameter.</p>
@@ -4633,11 +5140,13 @@ export interface RestoreDBClusterToPointInTimeMessage {
4633
5140
  */
4634
5141
  KmsKeyId?: string;
4635
5142
  /**
5143
+ * @public
4636
5144
  * <p>A list of log types that must be enabled for exporting to Amazon CloudWatch
4637
5145
  * Logs.</p>
4638
5146
  */
4639
5147
  EnableCloudwatchLogsExports?: string[];
4640
5148
  /**
5149
+ * @public
4641
5150
  * <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>
4642
5151
  */
4643
5152
  DeletionProtection?: boolean;
@@ -4647,6 +5156,7 @@ export interface RestoreDBClusterToPointInTimeMessage {
4647
5156
  */
4648
5157
  export interface RestoreDBClusterToPointInTimeResult {
4649
5158
  /**
5159
+ * @public
4650
5160
  * <p>Detailed information about a cluster. </p>
4651
5161
  */
4652
5162
  DBCluster?: DBCluster;
@@ -4656,6 +5166,7 @@ export interface RestoreDBClusterToPointInTimeResult {
4656
5166
  */
4657
5167
  export interface StartDBClusterMessage {
4658
5168
  /**
5169
+ * @public
4659
5170
  * <p>The identifier of the cluster to restart. Example:
4660
5171
  * <code>docdb-2019-05-28-15-24-52</code>
4661
5172
  * </p>
@@ -4667,6 +5178,7 @@ export interface StartDBClusterMessage {
4667
5178
  */
4668
5179
  export interface StartDBClusterResult {
4669
5180
  /**
5181
+ * @public
4670
5182
  * <p>Detailed information about a cluster. </p>
4671
5183
  */
4672
5184
  DBCluster?: DBCluster;
@@ -4676,6 +5188,7 @@ export interface StartDBClusterResult {
4676
5188
  */
4677
5189
  export interface StopDBClusterMessage {
4678
5190
  /**
5191
+ * @public
4679
5192
  * <p>The identifier of the cluster to stop. Example:
4680
5193
  * <code>docdb-2019-05-28-15-24-52</code>
4681
5194
  * </p>
@@ -4687,6 +5200,7 @@ export interface StopDBClusterMessage {
4687
5200
  */
4688
5201
  export interface StopDBClusterResult {
4689
5202
  /**
5203
+ * @public
4690
5204
  * <p>Detailed information about a cluster. </p>
4691
5205
  */
4692
5206
  DBCluster?: DBCluster;