File: types.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.24.1-2~bpo12%2B1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-backports
  • size: 554,032 kB
  • sloc: java: 15,941; makefile: 419; sh: 175
file content (1519 lines) | stat: -rw-r--r-- 37,383 bytes parent folder | download
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
// Code generated by smithy-go-codegen DO NOT EDIT.

package types

import (
	smithydocument "github.com/aws/smithy-go/document"
	"time"
)

// Details of an Amazon MSK Cluster.
type AmazonMskCluster struct {

	// The Amazon Resource Name (ARN) of an Amazon MSK cluster.
	//
	// This member is required.
	MskClusterArn *string

	noSmithyDocumentSerde
}

// 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.
type BrokerEBSVolumeInfo struct {

	// The ID of the broker to update.
	//
	// This member is required.
	KafkaBrokerNodeId *string

	// EBS volume provisioned throughput information.
	ProvisionedThroughput *ProvisionedThroughput

	// Size of the EBS volume to update.
	VolumeSizeGB *int32

	noSmithyDocumentSerde
}

type BrokerLogs struct {
	CloudWatchLogs *CloudWatchLogs

	Firehose *Firehose

	S3 *S3

	noSmithyDocumentSerde
}

// Describes the setup to be used for Apache Kafka broker nodes in the cluster.
type BrokerNodeGroupInfo struct {

	// The list of subnets to connect to in the client virtual private cloud (VPC).
	// AWS creates elastic network interfaces inside these subnets. Client applications
	// use elastic network interfaces to produce and consume data. Client subnets can't
	// occupy the Availability Zone with ID use use1-az3.
	//
	// This member is required.
	ClientSubnets []string

	// The type of Amazon EC2 instances to use for Apache Kafka brokers. The following
	// instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge,
	// kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.
	//
	// This member is required.
	InstanceType *string

	// 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

	// Information about the broker access configuration.
	ConnectivityInfo *ConnectivityInfo

	// 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 []string

	// Contains information about storage volumes attached to MSK broker nodes.
	StorageInfo *StorageInfo

	// The list of zoneIds for the cluster in the virtual private cloud (VPC).
	ZoneIds []string

	noSmithyDocumentSerde
}

// BrokerNodeInfo
type BrokerNodeInfo struct {

	// The attached elastic network interface of the broker.
	AttachedENIId *string

	// The ID of the broker.
	BrokerId *float64

	// 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 Apache
	// Kafka brokers in the cluster.
	CurrentBrokerSoftwareInfo *BrokerSoftwareInfo

	// Endpoints for accessing the broker.
	Endpoints []string

	noSmithyDocumentSerde
}

// Information about the current software installed on the cluster.
type BrokerSoftwareInfo struct {

	// 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 *int64

	// The version of Apache Kafka.
	KafkaVersion *string

	noSmithyDocumentSerde
}

// Includes all client authentication information.
type ClientAuthentication struct {

	// Details for ClientAuthentication using SASL.
	Sasl *Sasl

	// Details for ClientAuthentication using TLS.
	Tls *Tls

	// Contains information about unauthenticated traffic to the cluster.
	Unauthenticated *Unauthenticated

	noSmithyDocumentSerde
}

// The client VPC connection object.
type ClientVpcConnection struct {

	// The ARN that identifies the Vpc Connection.
	//
	// This member is required.
	VpcConnectionArn *string

	// Information about the auth scheme of Vpc Connection.
	Authentication *string

	// Creation time of the Vpc Connection.
	CreationTime *time.Time

	// The Owner of the Vpc Connection.
	Owner *string

	// State of the Vpc Connection.
	State VpcConnectionState

	noSmithyDocumentSerde
}

type CloudWatchLogs struct {

	// This member is required.
	Enabled *bool

	LogGroup *string

	noSmithyDocumentSerde
}

