String invalidParameter
The parameter that caused the error.
CloudWatchLogs cloudWatchLogs
Firehose firehose
S3 s3
String brokerAZDistribution
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.
List<E> clientSubnets
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.
String instanceType
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.
List<E> securityGroups
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.
StorageInfo storageInfo
Contains information about storage volumes attached to MSK broker nodes.
String attachedENIId
The attached elastic network interface of the broker.
Double brokerId
The ID of the broker.
String clientSubnet
The client subnet to which this broker node belongs.
String clientVpcIpAddress
The virtual private cloud (VPC) of the client.
BrokerSoftwareInfo currentBrokerSoftwareInfo
Information about the version of software currently deployed on the Kafka brokers in the cluster.
List<E> endpoints
Endpoints for accessing the broker.
String configurationArn
The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.
Long configurationRevision
The revision of the configuration to use. This field isn't visible in this preview release.
String kafkaVersion
The version of Apache Kafka.
String activeOperationArn
Arn of active cluster operation.
BrokerNodeGroupInfo brokerNodeGroupInfo
Information about the broker nodes.
ClientAuthentication clientAuthentication
Includes all client authentication information.
String clusterArn
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
String clusterName
The name of the cluster.
Date creationTime
The time when the cluster was created.
BrokerSoftwareInfo currentBrokerSoftwareInfo
Information about the version of software currently deployed on the Kafka brokers in the cluster.
String currentVersion
The current version of the MSK cluster.
EncryptionInfo encryptionInfo
Includes all encryption-related information.
String enhancedMonitoring
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.
OpenMonitoring openMonitoring
Settings for open monitoring using Prometheus.
LoggingInfo loggingInfo
Integer numberOfBrokerNodes
The number of broker nodes in the cluster.
String state
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
StateInfo stateInfo
Map<K,V> tags
Tags attached to the cluster.
String zookeeperConnectString
The connection string to use to connect to the Apache ZooKeeper cluster.
String zookeeperConnectStringTls
The connection string to use to connect to zookeeper cluster on Tls port.
String clientRequestId
The ID of the API request that triggered this operation.
String clusterArn
ARN of the cluster.
Date creationTime
The time that the operation was created.
Date endTime
The time at which the operation finished.
ErrorInfo errorInfo
Describes the error if the operation fails.
String operationArn
ARN of the cluster operation.
String operationState
State of the cluster operation.
List<E> operationSteps
Steps completed during the operation.
String operationType
Type of the cluster operation.
MutableClusterInfo sourceClusterInfo
Information about cluster attributes before a cluster is updated.
MutableClusterInfo targetClusterInfo
Information about cluster attributes after a cluster is updated.
ClusterOperationStepInfo stepInfo
Information about the step and its status.
String stepName
The name of the step.
String stepStatus
The steps current status.
String arn
The Amazon Resource Name (ARN) of the configuration.
Date creationTime
The time when the configuration was created.
String description
The description of the configuration.
List<E> kafkaVersions
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.
ConfigurationRevision latestRevision
Latest revision of the configuration.
String name
The name of the configuration.
String state
The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
String invalidParameter
The parameter that caused the error.
BrokerNodeGroupInfo brokerNodeGroupInfo
Information about the broker nodes in the cluster.
ClientAuthentication clientAuthentication
Includes all client authentication related information.
String clusterName
The name of the cluster.
ConfigurationInfo configurationInfo
Represents the configuration that you want MSK to use for the brokers in a cluster.
EncryptionInfo encryptionInfo
Includes all encryption-related information.
String enhancedMonitoring
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.
OpenMonitoringInfo openMonitoring
The settings for open monitoring.
String kafkaVersion
The version of Apache Kafka.
LoggingInfo loggingInfo
Integer numberOfBrokerNodes
The number of broker nodes in the cluster.
Map<K,V> tags
Create tags when creating the cluster.
String description
The description of the configuration.
List<E> kafkaVersions
The versions of Apache Kafka with which you can use this MSK configuration.
String name
The name of the configuration.
ByteBuffer serverProperties
Contents of the
String arn
The Amazon Resource Name (ARN) of the configuration.
Date creationTime
The time when the configuration was created.
ConfigurationRevision latestRevision
Latest revision of the configuration.
String name
The name of the configuration.
String state
The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
String arn
The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.
String clusterOperationArn
The Amazon Resource Name (ARN) that uniquely identifies the MSK cluster operation.
ClusterOperationInfo clusterOperationInfo
Cluster operation information
String clusterArn
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
ClusterInfo clusterInfo
The cluster information.
String arn
The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
String arn
The Amazon Resource Name (ARN) of the configuration.
Date creationTime
The time when the configuration was created.
String description
The description of the configuration.
List<E> kafkaVersions
The versions of Apache Kafka with which you can use this MSK configuration.
ConfigurationRevision latestRevision
Latest revision of the configuration.
String name
The name of the configuration.
String state
The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
String arn
The Amazon Resource Name (ARN) of the configuration.
Date creationTime
The time when the configuration was created.
String description
The description of the configuration.
Long revision
The revision number.
ByteBuffer serverProperties
Contents of the
Integer volumeSize
The size in GiB of the EBS volume for the data drive on each broker node.
String dataVolumeKMSKeyId
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.
EncryptionAtRest encryptionAtRest
The data-volume encryption details.
EncryptionInTransit encryptionInTransit
The details for encryption in transit.
String clientBroker
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.
Boolean inCluster
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.
String invalidParameter
The parameter that caused the error.
String clusterArn
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
String bootstrapBrokerString
A string containing one or more hostname:port pairs.
String bootstrapBrokerStringTls
A string containing one or more DNS names (or IP) and TLS port pairs.
String bootstrapBrokerStringSaslScram
A string containing one or more DNS names (or IP) and Sasl Scram port pairs.
String clusterArn
The Amazon Resource Name (ARN) of the cluster check.
String invalidParameter
The parameter that caused the error.
Boolean enabledInBroker
Indicates whether you want to enable or disable the JMX Exporter.
Boolean enabledInBroker
Indicates whether you want to enable or disable the JMX Exporter.
String clusterArn
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
Integer maxResults
The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
String nextToken
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.
List<E> clusterOperationInfoList
An array of cluster operation information objects.
String nextToken
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.
String clusterNameFilter
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.
Integer maxResults
The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
String nextToken
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.
List<E> clusterInfoList
Information on each of the MSK clusters in the response.
String nextToken
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.
String arn
The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
Integer maxResults
The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
String nextToken
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.
Integer maxResults
The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
String nextToken
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.
List<E> configurations
An array of MSK configurations.
String nextToken
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.
Integer maxResults
The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
String nextToken
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.
String clusterArn
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
Integer maxResults
The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
String nextToken
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.
String resourceArn
The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.
BrokerLogs brokerLogs
List<E> brokerEBSVolumeInfo
Specifies the size of the EBS volume and the ID of the associated broker.
ConfigurationInfo configurationInfo
Information about the changes in the configuration of the brokers.
Integer numberOfBrokerNodes
The number of broker nodes in the cluster.
String enhancedMonitoring
Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
OpenMonitoring openMonitoring
The settings for open monitoring.
String kafkaVersion
The Kafka version.
LoggingInfo loggingInfo
Boolean enabledInBroker
Indicates whether you want to enable or disable the Node Exporter.
Boolean enabledInBroker
Indicates whether you want to enable or disable the Node Exporter.
String addedToClusterTime
The start time.
BrokerNodeInfo brokerNodeInfo
The broker node info.
String instanceType
The instance type.
String nodeARN
The Amazon Resource Name (ARN) of the node.
String nodeType
The node type.
ZookeeperNodeInfo zookeeperNodeInfo
The ZookeeperNodeInfo.
String invalidParameter
The parameter that caused the error.
Prometheus prometheus
Prometheus settings.
PrometheusInfo prometheus
Prometheus settings.
JmxExporter jmxExporter
Indicates whether you want to enable or disable the JMX Exporter.
NodeExporter nodeExporter
Indicates whether you want to enable or disable the Node Exporter.
JmxExporterInfo jmxExporter
Indicates whether you want to enable or disable the JMX Exporter.
NodeExporterInfo nodeExporter
Indicates whether you want to enable or disable the Node Exporter.
Scram scram
Details for SASL/SCRAM client authentication.
Boolean enabled
SASL/SCRAM authentication is enabled or not.
String invalidParameter
The parameter that caused the error.
EBSStorageInfo ebsStorageInfo
EBS volume information.
String invalidParameter
The parameter that caused the error.
String invalidParameter
The parameter that caused the error.
String resourceArn
The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.
List<E> tagKeys
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: _ . / = + -
String clusterArn
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
String currentVersion
The version of cluster to update from. A successful operation will then generate a new version.
Integer targetNumberOfBrokerNodes
The number of broker nodes that you want the cluster to have after this operation completes successfully.
String clusterArn
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
String currentVersion
The version of cluster to update from. A successful operation will then generate a new version.
List<E> targetBrokerEBSVolumeInfo
Describes the target volume size and the ID of the broker to apply the update to.
String clusterArn
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
ConfigurationInfo configurationInfo
Represents the configuration that you want MSK to use for the brokers in a cluster.
String currentVersion
The version of the cluster that needs to be updated.
String clusterArn
The Amazon Resource Name (ARN) of the cluster to be updated.
ConfigurationInfo configurationInfo
The custom configuration that should be applied on the new version of cluster.
String currentVersion
Current cluster version.
String targetKafkaVersion
Target Kafka version.
String arn
The Amazon Resource Name (ARN) of the configuration.
String description
The description of the configuration revision.
ByteBuffer serverProperties
Contents of the
String arn
The Amazon Resource Name (ARN) of the configuration.
ConfigurationRevision latestRevision
Latest revision of the configuration.
String clusterArn
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
String currentVersion
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.
String enhancedMonitoring
Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
OpenMonitoringInfo openMonitoring
The settings for open monitoring.
LoggingInfo loggingInfo
String attachedENIId
The attached elastic network interface of the broker.
String clientVpcIpAddress
The virtual private cloud (VPC) IP address of the client.
List<E> endpoints
Endpoints for accessing the ZooKeeper.
Double zookeeperId
The role-specific ID for Zookeeper.
String zookeeperVersion
The version of Zookeeper.
Copyright © 2020. All rights reserved.