Expand description
<p>The operations for managing an Amazon MSK cluster.</p>
If you’re using the service, you’re probably looking for KafkaClient and Kafka.
Structs§
- BrokerEBS
Volume Info <p>Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.</p>- Broker
Logs - Broker
Node Group Info <p>Describes the setup to be used for Kafka broker nodes in the cluster.</p>- Broker
Node Info <p>BrokerNodeInfo</p>- Broker
Software Info <p>Information about the current software installed on the cluster.</p>- Client
Authentication <p>Includes all client authentication information.</p>- Cloud
Watch Logs - Cluster
Info <p>Returns information about a cluster.</p>- Cluster
Operation Info <p>Returns information about a cluster operation.</p>- Cluster
Operation Step <p>Step taken during a cluster operation.</p>- Cluster
Operation Step Info <p>State information about the operation step.</p>- Compatible
Kafka Version <p>Contains source Kafka versions and compatible target Kafka versions.</p>- Configuration
<p>Represents an MSK Configuration.</p>- Configuration
Info <p>Specifies the configuration to use for the brokers.</p>- Configuration
Revision <p>Describes a configuration revision.</p>- Create
Cluster Request - Create
Cluster Response - Create
Configuration Request - Create
Configuration Response - Delete
Cluster Request - Delete
Cluster Response - Describe
Cluster Operation Request - Describe
Cluster Operation Response - Describe
Cluster Request - Describe
Cluster Response - Describe
Configuration Request - Describe
Configuration Response - Describe
Configuration Revision Request - Describe
Configuration Revision Response - EBSStorage
Info <p>Contains information about the EBS storage volumes attached to Kafka broker nodes.</p>- Encryption
AtRest <p>The data-volume encryption details.</p>- Encryption
InTransit <p>The settings for encrypting data in transit.</p>- Encryption
Info <p>Includes encryption-related information, such as the AWS KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.</p>- Error
Info <p>Returns information about an error state of the cluster.</p>- Firehose
- GetBootstrap
Brokers Request - GetBootstrap
Brokers Response - GetCompatible
Kafka Versions Request - GetCompatible
Kafka Versions Response - JmxExporter
<p>Indicates whether you want to enable or disable the JMX Exporter.</p>- JmxExporter
Info <p>Indicates whether you want to enable or disable the JMX Exporter.</p>- Kafka
Client - A client for the Kafka API.
- Kafka
Version - List
Cluster Operations Request - List
Cluster Operations Response - List
Clusters Request - List
Clusters Response - List
Configuration Revisions Request - List
Configuration Revisions Response - List
Configurations Request - List
Configurations Response - List
Kafka Versions Request - List
Kafka Versions Response - List
Nodes Request - List
Nodes Response - List
Tags ForResource Request - List
Tags ForResource Response - Logging
Info - Mutable
Cluster Info <p>Information about cluster attributes that can be updated via update APIs.</p>- Node
Exporter <p>Indicates whether you want to enable or disable the Node Exporter.</p>- Node
Exporter Info <p>Indicates whether you want to enable or disable the Node Exporter.</p>- Node
Info <p>The node information object.</p>- Open
Monitoring <p>JMX and Node monitoring for the MSK cluster.</p>- Open
Monitoring Info <p>JMX and Node monitoring for the MSK cluster.</p>- Prometheus
<p>Prometheus settings.</p>- Prometheus
Info <p>Prometheus settings.</p>- S3
- State
Info - Storage
Info <p>Contains information about storage volumes attached to MSK broker nodes.</p>- TagResource
Request - Tls
<p>Details for client authentication using TLS.</p>- Untag
Resource Request - Update
Broker Count Request - Update
Broker Count Response - Update
Broker Storage Request - Update
Broker Storage Response - Update
Cluster Configuration Request - Update
Cluster Configuration Response - Update
Cluster Kafka Version Request - Update
Cluster Kafka Version Response - Update
Monitoring Request Request body for UpdateMonitoring.
- Update
Monitoring Response - Zookeeper
Node Info <p>Zookeeper node information.</p>
Enums§
- Create
Cluster Error - Errors returned by CreateCluster
- Create
Configuration Error - Errors returned by CreateConfiguration
- Delete
Cluster Error - Errors returned by DeleteCluster
- Describe
Cluster Error - Errors returned by DescribeCluster
- Describe
Cluster Operation Error - Errors returned by DescribeClusterOperation
- Describe
Configuration Error - Errors returned by DescribeConfiguration
- Describe
Configuration Revision Error - Errors returned by DescribeConfigurationRevision
- GetBootstrap
Brokers Error - Errors returned by GetBootstrapBrokers
- GetCompatible
Kafka Versions Error - Errors returned by GetCompatibleKafkaVersions
- List
Cluster Operations Error - Errors returned by ListClusterOperations
- List
Clusters Error - Errors returned by ListClusters
- List
Configuration Revisions Error - Errors returned by ListConfigurationRevisions
- List
Configurations Error - Errors returned by ListConfigurations
- List
Kafka Versions Error - Errors returned by ListKafkaVersions
- List
Nodes Error - Errors returned by ListNodes
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Broker Count Error - Errors returned by UpdateBrokerCount
- Update
Broker Storage Error - Errors returned by UpdateBrokerStorage
- Update
Cluster Configuration Error - Errors returned by UpdateClusterConfiguration
- Update
Cluster Kafka Version Error - Errors returned by UpdateClusterKafkaVersion
- Update
Monitoring Error - Errors returned by UpdateMonitoring
Traits§
- Kafka
- Trait representing the capabilities of the Kafka API. Kafka clients implement this trait.