// Returns information about a cluster.
type Cluster struct {

	// The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.
	ActiveOperationArn *string

	// The Amazon Resource Name (ARN) that uniquely identifies the cluster.
	ClusterArn *string

	// The name of the cluster.
	ClusterName *string

	// Cluster Type.
	ClusterType ClusterType

	// The time when the cluster was created.
	CreationTime *time.Time

	// The current version of the MSK cluster.
	CurrentVersion *string

	// Information about the provisioned cluster.
	Provisioned *Provisioned

	// Information about the serverless cluster.
	Serverless *Serverless

	// The state of the cluster. The possible states are ACTIVE, CREATING, DELETING,
	// FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
	State ClusterState

	// State Info for the Amazon MSK cluster.
	StateInfo *StateInfo

	// Tags attached to the cluster.
	Tags map[string]string

	noSmithyDocumentSerde
}

// Returns information about a cluster.
type ClusterInfo struct {

	// 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 *time.Time

	// Information about the version of software currently deployed on the Apache
	// Kafka brokers in the cluster.
	CurrentBrokerSoftwareInfo *BrokerSoftwareInfo

	// The current version of the MSK cluster.
	CurrentVersion *string

	// Determines if there is an action required from the customer.
	CustomerActionStatus CustomerActionStatus

	// Includes all encryption-related information.
	EncryptionInfo *EncryptionInfo

	// 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 Monitoring (https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html)
	// .
	EnhancedMonitoring EnhancedMonitoring

	LoggingInfo *LoggingInfo

	// The number of broker nodes in the cluster.
	NumberOfBrokerNodes *int32

	// Settings for open monitoring using Prometheus.
	OpenMonitoring *OpenMonitoring

	// The state of the cluster. The possible states are ACTIVE, CREATING, DELETING,
	// FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
	State ClusterState

	StateInfo *StateInfo

	// This controls storage mode for supported storage tiers.
	StorageMode StorageMode

	// Tags attached to the cluster.
	Tags map[string]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

	noSmithyDocumentSerde
}

// Returns information about a cluster operation.
type ClusterOperationInfo struct {

	// 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 *time.Time

	// The time at which the operation finished.
	EndTime *time.Time

	// 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 []ClusterOperationStep

	// 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

	// Description of the VPC connection for CreateVpcConnection and
	// DeleteVpcConnection operations.
	VpcConnectionInfo *VpcConnectionInfo

	noSmithyDocumentSerde
}

// Step taken during a cluster operation.
type ClusterOperationStep struct {

	// Information about the step and its status.
	StepInfo *ClusterOperationStepInfo

	// The name of the step.
	StepName *string

	noSmithyDocumentSerde
}

// State information about the operation step.
type ClusterOperationStepInfo struct {

	// The steps current status.
	StepStatus *string

	noSmithyDocumentSerde
}

// Returns information about a cluster operation.
type ClusterOperationV2 struct {

	// ARN of the cluster.
	ClusterArn *string

	// Type of the backend cluster.
	ClusterType ClusterType

	// The time at which the operation finished.
	EndTime *time.Time

	// If cluster operation failed from an error, it describes the error.
	ErrorInfo *ErrorInfo

	// ARN of the cluster operation.
	OperationArn *string

	// State of the cluster operation.
	OperationState *string

	// Type of the cluster operation.
	OperationType *string

	// Properties of a provisioned cluster.
	Provisioned *ClusterOperationV2Provisioned

	// Properties of a serverless cluster.
	Serverless *ClusterOperationV2Serverless

	// The time at which operation was started.
	StartTime *time.Time

	noSmithyDocumentSerde
}

// Returns information about a provisioned cluster operation.
type ClusterOperationV2Provisioned struct {

	// Steps completed during the operation.
	OperationSteps []ClusterOperationStep

	// Information about cluster attributes before a cluster is updated.
	SourceClusterInfo *MutableClusterInfo

	// Information about cluster attributes after a cluster is updated.
	TargetClusterInfo *MutableClusterInfo

	// Description of the VPC connection for CreateVpcConnection and
	// DeleteVpcConnection operations.
	VpcConnectionInfo *VpcConnectionInfo

	noSmithyDocumentSerde
}

