@aws-sdk/client-redshift 3.379.1 → 3.382.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 (3) hide show
  1. package/dist-types/models/models_0.d.ts +673 -0
  2. package/dist-types/models/models_1.d.ts +395 -0
  3. package/package.json +5 -5
package/dist-types/models/models_0.d.ts CHANGED
@@ -5,11 +5,13 @@ import { RedshiftServiceException as __BaseException } from "./RedshiftServiceEx
5
5
  */
6
6
  export interface AcceptReservedNodeExchangeInputMessage {
7
7
  /**
8
+ * @public
8
9
  * <p>A string representing the node identifier of the DC1 Reserved Node to be
9
10
  * exchanged.</p>
10
11
  */
11
12
  ReservedNodeId: string | undefined;
12
13
  /**
14
+ * @public
13
15
  * <p>The unique identifier of the DC2 Reserved Node offering to be used for the exchange.
14
16
  * You can obtain the value for the parameter by calling <a>GetReservedNodeExchangeOfferings</a>
15
17
  * </p>
@@ -22,11 +24,13 @@ export interface AcceptReservedNodeExchangeInputMessage {
22
24
  */
23
25
  export interface RecurringCharge {
24
26
  /**
27
+ * @public
25
28
  * <p>The amount charged per the period of time specified by the recurring charge
26
29
  * frequency.</p>
27
30
  */
28
31
  RecurringChargeAmount?: number;
29
32
  /**
33
+ * @public
30
34
  * <p>The frequency at which the recurring charge amount is applied.</p>
31
35
  */
32
36
  RecurringChargeFrequency?: string;
@@ -50,43 +54,53 @@ export type ReservedNodeOfferingType = (typeof ReservedNodeOfferingType)[keyof t
50
54
  */
51
55
  export interface ReservedNode {
52
56
  /**
57
+ * @public
53
58
  * <p>The unique identifier for the reservation.</p>
54
59
  */
55
60
  ReservedNodeId?: string;
56
61
  /**
62
+ * @public
57
63
  * <p>The identifier for the reserved node offering.</p>
58
64
  */
59
65
  ReservedNodeOfferingId?: string;
60
66
  /**
67
+ * @public
61
68
  * <p>The node type of the reserved node.</p>
62
69
  */
63
70
  NodeType?: string;
64
71
  /**
72
+ * @public
65
73
  * <p>The time the reservation started. You purchase a reserved node offering for a
66
74
  * duration. This is the start time of that duration.</p>
67
75
  */
68
76
  StartTime?: Date;
69
77
  /**
78
+ * @public
70
79
  * <p>The duration of the node reservation in seconds.</p>
71
80
  */
72
81
  Duration?: number;
73
82
  /**
83
+ * @public
74
84
  * <p>The fixed cost Amazon Redshift charges you for this reserved node.</p>
75
85
  */
76
86
  FixedPrice?: number;
77
87
  /**
88
+ * @public
78
89
  * <p>The hourly rate Amazon Redshift charges you for this reserved node.</p>
79
90
  */
80
91
  UsagePrice?: number;
81
92
  /**
93
+ * @public
82
94
  * <p>The currency code for the reserved cluster.</p>
83
95
  */
84
96
  CurrencyCode?: string;
85
97
  /**
98
+ * @public
86
99
  * <p>The number of reserved compute nodes.</p>
87
100
  */
88
101
  NodeCount?: number;
89
102
  /**
103
+ * @public
90
104
  * <p>The state of the reserved compute node.</p>
91
105
  * <p>Possible Values:</p>
92
106
  * <ul>
@@ -112,15 +126,18 @@ export interface ReservedNode {
112
126
  */
113
127
  State?: string;
114
128
  /**
129
+ * @public
115
130
  * <p>The anticipated utilization of the reserved node, as defined in the reserved node
116
131
  * offering.</p>
117
132
  */
118
133
  OfferingType?: string;
119
134
  /**
135
+ * @public
120
136
  * <p>The recurring charges for the reserved node.</p>
121
137
  */
122
138
  RecurringCharges?: RecurringCharge[];
123
139
  /**
140
+ * @public
124
141
  * <p></p>
125
142
  */
126
143
  ReservedNodeOfferingType?: ReservedNodeOfferingType | string;
@@ -130,6 +147,7 @@ export interface ReservedNode {
130
147
  */
131
148
  export interface AcceptReservedNodeExchangeOutputMessage {
132
149
  /**
150
+ * @public
133
151
  * <p></p>
134
152
  */
135
153
  ExchangedReservedNode?: ReservedNode;
@@ -250,6 +268,7 @@ export declare class AccessToSnapshotDeniedFault extends __BaseException {
250
268
  */
251
269
  export interface AttributeValueTarget {
252
270
  /**
271
+ * @public
253
272
  * <p>The value of the attribute.</p>
254
273
  */
255
274
  AttributeValue?: string;
@@ -260,10 +279,12 @@ export interface AttributeValueTarget {
260
279
  */
261
280
  export interface AccountAttribute {
262
281
  /**
282
+ * @public
263
283
  * <p>The name of the attribute.</p>
264
284
  */
265
285
  AttributeName?: string;
266
286
  /**
287
+ * @public
267
288
  * <p>A list of attribute values.</p>
268
289
  */
269
290
  AttributeValues?: AttributeValueTarget[];
@@ -273,6 +294,7 @@ export interface AccountAttribute {
273
294
  */
274
295
  export interface AccountAttributeList {
275
296
  /**
297
+ * @public
276
298
  * <p>A list of attributes assigned to an account.</p>
277
299
  */
278
300
  AccountAttributes?: AccountAttribute[];
@@ -283,11 +305,13 @@ export interface AccountAttributeList {
283
305
  */
284
306
  export interface AccountWithRestoreAccess {
285
307
  /**
308
+ * @public
286
309
  * <p>The identifier of an Amazon Web Services account authorized to restore a
287
310
  * snapshot.</p>
288
311
  */
289
312
  AccountId?: string;
290
313
  /**
314
+ * @public
291
315
  * <p>The identifier of an Amazon Web Services support account authorized to restore a
292
316
  * snapshot. For Amazon Web Services Support, the identifier is <code>amazon-redshift-support</code>. </p>
293
317
  */
@@ -324,18 +348,22 @@ export declare class ClusterNotFoundFault extends __BaseException {
324
348
  */
325
349
  export interface PartnerIntegrationInputMessage {
326
350
  /**
351
+ * @public
327
352
  * <p>The Amazon Web Services account ID that owns the cluster.</p>
328
353
  */
329
354
  AccountId: string | undefined;
330
355
  /**
356
+ * @public
331
357
  * <p>The cluster identifier of the cluster that receives data from the partner.</p>
332
358
  */
333
359
  ClusterIdentifier: string | undefined;
334
360
  /**
361
+ * @public
335
362
  * <p>The name of the database that receives data from the partner.</p>
336
363
  */
337
364
  DatabaseName: string | undefined;
338
365
  /**
366
+ * @public
339
367
  * <p>The name of the partner that is authorized to send data.</p>
340
368
  */
341
369
  PartnerName: string | undefined;
@@ -345,10 +373,12 @@ export interface PartnerIntegrationInputMessage {
345
373
  */
346
374
  export interface PartnerIntegrationOutputMessage {
347
375
  /**
376
+ * @public
348
377
  * <p>The name of the database that receives data from the partner.</p>
349
378
  */
350
379
  DatabaseName?: string;
351
380
  /**
381
+ * @public
352
382
  * <p>The name of the partner that is authorized to send data.</p>
353
383
  */
354
384
  PartnerName?: string;
@@ -409,10 +439,12 @@ export type AquaStatus = (typeof AquaStatus)[keyof typeof AquaStatus];
409
439
  */
410
440
  export interface AquaConfiguration {
411
441
  /**
442
+ * @public
412
443
  * <p>This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).</p>
413
444
  */
414
445
  AquaStatus?: AquaStatus | string;
415
446
  /**
447
+ * @public
416
448
  * <p>This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).</p>
417
449
  */
418
450
  AquaConfigurationStatus?: AquaConfigurationStatus | string;
@@ -422,19 +454,23 @@ export interface AquaConfiguration {
422
454
  */
423
455
  export interface AssociateDataShareConsumerMessage {
424
456
  /**
457
+ * @public
425
458
  * <p>The Amazon Resource Name (ARN) of the datashare that the consumer is to use with the account or the namespace.</p>
426
459
  */
427
460
  DataShareArn: string | undefined;
428
461
  /**
462
+ * @public
429
463
  * <p>A value that specifies whether the datashare is associated with the entire account.</p>
430
464
  */
431
465
  AssociateEntireAccount?: boolean;
432
466
  /**
467
+ * @public
433
468
  * <p>The Amazon Resource Name (ARN) of the consumer that is associated with the
434
469
  * datashare.</p>
435
470
  */
436
471
  ConsumerArn?: string;
437
472
  /**
473
+ * @public
438
474
  * <p>From a datashare consumer account, associates a datashare with all existing and future namespaces in the specified Amazon Web Services Region.</p>
439
475
  */
440
476
  ConsumerRegion?: string;
@@ -462,23 +498,28 @@ export type DataShareStatus = (typeof DataShareStatus)[keyof typeof DataShareSta
462
498
  */
463
499
  export interface DataShareAssociation {
464
500
  /**
501
+ * @public
465
502
  * <p>The name of the consumer accounts that have an association with a producer
466
503
  * datashare.</p>
467
504
  */
468
505
  ConsumerIdentifier?: string;
469
506
  /**
507
+ * @public
470
508
  * <p>The status of the datashare that is associated.</p>
471
509
  */
472
510
  Status?: DataShareStatus | string;
473
511
  /**
512
+ * @public
474
513
  * <p>The Amazon Web Services Region of the consumer accounts that have an association with a producer datashare.</p>
475
514
  */
476
515
  ConsumerRegion?: string;
477
516
  /**
517
+ * @public
478
518
  * <p>The creation date of the datashare that is associated.</p>
479
519
  */
480
520
  CreatedDate?: Date;
481
521
  /**
522
+ * @public
482
523
  * <p>The status change data of the datashare that is associated.</p>
483
524
  */
484
525
  StatusChangeDate?: Date;
@@ -488,23 +529,28 @@ export interface DataShareAssociation {
488
529
  */
489
530
  export interface DataShare {
490
531
  /**
532
+ * @public
491
533
  * <p>An Amazon Resource Name (ARN) that references the datashare that is owned by a specific namespace of the producer cluster. A datashare ARN is in the <code>arn:aws:redshift:\{region\}:\{account-id\}:\{datashare\}:\{namespace-guid\}/\{datashare-name\}</code> format.</p>
492
534
  */
493
535
  DataShareArn?: string;
494
536
  /**
537
+ * @public
495
538
  * <p>The Amazon Resource Name (ARN) of the producer.</p>
496
539
  */
497
540
  ProducerArn?: string;
498
541
  /**
542
+ * @public
499
543
  * <p>A value that specifies whether the datashare can be shared to a publicly accessible cluster.</p>
500
544
  */
501
545
  AllowPubliclyAccessibleConsumers?: boolean;
502
546
  /**
547
+ * @public
503
548
  * <p>A value that specifies when the datashare has an association between producer and data
504
549
  * consumers.</p>
505
550
  */
506
551
  DataShareAssociations?: DataShareAssociation[];
507
552
  /**
553
+ * @public
508
554
  * <p>The identifier of a datashare to show its managing entity.</p>
509
555
  */
510
556
  ManagedBy?: string;
@@ -552,10 +598,12 @@ export type ScheduleState = (typeof ScheduleState)[keyof typeof ScheduleState];
552
598
  */
553
599
  export interface ClusterAssociatedToSchedule {
554
600
  /**
601
+ * @public
555
602
  * <p></p>
556
603
  */
557
604
  ClusterIdentifier?: string;
558
605
  /**
606
+ * @public
559
607
  * <p></p>
560
608
  */
561
609
  ScheduleAssociationState?: ScheduleState | string;
@@ -567,10 +615,12 @@ export interface ClusterAssociatedToSchedule {
567
615
  */
568
616
  export interface CertificateAssociation {
569
617
  /**
618
+ * @public
570
619
  * <p>The custom domain name for the certificate association.</p>
571
620
  */
572
621
  CustomDomainName?: string;
573
622
  /**
623
+ * @public
574
624
  * <p>The cluster identifier for the certificate association.</p>
575
625
  */
576
626
  ClusterIdentifier?: string;
@@ -581,14 +631,17 @@ export interface CertificateAssociation {
581
631
  */
582
632
  export interface Association {
583
633
  /**
634
+ * @public
584
635
  * <p>The Amazon Resource Name (ARN) for the certificate associated with the custom domain.</p>
585
636
  */
586
637
  CustomDomainCertificateArn?: string;
587
638
  /**
639
+ * @public
588
640
  * <p>The expiration date for the certificate.</p>
589
641
  */
590
642
  CustomDomainCertificateExpiryDate?: Date;
591
643
  /**
644
+ * @public
592
645
  * <p>A list of all associated clusters and domain names tied to a specific certificate.</p>
593
646
  */
594
647
  CertificateAssociations?: CertificateAssociation[];
@@ -599,10 +652,12 @@ export interface Association {
599
652
  */
600
653
  export interface AuthenticationProfile {
601
654
  /**
655
+ * @public
602
656
  * <p>The name of the authentication profile.</p>
603
657
  */
604
658
  AuthenticationProfileName?: string;
605
659
  /**
660
+ * @public
606
661
  * <p>The content of the authentication profile in JSON format.
607
662
  * The maximum length of the JSON string is determined by a quota for your account.</p>
608
663
  */
@@ -701,18 +756,22 @@ export type AuthorizationStatus = (typeof AuthorizationStatus)[keyof typeof Auth
701
756
  */
702
757
  export interface AuthorizeClusterSecurityGroupIngressMessage {
703
758
  /**
759
+ * @public
704
760
  * <p>The name of the security group to which the ingress rule is added.</p>
705
761
  */
706
762
  ClusterSecurityGroupName: string | undefined;
707
763
  /**
764
+ * @public
708
765
  * <p>The IP range to be added the Amazon Redshift security group.</p>
709
766
  */
710
767
  CIDRIP?: string;
711
768
  /**
769
+ * @public
712
770
  * <p>The EC2 security group to be added the Amazon Redshift security group.</p>
713
771
  */
714
772
  EC2SecurityGroupName?: string;
715
773
  /**
774
+ * @public
716
775
  * <p>The Amazon Web Services account number of the owner of the security group specified by the
717
776
  * <i>EC2SecurityGroupName</i> parameter. The Amazon Web Services Access Key ID is not an
718
777
  * acceptable value. </p>
@@ -727,10 +786,12 @@ export interface AuthorizeClusterSecurityGroupIngressMessage {
727
786
  */
728
787
  export interface Tag {
729
788
  /**
789
+ * @public
730
790
  * <p>The key, or name, for the resource tag.</p>
731
791
  */
732
792
  Key?: string;
733
793
  /**
794
+ * @public
734
795
  * <p>The value for the resource tag.</p>
735
796
  */
736
797
  Value?: string;
@@ -741,19 +802,23 @@ export interface Tag {
741
802
  */
742
803
  export interface EC2SecurityGroup {
743
804
  /**
805
+ * @public
744
806
  * <p>The status of the EC2 security group.</p>
745
807
  */
746
808
  Status?: string;
747
809
  /**
810
+ * @public
748
811
  * <p>The name of the EC2 Security Group.</p>
749
812
  */
750
813
  EC2SecurityGroupName?: string;
751
814
  /**
815
+ * @public
752
816
  * <p>The Amazon Web Services account ID of the owner of the EC2 security group specified in the
753
817
  * <code>EC2SecurityGroupName</code> field. </p>
754
818
  */
755
819
  EC2SecurityGroupOwnerId?: string;
756
820
  /**
821
+ * @public
757
822
  * <p>The list of tags for the EC2 security group.</p>
758
823
  */
759
824
  Tags?: Tag[];
@@ -764,14 +829,17 @@ export interface EC2SecurityGroup {
764
829
  */
765
830
  export interface IPRange {
766
831
  /**
832
+ * @public
767
833
  * <p>The status of the IP range, for example, "authorized".</p>
768
834
  */
769
835
  Status?: string;
770
836
  /**
837
+ * @public
771
838
  * <p>The IP range in Classless Inter-Domain Routing (CIDR) notation.</p>
772
839
  */
773
840
  CIDRIP?: string;
774
841
  /**
842
+ * @public
775
843
  * <p>The list of tags for the IP range.</p>
776
844
  */
777
845
  Tags?: Tag[];
@@ -782,25 +850,30 @@ export interface IPRange {
782
850
  */
783
851
  export interface ClusterSecurityGroup {
784
852
  /**
853
+ * @public
785
854
  * <p>The name of the cluster security group to which the operation was
786
855
  * applied.</p>
787
856
  */
788
857
  ClusterSecurityGroupName?: string;
789
858
  /**
859
+ * @public
790
860
  * <p>A description of the security group.</p>
791
861
  */
792
862
  Description?: string;
793
863
  /**
864
+ * @public
794
865
  * <p>A list of EC2 security groups that are permitted to access clusters associated with
795
866
  * this cluster security group.</p>
796
867
  */
797
868
  EC2SecurityGroups?: EC2SecurityGroup[];
798
869
  /**
870
+ * @public
799
871
  * <p>A list of IP ranges (CIDR blocks) that are permitted to access clusters associated
800
872
  * with this cluster security group.</p>
801
873
  */
802
874
  IPRanges?: IPRange[];
803
875
  /**
876
+ * @public
804
877
  * <p>The list of tags for the cluster security group.</p>
805
878
  */
806
879
  Tags?: Tag[];
@@ -810,6 +883,7 @@ export interface ClusterSecurityGroup {
810
883
  */
811
884
  export interface AuthorizeClusterSecurityGroupIngressResult {
812
885
  /**
886
+ * @public
813
887
  * <p>Describes a security group.</p>
814
888
  */
815
889
  ClusterSecurityGroup?: ClusterSecurityGroup;
@@ -844,11 +918,13 @@ export declare class InvalidClusterSecurityGroupStateFault extends __BaseExcepti
844
918
  */
845
919
  export interface AuthorizeDataShareMessage {
846
920
  /**
921
+ * @public
847
922
  * <p>The Amazon Resource Name (ARN) of the datashare that producers are to authorize
848
923
  * sharing for.</p>
849
924
  */
850
925
  DataShareArn: string | undefined;
851
926
  /**
927
+ * @public
852
928
  * <p>The identifier of the data consumer that is authorized to access the datashare. This identifier is an Amazon Web Services account ID or a keyword, such as ADX.</p>
853
929
  */
854
930
  ConsumerIdentifier: string | undefined;
@@ -858,14 +934,17 @@ export interface AuthorizeDataShareMessage {
858
934
  */
859
935
  export interface AuthorizeEndpointAccessMessage {
860
936
  /**
937
+ * @public
861
938
  * <p>The cluster identifier of the cluster to grant access to.</p>
862
939
  */
863
940
  ClusterIdentifier?: string;
864
941
  /**
942
+ * @public
865
943
  * <p>The Amazon Web Services account ID to grant access to.</p>
866
944
  */
867
945
  Account: string | undefined;
868
946
  /**
947
+ * @public
869
948
  * <p>The virtual private cloud (VPC) identifiers to grant access to.</p>
870
949
  */
871
950
  VpcIds?: string[];
@@ -876,38 +955,47 @@ export interface AuthorizeEndpointAccessMessage {
876
955
  */
877
956
  export interface EndpointAuthorization {
878
957
  /**
958
+ * @public
879
959
  * <p>The Amazon Web Services account ID of the cluster owner.</p>
880
960
  */
881
961
  Grantor?: string;
882
962
  /**
963
+ * @public
883
964
  * <p>The Amazon Web Services account ID of the grantee of the cluster.</p>
884
965
  */
885
966
  Grantee?: string;
886
967
  /**
968
+ * @public
887
969
  * <p>The cluster identifier.</p>
888
970
  */
889
971
  ClusterIdentifier?: string;
890
972
  /**
973
+ * @public
891
974
  * <p>The time (UTC) when the authorization was created.</p>
892
975
  */
893
976
  AuthorizeTime?: Date;
894
977
  /**
978
+ * @public
895
979
  * <p>The status of the cluster.</p>
896
980
  */
897
981
  ClusterStatus?: string;
898
982
  /**
983
+ * @public
899
984
  * <p>The status of the authorization action.</p>
900
985
  */
901
986
  Status?: AuthorizationStatus | string;
902
987
  /**
988
+ * @public
903
989
  * <p>Indicates whether all VPCs in the grantee account are allowed access to the cluster.</p>
904
990
  */
905
991
  AllowedAllVPCs?: boolean;
906
992
  /**
993
+ * @public
907
994
  * <p>The VPCs allowed access to the cluster.</p>
908
995
  */
909
996
  AllowedVPCs?: string[];
910
997
  /**
998
+ * @public
911
999
  * <p>The number of Redshift-managed VPC endpoints created for the authorization.</p>
912
1000
  */
913
1001
  EndpointCount?: number;
@@ -966,20 +1054,24 @@ export declare class InvalidClusterStateFault extends __BaseException {
966
1054
  */
967
1055
  export interface AuthorizeSnapshotAccessMessage {
968
1056
  /**
1057
+ * @public
969
1058
  * <p>The identifier of the snapshot the account is authorized to restore.</p>
970
1059
  */
971
1060
  SnapshotIdentifier?: string;
972
1061
  /**
1062
+ * @public
973
1063
  * <p>The Amazon Resource Name (ARN) of the snapshot to authorize access to.</p>
974
1064
  */
975
1065
  SnapshotArn?: string;
976
1066
  /**
1067
+ * @public
977
1068
  * <p>The identifier of the cluster the snapshot was created from. This parameter is
978
1069
  * required if your IAM user has a policy containing a snapshot resource element that
979
1070
  * specifies anything other than * for the cluster name.</p>
980
1071
  */
981
1072
  SnapshotClusterIdentifier?: string;
982
1073
  /**
1074
+ * @public
983
1075
  * <p>The identifier of the Amazon Web Services account authorized to restore the specified
984
1076
  * snapshot.</p>
985
1077
  * <p>To share a snapshot with Amazon Web Services Support, specify amazon-redshift-support.</p>
@@ -992,19 +1084,23 @@ export interface AuthorizeSnapshotAccessMessage {
992
1084
  */
993
1085
  export interface Snapshot {
994
1086
  /**
1087
+ * @public
995
1088
  * <p>The snapshot identifier that is provided in the request.</p>
996
1089
  */
997
1090
  SnapshotIdentifier?: string;
998
1091
  /**
1092
+ * @public
999
1093
  * <p>The identifier of the cluster for which the snapshot was taken.</p>
1000
1094
  */
1001
1095
  ClusterIdentifier?: string;
1002
1096
  /**
1097
+ * @public
1003
1098
  * <p>The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a
1004
1099
  * copy of the cluster data as of this exact time.</p>
1005
1100
  */
1006
1101
  SnapshotCreateTime?: Date;
1007
1102
  /**
1103
+ * @public
1008
1104
  * <p>The snapshot status. The value of the status depends on the API operation used: </p>
1009
1105
  * <ul>
1010
1106
  * <li>
@@ -1024,121 +1120,147 @@ export interface Snapshot {
1024
1120
  */
1025
1121
  Status?: string;
1026
1122
  /**
1123
+ * @public
1027
1124
  * <p>The port that the cluster is listening on.</p>
1028
1125
  */
1029
1126
  Port?: number;
1030
1127
  /**
1128
+ * @public
1031
1129
  * <p>The Availability Zone in which the cluster was created.</p>
1032
1130
  */
1033
1131
  AvailabilityZone?: string;
1034
1132
  /**
1133
+ * @public
1035
1134
  * <p>The time (UTC) when the cluster was originally created.</p>
1036
1135
  */
1037
1136
  ClusterCreateTime?: Date;
1038
1137
  /**
1138
+ * @public
1039
1139
  * <p>The admin user name for the cluster.</p>
1040
1140
  */
1041
1141
  MasterUsername?: string;
1042
1142
  /**
1143
+ * @public
1043
1144
  * <p>The version ID of the Amazon Redshift engine that is running on the cluster.</p>
1044
1145
  */
1045
1146
  ClusterVersion?: string;
1046
1147
  /**
1148
+ * @public
1047
1149
  * <p>The cluster version of the cluster used to create the snapshot. For example, 1.0.15503. </p>
1048
1150
  */
1049
1151
  EngineFullVersion?: string;
1050
1152
  /**
1153
+ * @public
1051
1154
  * <p>The snapshot type. Snapshots created using <a>CreateClusterSnapshot</a>
1052
1155
  * and <a>CopyClusterSnapshot</a> are of type "manual". </p>
1053
1156
  */
1054
1157
  SnapshotType?: string;
1055
1158
  /**
1159
+ * @public
1056
1160
  * <p>The node type of the nodes in the cluster.</p>
1057
1161
  */
1058
1162
  NodeType?: string;
1059
1163
  /**
1164
+ * @public
1060
1165
  * <p>The number of nodes in the cluster.</p>
1061
1166
  */
1062
1167
  NumberOfNodes?: number;
1063
1168
  /**
1169
+ * @public
1064
1170
  * <p>The name of the database that was created when the cluster was created.</p>
1065
1171
  */
1066
1172
  DBName?: string;
1067
1173
  /**
1174
+ * @public
1068
1175
  * <p>The VPC identifier of the cluster if the snapshot is from a cluster in a VPC.
1069
1176
  * Otherwise, this field is not in the output.</p>
1070
1177
  */
1071
1178
  VpcId?: string;
1072
1179
  /**
1180
+ * @public
1073
1181
  * <p>If <code>true</code>, the data in the snapshot is encrypted at rest.</p>
1074
1182
  */
1075
1183
  Encrypted?: boolean;
1076
1184
  /**
1185
+ * @public
1077
1186
  * <p>The Key Management Service (KMS) key ID of the encryption key that was used to
1078
1187
  * encrypt data in the cluster from which the snapshot was taken.</p>
1079
1188
  */
1080
1189
  KmsKeyId?: string;
1081
1190
  /**
1191
+ * @public
1082
1192
  * <p>A boolean that indicates whether the snapshot data is encrypted using the HSM keys
1083
1193
  * of the source cluster. <code>true</code> indicates that the data is encrypted using HSM
1084
1194
  * keys.</p>
1085
1195
  */
1086
1196
  EncryptedWithHSM?: boolean;
1087
1197
  /**
1198
+ * @public
1088
1199
  * <p>A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns
1089
1200
  * <code>null</code> if no accounts are authorized. Visible only to the snapshot owner.
1090
1201
  * </p>
1091
1202
  */
1092
1203
  AccountsWithRestoreAccess?: AccountWithRestoreAccess[];
1093
1204
  /**
1205
+ * @public
1094
1206
  * <p>For manual snapshots, the Amazon Web Services account used to create or copy the snapshot.
1095
1207
  * For automatic snapshots, the owner of the cluster. The owner can perform all snapshot
1096
1208
  * actions, such as sharing a manual snapshot.</p>
1097
1209
  */
1098
1210
  OwnerAccount?: string;
1099
1211
  /**
1212
+ * @public
1100
1213
  * <p>The size of the complete set of backup data that would be used to restore the
1101
1214
  * cluster.</p>
1102
1215
  */
1103
1216
  TotalBackupSizeInMegaBytes?: number;
1104
1217
  /**
1218
+ * @public
1105
1219
  * <p>The size of the incremental backup.</p>
1106
1220
  */
1107
1221
  ActualIncrementalBackupSizeInMegaBytes?: number;
1108
1222
  /**
1223
+ * @public
1109
1224
  * <p>The number of megabytes that have been transferred to the snapshot
1110
1225
  * backup.</p>
1111
1226
  */
1112
1227
  BackupProgressInMegaBytes?: number;
1113
1228
  /**
1229
+ * @public
1114
1230
  * <p>The number of megabytes per second being transferred to the snapshot backup.
1115
1231
  * Returns <code>0</code> for a completed backup. </p>
1116
1232
  */
1117
1233
  CurrentBackupRateInMegaBytesPerSecond?: number;
1118
1234
  /**
1235
+ * @public
1119
1236
  * <p>The estimate of the time remaining before the snapshot backup will complete.
1120
1237
  * Returns <code>0</code> for a completed backup. </p>
1121
1238
  */
1122
1239
  EstimatedSecondsToCompletion?: number;
1123
1240
  /**
1241
+ * @public
1124
1242
  * <p>The amount of time an in-progress snapshot backup has been running, or the amount
1125
1243
  * of time it took a completed backup to finish.</p>
1126
1244
  */
1127
1245
  ElapsedTimeInSeconds?: number;
1128
1246
  /**
1247
+ * @public
1129
1248
  * <p>The source region from which the snapshot was copied.</p>
1130
1249
  */
1131
1250
  SourceRegion?: string;
1132
1251
  /**
1252
+ * @public
1133
1253
  * <p>The list of tags for the cluster snapshot.</p>
1134
1254
  */
1135
1255
  Tags?: Tag[];
1136
1256
  /**
1257
+ * @public
1137
1258
  * <p>The list of node types that this cluster snapshot is able to restore
1138
1259
  * into.</p>
1139
1260
  */
1140
1261
  RestorableNodeTypes?: string[];
1141
1262
  /**
1263
+ * @public
1142
1264
  * <p>An option that specifies whether to create the cluster with enhanced VPC routing
1143
1265
  * enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a
1144
1266
  * VPC. For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in
@@ -1148,20 +1270,24 @@ export interface Snapshot {
1148
1270
  */
1149
1271
  EnhancedVpcRouting?: boolean;
1150
1272
  /**
1273
+ * @public
1151
1274
  * <p>The name of the maintenance track for the snapshot.</p>
1152
1275
  */
1153
1276
  MaintenanceTrackName?: string;
1154
1277
  /**
1278
+ * @public
1155
1279
  * <p>The number of days that a manual snapshot is retained. If the value is -1, the manual
1156
1280
  * snapshot is retained indefinitely. </p>
1157
1281
  * <p>The value must be either -1 or an integer between 1 and 3,653.</p>
1158
1282
  */
1159
1283
  ManualSnapshotRetentionPeriod?: number;
1160
1284
  /**
1285
+ * @public
1161
1286
  * <p>The number of days until a manual snapshot will pass its retention period.</p>
1162
1287
  */
1163
1288
  ManualSnapshotRemainingDays?: number;
1164
1289
  /**
1290
+ * @public
1165
1291
  * <p>A timestamp representing the start of the retention period for the snapshot.</p>
1166
1292
  */
1167
1293
  SnapshotRetentionStartTime?: Date;
@@ -1171,6 +1297,7 @@ export interface Snapshot {
1171
1297
  */
1172
1298
  export interface AuthorizeSnapshotAccessResult {
1173
1299
  /**
1300
+ * @public
1174
1301
  * <p>Describes a snapshot.</p>
1175
1302
  */
1176
1303
  Snapshot?: Snapshot;
@@ -1231,6 +1358,7 @@ export declare class LimitExceededFault extends __BaseException {
1231
1358
  */
1232
1359
  export interface SupportedPlatform {
1233
1360
  /**
1361
+ * @public
1234
1362
  * <p></p>
1235
1363
  */
1236
1364
  Name?: string;
@@ -1241,10 +1369,12 @@ export interface SupportedPlatform {
1241
1369
  */
1242
1370
  export interface AvailabilityZone {
1243
1371
  /**
1372
+ * @public
1244
1373
  * <p>The name of the availability zone.</p>
1245
1374
  */
1246
1375
  Name?: string;
1247
1376
  /**
1377
+ * @public
1248
1378
  * <p></p>
1249
1379
  */
1250
1380
  SupportedPlatforms?: SupportedPlatform[];
@@ -1255,6 +1385,7 @@ export interface AvailabilityZone {
1255
1385
  */
1256
1386
  export interface DeleteClusterSnapshotMessage {
1257
1387
  /**
1388
+ * @public
1258
1389
  * <p>The unique identifier of the manual snapshot to be deleted.</p>
1259
1390
  * <p>Constraints: Must be the name of an existing snapshot that is in the
1260
1391
  * <code>available</code>, <code>failed</code>, or <code>cancelled</code>
@@ -1262,6 +1393,7 @@ export interface DeleteClusterSnapshotMessage {
1262
1393
  */
1263
1394
  SnapshotIdentifier: string | undefined;
1264
1395
  /**
1396
+ * @public
1265
1397
  * <p>The unique identifier of the cluster the snapshot was created from. This parameter
1266
1398
  * is required if your IAM user has a policy containing a snapshot resource element that
1267
1399
  * specifies anything other than * for the cluster name.</p>
@@ -1274,6 +1406,7 @@ export interface DeleteClusterSnapshotMessage {
1274
1406
  */
1275
1407
  export interface BatchDeleteClusterSnapshotsRequest {
1276
1408
  /**
1409
+ * @public
1277
1410
  * <p>A list of identifiers for the snapshots that you want to delete.</p>
1278
1411
  */
1279
1412
  Identifiers: DeleteClusterSnapshotMessage[] | undefined;
@@ -1284,18 +1417,22 @@ export interface BatchDeleteClusterSnapshotsRequest {
1284
1417
  */
1285
1418
  export interface SnapshotErrorMessage {
1286
1419
  /**
1420
+ * @public
1287
1421
  * <p>A unique identifier for the snapshot returning the error.</p>
1288
1422
  */
1289
1423
  SnapshotIdentifier?: string;
1290
1424
  /**
1425
+ * @public
1291
1426
  * <p>A unique identifier for the cluster.</p>
1292
1427
  */
1293
1428
  SnapshotClusterIdentifier?: string;
1294
1429
  /**
1430
+ * @public
1295
1431
  * <p>The failure code for the error.</p>
1296
1432
  */
1297
1433
  FailureCode?: string;
1298
1434
  /**
1435
+ * @public
1299
1436
  * <p>The text message describing the error.</p>
1300
1437
  */
1301
1438
  FailureReason?: string;
@@ -1305,10 +1442,12 @@ export interface SnapshotErrorMessage {
1305
1442
  */
1306
1443
  export interface BatchDeleteClusterSnapshotsResult {
1307
1444
  /**
1445
+ * @public
1308
1446
  * <p>A list of the snapshot identifiers that were deleted. </p>
1309
1447
  */
1310
1448
  Resources?: string[];
1311
1449
  /**
1450
+ * @public
1312
1451
  * <p>A list of any errors returned.</p>
1313
1452
  */
1314
1453
  Errors?: SnapshotErrorMessage[];
@@ -1344,10 +1483,12 @@ export declare class BatchModifyClusterSnapshotsLimitExceededFault extends __Bas
1344
1483
  */
1345
1484
  export interface BatchModifyClusterSnapshotsMessage {
1346
1485
  /**
1486
+ * @public
1347
1487
  * <p>A list of snapshot identifiers you want to modify.</p>
1348
1488
  */
1349
1489
  SnapshotIdentifierList: string[] | undefined;
1350
1490
  /**
1491
+ * @public
1351
1492
  * <p>The number of days that a manual snapshot is retained. If you specify the value -1,
1352
1493
  * the manual snapshot is retained indefinitely.</p>
1353
1494
  * <p>The number must be either -1 or an integer between 1 and 3,653.</p>
@@ -1357,6 +1498,7 @@ export interface BatchModifyClusterSnapshotsMessage {
1357
1498
  */
1358
1499
  ManualSnapshotRetentionPeriod?: number;
1359
1500
  /**
1501
+ * @public
1360
1502
  * <p>A boolean value indicating whether to override an exception if the retention period
1361
1503
  * has passed. </p>
1362
1504
  */
@@ -1367,10 +1509,12 @@ export interface BatchModifyClusterSnapshotsMessage {
1367
1509
  */
1368
1510
  export interface BatchModifyClusterSnapshotsOutputMessage {
1369
1511
  /**
1512
+ * @public
1370
1513
  * <p>A list of the snapshots that were modified.</p>
1371
1514
  */
1372
1515
  Resources?: string[];
1373
1516
  /**
1517
+ * @public
1374
1518
  * <p>A list of any errors returned.</p>
1375
1519
  */
1376
1520
  Errors?: SnapshotErrorMessage[];
@@ -1405,6 +1549,7 @@ export declare class BucketNotFoundFault extends __BaseException {
1405
1549
  */
1406
1550
  export interface CancelResizeMessage {
1407
1551
  /**
1552
+ * @public
1408
1553
  * <p>The unique identifier for the cluster that you want to cancel a resize operation
1409
1554
  * for.</p>
1410
1555
  */
@@ -1428,22 +1573,26 @@ export declare class ResizeNotFoundFault extends __BaseException {
1428
1573
  */
1429
1574
  export interface ResizeProgressMessage {
1430
1575
  /**
1576
+ * @public
1431
1577
  * <p>The node type that the cluster will have after the resize operation is
1432
1578
  * complete.</p>
1433
1579
  */
1434
1580
  TargetNodeType?: string;
1435
1581
  /**
1582
+ * @public
1436
1583
  * <p>The number of nodes that the cluster will have after the resize operation is
1437
1584
  * complete.</p>
1438
1585
  */
1439
1586
  TargetNumberOfNodes?: number;
1440
1587
  /**
1588
+ * @public
1441
1589
  * <p>The cluster type after the resize operation is complete.</p>
1442
1590
  * <p>Valid Values: <code>multi-node</code> | <code>single-node</code>
1443
1591
  * </p>
1444
1592
  */
1445
1593
  TargetClusterType?: string;
1446
1594
  /**
1595
+ * @public
1447
1596
  * <p>The status of the resize operation.</p>
1448
1597
  * <p>Valid Values: <code>NONE</code> | <code>IN_PROGRESS</code> | <code>FAILED</code> |
1449
1598
  * <code>SUCCEEDED</code> | <code>CANCELLING</code>
@@ -1451,32 +1600,38 @@ export interface ResizeProgressMessage {
1451
1600
  */
1452
1601
  Status?: string;
1453
1602
  /**
1603
+ * @public
1454
1604
  * <p>The names of tables that have been completely imported .</p>
1455
1605
  * <p>Valid Values: List of table names.</p>
1456
1606
  */
1457
1607
  ImportTablesCompleted?: string[];
1458
1608
  /**
1609
+ * @public
1459
1610
  * <p>The names of tables that are being currently imported.</p>
1460
1611
  * <p>Valid Values: List of table names.</p>
1461
1612
  */
1462
1613
  ImportTablesInProgress?: string[];
1463
1614
  /**
1615
+ * @public
1464
1616
  * <p>The names of tables that have not been yet imported.</p>
1465
1617
  * <p>Valid Values: List of table names</p>
1466
1618
  */
1467
1619
  ImportTablesNotStarted?: string[];
1468
1620
  /**
1621
+ * @public
1469
1622
  * <p>The average rate of the resize operation over the last few minutes, measured in
1470
1623
  * megabytes per second. After the resize operation completes, this value shows the average
1471
1624
  * rate of the entire resize operation.</p>
1472
1625
  */
1473
1626
  AvgResizeRateInMegaBytesPerSecond?: number;
1474
1627
  /**
1628
+ * @public
1475
1629
  * <p>The estimated total amount of data, in megabytes, on the cluster before the resize
1476
1630
  * operation began.</p>
1477
1631
  */
1478
1632
  TotalResizeDataInMegaBytes?: number;
1479
1633
  /**
1634
+ * @public
1480
1635
  * <p>While the resize operation is in progress, this value shows the current amount of
1481
1636
  * data, in megabytes, that has been processed so far. When the resize operation is
1482
1637
  * complete, this value shows the total amount of data, in megabytes, on the cluster, which
@@ -1485,12 +1640,14 @@ export interface ResizeProgressMessage {
1485
1640
  */
1486
1641
  ProgressInMegaBytes?: number;
1487
1642
  /**
1643
+ * @public
1488
1644
  * <p>The amount of seconds that have elapsed since the resize operation began. After the
1489
1645
  * resize operation completes, this value shows the total actual time, in seconds, for the
1490
1646
  * resize operation.</p>
1491
1647
  */
1492
1648
  ElapsedTimeInSeconds?: number;
1493
1649
  /**
1650
+ * @public
1494
1651
  * <p>The estimated time remaining, in seconds, until the resize operation is complete.
1495
1652
  * This value is calculated based on the average resize rate and the estimated amount of
1496
1653
  * data remaining to be processed. Once the resize operation is complete, this value will
@@ -1498,21 +1655,25 @@ export interface ResizeProgressMessage {
1498
1655
  */
1499
1656
  EstimatedTimeToCompletionInSeconds?: number;
1500
1657
  /**
1658
+ * @public
1501
1659
  * <p>An enum with possible values of <code>ClassicResize</code> and
1502
1660
  * <code>ElasticResize</code>. These values describe the type of resize operation being
1503
1661
  * performed. </p>
1504
1662
  */
1505
1663
  ResizeType?: string;
1506
1664
  /**
1665
+ * @public
1507
1666
  * <p>An optional string to provide additional details about the resize action.</p>
1508
1667
  */
1509
1668
  Message?: string;
1510
1669
  /**
1670
+ * @public
1511
1671
  * <p>The type of encryption for the cluster after the resize is complete.</p>
1512
1672
  * <p>Possible values are <code>KMS</code> and <code>None</code>. </p>
1513
1673
  */
1514
1674
  TargetEncryptionType?: string;
1515
1675
  /**
1676
+ * @public
1516
1677
  * <p>The percent of data transferred from source cluster to target cluster.</p>
1517
1678
  */
1518
1679
  DataTransferProgressPercent?: number;
@@ -1523,14 +1684,17 @@ export interface ResizeProgressMessage {
1523
1684
  */
1524
1685
  export interface ClusterNode {
1525
1686
  /**
1687
+ * @public
1526
1688
  * <p>Whether the node is a leader node or a compute node.</p>
1527
1689
  */
1528
1690
  NodeRole?: string;
1529
1691
  /**
1692
+ * @public
1530
1693
  * <p>The private IP address of a node within a cluster.</p>
1531
1694
  */
1532
1695
  PrivateIPAddress?: string;
1533
1696
  /**
1697
+ * @public
1534
1698
  * <p>The public IP address of a node within a cluster.</p>
1535
1699
  */
1536
1700
  PublicIPAddress?: string;
@@ -1541,10 +1705,12 @@ export interface ClusterNode {
1541
1705
  */
1542
1706
  export interface ClusterParameterStatus {
1543
1707
  /**
1708
+ * @public
1544
1709
  * <p>The name of the parameter.</p>
1545
1710
  */
1546
1711
  ParameterName?: string;
1547
1712
  /**
1713
+ * @public
1548
1714
  * <p>The status of the parameter that indicates whether the parameter is in sync with
1549
1715
  * the database, waiting for a cluster reboot, or encountered an error when being
1550
1716
  * applied.</p>
@@ -1589,6 +1755,7 @@ export interface ClusterParameterStatus {
1589
1755
  */
1590
1756
  ParameterApplyStatus?: string;
1591
1757
  /**
1758
+ * @public
1592
1759
  * <p>The error that prevented the parameter from being applied to the
1593
1760
  * database.</p>
1594
1761
  */
@@ -1600,14 +1767,17 @@ export interface ClusterParameterStatus {
1600
1767
  */
1601
1768
  export interface ClusterParameterGroupStatus {
1602
1769
  /**
1770
+ * @public
1603
1771
  * <p>The name of the cluster parameter group.</p>
1604
1772
  */
1605
1773
  ParameterGroupName?: string;
1606
1774
  /**
1775
+ * @public
1607
1776
  * <p>The status of parameter updates.</p>
1608
1777
  */
1609
1778
  ParameterApplyStatus?: string;
1610
1779
  /**
1780
+ * @public
1611
1781
  * <p>The list of parameter statuses.</p>
1612
1782
  * <p>
1613
1783
  * For more information about parameters and parameter groups, go to
@@ -1622,10 +1792,12 @@ export interface ClusterParameterGroupStatus {
1622
1792
  */
1623
1793
  export interface ClusterSecurityGroupMembership {
1624
1794
  /**
1795
+ * @public
1625
1796
  * <p>The name of the cluster security group.</p>
1626
1797
  */
1627
1798
  ClusterSecurityGroupName?: string;
1628
1799
  /**
1800
+ * @public
1629
1801
  * <p>The status of the cluster security group.</p>
1630
1802
  */
1631
1803
  Status?: string;
@@ -1637,16 +1809,19 @@ export interface ClusterSecurityGroupMembership {
1637
1809
  */
1638
1810
  export interface ClusterSnapshotCopyStatus {
1639
1811
  /**
1812
+ * @public
1640
1813
  * <p>The destination region that snapshots are automatically copied to when cross-region
1641
1814
  * snapshot copy is enabled.</p>
1642
1815
  */
1643
1816
  DestinationRegion?: string;
1644
1817
  /**
1818
+ * @public
1645
1819
  * <p>The number of days that automated snapshots are retained in the destination region
1646
1820
  * after they are copied from a source region.</p>
1647
1821
  */
1648
1822
  RetentionPeriod?: number;
1649
1823
  /**
1824
+ * @public
1650
1825
  * <p>The number of days that automated snapshots are retained in the destination region
1651
1826
  * after they are copied from a source region. If the value is -1, the manual snapshot is
1652
1827
  * retained indefinitely. </p>
@@ -1654,6 +1829,7 @@ export interface ClusterSnapshotCopyStatus {
1654
1829
  */
1655
1830
  ManualSnapshotRetentionPeriod?: number;
1656
1831
  /**
1832
+ * @public
1657
1833
  * <p>The name of the snapshot copy grant.</p>
1658
1834
  */
1659
1835
  SnapshotCopyGrantName?: string;
@@ -1665,27 +1841,33 @@ export interface ClusterSnapshotCopyStatus {
1665
1841
  */
1666
1842
  export interface DataTransferProgress {
1667
1843
  /**
1844
+ * @public
1668
1845
  * <p>Describes the status of the cluster. While the transfer is in progress the status is
1669
1846
  * <code>transferringdata</code>.</p>
1670
1847
  */
1671
1848
  Status?: string;
1672
1849
  /**
1850
+ * @public
1673
1851
  * <p>Describes the data transfer rate in MB's per second.</p>
1674
1852
  */
1675
1853
  CurrentRateInMegaBytesPerSecond?: number;
1676
1854
  /**
1855
+ * @public
1677
1856
  * <p>Describes the total amount of data to be transfered in megabytes.</p>
1678
1857
  */
1679
1858
  TotalDataInMegaBytes?: number;
1680
1859
  /**
1860
+ * @public
1681
1861
  * <p>Describes the total amount of data that has been transfered in MB's.</p>
1682
1862
  */
1683
1863
  DataTransferredInMegaBytes?: number;
1684
1864
  /**
1865
+ * @public
1685
1866
  * <p>Describes the estimated number of seconds remaining to complete the transfer.</p>
1686
1867
  */
1687
1868
  EstimatedTimeToCompletionInSeconds?: number;
1688
1869
  /**
1870
+ * @public
1689
1871
  * <p>Describes the number of seconds that have elapsed during the data transfer.</p>
1690
1872
  */
1691
1873
  ElapsedTimeInSeconds?: number;
@@ -1696,14 +1878,17 @@ export interface DataTransferProgress {
1696
1878
  */
1697
1879
  export interface DeferredMaintenanceWindow {
1698
1880
  /**
1881
+ * @public
1699
1882
  * <p>A unique identifier for the maintenance window.</p>
1700
1883
  */
1701
1884
  DeferMaintenanceIdentifier?: string;
1702
1885
  /**
1886
+ * @public
1703
1887
  * <p> A timestamp for the beginning of the time period when we defer maintenance.</p>
1704
1888
  */
1705
1889
  DeferMaintenanceStartTime?: Date;
1706
1890
  /**
1891
+ * @public
1707
1892
  * <p> A timestamp for the end of the time period when we defer maintenance.</p>
1708
1893
  */
1709
1894
  DeferMaintenanceEndTime?: Date;
@@ -1714,10 +1899,12 @@ export interface DeferredMaintenanceWindow {
1714
1899
  */
1715
1900
  export interface ElasticIpStatus {
1716
1901
  /**
1902
+ * @public
1717
1903
  * <p>The elastic IP (EIP) address for the cluster.</p>
1718
1904
  */
1719
1905
  ElasticIp?: string;
1720
1906
  /**
1907
+ * @public
1721
1908
  * <p>The status of the elastic IP (EIP) address.</p>
1722
1909
  */
1723
1910
  Status?: string;
@@ -1728,18 +1915,22 @@ export interface ElasticIpStatus {
1728
1915
  */
1729
1916
  export interface NetworkInterface {
1730
1917
  /**
1918
+ * @public
1731
1919
  * <p>The network interface identifier. </p>
1732
1920
  */
1733
1921
  NetworkInterfaceId?: string;
1734
1922
  /**
1923
+ * @public
1735
1924
  * <p>The subnet identifier. </p>
1736
1925
  */
1737
1926
  SubnetId?: string;
1738
1927
  /**
1928
+ * @public
1739
1929
  * <p>The IPv4 address of the network interface within the subnet. </p>
1740
1930
  */
1741
1931
  PrivateIpAddress?: string;
1742
1932
  /**
1933
+ * @public
1743
1934
  * <p>The Availability Zone. </p>
1744
1935
  */
1745
1936
  AvailabilityZone?: string;
@@ -1750,14 +1941,17 @@ export interface NetworkInterface {
1750
1941
  */
1751
1942
  export interface VpcEndpoint {
1752
1943
  /**
1944
+ * @public
1753
1945
  * <p>The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.</p>
1754
1946
  */
1755
1947
  VpcEndpointId?: string;
1756
1948
  /**
1949
+ * @public
1757
1950
  * <p>The VPC identifier that the endpoint is associated. </p>
1758
1951
  */
1759
1952
  VpcId?: string;
1760
1953
  /**
1954
+ * @public
1761
1955
  * <p>One or more network interfaces of the endpoint. Also known as an interface endpoint. </p>
1762
1956
  */
1763
1957
  NetworkInterfaces?: NetworkInterface[];
@@ -1768,14 +1962,17 @@ export interface VpcEndpoint {
1768
1962
  */
1769
1963
  export interface Endpoint {
1770
1964
  /**
1965
+ * @public
1771
1966
  * <p>The DNS address of the Cluster.</p>
1772
1967
  */
1773
1968
  Address?: string;
1774
1969
  /**
1970
+ * @public
1775
1971
  * <p>The port that the database engine is listening on.</p>
1776
1972
  */
1777
1973
  Port?: number;
1778
1974
  /**
1975
+ * @public
1779
1976
  * <p>Describes a connection endpoint.</p>
1780
1977
  */
1781
1978
  VpcEndpoints?: VpcEndpoint[];
@@ -1786,16 +1983,19 @@ export interface Endpoint {
1786
1983
  */
1787
1984
  export interface HsmStatus {
1788
1985
  /**
1986
+ * @public
1789
1987
  * <p>Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to
1790
1988
  * retrieve the data encryption keys stored in an HSM.</p>
1791
1989
  */
1792
1990
  HsmClientCertificateIdentifier?: string;
1793
1991
  /**
1992
+ * @public
1794
1993
  * <p>Specifies the name of the HSM configuration that contains the information the
1795
1994
  * Amazon Redshift cluster can use to retrieve and store keys in an HSM.</p>
1796
1995
  */
1797
1996
  HsmConfigurationIdentifier?: string;
1798
1997
  /**
1998
+ * @public
1799
1999
  * <p>Reports whether the Amazon Redshift cluster has finished applying any HSM settings
1800
2000
  * changes specified in a modify cluster command.</p>
1801
2001
  * <p>Values: active, applying</p>
@@ -1809,11 +2009,13 @@ export interface HsmStatus {
1809
2009
  */
1810
2010
  export interface ClusterIamRole {
1811
2011
  /**
2012
+ * @public
1812
2013
  * <p>The Amazon Resource Name (ARN) of the IAM role, for example,
1813
2014
  * <code>arn:aws:iam::123456789012:role/RedshiftCopyUnload</code>. </p>
1814
2015
  */
1815
2016
  IamRoleArn?: string;
1816
2017
  /**
2018
+ * @public
1817
2019
  * <p>A value that describes the status of the IAM role's association with an Amazon
1818
2020
  * Redshift cluster.</p>
1819
2021
  * <p>The following are possible statuses and descriptions.</p>
@@ -1843,41 +2045,50 @@ export interface ClusterIamRole {
1843
2045
  */
1844
2046
  export interface PendingModifiedValues {
1845
2047
  /**
2048
+ * @public
1846
2049
  * <p>The pending or in-progress change of the admin user password for the
1847
2050
  * cluster.</p>
1848
2051
  */
1849
2052
  MasterUserPassword?: string;
1850
2053
  /**
2054
+ * @public
1851
2055
  * <p>The pending or in-progress change of the cluster's node type.</p>
1852
2056
  */
1853
2057
  NodeType?: string;
1854
2058
  /**
2059
+ * @public
1855
2060
  * <p>The pending or in-progress change of the number of nodes in the cluster.</p>
1856
2061
  */
1857
2062
  NumberOfNodes?: number;
1858
2063
  /**
2064
+ * @public
1859
2065
  * <p>The pending or in-progress change of the cluster type.</p>
1860
2066
  */
1861
2067
  ClusterType?: string;
1862
2068
  /**
2069
+ * @public
1863
2070
  * <p>The pending or in-progress change of the service version.</p>
1864
2071
  */
1865
2072
  ClusterVersion?: string;
1866
2073
  /**
2074
+ * @public
1867
2075
  * <p>The pending or in-progress change of the automated snapshot retention
1868
2076
  * period.</p>
1869
2077
  */
1870
2078
  AutomatedSnapshotRetentionPeriod?: number;
1871
2079
  /**
2080
+ * @public
1872
2081
  * <p>The pending or in-progress change of the new identifier for the cluster.</p>
1873
2082
  */
1874
2083
  ClusterIdentifier?: string;
1875
2084
  /**
2085
+ * @public
1876
2086
  * <p>The pending or in-progress change of the ability to connect to the cluster from the
1877
2087
  * public network.</p>
1878
2088
  */
1879
2089
  PubliclyAccessible?: boolean;
1880
2090
  /**
2091
+ * @public
1881
2092
  * <p>An option that specifies whether to create the cluster with enhanced VPC routing
1882
2093
  * enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a
1883
2094
  * VPC. For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in
@@ -1887,11 +2098,13 @@ export interface PendingModifiedValues {
1887
2098
  */
1888
2099
  EnhancedVpcRouting?: boolean;
1889
2100
  /**
2101
+ * @public
1890
2102
  * <p>The name of the maintenance track that the cluster will change to during the next
1891
2103
  * maintenance window.</p>
1892
2104
  */
1893
2105
  MaintenanceTrackName?: string;
1894
2106
  /**
2107
+ * @public
1895
2108
  * <p>The encryption type for a cluster. Possible values are: KMS and None. </p>
1896
2109
  */
1897
2110
  EncryptionType?: string;
@@ -1920,38 +2133,47 @@ export type ReservedNodeExchangeStatusType = (typeof ReservedNodeExchangeStatusT
1920
2133
  */
1921
2134
  export interface ReservedNodeExchangeStatus {
1922
2135
  /**
2136
+ * @public
1923
2137
  * <p>The identifier of the reserved-node exchange request.</p>
1924
2138
  */
1925
2139
  ReservedNodeExchangeRequestId?: string;
1926
2140
  /**
2141
+ * @public
1927
2142
  * <p>The status of the reserved-node exchange request. Statuses include in-progress and requested.</p>
1928
2143
  */
1929
2144
  Status?: ReservedNodeExchangeStatusType | string;
1930
2145
  /**
2146
+ * @public
1931
2147
  * <p>A date and time that indicate when the reserved-node exchange was requested.</p>
1932
2148
  */
1933
2149
  RequestTime?: Date;
1934
2150
  /**
2151
+ * @public
1935
2152
  * <p>The identifier of the source reserved node.</p>
1936
2153
  */
1937
2154
  SourceReservedNodeId?: string;
1938
2155
  /**
2156
+ * @public
1939
2157
  * <p>The source reserved-node type, for example ds2.xlarge.</p>
1940
2158
  */
1941
2159
  SourceReservedNodeType?: string;
1942
2160
  /**
2161
+ * @public
1943
2162
  * <p>The source reserved-node count in the cluster.</p>
1944
2163
  */
1945
2164
  SourceReservedNodeCount?: number;
1946
2165
  /**
2166
+ * @public
1947
2167
  * <p>The identifier of the target reserved node offering.</p>
1948
2168
  */
1949
2169
  TargetReservedNodeOfferingId?: string;
1950
2170
  /**
2171
+ * @public
1951
2172
  * <p>The node type of the target reserved node, for example ra3.4xlarge.</p>
1952
2173
  */
1953
2174
  TargetReservedNodeType?: string;
1954
2175
  /**
2176
+ * @public
1955
2177
  * <p>The count of target reserved nodes in the cluster.</p>
1956
2178
  */
1957
2179
  TargetReservedNodeCount?: number;
@@ -1962,10 +2184,12 @@ export interface ReservedNodeExchangeStatus {
1962
2184
  */
1963
2185
  export interface ResizeInfo {
1964
2186
  /**
2187
+ * @public
1965
2188
  * <p>Returns the value <code>ClassicResize</code>.</p>
1966
2189
  */
1967
2190
  ResizeType?: string;
1968
2191
  /**
2192
+ * @public
1969
2193
  * <p>A boolean value indicating if the resize operation can be cancelled.</p>
1970
2194
  */
1971
2195
  AllowCancelResize?: boolean;
@@ -1977,33 +2201,39 @@ export interface ResizeInfo {
1977
2201
  */
1978
2202
  export interface RestoreStatus {
1979
2203
  /**
2204
+ * @public
1980
2205
  * <p>The status of the restore action. Returns starting, restoring, completed, or
1981
2206
  * failed.</p>
1982
2207
  */
1983
2208
  Status?: string;
1984
2209
  /**
2210
+ * @public
1985
2211
  * <p>The number of megabytes per second being transferred from the backup storage.
1986
2212
  * Returns the average rate for a completed backup.
1987
2213
  * This field is only updated when you restore to DC2 and DS2 node types. </p>
1988
2214
  */
1989
2215
  CurrentRestoreRateInMegaBytesPerSecond?: number;
1990
2216
  /**
2217
+ * @public
1991
2218
  * <p>The size of the set of snapshot data used to restore the cluster.
1992
2219
  * This field is only updated when you restore to DC2 and DS2 node types. </p>
1993
2220
  */
1994
2221
  SnapshotSizeInMegaBytes?: number;
1995
2222
  /**
2223
+ * @public
1996
2224
  * <p>The number of megabytes that have been transferred from snapshot storage.
1997
2225
  * This field is only updated when you restore to DC2 and DS2 node types. </p>
1998
2226
  */
1999
2227
  ProgressInMegaBytes?: number;
2000
2228
  /**
2229
+ * @public
2001
2230
  * <p>The amount of time an in-progress restore has been running, or the amount of time
2002
2231
  * it took a completed restore to finish.
2003
2232
  * This field is only updated when you restore to DC2 and DS2 node types. </p>
2004
2233
  */
2005
2234
  ElapsedTimeInSeconds?: number;
2006
2235
  /**
2236
+ * @public
2007
2237
  * <p>The estimate of the time remaining before the restore will complete. Returns 0 for
2008
2238
  * a completed restore.
2009
2239
  * This field is only updated when you restore to DC2 and DS2 node types. </p>
@@ -2016,10 +2246,12 @@ export interface RestoreStatus {
2016
2246
  */
2017
2247
  export interface VpcSecurityGroupMembership {
2018
2248
  /**
2249
+ * @public
2019
2250
  * <p>The identifier of the VPC security group.</p>
2020
2251
  */
2021
2252
  VpcSecurityGroupId?: string;
2022
2253
  /**
2254
+ * @public
2023
2255
  * <p>The status of the VPC security group.</p>
2024
2256
  */
2025
2257
  Status?: string;
@@ -2030,14 +2262,17 @@ export interface VpcSecurityGroupMembership {
2030
2262
  */
2031
2263
  export interface Cluster {
2032
2264
  /**
2265
+ * @public
2033
2266
  * <p>The unique identifier of the cluster.</p>
2034
2267
  */
2035
2268
  ClusterIdentifier?: string;
2036
2269
  /**
2270
+ * @public
2037
2271
  * <p>The node type for the nodes in the cluster.</p>
2038
2272
  */
2039
2273
  NodeType?: string;
2040
2274
  /**
2275
+ * @public
2041
2276
  * <p> The current state of the cluster. Possible values are the following:</p>
2042
2277
  * <ul>
2043
2278
  * <li>
@@ -2144,6 +2379,7 @@ export interface Cluster {
2144
2379
  */
2145
2380
  ClusterStatus?: string;
2146
2381
  /**
2382
+ * @public
2147
2383
  * <p>The availability status of the cluster for queries. Possible values are the following:</p>
2148
2384
  * <ul>
2149
2385
  * <li>
@@ -2165,33 +2401,40 @@ export interface Cluster {
2165
2401
  */
2166
2402
  ClusterAvailabilityStatus?: string;
2167
2403
  /**
2404
+ * @public
2168
2405
  * <p>The status of a modify operation, if any, initiated for the cluster.</p>
2169
2406
  */
2170
2407
  ModifyStatus?: string;
2171
2408
  /**
2409
+ * @public
2172
2410
  * <p>The admin user name for the cluster. This name is used to connect to the database
2173
2411
  * that is specified in the <b>DBName</b> parameter. </p>
2174
2412
  */
2175
2413
  MasterUsername?: string;
2176
2414
  /**
2415
+ * @public
2177
2416
  * <p>The name of the initial database that was created when the cluster was created.
2178
2417
  * This same name is returned for the life of the cluster. If an initial database was not
2179
2418
  * specified, a database named <code>dev</code>dev was created by default. </p>
2180
2419
  */
2181
2420
  DBName?: string;
2182
2421
  /**
2422
+ * @public
2183
2423
  * <p>The connection endpoint.</p>
2184
2424
  */
2185
2425
  Endpoint?: Endpoint;
2186
2426
  /**
2427
+ * @public
2187
2428
  * <p>The date and time that the cluster was created.</p>
2188
2429
  */
2189
2430
  ClusterCreateTime?: Date;
2190
2431
  /**
2432
+ * @public
2191
2433
  * <p>The number of days that automatic cluster snapshots are retained.</p>
2192
2434
  */
2193
2435
  AutomatedSnapshotRetentionPeriod?: number;
2194
2436
  /**
2437
+ * @public
2195
2438
  * <p>The default number of days to retain a manual snapshot. If the value is -1, the
2196
2439
  * snapshot is retained indefinitely. This setting doesn't change the retention period
2197
2440
  * of existing snapshots.</p>
@@ -2199,6 +2442,7 @@ export interface Cluster {
2199
2442
  */
2200
2443
  ManualSnapshotRetentionPeriod?: number;
2201
2444
  /**
2445
+ * @public
2202
2446
  * <p>A list of cluster security group that are associated with the cluster. Each
2203
2447
  * security group is represented by an element that contains
2204
2448
  * <code>ClusterSecurityGroup.Name</code> and <code>ClusterSecurityGroup.Status</code>
@@ -2210,72 +2454,87 @@ export interface Cluster {
2210
2454
  */
2211
2455
  ClusterSecurityGroups?: ClusterSecurityGroupMembership[];
2212
2456
  /**
2457
+ * @public
2213
2458
  * <p>A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are
2214
2459
  * associated with the cluster. This parameter is returned only if the cluster is in a
2215
2460
  * VPC.</p>
2216
2461
  */
2217
2462
  VpcSecurityGroups?: VpcSecurityGroupMembership[];
2218
2463
  /**
2464
+ * @public
2219
2465
  * <p>The list of cluster parameter groups that are associated with this cluster. Each
2220
2466
  * parameter group in the list is returned with its status.</p>
2221
2467
  */
2222
2468
  ClusterParameterGroups?: ClusterParameterGroupStatus[];
2223
2469
  /**
2470
+ * @public
2224
2471
  * <p>The name of the subnet group that is associated with the cluster. This parameter is
2225
2472
  * valid only when the cluster is in a VPC.</p>
2226
2473
  */
2227
2474
  ClusterSubnetGroupName?: string;
2228
2475
  /**
2476
+ * @public
2229
2477
  * <p>The identifier of the VPC the cluster is in, if the cluster is in a VPC.</p>
2230
2478
  */
2231
2479
  VpcId?: string;
2232
2480
  /**
2481
+ * @public
2233
2482
  * <p>The name of the Availability Zone in which the cluster is located.</p>
2234
2483
  */
2235
2484
  AvailabilityZone?: string;
2236
2485
  /**
2486
+ * @public
2237
2487
  * <p>The weekly time range, in Universal Coordinated Time (UTC), during which system
2238
2488
  * maintenance can occur.</p>
2239
2489
  */
2240
2490
  PreferredMaintenanceWindow?: string;
2241
2491
  /**
2492
+ * @public
2242
2493
  * <p>A value that, if present, indicates that changes to the cluster are pending.
2243
2494
  * Specific pending changes are identified by subelements.</p>
2244
2495
  */
2245
2496
  PendingModifiedValues?: PendingModifiedValues;
2246
2497
  /**
2498
+ * @public
2247
2499
  * <p>The version ID of the Amazon Redshift engine that is running on the cluster.</p>
2248
2500
  */
2249
2501
  ClusterVersion?: string;
2250
2502
  /**
2503
+ * @public
2251
2504
  * <p>A boolean value that, if <code>true</code>, indicates that major version upgrades
2252
2505
  * will be applied automatically to the cluster during the maintenance window. </p>
2253
2506
  */
2254
2507
  AllowVersionUpgrade?: boolean;
2255
2508
  /**
2509
+ * @public
2256
2510
  * <p>The number of compute nodes in the cluster.</p>
2257
2511
  */
2258
2512
  NumberOfNodes?: number;
2259
2513
  /**
2514
+ * @public
2260
2515
  * <p>A boolean value that, if <code>true</code>, indicates that the cluster can be
2261
2516
  * accessed from a public network.</p>
2262
2517
  */
2263
2518
  PubliclyAccessible?: boolean;
2264
2519
  /**
2520
+ * @public
2265
2521
  * <p>A boolean value that, if <code>true</code>, indicates that data in the cluster is
2266
2522
  * encrypted at rest.</p>
2267
2523
  */
2268
2524
  Encrypted?: boolean;
2269
2525
  /**
2526
+ * @public
2270
2527
  * <p>A value that describes the status of a cluster restore action. This parameter
2271
2528
  * returns null if the cluster was not created by restoring a snapshot.</p>
2272
2529
  */
2273
2530
  RestoreStatus?: RestoreStatus;
2274
2531
  /**
2532
+ * @public
2275
2533
  * <p></p>
2276
2534
  */
2277
2535
  DataTransferProgress?: DataTransferProgress;
2278
2536
  /**
2537
+ * @public
2279
2538
  * <p>A value that reports whether the Amazon Redshift cluster has finished applying any
2280
2539
  * hardware security module (HSM) settings changes specified in a modify cluster
2281
2540
  * command.</p>
@@ -2283,36 +2542,44 @@ export interface Cluster {
2283
2542
  */
2284
2543
  HsmStatus?: HsmStatus;
2285
2544
  /**
2545
+ * @public
2286
2546
  * <p>A value that returns the destination region and retention period that are
2287
2547
  * configured for cross-region snapshot copy.</p>
2288
2548
  */
2289
2549
  ClusterSnapshotCopyStatus?: ClusterSnapshotCopyStatus;
2290
2550
  /**
2551
+ * @public
2291
2552
  * <p>The public key for the cluster.</p>
2292
2553
  */
2293
2554
  ClusterPublicKey?: string;
2294
2555
  /**
2556
+ * @public
2295
2557
  * <p>The nodes in the cluster.</p>
2296
2558
  */
2297
2559
  ClusterNodes?: ClusterNode[];
2298
2560
  /**
2561
+ * @public
2299
2562
  * <p>The status of the elastic IP (EIP) address.</p>
2300
2563
  */
2301
2564
  ElasticIpStatus?: ElasticIpStatus;
2302
2565
  /**
2566
+ * @public
2303
2567
  * <p>The specific revision number of the database in the cluster.</p>
2304
2568
  */
2305
2569
  ClusterRevisionNumber?: string;
2306
2570
  /**
2571
+ * @public
2307
2572
  * <p>The list of tags for the cluster.</p>
2308
2573
  */
2309
2574
  Tags?: Tag[];
2310
2575
  /**
2576
+ * @public
2311
2577
  * <p>The Key Management Service (KMS) key ID of the encryption key used to
2312
2578
  * encrypt data in the cluster.</p>
2313
2579
  */
2314
2580
  KmsKeyId?: string;
2315
2581
  /**
2582
+ * @public
2316
2583
  * <p>An option that specifies whether to create the cluster with enhanced VPC routing
2317
2584
  * enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a
2318
2585
  * VPC. For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in
@@ -2322,40 +2589,49 @@ export interface Cluster {
2322
2589
  */
2323
2590
  EnhancedVpcRouting?: boolean;
2324
2591
  /**
2592
+ * @public
2325
2593
  * <p>A list of Identity and Access Management (IAM) roles that can be used by the
2326
2594
  * cluster to access other Amazon Web Services services.</p>
2327
2595
  */
2328
2596
  IamRoles?: ClusterIamRole[];
2329
2597
  /**
2598
+ * @public
2330
2599
  * <p>Cluster operations that are waiting to be started.</p>
2331
2600
  */
2332
2601
  PendingActions?: string[];
2333
2602
  /**
2603
+ * @public
2334
2604
  * <p>The name of the maintenance track for the cluster.</p>
2335
2605
  */
2336
2606
  MaintenanceTrackName?: string;
2337
2607
  /**
2608
+ * @public
2338
2609
  * <p>The number of nodes that you can resize the cluster to with the elastic resize method.
2339
2610
  * </p>
2340
2611
  */
2341
2612
  ElasticResizeNumberOfNodeOptions?: string;
2342
2613
  /**
2614
+ * @public
2343
2615
  * <p>Describes a group of <code>DeferredMaintenanceWindow</code> objects.</p>
2344
2616
  */
2345
2617
  DeferredMaintenanceWindows?: DeferredMaintenanceWindow[];
2346
2618
  /**
2619
+ * @public
2347
2620
  * <p>A unique identifier for the cluster snapshot schedule.</p>
2348
2621
  */
2349
2622
  SnapshotScheduleIdentifier?: string;
2350
2623
  /**
2624
+ * @public
2351
2625
  * <p>The current state of the cluster snapshot schedule.</p>
2352
2626
  */
2353
2627
  SnapshotScheduleState?: ScheduleState | string;
2354
2628
  /**
2629
+ * @public
2355
2630
  * <p>The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled. </p>
2356
2631
  */
2357
2632
  ExpectedNextSnapshotScheduleTime?: Date;
2358
2633
  /**
2634
+ * @public
2359
2635
  * <p> The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:</p>
2360
2636
  * <ul>
2361
2637
  * <li>
@@ -2368,10 +2644,12 @@ export interface Cluster {
2368
2644
  */
2369
2645
  ExpectedNextSnapshotScheduleTimeStatus?: string;
2370
2646
  /**
2647
+ * @public
2371
2648
  * <p>The date and time in UTC when system maintenance can begin.</p>
2372
2649
  */
2373
2650
  NextMaintenanceWindowStartTime?: Date;
2374
2651
  /**
2652
+ * @public
2375
2653
  * <p>Returns the following:</p>
2376
2654
  * <ul>
2377
2655
  * <li>
@@ -2385,38 +2663,47 @@ export interface Cluster {
2385
2663
  */
2386
2664
  ResizeInfo?: ResizeInfo;
2387
2665
  /**
2666
+ * @public
2388
2667
  * <p>Describes the status of the Availability Zone relocation operation.</p>
2389
2668
  */
2390
2669
  AvailabilityZoneRelocationStatus?: string;
2391
2670
  /**
2671
+ * @public
2392
2672
  * <p>The namespace Amazon Resource Name (ARN) of the cluster.</p>
2393
2673
  */
2394
2674
  ClusterNamespaceArn?: string;
2395
2675
  /**
2676
+ * @public
2396
2677
  * <p>The total storage capacity of the cluster in megabytes. </p>
2397
2678
  */
2398
2679
  TotalStorageCapacityInMegaBytes?: number;
2399
2680
  /**
2681
+ * @public
2400
2682
  * <p>This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).</p>
2401
2683
  */
2402
2684
  AquaConfiguration?: AquaConfiguration;
2403
2685
  /**
2686
+ * @public
2404
2687
  * <p>The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.</p>
2405
2688
  */
2406
2689
  DefaultIamRoleArn?: string;
2407
2690
  /**
2691
+ * @public
2408
2692
  * <p>The status of the reserved-node exchange request. Statuses include in-progress and requested.</p>
2409
2693
  */
2410
2694
  ReservedNodeExchangeStatus?: ReservedNodeExchangeStatus;
2411
2695
  /**
2696
+ * @public
2412
2697
  * <p>The custom domain name associated with the cluster.</p>
2413
2698
  */
2414
2699
  CustomDomainName?: string;
2415
2700
  /**
2701
+ * @public
2416
2702
  * <p>The certificate Amazon Resource Name (ARN) for the custom domain name.</p>
2417
2703
  */
2418
2704
  CustomDomainCertificateArn?: string;
2419
2705
  /**
2706
+ * @public
2420
2707
  * <p>The expiration date for the certificate associated with the custom domain name.</p>
2421
2708
  */
2422
2709
  CustomDomainCertificateExpiryDate?: Date;
@@ -2440,6 +2727,7 @@ export declare class ClusterAlreadyExistsFault extends __BaseException {
2440
2727
  */
2441
2728
  export interface ClusterCredentials {
2442
2729
  /**
2730
+ * @public
2443
2731
  * <p>A database user name that is authorized to log on to the database <code>DbName</code>
2444
2732
  * using the password <code>DbPassword</code>. If the specified DbUser exists in the
2445
2733
  * database, the new user name has the same database permissions as the the user named in
@@ -2449,11 +2737,13 @@ export interface ClusterCredentials {
2449
2737
  */
2450
2738
  DbUser?: string;
2451
2739
  /**
2740
+ * @public
2452
2741
  * <p>A temporary password that authorizes the user name returned by <code>DbUser</code>
2453
2742
  * to log on to the database <code>DbName</code>. </p>
2454
2743
  */
2455
2744
  DbPassword?: string;
2456
2745
  /**
2746
+ * @public
2457
2747
  * <p>The date and time the password in <code>DbPassword</code> expires.</p>
2458
2748
  */
2459
2749
  Expiration?: Date;
@@ -2464,16 +2754,19 @@ export interface ClusterCredentials {
2464
2754
  */
2465
2755
  export interface RevisionTarget {
2466
2756
  /**
2757
+ * @public
2467
2758
  * <p>A unique string that identifies the version to update the cluster to. You can use this
2468
2759
  * value in <a>ModifyClusterDbRevision</a>.</p>
2469
2760
  */
2470
2761
  DatabaseRevision?: string;
2471
2762
  /**
2763
+ * @public
2472
2764
  * <p>A string that describes the changes and features that will be applied to the cluster
2473
2765
  * when it is updated to the corresponding <a>ClusterDbRevision</a>.</p>
2474
2766
  */
2475
2767
  Description?: string;
2476
2768
  /**
2769
+ * @public
2477
2770
  * <p>The date on which the database revision was released.</p>
2478
2771
  */
2479
2772
  DatabaseRevisionReleaseDate?: Date;
@@ -2484,18 +2777,22 @@ export interface RevisionTarget {
2484
2777
  */
2485
2778
  export interface ClusterDbRevision {
2486
2779
  /**
2780
+ * @public
2487
2781
  * <p>The unique identifier of the cluster.</p>
2488
2782
  */
2489
2783
  ClusterIdentifier?: string;
2490
2784
  /**
2785
+ * @public
2491
2786
  * <p>A string representing the current cluster version.</p>
2492
2787
  */
2493
2788
  CurrentDatabaseRevision?: string;
2494
2789
  /**
2790
+ * @public
2495
2791
  * <p>The date on which the database revision was released.</p>
2496
2792
  */
2497
2793
  DatabaseRevisionReleaseDate?: Date;
2498
2794
  /**
2795
+ * @public
2499
2796
  * <p>A list of <code>RevisionTarget</code> objects, where each object describes the
2500
2797
  * database revision that a cluster can be updated to.</p>
2501
2798
  */
@@ -2506,6 +2803,7 @@ export interface ClusterDbRevision {
2506
2803
  */
2507
2804
  export interface ClusterDbRevisionsMessage {
2508
2805
  /**
2806
+ * @public
2509
2807
  * <p>A string representing the starting point for the next set of revisions. If a value is
2510
2808
  * returned in a response, you can retrieve the next set of revisions by providing the
2511
2809
  * value in the <code>marker</code> parameter and retrying the command. If the
@@ -2513,6 +2811,7 @@ export interface ClusterDbRevisionsMessage {
2513
2811
  */
2514
2812
  Marker?: string;
2515
2813
  /**
2814
+ * @public
2516
2815
  * <p>A list of revisions.</p>
2517
2816
  */
2518
2817
  ClusterDbRevisions?: ClusterDbRevision[];
@@ -2522,18 +2821,22 @@ export interface ClusterDbRevisionsMessage {
2522
2821
  */
2523
2822
  export interface ClusterExtendedCredentials {
2524
2823
  /**
2824
+ * @public
2525
2825
  * <p>A database user name that you provide when you connect to a database. The database user is mapped 1:1 to the source IAM identity. </p>
2526
2826
  */
2527
2827
  DbUser?: string;
2528
2828
  /**
2829
+ * @public
2529
2830
  * <p>A temporary password that you provide when you connect to a database.</p>
2530
2831
  */
2531
2832
  DbPassword?: string;
2532
2833
  /**
2834
+ * @public
2533
2835
  * <p>The time (UTC) when the temporary password expires. After this timestamp, a log in with the temporary password fails.</p>
2534
2836
  */
2535
2837
  Expiration?: Date;
2536
2838
  /**
2839
+ * @public
2537
2840
  * <p>Reserved for future use.</p>
2538
2841
  */
2539
2842
  NextRefreshTime?: Date;
@@ -2556,19 +2859,23 @@ export declare class ClusterOnLatestRevisionFault extends __BaseException {
2556
2859
  */
2557
2860
  export interface ClusterParameterGroup {
2558
2861
  /**
2862
+ * @public
2559
2863
  * <p>The name of the cluster parameter group.</p>
2560
2864
  */
2561
2865
  ParameterGroupName?: string;
2562
2866
  /**
2867
+ * @public
2563
2868
  * <p>The name of the cluster parameter group family that this cluster parameter group is
2564
2869
  * compatible with.</p>
2565
2870
  */
2566
2871
  ParameterGroupFamily?: string;
2567
2872
  /**
2873
+ * @public
2568
2874
  * <p>The description of the parameter group.</p>
2569
2875
  */
2570
2876
  Description?: string;
2571
2877
  /**
2878
+ * @public
2572
2879
  * <p>The list of tags for the cluster parameter group.</p>
2573
2880
  */
2574
2881
  Tags?: Tag[];
@@ -2603,31 +2910,38 @@ export type ParameterApplyType = (typeof ParameterApplyType)[keyof typeof Parame
2603
2910
  */
2604
2911
  export interface Parameter {
2605
2912
  /**
2913
+ * @public
2606
2914
  * <p>The name of the parameter.</p>
2607
2915
  */
2608
2916
  ParameterName?: string;
2609
2917
  /**
2918
+ * @public
2610
2919
  * <p>The value of the parameter. If <code>ParameterName</code> is <code>wlm_json_configuration</code>,
2611
2920
  * then the maximum size of <code>ParameterValue</code> is 8000 characters.</p>
2612
2921
  */
2613
2922
  ParameterValue?: string;
2614
2923
  /**
2924
+ * @public
2615
2925
  * <p>A description of the parameter.</p>
2616
2926
  */
2617
2927
  Description?: string;
2618
2928
  /**
2929
+ * @public
2619
2930
  * <p>The source of the parameter value, such as "engine-default" or "user".</p>
2620
2931
  */
2621
2932
  Source?: string;
2622
2933
  /**
2934
+ * @public
2623
2935
  * <p>The data type of the parameter.</p>
2624
2936
  */
2625
2937
  DataType?: string;
2626
2938
  /**
2939
+ * @public
2627
2940
  * <p>The valid range of values for the parameter.</p>
2628
2941
  */
2629
2942
  AllowedValues?: string;
2630
2943
  /**
2944
+ * @public
2631
2945
  * <p>Specifies how to apply the WLM configuration parameter. Some properties can be
2632
2946
  * applied dynamically, while other properties require that any associated clusters be
2633
2947
  * rebooted for the configuration changes to be applied.
@@ -2637,11 +2951,13 @@ export interface Parameter {
2637
2951
  */
2638
2952
  ApplyType?: ParameterApplyType | string;
2639
2953
  /**
2954
+ * @public
2640
2955
  * <p>If <code>true</code>, the parameter can be modified. Some parameters have security
2641
2956
  * or operational implications that prevent them from being changed. </p>
2642
2957
  */
2643
2958
  IsModifiable?: boolean;
2644
2959
  /**
2960
+ * @public
2645
2961
  * <p>The earliest engine version to which the parameter can apply.</p>
2646
2962
  */
2647
2963
  MinimumEngineVersion?: string;
@@ -2653,11 +2969,13 @@ export interface Parameter {
2653
2969
  */
2654
2970
  export interface ClusterParameterGroupDetails {
2655
2971
  /**
2972
+ * @public
2656
2973
  * <p>A list of <a>Parameter</a> instances. Each instance lists the parameters
2657
2974
  * of one cluster parameter group. </p>
2658
2975
  */
2659
2976
  Parameters?: Parameter[];
2660
2977
  /**
2978
+ * @public
2661
2979
  * <p>A value that indicates the starting point for the next set of response records in a
2662
2980
  * subsequent request. If a value is returned in a response, you can retrieve the next set
2663
2981
  * of records by providing this returned marker value in the <code>Marker</code> parameter
@@ -2672,10 +2990,12 @@ export interface ClusterParameterGroupDetails {
2672
2990
  */
2673
2991
  export interface ClusterParameterGroupNameMessage {
2674
2992
  /**
2993
+ * @public
2675
2994
  * <p>The name of the cluster parameter group.</p>
2676
2995
  */
2677
2996
  ParameterGroupName?: string;
2678
2997
  /**
2998
+ * @public
2679
2999
  * <p>The status of the parameter group. For example, if you made a change to a parameter
2680
3000
  * group name-value pair, then the change could be pending a reboot of an associated
2681
3001
  * cluster.</p>
@@ -2717,6 +3037,7 @@ export declare class ClusterParameterGroupQuotaExceededFault extends __BaseExcep
2717
3037
  */
2718
3038
  export interface ClusterParameterGroupsMessage {
2719
3039
  /**
3040
+ * @public
2720
3041
  * <p>A value that indicates the starting point for the next set of response records in a
2721
3042
  * subsequent request. If a value is returned in a response, you can retrieve the next set
2722
3043
  * of records by providing this returned marker value in the <code>Marker</code> parameter
@@ -2725,6 +3046,7 @@ export interface ClusterParameterGroupsMessage {
2725
3046
  */
2726
3047
  Marker?: string;
2727
3048
  /**
3049
+ * @public
2728
3050
  * <p>A list of <a>ClusterParameterGroup</a> instances. Each instance
2729
3051
  * describes one cluster parameter group. </p>
2730
3052
  */
@@ -2764,6 +3086,7 @@ export declare class ClusterSecurityGroupAlreadyExistsFault extends __BaseExcept
2764
3086
  */
2765
3087
  export interface ClusterSecurityGroupMessage {
2766
3088
  /**
3089
+ * @public
2767
3090
  * <p>A value that indicates the starting point for the next set of response records in a
2768
3091
  * subsequent request. If a value is returned in a response, you can retrieve the next set
2769
3092
  * of records by providing this returned marker value in the <code>Marker</code> parameter
@@ -2772,6 +3095,7 @@ export interface ClusterSecurityGroupMessage {
2772
3095
  */
2773
3096
  Marker?: string;
2774
3097
  /**
3098
+ * @public
2775
3099
  * <p>A list of <a>ClusterSecurityGroup</a> instances. </p>
2776
3100
  */
2777
3101
  ClusterSecurityGroups?: ClusterSecurityGroup[];
@@ -2798,6 +3122,7 @@ export declare class ClusterSecurityGroupQuotaExceededFault extends __BaseExcept
2798
3122
  */
2799
3123
  export interface ClustersMessage {
2800
3124
  /**
3125
+ * @public
2801
3126
  * <p>A value that indicates the starting point for the next set of response records in a
2802
3127
  * subsequent request. If a value is returned in a response, you can retrieve the next set
2803
3128
  * of records by providing this returned marker value in the <code>Marker</code> parameter
@@ -2806,6 +3131,7 @@ export interface ClustersMessage {
2806
3131
  */
2807
3132
  Marker?: string;
2808
3133
  /**
3134
+ * @public
2809
3135
  * <p>A list of <code>Cluster</code> objects, where each object describes one cluster.
2810
3136
  * </p>
2811
3137
  */
@@ -2843,14 +3169,17 @@ export declare class ClusterSnapshotQuotaExceededFault extends __BaseException {
2843
3169
  */
2844
3170
  export interface Subnet {
2845
3171
  /**
3172
+ * @public
2846
3173
  * <p>The identifier of the subnet.</p>
2847
3174
  */
2848
3175
  SubnetIdentifier?: string;
2849
3176
  /**
3177
+ * @public
2850
3178
  * <p></p>
2851
3179
  */
2852
3180
  SubnetAvailabilityZone?: AvailabilityZone;
2853
3181
  /**
3182
+ * @public
2854
3183
  * <p>The status of the subnet.</p>
2855
3184
  */
2856
3185
  SubnetStatus?: string;
@@ -2861,27 +3190,33 @@ export interface Subnet {
2861
3190
  */
2862
3191
  export interface ClusterSubnetGroup {
2863
3192
  /**
3193
+ * @public
2864
3194
  * <p>The name of the cluster subnet group.</p>
2865
3195
  */
2866
3196
  ClusterSubnetGroupName?: string;
2867
3197
  /**
3198
+ * @public
2868
3199
  * <p>The description of the cluster subnet group.</p>
2869
3200
  */
2870
3201
  Description?: string;
2871
3202
  /**
3203
+ * @public
2872
3204
  * <p>The VPC ID of the cluster subnet group.</p>
2873
3205
  */
2874
3206
  VpcId?: string;
2875
3207
  /**
3208
+ * @public
2876
3209
  * <p>The status of the cluster subnet group. Possible values are <code>Complete</code>,
2877
3210
  * <code>Incomplete</code> and <code>Invalid</code>. </p>
2878
3211
  */
2879
3212
  SubnetGroupStatus?: string;
2880
3213
  /**
3214
+ * @public
2881
3215
  * <p>A list of the VPC <a>Subnet</a> elements. </p>
2882
3216
  */
2883
3217
  Subnets?: Subnet[];
2884
3218
  /**
3219
+ * @public
2885
3220
  * <p>The list of tags for the cluster subnet group.</p>
2886
3221
  */
2887
3222
  Tags?: Tag[];
@@ -2906,6 +3241,7 @@ export declare class ClusterSubnetGroupAlreadyExistsFault extends __BaseExceptio
2906
3241
  */
2907
3242
  export interface ClusterSubnetGroupMessage {
2908
3243
  /**
3244
+ * @public
2909
3245
  * <p>A value that indicates the starting point for the next set of response records in a
2910
3246
  * subsequent request. If a value is returned in a response, you can retrieve the next set
2911
3247
  * of records by providing this returned marker value in the <code>Marker</code> parameter
@@ -2914,6 +3250,7 @@ export interface ClusterSubnetGroupMessage {
2914
3250
  */
2915
3251
  Marker?: string;
2916
3252
  /**
3253
+ * @public
2917
3254
  * <p>A list of <a>ClusterSubnetGroup</a> instances. </p>
2918
3255
  */
2919
3256
  ClusterSubnetGroups?: ClusterSubnetGroup[];
@@ -2970,14 +3307,17 @@ export declare class ClusterSubnetQuotaExceededFault extends __BaseException {
2970
3307
  */
2971
3308
  export interface ClusterVersion {
2972
3309
  /**
3310
+ * @public
2973
3311
  * <p>The version number used by the cluster.</p>
2974
3312
  */
2975
3313
  ClusterVersion?: string;
2976
3314
  /**
3315
+ * @public
2977
3316
  * <p>The name of the cluster parameter group family for the cluster.</p>
2978
3317
  */
2979
3318
  ClusterParameterGroupFamily?: string;
2980
3319
  /**
3320
+ * @public
2981
3321
  * <p>The description of the cluster version.</p>
2982
3322
  */
2983
3323
  Description?: string;
@@ -2989,6 +3329,7 @@ export interface ClusterVersion {
2989
3329
  */
2990
3330
  export interface ClusterVersionsMessage {
2991
3331
  /**
3332
+ * @public
2992
3333
  * <p>A value that indicates the starting point for the next set of response records in a
2993
3334
  * subsequent request. If a value is returned in a response, you can retrieve the next set
2994
3335
  * of records by providing this returned marker value in the <code>Marker</code> parameter
@@ -2997,6 +3338,7 @@ export interface ClusterVersionsMessage {
2997
3338
  */
2998
3339
  Marker?: string;
2999
3340
  /**
3341
+ * @public
3000
3342
  * <p>A list of <code>Version</code> elements. </p>
3001
3343
  */
3002
3344
  ClusterVersions?: ClusterVersion[];
@@ -3007,6 +3349,7 @@ export interface ClusterVersionsMessage {
3007
3349
  */
3008
3350
  export interface CopyClusterSnapshotMessage {
3009
3351
  /**
3352
+ * @public
3010
3353
  * <p>The identifier for the source snapshot.</p>
3011
3354
  * <p>Constraints:</p>
3012
3355
  * <ul>
@@ -3018,6 +3361,7 @@ export interface CopyClusterSnapshotMessage {
3018
3361
  */
3019
3362
  SourceSnapshotIdentifier: string | undefined;
3020
3363
  /**
3364
+ * @public
3021
3365
  * <p>The identifier of the cluster the source snapshot was created from. This parameter
3022
3366
  * is required if your IAM user has a policy containing a snapshot resource element that
3023
3367
  * specifies anything other than * for the cluster name.</p>
@@ -3030,6 +3374,7 @@ export interface CopyClusterSnapshotMessage {
3030
3374
  */
3031
3375
  SourceSnapshotClusterIdentifier?: string;
3032
3376
  /**
3377
+ * @public
3033
3378
  * <p>The identifier given to the new manual snapshot.</p>
3034
3379
  * <p>Constraints:</p>
3035
3380
  * <ul>
@@ -3052,6 +3397,7 @@ export interface CopyClusterSnapshotMessage {
3052
3397
  */
3053
3398
  TargetSnapshotIdentifier: string | undefined;
3054
3399
  /**
3400
+ * @public
3055
3401
  * <p>The number of days that a manual snapshot is retained. If the value is -1, the manual
3056
3402
  * snapshot is retained indefinitely. </p>
3057
3403
  * <p>The value must be either -1 or an integer between 1 and 3,653.</p>
@@ -3064,6 +3410,7 @@ export interface CopyClusterSnapshotMessage {
3064
3410
  */
3065
3411
  export interface CopyClusterSnapshotResult {
3066
3412
  /**
3413
+ * @public
3067
3414
  * <p>Describes a snapshot.</p>
3068
3415
  */
3069
3416
  Snapshot?: Snapshot;
@@ -3086,10 +3433,12 @@ export declare class CopyToRegionDisabledFault extends __BaseException {
3086
3433
  */
3087
3434
  export interface CreateAuthenticationProfileMessage {
3088
3435
  /**
3436
+ * @public
3089
3437
  * <p>The name of the authentication profile to be created.</p>
3090
3438
  */
3091
3439
  AuthenticationProfileName: string | undefined;
3092
3440
  /**
3441
+ * @public
3093
3442
  * <p>The content of the authentication profile in JSON format.
3094
3443
  * The maximum length of the JSON string is determined by a quota for your account.</p>
3095
3444
  */
@@ -3100,10 +3449,12 @@ export interface CreateAuthenticationProfileMessage {
3100
3449
  */
3101
3450
  export interface CreateAuthenticationProfileResult {
3102
3451
  /**
3452
+ * @public
3103
3453
  * <p>The name of the authentication profile that was created.</p>
3104
3454
  */
3105
3455
  AuthenticationProfileName?: string;
3106
3456
  /**
3457
+ * @public
3107
3458
  * <p>The content of the authentication profile in JSON format.</p>
3108
3459
  */
3109
3460
  AuthenticationProfileContent?: string;
@@ -3127,6 +3478,7 @@ export declare class InvalidAuthenticationProfileRequestFault extends __BaseExce
3127
3478
  */
3128
3479
  export interface CreateClusterMessage {
3129
3480
  /**
3481
+ * @public
3130
3482
  * <p>The name of the first database to be created when the cluster is created.</p>
3131
3483
  * <p>To create additional databases after the cluster is created, connect to the cluster
3132
3484
  * with a SQL client and use SQL commands to create a database. For more information, go to
@@ -3151,6 +3503,7 @@ export interface CreateClusterMessage {
3151
3503
  */
3152
3504
  DBName?: string;
3153
3505
  /**
3506
+ * @public
3154
3507
  * <p>A unique identifier for the cluster. You use this identifier to refer to the
3155
3508
  * cluster for any subsequent cluster operations such as deleting or modifying. The
3156
3509
  * identifier also appears in the Amazon Redshift console.</p>
@@ -3177,6 +3530,7 @@ export interface CreateClusterMessage {
3177
3530
  */
3178
3531
  ClusterIdentifier: string | undefined;
3179
3532
  /**
3533
+ * @public
3180
3534
  * <p>The type of the cluster. When cluster type is specified as</p>
3181
3535
  * <ul>
3182
3536
  * <li>
@@ -3197,6 +3551,7 @@ export interface CreateClusterMessage {
3197
3551
  */
3198
3552
  ClusterType?: string;
3199
3553
  /**
3554
+ * @public
3200
3555
  * <p>The node type to be provisioned for the cluster. For information about node types,
3201
3556
  * go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes"> Working with
3202
3557
  * Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </p>
@@ -3208,6 +3563,7 @@ export interface CreateClusterMessage {
3208
3563
  */
3209
3564
  NodeType: string | undefined;
3210
3565
  /**
3566
+ * @public
3211
3567
  * <p>The user name associated with the admin user account for the cluster that is being
3212
3568
  * created.</p>
3213
3569
  * <p>Constraints:</p>
@@ -3233,6 +3589,7 @@ export interface CreateClusterMessage {
3233
3589
  */
3234
3590
  MasterUsername: string | undefined;
3235
3591
  /**
3592
+ * @public
3236
3593
  * <p>The password associated with the admin user account for the cluster that is being
3237
3594
  * created.</p>
3238
3595
  * <p>Constraints:</p>
@@ -3257,23 +3614,27 @@ export interface CreateClusterMessage {
3257
3614
  */
3258
3615
  MasterUserPassword: string | undefined;
3259
3616
  /**
3617
+ * @public
3260
3618
  * <p>A list of security groups to be associated with this cluster.</p>
3261
3619
  * <p>Default: The default cluster security group for Amazon Redshift.</p>
3262
3620
  */
3263
3621
  ClusterSecurityGroups?: string[];
3264
3622
  /**
3623
+ * @public
3265
3624
  * <p>A list of Virtual Private Cloud (VPC) security groups to be associated with the
3266
3625
  * cluster.</p>
3267
3626
  * <p>Default: The default VPC security group is associated with the cluster.</p>
3268
3627
  */
3269
3628
  VpcSecurityGroupIds?: string[];
3270
3629
  /**
3630
+ * @public
3271
3631
  * <p>The name of a cluster subnet group to be associated with this cluster.</p>
3272
3632
  * <p>If this parameter is not provided the resulting cluster will be deployed outside
3273
3633
  * virtual private cloud (VPC).</p>
3274
3634
  */
3275
3635
  ClusterSubnetGroupName?: string;
3276
3636
  /**
3637
+ * @public
3277
3638
  * <p>The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the
3278
3639
  * cluster. For example, if you have several EC2 instances running in a specific
3279
3640
  * Availability Zone, then you might want the cluster to be provisioned in the same zone in
@@ -3287,6 +3648,7 @@ export interface CreateClusterMessage {
3287
3648
  */
3288
3649
  AvailabilityZone?: string;
3289
3650
  /**
3651
+ * @public
3290
3652
  * <p>The weekly time range (in UTC) during which automated cluster maintenance can
3291
3653
  * occur.</p>
3292
3654
  * <p> Format: <code>ddd:hh24:mi-ddd:hh24:mi</code>
@@ -3299,6 +3661,7 @@ export interface CreateClusterMessage {
3299
3661
  */
3300
3662
  PreferredMaintenanceWindow?: string;
3301
3663
  /**
3664
+ * @public
3302
3665
  * <p>The name of the parameter group to be associated with this cluster.</p>
3303
3666
  * <p>Default: The default Amazon Redshift cluster parameter group. For information about the
3304
3667
  * default parameter group, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Working with Amazon
@@ -3319,6 +3682,7 @@ export interface CreateClusterMessage {
3319
3682
  */
3320
3683
  ClusterParameterGroupName?: string;
3321
3684
  /**
3685
+ * @public
3322
3686
  * <p>The number of days that automated snapshots are retained. If the value is 0,
3323
3687
  * automated snapshots are disabled. Even if automated snapshots are disabled, you can
3324
3688
  * still create manual snapshots when you want with <a>CreateClusterSnapshot</a>. </p>
@@ -3329,6 +3693,7 @@ export interface CreateClusterMessage {
3329
3693
  */
3330
3694
  AutomatedSnapshotRetentionPeriod?: number;
3331
3695
  /**
3696
+ * @public
3332
3697
  * <p>The default number of days to retain a manual snapshot. If the value is -1, the
3333
3698
  * snapshot is retained indefinitely. This setting doesn't change the retention period
3334
3699
  * of existing snapshots.</p>
@@ -3336,6 +3701,7 @@ export interface CreateClusterMessage {
3336
3701
  */
3337
3702
  ManualSnapshotRetentionPeriod?: number;
3338
3703
  /**
3704
+ * @public
3339
3705
  * <p>The port number on which the cluster accepts incoming connections.</p>
3340
3706
  * <p>The cluster is accessible only via the JDBC and ODBC connection strings. Part of
3341
3707
  * the connection string requires the port on which the cluster will listen for incoming
@@ -3347,6 +3713,7 @@ export interface CreateClusterMessage {
3347
3713
  */
3348
3714
  Port?: number;
3349
3715
  /**
3716
+ * @public
3350
3717
  * <p>The version of the Amazon Redshift engine software that you want to deploy on the
3351
3718
  * cluster.</p>
3352
3719
  * <p>The version selected runs on all the nodes in the cluster.</p>
@@ -3356,6 +3723,7 @@ export interface CreateClusterMessage {
3356
3723
  */
3357
3724
  ClusterVersion?: string;
3358
3725
  /**
3726
+ * @public
3359
3727
  * <p>If <code>true</code>, major version upgrades can be applied during the maintenance
3360
3728
  * window to the Amazon Redshift engine that is running on the cluster.</p>
3361
3729
  * <p>When a new major version of the Amazon Redshift engine is released, you can request that
@@ -3366,6 +3734,7 @@ export interface CreateClusterMessage {
3366
3734
  */
3367
3735
  AllowVersionUpgrade?: boolean;
3368
3736
  /**
3737
+ * @public
3369
3738
  * <p>The number of compute nodes in the cluster. This parameter is required when the
3370
3739
  * <b>ClusterType</b> parameter is specified as
3371
3740
  * <code>multi-node</code>. </p>
@@ -3380,25 +3749,30 @@ export interface CreateClusterMessage {
3380
3749
  */
3381
3750
  NumberOfNodes?: number;
3382
3751
  /**
3752
+ * @public
3383
3753
  * <p>If <code>true</code>, the cluster can be accessed from a public network. </p>
3384
3754
  */
3385
3755
  PubliclyAccessible?: boolean;
3386
3756
  /**
3757
+ * @public
3387
3758
  * <p>If <code>true</code>, the data in the cluster is encrypted at rest. </p>
3388
3759
  * <p>Default: false</p>
3389
3760
  */
3390
3761
  Encrypted?: boolean;
3391
3762
  /**
3763
+ * @public
3392
3764
  * <p>Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to
3393
3765
  * retrieve the data encryption keys stored in an HSM.</p>
3394
3766
  */
3395
3767
  HsmClientCertificateIdentifier?: string;
3396
3768
  /**
3769
+ * @public
3397
3770
  * <p>Specifies the name of the HSM configuration that contains the information the
3398
3771
  * Amazon Redshift cluster can use to retrieve and store keys in an HSM.</p>
3399
3772
  */
3400
3773
  HsmConfigurationIdentifier?: string;
3401
3774
  /**
3775
+ * @public
3402
3776
  * <p>The Elastic IP (EIP) address for the cluster.</p>
3403
3777
  * <p>Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible
3404
3778
  * through an Internet gateway. Don't specify the Elastic IP address for a publicly accessible
@@ -3408,15 +3782,18 @@ export interface CreateClusterMessage {
3408
3782
  */
3409
3783
  ElasticIp?: string;
3410
3784
  /**
3785
+ * @public
3411
3786
  * <p>A list of tag instances.</p>
3412
3787
  */
3413
3788
  Tags?: Tag[];
3414
3789
  /**
3790
+ * @public
3415
3791
  * <p>The Key Management Service (KMS) key ID of the encryption key that you want to
3416
3792
  * use to encrypt data in the cluster.</p>
3417
3793
  */
3418
3794
  KmsKeyId?: string;
3419
3795
  /**
3796
+ * @public
3420
3797
  * <p>An option that specifies whether to create the cluster with enhanced VPC routing
3421
3798
  * enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a
3422
3799
  * VPC. For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in
@@ -3426,10 +3803,12 @@ export interface CreateClusterMessage {
3426
3803
  */
3427
3804
  EnhancedVpcRouting?: boolean;
3428
3805
  /**
3806
+ * @public
3429
3807
  * <p>Reserved.</p>
3430
3808
  */
3431
3809
  AdditionalInfo?: string;
3432
3810
  /**
3811
+ * @public
3433
3812
  * <p>A list of Identity and Access Management (IAM) roles that can be used by the
3434
3813
  * cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon
3435
3814
  * Resource Name (ARN) format. </p>
@@ -3439,28 +3818,34 @@ export interface CreateClusterMessage {
3439
3818
  */
3440
3819
  IamRoles?: string[];
3441
3820
  /**
3821
+ * @public
3442
3822
  * <p>An optional parameter for the name of the maintenance track for the cluster. If you
3443
3823
  * don't provide a maintenance track name, the cluster is assigned to the
3444
3824
  * <code>current</code> track.</p>
3445
3825
  */
3446
3826
  MaintenanceTrackName?: string;
3447
3827
  /**
3828
+ * @public
3448
3829
  * <p>A unique identifier for the snapshot schedule.</p>
3449
3830
  */
3450
3831
  SnapshotScheduleIdentifier?: string;
3451
3832
  /**
3833
+ * @public
3452
3834
  * <p>The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.</p>
3453
3835
  */
3454
3836
  AvailabilityZoneRelocation?: boolean;
3455
3837
  /**
3838
+ * @public
3456
3839
  * <p>This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).</p>
3457
3840
  */
3458
3841
  AquaConfigurationStatus?: AquaConfigurationStatus | string;
3459
3842
  /**
3843
+ * @public
3460
3844
  * <p>The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created. </p>
3461
3845
  */
3462
3846
  DefaultIamRoleArn?: string;
3463
3847
  /**
3848
+ * @public
3464
3849
  * <p>A flag that specifies whether to load sample data once the cluster is created.</p>
3465
3850
  */
3466
3851
  LoadSampleData?: string;
@@ -3470,6 +3855,7 @@ export interface CreateClusterMessage {
3470
3855
  */
3471
3856
  export interface CreateClusterResult {
3472
3857
  /**
3858
+ * @public
3473
3859
  * <p>Describes a cluster.</p>
3474
3860
  */
3475
3861
  Cluster?: Cluster;
@@ -3655,6 +4041,7 @@ export declare class UnauthorizedOperation extends __BaseException {
3655
4041
  */
3656
4042
  export interface CreateClusterParameterGroupMessage {
3657
4043
  /**
4044
+ * @public
3658
4045
  * <p>The name of the cluster parameter group.</p>
3659
4046
  * <p>Constraints:</p>
3660
4047
  * <ul>
@@ -3677,6 +4064,7 @@ export interface CreateClusterParameterGroupMessage {
3677
4064
  */
3678
4065
  ParameterGroupName: string | undefined;
3679
4066
  /**
4067
+ * @public
3680
4068
  * <p>The Amazon Redshift engine version to which the cluster parameter group applies. The
3681
4069
  * cluster engine version determines the set of parameters.</p>
3682
4070
  * <p>To get a list of valid parameter group family names, you can call <a>DescribeClusterParameterGroups</a>. By default, Amazon Redshift returns a list of
@@ -3687,10 +4075,12 @@ export interface CreateClusterParameterGroupMessage {
3687
4075
  */
3688
4076
  ParameterGroupFamily: string | undefined;
3689
4077
  /**
4078
+ * @public
3690
4079
  * <p>A description of the parameter group.</p>
3691
4080
  */
3692
4081
  Description: string | undefined;
3693
4082
  /**
4083
+ * @public
3694
4084
  * <p>A list of tag instances.</p>
3695
4085
  */
3696
4086
  Tags?: Tag[];
@@ -3700,6 +4090,7 @@ export interface CreateClusterParameterGroupMessage {
3700
4090
  */
3701
4091
  export interface CreateClusterParameterGroupResult {
3702
4092
  /**
4093
+ * @public
3703
4094
  * <p>Describes a parameter group.</p>
3704
4095
  */
3705
4096
  ClusterParameterGroup?: ClusterParameterGroup;
@@ -3710,6 +4101,7 @@ export interface CreateClusterParameterGroupResult {
3710
4101
  */
3711
4102
  export interface CreateClusterSecurityGroupMessage {
3712
4103
  /**
4104
+ * @public
3713
4105
  * <p>The name for the security group. Amazon Redshift stores the value as a lowercase
3714
4106
  * string.</p>
3715
4107
  * <p>Constraints:</p>
@@ -3729,10 +4121,12 @@ export interface CreateClusterSecurityGroupMessage {
3729
4121
  */
3730
4122
  ClusterSecurityGroupName: string | undefined;
3731
4123
  /**
4124
+ * @public
3732
4125
  * <p>A description for the security group.</p>
3733
4126
  */
3734
4127
  Description: string | undefined;
3735
4128
  /**
4129
+ * @public
3736
4130
  * <p>A list of tag instances.</p>
3737
4131
  */
3738
4132
  Tags?: Tag[];
@@ -3742,6 +4136,7 @@ export interface CreateClusterSecurityGroupMessage {
3742
4136
  */
3743
4137
  export interface CreateClusterSecurityGroupResult {
3744
4138
  /**
4139
+ * @public
3745
4140
  * <p>Describes a security group.</p>
3746
4141
  */
3747
4142
  ClusterSecurityGroup?: ClusterSecurityGroup;
@@ -3752,6 +4147,7 @@ export interface CreateClusterSecurityGroupResult {
3752
4147
  */
3753
4148
  export interface CreateClusterSnapshotMessage {
3754
4149
  /**
4150
+ * @public
3755
4151
  * <p>A unique identifier for the snapshot that you are requesting. This identifier must
3756
4152
  * be unique for all snapshots within the Amazon Web Services account.</p>
3757
4153
  * <p>Constraints:</p>
@@ -3774,10 +4170,12 @@ export interface CreateClusterSnapshotMessage {
3774
4170
  */
3775
4171
  SnapshotIdentifier: string | undefined;
3776
4172
  /**
4173
+ * @public
3777
4174
  * <p>The cluster identifier for which you want a snapshot.</p>
3778
4175
  */
3779
4176
  ClusterIdentifier: string | undefined;
3780
4177
  /**
4178
+ * @public
3781
4179
  * <p>The number of days that a manual snapshot is retained. If the value is -1, the manual
3782
4180
  * snapshot is retained indefinitely. </p>
3783
4181
  * <p>The value must be either -1 or an integer between 1 and 3,653.</p>
@@ -3785,6 +4183,7 @@ export interface CreateClusterSnapshotMessage {
3785
4183
  */
3786
4184
  ManualSnapshotRetentionPeriod?: number;
3787
4185
  /**
4186
+ * @public
3788
4187
  * <p>A list of tag instances.</p>
3789
4188
  */
3790
4189
  Tags?: Tag[];
@@ -3794,6 +4193,7 @@ export interface CreateClusterSnapshotMessage {
3794
4193
  */
3795
4194
  export interface CreateClusterSnapshotResult {
3796
4195
  /**
4196
+ * @public
3797
4197
  * <p>Describes a snapshot.</p>
3798
4198
  */
3799
4199
  Snapshot?: Snapshot;
@@ -3804,6 +4204,7 @@ export interface CreateClusterSnapshotResult {
3804
4204
  */
3805
4205
  export interface CreateClusterSubnetGroupMessage {
3806
4206
  /**
4207
+ * @public
3807
4208
  * <p>The name for the subnet group. Amazon Redshift stores the value as a lowercase
3808
4209
  * string.</p>
3809
4210
  * <p>Constraints:</p>
@@ -3823,15 +4224,18 @@ export interface CreateClusterSubnetGroupMessage {
3823
4224
  */
3824
4225
  ClusterSubnetGroupName: string | undefined;
3825
4226
  /**
4227
+ * @public
3826
4228
  * <p>A description for the subnet group.</p>
3827
4229
  */
3828
4230
  Description: string | undefined;
3829
4231
  /**
4232
+ * @public
3830
4233
  * <p>An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single
3831
4234
  * request.</p>
3832
4235
  */
3833
4236
  SubnetIds: string[] | undefined;
3834
4237
  /**
4238
+ * @public
3835
4239
  * <p>A list of tag instances.</p>
3836
4240
  */
3837
4241
  Tags?: Tag[];
@@ -3841,6 +4245,7 @@ export interface CreateClusterSubnetGroupMessage {
3841
4245
  */
3842
4246
  export interface CreateClusterSubnetGroupResult {
3843
4247
  /**
4248
+ * @public
3844
4249
  * <p>Describes a subnet group.</p>
3845
4250
  */
3846
4251
  ClusterSubnetGroup?: ClusterSubnetGroup;
@@ -3850,14 +4255,17 @@ export interface CreateClusterSubnetGroupResult {
3850
4255
  */
3851
4256
  export interface CreateCustomDomainAssociationMessage {
3852
4257
  /**
4258
+ * @public
3853
4259
  * <p>The custom domain name for a custom domain association.</p>
3854
4260
  */
3855
4261
  CustomDomainName: string | undefined;
3856
4262
  /**
4263
+ * @public
3857
4264
  * <p>The certificate Amazon Resource Name (ARN) for the custom domain name association.</p>
3858
4265
  */
3859
4266
  CustomDomainCertificateArn: string | undefined;
3860
4267
  /**
4268
+ * @public
3861
4269
  * <p>The cluster identifier that the custom domain is associated with.</p>
3862
4270
  */
3863
4271
  ClusterIdentifier: string | undefined;
@@ -3867,18 +4275,22 @@ export interface CreateCustomDomainAssociationMessage {
3867
4275
  */
3868
4276
  export interface CreateCustomDomainAssociationResult {
3869
4277
  /**
4278
+ * @public
3870
4279
  * <p>The custom domain name for the association result.</p>
3871
4280
  */
3872
4281
  CustomDomainName?: string;
3873
4282
  /**
4283
+ * @public
3874
4284
  * <p>The Amazon Resource Name (ARN) for the certificate associated with the custom domain name.</p>
3875
4285
  */
3876
4286
  CustomDomainCertificateArn?: string;
3877
4287
  /**
4288
+ * @public
3878
4289
  * <p>The identifier of the cluster that the custom domain is associated with.</p>
3879
4290
  */
3880
4291
  ClusterIdentifier?: string;
3881
4292
  /**
4293
+ * @public
3882
4294
  * <p>The expiration time for the certificate for the custom domain.</p>
3883
4295
  */
3884
4296
  CustomDomainCertExpiryTime?: string;
@@ -3900,14 +4312,17 @@ export declare class CustomCnameAssociationFault extends __BaseException {
3900
4312
  */
3901
4313
  export interface CreateEndpointAccessMessage {
3902
4314
  /**
4315
+ * @public
3903
4316
  * <p>The cluster identifier of the cluster to access.</p>
3904
4317
  */
3905
4318
  ClusterIdentifier?: string;
3906
4319
  /**
4320
+ * @public
3907
4321
  * <p>The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.</p>
3908
4322
  */
3909
4323
  ResourceOwner?: string;
3910
4324
  /**
4325
+ * @public
3911
4326
  * <p>The Redshift-managed VPC endpoint name.</p>
3912
4327
  * <p>An endpoint name must contain 1-30 characters.
3913
4328
  * Valid characters are A-Z, a-z, 0-9, and hyphen(-).
@@ -3916,10 +4331,12 @@ export interface CreateEndpointAccessMessage {
3916
4331
  */
3917
4332
  EndpointName: string | undefined;
3918
4333
  /**
4334
+ * @public
3919
4335
  * <p>The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.</p>
3920
4336
  */
3921
4337
  SubnetGroupName: string | undefined;
3922
4338
  /**
4339
+ * @public
3923
4340
  * <p>The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.</p>
3924
4341
  */
3925
4342
  VpcSecurityGroupIds?: string[];
@@ -3930,42 +4347,52 @@ export interface CreateEndpointAccessMessage {
3930
4347
  */
3931
4348
  export interface EndpointAccess {
3932
4349
  /**
4350
+ * @public
3933
4351
  * <p>The cluster identifier of the cluster associated with the endpoint.</p>
3934
4352
  */
3935
4353
  ClusterIdentifier?: string;
3936
4354
  /**
4355
+ * @public
3937
4356
  * <p>The Amazon Web Services account ID of the owner of the cluster.</p>
3938
4357
  */
3939
4358
  ResourceOwner?: string;
3940
4359
  /**
4360
+ * @public
3941
4361
  * <p>The subnet group name where Amazon Redshift chooses to deploy the endpoint.</p>
3942
4362
  */
3943
4363
  SubnetGroupName?: string;
3944
4364
  /**
4365
+ * @public
3945
4366
  * <p>The status of the endpoint.</p>
3946
4367
  */
3947
4368
  EndpointStatus?: string;
3948
4369
  /**
4370
+ * @public
3949
4371
  * <p>The name of the endpoint.</p>
3950
4372
  */
3951
4373
  EndpointName?: string;
3952
4374
  /**
4375
+ * @public
3953
4376
  * <p>The time (UTC) that the endpoint was created.</p>
3954
4377
  */
3955
4378
  EndpointCreateTime?: Date;
3956
4379
  /**
4380
+ * @public
3957
4381
  * <p>The port number on which the cluster accepts incoming connections.</p>
3958
4382
  */
3959
4383
  Port?: number;
3960
4384
  /**
4385
+ * @public
3961
4386
  * <p>The DNS address of the endpoint.</p>
3962
4387
  */
3963
4388
  Address?: string;
3964
4389
  /**
4390
+ * @public
3965
4391
  * <p>The security groups associated with the endpoint.</p>
3966
4392
  */
3967
4393
  VpcSecurityGroups?: VpcSecurityGroupMembership[];
3968
4394
  /**
4395
+ * @public
3969
4396
  * <p>The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.</p>
3970
4397
  */
3971
4398
  VpcEndpoint?: VpcEndpoint;
@@ -4012,6 +4439,7 @@ export declare class EndpointsPerClusterLimitExceededFault extends __BaseExcepti
4012
4439
  */
4013
4440
  export interface CreateEventSubscriptionMessage {
4014
4441
  /**
4442
+ * @public
4015
4443
  * <p>The name of the event subscription to be created.</p>
4016
4444
  * <p>Constraints:</p>
4017
4445
  * <ul>
@@ -4031,12 +4459,14 @@ export interface CreateEventSubscriptionMessage {
4031
4459
  */
4032
4460
  SubscriptionName: string | undefined;
4033
4461
  /**
4462
+ * @public
4034
4463
  * <p>The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event
4035
4464
  * notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to
4036
4465
  * it.</p>
4037
4466
  */
4038
4467
  SnsTopicArn: string | undefined;
4039
4468
  /**
4469
+ * @public
4040
4470
  * <p>The type of source that will be generating the events. For example, if you want to
4041
4471
  * be notified of events generated by a cluster, you would set this parameter to cluster.
4042
4472
  * If this value is not specified, events are returned for all Amazon Redshift objects in your
@@ -4045,6 +4475,7 @@ export interface CreateEventSubscriptionMessage {
4045
4475
  */
4046
4476
  SourceType?: string;
4047
4477
  /**
4478
+ * @public
4048
4479
  * <p>A list of one or more identifiers of Amazon Redshift source objects. All of the objects
4049
4480
  * must be of the same type as was specified in the source type parameter. The event
4050
4481
  * subscription will return only events generated by the specified objects. If not
@@ -4055,23 +4486,27 @@ export interface CreateEventSubscriptionMessage {
4055
4486
  */
4056
4487
  SourceIds?: string[];
4057
4488
  /**
4489
+ * @public
4058
4490
  * <p>Specifies the Amazon Redshift event categories to be published by the event notification
4059
4491
  * subscription.</p>
4060
4492
  * <p>Values: configuration, management, monitoring, security, pending</p>
4061
4493
  */
4062
4494
  EventCategories?: string[];
4063
4495
  /**
4496
+ * @public
4064
4497
  * <p>Specifies the Amazon Redshift event severity to be published by the event notification
4065
4498
  * subscription.</p>
4066
4499
  * <p>Values: ERROR, INFO</p>
4067
4500
  */
4068
4501
  Severity?: string;
4069
4502
  /**
4503
+ * @public
4070
4504
  * <p>A boolean value; set to <code>true</code> to activate the subscription, and set to
4071
4505
  * <code>false</code> to create the subscription but not activate it. </p>
4072
4506
  */
4073
4507
  Enabled?: boolean;
4074
4508
  /**
4509
+ * @public
4075
4510
  * <p>A list of tag instances.</p>
4076
4511
  */
4077
4512
  Tags?: Tag[];
@@ -4082,20 +4517,24 @@ export interface CreateEventSubscriptionMessage {
4082
4517
  */
4083
4518
  export interface EventSubscription {
4084
4519
  /**
4520
+ * @public
4085
4521
  * <p>The Amazon Web Services account associated with the Amazon Redshift event notification
4086
4522
  * subscription.</p>
4087
4523
  */
4088
4524
  CustomerAwsId?: string;
4089
4525
  /**
4526
+ * @public
4090
4527
  * <p>The name of the Amazon Redshift event notification subscription.</p>
4091
4528
  */
4092
4529
  CustSubscriptionId?: string;
4093
4530
  /**
4531
+ * @public
4094
4532
  * <p>The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event
4095
4533
  * notification subscription.</p>
4096
4534
  */
4097
4535
  SnsTopicArn?: string;
4098
4536
  /**
4537
+ * @public
4099
4538
  * <p>The status of the Amazon Redshift event notification subscription.</p>
4100
4539
  * <p>Constraints:</p>
4101
4540
  * <ul>
@@ -4113,38 +4552,45 @@ export interface EventSubscription {
4113
4552
  */
4114
4553
  Status?: string;
4115
4554
  /**
4555
+ * @public
4116
4556
  * <p>The date and time the Amazon Redshift event notification subscription was
4117
4557
  * created.</p>
4118
4558
  */
4119
4559
  SubscriptionCreationTime?: Date;
4120
4560
  /**
4561
+ * @public
4121
4562
  * <p>The source type of the events returned by the Amazon Redshift event notification, such as
4122
4563
  * cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, or scheduled-action. </p>
4123
4564
  */
4124
4565
  SourceType?: string;
4125
4566
  /**
4567
+ * @public
4126
4568
  * <p>A list of the sources that publish events to the Amazon Redshift event notification
4127
4569
  * subscription.</p>
4128
4570
  */
4129
4571
  SourceIdsList?: string[];
4130
4572
  /**
4573
+ * @public
4131
4574
  * <p>The list of Amazon Redshift event categories specified in the event notification
4132
4575
  * subscription.</p>
4133
4576
  * <p>Values: Configuration, Management, Monitoring, Security, Pending</p>
4134
4577
  */
4135
4578
  EventCategoriesList?: string[];
4136
4579
  /**
4580
+ * @public
4137
4581
  * <p>The event severity specified in the Amazon Redshift event notification
4138
4582
  * subscription.</p>
4139
4583
  * <p>Values: ERROR, INFO</p>
4140
4584
  */
4141
4585
  Severity?: string;
4142
4586
  /**
4587
+ * @public
4143
4588
  * <p>A boolean value indicating whether the subscription is enabled; <code>true</code>
4144
4589
  * indicates that the subscription is enabled.</p>
4145
4590
  */
4146
4591
  Enabled?: boolean;
4147
4592
  /**
4593
+ * @public
4148
4594
  * <p>The list of tags for the event subscription.</p>
4149
4595
  */
4150
4596
  Tags?: Tag[];
@@ -4154,6 +4600,7 @@ export interface EventSubscription {
4154
4600
  */
4155
4601
  export interface CreateEventSubscriptionResult {
4156
4602
  /**
4603
+ * @public
4157
4604
  * <p>Describes event subscriptions.</p>
4158
4605
  */
4159
4606
  EventSubscription?: EventSubscription;
@@ -4283,11 +4730,13 @@ export declare class SubscriptionSeverityNotFoundFault extends __BaseException {
4283
4730
  */
4284
4731
  export interface CreateHsmClientCertificateMessage {
4285
4732
  /**
4733
+ * @public
4286
4734
  * <p>The identifier to be assigned to the new HSM client certificate that the cluster
4287
4735
  * will use to connect to the HSM to use the database encryption keys.</p>
4288
4736
  */
4289
4737
  HsmClientCertificateIdentifier: string | undefined;
4290
4738
  /**
4739
+ * @public
4291
4740
  * <p>A list of tag instances.</p>
4292
4741
  */
4293
4742
  Tags?: Tag[];
@@ -4300,15 +4749,18 @@ export interface CreateHsmClientCertificateMessage {
4300
4749
  */
4301
4750
  export interface HsmClientCertificate {
4302
4751
  /**
4752
+ * @public
4303
4753
  * <p>The identifier of the HSM client certificate.</p>
4304
4754
  */
4305
4755
  HsmClientCertificateIdentifier?: string;
4306
4756
  /**
4757
+ * @public
4307
4758
  * <p>The public key that the Amazon Redshift cluster will use to connect to the HSM. You must
4308
4759
  * register the public key in the HSM.</p>
4309
4760
  */
4310
4761
  HsmClientCertificatePublicKey?: string;
4311
4762
  /**
4763
+ * @public
4312
4764
  * <p>The list of tags for the HSM client certificate.</p>
4313
4765
  */
4314
4766
  Tags?: Tag[];
@@ -4318,6 +4770,7 @@ export interface HsmClientCertificate {
4318
4770
  */
4319
4771
  export interface CreateHsmClientCertificateResult {
4320
4772
  /**
4773
+ * @public
4321
4774
  * <p>Returns information about an HSM client certificate. The certificate is stored in a
4322
4775
  * secure Hardware Storage Module (HSM), and used by the Amazon Redshift cluster to encrypt data
4323
4776
  * files.</p>
@@ -4358,32 +4811,39 @@ export declare class HsmClientCertificateQuotaExceededFault extends __BaseExcept
4358
4811
  */
4359
4812
  export interface CreateHsmConfigurationMessage {
4360
4813
  /**
4814
+ * @public
4361
4815
  * <p>The identifier to be assigned to the new Amazon Redshift HSM configuration.</p>
4362
4816
  */
4363
4817
  HsmConfigurationIdentifier: string | undefined;
4364
4818
  /**
4819
+ * @public
4365
4820
  * <p>A text description of the HSM configuration to be created.</p>
4366
4821
  */
4367
4822
  Description: string | undefined;
4368
4823
  /**
4824
+ * @public
4369
4825
  * <p>The IP address that the Amazon Redshift cluster must use to access the HSM.</p>
4370
4826
  */
4371
4827
  HsmIpAddress: string | undefined;
4372
4828
  /**
4829
+ * @public
4373
4830
  * <p>The name of the partition in the HSM where the Amazon Redshift clusters will store their
4374
4831
  * database encryption keys.</p>
4375
4832
  */
4376
4833
  HsmPartitionName: string | undefined;
4377
4834
  /**
4835
+ * @public
4378
4836
  * <p>The password required to access the HSM partition.</p>
4379
4837
  */
4380
4838
  HsmPartitionPassword: string | undefined;
4381
4839
  /**
4840
+ * @public
4382
4841
  * <p>The HSMs public certificate file. When using Cloud HSM, the file name is
4383
4842
  * server.pem.</p>
4384
4843
  */
4385
4844
  HsmServerPublicCertificate: string | undefined;
4386
4845
  /**
4846
+ * @public
4387
4847
  * <p>A list of tag instances.</p>
4388
4848
  */
4389
4849
  Tags?: Tag[];
@@ -4396,23 +4856,28 @@ export interface CreateHsmConfigurationMessage {
4396
4856
  */
4397
4857
  export interface HsmConfiguration {
4398
4858
  /**
4859
+ * @public
4399
4860
  * <p>The name of the Amazon Redshift HSM configuration.</p>
4400
4861
  */
4401
4862
  HsmConfigurationIdentifier?: string;
4402
4863
  /**
4864
+ * @public
4403
4865
  * <p>A text description of the HSM configuration.</p>
4404
4866
  */
4405
4867
  Description?: string;
4406
4868
  /**
4869
+ * @public
4407
4870
  * <p>The IP address that the Amazon Redshift cluster must use to access the HSM.</p>
4408
4871
  */
4409
4872
  HsmIpAddress?: string;
4410
4873
  /**
4874
+ * @public
4411
4875
  * <p>The name of the partition in the HSM where the Amazon Redshift clusters will store their
4412
4876
  * database encryption keys.</p>
4413
4877
  */
4414
4878
  HsmPartitionName?: string;
4415
4879
  /**
4880
+ * @public
4416
4881
  * <p>The list of tags for the HSM configuration.</p>
4417
4882
  */
4418
4883
  Tags?: Tag[];
@@ -4422,6 +4887,7 @@ export interface HsmConfiguration {
4422
4887
  */
4423
4888
  export interface CreateHsmConfigurationResult {
4424
4889
  /**
4890
+ * @public
4425
4891
  * <p>Returns information about an HSM configuration, which is an object that describes
4426
4892
  * to Amazon Redshift clusters the information they require to connect to an HSM where they can
4427
4893
  * store database encryption keys.</p>
@@ -4462,6 +4928,7 @@ export declare class HsmConfigurationQuotaExceededFault extends __BaseException
4462
4928
  */
4463
4929
  export interface PauseClusterMessage {
4464
4930
  /**
4931
+ * @public
4465
4932
  * <p>The identifier of the cluster to be paused.</p>
4466
4933
  */
4467
4934
  ClusterIdentifier: string | undefined;
@@ -4472,32 +4939,39 @@ export interface PauseClusterMessage {
4472
4939
  */
4473
4940
  export interface ResizeClusterMessage {
4474
4941
  /**
4942
+ * @public
4475
4943
  * <p>The unique identifier for the cluster to resize.</p>
4476
4944
  */
4477
4945
  ClusterIdentifier: string | undefined;
4478
4946
  /**
4947
+ * @public
4479
4948
  * <p>The new cluster type for the specified cluster.</p>
4480
4949
  */
4481
4950
  ClusterType?: string;
4482
4951
  /**
4952
+ * @public
4483
4953
  * <p>The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.</p>
4484
4954
  */
4485
4955
  NodeType?: string;
4486
4956
  /**
4957
+ * @public
4487
4958
  * <p>The new number of nodes for the cluster. If not specified, the cluster's current number of nodes is used.</p>
4488
4959
  */
4489
4960
  NumberOfNodes?: number;
4490
4961
  /**
4962
+ * @public
4491
4963
  * <p>A boolean value indicating whether the resize operation is using the classic resize
4492
4964
  * process. If you don't provide this parameter or set the value to
4493
4965
  * <code>false</code>, the resize type is elastic. </p>
4494
4966
  */
4495
4967
  Classic?: boolean;
4496
4968
  /**
4969
+ * @public
4497
4970
  * <p>The identifier of the reserved node.</p>
4498
4971
  */
4499
4972
  ReservedNodeId?: string;
4500
4973
  /**
4974
+ * @public
4501
4975
  * <p>The identifier of the target reserved node offering.</p>
4502
4976
  */
4503
4977
  TargetReservedNodeOfferingId?: string;
@@ -4508,6 +4982,7 @@ export interface ResizeClusterMessage {
4508
4982
  */
4509
4983
  export interface ResumeClusterMessage {
4510
4984
  /**
4985
+ * @public
4511
4986
  * <p>The identifier of the cluster to be resumed.</p>
4512
4987
  */
4513
4988
  ClusterIdentifier: string | undefined;
@@ -4518,14 +4993,17 @@ export interface ResumeClusterMessage {
4518
4993
  */
4519
4994
  export interface ScheduledActionType {
4520
4995
  /**
4996
+ * @public
4521
4997
  * <p>An action that runs a <code>ResizeCluster</code> API operation. </p>
4522
4998
  */
4523
4999
  ResizeCluster?: ResizeClusterMessage;
4524
5000
  /**
5001
+ * @public
4525
5002
  * <p>An action that runs a <code>PauseCluster</code> API operation. </p>
4526
5003
  */
4527
5004
  PauseCluster?: PauseClusterMessage;
4528
5005
  /**
5006
+ * @public
4529
5007
  * <p>An action that runs a <code>ResumeCluster</code> API operation. </p>
4530
5008
  */
4531
5009
  ResumeCluster?: ResumeClusterMessage;
@@ -4535,42 +5013,50 @@ export interface ScheduledActionType {
4535
5013
  */
4536
5014
  export interface CreateScheduledActionMessage {
4537
5015
  /**
5016
+ * @public
4538
5017
  * <p>The name of the scheduled action. The name must be unique within an account.
4539
5018
  * For more information about this parameter, see <a>ScheduledAction</a>. </p>
4540
5019
  */
4541
5020
  ScheduledActionName: string | undefined;
4542
5021
  /**
5022
+ * @public
4543
5023
  * <p>A JSON format string of the Amazon Redshift API operation with input parameters.
4544
5024
  * For more information about this parameter, see <a>ScheduledAction</a>. </p>
4545
5025
  */
4546
5026
  TargetAction: ScheduledActionType | undefined;
4547
5027
  /**
5028
+ * @public
4548
5029
  * <p>The schedule in <code>at( )</code> or <code>cron( )</code> format.
4549
5030
  * For more information about this parameter, see <a>ScheduledAction</a>.</p>
4550
5031
  */
4551
5032
  Schedule: string | undefined;
4552
5033
  /**
5034
+ * @public
4553
5035
  * <p>The IAM role to assume to run the target action.
4554
5036
  * For more information about this parameter, see <a>ScheduledAction</a>. </p>
4555
5037
  */
4556
5038
  IamRole: string | undefined;
4557
5039
  /**
5040
+ * @public
4558
5041
  * <p>The description of the scheduled action.
4559
5042
  * </p>
4560
5043
  */
4561
5044
  ScheduledActionDescription?: string;
4562
5045
  /**
5046
+ * @public
4563
5047
  * <p>The start time in UTC of the scheduled action.
4564
5048
  * Before this time, the scheduled action does not trigger.
4565
5049
  * For more information about this parameter, see <a>ScheduledAction</a>.</p>
4566
5050
  */
4567
5051
  StartTime?: Date;
4568
5052
  /**
5053
+ * @public
4569
5054
  * <p>The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger.
4570
5055
  * For more information about this parameter, see <a>ScheduledAction</a>. </p>
4571
5056
  */
4572
5057
  EndTime?: Date;
4573
5058
  /**
5059
+ * @public
4574
5060
  * <p>If true, the schedule is enabled. If false, the scheduled action does not trigger.
4575
5061
  * For more information about <code>state</code> of the scheduled action, see <a>ScheduledAction</a>. </p>
4576
5062
  */
@@ -4619,15 +5105,18 @@ export type ScheduledActionState = (typeof ScheduledActionState)[keyof typeof Sc
4619
5105
  */
4620
5106
  export interface ScheduledAction {
4621
5107
  /**
5108
+ * @public
4622
5109
  * <p>The name of the scheduled action. </p>
4623
5110
  */
4624
5111
  ScheduledActionName?: string;
4625
5112
  /**
5113
+ * @public
4626
5114
  * <p>A JSON format string of the Amazon Redshift API operation with input parameters. </p>
4627
5115
  * <p>"<code>\{\"ResizeCluster\":\{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3\}\}</code>". </p>
4628
5116
  */
4629
5117
  TargetAction?: ScheduledActionType;
4630
5118
  /**
5119
+ * @public
4631
5120
  * <p>The schedule for a one-time (at format) or recurring (cron format) scheduled action.
4632
5121
  * Schedule invocations must be separated by at least one hour.</p>
4633
5122
  * <p>Format of at expressions is "<code>at(yyyy-mm-ddThh:mm:ss)</code>". For example, "<code>at(2016-03-04T17:27:00)</code>".</p>
@@ -4638,6 +5127,7 @@ export interface ScheduledAction {
4638
5127
  */
4639
5128
  Schedule?: string;
4640
5129
  /**
5130
+ * @public
4641
5131
  * <p>The IAM role to assume to run the scheduled action.
4642
5132
  * This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action.
4643
5133
  * This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf.
@@ -4649,22 +5139,27 @@ export interface ScheduledAction {
4649
5139
  */
4650
5140
  IamRole?: string;
4651
5141
  /**
5142
+ * @public
4652
5143
  * <p>The description of the scheduled action. </p>
4653
5144
  */
4654
5145
  ScheduledActionDescription?: string;
4655
5146
  /**
5147
+ * @public
4656
5148
  * <p>The state of the scheduled action. For example, <code>DISABLED</code>. </p>
4657
5149
  */
4658
5150
  State?: ScheduledActionState | string;
4659
5151
  /**
5152
+ * @public
4660
5153
  * <p>List of times when the scheduled action will run. </p>
4661
5154
  */
4662
5155
  NextInvocations?: Date[];
4663
5156
  /**
5157
+ * @public
4664
5158
  * <p>The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger. </p>
4665
5159
  */
4666
5160
  StartTime?: Date;
4667
5161
  /**
5162
+ * @public
4668
5163
  * <p>The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger. </p>
4669
5164
  */
4670
5165
  EndTime?: Date;
@@ -4711,6 +5206,7 @@ export declare class ScheduledActionTypeUnsupportedFault extends __BaseException
4711
5206
  */
4712
5207
  export interface CreateSnapshotCopyGrantMessage {
4713
5208
  /**
5209
+ * @public
4714
5210
  * <p>The name of the snapshot copy grant. This name must be unique in the region for the
4715
5211
  * Amazon Web Services account.</p>
4716
5212
  * <p>Constraints:</p>
@@ -4734,11 +5230,13 @@ export interface CreateSnapshotCopyGrantMessage {
4734
5230
  */
4735
5231
  SnapshotCopyGrantName: string | undefined;
4736
5232
  /**
5233
+ * @public
4737
5234
  * <p>The unique identifier of the encrypted symmetric key to which to grant Amazon Redshift
4738
5235
  * permission. If no key is specified, the default key is used.</p>
4739
5236
  */
4740
5237
  KmsKeyId?: string;
4741
5238
  /**
5239
+ * @public
4742
5240
  * <p>A list of tag instances.</p>
4743
5241
  */
4744
5242
  Tags?: Tag[];
@@ -4756,15 +5254,18 @@ export interface CreateSnapshotCopyGrantMessage {
4756
5254
  */
4757
5255
  export interface SnapshotCopyGrant {
4758
5256
  /**
5257
+ * @public
4759
5258
  * <p>The name of the snapshot copy grant.</p>
4760
5259
  */
4761
5260
  SnapshotCopyGrantName?: string;
4762
5261
  /**
5262
+ * @public
4763
5263
  * <p>The unique identifier of the encrypted symmetric key in Amazon Web Services KMS to which
4764
5264
  * Amazon Redshift is granted permission.</p>
4765
5265
  */
4766
5266
  KmsKeyId?: string;
4767
5267
  /**
5268
+ * @public
4768
5269
  * <p>A list of tag instances.</p>
4769
5270
  */
4770
5271
  Tags?: Tag[];
@@ -4774,6 +5275,7 @@ export interface SnapshotCopyGrant {
4774
5275
  */
4775
5276
  export interface CreateSnapshotCopyGrantResult {
4776
5277
  /**
5278
+ * @public
4777
5279
  * <p>The snapshot copy grant that grants Amazon Redshift permission to encrypt copied
4778
5280
  * snapshots with the specified encrypted symmetric key from Amazon Web Services KMS in the destination
4779
5281
  * region.</p>
@@ -4816,28 +5318,34 @@ export declare class SnapshotCopyGrantQuotaExceededFault extends __BaseException
4816
5318
  */
4817
5319
  export interface CreateSnapshotScheduleMessage {
4818
5320
  /**
5321
+ * @public
4819
5322
  * <p>The definition of the snapshot schedule. The definition is made up of schedule
4820
5323
  * expressions, for example "cron(30 12 *)" or "rate(12 hours)". </p>
4821
5324
  */
4822
5325
  ScheduleDefinitions?: string[];
4823
5326
  /**
5327
+ * @public
4824
5328
  * <p>A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed
4825
5329
  * for the identifier.</p>
4826
5330
  */
4827
5331
  ScheduleIdentifier?: string;
4828
5332
  /**
5333
+ * @public
4829
5334
  * <p>The description of the snapshot schedule.</p>
4830
5335
  */
4831
5336
  ScheduleDescription?: string;
4832
5337
  /**
5338
+ * @public
4833
5339
  * <p>An optional set of tags you can use to search for the schedule.</p>
4834
5340
  */
4835
5341
  Tags?: Tag[];
4836
5342
  /**
5343
+ * @public
4837
5344
  * <p></p>
4838
5345
  */
4839
5346
  DryRun?: boolean;
4840
5347
  /**
5348
+ * @public
4841
5349
  * <p></p>
4842
5350
  */
4843
5351
  NextInvocations?: number;
@@ -4861,30 +5369,37 @@ export declare class ScheduleDefinitionTypeUnsupportedFault extends __BaseExcept
4861
5369
  */
4862
5370
  export interface SnapshotSchedule {
4863
5371
  /**
5372
+ * @public
4864
5373
  * <p>A list of ScheduleDefinitions.</p>
4865
5374
  */
4866
5375
  ScheduleDefinitions?: string[];
4867
5376
  /**
5377
+ * @public
4868
5378
  * <p>A unique identifier for the schedule.</p>
4869
5379
  */
4870
5380
  ScheduleIdentifier?: string;
4871
5381
  /**
5382
+ * @public
4872
5383
  * <p>The description of the schedule.</p>
4873
5384
  */
4874
5385
  ScheduleDescription?: string;
4875
5386
  /**
5387
+ * @public
4876
5388
  * <p>An optional set of tags describing the schedule.</p>
4877
5389
  */
4878
5390
  Tags?: Tag[];
4879
5391
  /**
5392
+ * @public
4880
5393
  * <p></p>
4881
5394
  */
4882
5395
  NextInvocations?: Date[];
4883
5396
  /**
5397
+ * @public
4884
5398
  * <p>The number of clusters associated with the schedule.</p>
4885
5399
  */
4886
5400
  AssociatedClusterCount?: number;
4887
5401
  /**
5402
+ * @public
4888
5403
  * <p>A list of clusters associated with the schedule. A maximum of 100 clusters is returned.</p>
4889
5404
  */
4890
5405
  AssociatedClusters?: ClusterAssociatedToSchedule[];
@@ -4919,11 +5434,13 @@ export declare class SnapshotScheduleQuotaExceededFault extends __BaseException
4919
5434
  */
4920
5435
  export interface CreateTagsMessage {
4921
5436
  /**
5437
+ * @public
4922
5438
  * <p>The Amazon Resource Name (ARN) to which you want to add the tag or tags. For
4923
5439
  * example, <code>arn:aws:redshift:us-east-2:123456789:cluster:t1</code>. </p>
4924
5440
  */
4925
5441
  ResourceName: string | undefined;
4926
5442
  /**
5443
+ * @public
4927
5444
  * <p>One or more name/value pairs to add as tags to the specified resource. Each tag
4928
5445
  * name is passed in with the parameter <code>Key</code> and the corresponding value is
4929
5446
  * passed in with the parameter <code>Value</code>. The <code>Key</code> and
@@ -5001,14 +5518,17 @@ export type UsageLimitPeriod = (typeof UsageLimitPeriod)[keyof typeof UsageLimit
5001
5518
  */
5002
5519
  export interface CreateUsageLimitMessage {
5003
5520
  /**
5521
+ * @public
5004
5522
  * <p>The identifier of the cluster that you want to limit usage.</p>
5005
5523
  */
5006
5524
  ClusterIdentifier: string | undefined;
5007
5525
  /**
5526
+ * @public
5008
5527
  * <p>The Amazon Redshift feature that you want to limit.</p>
5009
5528
  */
5010
5529
  FeatureType: UsageLimitFeatureType | string | undefined;
5011
5530
  /**
5531
+ * @public
5012
5532
  * <p>The type of limit. Depending on the feature type, this can be based on a time duration or data size.
5013
5533
  * If <code>FeatureType</code> is <code>spectrum</code>, then <code>LimitType</code> must be <code>data-scanned</code>.
5014
5534
  * If <code>FeatureType</code> is <code>concurrency-scaling</code>, then <code>LimitType</code> must be <code>time</code>.
@@ -5017,22 +5537,26 @@ export interface CreateUsageLimitMessage {
5017
5537
  */
5018
5538
  LimitType: UsageLimitLimitType | string | undefined;
5019
5539
  /**
5540
+ * @public
5020
5541
  * <p>The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).
5021
5542
  * The value must be a positive number.
5022
5543
  * </p>
5023
5544
  */
5024
5545
  Amount: number | undefined;
5025
5546
  /**
5547
+ * @public
5026
5548
  * <p>The time period that the amount applies to. A <code>weekly</code> period begins on Sunday. The default is <code>monthly</code>.
5027
5549
  * </p>
5028
5550
  */
5029
5551
  Period?: UsageLimitPeriod | string;
5030
5552
  /**
5553
+ * @public
5031
5554
  * <p>The action that Amazon Redshift takes when the limit is reached. The default is log.
5032
5555
  * For more information about this parameter, see <a>UsageLimit</a>.</p>
5033
5556
  */
5034
5557
  BreachAction?: UsageLimitBreachAction | string;
5035
5558
  /**
5559
+ * @public
5036
5560
  * <p>A list of tag instances.</p>
5037
5561
  */
5038
5562
  Tags?: Tag[];
@@ -5055,30 +5579,37 @@ export declare class InvalidUsageLimitFault extends __BaseException {
5055
5579
  */
5056
5580
  export interface UsageLimit {
5057
5581
  /**
5582
+ * @public
5058
5583
  * <p>The identifier of the usage limit.</p>
5059
5584
  */
5060
5585
  UsageLimitId?: string;
5061
5586
  /**
5587
+ * @public
5062
5588
  * <p>The identifier of the cluster with a usage limit.</p>
5063
5589
  */
5064
5590
  ClusterIdentifier?: string;
5065
5591
  /**
5592
+ * @public
5066
5593
  * <p>The Amazon Redshift feature to which the limit applies.</p>
5067
5594
  */
5068
5595
  FeatureType?: UsageLimitFeatureType | string;
5069
5596
  /**
5597
+ * @public
5070
5598
  * <p>The type of limit. Depending on the feature type, this can be based on a time duration or data size.</p>
5071
5599
  */
5072
5600
  LimitType?: UsageLimitLimitType | string;
5073
5601
  /**
5602
+ * @public
5074
5603
  * <p>The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).</p>
5075
5604
  */
5076
5605
  Amount?: number;
5077
5606
  /**
5607
+ * @public
5078
5608
  * <p>The time period that the amount applies to. A <code>weekly</code> period begins on Sunday. The default is <code>monthly</code>. </p>
5079
5609
  */
5080
5610
  Period?: UsageLimitPeriod | string;
5081
5611
  /**
5612
+ * @public
5082
5613
  * <p>The action that Amazon Redshift takes when the limit is reached. Possible values are: </p>
5083
5614
  * <ul>
5084
5615
  * <li>
@@ -5097,6 +5628,7 @@ export interface UsageLimit {
5097
5628
  */
5098
5629
  BreachAction?: UsageLimitBreachAction | string;
5099
5630
  /**
5631
+ * @public
5100
5632
  * <p>A list of tag instances.</p>
5101
5633
  */
5102
5634
  Tags?: Tag[];
@@ -5130,10 +5662,12 @@ export declare class CustomDomainAssociationNotFoundFault extends __BaseExceptio
5130
5662
  */
5131
5663
  export interface CustomDomainAssociationsMessage {
5132
5664
  /**
5665
+ * @public
5133
5666
  * <p>The marker for the custom domain association.</p>
5134
5667
  */
5135
5668
  Marker?: string;
5136
5669
  /**
5670
+ * @public
5137
5671
  * <p>The associations for the custom domain.</p>
5138
5672
  */
5139
5673
  Associations?: Association[];
@@ -5143,10 +5677,12 @@ export interface CustomDomainAssociationsMessage {
5143
5677
  */
5144
5678
  export interface CustomerStorageMessage {
5145
5679
  /**
5680
+ * @public
5146
5681
  * <p>The total amount of storage currently used for snapshots.</p>
5147
5682
  */
5148
5683
  TotalBackupSizeInMegaBytes?: number;
5149
5684
  /**
5685
+ * @public
5150
5686
  * <p>The total amount of storage currently provisioned.</p>
5151
5687
  */
5152
5688
  TotalProvisionedStorageInMegaBytes?: number;
@@ -5183,10 +5719,12 @@ export type DataShareStatusForProducer = (typeof DataShareStatusForProducer)[key
5183
5719
  */
5184
5720
  export interface DeauthorizeDataShareMessage {
5185
5721
  /**
5722
+ * @public
5186
5723
  * <p>The Amazon Resource Name (ARN) of the datashare to remove authorization from.</p>
5187
5724
  */
5188
5725
  DataShareArn: string | undefined;
5189
5726
  /**
5727
+ * @public
5190
5728
  * <p>The identifier of the data consumer that is to have authorization removed from the datashare.
5191
5729
  * This identifier is an Amazon Web Services account ID or a keyword, such as ADX.</p>
5192
5730
  */
@@ -5198,11 +5736,13 @@ export interface DeauthorizeDataShareMessage {
5198
5736
  */
5199
5737
  export interface DefaultClusterParameters {
5200
5738
  /**
5739
+ * @public
5201
5740
  * <p>The name of the cluster parameter group family to which the engine default
5202
5741
  * parameters apply.</p>
5203
5742
  */
5204
5743
  ParameterGroupFamily?: string;
5205
5744
  /**
5745
+ * @public
5206
5746
  * <p>A value that indicates the starting point for the next set of response records in a
5207
5747
  * subsequent request. If a value is returned in a response, you can retrieve the next set
5208
5748
  * of records by providing this returned marker value in the <code>Marker</code> parameter
@@ -5211,6 +5751,7 @@ export interface DefaultClusterParameters {
5211
5751
  */
5212
5752
  Marker?: string;
5213
5753
  /**
5754
+ * @public
5214
5755
  * <p>The list of cluster default parameters.</p>
5215
5756
  */
5216
5757
  Parameters?: Parameter[];
@@ -5220,6 +5761,7 @@ export interface DefaultClusterParameters {
5220
5761
  */
5221
5762
  export interface DeleteAuthenticationProfileMessage {
5222
5763
  /**
5764
+ * @public
5223
5765
  * <p>The name of the authentication profile to delete.</p>
5224
5766
  */
5225
5767
  AuthenticationProfileName: string | undefined;
@@ -5229,6 +5771,7 @@ export interface DeleteAuthenticationProfileMessage {
5229
5771
  */
5230
5772
  export interface DeleteAuthenticationProfileResult {
5231
5773
  /**
5774
+ * @public
5232
5775
  * <p>The name of the authentication profile that was deleted.</p>
5233
5776
  */
5234
5777
  AuthenticationProfileName?: string;
@@ -5239,6 +5782,7 @@ export interface DeleteAuthenticationProfileResult {
5239
5782
  */
5240
5783
  export interface DeleteClusterMessage {
5241
5784
  /**
5785
+ * @public
5242
5786
  * <p>The identifier of the cluster to be deleted.</p>
5243
5787
  * <p>Constraints:</p>
5244
5788
  * <ul>
@@ -5258,6 +5802,7 @@ export interface DeleteClusterMessage {
5258
5802
  */
5259
5803
  ClusterIdentifier: string | undefined;
5260
5804
  /**
5805
+ * @public
5261
5806
  * <p>Determines whether a final snapshot of the cluster is created before Amazon Redshift
5262
5807
  * deletes the cluster. If <code>true</code>, a final cluster snapshot is not created. If
5263
5808
  * <code>false</code>, a final cluster snapshot is created before the cluster is
@@ -5272,6 +5817,7 @@ export interface DeleteClusterMessage {
5272
5817
  */
5273
5818
  SkipFinalClusterSnapshot?: boolean;
5274
5819
  /**
5820
+ * @public
5275
5821
  * <p>The identifier of the final snapshot that is to be created immediately before
5276
5822
  * deleting the cluster. If this parameter is provided,
5277
5823
  * <i>SkipFinalClusterSnapshot</i> must be <code>false</code>. </p>
@@ -5290,6 +5836,7 @@ export interface DeleteClusterMessage {
5290
5836
  */
5291
5837
  FinalClusterSnapshotIdentifier?: string;
5292
5838
  /**
5839
+ * @public
5293
5840
  * <p>The number of days that a manual snapshot is retained. If the value is -1, the manual
5294
5841
  * snapshot is retained indefinitely.</p>
5295
5842
  * <p>The value must be either -1 or an integer between 1 and 3,653.</p>
@@ -5302,6 +5849,7 @@ export interface DeleteClusterMessage {
5302
5849
  */
5303
5850
  export interface DeleteClusterResult {
5304
5851
  /**
5852
+ * @public
5305
5853
  * <p>Describes a cluster.</p>
5306
5854
  */
5307
5855
  Cluster?: Cluster;
@@ -5312,6 +5860,7 @@ export interface DeleteClusterResult {
5312
5860
  */
5313
5861
  export interface DeleteClusterParameterGroupMessage {
5314
5862
  /**
5863
+ * @public
5315
5864
  * <p>The name of the parameter group to be deleted.</p>
5316
5865
  * <p>Constraints:</p>
5317
5866
  * <ul>
@@ -5345,6 +5894,7 @@ export declare class InvalidClusterParameterGroupStateFault extends __BaseExcept
5345
5894
  */
5346
5895
  export interface DeleteClusterSecurityGroupMessage {
5347
5896
  /**
5897
+ * @public
5348
5898
  * <p>The name of the cluster security group to be deleted.</p>
5349
5899
  */
5350
5900
  ClusterSecurityGroupName: string | undefined;
@@ -5354,6 +5904,7 @@ export interface DeleteClusterSecurityGroupMessage {
5354
5904
  */
5355
5905
  export interface DeleteClusterSnapshotResult {
5356
5906
  /**
5907
+ * @public
5357
5908
  * <p>Describes a snapshot.</p>
5358
5909
  */
5359
5910
  Snapshot?: Snapshot;
@@ -5364,6 +5915,7 @@ export interface DeleteClusterSnapshotResult {
5364
5915
  */
5365
5916
  export interface DeleteClusterSubnetGroupMessage {
5366
5917
  /**
5918
+ * @public
5367
5919
  * <p>The name of the cluster subnet group name to be deleted.</p>
5368
5920
  */
5369
5921
  ClusterSubnetGroupName: string | undefined;
@@ -5385,6 +5937,7 @@ export declare class InvalidClusterSubnetStateFault extends __BaseException {
5385
5937
  */
5386
5938
  export interface DeleteCustomDomainAssociationMessage {
5387
5939
  /**
5940
+ * @public
5388
5941
  * <p>The identifier of the cluster to delete a custom domain association for.</p>
5389
5942
  */
5390
5943
  ClusterIdentifier: string | undefined;
@@ -5394,6 +5947,7 @@ export interface DeleteCustomDomainAssociationMessage {
5394
5947
  */
5395
5948
  export interface DeleteEndpointAccessMessage {
5396
5949
  /**
5950
+ * @public
5397
5951
  * <p>The Redshift-managed VPC endpoint to delete.</p>
5398
5952
  */
5399
5953
  EndpointName: string | undefined;
@@ -5428,6 +5982,7 @@ export declare class InvalidEndpointStateFault extends __BaseException {
5428
5982
  */
5429
5983
  export interface DeleteEventSubscriptionMessage {
5430
5984
  /**
5985
+ * @public
5431
5986
  * <p>The name of the Amazon Redshift event notification subscription to be deleted.</p>
5432
5987
  */
5433
5988
  SubscriptionName: string | undefined;
@@ -5464,6 +6019,7 @@ export declare class SubscriptionNotFoundFault extends __BaseException {
5464
6019
  */
5465
6020
  export interface DeleteHsmClientCertificateMessage {
5466
6021
  /**
6022
+ * @public
5467
6023
  * <p>The identifier of the HSM client certificate to be deleted.</p>
5468
6024
  */
5469
6025
  HsmClientCertificateIdentifier: string | undefined;
@@ -5487,6 +6043,7 @@ export declare class InvalidHsmClientCertificateStateFault extends __BaseExcepti
5487
6043
  */
5488
6044
  export interface DeleteHsmConfigurationMessage {
5489
6045
  /**
6046
+ * @public
5490
6047
  * <p>The identifier of the Amazon Redshift HSM configuration to be deleted.</p>
5491
6048
  */
5492
6049
  HsmConfigurationIdentifier: string | undefined;
@@ -5509,6 +6066,7 @@ export declare class InvalidHsmConfigurationStateFault extends __BaseException {
5509
6066
  */
5510
6067
  export interface DeleteScheduledActionMessage {
5511
6068
  /**
6069
+ * @public
5512
6070
  * <p>The name of the scheduled action to delete. </p>
5513
6071
  */
5514
6072
  ScheduledActionName: string | undefined;
@@ -5531,6 +6089,7 @@ export declare class ScheduledActionNotFoundFault extends __BaseException {
5531
6089
  */
5532
6090
  export interface DeleteSnapshotCopyGrantMessage {
5533
6091
  /**
6092
+ * @public
5534
6093
  * <p>The name of the snapshot copy grant to delete.</p>
5535
6094
  */
5536
6095
  SnapshotCopyGrantName: string | undefined;
@@ -5566,6 +6125,7 @@ export declare class SnapshotCopyGrantNotFoundFault extends __BaseException {
5566
6125
  */
5567
6126
  export interface DeleteSnapshotScheduleMessage {
5568
6127
  /**
6128
+ * @public
5569
6129
  * <p>A unique identifier of the snapshot schedule to delete.</p>
5570
6130
  */
5571
6131
  ScheduleIdentifier: string | undefined;
@@ -5588,11 +6148,13 @@ export declare class InvalidClusterSnapshotScheduleStateFault extends __BaseExce
5588
6148
  */
5589
6149
  export interface DeleteTagsMessage {
5590
6150
  /**
6151
+ * @public
5591
6152
  * <p>The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For
5592
6153
  * example, <code>arn:aws:redshift:us-east-2:123456789:cluster:t1</code>. </p>
5593
6154
  */
5594
6155
  ResourceName: string | undefined;
5595
6156
  /**
6157
+ * @public
5596
6158
  * <p>The tag key that you want to delete.</p>
5597
6159
  */
5598
6160
  TagKeys: string[] | undefined;
@@ -5602,6 +6164,7 @@ export interface DeleteTagsMessage {
5602
6164
  */
5603
6165
  export interface DeleteUsageLimitMessage {
5604
6166
  /**
6167
+ * @public
5605
6168
  * <p>The identifier of the usage limit to delete.</p>
5606
6169
  */
5607
6170
  UsageLimitId: string | undefined;
@@ -5623,6 +6186,7 @@ export declare class UsageLimitNotFoundFault extends __BaseException {
5623
6186
  */
5624
6187
  export interface DescribeAccountAttributesMessage {
5625
6188
  /**
6189
+ * @public
5626
6190
  * <p>A list of attribute names.</p>
5627
6191
  */
5628
6192
  AttributeNames?: string[];
@@ -5632,6 +6196,7 @@ export interface DescribeAccountAttributesMessage {
5632
6196
  */
5633
6197
  export interface DescribeAuthenticationProfilesMessage {
5634
6198
  /**
6199
+ * @public
5635
6200
  * <p>The name of the authentication profile to describe. If not specified then all authentication profiles owned by the account are listed.</p>
5636
6201
  */
5637
6202
  AuthenticationProfileName?: string;
@@ -5641,6 +6206,7 @@ export interface DescribeAuthenticationProfilesMessage {
5641
6206
  */
5642
6207
  export interface DescribeAuthenticationProfilesResult {
5643
6208
  /**
6209
+ * @public
5644
6210
  * <p>The list of authentication profiles.</p>
5645
6211
  */
5646
6212
  AuthenticationProfiles?: AuthenticationProfile[];
@@ -5650,12 +6216,14 @@ export interface DescribeAuthenticationProfilesResult {
5650
6216
  */
5651
6217
  export interface DescribeClusterDbRevisionsMessage {
5652
6218
  /**
6219
+ * @public
5653
6220
  * <p>A unique identifier for a cluster whose <code>ClusterDbRevisions</code> you are
5654
6221
  * requesting. This parameter is case sensitive. All clusters defined for an account are
5655
6222
  * returned by default.</p>
5656
6223
  */
5657
6224
  ClusterIdentifier?: string;
5658
6225
  /**
6226
+ * @public
5659
6227
  * <p>The maximum number of response records to return in each call. If the number of
5660
6228
  * remaining response records exceeds the specified MaxRecords value, a value is returned
5661
6229
  * in the <code>marker</code> field of the response. You can retrieve the next set of
@@ -5666,6 +6234,7 @@ export interface DescribeClusterDbRevisionsMessage {
5666
6234
  */
5667
6235
  MaxRecords?: number;
5668
6236
  /**
6237
+ * @public
5669
6238
  * <p>An optional parameter that specifies the starting point for returning a set of
5670
6239
  * response records. When the results of a <code>DescribeClusterDbRevisions</code> request
5671
6240
  * exceed the value specified in <code>MaxRecords</code>, Amazon Redshift returns a value
@@ -5683,12 +6252,14 @@ export interface DescribeClusterDbRevisionsMessage {
5683
6252
  */
5684
6253
  export interface DescribeClusterParameterGroupsMessage {
5685
6254
  /**
6255
+ * @public
5686
6256
  * <p>The name of a specific parameter group for which to return details. By default,
5687
6257
  * details about all parameter groups and the default parameter group are
5688
6258
  * returned.</p>
5689
6259
  */
5690
6260
  ParameterGroupName?: string;
5691
6261
  /**
6262
+ * @public
5692
6263
  * <p>The maximum number of response records to return in each call. If the number of
5693
6264
  * remaining response records exceeds the specified <code>MaxRecords</code> value, a value
5694
6265
  * is returned in a <code>marker</code> field of the response. You can retrieve the next
@@ -5699,6 +6270,7 @@ export interface DescribeClusterParameterGroupsMessage {
5699
6270
  */
5700
6271
  MaxRecords?: number;
5701
6272
  /**
6273
+ * @public
5702
6274
  * <p>An optional parameter that specifies the starting point to return a set of response
5703
6275
  * records. When the results of a <a>DescribeClusterParameterGroups</a> request
5704
6276
  * exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
@@ -5708,6 +6280,7 @@ export interface DescribeClusterParameterGroupsMessage {
5708
6280
  */
5709
6281
  Marker?: string;
5710
6282
  /**
6283
+ * @public
5711
6284
  * <p>A tag key or keys for which you want to return all matching cluster parameter
5712
6285
  * groups that are associated with the specified key or keys. For example, suppose that you
5713
6286
  * have parameter groups that are tagged with keys called <code>owner</code> and
@@ -5717,6 +6290,7 @@ export interface DescribeClusterParameterGroupsMessage {
5717
6290
  */
5718
6291
  TagKeys?: string[];
5719
6292
  /**
6293
+ * @public
5720
6294
  * <p>A tag value or values for which you want to return all matching cluster parameter
5721
6295
  * groups that are associated with the specified tag value or values. For example, suppose
5722
6296
  * that you have parameter groups that are tagged with values called <code>admin</code> and
@@ -5732,10 +6306,12 @@ export interface DescribeClusterParameterGroupsMessage {
5732
6306
  */
5733
6307
  export interface DescribeClusterParametersMessage {
5734
6308
  /**
6309
+ * @public
5735
6310
  * <p>The name of a cluster parameter group for which to return details.</p>
5736
6311
  */
5737
6312
  ParameterGroupName: string | undefined;
5738
6313
  /**
6314
+ * @public
5739
6315
  * <p>The parameter types to return. Specify <code>user</code> to show parameters that
5740
6316
  * are different form the default. Similarly, specify <code>engine-default</code> to show
5741
6317
  * parameters that are the same as the default parameter group. </p>
@@ -5745,6 +6321,7 @@ export interface DescribeClusterParametersMessage {
5745
6321
  */
5746
6322
  Source?: string;
5747
6323
  /**
6324
+ * @public
5748
6325
  * <p>The maximum number of response records to return in each call. If the number of
5749
6326
  * remaining response records exceeds the specified <code>MaxRecords</code> value, a value
5750
6327
  * is returned in a <code>marker</code> field of the response. You can retrieve the next
@@ -5755,6 +6332,7 @@ export interface DescribeClusterParametersMessage {
5755
6332
  */
5756
6333
  MaxRecords?: number;
5757
6334
  /**
6335
+ * @public
5758
6336
  * <p>An optional parameter that specifies the starting point to return a set of response
5759
6337
  * records. When the results of a <a>DescribeClusterParameters</a> request
5760
6338
  * exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
@@ -5770,12 +6348,14 @@ export interface DescribeClusterParametersMessage {
5770
6348
  */
5771
6349
  export interface DescribeClustersMessage {
5772
6350
  /**
6351
+ * @public
5773
6352
  * <p>The unique identifier of a cluster whose properties you are requesting. This
5774
6353
  * parameter is case sensitive.</p>
5775
6354
  * <p>The default is that all clusters defined for an account are returned.</p>
5776
6355
  */
5777
6356
  ClusterIdentifier?: string;
5778
6357
  /**
6358
+ * @public
5779
6359
  * <p>The maximum number of response records to return in each call. If the number of
5780
6360
  * remaining response records exceeds the specified <code>MaxRecords</code> value, a value
5781
6361
  * is returned in a <code>marker</code> field of the response. You can retrieve the next
@@ -5786,6 +6366,7 @@ export interface DescribeClustersMessage {
5786
6366
  */
5787
6367
  MaxRecords?: number;
5788
6368
  /**
6369
+ * @public
5789
6370
  * <p>An optional parameter that specifies the starting point to return a set of response
5790
6371
  * records. When the results of a <a>DescribeClusters</a> request exceed the
5791
6372
  * value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
@@ -5796,6 +6377,7 @@ export interface DescribeClustersMessage {
5796
6377
  */
5797
6378
  Marker?: string;
5798
6379
  /**
6380
+ * @public
5799
6381
  * <p>A tag key or keys for which you want to return all matching clusters that are
5800
6382
  * associated with the specified key or keys. For example, suppose that you have clusters
5801
6383
  * that are tagged with keys called <code>owner</code> and <code>environment</code>. If you
@@ -5804,6 +6386,7 @@ export interface DescribeClustersMessage {
5804
6386
  */
5805
6387
  TagKeys?: string[];
5806
6388
  /**
6389
+ * @public
5807
6390
  * <p>A tag value or values for which you want to return all matching clusters that are
5808
6391
  * associated with the specified tag value or values. For example, suppose that you have
5809
6392
  * clusters that are tagged with values called <code>admin</code> and <code>test</code>. If
@@ -5819,6 +6402,7 @@ export interface DescribeClustersMessage {
5819
6402
  */
5820
6403
  export interface DescribeClusterSecurityGroupsMessage {
5821
6404
  /**
6405
+ * @public
5822
6406
  * <p>The name of a cluster security group for which you are requesting details. You must
5823
6407
  * specify either the <b>Marker</b> parameter or a <b>ClusterSecurityGroupName</b> parameter, but not both. </p>
5824
6408
  * <p> Example: <code>securitygroup1</code>
@@ -5826,6 +6410,7 @@ export interface DescribeClusterSecurityGroupsMessage {
5826
6410
  */
5827
6411
  ClusterSecurityGroupName?: string;
5828
6412
  /**
6413
+ * @public
5829
6414
  * <p>The maximum number of response records to return in each call. If the number of
5830
6415
  * remaining response records exceeds the specified <code>MaxRecords</code> value, a value
5831
6416
  * is returned in a <code>marker</code> field of the response. You can retrieve the next
@@ -5836,6 +6421,7 @@ export interface DescribeClusterSecurityGroupsMessage {
5836
6421
  */
5837
6422
  MaxRecords?: number;
5838
6423
  /**
6424
+ * @public
5839
6425
  * <p>An optional parameter that specifies the starting point to return a set of response
5840
6426
  * records. When the results of a <a>DescribeClusterSecurityGroups</a> request
5841
6427
  * exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
@@ -5846,6 +6432,7 @@ export interface DescribeClusterSecurityGroupsMessage {
5846
6432
  */
5847
6433
  Marker?: string;
5848
6434
  /**
6435
+ * @public
5849
6436
  * <p>A tag key or keys for which you want to return all matching cluster security groups
5850
6437
  * that are associated with the specified key or keys. For example, suppose that you have
5851
6438
  * security groups that are tagged with keys called <code>owner</code> and
@@ -5855,6 +6442,7 @@ export interface DescribeClusterSecurityGroupsMessage {
5855
6442
  */
5856
6443
  TagKeys?: string[];
5857
6444
  /**
6445
+ * @public
5858
6446
  * <p>A tag value or values for which you want to return all matching cluster security
5859
6447
  * groups that are associated with the specified tag value or values. For example, suppose
5860
6448
  * that you have security groups that are tagged with values called <code>admin</code> and
@@ -5895,10 +6483,12 @@ export type SortByOrder = (typeof SortByOrder)[keyof typeof SortByOrder];
5895
6483
  */
5896
6484
  export interface SnapshotSortingEntity {
5897
6485
  /**
6486
+ * @public
5898
6487
  * <p>The category for sorting the snapshots.</p>
5899
6488
  */
5900
6489
  Attribute: SnapshotAttributeToSortBy | string | undefined;
5901
6490
  /**
6491
+ * @public
5902
6492
  * <p>The order for listing the attributes.</p>
5903
6493
  */
5904
6494
  SortOrder?: SortByOrder | string;
@@ -5909,19 +6499,23 @@ export interface SnapshotSortingEntity {
5909
6499
  */
5910
6500
  export interface DescribeClusterSnapshotsMessage {
5911
6501
  /**
6502
+ * @public
5912
6503
  * <p>The identifier of the cluster which generated the requested snapshots.</p>
5913
6504
  */
5914
6505
  ClusterIdentifier?: string;
5915
6506
  /**
6507
+ * @public
5916
6508
  * <p>The snapshot identifier of the snapshot about which to return
5917
6509
  * information.</p>
5918
6510
  */
5919
6511
  SnapshotIdentifier?: string;
5920
6512
  /**
6513
+ * @public
5921
6514
  * <p>The Amazon Resource Name (ARN) of the snapshot associated with the message to describe cluster snapshots.</p>
5922
6515
  */
5923
6516
  SnapshotArn?: string;
5924
6517
  /**
6518
+ * @public
5925
6519
  * <p>The type of snapshots for which you are requesting information. By default,
5926
6520
  * snapshots of all types are returned.</p>
5927
6521
  * <p>Valid Values: <code>automated</code> | <code>manual</code>
@@ -5929,6 +6523,7 @@ export interface DescribeClusterSnapshotsMessage {
5929
6523
  */
5930
6524
  SnapshotType?: string;
5931
6525
  /**
6526
+ * @public
5932
6527
  * <p>A value that requests only snapshots created at or after the specified time. The
5933
6528
  * time value is specified in ISO 8601 format. For more information about ISO 8601, go to
5934
6529
  * the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a>
@@ -5938,6 +6533,7 @@ export interface DescribeClusterSnapshotsMessage {
5938
6533
  */
5939
6534
  StartTime?: Date;
5940
6535
  /**
6536
+ * @public
5941
6537
  * <p>A time value that requests only snapshots created at or before the specified time.
5942
6538
  * The time value is specified in ISO 8601 format. For more information about ISO 8601, go
5943
6539
  * to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia
@@ -5948,6 +6544,7 @@ export interface DescribeClusterSnapshotsMessage {
5948
6544
  */
5949
6545
  EndTime?: Date;
5950
6546
  /**
6547
+ * @public
5951
6548
  * <p>The maximum number of response records to return in each call. If the number of
5952
6549
  * remaining response records exceeds the specified <code>MaxRecords</code> value, a value
5953
6550
  * is returned in a <code>marker</code> field of the response. You can retrieve the next
@@ -5958,6 +6555,7 @@ export interface DescribeClusterSnapshotsMessage {
5958
6555
  */
5959
6556
  MaxRecords?: number;
5960
6557
  /**
6558
+ * @public
5961
6559
  * <p>An optional parameter that specifies the starting point to return a set of response
5962
6560
  * records. When the results of a <a>DescribeClusterSnapshots</a> request exceed
5963
6561
  * the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
@@ -5967,6 +6565,7 @@ export interface DescribeClusterSnapshotsMessage {
5967
6565
  */
5968
6566
  Marker?: string;
5969
6567
  /**
6568
+ * @public
5970
6569
  * <p>The Amazon Web Services account used to create or copy the snapshot. Use this field to
5971
6570
  * filter the results to snapshots owned by a particular account. To describe snapshots you
5972
6571
  * own, either specify your Amazon Web Services account, or do not specify the
@@ -5974,6 +6573,7 @@ export interface DescribeClusterSnapshotsMessage {
5974
6573
  */
5975
6574
  OwnerAccount?: string;
5976
6575
  /**
6576
+ * @public
5977
6577
  * <p>A tag key or keys for which you want to return all matching cluster snapshots that
5978
6578
  * are associated with the specified key or keys. For example, suppose that you have
5979
6579
  * snapshots that are tagged with keys called <code>owner</code> and
@@ -5983,6 +6583,7 @@ export interface DescribeClusterSnapshotsMessage {
5983
6583
  */
5984
6584
  TagKeys?: string[];
5985
6585
  /**
6586
+ * @public
5986
6587
  * <p>A tag value or values for which you want to return all matching cluster snapshots
5987
6588
  * that are associated with the specified tag value or values. For example, suppose that
5988
6589
  * you have snapshots that are tagged with values called <code>admin</code> and
@@ -5992,6 +6593,7 @@ export interface DescribeClusterSnapshotsMessage {
5992
6593
  */
5993
6594
  TagValues?: string[];
5994
6595
  /**
6596
+ * @public
5995
6597
  * <p>A value that indicates whether to return snapshots only for an existing cluster.
5996
6598
  * You can perform table-level restore only by using a snapshot of an existing cluster,
5997
6599
  * that is, a cluster that has not been deleted. Values for this parameter work as follows: </p>
@@ -6019,6 +6621,7 @@ export interface DescribeClusterSnapshotsMessage {
6019
6621
  */
6020
6622
  ClusterExists?: boolean;
6021
6623
  /**
6624
+ * @public
6022
6625
  * <p></p>
6023
6626
  */
6024
6627
  SortingEntities?: SnapshotSortingEntity[];
@@ -6030,6 +6633,7 @@ export interface DescribeClusterSnapshotsMessage {
6030
6633
  */
6031
6634
  export interface SnapshotMessage {
6032
6635
  /**
6636
+ * @public
6033
6637
  * <p>A value that indicates the starting point for the next set of response records in a
6034
6638
  * subsequent request. If a value is returned in a response, you can retrieve the next set
6035
6639
  * of records by providing this returned marker value in the <code>Marker</code> parameter
@@ -6038,6 +6642,7 @@ export interface SnapshotMessage {
6038
6642
  */
6039
6643
  Marker?: string;
6040
6644
  /**
6645
+ * @public
6041
6646
  * <p>A list of <a>Snapshot</a> instances. </p>
6042
6647
  */
6043
6648
  Snapshots?: Snapshot[];
@@ -6048,10 +6653,12 @@ export interface SnapshotMessage {
6048
6653
  */
6049
6654
  export interface DescribeClusterSubnetGroupsMessage {
6050
6655
  /**
6656
+ * @public
6051
6657
  * <p>The name of the cluster subnet group for which information is requested.</p>
6052
6658
  */
6053
6659
  ClusterSubnetGroupName?: string;
6054
6660
  /**
6661
+ * @public
6055
6662
  * <p>The maximum number of response records to return in each call. If the number of
6056
6663
  * remaining response records exceeds the specified <code>MaxRecords</code> value, a value
6057
6664
  * is returned in a <code>marker</code> field of the response. You can retrieve the next
@@ -6062,6 +6669,7 @@ export interface DescribeClusterSubnetGroupsMessage {
6062
6669
  */
6063
6670
  MaxRecords?: number;
6064
6671
  /**
6672
+ * @public
6065
6673
  * <p>An optional parameter that specifies the starting point to return a set of response
6066
6674
  * records. When the results of a <a>DescribeClusterSubnetGroups</a> request
6067
6675
  * exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
@@ -6071,6 +6679,7 @@ export interface DescribeClusterSubnetGroupsMessage {
6071
6679
  */
6072
6680
  Marker?: string;
6073
6681
  /**
6682
+ * @public
6074
6683
  * <p>A tag key or keys for which you want to return all matching cluster subnet groups
6075
6684
  * that are associated with the specified key or keys. For example, suppose that you have
6076
6685
  * subnet groups that are tagged with keys called <code>owner</code> and
@@ -6080,6 +6689,7 @@ export interface DescribeClusterSubnetGroupsMessage {
6080
6689
  */
6081
6690
  TagKeys?: string[];
6082
6691
  /**
6692
+ * @public
6083
6693
  * <p>A tag value or values for which you want to return all matching cluster subnet
6084
6694
  * groups that are associated with the specified tag value or values. For example, suppose
6085
6695
  * that you have subnet groups that are tagged with values called <code>admin</code> and
@@ -6094,14 +6704,17 @@ export interface DescribeClusterSubnetGroupsMessage {
6094
6704
  */
6095
6705
  export interface DescribeClusterTracksMessage {
6096
6706
  /**
6707
+ * @public
6097
6708
  * <p>The name of the maintenance track. </p>
6098
6709
  */
6099
6710
  MaintenanceTrackName?: string;
6100
6711
  /**
6712
+ * @public
6101
6713
  * <p>An integer value for the maximum number of maintenance tracks to return.</p>
6102
6714
  */
6103
6715
  MaxRecords?: number;
6104
6716
  /**
6717
+ * @public
6105
6718
  * <p>An optional parameter that specifies the starting point to return a set of response
6106
6719
  * records. When the results of a <code>DescribeClusterTracks</code> request exceed the
6107
6720
  * value specified in <code>MaxRecords</code>, Amazon Redshift returns a value in the
@@ -6117,6 +6730,7 @@ export interface DescribeClusterTracksMessage {
6117
6730
  */
6118
6731
  export interface SupportedOperation {
6119
6732
  /**
6733
+ * @public
6120
6734
  * <p>A list of the supported operations.</p>
6121
6735
  */
6122
6736
  OperationName?: string;
@@ -6127,14 +6741,17 @@ export interface SupportedOperation {
6127
6741
  */
6128
6742
  export interface UpdateTarget {
6129
6743
  /**
6744
+ * @public
6130
6745
  * <p>The name of the new maintenance track.</p>
6131
6746
  */
6132
6747
  MaintenanceTrackName?: string;
6133
6748
  /**
6749
+ * @public
6134
6750
  * <p>The cluster version for the new maintenance track.</p>
6135
6751
  */
6136
6752
  DatabaseVersion?: string;
6137
6753
  /**
6754
+ * @public
6138
6755
  * <p>A list of operations supported by the maintenance track.</p>
6139
6756
  */
6140
6757
  SupportedOperations?: SupportedOperation[];
@@ -6149,15 +6766,18 @@ export interface UpdateTarget {
6149
6766
  */
6150
6767
  export interface MaintenanceTrack {
6151
6768
  /**
6769
+ * @public
6152
6770
  * <p>The name of the maintenance track. Possible values are <code>current</code> and
6153
6771
  * <code>trailing</code>.</p>
6154
6772
  */
6155
6773
  MaintenanceTrackName?: string;
6156
6774
  /**
6775
+ * @public
6157
6776
  * <p>The version number for the cluster release.</p>
6158
6777
  */
6159
6778
  DatabaseVersion?: string;
6160
6779
  /**
6780
+ * @public
6161
6781
  * <p>An array of <a>UpdateTarget</a> objects to update with the maintenance
6162
6782
  * track. </p>
6163
6783
  */
@@ -6168,11 +6788,13 @@ export interface MaintenanceTrack {
6168
6788
  */
6169
6789
  export interface TrackListMessage {
6170
6790
  /**
6791
+ * @public
6171
6792
  * <p>A list of maintenance tracks output by the <code>DescribeClusterTracks</code>
6172
6793
  * operation. </p>
6173
6794
  */
6174
6795
  MaintenanceTracks?: MaintenanceTrack[];
6175
6796
  /**
6797
+ * @public
6176
6798
  * <p>The starting point to return a set of response tracklist records. You can retrieve the
6177
6799
  * next set of response records by providing the returned marker value in the
6178
6800
  * <code>Marker</code> parameter and retrying the request.</p>
@@ -6185,12 +6807,14 @@ export interface TrackListMessage {
6185
6807
  */
6186
6808
  export interface DescribeClusterVersionsMessage {
6187
6809
  /**
6810
+ * @public
6188
6811
  * <p>The specific cluster version to return.</p>
6189
6812
  * <p>Example: <code>1.0</code>
6190
6813
  * </p>
6191
6814
  */
6192
6815
  ClusterVersion?: string;
6193
6816
  /**
6817
+ * @public
6194
6818
  * <p>The name of a specific cluster parameter group family to return details
6195
6819
  * for.</p>
6196
6820
  * <p>Constraints:</p>
@@ -6208,6 +6832,7 @@ export interface DescribeClusterVersionsMessage {
6208
6832
  */
6209
6833
  ClusterParameterGroupFamily?: string;
6210
6834
  /**
6835
+ * @public
6211
6836
  * <p>The maximum number of response records to return in each call. If the number of
6212
6837
  * remaining response records exceeds the specified <code>MaxRecords</code> value, a value
6213
6838
  * is returned in a <code>marker</code> field of the response. You can retrieve the next
@@ -6218,6 +6843,7 @@ export interface DescribeClusterVersionsMessage {
6218
6843
  */
6219
6844
  MaxRecords?: number;
6220
6845
  /**
6846
+ * @public
6221
6847
  * <p>An optional parameter that specifies the starting point to return a set of response
6222
6848
  * records. When the results of a <a>DescribeClusterVersions</a> request exceed
6223
6849
  * the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
@@ -6232,18 +6858,22 @@ export interface DescribeClusterVersionsMessage {
6232
6858
  */
6233
6859
  export interface DescribeCustomDomainAssociationsMessage {
6234
6860
  /**
6861
+ * @public
6235
6862
  * <p>The custom domain name for the custom domain association.</p>
6236
6863
  */
6237
6864
  CustomDomainName?: string;
6238
6865
  /**
6866
+ * @public
6239
6867
  * <p>The certificate Amazon Resource Name (ARN) for the custom domain association.</p>
6240
6868
  */
6241
6869
  CustomDomainCertificateArn?: string;
6242
6870
  /**
6871
+ * @public
6243
6872
  * <p>The maximum records setting for the associated custom domain.</p>
6244
6873
  */
6245
6874
  MaxRecords?: number;
6246
6875
  /**
6876
+ * @public
6247
6877
  * <p>The marker for the custom domain association.</p>
6248
6878
  */
6249
6879
  Marker?: string;
@@ -6253,10 +6883,12 @@ export interface DescribeCustomDomainAssociationsMessage {
6253
6883
  */
6254
6884
  export interface DescribeDataSharesMessage {
6255
6885
  /**
6886
+ * @public
6256
6887
  * <p>The identifier of the datashare to describe details of.</p>
6257
6888
  */
6258
6889
  DataShareArn?: string;
6259
6890
  /**
6891
+ * @public
6260
6892
  * <p>The maximum number of response records to return in each call. If the number of
6261
6893
  * remaining response records exceeds the specified <code>MaxRecords</code> value, a value
6262
6894
  * is returned in a <code>marker</code> field of the response. You can retrieve the next
@@ -6264,6 +6896,7 @@ export interface DescribeDataSharesMessage {
6264
6896
  */
6265
6897
  MaxRecords?: number;
6266
6898
  /**
6899
+ * @public
6267
6900
  * <p>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeDataShares</a> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </p>
6268
6901
  */
6269
6902
  Marker?: string;
@@ -6273,10 +6906,12 @@ export interface DescribeDataSharesMessage {
6273
6906
  */
6274
6907
  export interface DescribeDataSharesResult {
6275
6908
  /**
6909
+ * @public
6276
6910
  * <p>The results returned from describing datashares.</p>
6277
6911
  */
6278
6912
  DataShares?: DataShare[];
6279
6913
  /**
6914
+ * @public
6280
6915
  * <p>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeDataShares</a> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </p>
6281
6916
  */
6282
6917
  Marker?: string;
@@ -6286,15 +6921,18 @@ export interface DescribeDataSharesResult {
6286
6921
  */
6287
6922
  export interface DescribeDataSharesForConsumerMessage {
6288
6923
  /**
6924
+ * @public
6289
6925
  * <p>The Amazon Resource Name (ARN) of the consumer that returns in the list of datashares.</p>
6290
6926
  */
6291
6927
  ConsumerArn?: string;
6292
6928
  /**
6929
+ * @public
6293
6930
  * <p>An identifier giving the status of a datashare in the consumer cluster. If this field is specified, Amazon
6294
6931
  * Redshift returns the list of datashares that have the specified status.</p>
6295
6932
  */
6296
6933
  Status?: DataShareStatusForConsumer | string;
6297
6934
  /**
6935
+ * @public
6298
6936
  * <p>The maximum number of response records to return in each call. If the number of
6299
6937
  * remaining response records exceeds the specified <code>MaxRecords</code> value, a value
6300
6938
  * is returned in a <code>marker</code> field of the response. You can retrieve the next
@@ -6302,6 +6940,7 @@ export interface DescribeDataSharesForConsumerMessage {
6302
6940
  */
6303
6941
  MaxRecords?: number;
6304
6942
  /**
6943
+ * @public
6305
6944
  * <p>An optional parameter that specifies the starting point to return a set of response
6306
6945
  * records. When the results of a <a>DescribeDataSharesForConsumer</a> request
6307
6946
  * exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
@@ -6316,10 +6955,12 @@ export interface DescribeDataSharesForConsumerMessage {
6316
6955
  */
6317
6956
  export interface DescribeDataSharesForConsumerResult {
6318
6957
  /**
6958
+ * @public
6319
6959
  * <p>Shows the results of datashares available for consumers.</p>
6320
6960
  */
6321
6961
  DataShares?: DataShare[];
6322
6962
  /**
6963
+ * @public
6323
6964
  * <p>An optional parameter that specifies the starting point to return a set of response
6324
6965
  * records. When the results of a <a>DescribeDataSharesForConsumer</a> request
6325
6966
  * exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
@@ -6334,15 +6975,18 @@ export interface DescribeDataSharesForConsumerResult {
6334
6975
  */
6335
6976
  export interface DescribeDataSharesForProducerMessage {
6336
6977
  /**
6978
+ * @public
6337
6979
  * <p>The Amazon Resource Name (ARN) of the producer that returns in the list of datashares.</p>
6338
6980
  */
6339
6981
  ProducerArn?: string;
6340
6982
  /**
6983
+ * @public
6341
6984
  * <p>An identifier giving the status of a datashare in the producer. If this field is specified, Amazon
6342
6985
  * Redshift returns the list of datashares that have the specified status.</p>
6343
6986
  */
6344
6987
  Status?: DataShareStatusForProducer | string;
6345
6988
  /**
6989
+ * @public
6346
6990
  * <p>The maximum number of response records to return in each call. If the number of
6347
6991
  * remaining response records exceeds the specified <code>MaxRecords</code> value, a value
6348
6992
  * is returned in a <code>marker</code> field of the response. You can retrieve the next
@@ -6350,6 +6994,7 @@ export interface DescribeDataSharesForProducerMessage {
6350
6994
  */
6351
6995
  MaxRecords?: number;
6352
6996
  /**
6997
+ * @public
6353
6998
  * <p>An optional parameter that specifies the starting point to return a set of response
6354
6999
  * records. When the results of a <a>DescribeDataSharesForProducer</a> request
6355
7000
  * exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
@@ -6364,10 +7009,12 @@ export interface DescribeDataSharesForProducerMessage {
6364
7009
  */
6365
7010
  export interface DescribeDataSharesForProducerResult {
6366
7011
  /**
7012
+ * @public
6367
7013
  * <p>Shows the results of datashares available for producers.</p>
6368
7014
  */
6369
7015
  DataShares?: DataShare[];
6370
7016
  /**
7017
+ * @public
6371
7018
  * <p>An optional parameter that specifies the starting point to return a set of response
6372
7019
  * records. When the results of a <a>DescribeDataSharesForProducer</a> request
6373
7020
  * exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the
@@ -6383,10 +7030,12 @@ export interface DescribeDataSharesForProducerResult {
6383
7030
  */
6384
7031
  export interface DescribeDefaultClusterParametersMessage {
6385
7032
  /**
7033
+ * @public
6386
7034
  * <p>The name of the cluster parameter group family.</p>
6387
7035
  */
6388
7036
  ParameterGroupFamily: string | undefined;
6389
7037
  /**
7038
+ * @public
6390
7039
  * <p>The maximum number of response records to return in each call. If the number of
6391
7040
  * remaining response records exceeds the specified <code>MaxRecords</code> value, a value
6392
7041
  * is returned in a <code>marker</code> field of the response. You can retrieve the next
@@ -6397,6 +7046,7 @@ export interface DescribeDefaultClusterParametersMessage {
6397
7046
  */
6398
7047
  MaxRecords?: number;
6399
7048
  /**
7049
+ * @public
6400
7050
  * <p>An optional parameter that specifies the starting point to return a set of response
6401
7051
  * records. When the results of a <a>DescribeDefaultClusterParameters</a>
6402
7052
  * request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in
@@ -6411,6 +7061,7 @@ export interface DescribeDefaultClusterParametersMessage {
6411
7061
  */
6412
7062
  export interface DescribeDefaultClusterParametersResult {
6413
7063
  /**
7064
+ * @public
6414
7065
  * <p>Describes the default cluster parameters for a parameter group family.</p>
6415
7066
  */
6416
7067
  DefaultClusterParameters?: DefaultClusterParameters;
@@ -6420,28 +7071,34 @@ export interface DescribeDefaultClusterParametersResult {
6420
7071
  */
6421
7072
  export interface DescribeEndpointAccessMessage {
6422
7073
  /**
7074
+ * @public
6423
7075
  * <p>The cluster identifier associated with the described endpoint.</p>
6424
7076
  */
6425
7077
  ClusterIdentifier?: string;
6426
7078
  /**
7079
+ * @public
6427
7080
  * <p>The Amazon Web Services account ID of the owner of the cluster.</p>
6428
7081
  */
6429
7082
  ResourceOwner?: string;
6430
7083
  /**
7084
+ * @public
6431
7085
  * <p>The name of the endpoint to be described.</p>
6432
7086
  */
6433
7087
  EndpointName?: string;
6434
7088
  /**
7089
+ * @public
6435
7090
  * <p>The virtual private cloud (VPC) identifier with access to the cluster.</p>
6436
7091
  */
6437
7092
  VpcId?: string;
6438
7093
  /**
7094
+ * @public
6439
7095
  * <p>The maximum number of records to include in the response. If more records exist
6440
7096
  * than the specified <code>MaxRecords</code> value, a pagination token called a <code>Marker</code> is
6441
7097
  * included in the response so that the remaining results can be retrieved.</p>
6442
7098
  */
6443
7099
  MaxRecords?: number;
6444
7100
  /**
7101
+ * @public
6445
7102
  * <p>An optional pagination token provided by a previous
6446
7103
  * <code>DescribeEndpointAccess</code> request. If this parameter is specified, the
6447
7104
  * response includes only records beyond the marker, up to the value specified by the
@@ -6454,10 +7111,12 @@ export interface DescribeEndpointAccessMessage {
6454
7111
  */
6455
7112
  export interface EndpointAccessList {
6456
7113
  /**
7114
+ * @public
6457
7115
  * <p>The list of endpoints with access to the cluster.</p>
6458
7116
  */
6459
7117
  EndpointAccessList?: EndpointAccess[];
6460
7118
  /**
7119
+ * @public
6461
7120
  * <p>An optional pagination token provided by a previous
6462
7121
  * <code>DescribeEndpointAccess</code> request. If this parameter is specified, the
6463
7122
  * response includes only records beyond the marker, up to the value specified by the
@@ -6470,27 +7129,32 @@ export interface EndpointAccessList {
6470
7129
  */
6471
7130
  export interface DescribeEndpointAuthorizationMessage {
6472
7131
  /**
7132
+ * @public
6473
7133
  * <p>The cluster identifier of the cluster to access.</p>
6474
7134
  */
6475
7135
  ClusterIdentifier?: string;
6476
7136
  /**
7137
+ * @public
6477
7138
  * <p>The Amazon Web Services account ID of either the cluster owner (grantor) or grantee.
6478
7139
  * If <code>Grantee</code> parameter is true, then the <code>Account</code> value is of the grantor.</p>
6479
7140
  */
6480
7141
  Account?: string;
6481
7142
  /**
7143
+ * @public
6482
7144
  * <p>Indicates whether to check authorization from a grantor or grantee point of view.
6483
7145
  * If true, Amazon Redshift returns endpoint authorizations that you've been granted.
6484
7146
  * If false (default), checks authorization from a grantor point of view.</p>
6485
7147
  */
6486
7148
  Grantee?: boolean;
6487
7149
  /**
7150
+ * @public
6488
7151
  * <p>The maximum number of records to include in the response. If more records exist
6489
7152
  * than the specified <code>MaxRecords</code> value, a pagination token called a <code>Marker</code> is
6490
7153
  * included in the response so that the remaining results can be retrieved.</p>
6491
7154
  */
6492
7155
  MaxRecords?: number;
6493
7156
  /**
7157
+ * @public
6494
7158
  * <p>An optional pagination token provided by a previous
6495
7159
  * <code>DescribeEndpointAuthorization</code> request. If this parameter is specified, the
6496
7160
  * response includes only records beyond the marker, up to the value specified by the
@@ -6503,10 +7167,12 @@ export interface DescribeEndpointAuthorizationMessage {
6503
7167
  */
6504
7168
  export interface EndpointAuthorizationList {
6505
7169
  /**
7170
+ * @public
6506
7171
  * <p>The authorizations to an endpoint.</p>
6507
7172
  */
6508
7173
  EndpointAuthorizationList?: EndpointAuthorization[];
6509
7174
  /**
7175
+ * @public
6510
7176
  * <p>An optional pagination token provided by a previous
6511
7177
  * <code>DescribeEndpointAuthorization</code> request. If this parameter is specified, the
6512
7178
  * response includes only records beyond the marker, up to the value specified by the
@@ -6520,6 +7186,7 @@ export interface EndpointAuthorizationList {
6520
7186
  */
6521
7187
  export interface DescribeEventCategoriesMessage {
6522
7188
  /**
7189
+ * @public
6523
7190
  * <p>The source type, such as cluster or parameter group, to which the described event
6524
7191
  * categories apply.</p>
6525
7192
  * <p>Valid values: cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, and scheduled-action.</p>
@@ -6532,18 +7199,22 @@ export interface DescribeEventCategoriesMessage {
6532
7199
  */
6533
7200
  export interface EventInfoMap {
6534
7201
  /**
7202
+ * @public
6535
7203
  * <p>The identifier of an Amazon Redshift event.</p>
6536
7204
  */
6537
7205
  EventId?: string;
6538
7206
  /**
7207
+ * @public
6539
7208
  * <p>The category of an Amazon Redshift event.</p>
6540
7209
  */
6541
7210
  EventCategories?: string[];
6542
7211
  /**
7212
+ * @public
6543
7213
  * <p>The description of an Amazon Redshift event.</p>
6544
7214
  */
6545
7215
  EventDescription?: string;
6546
7216
  /**
7217
+ * @public
6547
7218
  * <p>The severity of the event.</p>
6548
7219
  * <p>Values: ERROR, INFO</p>
6549
7220
  */
@@ -6555,11 +7226,13 @@ export interface EventInfoMap {
6555
7226
  */
6556
7227
  export interface EventCategoriesMap {
6557
7228
  /**
7229
+ * @public
6558
7230
  * <p>The source type, such as cluster or cluster-snapshot, that the returned categories
6559
7231
  * belong to.</p>
6560
7232
  */
6561
7233
  SourceType?: string;
6562
7234
  /**
7235
+ * @public
6563
7236
  * <p>The events in the event category.</p>
6564
7237
  */
6565
7238
  Events?: EventInfoMap[];