@aws-sdk/client-kafka 3.380.0 → 3.385.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -6,10 +6,12 @@ import { KafkaServiceException as __BaseException } from "./KafkaServiceExceptio
6
6
  */
7
7
  export interface ProvisionedThroughput {
8
8
  /**
9
+ * @public
9
10
  * <p>Provisioned throughput is enabled or not.</p>
10
11
  */
11
12
  Enabled?: boolean;
12
13
  /**
14
+ * @public
13
15
  * <p>Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.</p>
14
16
  */
15
17
  VolumeThroughput?: number;
@@ -20,14 +22,17 @@ export interface ProvisionedThroughput {
20
22
  */
21
23
  export interface BrokerEBSVolumeInfo {
22
24
  /**
25
+ * @public
23
26
  * <p>The ID of the broker to update.</p>
24
27
  */
25
28
  KafkaBrokerNodeId: string | undefined;
26
29
  /**
30
+ * @public
27
31
  * <p>EBS volume provisioned throughput information.</p>
28
32
  */
29
33
  ProvisionedThroughput?: ProvisionedThroughput;
30
34
  /**
35
+ * @public
31
36
  * <p>Size of the EBS volume to update.</p>
32
37
  */
33
38
  VolumeSizeGB?: number;
@@ -56,22 +61,27 @@ export type VpcConnectionState = (typeof VpcConnectionState)[keyof typeof VpcCon
56
61
  */
57
62
  export interface ClientVpcConnection {
58
63
  /**
64
+ * @public
59
65
  * <p>Information about the auth scheme of Vpc Connection.</p>
60
66
  */
61
67
  Authentication?: string;
62
68
  /**
69
+ * @public
63
70
  * <p>Creation time of the Vpc Connection.</p>
64
71
  */
65
72
  CreationTime?: Date;
66
73
  /**
74
+ * @public
67
75
  * <p>State of the Vpc Connection.</p>
68
76
  */
69
77
  State?: VpcConnectionState | string;
70
78
  /**
79
+ * @public
71
80
  * <p>The ARN that identifies the Vpc Connection.</p>
72
81
  */
73
82
  VpcConnectionArn: string | undefined;
74
83
  /**
84
+ * @public
75
85
  * <p>The Owner of the Vpc Connection.</p>
76
86
  */
77
87
  Owner?: string;
@@ -105,6 +115,7 @@ export type BrokerAZDistribution = (typeof BrokerAZDistribution)[keyof typeof Br
105
115
  */
106
116
  export interface PublicAccess {
107
117
  /**
118
+ * @public
108
119
  * <p>The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.</p>
109
120
  */
110
121
  Type?: string;
@@ -115,6 +126,7 @@ export interface PublicAccess {
115
126
  */
116
127
  export interface VpcConnectivityIam {
117
128
  /**
129
+ * @public
118
130
  * <p>SASL/IAM authentication is on or off for VPC connectivity.</p>
119
131
  */
120
132
  Enabled?: boolean;
@@ -125,6 +137,7 @@ export interface VpcConnectivityIam {
125
137
  */
126
138
  export interface VpcConnectivityScram {
127
139
  /**
140
+ * @public
128
141
  * <p>SASL/SCRAM authentication is on or off for VPC connectivity.</p>
129
142
  */
130
143
  Enabled?: boolean;
@@ -135,10 +148,12 @@ export interface VpcConnectivityScram {
135
148
  */
136
149
  export interface VpcConnectivitySasl {
137
150
  /**
151
+ * @public
138
152
  * <p>Details for SASL/SCRAM client authentication for VPC connectivity.</p>
139
153
  */
140
154
  Scram?: VpcConnectivityScram;
141
155
  /**
156
+ * @public
142
157
  * <p>Details for SASL/IAM client authentication for VPC connectivity.</p>
143
158
  */
144
159
  Iam?: VpcConnectivityIam;
@@ -149,6 +164,7 @@ export interface VpcConnectivitySasl {
149
164
  */
150
165
  export interface VpcConnectivityTls {
151
166
  /**
167
+ * @public
152
168
  * <p>TLS authentication is on or off for VPC connectivity.</p>
153
169
  */
154
170
  Enabled?: boolean;
@@ -159,10 +175,12 @@ export interface VpcConnectivityTls {
159
175
  */
160
176
  export interface VpcConnectivityClientAuthentication {
161
177
  /**
178
+ * @public
162
179
  * <p>SASL authentication type details for VPC connectivity.</p>
163
180
  */
164
181
  Sasl?: VpcConnectivitySasl;
165
182
  /**
183
+ * @public
166
184
  * <p>TLS authentication type details for VPC connectivity.</p>
167
185
  */
168
186
  Tls?: VpcConnectivityTls;
@@ -173,6 +191,7 @@ export interface VpcConnectivityClientAuthentication {
173
191
  */
174
192
  export interface VpcConnectivity {
175
193
  /**
194
+ * @public
176
195
  * <p>Includes all client authentication information for VPC connectivity.</p>
177
196
  */
178
197
  ClientAuthentication?: VpcConnectivityClientAuthentication;
@@ -183,10 +202,12 @@ export interface VpcConnectivity {
183
202
  */
184
203
  export interface ConnectivityInfo {
185
204
  /**
205
+ * @public
186
206
  * <p>Public access control for brokers.</p>
187
207
  */
188
208
  PublicAccess?: PublicAccess;
189
209
  /**
210
+ * @public
190
211
  * <p>VPC connectivity access control for brokers.</p>
191
212
  */
192
213
  VpcConnectivity?: VpcConnectivity;
@@ -197,10 +218,12 @@ export interface ConnectivityInfo {
197
218
  */
198
219
  export interface EBSStorageInfo {
199
220
  /**
221
+ * @public
200
222
  * <p>EBS volume provisioned throughput information.</p>
201
223
  */
202
224
  ProvisionedThroughput?: ProvisionedThroughput;
203
225
  /**
226
+ * @public
204
227
  * <p>The size in GiB of the EBS volume for the data drive on each broker node.</p>
205
228
  */
206
229
  VolumeSize?: number;
@@ -211,6 +234,7 @@ export interface EBSStorageInfo {
211
234
  */
212
235
  export interface StorageInfo {
213
236
  /**
237
+ * @public
214
238
  * <p>EBS volume information.</p>
215
239
  */
216
240
  EbsStorageInfo?: EBSStorageInfo;
@@ -221,32 +245,39 @@ export interface StorageInfo {
221
245
  */
222
246
  export interface BrokerNodeGroupInfo {
223
247
  /**
248
+ * @public
224
249
  * <p>The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.</p>
225
250
  * <p>Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.</p>
226
251
  */
227
252
  BrokerAZDistribution?: BrokerAZDistribution | string;
228
253
  /**
254
+ * @public
229
255
  * <p>The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't occupy the Availability Zone with ID use use1-az3.</p>
230
256
  */
231
257
  ClientSubnets: string[] | undefined;
232
258
  /**
259
+ * @public
233
260
  * <p>The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge,
234
261
  * kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.</p>
235
262
  */
236
263
  InstanceType: string | undefined;
237
264
  /**
265
+ * @public
238
266
  * <p>The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.</p>
239
267
  */
240
268
  SecurityGroups?: string[];
241
269
  /**
270
+ * @public
242
271
  * <p>Contains information about storage volumes attached to MSK broker nodes.</p>
243
272
  */
244
273
  StorageInfo?: StorageInfo;
245
274
  /**
275
+ * @public
246
276
  * <p>Information about the broker access configuration.</p>
247
277
  */
248
278
  ConnectivityInfo?: ConnectivityInfo;
249
279
  /**
280
+ * @public
250
281
  * <p>The list of zoneIds for the cluster in the virtual private cloud (VPC).</p>
251
282
  */
252
283
  ZoneIds?: string[];
@@ -257,6 +288,7 @@ export interface BrokerNodeGroupInfo {
257
288
  */
258
289
  export interface Iam {
259
290
  /**
291
+ * @public
260
292
  * <p>Indicates whether IAM access control is enabled.</p>
261
293
  */
262
294
  Enabled?: boolean;
@@ -267,6 +299,7 @@ export interface Iam {
267
299
  */
268
300
  export interface Scram {
269
301
  /**
302
+ * @public
270
303
  * <p>SASL/SCRAM authentication is enabled or not.</p>
271
304
  */
272
305
  Enabled?: boolean;
@@ -277,10 +310,12 @@ export interface Scram {
277
310
  */
278
311
  export interface Sasl {
279
312
  /**
313
+ * @public
280
314
  * <p>Details for SASL/SCRAM client authentication.</p>
281
315
  */
282
316
  Scram?: Scram;
283
317
  /**
318
+ * @public
284
319
  * <p>Indicates whether IAM access control is enabled.</p>
285
320
  */
286
321
  Iam?: Iam;
@@ -291,10 +326,12 @@ export interface Sasl {
291
326
  */
292
327
  export interface Tls {
293
328
  /**
329
+ * @public
294
330
  * <p>List of ACM Certificate Authority ARNs.</p>
295
331
  */
296
332
  CertificateAuthorityArnList?: string[];
297
333
  /**
334
+ * @public
298
335
  * <p>Specifies whether you want to turn on or turn off TLS authentication.</p>
299
336
  */
300
337
  Enabled?: boolean;
@@ -304,6 +341,7 @@ export interface Tls {
304
341
  */
305
342
  export interface Unauthenticated {
306
343
  /**
344
+ * @public
307
345
  * <p>Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.</p>
308
346
  */
309
347
  Enabled?: boolean;
@@ -314,14 +352,17 @@ export interface Unauthenticated {
314
352
  */
315
353
  export interface ClientAuthentication {
316
354
  /**
355
+ * @public
317
356
  * <p>Details for ClientAuthentication using SASL.</p>
318
357
  */
319
358
  Sasl?: Sasl;
320
359
  /**
360
+ * @public
321
361
  * <p>Details for ClientAuthentication using TLS.</p>
322
362
  */
323
363
  Tls?: Tls;
324
364
  /**
365
+ * @public
325
366
  * <p>Contains information about unauthenticated traffic to the cluster.</p>
326
367
  */
327
368
  Unauthenticated?: Unauthenticated;
@@ -332,14 +373,17 @@ export interface ClientAuthentication {
332
373
  */
333
374
  export interface BrokerSoftwareInfo {
334
375
  /**
376
+ * @public
335
377
  * <p>The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.</p>
336
378
  */
337
379
  ConfigurationArn?: string;
338
380
  /**
381
+ * @public
339
382
  * <p>The revision of the configuration to use. This field isn't visible in this preview release.</p>
340
383
  */
341
384
  ConfigurationRevision?: number;
342
385
  /**
386
+ * @public
343
387
  * <p>The version of Apache Kafka.</p>
344
388
  */
345
389
  KafkaVersion?: string;
@@ -350,6 +394,7 @@ export interface BrokerSoftwareInfo {
350
394
  */
351
395
  export interface EncryptionAtRest {
352
396
  /**
397
+ * @public
353
398
  * <p>The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.</p>
354
399
  */
355
400
  DataVolumeKMSKeyId: string | undefined;
@@ -373,6 +418,7 @@ export type ClientBroker = (typeof ClientBroker)[keyof typeof ClientBroker];
373
418
  */
374
419
  export interface EncryptionInTransit {
375
420
  /**
421
+ * @public
376
422
  * <p>Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.</p>
377
423
  * <p>
378
424
  * TLS means that client-broker communication is enabled with TLS only.</p>
@@ -384,6 +430,7 @@ export interface EncryptionInTransit {
384
430
  */
385
431
  ClientBroker?: ClientBroker | string;
386
432
  /**
433
+ * @public
387
434
  * <p>When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.</p>
388
435
  * <p>The default value is true.</p>
389
436
  */
@@ -395,10 +442,12 @@ export interface EncryptionInTransit {
395
442
  */
396
443
  export interface EncryptionInfo {
397
444
  /**
445
+ * @public
398
446
  * <p>The data-volume encryption details.</p>
399
447
  */
400
448
  EncryptionAtRest?: EncryptionAtRest;
401
449
  /**
450
+ * @public
402
451
  * <p>The details for encryption in transit.</p>
403
452
  */
404
453
  EncryptionInTransit?: EncryptionInTransit;
@@ -459,6 +508,7 @@ export interface LoggingInfo {
459
508
  */
460
509
  export interface JmxExporterInfo {
461
510
  /**
511
+ * @public
462
512
  * <p>Indicates whether you want to turn on or turn off the JMX Exporter.</p>
463
513
  */
464
514
  EnabledInBroker: boolean | undefined;
@@ -469,6 +519,7 @@ export interface JmxExporterInfo {
469
519
  */
470
520
  export interface NodeExporterInfo {
471
521
  /**
522
+ * @public
472
523
  * <p>Indicates whether you want to turn on or turn off the Node Exporter.</p>
473
524
  */
474
525
  EnabledInBroker: boolean | undefined;
@@ -479,10 +530,12 @@ export interface NodeExporterInfo {
479
530
  */
480
531
  export interface PrometheusInfo {
481
532
  /**
533
+ * @public
482
534
  * <p>Indicates whether you want to turn on or turn off the JMX Exporter.</p>
483
535
  */
484
536
  JmxExporter?: JmxExporterInfo;
485
537
  /**
538
+ * @public
486
539
  * <p>Indicates whether you want to turn on or turn off the Node Exporter.</p>
487
540
  */
488
541
  NodeExporter?: NodeExporterInfo;
@@ -493,6 +546,7 @@ export interface PrometheusInfo {
493
546
  */
494
547
  export interface OpenMonitoringInfo {
495
548
  /**
549
+ * @public
496
550
  * <p>Prometheus settings.</p>
497
551
  */
498
552
  Prometheus: PrometheusInfo | undefined;
@@ -515,46 +569,57 @@ export type StorageMode = (typeof StorageMode)[keyof typeof StorageMode];
515
569
  */
516
570
  export interface Provisioned {
517
571
  /**
572
+ * @public
518
573
  * <p>Information about the brokers.</p>
519
574
  */
520
575
  BrokerNodeGroupInfo: BrokerNodeGroupInfo | undefined;
521
576
  /**
577
+ * @public
522
578
  * <p>Information about the Apache Kafka version deployed on the brokers.</p>
523
579
  */
524
580
  CurrentBrokerSoftwareInfo?: BrokerSoftwareInfo;
525
581
  /**
582
+ * @public
526
583
  * <p>Includes all client authentication information.</p>
527
584
  */
528
585
  ClientAuthentication?: ClientAuthentication;
529
586
  /**
587
+ * @public
530
588
  * <p>Includes all encryption-related information.</p>
531
589
  */
532
590
  EncryptionInfo?: EncryptionInfo;
533
591
  /**
592
+ * @public
534
593
  * <p>Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.</p>
535
594
  */
536
595
  EnhancedMonitoring?: EnhancedMonitoring | string;
537
596
  /**
597
+ * @public
538
598
  * <p>The settings for open monitoring.</p>
539
599
  */
540
600
  OpenMonitoring?: OpenMonitoringInfo;
541
601
  /**
602
+ * @public
542
603
  * <p>Log delivery information for the cluster.</p>
543
604
  */
544
605
  LoggingInfo?: LoggingInfo;
545
606
  /**
607
+ * @public
546
608
  * <p>The number of broker nodes in the cluster.</p>
547
609
  */
548
610
  NumberOfBrokerNodes: number | undefined;
549
611
  /**
612
+ * @public
550
613
  * <p>The connection string to use to connect to the Apache ZooKeeper cluster.</p>
551
614
  */
552
615
  ZookeeperConnectString?: string;
553
616
  /**
617
+ * @public
554
618
  * <p>The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port.</p>
555
619
  */
556
620
  ZookeeperConnectStringTls?: string;
557
621
  /**
622
+ * @public
558
623
  * <p>This controls storage mode for supported storage tiers.</p>
559
624
  */
560
625
  StorageMode?: StorageMode | string;
@@ -565,6 +630,7 @@ export interface Provisioned {
565
630
  */
566
631
  export interface ServerlessSasl {
567
632
  /**
633
+ * @public
568
634
  * <p>Indicates whether IAM access control is enabled.</p>
569
635
  */
570
636
  Iam?: Iam;
@@ -575,6 +641,7 @@ export interface ServerlessSasl {
575
641
  */
576
642
  export interface ServerlessClientAuthentication {
577
643
  /**
644
+ * @public
578
645
  * <p>Details for ClientAuthentication using SASL.</p>
579
646
  */
580
647
  Sasl?: ServerlessSasl;
@@ -585,10 +652,12 @@ export interface ServerlessClientAuthentication {
585
652
  */
586
653
  export interface VpcConfig {
587
654
  /**
655
+ * @public
588
656
  * <p>The IDs of the subnets associated with the cluster.</p>
589
657
  */
590
658
  SubnetIds: string[] | undefined;
591
659
  /**
660
+ * @public
592
661
  * <p>The IDs of the security groups associated with the cluster.</p>
593
662
  */
594
663
  SecurityGroupIds?: string[];
@@ -599,10 +668,12 @@ export interface VpcConfig {
599
668
  */
600
669
  export interface Serverless {
601
670
  /**
671
+ * @public
602
672
  * <p>The configuration of the Amazon VPCs for the cluster.</p>
603
673
  */
604
674
  VpcConfigs: VpcConfig[] | undefined;
605
675
  /**
676
+ * @public
606
677
  * <p>Includes all client authentication information.</p>
607
678
  */
608
679
  ClientAuthentication?: ServerlessClientAuthentication;
@@ -638,46 +709,57 @@ export interface StateInfo {
638
709
  */
639
710
  export interface Cluster {
640
711
  /**
712
+ * @public
641
713
  * <p>The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.</p>
642
714
  */
643
715
  ActiveOperationArn?: string;
644
716
  /**
717
+ * @public
645
718
  * <p>Cluster Type.</p>
646
719
  */
647
720
  ClusterType?: ClusterType | string;
648
721
  /**
722
+ * @public
649
723
  * <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>
650
724
  */
651
725
  ClusterArn?: string;
652
726
  /**
727
+ * @public
653
728
  * <p>The name of the cluster.</p>
654
729
  */
655
730
  ClusterName?: string;
656
731
  /**
732
+ * @public
657
733
  * <p>The time when the cluster was created.</p>
658
734
  */
659
735
  CreationTime?: Date;
660
736
  /**
737
+ * @public
661
738
  * <p>The current version of the MSK cluster.</p>
662
739
  */
663
740
  CurrentVersion?: string;
664
741
  /**
742
+ * @public
665
743
  * <p>The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.</p>
666
744
  */
667
745
  State?: ClusterState | string;
668
746
  /**
747
+ * @public
669
748
  * <p>State Info for the Amazon MSK cluster.</p>
670
749
  */
671
750
  StateInfo?: StateInfo;
672
751
  /**
752
+ * @public
673
753
  * <p>Tags attached to the cluster.</p>
674
754
  */
675
755
  Tags?: Record<string, string>;
676
756
  /**
757
+ * @public
677
758
  * <p>Information about the provisioned cluster.</p>
678
759
  */
679
760
  Provisioned?: Provisioned;
680
761
  /**
762
+ * @public
681
763
  * <p>Information about the serverless cluster.</p>
682
764
  */
683
765
  Serverless?: Serverless;
@@ -688,6 +770,7 @@ export interface Cluster {
688
770
  */
689
771
  export interface JmxExporter {
690
772
  /**
773
+ * @public
691
774
  * <p>Indicates whether you want to turn on or turn off the JMX Exporter.</p>
692
775
  */
693
776
  EnabledInBroker: boolean | undefined;
@@ -698,6 +781,7 @@ export interface JmxExporter {
698
781
  */
699
782
  export interface NodeExporter {
700
783
  /**
784
+ * @public
701
785
  * <p>Indicates whether you want to turn on or turn off the Node Exporter.</p>
702
786
  */
703
787
  EnabledInBroker: boolean | undefined;
@@ -708,10 +792,12 @@ export interface NodeExporter {
708
792
  */
709
793
  export interface Prometheus {
710
794
  /**
795
+ * @public
711
796
  * <p>Indicates whether you want to turn on or turn off the JMX Exporter.</p>
712
797
  */
713
798
  JmxExporter?: JmxExporter;
714
799
  /**
800
+ * @public
715
801
  * <p>Indicates whether you want to turn on or turn off the Node Exporter.</p>
716
802
  */
717
803
  NodeExporter?: NodeExporter;
@@ -722,6 +808,7 @@ export interface Prometheus {
722
808
  */
723
809
  export interface OpenMonitoring {
724
810
  /**
811
+ * @public
725
812
  * <p>Prometheus settings.</p>
726
813
  */
727
814
  Prometheus: Prometheus | undefined;
@@ -732,72 +819,89 @@ export interface OpenMonitoring {
732
819
  */
733
820
  export interface ClusterInfo {
734
821
  /**
822
+ * @public
735
823
  * <p>Arn of active cluster operation.</p>
736
824
  */
737
825
  ActiveOperationArn?: string;
738
826
  /**
827
+ * @public
739
828
  * <p>Information about the broker nodes.</p>
740
829
  */
741
830
  BrokerNodeGroupInfo?: BrokerNodeGroupInfo;
742
831
  /**
832
+ * @public
743
833
  * <p>Includes all client authentication information.</p>
744
834
  */
745
835
  ClientAuthentication?: ClientAuthentication;
746
836
  /**
837
+ * @public
747
838
  * <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>
748
839
  */
749
840
  ClusterArn?: string;
750
841
  /**
842
+ * @public
751
843
  * <p>The name of the cluster.</p>
752
844
  */
753
845
  ClusterName?: string;
754
846
  /**
847
+ * @public
755
848
  * <p>The time when the cluster was created.</p>
756
849
  */
757
850
  CreationTime?: Date;
758
851
  /**
852
+ * @public
759
853
  * <p>Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.</p>
760
854
  */
761
855
  CurrentBrokerSoftwareInfo?: BrokerSoftwareInfo;
762
856
  /**
857
+ * @public
763
858
  * <p>The current version of the MSK cluster.</p>
764
859
  */
765
860
  CurrentVersion?: string;
766
861
  /**
862
+ * @public
767
863
  * <p>Includes all encryption-related information.</p>
768
864
  */
769
865
  EncryptionInfo?: EncryptionInfo;
770
866
  /**
867
+ * @public
771
868
  * <p>Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see <a href="https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html">Monitoring</a>.</p>
772
869
  */
773
870
  EnhancedMonitoring?: EnhancedMonitoring | string;
774
871
  /**
872
+ * @public
775
873
  * <p>Settings for open monitoring using Prometheus.</p>
776
874
  */
777
875
  OpenMonitoring?: OpenMonitoring;
778
876
  LoggingInfo?: LoggingInfo;
779
877
  /**
878
+ * @public
780
879
  * <p>The number of broker nodes in the cluster.</p>
781
880
  */
782
881
  NumberOfBrokerNodes?: number;
783
882
  /**
883
+ * @public
784
884
  * <p>The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.</p>
785
885
  */
786
886
  State?: ClusterState | string;
787
887
  StateInfo?: StateInfo;
788
888
  /**
889
+ * @public
789
890
  * <p>Tags attached to the cluster.</p>
790
891
  */
791
892
  Tags?: Record<string, string>;
792
893
  /**
894
+ * @public
793
895
  * <p>The connection string to use to connect to the Apache ZooKeeper cluster.</p>
794
896
  */
795
897
  ZookeeperConnectString?: string;
796
898
  /**
899
+ * @public
797
900
  * <p>The connection string to use to connect to zookeeper cluster on Tls port.</p>
798
901
  */
799
902
  ZookeeperConnectStringTls?: string;
800
903
  /**
904
+ * @public
801
905
  * <p>This controls storage mode for supported storage tiers.</p>
802
906
  */
803
907
  StorageMode?: StorageMode | string;
@@ -808,10 +912,12 @@ export interface ClusterInfo {
808
912
  */
809
913
  export interface ErrorInfo {
810
914
  /**
915
+ * @public
811
916
  * <p>A number describing the error programmatically.</p>
812
917
  */
813
918
  ErrorCode?: string;
814
919
  /**
920
+ * @public
815
921
  * <p>An optional field to provide more details about the error.</p>
816
922
  */
817
923
  ErrorString?: string;
@@ -822,6 +928,7 @@ export interface ErrorInfo {
822
928
  */
823
929
  export interface ClusterOperationStepInfo {
824
930
  /**
931
+ * @public
825
932
  * <p>The steps current status.</p>
826
933
  */
827
934
  StepStatus?: string;
@@ -832,10 +939,12 @@ export interface ClusterOperationStepInfo {
832
939
  */
833
940
  export interface ClusterOperationStep {
834
941
  /**
942
+ * @public
835
943
  * <p>Information about the step and its status.</p>
836
944
  */
837
945
  StepInfo?: ClusterOperationStepInfo;
838
946
  /**
947
+ * @public
839
948
  * <p>The name of the step.</p>
840
949
  */
841
950
  StepName?: string;
@@ -846,10 +955,12 @@ export interface ClusterOperationStep {
846
955
  */
847
956
  export interface ConfigurationInfo {
848
957
  /**
958
+ * @public
849
959
  * <p>ARN of the configuration to use.</p>
850
960
  */
851
961
  Arn: string | undefined;
852
962
  /**
963
+ * @public
853
964
  * <p>The revision of the configuration to use.</p>
854
965
  */
855
966
  Revision: number | undefined;
@@ -860,50 +971,62 @@ export interface ConfigurationInfo {
860
971
  */
861
972
  export interface MutableClusterInfo {
862
973
  /**
974
+ * @public
863
975
  * <p>Specifies the size of the EBS volume and the ID of the associated broker.</p>
864
976
  */
865
977
  BrokerEBSVolumeInfo?: BrokerEBSVolumeInfo[];
866
978
  /**
979
+ * @public
867
980
  * <p>Information about the changes in the configuration of the brokers.</p>
868
981
  */
869
982
  ConfigurationInfo?: ConfigurationInfo;
870
983
  /**
984
+ * @public
871
985
  * <p>The number of broker nodes in the cluster.</p>
872
986
  */
873
987
  NumberOfBrokerNodes?: number;
874
988
  /**
989
+ * @public
875
990
  * <p>Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.</p>
876
991
  */
877
992
  EnhancedMonitoring?: EnhancedMonitoring | string;
878
993
  /**
994
+ * @public
879
995
  * <p>The settings for open monitoring.</p>
880
996
  */
881
997
  OpenMonitoring?: OpenMonitoring;
882
998
  /**
999
+ * @public
883
1000
  * <p>The Apache Kafka version.</p>
884
1001
  */
885
1002
  KafkaVersion?: string;
886
1003
  /**
1004
+ * @public
887
1005
  * <p>You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.</p>
888
1006
  */
889
1007
  LoggingInfo?: LoggingInfo;
890
1008
  /**
1009
+ * @public
891
1010
  * <p>Information about the Amazon MSK broker type.</p>
892
1011
  */
893
1012
  InstanceType?: string;
894
1013
  /**
1014
+ * @public
895
1015
  * <p>Includes all client authentication information.</p>
896
1016
  */
897
1017
  ClientAuthentication?: ClientAuthentication;
898
1018
  /**
1019
+ * @public
899
1020
  * <p>Includes all encryption-related information.</p>
900
1021
  */
901
1022
  EncryptionInfo?: EncryptionInfo;
902
1023
  /**
1024
+ * @public
903
1025
  * <p>Information about the broker access configuration.</p>
904
1026
  */
905
1027
  ConnectivityInfo?: ConnectivityInfo;
906
1028
  /**
1029
+ * @public
907
1030
  * <p>This controls storage mode for supported storage tiers.</p>
908
1031
  */
909
1032
  StorageMode?: StorageMode | string;
@@ -926,10 +1049,12 @@ export type UserIdentityType = (typeof UserIdentityType)[keyof typeof UserIdenti
926
1049
  */
927
1050
  export interface UserIdentity {
928
1051
  /**
1052
+ * @public
929
1053
  * <p>The identity type of the requester that calls the API operation.</p>
930
1054
  */
931
1055
  Type?: UserIdentityType | string;
932
1056
  /**
1057
+ * @public
933
1058
  * <p>A unique identifier for the requester that calls the API operation.</p>
934
1059
  */
935
1060
  PrincipalId?: string;
@@ -940,18 +1065,22 @@ export interface UserIdentity {
940
1065
  */
941
1066
  export interface VpcConnectionInfo {
942
1067
  /**
1068
+ * @public
943
1069
  * <p>The Amazon Resource Name (ARN) of the VPC connection.</p>
944
1070
  */
945
1071
  VpcConnectionArn?: string;
946
1072
  /**
1073
+ * @public
947
1074
  * <p>The owner of the VPC Connection.</p>
948
1075
  */
949
1076
  Owner?: string;
950
1077
  /**
1078
+ * @public
951
1079
  * <p>Description of the requester that calls the API operation.</p>
952
1080
  */
953
1081
  UserIdentity?: UserIdentity;
954
1082
  /**
1083
+ * @public
955
1084
  * <p>The time when Amazon MSK creates the VPC Connnection.</p>
956
1085
  */
957
1086
  CreationTime?: Date;
@@ -962,50 +1091,62 @@ export interface VpcConnectionInfo {
962
1091
  */
963
1092
  export interface ClusterOperationInfo {
964
1093
  /**
1094
+ * @public
965
1095
  * <p>The ID of the API request that triggered this operation.</p>
966
1096
  */
967
1097
  ClientRequestId?: string;
968
1098
  /**
1099
+ * @public
969
1100
  * <p>ARN of the cluster.</p>
970
1101
  */
971
1102
  ClusterArn?: string;
972
1103
  /**
1104
+ * @public
973
1105
  * <p>The time that the operation was created.</p>
974
1106
  */
975
1107
  CreationTime?: Date;
976
1108
  /**
1109
+ * @public
977
1110
  * <p>The time at which the operation finished.</p>
978
1111
  */
979
1112
  EndTime?: Date;
980
1113
  /**
1114
+ * @public
981
1115
  * <p>Describes the error if the operation fails.</p>
982
1116
  */
983
1117
  ErrorInfo?: ErrorInfo;
984
1118
  /**
1119
+ * @public
985
1120
  * <p>ARN of the cluster operation.</p>
986
1121
  */
987
1122
  OperationArn?: string;
988
1123
  /**
1124
+ * @public
989
1125
  * <p>State of the cluster operation.</p>
990
1126
  */
991
1127
  OperationState?: string;
992
1128
  /**
1129
+ * @public
993
1130
  * <p>Steps completed during the operation.</p>
994
1131
  */
995
1132
  OperationSteps?: ClusterOperationStep[];
996
1133
  /**
1134
+ * @public
997
1135
  * <p>Type of the cluster operation.</p>
998
1136
  */
999
1137
  OperationType?: string;
1000
1138
  /**
1139
+ * @public
1001
1140
  * <p>Information about cluster attributes before a cluster is updated.</p>
1002
1141
  */
1003
1142
  SourceClusterInfo?: MutableClusterInfo;
1004
1143
  /**
1144
+ * @public
1005
1145
  * <p>Information about cluster attributes after a cluster is updated.</p>
1006
1146
  */
1007
1147
  TargetClusterInfo?: MutableClusterInfo;
1008
1148
  /**
1149
+ * @public
1009
1150
  * <p>Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.</p>
1010
1151
  */
1011
1152
  VpcConnectionInfo?: VpcConnectionInfo;
@@ -1016,30 +1157,37 @@ export interface ClusterOperationInfo {
1016
1157
  */
1017
1158
  export interface ClusterOperationV2Summary {
1018
1159
  /**
1160
+ * @public
1019
1161
  * <p>ARN of the cluster.</p>
1020
1162
  */
1021
1163
  ClusterArn?: string;
1022
1164
  /**
1165
+ * @public
1023
1166
  * <p>Type of the backend cluster.</p>
1024
1167
  */
1025
1168
  ClusterType?: ClusterType | string;
1026
1169
  /**
1170
+ * @public
1027
1171
  * <p>The time at which operation was started.</p>
1028
1172
  */
1029
1173
  StartTime?: Date;
1030
1174
  /**
1175
+ * @public
1031
1176
  * <p>The time at which the operation finished.</p>
1032
1177
  */
1033
1178
  EndTime?: Date;
1034
1179
  /**
1180
+ * @public
1035
1181
  * <p>ARN of the cluster operation.</p>
1036
1182
  */
1037
1183
  OperationArn?: string;
1038
1184
  /**
1185
+ * @public
1039
1186
  * <p>State of the cluster operation.</p>
1040
1187
  */
1041
1188
  OperationState?: string;
1042
1189
  /**
1190
+ * @public
1043
1191
  * <p>Type of the cluster operation.</p>
1044
1192
  */
1045
1193
  OperationType?: string;
@@ -1050,10 +1198,12 @@ export interface ClusterOperationV2Summary {
1050
1198
  */
1051
1199
  export interface CompatibleKafkaVersion {
1052
1200
  /**
1201
+ * @public
1053
1202
  * <p>An Apache Kafka version.</p>
1054
1203
  */
1055
1204
  SourceVersion?: string;
1056
1205
  /**
1206
+ * @public
1057
1207
  * <p>A list of Apache Kafka versions.</p>
1058
1208
  */
1059
1209
  TargetVersions?: string[];
@@ -1064,14 +1214,17 @@ export interface CompatibleKafkaVersion {
1064
1214
  */
1065
1215
  export interface ConfigurationRevision {
1066
1216
  /**
1217
+ * @public
1067
1218
  * <p>The time when the configuration revision was created.</p>
1068
1219
  */
1069
1220
  CreationTime: Date | undefined;
1070
1221
  /**
1222
+ * @public
1071
1223
  * <p>The description of the configuration revision.</p>
1072
1224
  */
1073
1225
  Description?: string;
1074
1226
  /**
1227
+ * @public
1075
1228
  * <p>The revision number.</p>
1076
1229
  */
1077
1230
  Revision: number | undefined;
@@ -1095,30 +1248,37 @@ export type ConfigurationState = (typeof ConfigurationState)[keyof typeof Config
1095
1248
  */
1096
1249
  export interface Configuration {
1097
1250
  /**
1251
+ * @public
1098
1252
  * <p>The Amazon Resource Name (ARN) of the configuration.</p>
1099
1253
  */
1100
1254
  Arn: string | undefined;
1101
1255
  /**
1256
+ * @public
1102
1257
  * <p>The time when the configuration was created.</p>
1103
1258
  */
1104
1259
  CreationTime: Date | undefined;
1105
1260
  /**
1261
+ * @public
1106
1262
  * <p>The description of the configuration.</p>
1107
1263
  */
1108
1264
  Description: string | undefined;
1109
1265
  /**
1266
+ * @public
1110
1267
  * <p>An array of the versions of Apache Kafka with which you can use this MSK configuration. You can use this configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this array.</p>
1111
1268
  */
1112
1269
  KafkaVersions: string[] | undefined;
1113
1270
  /**
1271
+ * @public
1114
1272
  * <p>Latest revision of the configuration.</p>
1115
1273
  */
1116
1274
  LatestRevision: ConfigurationRevision | undefined;
1117
1275
  /**
1276
+ * @public
1118
1277
  * <p>The name of the configuration.</p>
1119
1278
  */
1120
1279
  Name: string | undefined;
1121
1280
  /**
1281
+ * @public
1122
1282
  * <p>The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED. </p>
1123
1283
  */
1124
1284
  State: ConfigurationState | string | undefined;
@@ -1148,26 +1308,32 @@ export interface KafkaVersion {
1148
1308
  */
1149
1309
  export interface BrokerNodeInfo {
1150
1310
  /**
1311
+ * @public
1151
1312
  * <p>The attached elastic network interface of the broker.</p>
1152
1313
  */
1153
1314
  AttachedENIId?: string;
1154
1315
  /**
1316
+ * @public
1155
1317
  * <p>The ID of the broker.</p>
1156
1318
  */
1157
1319
  BrokerId?: number;
1158
1320
  /**
1321
+ * @public
1159
1322
  * <p>The client subnet to which this broker node belongs.</p>
1160
1323
  */
1161
1324
  ClientSubnet?: string;
1162
1325
  /**
1326
+ * @public
1163
1327
  * <p>The virtual private cloud (VPC) of the client.</p>
1164
1328
  */
1165
1329
  ClientVpcIpAddress?: string;
1166
1330
  /**
1331
+ * @public
1167
1332
  * <p>Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.</p>
1168
1333
  */
1169
1334
  CurrentBrokerSoftwareInfo?: BrokerSoftwareInfo;
1170
1335
  /**
1336
+ * @public
1171
1337
  * <p>Endpoints for accessing the broker.</p>
1172
1338
  */
1173
1339
  Endpoints?: string[];
@@ -1189,22 +1355,27 @@ export type NodeType = (typeof NodeType)[keyof typeof NodeType];
1189
1355
  */
1190
1356
  export interface ZookeeperNodeInfo {
1191
1357
  /**
1358
+ * @public
1192
1359
  * <p>The attached elastic network interface of the broker.</p>
1193
1360
  */
1194
1361
  AttachedENIId?: string;
1195
1362
  /**
1363
+ * @public
1196
1364
  * <p>The virtual private cloud (VPC) IP address of the client.</p>
1197
1365
  */
1198
1366
  ClientVpcIpAddress?: string;
1199
1367
  /**
1368
+ * @public
1200
1369
  * <p>Endpoints for accessing the ZooKeeper.</p>
1201
1370
  */
1202
1371
  Endpoints?: string[];
1203
1372
  /**
1373
+ * @public
1204
1374
  * <p>The role-specific ID for Zookeeper.</p>
1205
1375
  */
1206
1376
  ZookeeperId?: number;
1207
1377
  /**
1378
+ * @public
1208
1379
  * <p>The version of Zookeeper.</p>
1209
1380
  */
1210
1381
  ZookeeperVersion?: string;
@@ -1215,26 +1386,32 @@ export interface ZookeeperNodeInfo {
1215
1386
  */
1216
1387
  export interface NodeInfo {
1217
1388
  /**
1389
+ * @public
1218
1390
  * <p>The start time.</p>
1219
1391
  */
1220
1392
  AddedToClusterTime?: string;
1221
1393
  /**
1394
+ * @public
1222
1395
  * <p>The broker node info.</p>
1223
1396
  */
1224
1397
  BrokerNodeInfo?: BrokerNodeInfo;
1225
1398
  /**
1399
+ * @public
1226
1400
  * <p>The instance type.</p>
1227
1401
  */
1228
1402
  InstanceType?: string;
1229
1403
  /**
1404
+ * @public
1230
1405
  * <p>The Amazon Resource Name (ARN) of the node.</p>
1231
1406
  */
1232
1407
  NodeARN?: string;
1233
1408
  /**
1409
+ * @public
1234
1410
  * <p>The node type.</p>
1235
1411
  */
1236
1412
  NodeType?: NodeType | string;
1237
1413
  /**
1414
+ * @public
1238
1415
  * <p>The ZookeeperNodeInfo.</p>
1239
1416
  */
1240
1417
  ZookeeperNodeInfo?: ZookeeperNodeInfo;
@@ -1245,14 +1422,17 @@ export interface NodeInfo {
1245
1422
  */
1246
1423
  export interface UnprocessedScramSecret {
1247
1424
  /**
1425
+ * @public
1248
1426
  * <p>Error code for associate/disassociate failure.</p>
1249
1427
  */
1250
1428
  ErrorCode?: string;
1251
1429
  /**
1430
+ * @public
1252
1431
  * <p>Error message for associate/disassociate failure.</p>
1253
1432
  */
1254
1433
  ErrorMessage?: string;
1255
1434
  /**
1435
+ * @public
1256
1436
  * <p>AWS Secrets Manager secret ARN.</p>
1257
1437
  */
1258
1438
  SecretArn?: string;
@@ -1263,26 +1443,32 @@ export interface UnprocessedScramSecret {
1263
1443
  */
1264
1444
  export interface VpcConnection {
1265
1445
  /**
1446
+ * @public
1266
1447
  * <p>The ARN that identifies the Vpc Connection.</p>
1267
1448
  */
1268
1449
  VpcConnectionArn: string | undefined;
1269
1450
  /**
1451
+ * @public
1270
1452
  * <p>The ARN that identifies the Cluster which the Vpc Connection belongs to.</p>
1271
1453
  */
1272
1454
  TargetClusterArn: string | undefined;
1273
1455
  /**
1456
+ * @public
1274
1457
  * <p>Creation time of the Vpc Connection.</p>
1275
1458
  */
1276
1459
  CreationTime?: Date;
1277
1460
  /**
1461
+ * @public
1278
1462
  * <p>Information about the auth scheme of Vpc Connection.</p>
1279
1463
  */
1280
1464
  Authentication?: string;
1281
1465
  /**
1466
+ * @public
1282
1467
  * <p>The vpcId that belongs to the Vpc Connection.</p>
1283
1468
  */
1284
1469
  VpcId?: string;
1285
1470
  /**
1471
+ * @public
1286
1472
  * <p>State of the Vpc Connection.</p>
1287
1473
  */
1288
1474
  State?: VpcConnectionState | string;
@@ -1295,10 +1481,12 @@ export declare class BadRequestException extends __BaseException {
1295
1481
  readonly name: "BadRequestException";
1296
1482
  readonly $fault: "client";
1297
1483
  /**
1484
+ * @public
1298
1485
  * <p>The parameter that caused the error.</p>
1299
1486
  */
1300
1487
  InvalidParameter?: string;
1301
1488
  /**
1489
+ * @public
1302
1490
  * <p>The description of the error.</p>
1303
1491
  */
1304
1492
  Message?: string;
@@ -1313,10 +1501,12 @@ export declare class BadRequestException extends __BaseException {
1313
1501
  */
1314
1502
  export interface BatchAssociateScramSecretRequest {
1315
1503
  /**
1504
+ * @public
1316
1505
  * <p>The Amazon Resource Name (ARN) of the cluster to be updated.</p>
1317
1506
  */
1318
1507
  ClusterArn: string | undefined;
1319
1508
  /**
1509
+ * @public
1320
1510
  * <p>List of AWS Secrets Manager secret ARNs.</p>
1321
1511
  */
1322
1512
  SecretArnList: string[] | undefined;
@@ -1326,10 +1516,12 @@ export interface BatchAssociateScramSecretRequest {
1326
1516
  */
1327
1517
  export interface BatchAssociateScramSecretResponse {
1328
1518
  /**
1519
+ * @public
1329
1520
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
1330
1521
  */
1331
1522
  ClusterArn?: string;
1332
1523
  /**
1524
+ * @public
1333
1525
  * <p>List of errors when associating secrets to cluster.</p>
1334
1526
  */
1335
1527
  UnprocessedScramSecrets?: UnprocessedScramSecret[];
@@ -1342,10 +1534,12 @@ export declare class ForbiddenException extends __BaseException {
1342
1534
  readonly name: "ForbiddenException";
1343
1535
  readonly $fault: "client";
1344
1536
  /**
1537
+ * @public
1345
1538
  * <p>The parameter that caused the error.</p>
1346
1539
  */
1347
1540
  InvalidParameter?: string;
1348
1541
  /**
1542
+ * @public
1349
1543
  * <p>The description of the error.</p>
1350
1544
  */
1351
1545
  Message?: string;
@@ -1362,10 +1556,12 @@ export declare class InternalServerErrorException extends __BaseException {
1362
1556
  readonly name: "InternalServerErrorException";
1363
1557
  readonly $fault: "server";
1364
1558
  /**
1559
+ * @public
1365
1560
  * <p>The parameter that caused the error.</p>
1366
1561
  */
1367
1562
  InvalidParameter?: string;
1368
1563
  /**
1564
+ * @public
1369
1565
  * <p>The description of the error.</p>
1370
1566
  */
1371
1567
  Message?: string;
@@ -1382,10 +1578,12 @@ export declare class NotFoundException extends __BaseException {
1382
1578
  readonly name: "NotFoundException";
1383
1579
  readonly $fault: "client";
1384
1580
  /**
1581
+ * @public
1385
1582
  * <p>The parameter that caused the error.</p>
1386
1583
  */
1387
1584
  InvalidParameter?: string;
1388
1585
  /**
1586
+ * @public
1389
1587
  * <p>The description of the error.</p>
1390
1588
  */
1391
1589
  Message?: string;
@@ -1402,10 +1600,12 @@ export declare class ServiceUnavailableException extends __BaseException {
1402
1600
  readonly name: "ServiceUnavailableException";
1403
1601
  readonly $fault: "server";
1404
1602
  /**
1603
+ * @public
1405
1604
  * <p>The parameter that caused the error.</p>
1406
1605
  */
1407
1606
  InvalidParameter?: string;
1408
1607
  /**
1608
+ * @public
1409
1609
  * <p>The description of the error.</p>
1410
1610
  */
1411
1611
  Message?: string;
@@ -1422,10 +1622,12 @@ export declare class TooManyRequestsException extends __BaseException {
1422
1622
  readonly name: "TooManyRequestsException";
1423
1623
  readonly $fault: "client";
1424
1624
  /**
1625
+ * @public
1425
1626
  * <p>The parameter that caused the error.</p>
1426
1627
  */
1427
1628
  InvalidParameter?: string;
1428
1629
  /**
1630
+ * @public
1429
1631
  * <p>The description of the error.</p>
1430
1632
  */
1431
1633
  Message?: string;
@@ -1442,10 +1644,12 @@ export declare class UnauthorizedException extends __BaseException {
1442
1644
  readonly name: "UnauthorizedException";
1443
1645
  readonly $fault: "client";
1444
1646
  /**
1647
+ * @public
1445
1648
  * <p>The parameter that caused the error.</p>
1446
1649
  */
1447
1650
  InvalidParameter?: string;
1448
1651
  /**
1652
+ * @public
1449
1653
  * <p>The description of the error.</p>
1450
1654
  */
1451
1655
  Message?: string;
@@ -1460,10 +1664,12 @@ export declare class UnauthorizedException extends __BaseException {
1460
1664
  */
1461
1665
  export interface BatchDisassociateScramSecretRequest {
1462
1666
  /**
1667
+ * @public
1463
1668
  * <p>The Amazon Resource Name (ARN) of the cluster to be updated.</p>
1464
1669
  */
1465
1670
  ClusterArn: string | undefined;
1466
1671
  /**
1672
+ * @public
1467
1673
  * <p>List of AWS Secrets Manager secret ARNs.</p>
1468
1674
  */
1469
1675
  SecretArnList: string[] | undefined;
@@ -1473,10 +1679,12 @@ export interface BatchDisassociateScramSecretRequest {
1473
1679
  */
1474
1680
  export interface BatchDisassociateScramSecretResponse {
1475
1681
  /**
1682
+ * @public
1476
1683
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
1477
1684
  */
1478
1685
  ClusterArn?: string;
1479
1686
  /**
1687
+ * @public
1480
1688
  * <p>List of errors when disassociating secrets to cluster.</p>
1481
1689
  */
1482
1690
  UnprocessedScramSecrets?: UnprocessedScramSecret[];
@@ -1487,18 +1695,22 @@ export interface BatchDisassociateScramSecretResponse {
1487
1695
  */
1488
1696
  export interface ClusterOperationV2Provisioned {
1489
1697
  /**
1698
+ * @public
1490
1699
  * <p>Steps completed during the operation.</p>
1491
1700
  */
1492
1701
  OperationSteps?: ClusterOperationStep[];
1493
1702
  /**
1703
+ * @public
1494
1704
  * <p>Information about cluster attributes before a cluster is updated.</p>
1495
1705
  */
1496
1706
  SourceClusterInfo?: MutableClusterInfo;
1497
1707
  /**
1708
+ * @public
1498
1709
  * <p>Information about cluster attributes after a cluster is updated.</p>
1499
1710
  */
1500
1711
  TargetClusterInfo?: MutableClusterInfo;
1501
1712
  /**
1713
+ * @public
1502
1714
  * <p>Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.</p>
1503
1715
  */
1504
1716
  VpcConnectionInfo?: VpcConnectionInfo;
@@ -1509,18 +1721,22 @@ export interface ClusterOperationV2Provisioned {
1509
1721
  */
1510
1722
  export interface VpcConnectionInfoServerless {
1511
1723
  /**
1724
+ * @public
1512
1725
  * <p>The time when Amazon MSK creates the VPC Connnection.</p>
1513
1726
  */
1514
1727
  CreationTime?: Date;
1515
1728
  /**
1729
+ * @public
1516
1730
  * <p>The owner of the VPC Connection.</p>
1517
1731
  */
1518
1732
  Owner?: string;
1519
1733
  /**
1734
+ * @public
1520
1735
  * <p>Description of the requester that calls the API operation.</p>
1521
1736
  */
1522
1737
  UserIdentity?: UserIdentity;
1523
1738
  /**
1739
+ * @public
1524
1740
  * <p>The Amazon Resource Name (ARN) of the VPC connection.</p>
1525
1741
  */
1526
1742
  VpcConnectionArn?: string;
@@ -1531,6 +1747,7 @@ export interface VpcConnectionInfoServerless {
1531
1747
  */
1532
1748
  export interface ClusterOperationV2Serverless {
1533
1749
  /**
1750
+ * @public
1534
1751
  * <p>Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.</p>
1535
1752
  */
1536
1753
  VpcConnectionInfo?: VpcConnectionInfoServerless;
@@ -1541,42 +1758,52 @@ export interface ClusterOperationV2Serverless {
1541
1758
  */
1542
1759
  export interface ClusterOperationV2 {
1543
1760
  /**
1761
+ * @public
1544
1762
  * <p>ARN of the cluster.</p>
1545
1763
  */
1546
1764
  ClusterArn?: string;
1547
1765
  /**
1766
+ * @public
1548
1767
  * <p>Type of the backend cluster.</p>
1549
1768
  */
1550
1769
  ClusterType?: ClusterType | string;
1551
1770
  /**
1771
+ * @public
1552
1772
  * <p>The time at which operation was started.</p>
1553
1773
  */
1554
1774
  StartTime?: Date;
1555
1775
  /**
1776
+ * @public
1556
1777
  * <p>The time at which the operation finished.</p>
1557
1778
  */
1558
1779
  EndTime?: Date;
1559
1780
  /**
1781
+ * @public
1560
1782
  * <p>If cluster operation failed from an error, it describes the error.</p>
1561
1783
  */
1562
1784
  ErrorInfo?: ErrorInfo;
1563
1785
  /**
1786
+ * @public
1564
1787
  * <p>ARN of the cluster operation.</p>
1565
1788
  */
1566
1789
  OperationArn?: string;
1567
1790
  /**
1791
+ * @public
1568
1792
  * <p>State of the cluster operation.</p>
1569
1793
  */
1570
1794
  OperationState?: string;
1571
1795
  /**
1796
+ * @public
1572
1797
  * <p>Type of the cluster operation.</p>
1573
1798
  */
1574
1799
  OperationType?: string;
1575
1800
  /**
1801
+ * @public
1576
1802
  * <p>Properties of a provisioned cluster.</p>
1577
1803
  */
1578
1804
  Provisioned?: ClusterOperationV2Provisioned;
1579
1805
  /**
1806
+ * @public
1580
1807
  * <p>Properties of a serverless cluster.</p>
1581
1808
  */
1582
1809
  Serverless?: ClusterOperationV2Serverless;
@@ -1589,10 +1816,12 @@ export declare class ConflictException extends __BaseException {
1589
1816
  readonly name: "ConflictException";
1590
1817
  readonly $fault: "client";
1591
1818
  /**
1819
+ * @public
1592
1820
  * <p>The parameter that caused the error.</p>
1593
1821
  */
1594
1822
  InvalidParameter?: string;
1595
1823
  /**
1824
+ * @public
1596
1825
  * <p>The description of the error.</p>
1597
1826
  */
1598
1827
  Message?: string;
@@ -1606,47 +1835,58 @@ export declare class ConflictException extends __BaseException {
1606
1835
  */
1607
1836
  export interface CreateClusterRequest {
1608
1837
  /**
1838
+ * @public
1609
1839
  * <p>Information about the broker nodes in the cluster.</p>
1610
1840
  */
1611
1841
  BrokerNodeGroupInfo: BrokerNodeGroupInfo | undefined;
1612
1842
  /**
1843
+ * @public
1613
1844
  * <p>Includes all client authentication related information.</p>
1614
1845
  */
1615
1846
  ClientAuthentication?: ClientAuthentication;
1616
1847
  /**
1848
+ * @public
1617
1849
  * <p>The name of the cluster.</p>
1618
1850
  */
1619
1851
  ClusterName: string | undefined;
1620
1852
  /**
1853
+ * @public
1621
1854
  * <p>Represents the configuration that you want MSK to use for the brokers in a cluster.</p>
1622
1855
  */
1623
1856
  ConfigurationInfo?: ConfigurationInfo;
1624
1857
  /**
1858
+ * @public
1625
1859
  * <p>Includes all encryption-related information.</p>
1626
1860
  */
1627
1861
  EncryptionInfo?: EncryptionInfo;
1628
1862
  /**
1863
+ * @public
1629
1864
  * <p>Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.</p>
1630
1865
  */
1631
1866
  EnhancedMonitoring?: EnhancedMonitoring | string;
1632
1867
  /**
1868
+ * @public
1633
1869
  * <p>The settings for open monitoring.</p>
1634
1870
  */
1635
1871
  OpenMonitoring?: OpenMonitoringInfo;
1636
1872
  /**
1873
+ * @public
1637
1874
  * <p>The version of Apache Kafka.</p>
1638
1875
  */
1639
1876
  KafkaVersion: string | undefined;
1640
1877
  LoggingInfo?: LoggingInfo;
1641
1878
  /**
1879
+ * @public
1642
1880
  * <p>The number of broker nodes in the cluster.</p>
1643
1881
  */
1644
1882
  NumberOfBrokerNodes: number | undefined;
1645
1883
  /**
1884
+ * @public
1646
1885
  * <p>Create tags when creating the cluster.</p>
1647
1886
  */
1648
1887
  Tags?: Record<string, string>;
1649
1888
  /**
1889
+ * @public
1650
1890
  * <p>This controls storage mode for supported storage tiers.</p>
1651
1891
  */
1652
1892
  StorageMode?: StorageMode | string;
@@ -1656,14 +1896,17 @@ export interface CreateClusterRequest {
1656
1896
  */
1657
1897
  export interface CreateClusterResponse {
1658
1898
  /**
1899
+ * @public
1659
1900
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
1660
1901
  */
1661
1902
  ClusterArn?: string;
1662
1903
  /**
1904
+ * @public
1663
1905
  * <p>The name of the MSK cluster.</p>
1664
1906
  */
1665
1907
  ClusterName?: string;
1666
1908
  /**
1909
+ * @public
1667
1910
  * <p>The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.</p>
1668
1911
  */
1669
1912
  State?: ClusterState | string;
@@ -1674,42 +1917,52 @@ export interface CreateClusterResponse {
1674
1917
  */
1675
1918
  export interface ProvisionedRequest {
1676
1919
  /**
1920
+ * @public
1677
1921
  * <p>Information about the brokers.</p>
1678
1922
  */
1679
1923
  BrokerNodeGroupInfo: BrokerNodeGroupInfo | undefined;
1680
1924
  /**
1925
+ * @public
1681
1926
  * <p>Includes all client authentication information.</p>
1682
1927
  */
1683
1928
  ClientAuthentication?: ClientAuthentication;
1684
1929
  /**
1930
+ * @public
1685
1931
  * <p>Represents the configuration that you want Amazon MSK to use for the brokers in a cluster.</p>
1686
1932
  */
1687
1933
  ConfigurationInfo?: ConfigurationInfo;
1688
1934
  /**
1935
+ * @public
1689
1936
  * <p>Includes all encryption-related information.</p>
1690
1937
  */
1691
1938
  EncryptionInfo?: EncryptionInfo;
1692
1939
  /**
1940
+ * @public
1693
1941
  * <p>Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.</p>
1694
1942
  */
1695
1943
  EnhancedMonitoring?: EnhancedMonitoring | string;
1696
1944
  /**
1945
+ * @public
1697
1946
  * <p>The settings for open monitoring.</p>
1698
1947
  */
1699
1948
  OpenMonitoring?: OpenMonitoringInfo;
1700
1949
  /**
1950
+ * @public
1701
1951
  * <p>The Apache Kafka version that you want for the cluster.</p>
1702
1952
  */
1703
1953
  KafkaVersion: string | undefined;
1704
1954
  /**
1955
+ * @public
1705
1956
  * <p>Log delivery information for the cluster.</p>
1706
1957
  */
1707
1958
  LoggingInfo?: LoggingInfo;
1708
1959
  /**
1960
+ * @public
1709
1961
  * <p>The number of broker nodes in the cluster.</p>
1710
1962
  */
1711
1963
  NumberOfBrokerNodes: number | undefined;
1712
1964
  /**
1965
+ * @public
1713
1966
  * <p>This controls storage mode for supported storage tiers.</p>
1714
1967
  */
1715
1968
  StorageMode?: StorageMode | string;
@@ -1720,10 +1973,12 @@ export interface ProvisionedRequest {
1720
1973
  */
1721
1974
  export interface ServerlessRequest {
1722
1975
  /**
1976
+ * @public
1723
1977
  * <p>The configuration of the Amazon VPCs for the cluster.</p>
1724
1978
  */
1725
1979
  VpcConfigs: VpcConfig[] | undefined;
1726
1980
  /**
1981
+ * @public
1727
1982
  * <p>Includes all client authentication information.</p>
1728
1983
  */
1729
1984
  ClientAuthentication?: ServerlessClientAuthentication;
@@ -1733,18 +1988,22 @@ export interface ServerlessRequest {
1733
1988
  */
1734
1989
  export interface CreateClusterV2Request {
1735
1990
  /**
1991
+ * @public
1736
1992
  * <p>The name of the cluster.</p>
1737
1993
  */
1738
1994
  ClusterName: string | undefined;
1739
1995
  /**
1996
+ * @public
1740
1997
  * <p>A map of tags that you want the cluster to have.</p>
1741
1998
  */
1742
1999
  Tags?: Record<string, string>;
1743
2000
  /**
2001
+ * @public
1744
2002
  * <p>Information about the provisioned cluster.</p>
1745
2003
  */
1746
2004
  Provisioned?: ProvisionedRequest;
1747
2005
  /**
2006
+ * @public
1748
2007
  * <p>Information about the serverless cluster.</p>
1749
2008
  */
1750
2009
  Serverless?: ServerlessRequest;
@@ -1754,18 +2013,22 @@ export interface CreateClusterV2Request {
1754
2013
  */
1755
2014
  export interface CreateClusterV2Response {
1756
2015
  /**
2016
+ * @public
1757
2017
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
1758
2018
  */
1759
2019
  ClusterArn?: string;
1760
2020
  /**
2021
+ * @public
1761
2022
  * <p>The name of the MSK cluster.</p>
1762
2023
  */
1763
2024
  ClusterName?: string;
1764
2025
  /**
2026
+ * @public
1765
2027
  * <p>The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.</p>
1766
2028
  */
1767
2029
  State?: ClusterState | string;
1768
2030
  /**
2031
+ * @public
1769
2032
  * <p>The type of the cluster. The possible states are PROVISIONED or SERVERLESS.</p>
1770
2033
  */
1771
2034
  ClusterType?: ClusterType | string;
@@ -1775,18 +2038,22 @@ export interface CreateClusterV2Response {
1775
2038
  */
1776
2039
  export interface CreateConfigurationRequest {
1777
2040
  /**
2041
+ * @public
1778
2042
  * <p>The description of the configuration.</p>
1779
2043
  */
1780
2044
  Description?: string;
1781
2045
  /**
2046
+ * @public
1782
2047
  * <p>The versions of Apache Kafka with which you can use this MSK configuration.</p>
1783
2048
  */
1784
2049
  KafkaVersions?: string[];
1785
2050
  /**
2051
+ * @public
1786
2052
  * <p>The name of the configuration.</p>
1787
2053
  */
1788
2054
  Name: string | undefined;
1789
2055
  /**
2056
+ * @public
1790
2057
  * <p>Contents of the <filename>server.properties</filename> file. When using the API, you must ensure that the contents of the file are base64 encoded.
1791
2058
  * When using the AWS Management Console, the SDK, or the AWS CLI, the contents of <filename>server.properties</filename> can be in plaintext.</p>
1792
2059
  */
@@ -1797,22 +2064,27 @@ export interface CreateConfigurationRequest {
1797
2064
  */
1798
2065
  export interface CreateConfigurationResponse {
1799
2066
  /**
2067
+ * @public
1800
2068
  * <p>The Amazon Resource Name (ARN) of the configuration.</p>
1801
2069
  */
1802
2070
  Arn?: string;
1803
2071
  /**
2072
+ * @public
1804
2073
  * <p>The time when the configuration was created.</p>
1805
2074
  */
1806
2075
  CreationTime?: Date;
1807
2076
  /**
2077
+ * @public
1808
2078
  * <p>Latest revision of the configuration.</p>
1809
2079
  */
1810
2080
  LatestRevision?: ConfigurationRevision;
1811
2081
  /**
2082
+ * @public
1812
2083
  * <p>The name of the configuration.</p>
1813
2084
  */
1814
2085
  Name?: string;
1815
2086
  /**
2087
+ * @public
1816
2088
  * <p>The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED. </p>
1817
2089
  */
1818
2090
  State?: ConfigurationState | string;
@@ -1822,26 +2094,32 @@ export interface CreateConfigurationResponse {
1822
2094
  */
1823
2095
  export interface CreateVpcConnectionRequest {
1824
2096
  /**
2097
+ * @public
1825
2098
  * <p>The cluster Amazon Resource Name (ARN) for the VPC connection.</p>
1826
2099
  */
1827
2100
  TargetClusterArn: string | undefined;
1828
2101
  /**
2102
+ * @public
1829
2103
  * <p>The authentication type of VPC connection.</p>
1830
2104
  */
1831
2105
  Authentication: string | undefined;
1832
2106
  /**
2107
+ * @public
1833
2108
  * <p>The VPC ID of VPC connection.</p>
1834
2109
  */
1835
2110
  VpcId: string | undefined;
1836
2111
  /**
2112
+ * @public
1837
2113
  * <p>The list of client subnets.</p>
1838
2114
  */
1839
2115
  ClientSubnets: string[] | undefined;
1840
2116
  /**
2117
+ * @public
1841
2118
  * <p>The list of security groups.</p>
1842
2119
  */
1843
2120
  SecurityGroups: string[] | undefined;
1844
2121
  /**
2122
+ * @public
1845
2123
  * <p>A map of tags for the VPC connection.</p>
1846
2124
  */
1847
2125
  Tags?: Record<string, string>;
@@ -1851,34 +2129,42 @@ export interface CreateVpcConnectionRequest {
1851
2129
  */
1852
2130
  export interface CreateVpcConnectionResponse {
1853
2131
  /**
2132
+ * @public
1854
2133
  * <p>The VPC connection ARN.</p>
1855
2134
  */
1856
2135
  VpcConnectionArn?: string;
1857
2136
  /**
2137
+ * @public
1858
2138
  * <p>The State of Vpc Connection.</p>
1859
2139
  */
1860
2140
  State?: VpcConnectionState | string;
1861
2141
  /**
2142
+ * @public
1862
2143
  * <p>The authentication type of VPC connection.</p>
1863
2144
  */
1864
2145
  Authentication?: string;
1865
2146
  /**
2147
+ * @public
1866
2148
  * <p>The VPC ID of the VPC connection.</p>
1867
2149
  */
1868
2150
  VpcId?: string;
1869
2151
  /**
2152
+ * @public
1870
2153
  * <p>The list of client subnets.</p>
1871
2154
  */
1872
2155
  ClientSubnets?: string[];
1873
2156
  /**
2157
+ * @public
1874
2158
  * <p>The list of security groups.</p>
1875
2159
  */
1876
2160
  SecurityGroups?: string[];
1877
2161
  /**
2162
+ * @public
1878
2163
  * <p>The creation time of VPC connection.</p>
1879
2164
  */
1880
2165
  CreationTime?: Date;
1881
2166
  /**
2167
+ * @public
1882
2168
  * <p>A map of tags for the VPC connection.</p>
1883
2169
  */
1884
2170
  Tags?: Record<string, string>;
@@ -1888,10 +2174,12 @@ export interface CreateVpcConnectionResponse {
1888
2174
  */
1889
2175
  export interface DeleteClusterRequest {
1890
2176
  /**
2177
+ * @public
1891
2178
  * <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>
1892
2179
  */
1893
2180
  ClusterArn: string | undefined;
1894
2181
  /**
2182
+ * @public
1895
2183
  * <p>The current version of the MSK cluster.</p>
1896
2184
  */
1897
2185
  CurrentVersion?: string;
@@ -1901,10 +2189,12 @@ export interface DeleteClusterRequest {
1901
2189
  */
1902
2190
  export interface DeleteClusterResponse {
1903
2191
  /**
2192
+ * @public
1904
2193
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
1905
2194
  */
1906
2195
  ClusterArn?: string;
1907
2196
  /**
2197
+ * @public
1908
2198
  * <p>The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.</p>
1909
2199
  */
1910
2200
  State?: ClusterState | string;
@@ -1914,6 +2204,7 @@ export interface DeleteClusterResponse {
1914
2204
  */
1915
2205
  export interface DeleteClusterPolicyRequest {
1916
2206
  /**
2207
+ * @public
1917
2208
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
1918
2209
  */
1919
2210
  ClusterArn: string | undefined;
@@ -1928,6 +2219,7 @@ export interface DeleteClusterPolicyResponse {
1928
2219
  */
1929
2220
  export interface DeleteConfigurationRequest {
1930
2221
  /**
2222
+ * @public
1931
2223
  * <p>The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.</p>
1932
2224
  */
1933
2225
  Arn: string | undefined;
@@ -1937,10 +2229,12 @@ export interface DeleteConfigurationRequest {
1937
2229
  */
1938
2230
  export interface DeleteConfigurationResponse {
1939
2231
  /**
2232
+ * @public
1940
2233
  * <p>The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.</p>
1941
2234
  */
1942
2235
  Arn?: string;
1943
2236
  /**
2237
+ * @public
1944
2238
  * <p>The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED. </p>
1945
2239
  */
1946
2240
  State?: ConfigurationState | string;
@@ -1950,6 +2244,7 @@ export interface DeleteConfigurationResponse {
1950
2244
  */
1951
2245
  export interface DeleteVpcConnectionRequest {
1952
2246
  /**
2247
+ * @public
1953
2248
  * <p>The Amazon Resource Name (ARN) that uniquely identifies an MSK VPC connection.</p>
1954
2249
  */
1955
2250
  Arn: string | undefined;
@@ -1959,10 +2254,12 @@ export interface DeleteVpcConnectionRequest {
1959
2254
  */
1960
2255
  export interface DeleteVpcConnectionResponse {
1961
2256
  /**
2257
+ * @public
1962
2258
  * <p>The Amazon Resource Name (ARN) that uniquely identifies an MSK VPC connection.</p>
1963
2259
  */
1964
2260
  VpcConnectionArn?: string;
1965
2261
  /**
2262
+ * @public
1966
2263
  * <p>The state of the VPC connection.</p>
1967
2264
  */
1968
2265
  State?: VpcConnectionState | string;
@@ -1972,6 +2269,7 @@ export interface DeleteVpcConnectionResponse {
1972
2269
  */
1973
2270
  export interface DescribeClusterRequest {
1974
2271
  /**
2272
+ * @public
1975
2273
  * <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>
1976
2274
  */
1977
2275
  ClusterArn: string | undefined;
@@ -1981,6 +2279,7 @@ export interface DescribeClusterRequest {
1981
2279
  */
1982
2280
  export interface DescribeClusterResponse {
1983
2281
  /**
2282
+ * @public
1984
2283
  * <p>The cluster information.</p>
1985
2284
  */
1986
2285
  ClusterInfo?: ClusterInfo;
@@ -1990,6 +2289,7 @@ export interface DescribeClusterResponse {
1990
2289
  */
1991
2290
  export interface DescribeClusterOperationRequest {
1992
2291
  /**
2292
+ * @public
1993
2293
  * <p>The Amazon Resource Name (ARN) that uniquely identifies the MSK cluster operation.</p>
1994
2294
  */
1995
2295
  ClusterOperationArn: string | undefined;
@@ -1999,6 +2299,7 @@ export interface DescribeClusterOperationRequest {
1999
2299
  */
2000
2300
  export interface DescribeClusterOperationResponse {
2001
2301
  /**
2302
+ * @public
2002
2303
  * <p>Cluster operation information</p>
2003
2304
  */
2004
2305
  ClusterOperationInfo?: ClusterOperationInfo;
@@ -2008,6 +2309,7 @@ export interface DescribeClusterOperationResponse {
2008
2309
  */
2009
2310
  export interface DescribeClusterOperationV2Request {
2010
2311
  /**
2312
+ * @public
2011
2313
  * ARN of the cluster operation to describe.
2012
2314
  */
2013
2315
  ClusterOperationArn: string | undefined;
@@ -2017,6 +2319,7 @@ export interface DescribeClusterOperationV2Request {
2017
2319
  */
2018
2320
  export interface DescribeClusterOperationV2Response {
2019
2321
  /**
2322
+ * @public
2020
2323
  * <p>Cluster operation information</p>
2021
2324
  */
2022
2325
  ClusterOperationInfo?: ClusterOperationV2;
@@ -2026,6 +2329,7 @@ export interface DescribeClusterOperationV2Response {
2026
2329
  */
2027
2330
  export interface DescribeClusterV2Request {
2028
2331
  /**
2332
+ * @public
2029
2333
  * <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>
2030
2334
  */
2031
2335
  ClusterArn: string | undefined;
@@ -2035,6 +2339,7 @@ export interface DescribeClusterV2Request {
2035
2339
  */
2036
2340
  export interface DescribeClusterV2Response {
2037
2341
  /**
2342
+ * @public
2038
2343
  * <p>The cluster information.</p>
2039
2344
  */
2040
2345
  ClusterInfo?: Cluster;
@@ -2044,6 +2349,7 @@ export interface DescribeClusterV2Response {
2044
2349
  */
2045
2350
  export interface DescribeConfigurationRequest {
2046
2351
  /**
2352
+ * @public
2047
2353
  * <p>The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.</p>
2048
2354
  */
2049
2355
  Arn: string | undefined;
@@ -2053,30 +2359,37 @@ export interface DescribeConfigurationRequest {
2053
2359
  */
2054
2360
  export interface DescribeConfigurationResponse {
2055
2361
  /**
2362
+ * @public
2056
2363
  * <p>The Amazon Resource Name (ARN) of the configuration.</p>
2057
2364
  */
2058
2365
  Arn?: string;
2059
2366
  /**
2367
+ * @public
2060
2368
  * <p>The time when the configuration was created.</p>
2061
2369
  */
2062
2370
  CreationTime?: Date;
2063
2371
  /**
2372
+ * @public
2064
2373
  * <p>The description of the configuration.</p>
2065
2374
  */
2066
2375
  Description?: string;
2067
2376
  /**
2377
+ * @public
2068
2378
  * <p>The versions of Apache Kafka with which you can use this MSK configuration.</p>
2069
2379
  */
2070
2380
  KafkaVersions?: string[];
2071
2381
  /**
2382
+ * @public
2072
2383
  * <p>Latest revision of the configuration.</p>
2073
2384
  */
2074
2385
  LatestRevision?: ConfigurationRevision;
2075
2386
  /**
2387
+ * @public
2076
2388
  * <p>The name of the configuration.</p>
2077
2389
  */
2078
2390
  Name?: string;
2079
2391
  /**
2392
+ * @public
2080
2393
  * <p>The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED. </p>
2081
2394
  */
2082
2395
  State?: ConfigurationState | string;
@@ -2086,10 +2399,12 @@ export interface DescribeConfigurationResponse {
2086
2399
  */
2087
2400
  export interface DescribeConfigurationRevisionRequest {
2088
2401
  /**
2402
+ * @public
2089
2403
  * <p>The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.</p>
2090
2404
  */
2091
2405
  Arn: string | undefined;
2092
2406
  /**
2407
+ * @public
2093
2408
  * <p>A string that uniquely identifies a revision of an MSK configuration.</p>
2094
2409
  */
2095
2410
  Revision: number | undefined;
@@ -2099,22 +2414,27 @@ export interface DescribeConfigurationRevisionRequest {
2099
2414
  */
2100
2415
  export interface DescribeConfigurationRevisionResponse {
2101
2416
  /**
2417
+ * @public
2102
2418
  * <p>The Amazon Resource Name (ARN) of the configuration.</p>
2103
2419
  */
2104
2420
  Arn?: string;
2105
2421
  /**
2422
+ * @public
2106
2423
  * <p>The time when the configuration was created.</p>
2107
2424
  */
2108
2425
  CreationTime?: Date;
2109
2426
  /**
2427
+ * @public
2110
2428
  * <p>The description of the configuration.</p>
2111
2429
  */
2112
2430
  Description?: string;
2113
2431
  /**
2432
+ * @public
2114
2433
  * <p>The revision number.</p>
2115
2434
  */
2116
2435
  Revision?: number;
2117
2436
  /**
2437
+ * @public
2118
2438
  * <p>Contents of the <filename>server.properties</filename> file. When using the API, you must ensure that the contents of the file are base64 encoded.
2119
2439
  * When using the AWS Management Console, the SDK, or the AWS CLI, the contents of <filename>server.properties</filename> can be in plaintext.</p>
2120
2440
  */
@@ -2125,6 +2445,7 @@ export interface DescribeConfigurationRevisionResponse {
2125
2445
  */
2126
2446
  export interface DescribeVpcConnectionRequest {
2127
2447
  /**
2448
+ * @public
2128
2449
  * <p>The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC connection.</p>
2129
2450
  */
2130
2451
  Arn: string | undefined;
@@ -2134,38 +2455,47 @@ export interface DescribeVpcConnectionRequest {
2134
2455
  */
2135
2456
  export interface DescribeVpcConnectionResponse {
2136
2457
  /**
2458
+ * @public
2137
2459
  * <p>The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC connection.</p>
2138
2460
  */
2139
2461
  VpcConnectionArn?: string;
2140
2462
  /**
2463
+ * @public
2141
2464
  * <p>The Amazon Resource Name (ARN) that uniquely identifies an MSK cluster.</p>
2142
2465
  */
2143
2466
  TargetClusterArn?: string;
2144
2467
  /**
2468
+ * @public
2145
2469
  * <p>The state of VPC connection.</p>
2146
2470
  */
2147
2471
  State?: VpcConnectionState | string;
2148
2472
  /**
2473
+ * @public
2149
2474
  * <p>The authentication type of VPC connection.</p>
2150
2475
  */
2151
2476
  Authentication?: string;
2152
2477
  /**
2478
+ * @public
2153
2479
  * <p>The VPC Id for the VPC connection.</p>
2154
2480
  */
2155
2481
  VpcId?: string;
2156
2482
  /**
2483
+ * @public
2157
2484
  * <p>The list of subnets for the VPC connection.</p>
2158
2485
  */
2159
2486
  Subnets?: string[];
2160
2487
  /**
2488
+ * @public
2161
2489
  * <p>The list of security groups for the VPC connection.</p>
2162
2490
  */
2163
2491
  SecurityGroups?: string[];
2164
2492
  /**
2493
+ * @public
2165
2494
  * <p>The creation time of the VPC connection.</p>
2166
2495
  */
2167
2496
  CreationTime?: Date;
2168
2497
  /**
2498
+ * @public
2169
2499
  * <p>A map of tags for the VPC connection.</p>
2170
2500
  */
2171
2501
  Tags?: Record<string, string>;
@@ -2175,6 +2505,7 @@ export interface DescribeVpcConnectionResponse {
2175
2505
  */
2176
2506
  export interface GetBootstrapBrokersRequest {
2177
2507
  /**
2508
+ * @public
2178
2509
  * <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>
2179
2510
  */
2180
2511
  ClusterArn: string | undefined;
@@ -2184,42 +2515,52 @@ export interface GetBootstrapBrokersRequest {
2184
2515
  */
2185
2516
  export interface GetBootstrapBrokersResponse {
2186
2517
  /**
2518
+ * @public
2187
2519
  * <p>A string containing one or more hostname:port pairs.</p>
2188
2520
  */
2189
2521
  BootstrapBrokerString?: string;
2190
2522
  /**
2523
+ * @public
2191
2524
  * <p>A string containing one or more DNS names (or IP) and TLS port pairs.</p>
2192
2525
  */
2193
2526
  BootstrapBrokerStringTls?: string;
2194
2527
  /**
2528
+ * @public
2195
2529
  * <p>A string containing one or more DNS names (or IP) and Sasl Scram port pairs.</p>
2196
2530
  */
2197
2531
  BootstrapBrokerStringSaslScram?: string;
2198
2532
  /**
2533
+ * @public
2199
2534
  * <p>A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.</p>
2200
2535
  */
2201
2536
  BootstrapBrokerStringSaslIam?: string;
2202
2537
  /**
2538
+ * @public
2203
2539
  * <p>A string containing one or more DNS names (or IP) and TLS port pairs.</p>
2204
2540
  */
2205
2541
  BootstrapBrokerStringPublicTls?: string;
2206
2542
  /**
2543
+ * @public
2207
2544
  * <p>A string containing one or more DNS names (or IP) and Sasl Scram port pairs.</p>
2208
2545
  */
2209
2546
  BootstrapBrokerStringPublicSaslScram?: string;
2210
2547
  /**
2548
+ * @public
2211
2549
  * <p>A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.</p>
2212
2550
  */
2213
2551
  BootstrapBrokerStringPublicSaslIam?: string;
2214
2552
  /**
2553
+ * @public
2215
2554
  * <p>A string containing one or more DNS names (or IP) and TLS port pairs for VPC connectivity.</p>
2216
2555
  */
2217
2556
  BootstrapBrokerStringVpcConnectivityTls?: string;
2218
2557
  /**
2558
+ * @public
2219
2559
  * <p>A string containing one or more DNS names (or IP) and SASL/SCRAM port pairs for VPC connectivity.</p>
2220
2560
  */
2221
2561
  BootstrapBrokerStringVpcConnectivitySaslScram?: string;
2222
2562
  /**
2563
+ * @public
2223
2564
  * <p>A string containing one or more DNS names (or IP) and SASL/IAM port pairs for VPC connectivity.</p>
2224
2565
  */
2225
2566
  BootstrapBrokerStringVpcConnectivitySaslIam?: string;
@@ -2229,6 +2570,7 @@ export interface GetBootstrapBrokersResponse {
2229
2570
  */
2230
2571
  export interface GetClusterPolicyRequest {
2231
2572
  /**
2573
+ * @public
2232
2574
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
2233
2575
  */
2234
2576
  ClusterArn: string | undefined;
@@ -2238,10 +2580,12 @@ export interface GetClusterPolicyRequest {
2238
2580
  */
2239
2581
  export interface GetClusterPolicyResponse {
2240
2582
  /**
2583
+ * @public
2241
2584
  * <p>The version of cluster policy.</p>
2242
2585
  */
2243
2586
  CurrentVersion?: string;
2244
2587
  /**
2588
+ * @public
2245
2589
  * <p>The cluster policy.</p>
2246
2590
  */
2247
2591
  Policy?: string;
@@ -2251,6 +2595,7 @@ export interface GetClusterPolicyResponse {
2251
2595
  */
2252
2596
  export interface GetCompatibleKafkaVersionsRequest {
2253
2597
  /**
2598
+ * @public
2254
2599
  * <p>The Amazon Resource Name (ARN) of the cluster check.</p>
2255
2600
  */
2256
2601
  ClusterArn?: string;
@@ -2260,6 +2605,7 @@ export interface GetCompatibleKafkaVersionsRequest {
2260
2605
  */
2261
2606
  export interface GetCompatibleKafkaVersionsResponse {
2262
2607
  /**
2608
+ * @public
2263
2609
  * <p>A list of CompatibleKafkaVersion objects.</p>
2264
2610
  */
2265
2611
  CompatibleKafkaVersions?: CompatibleKafkaVersion[];
@@ -2269,14 +2615,17 @@ export interface GetCompatibleKafkaVersionsResponse {
2269
2615
  */
2270
2616
  export interface ListClientVpcConnectionsRequest {
2271
2617
  /**
2618
+ * @public
2272
2619
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
2273
2620
  */
2274
2621
  ClusterArn: string | undefined;
2275
2622
  /**
2623
+ * @public
2276
2624
  * <p>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</p>
2277
2625
  */
2278
2626
  MaxResults?: number;
2279
2627
  /**
2628
+ * @public
2280
2629
  * <p>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response.
2281
2630
  * To get the next batch, provide this token in your next request.</p>
2282
2631
  */
@@ -2287,10 +2636,12 @@ export interface ListClientVpcConnectionsRequest {
2287
2636
  */
2288
2637
  export interface ListClientVpcConnectionsResponse {
2289
2638
  /**
2639
+ * @public
2290
2640
  * <p>List of client VPC connections.</p>
2291
2641
  */
2292
2642
  ClientVpcConnections?: ClientVpcConnection[];
2293
2643
  /**
2644
+ * @public
2294
2645
  * <p>The paginated results marker. When the result of a ListClientVpcConnections operation is truncated, the call returns NextToken in the response.
2295
2646
  * To get another batch of configurations, provide this token in your next request.</p>
2296
2647
  */
@@ -2301,14 +2652,17 @@ export interface ListClientVpcConnectionsResponse {
2301
2652
  */
2302
2653
  export interface ListClusterOperationsRequest {
2303
2654
  /**
2655
+ * @public
2304
2656
  * <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>
2305
2657
  */
2306
2658
  ClusterArn: string | undefined;
2307
2659
  /**
2660
+ * @public
2308
2661
  * <p>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</p>
2309
2662
  */
2310
2663
  MaxResults?: number;
2311
2664
  /**
2665
+ * @public
2312
2666
  * <p>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response.
2313
2667
  * To get the next batch, provide this token in your next request.</p>
2314
2668
  */
@@ -2319,10 +2673,12 @@ export interface ListClusterOperationsRequest {
2319
2673
  */
2320
2674
  export interface ListClusterOperationsResponse {
2321
2675
  /**
2676
+ * @public
2322
2677
  * <p>An array of cluster operation information objects.</p>
2323
2678
  */
2324
2679
  ClusterOperationInfoList?: ClusterOperationInfo[];
2325
2680
  /**
2681
+ * @public
2326
2682
  * <p>If the response of ListClusterOperations is truncated, it returns a NextToken in the response. This Nexttoken should be sent in the subsequent request to ListClusterOperations.</p>
2327
2683
  */
2328
2684
  NextToken?: string;
@@ -2332,14 +2688,17 @@ export interface ListClusterOperationsResponse {
2332
2688
  */
2333
2689
  export interface ListClusterOperationsV2Request {
2334
2690
  /**
2691
+ * @public
2335
2692
  * The arn of the cluster whose operations are being requested.
2336
2693
  */
2337
2694
  ClusterArn: string | undefined;
2338
2695
  /**
2696
+ * @public
2339
2697
  * The maxResults of the query.
2340
2698
  */
2341
2699
  MaxResults?: number;
2342
2700
  /**
2701
+ * @public
2343
2702
  * The nextToken of the query.
2344
2703
  */
2345
2704
  NextToken?: string;
@@ -2349,10 +2708,12 @@ export interface ListClusterOperationsV2Request {
2349
2708
  */
2350
2709
  export interface ListClusterOperationsV2Response {
2351
2710
  /**
2711
+ * @public
2352
2712
  * <p>An array of cluster operation information objects.</p>
2353
2713
  */
2354
2714
  ClusterOperationInfoList?: ClusterOperationV2Summary[];
2355
2715
  /**
2716
+ * @public
2356
2717
  * <p>If the response of ListClusterOperationsV2 is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListClusterOperationsV2.</p>
2357
2718
  */
2358
2719
  NextToken?: string;
@@ -2362,14 +2723,17 @@ export interface ListClusterOperationsV2Response {
2362
2723
  */
2363
2724
  export interface ListClustersRequest {
2364
2725
  /**
2726
+ * @public
2365
2727
  * <p>Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.</p>
2366
2728
  */
2367
2729
  ClusterNameFilter?: string;
2368
2730
  /**
2731
+ * @public
2369
2732
  * <p>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</p>
2370
2733
  */
2371
2734
  MaxResults?: number;
2372
2735
  /**
2736
+ * @public
2373
2737
  * <p>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response.
2374
2738
  * To get the next batch, provide this token in your next request.</p>
2375
2739
  */
@@ -2380,10 +2744,12 @@ export interface ListClustersRequest {
2380
2744
  */
2381
2745
  export interface ListClustersResponse {
2382
2746
  /**
2747
+ * @public
2383
2748
  * <p>Information on each of the MSK clusters in the response.</p>
2384
2749
  */
2385
2750
  ClusterInfoList?: ClusterInfo[];
2386
2751
  /**
2752
+ * @public
2387
2753
  * <p>The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response.
2388
2754
  * To get another batch of clusters, provide this token in your next request.</p>
2389
2755
  */
@@ -2394,18 +2760,22 @@ export interface ListClustersResponse {
2394
2760
  */
2395
2761
  export interface ListClustersV2Request {
2396
2762
  /**
2763
+ * @public
2397
2764
  * <p>Specify a prefix of the names of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.</p>
2398
2765
  */
2399
2766
  ClusterNameFilter?: string;
2400
2767
  /**
2768
+ * @public
2401
2769
  * <p>Specify either PROVISIONED or SERVERLESS.</p>
2402
2770
  */
2403
2771
  ClusterTypeFilter?: string;
2404
2772
  /**
2773
+ * @public
2405
2774
  * <p>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</p>
2406
2775
  */
2407
2776
  MaxResults?: number;
2408
2777
  /**
2778
+ * @public
2409
2779
  * <p>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response.
2410
2780
  * To get the next batch, provide this token in your next request.</p>
2411
2781
  */
@@ -2416,10 +2786,12 @@ export interface ListClustersV2Request {
2416
2786
  */
2417
2787
  export interface ListClustersV2Response {
2418
2788
  /**
2789
+ * @public
2419
2790
  * <p>Information on each of the MSK clusters in the response.</p>
2420
2791
  */
2421
2792
  ClusterInfoList?: Cluster[];
2422
2793
  /**
2794
+ * @public
2423
2795
  * <p>The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response.
2424
2796
  * To get another batch of clusters, provide this token in your next request.</p>
2425
2797
  */
@@ -2430,14 +2802,17 @@ export interface ListClustersV2Response {
2430
2802
  */
2431
2803
  export interface ListConfigurationRevisionsRequest {
2432
2804
  /**
2805
+ * @public
2433
2806
  * <p>The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.</p>
2434
2807
  */
2435
2808
  Arn: string | undefined;
2436
2809
  /**
2810
+ * @public
2437
2811
  * <p>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</p>
2438
2812
  */
2439
2813
  MaxResults?: number;
2440
2814
  /**
2815
+ * @public
2441
2816
  * <p>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response.
2442
2817
  * To get the next batch, provide this token in your next request.</p>
2443
2818
  */
@@ -2448,10 +2823,12 @@ export interface ListConfigurationRevisionsRequest {
2448
2823
  */
2449
2824
  export interface ListConfigurationRevisionsResponse {
2450
2825
  /**
2826
+ * @public
2451
2827
  * <p>Paginated results marker.</p>
2452
2828
  */
2453
2829
  NextToken?: string;
2454
2830
  /**
2831
+ * @public
2455
2832
  * <p>List of ConfigurationRevision objects.</p>
2456
2833
  */
2457
2834
  Revisions?: ConfigurationRevision[];
@@ -2461,10 +2838,12 @@ export interface ListConfigurationRevisionsResponse {
2461
2838
  */
2462
2839
  export interface ListConfigurationsRequest {
2463
2840
  /**
2841
+ * @public
2464
2842
  * <p>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</p>
2465
2843
  */
2466
2844
  MaxResults?: number;
2467
2845
  /**
2846
+ * @public
2468
2847
  * <p>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response.
2469
2848
  * To get the next batch, provide this token in your next request.</p>
2470
2849
  */
@@ -2475,10 +2854,12 @@ export interface ListConfigurationsRequest {
2475
2854
  */
2476
2855
  export interface ListConfigurationsResponse {
2477
2856
  /**
2857
+ * @public
2478
2858
  * <p>An array of MSK configurations.</p>
2479
2859
  */
2480
2860
  Configurations?: Configuration[];
2481
2861
  /**
2862
+ * @public
2482
2863
  * <p>The paginated results marker. When the result of a ListConfigurations operation is truncated, the call returns NextToken in the response.
2483
2864
  * To get another batch of configurations, provide this token in your next request.</p>
2484
2865
  */
@@ -2489,10 +2870,12 @@ export interface ListConfigurationsResponse {
2489
2870
  */
2490
2871
  export interface ListKafkaVersionsRequest {
2491
2872
  /**
2873
+ * @public
2492
2874
  * <p>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</p>
2493
2875
  */
2494
2876
  MaxResults?: number;
2495
2877
  /**
2878
+ * @public
2496
2879
  * <p>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.</p>
2497
2880
  */
2498
2881
  NextToken?: string;
@@ -2509,14 +2892,17 @@ export interface ListKafkaVersionsResponse {
2509
2892
  */
2510
2893
  export interface ListNodesRequest {
2511
2894
  /**
2895
+ * @public
2512
2896
  * <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>
2513
2897
  */
2514
2898
  ClusterArn: string | undefined;
2515
2899
  /**
2900
+ * @public
2516
2901
  * <p>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</p>
2517
2902
  */
2518
2903
  MaxResults?: number;
2519
2904
  /**
2905
+ * @public
2520
2906
  * <p>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response.
2521
2907
  * To get the next batch, provide this token in your next request.</p>
2522
2908
  */
@@ -2527,11 +2913,13 @@ export interface ListNodesRequest {
2527
2913
  */
2528
2914
  export interface ListNodesResponse {
2529
2915
  /**
2916
+ * @public
2530
2917
  * <p>The paginated results marker. When the result of a ListNodes operation is truncated, the call returns NextToken in the response.
2531
2918
  * To get another batch of nodes, provide this token in your next request.</p>
2532
2919
  */
2533
2920
  NextToken?: string;
2534
2921
  /**
2922
+ * @public
2535
2923
  * <p>List containing a NodeInfo object.</p>
2536
2924
  */
2537
2925
  NodeInfoList?: NodeInfo[];
@@ -2541,14 +2929,17 @@ export interface ListNodesResponse {
2541
2929
  */
2542
2930
  export interface ListScramSecretsRequest {
2543
2931
  /**
2932
+ * @public
2544
2933
  * <p>The arn of the cluster.</p>
2545
2934
  */
2546
2935
  ClusterArn: string | undefined;
2547
2936
  /**
2937
+ * @public
2548
2938
  * <p>The maxResults of the query.</p>
2549
2939
  */
2550
2940
  MaxResults?: number;
2551
2941
  /**
2942
+ * @public
2552
2943
  * <p>The nextToken of the query.</p>
2553
2944
  */
2554
2945
  NextToken?: string;
@@ -2558,10 +2949,12 @@ export interface ListScramSecretsRequest {
2558
2949
  */
2559
2950
  export interface ListScramSecretsResponse {
2560
2951
  /**
2952
+ * @public
2561
2953
  * <p>Paginated results marker.</p>
2562
2954
  */
2563
2955
  NextToken?: string;
2564
2956
  /**
2957
+ * @public
2565
2958
  * <p>The list of scram secrets associated with the cluster.</p>
2566
2959
  */
2567
2960
  SecretArnList?: string[];
@@ -2571,6 +2964,7 @@ export interface ListScramSecretsResponse {
2571
2964
  */
2572
2965
  export interface ListTagsForResourceRequest {
2573
2966
  /**
2967
+ * @public
2574
2968
  * <p>The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.</p>
2575
2969
  */
2576
2970
  ResourceArn: string | undefined;
@@ -2580,6 +2974,7 @@ export interface ListTagsForResourceRequest {
2580
2974
  */
2581
2975
  export interface ListTagsForResourceResponse {
2582
2976
  /**
2977
+ * @public
2583
2978
  * <p>The key-value pair for the resource tag.</p>
2584
2979
  */
2585
2980
  Tags?: Record<string, string>;
@@ -2589,10 +2984,12 @@ export interface ListTagsForResourceResponse {
2589
2984
  */
2590
2985
  export interface ListVpcConnectionsRequest {
2591
2986
  /**
2987
+ * @public
2592
2988
  * <p>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</p>
2593
2989
  */
2594
2990
  MaxResults?: number;
2595
2991
  /**
2992
+ * @public
2596
2993
  * <p>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response.
2597
2994
  * To get the next batch, provide this token in your next request.</p>
2598
2995
  */
@@ -2603,10 +3000,12 @@ export interface ListVpcConnectionsRequest {
2603
3000
  */
2604
3001
  export interface ListVpcConnectionsResponse {
2605
3002
  /**
3003
+ * @public
2606
3004
  * <p>List of VPC connections.</p>
2607
3005
  */
2608
3006
  VpcConnections?: VpcConnection[];
2609
3007
  /**
3008
+ * @public
2610
3009
  * <p>The paginated results marker. When the result of a ListClientVpcConnections operation is truncated, the call returns NextToken in the response.
2611
3010
  * To get another batch of configurations, provide this token in your next request.</p>
2612
3011
  */
@@ -2617,14 +3016,17 @@ export interface ListVpcConnectionsResponse {
2617
3016
  */
2618
3017
  export interface PutClusterPolicyRequest {
2619
3018
  /**
3019
+ * @public
2620
3020
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
2621
3021
  */
2622
3022
  ClusterArn: string | undefined;
2623
3023
  /**
3024
+ * @public
2624
3025
  * <p>The policy version.</p>
2625
3026
  */
2626
3027
  CurrentVersion?: string;
2627
3028
  /**
3029
+ * @public
2628
3030
  * <p>The policy.</p>
2629
3031
  */
2630
3032
  Policy: string | undefined;
@@ -2634,6 +3036,7 @@ export interface PutClusterPolicyRequest {
2634
3036
  */
2635
3037
  export interface PutClusterPolicyResponse {
2636
3038
  /**
3039
+ * @public
2637
3040
  * <p>The policy version.</p>
2638
3041
  */
2639
3042
  CurrentVersion?: string;
@@ -2644,10 +3047,12 @@ export interface PutClusterPolicyResponse {
2644
3047
  */
2645
3048
  export interface RebootBrokerRequest {
2646
3049
  /**
3050
+ * @public
2647
3051
  * <p>The list of broker IDs to be rebooted. The reboot-broker operation supports rebooting one broker at a time.</p>
2648
3052
  */
2649
3053
  BrokerIds: string[] | undefined;
2650
3054
  /**
3055
+ * @public
2651
3056
  * <p>The Amazon Resource Name (ARN) of the cluster to be updated.</p>
2652
3057
  */
2653
3058
  ClusterArn: string | undefined;
@@ -2657,10 +3062,12 @@ export interface RebootBrokerRequest {
2657
3062
  */
2658
3063
  export interface RebootBrokerResponse {
2659
3064
  /**
3065
+ * @public
2660
3066
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
2661
3067
  */
2662
3068
  ClusterArn?: string;
2663
3069
  /**
3070
+ * @public
2664
3071
  * <p>The Amazon Resource Name (ARN) of the cluster operation.</p>
2665
3072
  */
2666
3073
  ClusterOperationArn?: string;
@@ -2670,10 +3077,12 @@ export interface RebootBrokerResponse {
2670
3077
  */
2671
3078
  export interface RejectClientVpcConnectionRequest {
2672
3079
  /**
3080
+ * @public
2673
3081
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
2674
3082
  */
2675
3083
  ClusterArn: string | undefined;
2676
3084
  /**
3085
+ * @public
2677
3086
  * <p>The VPC connection ARN.</p>
2678
3087
  */
2679
3088
  VpcConnectionArn: string | undefined;
@@ -2688,10 +3097,12 @@ export interface RejectClientVpcConnectionResponse {
2688
3097
  */
2689
3098
  export interface TagResourceRequest {
2690
3099
  /**
3100
+ * @public
2691
3101
  * <p>The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.</p>
2692
3102
  */
2693
3103
  ResourceArn: string | undefined;
2694
3104
  /**
3105
+ * @public
2695
3106
  * <p>The key-value pair for the resource tag.</p>
2696
3107
  */
2697
3108
  Tags: Record<string, string> | undefined;
@@ -2701,10 +3112,12 @@ export interface TagResourceRequest {
2701
3112
  */
2702
3113
  export interface UntagResourceRequest {
2703
3114
  /**
3115
+ * @public
2704
3116
  * <p>The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.</p>
2705
3117
  */
2706
3118
  ResourceArn: string | undefined;
2707
3119
  /**
3120
+ * @public
2708
3121
  * <p>Tag keys must be unique for a given cluster. In addition, the following restrictions apply:</p>
2709
3122
  * <ul>
2710
3123
  * <li>
@@ -2733,14 +3146,17 @@ export interface UntagResourceRequest {
2733
3146
  */
2734
3147
  export interface UpdateBrokerCountRequest {
2735
3148
  /**
3149
+ * @public
2736
3150
  * <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>
2737
3151
  */
2738
3152
  ClusterArn: string | undefined;
2739
3153
  /**
3154
+ * @public
2740
3155
  * <p>The version of cluster to update from. A successful operation will then generate a new version.</p>
2741
3156
  */
2742
3157
  CurrentVersion: string | undefined;
2743
3158
  /**
3159
+ * @public
2744
3160
  * <p>The number of broker nodes that you want the cluster to have after this operation completes successfully.</p>
2745
3161
  */
2746
3162
  TargetNumberOfBrokerNodes: number | undefined;
@@ -2750,10 +3166,12 @@ export interface UpdateBrokerCountRequest {
2750
3166
  */
2751
3167
  export interface UpdateBrokerCountResponse {
2752
3168
  /**
3169
+ * @public
2753
3170
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
2754
3171
  */
2755
3172
  ClusterArn?: string;
2756
3173
  /**
3174
+ * @public
2757
3175
  * <p>The Amazon Resource Name (ARN) of the cluster operation.</p>
2758
3176
  */
2759
3177
  ClusterOperationArn?: string;
@@ -2763,14 +3181,17 @@ export interface UpdateBrokerCountResponse {
2763
3181
  */
2764
3182
  export interface UpdateBrokerStorageRequest {
2765
3183
  /**
3184
+ * @public
2766
3185
  * <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>
2767
3186
  */
2768
3187
  ClusterArn: string | undefined;
2769
3188
  /**
3189
+ * @public
2770
3190
  * <p>The version of cluster to update from. A successful operation will then generate a new version.</p>
2771
3191
  */
2772
3192
  CurrentVersion: string | undefined;
2773
3193
  /**
3194
+ * @public
2774
3195
  * <p>Describes the target volume size and the ID of the broker to apply the update to.</p>
2775
3196
  */
2776
3197
  TargetBrokerEBSVolumeInfo: BrokerEBSVolumeInfo[] | undefined;
@@ -2780,10 +3201,12 @@ export interface UpdateBrokerStorageRequest {
2780
3201
  */
2781
3202
  export interface UpdateBrokerStorageResponse {
2782
3203
  /**
3204
+ * @public
2783
3205
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
2784
3206
  */
2785
3207
  ClusterArn?: string;
2786
3208
  /**
3209
+ * @public
2787
3210
  * <p>The Amazon Resource Name (ARN) of the cluster operation.</p>
2788
3211
  */
2789
3212
  ClusterOperationArn?: string;
@@ -2793,14 +3216,17 @@ export interface UpdateBrokerStorageResponse {
2793
3216
  */
2794
3217
  export interface UpdateBrokerTypeRequest {
2795
3218
  /**
3219
+ * @public
2796
3220
  * <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>
2797
3221
  */
2798
3222
  ClusterArn: string | undefined;
2799
3223
  /**
3224
+ * @public
2800
3225
  * <p>The cluster version that you want to change. After this operation completes successfully, the cluster will have a new version.</p>
2801
3226
  */
2802
3227
  CurrentVersion: string | undefined;
2803
3228
  /**
3229
+ * @public
2804
3230
  * <p>The Amazon MSK broker type that you want all of the brokers in this cluster to be.</p>
2805
3231
  */
2806
3232
  TargetInstanceType: string | undefined;
@@ -2810,10 +3236,12 @@ export interface UpdateBrokerTypeRequest {
2810
3236
  */
2811
3237
  export interface UpdateBrokerTypeResponse {
2812
3238
  /**
3239
+ * @public
2813
3240
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
2814
3241
  */
2815
3242
  ClusterArn?: string;
2816
3243
  /**
3244
+ * @public
2817
3245
  * <p>The Amazon Resource Name (ARN) of the cluster operation.</p>
2818
3246
  */
2819
3247
  ClusterOperationArn?: string;
@@ -2823,14 +3251,17 @@ export interface UpdateBrokerTypeResponse {
2823
3251
  */
2824
3252
  export interface UpdateClusterConfigurationRequest {
2825
3253
  /**
3254
+ * @public
2826
3255
  * <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>
2827
3256
  */
2828
3257
  ClusterArn: string | undefined;
2829
3258
  /**
3259
+ * @public
2830
3260
  * <p>Represents the configuration that you want MSK to use for the brokers in a cluster.</p>
2831
3261
  */
2832
3262
  ConfigurationInfo: ConfigurationInfo | undefined;
2833
3263
  /**
3264
+ * @public
2834
3265
  * <p>The version of the cluster that needs to be updated.</p>
2835
3266
  */
2836
3267
  CurrentVersion: string | undefined;
@@ -2840,10 +3271,12 @@ export interface UpdateClusterConfigurationRequest {
2840
3271
  */
2841
3272
  export interface UpdateClusterConfigurationResponse {
2842
3273
  /**
3274
+ * @public
2843
3275
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
2844
3276
  */
2845
3277
  ClusterArn?: string;
2846
3278
  /**
3279
+ * @public
2847
3280
  * <p>The Amazon Resource Name (ARN) of the cluster operation.</p>
2848
3281
  */
2849
3282
  ClusterOperationArn?: string;
@@ -2853,18 +3286,22 @@ export interface UpdateClusterConfigurationResponse {
2853
3286
  */
2854
3287
  export interface UpdateClusterKafkaVersionRequest {
2855
3288
  /**
3289
+ * @public
2856
3290
  * <p>The Amazon Resource Name (ARN) of the cluster to be updated.</p>
2857
3291
  */
2858
3292
  ClusterArn: string | undefined;
2859
3293
  /**
3294
+ * @public
2860
3295
  * <p>The custom configuration that should be applied on the new version of cluster.</p>
2861
3296
  */
2862
3297
  ConfigurationInfo?: ConfigurationInfo;
2863
3298
  /**
3299
+ * @public
2864
3300
  * <p>Current cluster version.</p>
2865
3301
  */
2866
3302
  CurrentVersion: string | undefined;
2867
3303
  /**
3304
+ * @public
2868
3305
  * <p>Target Kafka version.</p>
2869
3306
  */
2870
3307
  TargetKafkaVersion: string | undefined;
@@ -2874,10 +3311,12 @@ export interface UpdateClusterKafkaVersionRequest {
2874
3311
  */
2875
3312
  export interface UpdateClusterKafkaVersionResponse {
2876
3313
  /**
3314
+ * @public
2877
3315
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
2878
3316
  */
2879
3317
  ClusterArn?: string;
2880
3318
  /**
3319
+ * @public
2881
3320
  * <p>The Amazon Resource Name (ARN) of the cluster operation.</p>
2882
3321
  */
2883
3322
  ClusterOperationArn?: string;
@@ -2887,14 +3326,17 @@ export interface UpdateClusterKafkaVersionResponse {
2887
3326
  */
2888
3327
  export interface UpdateConfigurationRequest {
2889
3328
  /**
3329
+ * @public
2890
3330
  * <p>The Amazon Resource Name (ARN) of the configuration.</p>
2891
3331
  */
2892
3332
  Arn: string | undefined;
2893
3333
  /**
3334
+ * @public
2894
3335
  * <p>The description of the configuration revision.</p>
2895
3336
  */
2896
3337
  Description?: string;
2897
3338
  /**
3339
+ * @public
2898
3340
  * <p>Contents of the <filename>server.properties</filename> file. When using the API, you must ensure that the contents of the file are base64 encoded.
2899
3341
  * When using the AWS Management Console, the SDK, or the AWS CLI, the contents of <filename>server.properties</filename> can be in plaintext.</p>
2900
3342
  */
@@ -2905,10 +3347,12 @@ export interface UpdateConfigurationRequest {
2905
3347
  */
2906
3348
  export interface UpdateConfigurationResponse {
2907
3349
  /**
3350
+ * @public
2908
3351
  * <p>The Amazon Resource Name (ARN) of the configuration.</p>
2909
3352
  */
2910
3353
  Arn?: string;
2911
3354
  /**
3355
+ * @public
2912
3356
  * <p>Latest revision of the configuration.</p>
2913
3357
  */
2914
3358
  LatestRevision?: ConfigurationRevision;
@@ -2919,14 +3363,17 @@ export interface UpdateConfigurationResponse {
2919
3363
  */
2920
3364
  export interface UpdateConnectivityRequest {
2921
3365
  /**
3366
+ * @public
2922
3367
  * <p>The Amazon Resource Name (ARN) of the configuration.</p>
2923
3368
  */
2924
3369
  ClusterArn: string | undefined;
2925
3370
  /**
3371
+ * @public
2926
3372
  * <p>Information about the broker access configuration.</p>
2927
3373
  */
2928
3374
  ConnectivityInfo: ConnectivityInfo | undefined;
2929
3375
  /**
3376
+ * @public
2930
3377
  * <p>The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.</p>
2931
3378
  */
2932
3379
  CurrentVersion: string | undefined;
@@ -2936,10 +3383,12 @@ export interface UpdateConnectivityRequest {
2936
3383
  */
2937
3384
  export interface UpdateConnectivityResponse {
2938
3385
  /**
3386
+ * @public
2939
3387
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
2940
3388
  */
2941
3389
  ClusterArn?: string;
2942
3390
  /**
3391
+ * @public
2943
3392
  * <p>The Amazon Resource Name (ARN) of the cluster operation.</p>
2944
3393
  */
2945
3394
  ClusterOperationArn?: string;
@@ -2950,18 +3399,22 @@ export interface UpdateConnectivityResponse {
2950
3399
  */
2951
3400
  export interface UpdateMonitoringRequest {
2952
3401
  /**
3402
+ * @public
2953
3403
  * <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>
2954
3404
  */
2955
3405
  ClusterArn: string | undefined;
2956
3406
  /**
3407
+ * @public
2957
3408
  * <p>The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.</p>
2958
3409
  */
2959
3410
  CurrentVersion: string | undefined;
2960
3411
  /**
3412
+ * @public
2961
3413
  * <p>Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.</p>
2962
3414
  */
2963
3415
  EnhancedMonitoring?: EnhancedMonitoring | string;
2964
3416
  /**
3417
+ * @public
2965
3418
  * <p>The settings for open monitoring.</p>
2966
3419
  */
2967
3420
  OpenMonitoring?: OpenMonitoringInfo;
@@ -2972,10 +3425,12 @@ export interface UpdateMonitoringRequest {
2972
3425
  */
2973
3426
  export interface UpdateMonitoringResponse {
2974
3427
  /**
3428
+ * @public
2975
3429
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
2976
3430
  */
2977
3431
  ClusterArn?: string;
2978
3432
  /**
3433
+ * @public
2979
3434
  * <p>The Amazon Resource Name (ARN) of the cluster operation.</p>
2980
3435
  */
2981
3436
  ClusterOperationArn?: string;
@@ -2985,18 +3440,22 @@ export interface UpdateMonitoringResponse {
2985
3440
  */
2986
3441
  export interface UpdateSecurityRequest {
2987
3442
  /**
3443
+ * @public
2988
3444
  * <p>Includes all client authentication related information.</p>
2989
3445
  */
2990
3446
  ClientAuthentication?: ClientAuthentication;
2991
3447
  /**
3448
+ * @public
2992
3449
  * <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>
2993
3450
  */
2994
3451
  ClusterArn: string | undefined;
2995
3452
  /**
3453
+ * @public
2996
3454
  * <p>The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.</p>
2997
3455
  */
2998
3456
  CurrentVersion: string | undefined;
2999
3457
  /**
3458
+ * @public
3000
3459
  * <p>Includes all encryption-related information.</p>
3001
3460
  */
3002
3461
  EncryptionInfo?: EncryptionInfo;
@@ -3006,10 +3465,12 @@ export interface UpdateSecurityRequest {
3006
3465
  */
3007
3466
  export interface UpdateSecurityResponse {
3008
3467
  /**
3468
+ * @public
3009
3469
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
3010
3470
  */
3011
3471
  ClusterArn?: string;
3012
3472
  /**
3473
+ * @public
3013
3474
  * <p>The Amazon Resource Name (ARN) of the cluster operation.</p>
3014
3475
  */
3015
3476
  ClusterOperationArn?: string;
@@ -3020,22 +3481,27 @@ export interface UpdateSecurityResponse {
3020
3481
  */
3021
3482
  export interface UpdateStorageRequest {
3022
3483
  /**
3484
+ * @public
3023
3485
  * <p>The Amazon Resource Name (ARN) of the cluster to be updated.</p>
3024
3486
  */
3025
3487
  ClusterArn: string | undefined;
3026
3488
  /**
3489
+ * @public
3027
3490
  * <p>The version of cluster to update from. A successful operation will then generate a new version.</p>
3028
3491
  */
3029
3492
  CurrentVersion: string | undefined;
3030
3493
  /**
3494
+ * @public
3031
3495
  * <p>EBS volume provisioned throughput information.</p>
3032
3496
  */
3033
3497
  ProvisionedThroughput?: ProvisionedThroughput;
3034
3498
  /**
3499
+ * @public
3035
3500
  * <p>Controls storage mode for supported storage tiers.</p>
3036
3501
  */
3037
3502
  StorageMode?: StorageMode | string;
3038
3503
  /**
3504
+ * @public
3039
3505
  * <p>size of the EBS volume to update.</p>
3040
3506
  */
3041
3507
  VolumeSizeGB?: number;
@@ -3045,10 +3511,12 @@ export interface UpdateStorageRequest {
3045
3511
  */
3046
3512
  export interface UpdateStorageResponse {
3047
3513
  /**
3514
+ * @public
3048
3515
  * <p>The Amazon Resource Name (ARN) of the cluster.</p>
3049
3516
  */
3050
3517
  ClusterArn?: string;
3051
3518
  /**
3519
+ * @public
3052
3520
  * <p>The Amazon Resource Name (ARN) of the cluster operation.</p>
3053
3521
  */
3054
3522
  ClusterOperationArn?: string;