// Returns information about a serverless cluster operation.
type ClusterOperationV2Serverless struct {

	// Description of the VPC connection for CreateVpcConnection and
	// DeleteVpcConnection operations.
	VpcConnectionInfo *VpcConnectionInfoServerless

	noSmithyDocumentSerde
}

// Returns information about a cluster operation.
type ClusterOperationV2Summary struct {

	// ARN of the cluster.
	ClusterArn *string

	// Type of the backend cluster.
	ClusterType ClusterType

	// The time at which the operation finished.
	EndTime *time.Time

	// ARN of the cluster operation.
	OperationArn *string

	// State of the cluster operation.
	OperationState *string

	// Type of the cluster operation.
	OperationType *string

	// The time at which operation was started.
	StartTime *time.Time

	noSmithyDocumentSerde
}

// Contains source Apache Kafka versions and compatible target Apache Kafka
// versions.
type CompatibleKafkaVersion struct {

	// An Apache Kafka version.
	SourceVersion *string

	// A list of Apache Kafka versions.
	TargetVersions []string

	noSmithyDocumentSerde
}

// Represents an MSK Configuration.
type Configuration struct {

	// The Amazon Resource Name (ARN) of the configuration.
	//
	// This member is required.
	Arn *string

	// The time when the configuration was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The description of the configuration.
	//
	// This member is required.
	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.
	//
	// This member is required.
	KafkaVersions []string

	// Latest revision of the configuration.
	//
	// This member is required.
	LatestRevision *ConfigurationRevision

	// The name of the configuration.
	//
	// This member is required.
	Name *string

	// The state of the configuration. The possible states are ACTIVE, DELETING, and
	// DELETE_FAILED.
	//
	// This member is required.
	State ConfigurationState

	noSmithyDocumentSerde
}

// Specifies the configuration to use for the brokers.
type ConfigurationInfo struct {

	// ARN of the configuration to use.
	//
	// This member is required.
	Arn *string

	// The revision of the configuration to use.
	//
	// This member is required.
	Revision *int64

	noSmithyDocumentSerde
}

// Describes a configuration revision.
type ConfigurationRevision struct {

	// The time when the configuration revision was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The revision number.
	//
	// This member is required.
	Revision *int64

	// The description of the configuration revision.
	Description *string

	noSmithyDocumentSerde
}

// Information about the broker access configuration.
type ConnectivityInfo struct {

	// Public access control for brokers.
	PublicAccess *PublicAccess

	// VPC connectivity access control for brokers.
	VpcConnectivity *VpcConnectivity

	noSmithyDocumentSerde
}

// Details about consumer group replication.
type ConsumerGroupReplication struct {

	// List of regular expression patterns indicating the consumer groups to copy.
	//
	// This member is required.
	ConsumerGroupsToReplicate []string

	// List of regular expression patterns indicating the consumer groups that should
	// not be replicated.
	ConsumerGroupsToExclude []string

	// Enables synchronization of consumer groups to target cluster.
	DetectAndCopyNewConsumerGroups *bool

	// Enables synchronization of consumer group offsets to target cluster. The
	// translated offsets will be written to topic __consumer_offsets.
	SynchroniseConsumerGroupOffsets *bool

	noSmithyDocumentSerde
}

// Details about consumer group replication.
type ConsumerGroupReplicationUpdate struct {

	// List of regular expression patterns indicating the consumer groups that should
	// not be replicated.
	//
	// This member is required.
	ConsumerGroupsToExclude []string

	// List of regular expression patterns indicating the consumer groups to copy.
	//
	// This member is required.
	ConsumerGroupsToReplicate []string

	// Enables synchronization of consumer groups to target cluster.
	//
	// This member is required.
	DetectAndCopyNewConsumerGroups *bool

	// Enables synchronization of consumer group offsets to target cluster. The
	// translated offsets will be written to topic __consumer_offsets.
	//
	// This member is required.
	SynchroniseConsumerGroupOffsets *bool

	noSmithyDocumentSerde
}

// Contains information about the EBS storage volumes attached to Apache Kafka
// broker nodes.
type EBSStorageInfo struct {

	// EBS volume provisioned throughput information.
	ProvisionedThroughput *ProvisionedThroughput

	// The size in GiB of the EBS volume for the data drive on each broker node.
	VolumeSize *int32

	noSmithyDocumentSerde
}

