/
docs-2.json
968 lines (968 loc) · 56.4 KB
/
docs-2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
{
"version" : "2.0",
"service" : "<p>The operations for managing an Amazon MSK cluster.</p>",
"operations" : {
"BatchAssociateScramSecret" : "<p>Associates one or more Scram Secrets with an Amazon MSK cluster.</p>",
"CreateCluster" : "<p>Creates a new MSK cluster.</p>",
"CreateClusterV2" : "<p>Creates a new Amazon MSK cluster of either the provisioned or the serverless type.</p>",
"CreateConfiguration" : "<p>Creates a new MSK configuration.</p>",
"DeleteCluster" : "<p>Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.</p>",
"DeleteConfiguration" : "<p>Deletes the specified MSK configuration. The configuration must be in the ACTIVE or DELETE_FAILED state.</p>",
"DescribeCluster" : "<p>Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.</p>",
"DescribeClusterV2" : "<p>Returns a description of the MSK cluster of either the provisioned or the serverless type whose Amazon Resource Name (ARN) is specified in the request.</p>",
"DescribeClusterOperation" : "<p>Returns a description of the cluster operation specified by the ARN.</p>",
"DescribeConfiguration" : "<p>Returns a description of this MSK configuration.</p>",
"DescribeConfigurationRevision" : "<p>Returns a description of this revision of the configuration.</p>",
"BatchDisassociateScramSecret" : "<p>Disassociates one or more Scram Secrets from an Amazon MSK cluster.</p>",
"GetBootstrapBrokers" : "<p>A list of brokers that a client application can use to bootstrap.</p>",
"GetCompatibleKafkaVersions" : "<p>Gets the Apache Kafka versions to which you can update the MSK cluster.</p>",
"ListClusterOperations" : "<p>Returns a list of all the operations that have been performed on the specified MSK cluster.</p>",
"ListClusters" : "<p>Returns a list of all the MSK clusters in the current Region.</p>",
"ListClustersV2" : "<p>Returns a list of all the MSK clusters in the current Region.</p>",
"ListConfigurationRevisions" : "<p>Returns a list of all the revisions of an MSK configuration.</p>",
"ListConfigurations" : "<p>Returns a list of all the MSK configurations in this Region.</p>",
"ListKafkaVersions" : "<p>Returns a list of Apache Kafka versions.</p>",
"ListNodes" : "<p>Returns a list of the broker nodes in the cluster.</p>",
"ListScramSecrets" : "<p>Returns a list of the Scram Secrets associated with an Amazon MSK cluster.</p>",
"ListTagsForResource" : "<p>Returns a list of the tags associated with the specified resource.</p>",
"RebootBroker" : "<p>Executes a reboot on a broker.</p>",
"TagResource" : "<p>Adds tags to the specified MSK resource.</p>",
"UntagResource" : "<p>Removes the tags associated with the keys that are provided in the query.</p>",
"UpdateBrokerCount" : "<p>Updates the number of broker nodes in the cluster. You can use this operation to increase the number of brokers in an existing cluster. You can't decrease the number of brokers.</p>",
"UpdateBrokerType": "<p>Updates all the brokers in the cluster to the specified type.</p>",
"UpdateBrokerStorage" : "<p>Updates the EBS storage associated with MSK brokers.</p>",
"UpdateConfiguration" : "<p>Updates an existing MSK configuration. The configuration must be in the Active state.</p>",
"UpdateConnectivity" : "<p>Updates the connectivity configuration for the cluster.</p>",
"UpdateClusterConfiguration" : "<p>Updates the cluster with the configuration that is specified in the request body.</p>",
"UpdateClusterKafkaVersion" : "<p>Updates the Apache Kafka version for the cluster.</p>",
"UpdateMonitoring" : "<p>Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.</p>",
"UpdateSecurity" : "<p>You can use this operation to update the encrypting and authentication settings for an existing cluster.</p>"
},
"shapes" : {
"BatchAssociateScramSecretRequest" : {
"base" : "<p>Request body for BatchAssociateScramSecret.</p>",
"refs" : { }
},
"BatchAssociateScramSecretResponse" : {
"base" : "<p>Response body for BatchAssociateScramSecret.</p>",
"refs" : { }
},
"BadRequestException" : {
"base" : "<p>Returns information about an error.</p>",
"refs" : { }
},
"BrokerAZDistribution" : {
"base" : "<p>The distribution of broker nodes across Availability Zones. By default, broker nodes are distributed among the Availability Zones of your Region. Currently, the only supported value is DEFAULT. You can either specify this value explicitly or leave it out.</p>",
"refs" : {
"BrokerNodeGroupInfo$BrokerAZDistribution" : "<p>The distribution of broker nodes across Availability Zones.</p>"
}
},
"BrokerEBSVolumeInfo" : {
"base" : "<p>Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.</p>",
"refs" : {
"__listOfBrokerEBSVolumeInfo$member" : null
}
},
"BrokerLogs" : {
"base" : "<p>The broker logs configuration for this MSK cluster.</p>",
"refs" : {
"LoggingInfo$BrokerLogs" : "<p>You can configure your MSK cluster to send broker logs to different destination types. This configuration specifies the details of these destinations.</p>"
}
},
"BrokerNodeGroupInfo" : {
"base" : "<p>Describes the setup to be used for Apache Kafka broker nodes in the cluster.</p>",
"refs" : {
"ClusterInfo$BrokerNodeGroupInfo" : "<p>Information about the brokers.</p>",
"Provisioned$BrokerNodeGroupInfo" : "<p>Information about the brokers.</p>",
"CreateClusterRequest$BrokerNodeGroupInfo" : "<p>Information about the brokers.</p>",
"ProvisionedRequest$BrokerNodeGroupInfo" : "<p>Information about the brokers.</p>"
}
},
"Provisioned" : {
"base" : "<p>Describes the provisioned cluster.</p>",
"refs" : {
"Cluster$Provisioned" : "<p>Information about the provisioned cluster.</p>"
}
},
"ProvisionedRequest" : {
"base" : "<p>Creates a provisioned cluster.</p>",
"refs" : {
"CreateClusterV2Request$Provisioned" : "<p>Creates a provisioned cluster.</p>"
}
},
"ServerlessRequest" : {
"base" : "<p>Creates serverless cluster.</p>",
"refs" : {
"CreateClusterV2Request$Serverless" : "<p>Creates a serverless cluster.</p>"
}
},
"Serverless" : {
"base" : "<p>Describes the serverless cluster.</p>",
"refs" : {
"Cluster$Serverless" : "<p>Information about the serverless cluster.</p>"
}
},
"ServerlessClientAuthentication" : {
"base" : "<p>Describes the serverless cluster client authentication.</p>",
"refs" : {
"Serverless$ClientAuthentication" : "<p>Information about the serverless cluster client authentication.</p>",
"ServerlessRequest$ClientAuthentication" : "<p>Information about the serverless cluster client authentication.</p>"
}
},
"ServerlessSasl" : {
"base" : "<p>Describes the serverless cluster SASL information.</p>",
"refs" : {
"ServerlessClientAuthentication$Sasl" : "<p>Serverless cluster SASL information.</p>"
}
},
"BrokerNodeInfo" : {
"base" : "<p>BrokerNodeInfo</p>",
"refs" : {
"NodeInfo$BrokerNodeInfo" : "<p>The broker node info.</p>"
}
},
"BrokerSoftwareInfo" : {
"base" : "<p>Information about the current software installed on the cluster.</p>",
"refs" : {
"BrokerNodeInfo$CurrentBrokerSoftwareInfo" : "<p>Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.</p>",
"ClusterInfo$CurrentBrokerSoftwareInfo" : "<p>Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.</p>",
"Provisioned$CurrentBrokerSoftwareInfo" : "<p>Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.</p>"
}
},
"ClientAuthentication" : {
"base" : "<p>Includes all client authentication information.</p>",
"refs" : {
"ClusterInfo$ClientAuthentication" : "<p>Includes all client authentication information.</p>",
"Provisioned$ClientAuthentication" : "<p>Includes all client authentication information.</p>",
"CreateClusterRequest$ClientAuthentication" : "<p>Includes all client authentication related information.</p>",
"ProvisionedRequest$ClientAuthentication" : "<p>Includes all client authentication related information.</p>",
"MutableClusterInfo$ClientAuthentication" : "<p>Includes all client authentication related information.</p>",
"UpdateSecurityRequest$ClientAuthentication" : "<p>Includes all client authentication related information.</p>"
}
},
"ClientBroker" : {
"base" : "<p>Client-broker encryption in transit setting.</p>",
"refs" : {
"EncryptionInTransit$ClientBroker" : "<p>Indicates the encryption setting for data in transit between clients and brokers. You must set it to one of the following values.</p> <p>TLS means that client-broker communication is enabled with TLS only.</p> <p>TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.</p> <p>PLAINTEXT means that client-broker communication is enabled in plaintext only.</p> <p>The default value is TLS.</p>"
}
},
"CloudWatchLogs" : {
"base" : "<p>Details of the CloudWatch Logs destination for broker logs.</p>",
"refs" : {
"BrokerLogs$CloudWatchLogs" : "<p>Details of the CloudWatch Logs destination for broker logs.</p>"
}
},
"ClusterInfo" : {
"base" : "<p>Returns information about a cluster.</p>",
"refs" : {
"DescribeClusterResponse$ClusterInfo" : "<p>The cluster information.</p>",
"__listOfClusterInfo$member" : null
}
},
"Cluster" : {
"base" : "<p>Returns information about a cluster of either the provisioned or the serverless type.</p>",
"refs" : {
"DescribeClusterV2Response$ClusterInfo" : "<p>The cluster information.</p>",
"__listOfCluster$member" : null
}
},
"ClusterOperationInfo" : {
"base" : "<p>Returns information about a cluster operation.</p>",
"refs" : {
"DescribeClusterOperationResponse$ClusterOperationInfo" : "<p>Cluster operation information</p>",
"__listOfClusterOperationInfo$member" : null
}
},
"ClusterOperationStep" : {
"base" : "<p>Step taken during a cluster operation.</p>",
"refs" : {
"__listOfClusterOperationStep$member" : null
}
},
"ClusterOperationStepInfo" : {
"base" : "<p>State information about the operation step.</p>",
"refs" : {
"ClusterOperationStep$StepInfo" : "<p>Information about the step and its status.</p>"
}
},
"ClusterState" : {
"base" : "<p>The state of an Apache Kafka cluster.</p>",
"refs" : {
"ClusterInfo$State" : "<p>The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.</p>",
"CreateClusterResponse$State" : "<p>The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.</p>",
"CreateClusterV2Response$State" : "<p>The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.</p>",
"DeleteClusterResponse$State" : "<p>The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.</p>"
}
},
"CompatibleKafkaVersion" : {
"base" : "<p>Contains source Apache Kafka versions and compatible target Apache Kafka versions.</p>",
"refs" : {
"__listOfCompatibleKafkaVersion$member" : null
}
},
"Configuration" : {
"base" : "<p>Represents an MSK Configuration.</p>",
"refs" : {
"__listOfConfiguration$member" : null
}
},
"ConfigurationInfo" : {
"base" : "<p>Specifies the configuration to use for the brokers.</p>",
"refs" : {
"CreateClusterRequest$ConfigurationInfo" : "<p>Represents the configuration that you want MSK to use for the cluster.</p>",
"ProvisionedRequest$ConfigurationInfo" : "<p>Represents the configuration that you want MSK to use for the cluster.</p>",
"MutableClusterInfo$ConfigurationInfo" : "<p>Information about the changes in the configuration of the brokers.</p>",
"UpdateClusterConfigurationRequest$ConfigurationInfo" : "<p>Represents the configuration that you want MSK to use for the cluster.</p>"
}
},
"ConfigurationRevision" : {
"base" : "<p>Describes a configuration revision.</p>",
"refs" : {
"Configuration$LatestRevision" : "<p>Latest revision of the configuration.</p>",
"CreateConfigurationResponse$LatestRevision" : "<p>Latest revision of the configuration.</p>",
"DescribeConfigurationResponse$LatestRevision" : "<p>Latest revision of the configuration.</p>",
"UpdateConfigurationResponse$LatestRevision" : "<p>Latest revision of the configuration.</p>",
"__listOfConfigurationRevision$member" : null
}
},
"ConfigurationState" : {
"base" : "<p>The state of a configuration.</p>",
"refs" : {
"DescribeConfigurationResponse$State" : "<p>The state of the configuration. The possible states are ACTIVE, DELETING and DELETE_FAILED.</p>",
"CreateConfigurationResponse$State" : "<p>The state of the configuration. The possible states are ACTIVE, DELETING and DELETE_FAILED.</p>",
"DeleteConfigurationResponse$State" : "<p>The state of the configuration. The possible states are ACTIVE, DELETING and DELETE_FAILED.</p>"
}
},
"ConflictException" : {
"base" : "<p>Returns information about an error.</p>",
"refs" : { }
},
"ConnectivityInfo" : {
"base" : "<p>Information about the broker access configuration.</p>",
"refs" : {
"BrokerNodeGroupInfo$ConnectivityInfo" : "<p>Information about the broker access configuration.</p>",
"MutableClusterInfo$ConnectivityInfo" : "<p>Information about the broker access configuration.</p>",
"UpdateConnectivityRequest$ConnectivityInfo" : "<p>Information about the broker access configuration.</p>"
}
},
"CreateClusterRequest" : {
"base" : "<p>Creates a cluster.</p>",
"refs" : { }
},
"CreateClusterV2Request" : {
"base" : "<p>Creates a new Amazon MSK cluster of either the provisioned or the serverless type.</p>",
"refs" : { }
},
"CreateClusterResponse" : {
"base" : "<p>Returns information about the created cluster.</p>",
"refs" : { }
},
"CreateClusterV2Response" : {
"base" : "<p>Returns information about the created cluster of either the provisioned or the serverless type.</p>",
"refs" : { }
},
"CreateConfigurationRequest" : {
"base" : "<p>Request body for CreateConfiguration.</p>",
"refs" : { }
},
"CreateConfigurationResponse" : {
"base" : "<p>Response body for CreateConfiguration</p>",
"refs" : { }
},
"DeleteClusterResponse" : {
"base" : "<p>Returns information about the deleted cluster.</p>",
"refs" : { }
},
"DeleteConfigurationRequest" : {
"base" : "<p>Request body for DeleteConfiguration.</p>",
"refs" : { }
},
"DeleteConfigurationResponse" : {
"base" : "<p>Response body for DeleteConfiguration.</p>",
"refs" : { }
},
"DescribeClusterOperationResponse" : {
"base" : "<p>Information about a cluster operation.</p>",
"refs" : { }
},
"DescribeClusterResponse" : {
"base" : "<p>Returns information about a cluster.</p>",
"refs" : { }
},
"DescribeClusterV2Response" : {
"base" : "<p>Returns information about a cluster of either the provisioned or the serverless type.</p>",
"refs" : { }
},
"DescribeConfigurationResponse" : {
"base" : "<p>Response body for DescribeConfiguration.</p>",
"refs" : { }
},
"DescribeConfigurationRevisionResponse" : {
"base" : "<p>Response body for DescribeConfigurationRevision.</p>",
"refs" : { }
},
"BatchDisassociateScramSecretRequest" : {
"base" : "<p>Request body for BatchDisassociateScramSecret.</p>",
"refs" : { }
},
"BatchDisassociateScramSecretResponse" : {
"base" : "<p>Response body for BatchDisassociateScramSecret.</p>",
"refs" : { }
},
"EBSStorageInfo" : {
"base" : "<p>Contains information about the EBS storage volumes attached to Apache Kafka broker nodes.</p>",
"refs" : {
"StorageInfo$EbsStorageInfo" : "<p>EBS volume information.</p>"
}
},
"EncryptionAtRest" : {
"base" : "<p>The data-volume encryption details.</p>",
"refs" : {
"EncryptionInfo$EncryptionAtRest" : "<p>The data-volume encryption details.</p>"
}
},
"EncryptionInTransit" : {
"base" : "<p>The settings for encrypting data in transit.</p>",
"refs" : {
"EncryptionInfo$EncryptionInTransit" : "<p>The details for encryption in transit.</p>"
}
},
"EncryptionInfo" : {
"base" : "<p>Includes encryption-related information, such as the AWS KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.</p>",
"refs" : {
"ClusterInfo$EncryptionInfo" : "<p>Includes all encryption-related information.</p>",
"Provisioned$EncryptionInfo" : "<p>Includes all encryption-related information.</p>",
"CreateClusterRequest$EncryptionInfo" : "<p>Includes all encryption-related information.</p>",
"ProvisionedRequest$EncryptionInfo" : "<p>Includes all encryption-related information.</p>",
"MutableClusterInfo$EncryptionInfo" : "<p>Includes all encryption-related information.</p>",
"UpdateSecurityRequest$EncryptionInfo" : "<p>Includes all encryption-related information.</p>"
}
},
"EnhancedMonitoring" : {
"base" : "<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>",
"refs" : {
"ClusterInfo$EnhancedMonitoring" : "<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>",
"Provisioned$EnhancedMonitoring" : "<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>",
"CreateClusterRequest$EnhancedMonitoring" : "<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>",
"ProvisionedRequest$EnhancedMonitoring" : "<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>",
"MutableClusterInfo$EnhancedMonitoring" : "<p>Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.</p>",
"UpdateMonitoringRequest$EnhancedMonitoring" : "<p>Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.</p>"
}
},
"Error" : {
"base" : "<p>Returns information about an error.</p>",
"refs" : { }
},
"ErrorInfo" : {
"base" : "<p>Returns information about an error state of the cluster.</p>",
"refs" : {
"ClusterOperationInfo$ErrorInfo" : "<p>Describes the error if the operation fails.</p>"
}
},
"Firehose" : {
"base" : "<p>Firehose details for BrokerLogs.</p>",
"refs" : {
"BrokerLogs$Firehose" : "<p>Details of the Kinesis Data Firehose delivery stream that is the destination for broker logs.</p>"
}
},
"ForbiddenException" : {
"base" : "<p>Returns information about an error.</p>",
"refs" : { }
},
"GetBootstrapBrokersResponse" : {
"base" : "<p>Returns a string containing one or more hostname:port pairs.</p>",
"refs" : { }
},
"GetCompatibleKafkaVersionsResponse" : {
"base" : "<p>Response body for GetCompatibleKafkaVersions.</p>",
"refs" : { }
},
"InternalServerErrorException" : {
"base" : "<p>Returns information about an error.</p>",
"refs" : { }
},
"JmxExporter" : {
"base" : "<p>Indicates whether you want to enable or disable the JMX Exporter.</p>",
"refs" : {
"Prometheus$JmxExporter" : "<p>Indicates whether you want to enable or disable the JMX Exporter.</p>"
}
},
"JmxExporterInfo" : {
"base" : "<p>Indicates whether you want to enable or disable the JMX Exporter.</p>",
"refs" : {
"PrometheusInfo$JmxExporter" : "<p>JMX Exporter settings.</p>"
}
},
"KafkaVersion" : {
"base" : "<p>Information about a Apache Kafka version.</p>",
"refs" : {
"__listOfKafkaVersion$member" : null
}
},
"KafkaVersionStatus" : {
"base" : "<p>The status of a Apache Kafka version.</p>",
"refs" : {
"KafkaVersion$Status" : "<p>The status of the Apache Kafka version.</p>"
}
},
"ListClusterOperationsResponse" : {
"base" : "<p>The response contains an array containing cluster operation information and a next token if the response is truncated.</p>",
"refs" : { }
},
"ListClustersResponse" : {
"base" : "<p>The response contains an array containing cluster information and a next token if the response is truncated.</p>",
"refs" : { }
},
"ListClustersV2Response" : {
"base" : "<p>The response contains an array containing cluster information and a next token if the response is truncated.</p>",
"refs" : { }
},
"ListConfigurationRevisionsResponse" : {
"base" : "<p>Information about revisions of an MSK configuration.</p>",
"refs" : { }
},
"ListConfigurationsResponse" : {
"base" : "<p>The response contains an array of Configuration and a next token if the response is truncated.</p>",
"refs" : { }
},
"ListKafkaVersionsResponse" : {
"base" : "<p>Response for ListKafkaVersions.</p>",
"refs" : { }
},
"ListNodesResponse" : {
"base" : "<p>Information about nodes in the cluster.</p>",
"refs" : { }
},
"ListScramSecretsResponse" : {
"base" : "<p>Information about scram secrets associated to the cluster.</p>",
"refs" : { }
},
"ListTagsForResourceResponse" : {
"base" : "<p>Response of listing tags for a resource.</p>",
"refs" : { }
},
"LoggingInfo" : {
"base" : "<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>",
"refs" : {
"ClusterInfo$LoggingInfo" : "<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>",
"Provisioned$LoggingInfo" : "<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>",
"CreateClusterRequest$LoggingInfo" : "<p>LoggingInfo details.</p>",
"ProvisionedRequest$LoggingInfo" : "<p>LoggingInfo details.</p>",
"MutableClusterInfo$LoggingInfo" : "<p>LoggingInfo details.</p>",
"UpdateMonitoringRequest$LoggingInfo" : "<p>LoggingInfo details.</p>"
}
},
"MutableClusterInfo" : {
"base" : "<p>Information about cluster attributes that can be updated via update APIs.</p>",
"refs" : {
"ClusterOperationInfo$SourceClusterInfo" : "<p>Information about cluster attributes before a cluster is updated.</p>",
"ClusterOperationInfo$TargetClusterInfo" : "<p>Information about cluster attributes after a cluster is updated.</p>"
}
},
"NodeExporter" : {
"base" : "<p>Indicates whether you want to enable or disable the Node Exporter.</p>",
"refs" : {
"Prometheus$NodeExporter" : "<p>Indicates whether you want to enable or disable the Node Exporter.</p>"
}
},
"NodeExporterInfo" : {
"base" : "<p>Indicates whether you want to enable or disable the Node Exporter.</p>",
"refs" : {
"PrometheusInfo$NodeExporter" : "<p>Node Exporter settings.</p>"
}
},
"NodeInfo" : {
"base" : "<p>The node information object.</p>",
"refs" : {
"__listOfNodeInfo$member" : null
}
},
"NodeType" : {
"base" : "<p>The broker or Zookeeper node.</p>",
"refs" : {
"NodeInfo$NodeType" : "<p>The node type.</p>"
}
},
"NotFoundException" : {
"base" : "<p>Returns information about an error.</p>",
"refs" : { }
},
"OpenMonitoring" : {
"base" : "<p>JMX and Node monitoring for the MSK cluster.</p>",
"refs" : {
"ClusterInfo$OpenMonitoring" : "<p>Settings for open monitoring using Prometheus.</p>",
"Provisioned$OpenMonitoring" : "<p>Settings for open monitoring using Prometheus.</p>",
"MutableClusterInfo$OpenMonitoring" : "<p>Settings for open monitoring using Prometheus.</p>"
}
},
"OpenMonitoringInfo" : {
"base" : "<p>JMX and Node monitoring for the MSK cluster.</p>",
"refs" : {
"CreateClusterRequest$OpenMonitoring" : "<p>The settings for open monitoring.</p>",
"ProvisionedRequest$OpenMonitoring" : "<p>The settings for open monitoring.</p>",
"UpdateMonitoringRequest$OpenMonitoring" : "<p>The settings for open monitoring.</p>"
}
},
"Prometheus" : {
"base" : "<p>Prometheus settings for open monitoring.</p>",
"refs" : {
"OpenMonitoring$Prometheus" : "<p>Prometheus settings.</p>"
}
},
"PrometheusInfo" : {
"base" : "<p>Prometheus settings.</p>",
"refs" : {
"OpenMonitoringInfo$Prometheus" : "<p>Prometheus settings.</p>"
}
},
"ProvisionedThroughput" : {
"base" : "Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.",
"refs" : {
"BrokerEBSVolumeInfo$ProvisionedThroughput" : "EBS volume provisioned throughput information.",
"EBSStorageInfo$ProvisionedThroughput" : "EBS volume provisioned throughput information."
}
},
"PublicAccess" : {
"base" : "<p>Broker public access control.</p>",
"refs" : {
"ConnectivityInfo$PublicAccess" : "<p>Public access control for brokers.</p>"
}
},
"RebootBrokerRequest" : {
"base" : "<p>Request body for RebootBrokerNode action.</p>",
"refs" : { }
},
"RebootBrokerResponse" : {
"base" : "<p>Response body for RebootBrokers action.</p>",
"refs" : { }
},
"S3" : {
"base" : "<p>The details of the Amazon S3 destination for broker logs.</p>",
"refs" : {
"BrokerLogs$S3" : "<p>Details of the Amazon S3 destination for broker logs.</p>"
}
},
"ServiceUnavailableException" : {
"base" : "<p>Returns information about an error.</p>",
"refs" : { }
},
"StateInfo" : {
"base" : "<p>Contains information about the state of the Amazon MSK cluster.</p>",
"refs" : {
"ClusterInfo$StateInfo" : "<p>Contains information about the state of the Amazon MSK cluster.</p>"
}
},
"StorageInfo" : {
"base" : "<p>Contains information about storage volumes attached to MSK broker nodes.</p>",
"refs" : {
"BrokerNodeGroupInfo$StorageInfo" : "<p>Contains information about storage volumes attached to MSK broker nodes.</p>"
}
},
"TagResourceRequest" : {
"base" : "<p>Tag a resource.</p>",
"refs" : { }
},
"Tls" : {
"base" : "<p>Details for client authentication using TLS.</p>",
"refs" : {
"ClientAuthentication$Tls" : "<p>Details for ClientAuthentication using TLS.</p>"
}
},
"TooManyRequestsException" : {
"base" : "<p>Returns information about an error.</p>",
"refs" : { }
},
"Unauthenticated" : {
"base" : "<p>Contains information about unauthenticated traffic to the cluster.</p>",
"refs" : {
"ClientAuthentication$Unauthenticated" : "<p>Contains information about unauthenticated traffic to the cluster.</p>"
}
},
"UnauthorizedException" : {
"base" : "<p>Returns information about an error.</p>",
"refs" : { }
},
"UpdateBrokerCountRequest" : {
"base" : "<p>Request body for UpdateBrokerCount.</p>",
"refs" : { }
},
"UpdateBrokerCountResponse" : {
"base" : "<p>Response body for UpdateBrokerCount.</p>",
"refs" : { }
},
"UpdateBrokerTypeRequest" : {
"base" : "<p>Request body for UpdateBrokerType.</p>",
"refs" : { }
},
"UpdateBrokerTypeResponse" : {
"base" : "<p>Response body for UpdateBrokerType.</p>",
"refs" : { }
},
"UpdateBrokerStorageRequest" : {
"base" : "<p>Request object for UpdateBrokerStorage.</p>",
"refs" : { }
},
"UpdateBrokerStorageResponse" : {
"base" : "<p>Response body for UpdateBrokerStorage.</p>",
"refs" : { }
},
"UpdateConfigurationRequest" : {
"base" : "<p>Request body for UpdateConfiguration.</p>",
"refs" : { }
},
"UpdateConfigurationResponse" : {
"base" : "<p>Response body for UpdateConfiguration.</p>",
"refs" : { }
},
"UpdateConnectivityRequest" : {
"base" : "<p>Request body for UpdateConnectivity.</p>",
"refs" : { }
},
"UpdateConnectivityResponse" : {
"base" : "<p>Response body for UpdateConnectivity.</p>",
"refs" : { }
},
"UpdateClusterConfigurationRequest" : {
"base" : "<p>Request body for UpdateClusterConfiguration.</p>",
"refs" : { }
},
"UpdateClusterConfigurationResponse" : {
"base" : "<p>Response body for UpdateClusterConfiguration.</p>",
"refs" : { }
},
"UpdateClusterKafkaVersionRequest" : {
"base" : "<p>Request body for UpdateClusterKafkaVersion.</p>",
"refs" : { }
},
"UpdateClusterKafkaVersionResponse" : {
"base" : "<p>Response body for UpdateClusterKafkaVersion.</p>",
"refs" : { }
},
"UpdateMonitoringRequest" : {
"base" : "<p>Request body for UpdateMonitoring.</p>",
"refs" : { }
},
"UpdateMonitoringResponse" : {
"base" : "<p>Response body for UpdateMonitoring.</p>",
"refs" : { }
},
"UpdateSecurityRequest" : {
"base" : "<p>Request body for UpdateSecurity.</p>",
"refs" : { }
},
"UpdateSecurityResponse" : {
"base" : "<p>Response body for UpdateSecurity.</p>",
"refs" : { }
},
"ZookeeperNodeInfo" : {
"base" : "<p>Zookeeper node information.</p>",
"refs" : {
"NodeInfo$ZookeeperNodeInfo" : "<p>The ZookeeperNodeInfo.</p>"
}
},
"VpcConfig" : {
"base" : "<p>The configuration of the Amazon VPCs for the cluster.</p>",
"refs" : { }
},
"__boolean" : {
"base" : null,
"refs" : {
"CloudWatchLogs$Enabled" : "<p>Specifies whether broker logs get sent to the specified CloudWatch Logs destination.</p>",
"EncryptionInTransit$InCluster" : "<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> <p>The default value is true.</p>",
"Firehose$Enabled" : "<p>Specifies whether broker logs get sent to the specified Kinesis Data Firehose delivery stream.</p>",
"IAM$Enabled" : "<p>IAM authentication is enabled or not.</p>",
"JmxExporter$EnabledInBroker" : "<p>Indicates whether you want to enable or disable the JMX Exporter.</p>",
"JmxExporterInfo$EnabledInBroker" : "<p>JMX Exporter being enabled in broker.</p>",
"NodeExporter$EnabledInBroker" : "<p>Indicates whether you want to enable or disable the Node Exporter.</p>",
"NodeExporterInfo$EnabledInBroker" : "<p>Node Exporter being enabled in broker.</p>",
"ProvisionedThroughput$Enabled" : "Provisioned throughput is enabled or not.",
"S3$Enabled" : "<p>Specifies whether broker logs get sent to the specified Amazon S3 destination.</p>",
"Scram$Enabled" : "<p>SASL/SCRAM authentication is enabled or not.</p>",
"Tls$Enabled" : "<p>TLS authentication is enabled or not.</p>",
"Unauthenticated$Enabled" : "<p>Specifies whether you want to enable or disable unauthenticated traffic to your cluster.</p>"
}
},
"__double" : {
"base" : null,
"refs" : {
"BrokerNodeInfo$BrokerId" : "<p>The ID of the broker.</p>",
"ZookeeperNodeInfo$ZookeeperId" : "<p>The role-specific ID for Zookeeper.</p>"
}
},
"__integer" : {
"base" : null,
"refs" : {
"BrokerEBSVolumeInfo$VolumeSizeGB" : "\n <p>Size of the EBS volume to update.</p>\n ",
"ClusterInfo$NumberOfBrokerNodes" : "\n <p>The number of broker nodes in the cluster.</p>\n ",
"CreateClusterRequest$NumberOfBrokerNodes" : "\n <p>The number of broker nodes in the cluster.</p>\n ",
"MutableClusterInfo$NumberOfBrokerNodes" : "\n <p>The number of broker nodes in the cluster.</p>\n ",
"ProvisionedThroughput$VolumeThroughput" : "Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second."
}
},
"__integerMin1Max15" : {
"base" : null,
"refs" : {
"CreateClusterRequest$NumberOfBrokerNodes": "<p>The number of Apache Kafka broker nodes in the Amazon MSK cluster.</p>",
"UpdateBrokerCountRequest$TargetNumberOfBrokerNodes" : "<p>The number of broker nodes that you want the cluster to have after this operation completes successfully.</p>"
}
},
"__integerMin1Max16384" : {
"base" : null,
"refs" : {
"EBSStorageInfo$VolumeSize" : "<p>The size in GiB of the EBS volume for the data drive on each broker node.</p>"
}
},
"__listOfBrokerEBSVolumeInfo" : {
"base" : null,
"refs" : {
"MutableClusterInfo$BrokerEBSVolumeInfo" : "<p>Specifies the size of the EBS volume and the ID of the associated broker.</p>",
"UpdateBrokerStorageRequest$TargetBrokerEBSVolumeInfo" : "<p>Describes the target volume size and the ID of the broker to apply the update to.</p> <p>The value you specify for Target-Volume-in-GiB must be a whole number that is greater than 100 GiB.</p> <p>The storage per broker after the update operation can't exceed 16384 GiB.</p>"
}
},
"__listOfClusterInfo" : {
"base" : null,
"refs" : {
"ListClustersResponse$ClusterInfoList" : "<p>Information on each of the MSK clusters in the response.</p>"
}
},
"__listOfCluster" : {
"base" : null,
"refs" : {
"ListClustersV2Response$ClusterInfoList" : "<p>Information on each of the MSK clusters in the response.</p>"
}
},
"__listOfVpcConfig" : {
"base" : null,
"refs" : {
"ServerlessRequest$VpcConfigs" : "<p>Information on vpc config for the serverless cluster.</p>",
"Serverless$VpcConfigs" : "<p>Information on vpc config for the serverless cluster.</p>"
}
},
"__listOfClusterOperationInfo" : {
"base" : null,
"refs" : {
"ListClusterOperationsResponse$ClusterOperationInfoList" : "<p>An array of cluster operation information objects.</p>"
}
},
"__listOfClusterOperationStep" : {
"base" : null,
"refs" : {
"ClusterOperationInfo$OperationSteps" : "<p>Steps completed during the operation.</p>"
}
},
"__listOfCompatibleKafkaVersion" : {
"base" : null,
"refs" : {
"GetCompatibleKafkaVersionsResponse$CompatibleKafkaVersions" : "<p>A list of CompatibleKafkaVersion objects.</p>"
}
},
"__listOfConfiguration" : {
"base" : null,
"refs" : {
"ListConfigurationsResponse$Configurations" : "<p>An array of MSK configurations.</p>"
}
},
"__listOfConfigurationRevision" : {
"base" : null,
"refs" : {
"ListConfigurationRevisionsResponse$Revisions" : "<p>List of ConfigurationRevision objects.</p>"
}
},
"__listOfKafkaVersion" : {
"base" : null,
"refs" : {
"ListKafkaVersionsResponse$KafkaVersions" : "<p>An array of Apache Kafka version objects.</p>"
}
},
"__listOfNodeInfo" : {
"base" : null,
"refs" : {
"ListNodesResponse$NodeInfoList" : "<p>List containing a NodeInfo object.</p>"
}
},
"__listOfUnprocessedScramSecret" : {
"base" : null,
"refs" : {
"BatchAssociateScramSecretResponse$UnprocessedScramSecrets" : "<p>List of errors when associating secrets to cluster.</p>",
"BatchDisassociateScramSecretResponse$UnprocessedScramSecrets" : "<p>List of errors when disassociating secrets to cluster.</p>"
}
},
"__listOf__string" : {
"base" : null,
"refs" : {
"BatchAssociateScramSecretRequest$SecretArnList" : "<p>List of AWS Secrets Manager secret ARNs.</p>",
"BrokerNodeGroupInfo$ClientSubnets" : "<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 be in Availability Zone us-east-1e.</p>",
"BrokerNodeGroupInfo$SecurityGroups" : "<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. If you specify security groups that were shared with you, you must ensure that you have permissions to them. Specifically, you need the ec2:DescribeSecurityGroups permission.</p>",
"BrokerNodeInfo$Endpoints" : "<p>Endpoints for accessing the broker.</p>",
"Configuration$KafkaVersions" : "<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>",
"CreateConfigurationRequest$KafkaVersions" : "<p>The versions of Apache Kafka with which you can use this MSK configuration.</p>",
"DescribeConfigurationResponse$KafkaVersions" : "<p>The versions of Apache Kafka with which you can use this MSK configuration.</p>",
"BatchDisassociateScramSecretRequest$SecretArnList" : "<p>List of AWS Secrets Manager secret ARNs.</p>",
"ListScramSecretsResponse$SecretArnList" : "<p>The list of scram secrets associated with the cluster.</p>",
"RebootBrokerRequest$BrokerIds" : "<p>The list of broker ids to be rebooted.</p>",
"Tls$CertificateAuthorityArnList" : "<p>List of ACM Certificate Authority ARNs.</p>",
"ZookeeperNodeInfo$Endpoints" : "<p>Endpoints for accessing the ZooKeeper.</p>"
}
},
"__long" : {
"base" : null,
"refs" : {
"BrokerSoftwareInfo$ConfigurationRevision" : "<p>The revision of the configuration to use. This field isn't visible in this preview release.</p>",
"ConfigurationRevision$Revision" : "<p>The revision number.</p>",
"DescribeConfigurationRevisionResponse$Revision" : "<p>The revision number.</p>",
"ConfigurationInfo$Revision" : "<p>The revision of the configuration to use.</p>"
}
},
"__mapOf__string" : {
"base" : null,
"refs" : {
"ClusterInfo$Tags" : "<p>Tags attached to the cluster.</p>",
"CreateClusterRequest$Tags" : "<p>Create tags when creating the cluster.</p>",
"ListTagsForResourceResponse$Tags" : "<p>The key-value pair for the resource tag.</p>",
"TagResourceRequest$Tags" : "<p>The key-value pair for the resource tag.</p>"
}
},
"__string" : {
"base" : null,
"refs" : {
"BatchAssociateScramSecretResponse$ClusterArn" : "<p>The Amazon Resource Name (ARN) of the cluster.</p>",
"BrokerEBSVolumeInfo$KafkaBrokerNodeId" : "<p>The ID of the broker to update.</p>",
"BrokerNodeInfo$AttachedENIId" : "<p>The attached elastic network interface of the broker.</p>",
"BrokerNodeInfo$ClientSubnet" : "<p>The client subnet to which this broker node belongs.</p>",
"BrokerNodeInfo$ClientVpcIpAddress" : "<p>The virtual private cloud (VPC) of the client.</p>",
"BrokerSoftwareInfo$ConfigurationArn" : "<p>The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.</p>",
"BrokerSoftwareInfo$KafkaVersion" : "<p>The version of Apache Kafka.</p>",
"CloudWatchLogs$LogGroup" : "<p>The CloudWatch log group that is the destination for broker logs.</p>",
"ClusterInfo$ActiveOperationArn" : "<p>Arn of active cluster operation.</p>",
"ClusterInfo$ClusterArn" : "<p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>",
"ClusterInfo$ClusterName" : "<p>The name of the cluster.</p>",
"ClusterInfo$CurrentVersion" : "<p>The current version of the MSK cluster. Cluster versions aren't simple integers. You can obtain the current version by describing the cluster. An example version is KTVPDKIKX0DER.</p>",
"ClusterInfo$ZookeeperConnectString" : "<p>The connection string to use to connect to the Apache ZooKeeper cluster.</p>",
"ClusterInfo$ZookeeperConnectStringTls" : "<p>The connection string to use to connect to zookeeper cluster on Tls port.</p>",
"ClusterOperationInfo$ClientRequestId" : "<p>The ID of the API request that triggered this operation.</p>",
"ClusterOperationInfo$ClusterArn" : "<p>ARN of the cluster.</p>",
"ClusterOperationInfo$OperationArn" : "<p>ARN of the cluster operation.</p>",
"ClusterOperationInfo$OperationState" : "<p>State of the cluster operation.</p>",
"ClusterOperationInfo$OperationType" : "<p>Type of the cluster operation.</p>",
"ClusterOperationStep$StepName" : "<p>The name of the step.</p>",
"ClusterOperationStepInfo$StepStatus" : "<p>The steps current status.</p>",
"Configuration$Arn" : "<p>The Amazon Resource Name (ARN) of the configuration.</p>",
"Configuration$Description" : "<p>The description of the configuration.</p>",
"Configuration$Name" : "<p>The name of the configuration. Configuration names are strings that match the regex \"^[0-9A-Za-z-]+$\".</p>",
"ConfigurationInfo$Arn" : "<p>ARN of the configuration to use.</p>",
"ConfigurationRevision$Description" : "<p>The description of the configuration revision.</p>",
"CreateClusterResponse$ClusterArn" : "<p>The Amazon Resource Name (ARN) of the cluster.</p>",
"CreateClusterResponse$ClusterName" : "<p>The name of the MSK cluster.</p>",
"CreateConfigurationRequest$Description" : "<p>The description of the configuration.</p>",
"CreateConfigurationRequest$Name" : "<p>The name of the configuration. Configuration names are strings that match the regex \"^[0-9A-Za-z-]+$\".</p>",
"CreateConfigurationResponse$Arn" : "<p>The Amazon Resource Name (ARN) of the configuration.</p>",
"CreateConfigurationResponse$Name" : "<p>The name of the configuration. Configuration names are strings that match the regex \"^[0-9A-Za-z-]+$\".</p>",
"DeleteClusterResponse$ClusterArn" : "<p>The Amazon Resource Name (ARN) of the cluster.</p>",
"DeleteConfigurationRequest$Arn" : "<p>The Amazon Resource Name (ARN) of the configuration.</p>",
"DeleteConfigurationResponse$Arn" : "<p>The Amazon Resource Name (ARN) of the configuration.</p>",
"DescribeConfigurationResponse$Arn" : "<p>The Amazon Resource Name (ARN) of the configuration.</p>",
"DescribeConfigurationResponse$Description" : "<p>The description of the configuration.</p>",
"DescribeConfigurationResponse$Name" : "<p>The name of the configuration. Configuration names are strings that match the regex \"^[0-9A-Za-z-]+$\".</p>",
"DescribeConfigurationRevisionResponse$Arn" : "<p>The Amazon Resource Name (ARN) of the configuration.</p>",
"DescribeConfigurationRevisionResponse$Description" : "<p>The description of the configuration.</p>",
"BatchDisassociateScramSecretResponse$ClusterArn" : "<p>The Amazon Resource Name (ARN) of the cluster.</p>",
"EncryptionAtRest$DataVolumeKMSKeyId" : "<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>",
"Error$InvalidParameter" : "<p>The parameter that caused the error.</p>",
"Error$Message" : "<p>The description of the error.</p>",
"ErrorInfo$ErrorCode" : "<p>A number describing the error programmatically.</p>",
"ErrorInfo$ErrorString" : "<p>An optional field to provide more details about the error.</p>",
"Firehose$DeliveryStream" : "<p>The Kinesis Data Firehose delivery stream that is the destination for broker logs.</p>",
"GetBootstrapBrokersResponse$BootstrapBrokerString" : "<p>A string containing one or more hostname:port pairs.</p>",
"GetBootstrapBrokersResponse$BootstrapBrokerStringTls" : "<p>A string containing one or more DNS names (or IP addresses) and TLS port pairs. The following is an example.</p> <programlisting>{\n \"BootstrapBrokerStringTls\": \"b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094\"\n}</programlisting>",
"GetBootstrapBrokersResponse$BootstrapBrokerStringSaslScram" : "<p>A string containing one or more DNS names (or IP addresses) and SASL SCRAM port pairs. The following is an example.</p> <programlisting>{\n \"BootstrapBrokerStringSaslScram\": \"b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096\"\n}</programlisting>",
"GetBootstrapBrokersResponse$BootstrapBrokerStringSaslIam" : "<p>A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs. The following is an example.</p> <programlisting>{\n \"BootstrapBrokerStringSaslIam\": \"b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098\"\n}</programlisting>",
"GetBootstrapBrokersResponse$BootstrapBrokerStringPublicTls" : "<p>A string containing one or more DNS names (or IP addresses) and TLS port pairs. The following is an example.</p> <programlisting>{\n \"BootstrapBrokerStringTls\": \"b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194\"\n}</programlisting>",
"GetBootstrapBrokersResponse$BootstrapBrokerStringPublicSaslScram" : "<p>A string containing one or more DNS names (or IP addresses) and SASL SCRAM port pairs. The following is an example.</p> <programlisting>{\n \"BootstrapBrokerStringSaslScram\": \"b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196\"\n}</programlisting>",
"GetBootstrapBrokersResponse$BootstrapBrokerStringPublicSaslIam" : "<p>A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs. The following is an example.</p> <programlisting>{\n \"BootstrapBrokerStringSaslIam\": \"b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198\"\n}</programlisting>",
"KafkaVersion$Version" : "<p>The Apache Kafka version.</p>",
"ListClusterOperationsResponse$NextToken" : "<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>",
"ListClustersResponse$NextToken" : "<p>The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. To get another batch of clusters, provide this token in your next request.</p>",
"ListConfigurationRevisionsResponse$NextToken" : "<p>Paginated results marker.</p>",
"ListConfigurationsResponse$NextToken" : "<p>The paginated results marker. When the result of a ListConfigurations operation is truncated, the call returns NextToken in the response. To get another batch of configurations, provide this token in your next request.</p>",
"ListKafkaVersionsResponse$NextToken" : "<p>Paginated results marker.</p>",
"ListNodesResponse$NextToken" : "<p>The paginated results marker. When the result of a ListNodes operation is truncated, the call returns NextToken in the response. To get another batch of nodes, provide this token in your next request.</p>",
"ListScramSecretsResponse$NextToken" : "<p>Paginated results marker.</p>",
"NodeInfo$AddedToClusterTime" : "<p>The start time.</p>",
"NodeInfo$InstanceType" : "<p>The instance type.</p>",
"NodeInfo$NodeARN" : "<p>The Amazon Resource Name (ARN) of the node.</p>",
"PublicAccess$Type" : "<p>The value DISABLED indicates that public access is disabled. SERVICE_PROVIDED_EIPS indicates that public access is enabled.</p>",
"RebootBrokerResponse$ClusterArn" : "<p>The Amazon Resource Name (ARN) of the cluster.</p>",
"RebootBrokerResponse$ClusterOperationArn" : "<p>The Amazon Resource Name (ARN) of the cluster operation.</p>",
"S3$Bucket" : "<p>The name of the S3 bucket that is the destination for broker logs.</p>",
"S3$Prefix" : "<p>The S3 prefix that is the destination for broker logs.</p>",
"StateInfo$Code" : "<p>If the cluster is in an unusable state, this field contains the code that describes the issue.</p>",
"StateInfo$Message" : "<p>If the cluster is in an unusable state, this field contains a message that describes the issue.</p>",
"UpdateBrokerCountRequest$CurrentVersion" : "<p>The current version of the cluster.</p>",
"UpdateBrokerCountResponse$ClusterArn" : "<p>The Amazon Resource Name (ARN) of the cluster.</p>",
"UpdateBrokerCountResponse$ClusterOperationArn" : "<p>The Amazon Resource Name (ARN) of the cluster operation.</p>",
"UpdateBrokerTypeRequest$CurrentVersion": "<p>The current version of the cluster.</p>",
"UpdateBrokerTypeRequest$TargetInstanceType": "<p>The Amazon MSK broker type that you want all of the brokers in this cluster to be.</p>",
"UpdateBrokerTypeResponse$ClusterArn" : "<p>The Amazon Resource Name (ARN) of the cluster.</p>",
"UpdateBrokerTypeResponse$ClusterOperationArn" : "<p>The Amazon Resource Name (ARN) of the cluster operation.</p>",
"UpdateBrokerStorageRequest$CurrentVersion" : "<p>The version of cluster to update from. A successful operation will then generate a new version.</p>",
"UpdateBrokerStorageResponse$ClusterArn" : "<p>The Amazon Resource Name (ARN) of the cluster.</p>",
"UpdateBrokerStorageResponse$ClusterOperationArn" : "<p>The Amazon Resource Name (ARN) of the cluster operation.</p>",
"UpdateConfigurationRequest$Description" : "<p>The description of the configuration.</p>",
"UpdateConfigurationRequest$Arn" : "<p>The Amazon Resource Name (ARN) of the configuration.</p>",
"UpdateConfigurationResponse$Arn" : "<p>The Amazon Resource Name (ARN) of the configuration.</p>",
"UpdateConnectivityRequest$CurrentVersion" : "<p>The current version of the cluster.</p>",
"UpdateConnectivityResponse$ClusterArn" : "<p>The Amazon Resource Name (ARN) of the cluster.</p>",
"UpdateConnectivityResponse$ClusterOperationArn" : "<p>The Amazon Resource Name (ARN) of the cluster operation.</p>",
"UpdateClusterConfigurationRequest$CurrentVersion" : "<p>The version of the cluster that you want to update.</p>",
"UpdateClusterConfigurationResponse$ClusterArn" : "<p>The Amazon Resource Name (ARN) of the cluster.</p>",
"UpdateClusterConfigurationResponse$ClusterOperationArn" : "<p>The Amazon Resource Name (ARN) of the cluster operation.</p>",
"UpdateClusterKafkaVersionRequest$CurrentVersion" : "<p>Current cluster version.</p>",
"UpdateClusterKafkaVersionRequest$TargetKafkaVersion" : "<p>Target Apache Kafka version.</p>",
"UpdateClusterKafkaVersionResponse$ClusterArn" : "<p>The Amazon Resource Name (ARN) of the cluster.</p>",
"UpdateClusterKafkaVersionResponse$ClusterOperationArn" : "<p>The Amazon Resource Name (ARN) of the cluster operation.</p>",
"UpdateMonitoringRequest$CurrentVersion" : "<p>The version of cluster to update from. A successful operation will then generate a new version.</p>",
"UpdateMonitoringResponse$ClusterArn" : "<p>The Amazon Resource Name (ARN) of the cluster.</p>",
"UpdateMonitoringResponse$ClusterOperationArn" : "<p>The Amazon Resource Name (ARN) of the cluster operation.</p>",
"UpdateSecurityRequest$CurrentVersion" : "<p>You can use the DescribeCluster operation to get the current version of the cluster. After the security update is complete, the cluster will have a new version.</p>",
"UpdateSecurityResponse$ClusterArn" : "<p>The Amazon Resource Name (ARN) of the cluster.</p>",
"UpdateSecurityResponse$ClusterOperationArn" : "<p>The Amazon Resource Name (ARN) of the cluster operation.</p>",
"ZookeeperNodeInfo$AttachedENIId" : "<p>The attached elastic network interface of the broker.</p>",
"ZookeeperNodeInfo$ClientVpcIpAddress" : "<p>The virtual private cloud (VPC) IP address of the client.</p>",
"ZookeeperNodeInfo$ZookeeperVersion" : "<p>The version of Zookeeper.</p>",
"__listOf__string$member" : null,
"__mapOf__string$member" : null
}
},
"__stringMin1Max128" : {
"base" : null,
"refs" : {
"CreateClusterRequest$KafkaVersion" : "<p>The version of Apache Kafka.</p>"
}
},
"__stringMin1Max64" : {
"base" : null,
"refs" : {
"CreateClusterRequest$ClusterName" : "<p>The name of the cluster.</p>"
}
},
"__stringMin5Max32" : {
"base" : null,
"refs" : {
"BrokerNodeGroupInfo$InstanceType" : "<p>The type of broker used in the Amazon MSK cluster.</p>",
"MutableClusterInfo$InstanceType": "<p>The Amazon MSK broker type that you want all of the brokers in this cluster to be.</p>"
}
},
"__timestampIso8601" : {
"base" : null,
"refs" : {
"ClusterInfo$CreationTime" : "<p>The time when the cluster was created.</p>",
"ConfigurationRevision$CreationTime" : "<p>The time when the configuration revision was created.</p>",
"CreateConfigurationResponse$CreationTime" : "<p>The time when the configuration was created.</p>",
"DescribeConfigurationResponse$CreationTime" : "<p>The time when the configuration was created.</p>",
"DescribeConfigurationRevisionResponse$CreationTime" : "<p>The time when the configuration was created.</p>",
"ClusterOperationInfo$CreationTime" : "<p>The time at which operation was created.</p>",
"ClusterOperationInfo$EndTime" : "<p>The time at which the operation finished.</p>"
}
}
}
}