kafka.d.ts
60.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Kafka extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Kafka.Types.ClientConfiguration)
config: Config & Kafka.Types.ClientConfiguration;
/**
*
Associates one or more Scram Secrets with an Amazon MSK cluster.
*/
batchAssociateScramSecret(params: Kafka.Types.BatchAssociateScramSecretRequest, callback?: (err: AWSError, data: Kafka.Types.BatchAssociateScramSecretResponse) => void): Request<Kafka.Types.BatchAssociateScramSecretResponse, AWSError>;
/**
*
Associates one or more Scram Secrets with an Amazon MSK cluster.
*/
batchAssociateScramSecret(callback?: (err: AWSError, data: Kafka.Types.BatchAssociateScramSecretResponse) => void): Request<Kafka.Types.BatchAssociateScramSecretResponse, AWSError>;
/**
*
Creates a new MSK cluster.
*/
createCluster(params: Kafka.Types.CreateClusterRequest, callback?: (err: AWSError, data: Kafka.Types.CreateClusterResponse) => void): Request<Kafka.Types.CreateClusterResponse, AWSError>;
/**
*
Creates a new MSK cluster.
*/
createCluster(callback?: (err: AWSError, data: Kafka.Types.CreateClusterResponse) => void): Request<Kafka.Types.CreateClusterResponse, AWSError>;
/**
*
Creates a new MSK configuration.
*/
createConfiguration(params: Kafka.Types.CreateConfigurationRequest, callback?: (err: AWSError, data: Kafka.Types.CreateConfigurationResponse) => void): Request<Kafka.Types.CreateConfigurationResponse, AWSError>;
/**
*
Creates a new MSK configuration.
*/
createConfiguration(callback?: (err: AWSError, data: Kafka.Types.CreateConfigurationResponse) => void): Request<Kafka.Types.CreateConfigurationResponse, AWSError>;
/**
*
Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
*/
deleteCluster(params: Kafka.Types.DeleteClusterRequest, callback?: (err: AWSError, data: Kafka.Types.DeleteClusterResponse) => void): Request<Kafka.Types.DeleteClusterResponse, AWSError>;
/**
*
Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
*/
deleteCluster(callback?: (err: AWSError, data: Kafka.Types.DeleteClusterResponse) => void): Request<Kafka.Types.DeleteClusterResponse, AWSError>;
/**
*
Deletes an MSK Configuration.
*/
deleteConfiguration(params: Kafka.Types.DeleteConfigurationRequest, callback?: (err: AWSError, data: Kafka.Types.DeleteConfigurationResponse) => void): Request<Kafka.Types.DeleteConfigurationResponse, AWSError>;
/**
*
Deletes an MSK Configuration.
*/
deleteConfiguration(callback?: (err: AWSError, data: Kafka.Types.DeleteConfigurationResponse) => void): Request<Kafka.Types.DeleteConfigurationResponse, AWSError>;
/**
*
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
*/
describeCluster(params: Kafka.Types.DescribeClusterRequest, callback?: (err: AWSError, data: Kafka.Types.DescribeClusterResponse) => void): Request<Kafka.Types.DescribeClusterResponse, AWSError>;
/**
*
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
*/
describeCluster(callback?: (err: AWSError, data: Kafka.Types.DescribeClusterResponse) => void): Request<Kafka.Types.DescribeClusterResponse, AWSError>;
/**
*
Returns a description of the cluster operation specified by the ARN.
*/
describeClusterOperation(params: Kafka.Types.DescribeClusterOperationRequest, callback?: (err: AWSError, data: Kafka.Types.DescribeClusterOperationResponse) => void): Request<Kafka.Types.DescribeClusterOperationResponse, AWSError>;
/**
*
Returns a description of the cluster operation specified by the ARN.
*/
describeClusterOperation(callback?: (err: AWSError, data: Kafka.Types.DescribeClusterOperationResponse) => void): Request<Kafka.Types.DescribeClusterOperationResponse, AWSError>;
/**
*
Returns a description of this MSK configuration.
*/
describeConfiguration(params: Kafka.Types.DescribeConfigurationRequest, callback?: (err: AWSError, data: Kafka.Types.DescribeConfigurationResponse) => void): Request<Kafka.Types.DescribeConfigurationResponse, AWSError>;
/**
*
Returns a description of this MSK configuration.
*/
describeConfiguration(callback?: (err: AWSError, data: Kafka.Types.DescribeConfigurationResponse) => void): Request<Kafka.Types.DescribeConfigurationResponse, AWSError>;
/**
*
Returns a description of this revision of the configuration.
*/
describeConfigurationRevision(params: Kafka.Types.DescribeConfigurationRevisionRequest, callback?: (err: AWSError, data: Kafka.Types.DescribeConfigurationRevisionResponse) => void): Request<Kafka.Types.DescribeConfigurationRevisionResponse, AWSError>;
/**
*
Returns a description of this revision of the configuration.
*/
describeConfigurationRevision(callback?: (err: AWSError, data: Kafka.Types.DescribeConfigurationRevisionResponse) => void): Request<Kafka.Types.DescribeConfigurationRevisionResponse, AWSError>;
/**
*
Disassociates one or more Scram Secrets from an Amazon MSK cluster.
*/
batchDisassociateScramSecret(params: Kafka.Types.BatchDisassociateScramSecretRequest, callback?: (err: AWSError, data: Kafka.Types.BatchDisassociateScramSecretResponse) => void): Request<Kafka.Types.BatchDisassociateScramSecretResponse, AWSError>;
/**
*
Disassociates one or more Scram Secrets from an Amazon MSK cluster.
*/
batchDisassociateScramSecret(callback?: (err: AWSError, data: Kafka.Types.BatchDisassociateScramSecretResponse) => void): Request<Kafka.Types.BatchDisassociateScramSecretResponse, AWSError>;
/**
*
A list of brokers that a client application can use to bootstrap.
*/
getBootstrapBrokers(params: Kafka.Types.GetBootstrapBrokersRequest, callback?: (err: AWSError, data: Kafka.Types.GetBootstrapBrokersResponse) => void): Request<Kafka.Types.GetBootstrapBrokersResponse, AWSError>;
/**
*
A list of brokers that a client application can use to bootstrap.
*/
getBootstrapBrokers(callback?: (err: AWSError, data: Kafka.Types.GetBootstrapBrokersResponse) => void): Request<Kafka.Types.GetBootstrapBrokersResponse, AWSError>;
/**
*
Gets the Apache Kafka versions to which you can update the MSK cluster.
*/
getCompatibleKafkaVersions(params: Kafka.Types.GetCompatibleKafkaVersionsRequest, callback?: (err: AWSError, data: Kafka.Types.GetCompatibleKafkaVersionsResponse) => void): Request<Kafka.Types.GetCompatibleKafkaVersionsResponse, AWSError>;
/**
*
Gets the Apache Kafka versions to which you can update the MSK cluster.
*/
getCompatibleKafkaVersions(callback?: (err: AWSError, data: Kafka.Types.GetCompatibleKafkaVersionsResponse) => void): Request<Kafka.Types.GetCompatibleKafkaVersionsResponse, AWSError>;
/**
*
Returns a list of all the operations that have been performed on the specified MSK cluster.
*/
listClusterOperations(params: Kafka.Types.ListClusterOperationsRequest, callback?: (err: AWSError, data: Kafka.Types.ListClusterOperationsResponse) => void): Request<Kafka.Types.ListClusterOperationsResponse, AWSError>;
/**
*
Returns a list of all the operations that have been performed on the specified MSK cluster.
*/
listClusterOperations(callback?: (err: AWSError, data: Kafka.Types.ListClusterOperationsResponse) => void): Request<Kafka.Types.ListClusterOperationsResponse, AWSError>;
/**
*
Returns a list of all the MSK clusters in the current Region.
*/
listClusters(params: Kafka.Types.ListClustersRequest, callback?: (err: AWSError, data: Kafka.Types.ListClustersResponse) => void): Request<Kafka.Types.ListClustersResponse, AWSError>;
/**
*
Returns a list of all the MSK clusters in the current Region.
*/
listClusters(callback?: (err: AWSError, data: Kafka.Types.ListClustersResponse) => void): Request<Kafka.Types.ListClustersResponse, AWSError>;
/**
*
Returns a list of all the MSK configurations in this Region.
*/
listConfigurationRevisions(params: Kafka.Types.ListConfigurationRevisionsRequest, callback?: (err: AWSError, data: Kafka.Types.ListConfigurationRevisionsResponse) => void): Request<Kafka.Types.ListConfigurationRevisionsResponse, AWSError>;
/**
*
Returns a list of all the MSK configurations in this Region.
*/
listConfigurationRevisions(callback?: (err: AWSError, data: Kafka.Types.ListConfigurationRevisionsResponse) => void): Request<Kafka.Types.ListConfigurationRevisionsResponse, AWSError>;
/**
*
Returns a list of all the MSK configurations in this Region.
*/
listConfigurations(params: Kafka.Types.ListConfigurationsRequest, callback?: (err: AWSError, data: Kafka.Types.ListConfigurationsResponse) => void): Request<Kafka.Types.ListConfigurationsResponse, AWSError>;
/**
*
Returns a list of all the MSK configurations in this Region.
*/
listConfigurations(callback?: (err: AWSError, data: Kafka.Types.ListConfigurationsResponse) => void): Request<Kafka.Types.ListConfigurationsResponse, AWSError>;
/**
*
Returns a list of Kafka versions.
*/
listKafkaVersions(params: Kafka.Types.ListKafkaVersionsRequest, callback?: (err: AWSError, data: Kafka.Types.ListKafkaVersionsResponse) => void): Request<Kafka.Types.ListKafkaVersionsResponse, AWSError>;
/**
*
Returns a list of Kafka versions.
*/
listKafkaVersions(callback?: (err: AWSError, data: Kafka.Types.ListKafkaVersionsResponse) => void): Request<Kafka.Types.ListKafkaVersionsResponse, AWSError>;
/**
*
Returns a list of the broker nodes in the cluster.
*/
listNodes(params: Kafka.Types.ListNodesRequest, callback?: (err: AWSError, data: Kafka.Types.ListNodesResponse) => void): Request<Kafka.Types.ListNodesResponse, AWSError>;
/**
*
Returns a list of the broker nodes in the cluster.
*/
listNodes(callback?: (err: AWSError, data: Kafka.Types.ListNodesResponse) => void): Request<Kafka.Types.ListNodesResponse, AWSError>;
/**
*
Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
*/
listScramSecrets(params: Kafka.Types.ListScramSecretsRequest, callback?: (err: AWSError, data: Kafka.Types.ListScramSecretsResponse) => void): Request<Kafka.Types.ListScramSecretsResponse, AWSError>;
/**
*
Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
*/
listScramSecrets(callback?: (err: AWSError, data: Kafka.Types.ListScramSecretsResponse) => void): Request<Kafka.Types.ListScramSecretsResponse, AWSError>;
/**
*
Returns a list of the tags associated with the specified resource.
*/
listTagsForResource(params: Kafka.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Kafka.Types.ListTagsForResourceResponse) => void): Request<Kafka.Types.ListTagsForResourceResponse, AWSError>;
/**
*
Returns a list of the tags associated with the specified resource.
*/
listTagsForResource(callback?: (err: AWSError, data: Kafka.Types.ListTagsForResourceResponse) => void): Request<Kafka.Types.ListTagsForResourceResponse, AWSError>;
/**
* Reboots brokers.
*/
rebootBroker(params: Kafka.Types.RebootBrokerRequest, callback?: (err: AWSError, data: Kafka.Types.RebootBrokerResponse) => void): Request<Kafka.Types.RebootBrokerResponse, AWSError>;
/**
* Reboots brokers.
*/
rebootBroker(callback?: (err: AWSError, data: Kafka.Types.RebootBrokerResponse) => void): Request<Kafka.Types.RebootBrokerResponse, AWSError>;
/**
*
Adds tags to the specified MSK resource.
*/
tagResource(params: Kafka.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
*
Adds tags to the specified MSK resource.
*/
tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
*
Removes the tags associated with the keys that are provided in the query.
*/
untagResource(params: Kafka.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
*
Removes the tags associated with the keys that are provided in the query.
*/
untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
*
Updates the number of broker nodes in the cluster.
*/
updateBrokerCount(params: Kafka.Types.UpdateBrokerCountRequest, callback?: (err: AWSError, data: Kafka.Types.UpdateBrokerCountResponse) => void): Request<Kafka.Types.UpdateBrokerCountResponse, AWSError>;
/**
*
Updates the number of broker nodes in the cluster.
*/
updateBrokerCount(callback?: (err: AWSError, data: Kafka.Types.UpdateBrokerCountResponse) => void): Request<Kafka.Types.UpdateBrokerCountResponse, AWSError>;
/**
*
Updates the EBS storage associated with MSK brokers.
*/
updateBrokerStorage(params: Kafka.Types.UpdateBrokerStorageRequest, callback?: (err: AWSError, data: Kafka.Types.UpdateBrokerStorageResponse) => void): Request<Kafka.Types.UpdateBrokerStorageResponse, AWSError>;
/**
*
Updates the EBS storage associated with MSK brokers.
*/
updateBrokerStorage(callback?: (err: AWSError, data: Kafka.Types.UpdateBrokerStorageResponse) => void): Request<Kafka.Types.UpdateBrokerStorageResponse, AWSError>;
/**
*
Updates an MSK configuration.
*/
updateConfiguration(params: Kafka.Types.UpdateConfigurationRequest, callback?: (err: AWSError, data: Kafka.Types.UpdateConfigurationResponse) => void): Request<Kafka.Types.UpdateConfigurationResponse, AWSError>;
/**
*
Updates an MSK configuration.
*/
updateConfiguration(callback?: (err: AWSError, data: Kafka.Types.UpdateConfigurationResponse) => void): Request<Kafka.Types.UpdateConfigurationResponse, AWSError>;
/**
*
Updates the cluster with the configuration that is specified in the request body.
*/
updateClusterConfiguration(params: Kafka.Types.UpdateClusterConfigurationRequest, callback?: (err: AWSError, data: Kafka.Types.UpdateClusterConfigurationResponse) => void): Request<Kafka.Types.UpdateClusterConfigurationResponse, AWSError>;
/**
*
Updates the cluster with the configuration that is specified in the request body.
*/
updateClusterConfiguration(callback?: (err: AWSError, data: Kafka.Types.UpdateClusterConfigurationResponse) => void): Request<Kafka.Types.UpdateClusterConfigurationResponse, AWSError>;
/**
*
Updates the Apache Kafka version for the cluster.
*/
updateClusterKafkaVersion(params: Kafka.Types.UpdateClusterKafkaVersionRequest, callback?: (err: AWSError, data: Kafka.Types.UpdateClusterKafkaVersionResponse) => void): Request<Kafka.Types.UpdateClusterKafkaVersionResponse, AWSError>;
/**
*
Updates the Apache Kafka version for the cluster.
*/
updateClusterKafkaVersion(callback?: (err: AWSError, data: Kafka.Types.UpdateClusterKafkaVersionResponse) => void): Request<Kafka.Types.UpdateClusterKafkaVersionResponse, AWSError>;
/**
*
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.
*/
updateMonitoring(params: Kafka.Types.UpdateMonitoringRequest, callback?: (err: AWSError, data: Kafka.Types.UpdateMonitoringResponse) => void): Request<Kafka.Types.UpdateMonitoringResponse, AWSError>;
/**
*
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.
*/
updateMonitoring(callback?: (err: AWSError, data: Kafka.Types.UpdateMonitoringResponse) => void): Request<Kafka.Types.UpdateMonitoringResponse, AWSError>;
}
declare namespace Kafka {
export interface BatchAssociateScramSecretRequest {
/**
*
The Amazon Resource Name (ARN) of the cluster to be updated.
*/
ClusterArn: __string;
/**
*
List of AWS Secrets Manager secret ARNs.
*/
SecretArnList: __listOf__string;
}
export interface BatchAssociateScramSecretResponse {
/**
*
The Amazon Resource Name (ARN) of the cluster.
*/
ClusterArn?: __string;
/**
*
List of errors when associating secrets to cluster.
*/
UnprocessedScramSecrets?: __listOfUnprocessedScramSecret;
}
export type BrokerAZDistribution = "DEFAULT"|string;
export interface BrokerEBSVolumeInfo {
/**
*
The ID of the broker to update.
*/
KafkaBrokerNodeId: __string;
/**
*
Size of the EBS volume to update.
*/
VolumeSizeGB: __integer;
}
export interface BrokerLogs {
CloudWatchLogs?: CloudWatchLogs;
Firehose?: Firehose;
S3?: S3;
}
export interface BrokerNodeGroupInfo {
/**
*
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.
Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.
*/
BrokerAZDistribution?: BrokerAZDistribution;
/**
*
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.
*/
ClientSubnets: __listOf__string;
/**
*
The type of Amazon EC2 instances to use for Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge,
kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.
*/
InstanceType: __stringMin5Max32;
/**
*
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.
*/
SecurityGroups?: __listOf__string;
/**
*
Contains information about storage volumes attached to MSK broker nodes.
*/
StorageInfo?: StorageInfo;
}
export interface BrokerNodeInfo {
/**
*
The attached elastic network interface of the broker.
*/
AttachedENIId?: __string;
/**
*
The ID of the broker.
*/
BrokerId?: __double;
/**
*
The client subnet to which this broker node belongs.
*/
ClientSubnet?: __string;
/**
*
The virtual private cloud (VPC) of the client.
*/
ClientVpcIpAddress?: __string;
/**
*
Information about the version of software currently deployed on the Kafka brokers in the cluster.
*/
CurrentBrokerSoftwareInfo?: BrokerSoftwareInfo;
/**
*
Endpoints for accessing the broker.
*/
Endpoints?: __listOf__string;
}
export interface BrokerSoftwareInfo {
/**
*
The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.
*/
ConfigurationArn?: __string;
/**
*
The revision of the configuration to use. This field isn't visible in this preview release.
*/
ConfigurationRevision?: __long;
/**
*
The version of Apache Kafka.
*/
KafkaVersion?: __string;
}
export interface ClientAuthentication {
/**
*
Details for ClientAuthentication using SASL.
*/
Sasl?: Sasl;
/**
*
Details for ClientAuthentication using TLS.
*/
Tls?: Tls;
}
export type ClientBroker = "TLS"|"TLS_PLAINTEXT"|"PLAINTEXT"|string;
export interface CloudWatchLogs {
Enabled: __boolean;
LogGroup?: __string;
}
export interface ClusterInfo {
/**
*
Arn of active cluster operation.
*/
ActiveOperationArn?: __string;
/**
*
Information about the broker nodes.
*/
BrokerNodeGroupInfo?: BrokerNodeGroupInfo;
/**
*
Includes all client authentication information.
*/
ClientAuthentication?: ClientAuthentication;
/**
*
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
*/
ClusterArn?: __string;
/**
*
The name of the cluster.
*/
ClusterName?: __string;
/**
*
The time when the cluster was created.
*/
CreationTime?: __timestampIso8601;
/**
*
Information about the version of software currently deployed on the Kafka brokers in the cluster.
*/
CurrentBrokerSoftwareInfo?: BrokerSoftwareInfo;
/**
*
The current version of the MSK cluster.
*/
CurrentVersion?: __string;
/**
*
Includes all encryption-related information.
*/
EncryptionInfo?: EncryptionInfo;
/**
*
Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of monitoring, see Monitoring.
*/
EnhancedMonitoring?: EnhancedMonitoring;
/**
*
Settings for open monitoring using Prometheus.
*/
OpenMonitoring?: OpenMonitoring;
LoggingInfo?: LoggingInfo;
/**
*
The number of broker nodes in the cluster.
*/
NumberOfBrokerNodes?: __integer;
/**
*
The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.
*/
State?: ClusterState;
StateInfo?: StateInfo;
/**
*
Tags attached to the cluster.
*/
Tags?: __mapOf__string;
/**
*
The connection string to use to connect to the Apache ZooKeeper cluster.
*/
ZookeeperConnectString?: __string;
/**
*
The connection string to use to connect to zookeeper cluster on Tls port.
*/
ZookeeperConnectStringTls?: __string;
}
export interface ClusterOperationInfo {
/**
*
The ID of the API request that triggered this operation.
*/
ClientRequestId?: __string;
/**
*
ARN of the cluster.
*/
ClusterArn?: __string;
/**
*
The time that the operation was created.
*/
CreationTime?: __timestampIso8601;
/**
*
The time at which the operation finished.
*/
EndTime?: __timestampIso8601;
/**
*
Describes the error if the operation fails.
*/
ErrorInfo?: ErrorInfo;
/**
*
ARN of the cluster operation.
*/
OperationArn?: __string;
/**
*
State of the cluster operation.
*/
OperationState?: __string;
/**
*
Steps completed during the operation.
*/
OperationSteps?: __listOfClusterOperationStep;
/**
*
Type of the cluster operation.
*/
OperationType?: __string;
/**
*
Information about cluster attributes before a cluster is updated.
*/
SourceClusterInfo?: MutableClusterInfo;
/**
*
Information about cluster attributes after a cluster is updated.
*/
TargetClusterInfo?: MutableClusterInfo;
}
export interface ClusterOperationStep {
/**
*
Information about the step and its status.
*/
StepInfo?: ClusterOperationStepInfo;
/**
*
The name of the step.
*/
StepName?: __string;
}
export interface ClusterOperationStepInfo {
/**
*
The steps current status.
*/
StepStatus?: __string;
}
export type ClusterState = "ACTIVE"|"CREATING"|"UPDATING"|"DELETING"|"FAILED"|string;
export interface CompatibleKafkaVersion {
/**
*
A Kafka version.
*/
SourceVersion?: __string;
/**
*
A list of Kafka versions.
*/
TargetVersions?: __listOf__string;
}
export interface Configuration {
/**
*
The Amazon Resource Name (ARN) of the configuration.
*/
Arn: __string;
/**
*
The time when the configuration was created.
*/
CreationTime: __timestampIso8601;
/**
*
The description of the configuration.
*/
Description: __string;
/**
*
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.
*/
KafkaVersions: __listOf__string;
/**
*
Latest revision of the configuration.
*/
LatestRevision: ConfigurationRevision;
/**
*
The name of the configuration.
*/
Name: __string;
/**
*
The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
*/
State: ConfigurationState;
}
export interface ConfigurationInfo {
/**
*
ARN of the configuration to use.
*/
Arn: __string;
/**
*
The revision of the configuration to use.
*/
Revision: __long;
}
export interface ConfigurationRevision {
/**
*
The time when the configuration revision was created.
*/
CreationTime: __timestampIso8601;
/**
*
The description of the configuration revision.
*/
Description?: __string;
/**
*
The revision number.
*/
Revision: __long;
}
export type ConfigurationState = "ACTIVE"|"DELETING"|"DELETE_FAILED"|string;
export interface CreateClusterRequest {
/**
*
Information about the broker nodes in the cluster.
*/
BrokerNodeGroupInfo: BrokerNodeGroupInfo;
/**
*
Includes all client authentication related information.
*/
ClientAuthentication?: ClientAuthentication;
/**
*
The name of the cluster.
*/
ClusterName: __stringMin1Max64;
/**
*
Represents the configuration that you want MSK to use for the brokers in a cluster.
*/
ConfigurationInfo?: ConfigurationInfo;
/**
*
Includes all encryption-related information.
*/
EncryptionInfo?: EncryptionInfo;
/**
*
Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER.
*/
EnhancedMonitoring?: EnhancedMonitoring;
/**
*
The settings for open monitoring.
*/
OpenMonitoring?: OpenMonitoringInfo;
/**
*
The version of Apache Kafka.
*/
KafkaVersion: __stringMin1Max128;
LoggingInfo?: LoggingInfo;
/**
*
The number of broker nodes in the cluster.
*/
NumberOfBrokerNodes: __integerMin1Max15;
/**
*
Create tags when creating the cluster.
*/
Tags?: __mapOf__string;
}
export interface CreateClusterResponse {
/**
*
The Amazon Resource Name (ARN) of the cluster.
*/
ClusterArn?: __string;
/**
*
The name of the MSK cluster.
*/
ClusterName?: __string;
/**
*
The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.
*/
State?: ClusterState;
}
export interface CreateConfigurationRequest {
/**
*
The description of the configuration.
*/
Description?: __string;
/**
*
The versions of Apache Kafka with which you can use this MSK configuration.
*/
KafkaVersions?: __listOf__string;
/**
*
The name of the configuration.
*/
Name: __string;
/**
*
Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded.
When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.
*/
ServerProperties: __blob;
}
export interface CreateConfigurationResponse {
/**
*
The Amazon Resource Name (ARN) of the configuration.
*/
Arn?: __string;
/**
*
The time when the configuration was created.
*/
CreationTime?: __timestampIso8601;
/**
*
Latest revision of the configuration.
*/
LatestRevision?: ConfigurationRevision;
/**
*
The name of the configuration.
*/
Name?: __string;
/**
*
The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
*/
State?: ConfigurationState;
}
export interface DeleteClusterRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
*/
ClusterArn: __string;
/**
*
The current version of the MSK cluster.
*/
CurrentVersion?: __string;
}
export interface DeleteClusterResponse {
/**
*
The Amazon Resource Name (ARN) of the cluster.
*/
ClusterArn?: __string;
/**
*
The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.
*/
State?: ClusterState;
}
export interface DeleteConfigurationRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.
*/
Arn: __string;
}
export interface DeleteConfigurationResponse {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.
*/
Arn?: __string;
/**
*
The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
*/
State?: ConfigurationState;
}
export interface DescribeClusterOperationRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies the MSK cluster operation.
*/
ClusterOperationArn: __string;
}
export interface DescribeClusterOperationResponse {
/**
*
Cluster operation information
*/
ClusterOperationInfo?: ClusterOperationInfo;
}
export interface DescribeClusterRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
*/
ClusterArn: __string;
}
export interface DescribeClusterResponse {
/**
*
The cluster information.
*/
ClusterInfo?: ClusterInfo;
}
export interface DescribeConfigurationRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
*/
Arn: __string;
}
export interface DescribeConfigurationResponse {
/**
*
The Amazon Resource Name (ARN) of the configuration.
*/
Arn?: __string;
/**
*
The time when the configuration was created.
*/
CreationTime?: __timestampIso8601;
/**
*
The description of the configuration.
*/
Description?: __string;
/**
*
The versions of Apache Kafka with which you can use this MSK configuration.
*/
KafkaVersions?: __listOf__string;
/**
*
Latest revision of the configuration.
*/
LatestRevision?: ConfigurationRevision;
/**
*
The name of the configuration.
*/
Name?: __string;
/**
*
The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
*/
State?: ConfigurationState;
}
export interface DescribeConfigurationRevisionRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
*/
Arn: __string;
/**
*
A string that uniquely identifies a revision of an MSK configuration.
*/
Revision: __long;
}
export interface DescribeConfigurationRevisionResponse {
/**
*
The Amazon Resource Name (ARN) of the configuration.
*/
Arn?: __string;
/**
*
The time when the configuration was created.
*/
CreationTime?: __timestampIso8601;
/**
*
The description of the configuration.
*/
Description?: __string;
/**
*
The revision number.
*/
Revision?: __long;
/**
*
Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded.
When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.
*/
ServerProperties?: __blob;
}
export interface BatchDisassociateScramSecretRequest {
/**
*
The Amazon Resource Name (ARN) of the cluster to be updated.
*/
ClusterArn: __string;
/**
*
List of AWS Secrets Manager secret ARNs.
*/
SecretArnList: __listOf__string;
}
export interface BatchDisassociateScramSecretResponse {
/**
*
The Amazon Resource Name (ARN) of the cluster.
*/
ClusterArn?: __string;
/**
*
List of errors when disassociating secrets to cluster.
*/
UnprocessedScramSecrets?: __listOfUnprocessedScramSecret;
}
export interface EBSStorageInfo {
/**
*
The size in GiB of the EBS volume for the data drive on each broker node.
*/
VolumeSize?: __integerMin1Max16384;
}
export interface EncryptionAtRest {
/**
*
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.
*/
DataVolumeKMSKeyId: __string;
}
export interface EncryptionInTransit {
/**
*
Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
TLS means that client-broker communication is enabled with TLS only.
TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
PLAINTEXT means that client-broker communication is enabled in plaintext only.
The default value is TLS_PLAINTEXT.
*/
ClientBroker?: ClientBroker;
/**
*
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.
The default value is true.
*/
InCluster?: __boolean;
}
export interface EncryptionInfo {
/**
*
The data-volume encryption details.
*/
EncryptionAtRest?: EncryptionAtRest;
/**
*
The details for encryption in transit.
*/
EncryptionInTransit?: EncryptionInTransit;
}
export type EnhancedMonitoring = "DEFAULT"|"PER_BROKER"|"PER_TOPIC_PER_BROKER"|string;
export interface ErrorInfo {
/**
*
A number describing the error programmatically.
*/
ErrorCode?: __string;
/**
*
An optional field to provide more details about the error.
*/
ErrorString?: __string;
}
export interface Firehose {
DeliveryStream?: __string;
Enabled: __boolean;
}
export interface GetBootstrapBrokersRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
*/
ClusterArn: __string;
}
export interface GetBootstrapBrokersResponse {
/**
*
A string containing one or more hostname:port pairs.
*/
BootstrapBrokerString?: __string;
/**
*
A string containing one or more DNS names (or IP) and TLS port pairs.
*/
BootstrapBrokerStringTls?: __string;
/**
*
A string containing one or more DNS names (or IP) and Sasl Scram port pairs.
*/
BootstrapBrokerStringSaslScram?: __string;
}
export interface GetCompatibleKafkaVersionsRequest {
/**
*
The Amazon Resource Name (ARN) of the cluster check.
*/
ClusterArn?: __string;
}
export interface GetCompatibleKafkaVersionsResponse {
/**
*
A list of CompatibleKafkaVersion objects.
*/
CompatibleKafkaVersions?: __listOfCompatibleKafkaVersion;
}
export interface KafkaVersion {
Version?: __string;
Status?: KafkaVersionStatus;
}
export type KafkaVersionStatus = "ACTIVE"|"DEPRECATED"|string;
export interface ListClusterOperationsRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
*/
ClusterArn: __string;
/**
*
The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
*/
MaxResults?: MaxResults;
/**
*
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.
*/
NextToken?: __string;
}
export interface ListClusterOperationsResponse {
/**
*
An array of cluster operation information objects.
*/
ClusterOperationInfoList?: __listOfClusterOperationInfo;
/**
*
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.
*/
NextToken?: __string;
}
export interface ListClustersRequest {
/**
*
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.
*/
ClusterNameFilter?: __string;
/**
*
The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
*/
MaxResults?: MaxResults;
/**
*
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.
*/
NextToken?: __string;
}
export interface ListClustersResponse {
/**
*
Information on each of the MSK clusters in the response.
*/
ClusterInfoList?: __listOfClusterInfo;
/**
*
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.
*/
NextToken?: __string;
}
export interface ListConfigurationRevisionsRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
*/
Arn: __string;
/**
*
The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
*/
MaxResults?: MaxResults;
/**
*
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.
*/
NextToken?: __string;
}
export interface ListConfigurationRevisionsResponse {
/**
*
Paginated results marker.
*/
NextToken?: __string;
/**
*
List of ConfigurationRevision objects.
*/
Revisions?: __listOfConfigurationRevision;
}
export interface ListConfigurationsRequest {
/**
*
The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
*/
MaxResults?: MaxResults;
/**
*
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.
*/
NextToken?: __string;
}
export interface ListConfigurationsResponse {
/**
*
An array of MSK configurations.
*/
Configurations?: __listOfConfiguration;
/**
*
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.
*/
NextToken?: __string;
}
export interface ListKafkaVersionsRequest {
/**
*
The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
*/
MaxResults?: MaxResults;
/**
*
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.
*/
NextToken?: __string;
}
export interface ListKafkaVersionsResponse {
KafkaVersions?: __listOfKafkaVersion;
NextToken?: __string;
}
export interface ListNodesRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
*/
ClusterArn: __string;
/**
*
The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
*/
MaxResults?: MaxResults;
/**
*
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.
*/
NextToken?: __string;
}
export interface ListNodesResponse {
/**
*
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.
*/
NextToken?: __string;
/**
*
List containing a NodeInfo object.
*/
NodeInfoList?: __listOfNodeInfo;
}
export interface ListScramSecretsRequest {
/**
*
The arn of the cluster.
*/
ClusterArn: __string;
/**
*
The maxResults of the query.
*/
MaxResults?: MaxResults;
/**
*
The nextToken of the query.
*/
NextToken?: __string;
}
export interface ListScramSecretsResponse {
/**
*
Paginated results marker.
*/
NextToken?: __string;
/**
*
The list of scram secrets associated with the cluster.
*/
SecretArnList?: __listOf__string;
}
export interface ListTagsForResourceRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.
*/
ResourceArn: __string;
}
export interface ListTagsForResourceResponse {
/**
*
The key-value pair for the resource tag.
*/
Tags?: __mapOf__string;
}
export type MaxResults = number;
export interface LoggingInfo {
BrokerLogs: BrokerLogs;
}
export interface MutableClusterInfo {
/**
*
Specifies the size of the EBS volume and the ID of the associated broker.
*/
BrokerEBSVolumeInfo?: __listOfBrokerEBSVolumeInfo;
/**
*
Information about the changes in the configuration of the brokers.
*/
ConfigurationInfo?: ConfigurationInfo;
/**
*
The number of broker nodes in the cluster.
*/
NumberOfBrokerNodes?: __integer;
/**
*
Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
*/
EnhancedMonitoring?: EnhancedMonitoring;
/**
*
The settings for open monitoring.
*/
OpenMonitoring?: OpenMonitoring;
/**
*
The Kafka version.
*/
KafkaVersion?: __string;
LoggingInfo?: LoggingInfo;
}
export interface NodeExporter {
/**
*
Indicates whether you want to enable or disable the Node Exporter.
*/
EnabledInBroker: __boolean;
}
export interface NodeExporterInfo {
/**
*
Indicates whether you want to enable or disable the Node Exporter.
*/
EnabledInBroker: __boolean;
}
export interface JmxExporter {
/**
*
Indicates whether you want to enable or disable the JMX Exporter.
*/
EnabledInBroker: __boolean;
}
export interface JmxExporterInfo {
/**
*
Indicates whether you want to enable or disable the JMX Exporter.
*/
EnabledInBroker: __boolean;
}
export interface OpenMonitoring {
/**
*
Prometheus settings.
*/
Prometheus: Prometheus;
}
export interface OpenMonitoringInfo {
/**
*
Prometheus settings.
*/
Prometheus: PrometheusInfo;
}
export interface Prometheus {
/**
*
Indicates whether you want to enable or disable the JMX Exporter.
*/
JmxExporter?: JmxExporter;
/**
*
Indicates whether you want to enable or disable the Node Exporter.
*/
NodeExporter?: NodeExporter;
}
export interface PrometheusInfo {
/**
*
Indicates whether you want to enable or disable the JMX Exporter.
*/
JmxExporter?: JmxExporterInfo;
/**
*
Indicates whether you want to enable or disable the Node Exporter.
*/
NodeExporter?: NodeExporterInfo;
}
export interface RebootBrokerRequest {
/**
*
The list of broker IDs to be rebooted. The reboot-broker operation supports rebooting one broker at a time.
*/
BrokerIds: __listOf__string;
/**
*
The Amazon Resource Name (ARN) of the cluster to be updated.
*/
ClusterArn: __string;
}
export interface RebootBrokerResponse {
/**
*
The Amazon Resource Name (ARN) of the cluster.
*/
ClusterArn?: __string;
/**
*
The Amazon Resource Name (ARN) of the cluster operation.
*/
ClusterOperationArn?: __string;
}
export interface S3 {
Bucket?: __string;
Enabled: __boolean;
Prefix?: __string;
}
export interface Sasl {
/**
*
Details for SASL/SCRAM client authentication.
*/
Scram?: Scram;
}
export interface Scram {
/**
*
SASL/SCRAM authentication is enabled or not.
*/
Enabled?: __boolean;
}
export interface NodeInfo {
/**
*
The start time.
*/
AddedToClusterTime?: __string;
/**
*
The broker node info.
*/
BrokerNodeInfo?: BrokerNodeInfo;
/**
*
The instance type.
*/
InstanceType?: __string;
/**
*
The Amazon Resource Name (ARN) of the node.
*/
NodeARN?: __string;
/**
*
The node type.
*/
NodeType?: NodeType;
/**
*
The ZookeeperNodeInfo.
*/
ZookeeperNodeInfo?: ZookeeperNodeInfo;
}
export type NodeType = "BROKER"|string;
export interface StateInfo {
Code?: __string;
Message?: __string;
}
export interface StorageInfo {
/**
*
EBS volume information.
*/
EbsStorageInfo?: EBSStorageInfo;
}
export interface TagResourceRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.
*/
ResourceArn: __string;
/**
*
The key-value pair for the resource tag.
*/
Tags: __mapOf__string;
}
export interface Tls {
/**
*
List of ACM Certificate Authority ARNs.
*/
CertificateAuthorityArnList?: __listOf__string;
}
export interface UnprocessedScramSecret {
/**
*
Error code for associate/disassociate failure.
*/
ErrorCode?: __string;
/**
*
Error message for associate/disassociate failure.
*/
ErrorMessage?: __string;
/**
*
AWS Secrets Manager secret ARN.
*/
SecretArn?: __string;
}
export interface UntagResourceRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.
*/
ResourceArn: __string;
/**
*
Tag keys must be unique for a given cluster. In addition, the following restrictions apply:
Each tag key must be unique. If you add a tag with a key that's already in
use, your new tag overwrites the existing key-value pair.
You can't start a tag key with aws: because this prefix is reserved for use
by AWS. AWS creates tags that begin with this prefix on your behalf, but
you can't edit or delete them.
Tag keys must be between 1 and 128 Unicode characters in length.
Tag keys must consist of the following characters: Unicode letters, digits,
white space, and the following special characters: _ . / = + -
@.
*/
TagKeys: __listOf__string;
}
export interface UpdateBrokerCountRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
*/
ClusterArn: __string;
/**
*
The version of cluster to update from. A successful operation will then generate a new version.
*/
CurrentVersion: __string;
/**
*
The number of broker nodes that you want the cluster to have after this operation completes successfully.
*/
TargetNumberOfBrokerNodes: __integerMin1Max15;
}
export interface UpdateBrokerCountResponse {
/**
*
The Amazon Resource Name (ARN) of the cluster.
*/
ClusterArn?: __string;
/**
*
The Amazon Resource Name (ARN) of the cluster operation.
*/
ClusterOperationArn?: __string;
}
export interface UpdateBrokerStorageRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
*/
ClusterArn: __string;
/**
*
The version of cluster to update from. A successful operation will then generate a new version.
*/
CurrentVersion: __string;
/**
*
Describes the target volume size and the ID of the broker to apply the update to.
*/
TargetBrokerEBSVolumeInfo: __listOfBrokerEBSVolumeInfo;
}
export interface UpdateBrokerStorageResponse {
/**
*
The Amazon Resource Name (ARN) of the cluster.
*/
ClusterArn?: __string;
/**
*
The Amazon Resource Name (ARN) of the cluster operation.
*/
ClusterOperationArn?: __string;
}
export interface UpdateClusterConfigurationRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
*/
ClusterArn: __string;
/**
*
Represents the configuration that you want MSK to use for the brokers in a cluster.
*/
ConfigurationInfo: ConfigurationInfo;
/**
*
The version of the cluster that needs to be updated.
*/
CurrentVersion: __string;
}
export interface UpdateClusterConfigurationResponse {
/**
*
The Amazon Resource Name (ARN) of the cluster.
*/
ClusterArn?: __string;
/**
*
The Amazon Resource Name (ARN) of the cluster operation.
*/
ClusterOperationArn?: __string;
}
export interface UpdateClusterKafkaVersionRequest {
/**
*
The Amazon Resource Name (ARN) of the cluster to be updated.
*/
ClusterArn: __string;
/**
*
The custom configuration that should be applied on the new version of cluster.
*/
ConfigurationInfo?: ConfigurationInfo;
/**
*
Current cluster version.
*/
CurrentVersion: __string;
/**
*
Target Kafka version.
*/
TargetKafkaVersion: __string;
}
export interface UpdateClusterKafkaVersionResponse {
/**
*
The Amazon Resource Name (ARN) of the cluster.
*/
ClusterArn?: __string;
/**
*
The Amazon Resource Name (ARN) of the cluster operation.
*/
ClusterOperationArn?: __string;
}
export interface UpdateMonitoringRequest {
/**
*
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
*/
ClusterArn: __string;
/**
*
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.
*/
CurrentVersion: __string;
/**
*
Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
*/
EnhancedMonitoring?: EnhancedMonitoring;
/**
*
The settings for open monitoring.
*/
OpenMonitoring?: OpenMonitoringInfo;
LoggingInfo?: LoggingInfo;
}
export interface UpdateMonitoringResponse {
/**
*
The Amazon Resource Name (ARN) of the cluster.
*/
ClusterArn?: __string;
/**
*
The Amazon Resource Name (ARN) of the cluster operation.
*/
ClusterOperationArn?: __string;
}
export interface UpdateConfigurationRequest {
/**
*
The Amazon Resource Name (ARN) of the configuration.
*/
Arn: __string;
/**
*
The description of the configuration revision.
*/
Description?: __string;
/**
*
Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded.
When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.
*/
ServerProperties: __blob;
}
export interface UpdateConfigurationResponse {
/**
*
The Amazon Resource Name (ARN) of the configuration.
*/
Arn?: __string;
/**
*
Latest revision of the configuration.
*/
LatestRevision?: ConfigurationRevision;
}
export interface ZookeeperNodeInfo {
/**
*
The attached elastic network interface of the broker.
*/
AttachedENIId?: __string;
/**
*
The virtual private cloud (VPC) IP address of the client.
*/
ClientVpcIpAddress?: __string;
/**
*
Endpoints for accessing the ZooKeeper.
*/
Endpoints?: __listOf__string;
/**
*
The role-specific ID for Zookeeper.
*/
ZookeeperId?: __double;
/**
*
The version of Zookeeper.
*/
ZookeeperVersion?: __string;
}
export type __boolean = boolean;
export type __blob = Buffer|Uint8Array|Blob|string;
export type __double = number;
export type __integer = number;
export type __integerMin1Max15 = number;
export type __integerMin1Max16384 = number;
export type __listOfBrokerEBSVolumeInfo = BrokerEBSVolumeInfo[];
export type __listOfClusterInfo = ClusterInfo[];
export type __listOfClusterOperationInfo = ClusterOperationInfo[];
export type __listOfClusterOperationStep = ClusterOperationStep[];
export type __listOfCompatibleKafkaVersion = CompatibleKafkaVersion[];
export type __listOfConfiguration = Configuration[];
export type __listOfConfigurationRevision = ConfigurationRevision[];
export type __listOfKafkaVersion = KafkaVersion[];
export type __listOfNodeInfo = NodeInfo[];
export type __listOfUnprocessedScramSecret = UnprocessedScramSecret[];
export type __listOf__string = __string[];
export type __long = number;
export type __mapOf__string = {[key: string]: __string};
export type __string = string;
export type __stringMin1Max128 = string;
export type __stringMin1Max64 = string;
export type __stringMin5Max32 = string;
export type __timestampIso8601 = Date;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2018-11-14"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the Kafka client.
*/
export import Types = Kafka;
}
export = Kafka;