// The data-volume encryption details.
type EncryptionAtRest struct {

	// 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.
	//
	// This member is required.
	DataVolumeKMSKeyId *string

	noSmithyDocumentSerde
}

// 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.
type EncryptionInfo struct {

	// The data-volume encryption details.
	EncryptionAtRest *EncryptionAtRest

	// The details for encryption in transit.
	EncryptionInTransit *EncryptionInTransit

	noSmithyDocumentSerde
}

// The settings for encrypting data in transit.
type EncryptionInTransit struct {

	// 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 *bool

	noSmithyDocumentSerde
}

// Returns information about an error state of the cluster.
type ErrorInfo struct {

	// A number describing the error programmatically.
	ErrorCode *string

	// An optional field to provide more details about the error.
	ErrorString *string

	noSmithyDocumentSerde
}

type Firehose struct {

	// This member is required.
	Enabled *bool

	DeliveryStream *string

	noSmithyDocumentSerde
}

// Details for IAM access control.
type Iam struct {

	// Indicates whether IAM access control is enabled.
	Enabled *bool

	noSmithyDocumentSerde
}

// Indicates whether you want to turn on or turn off the JMX Exporter.
type JmxExporter struct {

	// Indicates whether you want to turn on or turn off the JMX Exporter.
	//
	// This member is required.
	EnabledInBroker *bool

	noSmithyDocumentSerde
}

// Indicates whether you want to turn on or turn off the JMX Exporter.
type JmxExporterInfo struct {

	// Indicates whether you want to turn on or turn off the JMX Exporter.
	//
	// This member is required.
	EnabledInBroker *bool

	noSmithyDocumentSerde
}

// Information about Kafka Cluster to be used as source / target for replication.
type KafkaCluster struct {

	// Details of an Amazon MSK Cluster.
	//
	// This member is required.
	AmazonMskCluster *AmazonMskCluster

	// Details of an Amazon VPC which has network connectivity to the Apache Kafka
	// cluster.
	//
	// This member is required.
	VpcConfig *KafkaClusterClientVpcConfig

	noSmithyDocumentSerde
}

// Details of an Amazon VPC which has network connectivity to the Apache Kafka
// cluster.
type KafkaClusterClientVpcConfig struct {

	// The list of subnets in the client VPC to connect to.
	//
	// This member is required.
	SubnetIds []string

	// The security groups to attach to the ENIs for the broker nodes.
	SecurityGroupIds []string

	noSmithyDocumentSerde
}

// Information about Kafka Cluster used as source / target for replication.
type KafkaClusterDescription struct {

	// Details of an Amazon MSK Cluster.
	AmazonMskCluster *AmazonMskCluster

	// The alias of the Kafka cluster. Used to prefix names of replicated topics.
	KafkaClusterAlias *string

	// Details of an Amazon VPC which has network connectivity to the Apache Kafka
	// cluster.
	VpcConfig *KafkaClusterClientVpcConfig

	noSmithyDocumentSerde
}

// Summarized information about Kafka Cluster used as source / target for
// replication.
type KafkaClusterSummary struct {

	// Details of an Amazon MSK Cluster.
	AmazonMskCluster *AmazonMskCluster

	// The alias of the Kafka cluster. Used to prefix names of replicated topics.
	KafkaClusterAlias *string

	noSmithyDocumentSerde
}

type KafkaVersion struct {
	Status KafkaVersionStatus

	Version *string

	noSmithyDocumentSerde
}

type LoggingInfo struct {

	// This member is required.
	BrokerLogs *BrokerLogs

	noSmithyDocumentSerde
}

