Module types

Source

Expand description

Data structures used by operation inputs/outputs.

Modules§

builders: Builders
error: Error types that Managed Streaming for Kafka can respond with.

Structs§

AmazonMskCluster: Details of an Amazon MSK Cluster.
BrokerCountUpdateInfo: Information regarding UpdateBrokerCount.
BrokerEbsVolumeInfo: 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.
BrokerLogs
BrokerNodeGroupInfo: Describes the setup to be used for Apache Kafka broker nodes in the cluster.
BrokerNodeInfo: BrokerNodeInfo
BrokerSoftwareInfo: Information about the current software installed on the cluster.
ClientAuthentication: Includes all client authentication information.
ClientVpcConnection: The client VPC connection object.
CloudWatchLogs
Cluster: Returns information about a cluster.
ClusterInfo: Returns information about a cluster.
ClusterOperationInfo: Returns information about a cluster operation.
ClusterOperationStep: Step taken during a cluster operation.
ClusterOperationStepInfo: State information about the operation step.
ClusterOperationV2: Returns information about a cluster operation.
ClusterOperationV2Provisioned: Returns information about a provisioned cluster operation.
ClusterOperationV2Serverless: Returns information about a serverless cluster operation.
ClusterOperationV2Summary: Returns information about a cluster operation.
CompatibleKafkaVersion: Contains source Apache Kafka versions and compatible target Apache Kafka versions.
Configuration: Represents an MSK Configuration.
ConfigurationInfo: Specifies the configuration to use for the brokers.
ConfigurationRevision: Describes a configuration revision.
ConnectivityInfo: Information about the broker access configuration.
ConsumerGroupReplication: Details about consumer group replication.
ConsumerGroupReplicationUpdate: Details about consumer group replication.
ControllerNodeInfo: Controller node information.
EbsStorageInfo: Contains information about the EBS storage volumes attached to Apache Kafka broker nodes.
EncryptionAtRest: The data-volume encryption details.
EncryptionInTransit: The settings for encrypting data in transit.
EncryptionInfo: 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.
ErrorInfo: Returns information about an error state of the cluster.
Firehose
Iam: Details for IAM access control.
JmxExporter: Indicates whether you want to turn on or turn off the JMX Exporter.
JmxExporterInfo: Indicates whether you want to turn on or turn off the JMX Exporter.
KafkaCluster: Information about Kafka Cluster to be used as source / target for replication.
KafkaClusterClientVpcConfig: Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
KafkaClusterDescription: Information about Kafka Cluster used as source / target for replication.
KafkaClusterSummary: Summarized information about Kafka Cluster used as source / target for replication.
KafkaVersion
LoggingInfo
MutableClusterInfo: Information about cluster attributes that can be updated via update APIs.
NodeExporter: Indicates whether you want to turn on or turn off the Node Exporter.
NodeExporterInfo: Indicates whether you want to turn on or turn off the Node Exporter.
NodeInfo: The node information object.
OpenMonitoring: JMX and Node monitoring for the MSK cluster.
OpenMonitoringInfo: JMX and Node monitoring for the MSK cluster.
Prometheus: Prometheus settings.
PrometheusInfo: Prometheus settings.
Provisioned: Provisioned cluster.
ProvisionedRequest: Provisioned cluster request.
ProvisionedThroughput: Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.
PublicAccess: Public access control for brokers.
ReplicationInfo: Specifies configuration for replication between a source and target Kafka cluster.
ReplicationInfoDescription: Specifies configuration for replication between a source and target Kafka cluster (sourceKafkaClusterAlias -> targetKafkaClusterAlias)
ReplicationInfoSummary: Summarized information of replication between clusters.
ReplicationStartingPosition: Configuration for specifying the position in the topics to start replicating from.
ReplicationStateInfo: Details about the state of a replicator
ReplicationTopicNameConfiguration: Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias.
ReplicatorSummary: Information about a replicator.
S3
Sasl: Details for client authentication using SASL.
Scram: Details for SASL/SCRAM client authentication.
Serverless: Serverless cluster.
ServerlessClientAuthentication: Includes all client authentication information.
ServerlessRequest: Serverless cluster request.
ServerlessSasl: Details for client authentication using SASL.
StateInfo
StorageInfo: Contains information about storage volumes attached to MSK broker nodes.
Tls: Details for client authentication using TLS.
TopicReplication: Details about topic replication.
TopicReplicationUpdate: Details for updating the topic replication of a replicator.
Unauthenticated
UnprocessedScramSecret: Error info for scram secret associate/disassociate failure.
UserIdentity: Description of the requester that calls the API operation.
VpcConfig: The configuration of the Amazon VPCs for the cluster.
VpcConnection: The VPC connection object.
VpcConnectionInfo: Description of the VPC connection.
VpcConnectionInfoServerless: Description of the VPC connection.
VpcConnectivity: VPC connectivity access control for brokers.
VpcConnectivityClientAuthentication: Includes all client authentication information for VPC connectivity.
VpcConnectivityIam: Details for IAM access control for VPC connectivity.
VpcConnectivitySasl: Details for SASL client authentication for VPC connectivity.
VpcConnectivityScram: Details for SASL/SCRAM client authentication for VPC connectivity.
VpcConnectivityTls: Details for TLS client authentication for VPC connectivity.
ZookeeperNodeInfo: Zookeeper node information.

Enums§

BrokerAzDistribution: When writing a match expression against BrokerAzDistribution, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ClientBroker: When writing a match expression against ClientBroker, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ClusterState: When writing a match expression against ClusterState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ClusterType: When writing a match expression against ClusterType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ConfigurationState: When writing a match expression against ConfigurationState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CustomerActionStatus: When writing a match expression against CustomerActionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
EnhancedMonitoring: When writing a match expression against EnhancedMonitoring, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
KafkaVersionStatus: When writing a match expression against KafkaVersionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
NodeType: When writing a match expression against NodeType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ReplicationStartingPositionType: When writing a match expression against ReplicationStartingPositionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ReplicationTopicNameConfigurationType: When writing a match expression against ReplicationTopicNameConfigurationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ReplicatorState: When writing a match expression against ReplicatorState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
StorageMode: When writing a match expression against StorageMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TargetCompressionType: When writing a match expression against TargetCompressionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
UserIdentityType: When writing a match expression against UserIdentityType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
VpcConnectionState: When writing a match expression against VpcConnectionState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Module types

Module types Copy item path

Modules§

Structs§

Enums§

Module types