// Information about cluster attributes that can be updated via update APIs.
type MutableClusterInfo struct {

	// Specifies the size of the EBS volume and the ID of the associated broker.
	BrokerEBSVolumeInfo []BrokerEBSVolumeInfo

	// Includes all client authentication information.
	ClientAuthentication *ClientAuthentication

	// Information about the changes in the configuration of the brokers.
	ConfigurationInfo *ConfigurationInfo

	// Information about the broker access configuration.
	ConnectivityInfo *ConnectivityInfo

	// Includes all encryption-related information.
	EncryptionInfo *EncryptionInfo

	// Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon
	// CloudWatch for this cluster.
	EnhancedMonitoring EnhancedMonitoring

	// Information about the Amazon MSK broker type.
	InstanceType *string

	// The Apache Kafka version.
	KafkaVersion *string

	// 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.
	LoggingInfo *LoggingInfo

	// The number of broker nodes in the cluster.
	NumberOfBrokerNodes *int32

	// The settings for open monitoring.
	OpenMonitoring *OpenMonitoring

	// This controls storage mode for supported storage tiers.
	StorageMode StorageMode

	noSmithyDocumentSerde
}

// Indicates whether you want to turn on or turn off the Node Exporter.
type NodeExporter struct {

	// Indicates whether you want to turn on or turn off the Node Exporter.
	//
	// This member is required.
	EnabledInBroker *bool

	noSmithyDocumentSerde
}

// Indicates whether you want to turn on or turn off the Node Exporter.
type NodeExporterInfo struct {

	// Indicates whether you want to turn on or turn off the Node Exporter.
	//
	// This member is required.
	EnabledInBroker *bool

	noSmithyDocumentSerde
}

// The node information object.
type NodeInfo struct {

	// 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

	noSmithyDocumentSerde
}

// JMX and Node monitoring for the MSK cluster.
type OpenMonitoring struct {

	// Prometheus settings.
	//
	// This member is required.
	Prometheus *Prometheus

	noSmithyDocumentSerde
}

// JMX and Node monitoring for the MSK cluster.
type OpenMonitoringInfo struct {

	// Prometheus settings.
	//
	// This member is required.
	Prometheus *PrometheusInfo

	noSmithyDocumentSerde
}

// Prometheus settings.
type Prometheus struct {

	// Indicates whether you want to turn on or turn off the JMX Exporter.
	JmxExporter *JmxExporter

	// Indicates whether you want to turn on or turn off the Node Exporter.
	NodeExporter *NodeExporter

	noSmithyDocumentSerde
}

// Prometheus settings.
type PrometheusInfo struct {

	// Indicates whether you want to turn on or turn off the JMX Exporter.
	JmxExporter *JmxExporterInfo

	// Indicates whether you want to turn on or turn off the Node Exporter.
	NodeExporter *NodeExporterInfo

	noSmithyDocumentSerde
}

// Provisioned cluster.
type Provisioned struct {

	// Information about the brokers.
	//
	// This member is required.
	BrokerNodeGroupInfo *BrokerNodeGroupInfo

	// The number of broker nodes in the cluster.
	//
	// This member is required.
	NumberOfBrokerNodes *int32

	// Includes all client authentication information.
	ClientAuthentication *ClientAuthentication

	// Information about the Apache Kafka version deployed on the brokers.
	CurrentBrokerSoftwareInfo *BrokerSoftwareInfo

	// Determines if there is an action required from the customer.
	CustomerActionStatus CustomerActionStatus

	// Includes all encryption-related information.
	EncryptionInfo *EncryptionInfo

	// 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.
	EnhancedMonitoring EnhancedMonitoring

	// Log delivery information for the cluster.
	LoggingInfo *LoggingInfo

	// The settings for open monitoring.
	OpenMonitoring *OpenMonitoringInfo

	// This controls storage mode for supported storage tiers.
	StorageMode StorageMode

	// The connection string to use to connect to the Apache ZooKeeper cluster.
	ZookeeperConnectString *string

	// The connection string to use to connect to the Apache ZooKeeper cluster on a
	// TLS port.
	ZookeeperConnectStringTls *string

	noSmithyDocumentSerde
}

// Provisioned cluster request.
type ProvisionedRequest struct {

	// Information about the brokers.
	//
	// This member is required.
	BrokerNodeGroupInfo *BrokerNodeGroupInfo

	// The Apache Kafka version that you want for the cluster.
	//
	// This member is required.
	KafkaVersion *string

	// The number of broker nodes in the cluster.
	//
	// This member is required.
	NumberOfBrokerNodes *int32

	// Includes all client authentication information.
	ClientAuthentication *ClientAuthentication

	// Represents the configuration that you want Amazon 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, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.
	EnhancedMonitoring EnhancedMonitoring

	// Log delivery information for the cluster.
	LoggingInfo *LoggingInfo

	// The settings for open monitoring.
	OpenMonitoring *OpenMonitoringInfo

	// This controls storage mode for supported storage tiers.
	StorageMode StorageMode

	noSmithyDocumentSerde
}

// Contains information about provisioned throughput for EBS storage volumes
// attached to kafka broker nodes.
type ProvisionedThroughput struct {

	// Provisioned throughput is enabled or not.
	Enabled *bool

	// Throughput value of the EBS volumes for the data drive on each kafka broker
	// node in MiB per second.
	VolumeThroughput *int32

	noSmithyDocumentSerde
}

// Public access control for brokers.
type PublicAccess struct {

	// The value DISABLED indicates that public access is turned off.
	// SERVICE_PROVIDED_EIPS indicates that public access is turned on.
	Type *string

	noSmithyDocumentSerde
}

// Specifies configuration for replication between a source and target Kafka
// cluster.
type ReplicationInfo struct {

	// Configuration relating to consumer group replication.
	//
	// This member is required.
	ConsumerGroupReplication *ConsumerGroupReplication

	// The ARN of the source Kafka cluster.
	//
	// This member is required.
	SourceKafkaClusterArn *string

	// The compression type to use when producing records to target cluster.
	//
	// This member is required.
	TargetCompressionType TargetCompressionType

	// The ARN of the target Kafka cluster.
	//
	// This member is required.
	TargetKafkaClusterArn *string

	// Configuration relating to topic replication.
	//
	// This member is required.
	TopicReplication *TopicReplication

	noSmithyDocumentSerde
}

// Specifies configuration for replication between a source and target Kafka
// cluster (sourceKafkaClusterAlias -> targetKafkaClusterAlias)
type ReplicationInfoDescription struct {

	// Configuration relating to consumer group replication.
	ConsumerGroupReplication *ConsumerGroupReplication

	// The alias of the source Kafka cluster.
	SourceKafkaClusterAlias *string

	// The compression type to use when producing records to target cluster.
	TargetCompressionType TargetCompressionType

	// The alias of the target Kafka cluster.
	TargetKafkaClusterAlias *string

	// Configuration relating to topic replication.
	TopicReplication *TopicReplication

	noSmithyDocumentSerde
}

// Summarized information of replication between clusters.
type ReplicationInfoSummary struct {

	// The alias of the source Kafka cluster.
	SourceKafkaClusterAlias *string

	// The alias of the target Kafka cluster.
	TargetKafkaClusterAlias *string

	noSmithyDocumentSerde
}

// Details about the state of a replicator
type ReplicationStateInfo struct {

	// Code that describes the current state of the replicator.
	Code *string

	// Message that describes the state of the replicator.
	Message *string

	noSmithyDocumentSerde
}

// Information about a replicator.
type ReplicatorSummary struct {

	// The time the replicator was created.
	CreationTime *time.Time

	// The current version of the replicator.
	CurrentVersion *string

	// Whether this resource is a replicator reference.
	IsReplicatorReference *bool

	// Kafka Clusters used in setting up sources / targets for replication.
	KafkaClustersSummary []KafkaClusterSummary

	// A list of summarized information of replications between clusters.
	ReplicationInfoSummaryList []ReplicationInfoSummary

	// The Amazon Resource Name (ARN) of the replicator.
	ReplicatorArn *string

	// The name of the replicator.
	ReplicatorName *string

	// The Amazon Resource Name (ARN) of the replicator resource in the region where
	// the replicator was created.
	ReplicatorResourceArn *string

	// State of the replicator.
	ReplicatorState ReplicatorState

	noSmithyDocumentSerde
}

type S3 struct {

	// This member is required.
	Enabled *bool

	Bucket *string

	Prefix *string

	noSmithyDocumentSerde
}

// Details for client authentication using SASL.
type Sasl struct {

	// Indicates whether IAM access control is enabled.
	Iam *Iam

	// Details for SASL/SCRAM client authentication.
	Scram *Scram

	noSmithyDocumentSerde
}

// Details for SASL/SCRAM client authentication.
type Scram struct {

	// SASL/SCRAM authentication is enabled or not.
	Enabled *bool

	noSmithyDocumentSerde
}

// Serverless cluster.
type Serverless struct {

	// The configuration of the Amazon VPCs for the cluster.
	//
	// This member is required.
	VpcConfigs []VpcConfig

	// Includes all client authentication information.
	ClientAuthentication *ServerlessClientAuthentication

	noSmithyDocumentSerde
}

// Includes all client authentication information.
type ServerlessClientAuthentication struct {

	// Details for ClientAuthentication using SASL.
	Sasl *ServerlessSasl

	noSmithyDocumentSerde
}

// Serverless cluster request.
type ServerlessRequest struct {

	// The configuration of the Amazon VPCs for the cluster.
	//
	// This member is required.
	VpcConfigs []VpcConfig

	// Includes all client authentication information.
	ClientAuthentication *ServerlessClientAuthentication

	noSmithyDocumentSerde
}

// Details for client authentication using SASL.
type ServerlessSasl struct {

	// Indicates whether IAM access control is enabled.
	Iam *Iam

	noSmithyDocumentSerde
}

type StateInfo struct {
	Code *string

	Message *string

	noSmithyDocumentSerde
}

// Contains information about storage volumes attached to MSK broker nodes.
type StorageInfo struct {

	// EBS volume information.
	EbsStorageInfo *EBSStorageInfo

	noSmithyDocumentSerde
}

// Details for client authentication using TLS.
type Tls struct {

	// List of ACM Certificate Authority ARNs.
	CertificateAuthorityArnList []string

	// Specifies whether you want to turn on or turn off TLS authentication.
	Enabled *bool

	noSmithyDocumentSerde
}

// Details about topic replication.
type TopicReplication struct {

	// List of regular expression patterns indicating the topics to copy.
	//
	// This member is required.
	TopicsToReplicate []string

	// Whether to periodically configure remote topic ACLs to match their
	// corresponding upstream topics.
	CopyAccessControlListsForTopics *bool

	// Whether to periodically configure remote topics to match their corresponding
	// upstream topics.
	CopyTopicConfigurations *bool

	// Whether to periodically check for new topics and partitions.
	DetectAndCopyNewTopics *bool

	// List of regular expression patterns indicating the topics that should not be
	// replicated.
	TopicsToExclude []string

	noSmithyDocumentSerde
}

// Details for updating the topic replication of a replicator.
type TopicReplicationUpdate struct {

	// Whether to periodically configure remote topic ACLs to match their
	// corresponding upstream topics.
	//
	// This member is required.
	CopyAccessControlListsForTopics *bool

	// Whether to periodically configure remote topics to match their corresponding
	// upstream topics.
	//
	// This member is required.
	CopyTopicConfigurations *bool

	// Whether to periodically check for new topics and partitions.
	//
	// This member is required.
	DetectAndCopyNewTopics *bool

	// List of regular expression patterns indicating the topics that should not be
	// replicated.
	//
	// This member is required.
	TopicsToExclude []string

	// List of regular expression patterns indicating the topics to copy.
	//
	// This member is required.
	TopicsToReplicate []string

	noSmithyDocumentSerde
}

type Unauthenticated struct {

	// Specifies whether you want to turn on or turn off unauthenticated traffic to
	// your cluster.
	Enabled *bool

	noSmithyDocumentSerde
}

// Error info for scram secret associate/disassociate failure.
type UnprocessedScramSecret struct {

	// Error code for associate/disassociate failure.
	ErrorCode *string

	// Error message for associate/disassociate failure.
	ErrorMessage *string

	// AWS Secrets Manager secret ARN.
	SecretArn *string

	noSmithyDocumentSerde
}

// Description of the requester that calls the API operation.
type UserIdentity struct {

	// A unique identifier for the requester that calls the API operation.
	PrincipalId *string

	// The identity type of the requester that calls the API operation.
	Type UserIdentityType

	noSmithyDocumentSerde
}

// The configuration of the Amazon VPCs for the cluster.
type VpcConfig struct {

	// The IDs of the subnets associated with the cluster.
	//
	// This member is required.
	SubnetIds []string

	// The IDs of the security groups associated with the cluster.
	SecurityGroupIds []string

	noSmithyDocumentSerde
}

// The VPC connection object.
type VpcConnection struct {

	// The ARN that identifies the Cluster which the Vpc Connection belongs to.
	//
	// This member is required.
	TargetClusterArn *string

	// The ARN that identifies the Vpc Connection.
	//
	// This member is required.
	VpcConnectionArn *string

	// Information about the auth scheme of Vpc Connection.
	Authentication *string

	// Creation time of the Vpc Connection.
	CreationTime *time.Time

	// State of the Vpc Connection.
	State VpcConnectionState

	// The vpcId that belongs to the Vpc Connection.
	VpcId *string

	noSmithyDocumentSerde
}

// Description of the VPC connection.
type VpcConnectionInfo struct {

	// The time when Amazon MSK creates the VPC Connnection.
	CreationTime *time.Time

	// The owner of the VPC Connection.
	Owner *string

	// Description of the requester that calls the API operation.
	UserIdentity *UserIdentity

	// The Amazon Resource Name (ARN) of the VPC connection.
	VpcConnectionArn *string

	noSmithyDocumentSerde
}

// Description of the VPC connection.
type VpcConnectionInfoServerless struct {

	// The time when Amazon MSK creates the VPC Connnection.
	CreationTime *time.Time

	// The owner of the VPC Connection.
	Owner *string

	// Description of the requester that calls the API operation.
	UserIdentity *UserIdentity

	// The Amazon Resource Name (ARN) of the VPC connection.
	VpcConnectionArn *string

	noSmithyDocumentSerde
}

// VPC connectivity access control for brokers.
type VpcConnectivity struct {

	// Includes all client authentication information for VPC connectivity.
	ClientAuthentication *VpcConnectivityClientAuthentication

	noSmithyDocumentSerde
}

// Includes all client authentication information for VPC connectivity.
type VpcConnectivityClientAuthentication struct {

	// SASL authentication type details for VPC connectivity.
	Sasl *VpcConnectivitySasl

	// TLS authentication type details for VPC connectivity.
	Tls *VpcConnectivityTls

	noSmithyDocumentSerde
}

// Details for IAM access control for VPC connectivity.
type VpcConnectivityIam struct {

	// SASL/IAM authentication is on or off for VPC connectivity.
	Enabled *bool

	noSmithyDocumentSerde
}

// Details for SASL client authentication for VPC connectivity.
type VpcConnectivitySasl struct {

	// Details for SASL/IAM client authentication for VPC connectivity.
	Iam *VpcConnectivityIam

	// Details for SASL/SCRAM client authentication for VPC connectivity.
	Scram *VpcConnectivityScram

	noSmithyDocumentSerde
}

// Details for SASL/SCRAM client authentication for VPC connectivity.
type VpcConnectivityScram struct {

	// SASL/SCRAM authentication is on or off for VPC connectivity.
	Enabled *bool

	noSmithyDocumentSerde
}

// Details for TLS client authentication for VPC connectivity.
type VpcConnectivityTls struct {

	// TLS authentication is on or off for VPC connectivity.
	Enabled *bool

	noSmithyDocumentSerde
}

// Zookeeper node information.
type ZookeeperNodeInfo struct {

	// 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 []string

	// The role-specific ID for Zookeeper.
	ZookeeperId *float64

	// The version of Zookeeper.
	ZookeeperVersion *string

	noSmithyDocumentSerde
}

type noSmithyDocumentSerde = smithydocument.NoSerde