AWS Kafka Service Tables

Tables

AWSKafkaClusterOperationBrokerEBSVolumes

Name	Type	Description
AWSKafkaClusterOperationARN	string	Amazon Resource Name (ARN) identifying the specific MSK cluster operation.
ConfigID	integer	Internal identifier linking this EBS volume configuration to a configuration context.
VolumeSizeInGB	integer	Size of the EBS volume allocated to the broker, in gigabytes.
ProvisionedThroughputVolume	integer	Provisioned throughput value for the EBS volume, in MiB/s.
ProvisionedThroughputEnabled	bit	Indicates whether provisioned throughput is enabled for the EBS volume.
IsSource	bit	Indicates if this configuration is the original (source) state.
BatchDate	datetime	Date the data was collected or processed.
ID	integer	Unique identifier for this EBS volume configuration.
KafkaBrokerNodeID	string	Identifier of the broker node associated with this EBS volume.

AWSKafkaClusterOperations

Name	Type	Description
ARN	string	Amazon Resource Name (ARN) identifying the specific MSK cluster operation.
AWSKafkaClusterARN	string	ARN of the MSK cluster associated with the operation.
ConfigID	integer	Internal identifier linking this operation to a specific configuration context.
ClusterType	string	Type of the cluster, either `PROVISIONED` or `SERVERLESS`.
Type	string	Type of the cluster operation (e.g., `UPDATE`, `DELETE`).
StartTime	datetime	The time at which the operation was started.
EndTime	datetime	The time at which the operation finished.
ErrorCode	string	A code describing the error if the operation failed.
ErrorString	string	A detailed message describing the error if the operation failed.
ProvisionedClusterOperationMutableSourceClientAuthenticationtSASLIAMEnabled	bit	Indicates whether SASL/IAM authentication was enabled in the source configuration.
ProvisionedClusterOperationMutableSourceClientAuthenticationtSASLSCRAMEnabled	bit	Indicates whether SASL/SCRAM authentication was enabled in the source configuration.
ProvisionedClusterOperationMutableSourceClientAuthenticationtTLSEnabled	bit	Indicates whether TLS authentication was enabled in the source configuration.
ProvisionedClusterOperationMutableSourceClientAuthenticationtUnauthenticatedEnabled	bit	Indicates whether unauthenticated access was enabled in the source configuration.
ProvisionedClusterOperationMutableSourceConfigurationRevision	bigint	The revision number of the source configuration.
ProvisionedClusterOperationMutableSourceConnectivityPublicAccessType	string	Type of public access in the source configuration (`DISABLED` or `SERVICE_PROVIDED_EIPS`).
ProvisionedClusterOperationMutableSourceConnectivityVPCClientSASLIAMEnabled	bit	Indicates whether SASL/IAM authentication was enabled for VPC clients in the source configuration.
ProvisionedClusterOperationMutableSourceConnectivityVPCClientSASLSCRAMEnabled	bit	Indicates whether SASL/SCRAM authentication was enabled for VPC clients in the source configuration.
ProvisionedClusterOperationMutableSourceConnectivityVPCClientTLSEnabled	bit	Indicates whether TLS authentication was enabled for VPC clients in the source configuration.
ProvisionedClusterOperationMutableSourceEnhancedMonitoring	string	Level of enhanced monitoring in the source configuration (e.g., `DEFAULT`, `PER_BROKER`, etc.).
ProvisionedClusterOperationMutableSourceInstanceType	string	Broker instance type in the source configuration (e.g., `kafka.m5.large`).
ServerlessClusterOperationMutableSourceKafkaVersion	string	Kafka version in the source configuration for serverless clusters.
ProvisionedClusterOperationMutableSourceLoggingCloudWatchLogsEnabled	bit	Indicates whether CloudWatch Logs were enabled in the source configuration.
ProvisionedClusterOperationMutableSourceLoggingCloudWatchLogsGroup	string	CloudWatch Logs group name in the source configuration.
ProvisionedClusterOperationMutableSourceLoggingFirehoseEnabled	bit	Indicates whether Kinesis Data Firehose logging was enabled in the source configuration.
ProvisionedClusterOperationMutableSourceLoggingFirehoseDeliveryStream	string	Kinesis Data Firehose delivery stream name in the source configuration.
ProvisionedClusterOperationMutableSourceLoggingS3Enabled	bit	Indicates whether S3 logging was enabled in the source configuration.
ProvisionedClusterOperationMutableSourceLoggingS3Bucket	string	S3 bucket name for logging in the source configuration.
ProvisionedClusterOperationMutableSourceLoggingS3Prefix	string	S3 prefix for logging in the source configuration.
ProvisionedClusterOperationMutableSourceNumberOfBrokerNodes	integer	Number of broker nodes in the source configuration.
ProvisionedClusterOperationMutableSourceOpenMonitoringPrometheusJMXExporterEnabledInBroker	bit	Indicates whether JMX Exporter was enabled in the source configuration.
ProvisionedClusterOperationMutableSourceOpenMonitoringPrometheusNodeExporterEnabledInBroker	bit	Indicates whether Node Exporter was enabled in the source configuration.
ProvisionedClusterOperationMutableSourceStorageMode	string	Storage mode in the source configuration (`LOCAL` or `TIERED`).
ProvisionedClusterOperationMutableTargetClientAuthenticationtSASLIAMEnabled	bit	Indicates whether SASL/IAM authentication is enabled in the target configuration.
ProvisionedClusterOperationMutableTargetClientAuthenticationtSASLSCRAMEnabled	bit	Indicates whether SASL/SCRAM authentication is enabled in the target configuration.
ProvisionedClusterOperationMutableTargetClientAuthenticationtTLSEnabled	bit	Indicates whether TLS authentication is enabled in the target configuration.
ProvisionedClusterOperationMutableTargetClientAuthenticationtUnauthenticatedEnabled	bit	Indicates whether unauthenticated access is enabled in the target configuration.
ProvisionedClusterOperationMutableTargetConfigurationRevision	bigint	The revision number of the target configuration.
ProvisionedClusterOperationMutableTargetConnectivityPublicAccessType	string	Type of public access in the target configuration (`DISABLED` or `SERVICE_PROVIDED_EIPS`).
ProvisionedClusterOperationMutableTargetConnectivityVPCClientSASLIAMEnabled	bit	Indicates whether SASL/IAM authentication is enabled for VPC clients in the target configuration.
ProvisionedClusterOperationMutableTargetConnectivityVPCClientSASLSCRAMEnabled	bit	Indicates whether SASL/SCRAM authentication is enabled for VPC clients in the target configuration.
ProvisionedClusterOperationMutableTargetConnectivityVPCClientTLSEnabled	bit	Indicates whether TLS authentication is enabled for VPC clients in the target configuration.
ProvisionedClusterOperationMutableTargetEnhancedMonitoring	string	Level of enhanced monitoring in the target configuration (e.g., `DEFAULT`, `PER_BROKER`, etc.).
ProvisionedClusterOperationMutableTargetInstanceType	string	Broker instance type in the target configuration (e.g., `kafka.m5.large`).
ProvisionedClusterOperationMutableTargetKafkaVersion	string	Kafka version in the target configuration.
ProvisionedClusterOperationMutableTargetLoggingCloudWatchLogsEnabled	bit	Indicates whether CloudWatch Logs are enabled in the target configuration.
ProvisionedClusterOperationMutableTargetLoggingCloudWatchLogsGroup	string	CloudWatch Logs group name in the target configuration.
ProvisionedClusterOperationMutableTargetLoggingFirehoseEnabled	bit	Indicates whether Kinesis Data Firehose logging is enabled in the target configuration.
ProvisionedClusterOperationMutableTargetLoggingFirehoseDeliveryStream	string	Kinesis Data Firehose delivery stream name in the target configuration.
ProvisionedClusterOperationMutableTargetLoggingS3Enabled	bit	Indicates whether S3 logging is enabled in the target configuration.
ProvisionedClusterOperationMutableTargetLoggingS3Bucket	string	S3 bucket name for logging in the target configuration.
ProvisionedClusterOperationMutableTargetLoggingS3Prefix	string	S3 prefix for logging in the target configuration.
ProvisionedClusterOperationMutableTargetNumberOfBrokerNodes	integer	Number of broker nodes in the target configuration.
ProvisionedClusterOperationMutableTargetOpenMonitoringPrometheusJMXExporterEnabledInBroker	bit	Indicates whether JMX Exporter is enabled in the target configuration.
ProvisionedClusterOperationMutableTargetOpenMonitoringPrometheusNodeExporterEnabledInBroker	bit	The storage mode used in the target configuration, either `LOCAL` or `TIERED`.
ProvisionedClusterOperationMutableTargetStorageMode	string	The target storage mode for a provisioned Kafka cluster during a cluster operation update (e.g., `EBS`, `LOCAL`). It defines how broker node storage is configured post-operation.
ProvisionedClusterOperationVPCConnectionCreationTime	datetime	The time when the VPC connection for the provisioned cluster operation was created.
ProvisionedClusterOperationVPCConnectionOwner	string	The AWS account ID that owns the VPC connection for the provisioned cluster operation.
ServerlessClusterOperationVPCConnectionCreationTime	datetime	The time when the VPC connection for the serverless cluster operation was created.
ServerlessClusterOperationVPCConnectionOwner	string	The AWS account ID that owns the VPC connection for the serverless cluster operation.
State	string	The state of the cluster operation (e.g., `IN_PROGRESS`, `SUCCEEDED`, `FAILED`).
BatchDate	datetime	The date when the batch operation was executed.
ProvisionedClusterOperationMutableSourceBrokerCountUpdateCreatedIDsJson	string	A JSON list of broker IDs created during the source broker count update for the provisioned cluster operation.
ProvisionedClusterOperationMutableSourceBrokerCountUpdateDeletedIDsJson	string	A JSON list of broker IDs deleted during the source broker count update for the provisioned cluster operation.
ProvisionedClusterOperationMutableTargetBrokerCountUpdateCreatedIDsJson	string	A JSON list of broker IDs created during the target broker count update for the provisioned cluster operation.
ProvisionedClusterOperationMutableTargetBrokerCountUpdateDeletedIDsJson	string	A JSON list of broker IDs deleted during the target broker count update for the provisioned cluster operation.
ProvisionedClusterOperationVPCConnectionUserIdentityPrincipalID	string	The principal ID of the user identity associated with the VPC connection in the provisioned cluster operation.
ProvisionedClusterOperationVPCConnectionUserIdentityType	string	The type of the user identity associated with the VPC connection in the provisioned cluster operation.
ServerlessClusterOperationVPCConnectionUserIdentityPrincipalID	string	The principal ID of the user identity associated with the VPC connection in the serverless cluster operation.
ServerlessClusterOperationVPCConnectionUserIdentityType	string	The type of the user identity associated with the VPC connection in the serverless cluster operation.
ProvisionedClusterOperationMutableSourceClientAuthenticationtTLSCertificateAuthorityARNListJson	string	A JSON list of ARN values for the TLS certificate authorities used in the source client authentication for the provisioned cluster operation.
ProvisionedClusterOperationMutableSourceConfigurationARN	string	The ARN of the configuration used in the source for the provisioned cluster operation.
ProvisionedClusterOperationMutableTargetClientAuthenticationtTLSCertificateAuthorityARNListJson	string	A JSON list of ARN values for the TLS certificate authorities used in the target client authentication for the provisioned cluster operation.
ProvisionedClusterOperationMutableTargetConfigurationARN	string	The ARN of the configuration used in the target for the provisioned cluster operation.
ProvisionedClusterOperationVPCConnectionARN	string	The ARN of the VPC connection for the provisioned cluster operation.
ServerlessClusterOperationVPCConnectionARN	string	The ARN of the VPC connection for the serverless cluster operation.

AWSKafkaClusterOperationSteps

Name	Type	Description
AWSKafkaClusterOperationARN	string	The ARN of the Kafka cluster operation.
ConfigID	integer	The unique identifier for the configuration associated with the operation step.
Name	string	The name of the Kafka cluster operation step.
Status	string	The current status of the operation step (e.g., `IN_PROGRESS`, `SUCCEEDED`, `FAILED`).
BatchDate	datetime	The date when the batch operation was executed.
ID	integer	The unique identifier for the Kafka cluster operation step.

AWSKafkaClusters

Name	Type	Description
ActiveOperationARN	string	The ARN of the active operation currently being performed on the Kafka cluster.
ARN	string	The ARN of the Kafka cluster.
ConfigID	integer	The unique identifier for the configuration associated with the Kafka cluster.
Name	string	The name of the Kafka cluster.
Type	string	The type of the Kafka cluster (e.g., `Provisioned`, `Serverless`).
CreationTime	datetime	The time when the Kafka cluster was created.
CurrentVersion	string	The current version of the Kafka cluster.
ProvisionedClusterBrokerNodeGroupAZDistribution	string	The distribution of broker nodes across availability zones for a provisioned Kafka cluster.
ProvisionedClusterBrokerNodeGroupClientSubnetJson	string	The list of subnets for client communication in a provisioned Kafka cluster.
ProvisionedClusterBrokerNodeGroupConnectivityPublicAccessType	string	The type of public access for the provisioned Kafka cluster broker node group connectivity (e.g., `DISABLED`, `ENABLED`).
ProvisionedClusterBrokerNodeGroupConnectivityVPCClientSASLIAMEnabled	bit	Indicates if SASL authentication using IAM is enabled for VPC client connectivity in a provisioned Kafka cluster.
ProvisionedClusterBrokerNodeGroupConnectivityVPCClientSASLSCRAMEnabled	bit	Indicates if SASL authentication using SCRAM is enabled for VPC client connectivity in a provisioned Kafka cluster.
ProvisionedClusterBrokerNodeGroupConnectivityVPCClientTLSEnabled	bit	Indicates if TLS encryption is enabled for VPC client connectivity in a provisioned Kafka cluster.
ProvisionedClusterBrokerNodeGroupInstanceType	string	The instance type of broker nodes in the provisioned Kafka cluster.
ProvisionedClusterBrokerNodeGroupSecurityGroupsJson	string	The list of security groups associated with the provisioned Kafka cluster broker node group.
ProvisionedClusterBrokerNodeGroupEBSStorageVolumeSize	integer	The size of the EBS volume attached to broker nodes in a provisioned Kafka cluster.
ProvisionedClusterBrokerNodeGroupEBSStorageProvisionedThroughputVolume	integer	The provisioned throughput volume for the EBS storage in a provisioned Kafka cluster.
ProvisionedClusterBrokerNodeGroupEBSStorageProvisionedThroughputEnabled	bit	Indicates whether provisioned throughput is enabled for the EBS storage in a provisioned Kafka cluster.
ProvisionedClusterClientAuthenticationPublicAccessType	string	The type of public access allowed for client authentication in the provisioned Kafka cluster.
ProvisionedClusterClientAuthenticationSASLIAMEnabled	bit	Indicates if SASL authentication using IAM is enabled for client authentication in a provisioned Kafka cluster.
ProvisionedClusterClientAuthenticationSASLSCRAMEnabled	bit	Indicates if SASL authentication using SCRAM is enabled for client authentication in a provisioned Kafka cluster.
ProvisionedClusterClientAuthenticationTLSEnabled	bit	Indicates if TLS encryption is enabled for client authentication in a provisioned Kafka cluster.
ProvisionedClusterClientAuthenticationUnauthenticatedEnabled	bit	Indicates if unauthenticated access is enabled for client authentication in a provisioned Kafka cluster.
ProvisionedClusterCurrentBrokerSoftwareKafkaVersion	string	The Kafka software version currently being used by the broker in the provisioned Kafka cluster.
ProvisionedClusterCurrentBrokerSoftwareConfigurationRevision	bigint	The configuration revision of the current broker software for the provisioned Kafka cluster.
ProvisionedClusterCustomerActionStatus	string	The status of any customer action on the provisioned Kafka cluster.
ProvisionedClusterEncryptionInTransitClientBroker	string	Indicates whether encryption in transit is enabled between client and broker in a provisioned Kafka cluster.
ProvisionedClusterEncryptionInTransitInCluster	bit	Indicates whether encryption in transit is enabled within the cluster for a provisioned Kafka cluster.
ProvisionedClusterEnhancedMonitoring	string	Indicates whether enhanced monitoring is enabled for a provisioned Kafka cluster.
ProvisionedClusterLoggingCloudWatchLogsEnabled	bit	Indicates if CloudWatch logs are enabled for logging in the provisioned Kafka cluster.
ProvisionedClusterLoggingCloudWatchLogsGroup	string	The CloudWatch Logs group used for logging in the provisioned Kafka cluster.
ProvisionedClusterLoggingFirehoseEnabled	bit	Indicates if Firehose logging is enabled for the provisioned Kafka cluster.
ProvisionedClusterLoggingFirehoseDeliveryStream	string	The Firehose delivery stream used for logging in the provisioned Kafka cluster.
ProvisionedClusterLoggingS3Enabled	bit	Indicates if S3 logging is enabled for the provisioned Kafka cluster.
ProvisionedClusterLoggingS3Bucket	string	The S3 bucket used for logging in the provisioned Kafka cluster.
ProvisionedClusterLoggingS3Prefix	string	The S3 prefix used for logging in the provisioned Kafka cluster.
ProvisionedClusterNumberOfClusterNodes	integer	The number of broker nodes in the provisioned Kafka cluster.
ProvisionedClusterOpenMonitoringPrometheusJMXExporterEnabledInBroker	bit	Indicates if JMX exporter for Prometheus monitoring is enabled for the broker nodes in the provisioned Kafka cluster.
ProvisionedClusterOpenMonitoringPrometheusNodeExporterEnabledInBroker	bit	Indicates if node exporter for Prometheus monitoring is enabled for the broker nodes in the provisioned Kafka cluster.
ProvisionedClusterStorageMode	string	The storage mode for the provisioned Kafka cluster (e.g., `LOCAL`, `EBS`).
ProvisionedClusterZookeeperConnectString	string	The Zookeeper connection string for the provisioned Kafka cluster.
ProvisionedClusterZookeeperConnectStringTLS	string	The Zookeeper connection string with TLS for the provisioned Kafka cluster.
ServerlessClusterClientAuthenticationSASLIAMEnabled	bit	Indicates if SASL authentication using IAM is enabled for the serverless Kafka cluster.
ServerlessClusterVPCConfigsJson	string	The list of VPC configurations for the serverless Kafka cluster.
State	string	The current state of the Kafka cluster (e.g., `ACTIVE`, `IN_PROGRESS`, `FAILED`).
StateCode	string	The numeric code representing the current state of the Kafka cluster.
StateMessage	string	The message describing the current state of the Kafka cluster.
BatchDate	datetime	The date when the batch operation was executed.
ProvisionedClusterClientAuthenticationTLSCertificateAuthorityARNListJson	string	The list of ARN for the certificate authority used for TLS authentication in the provisioned Kafka cluster.
ProvisionedClusterCurrentBrokerSoftwareConfigurationARN	string	The ARN of the broker software configuration used in the provisioned Kafka cluster.
ProvisionedClusterBrokerNodeGroupZoneIDsJson	string	The list of zone IDs for the broker node group in the provisioned Kafka cluster.
ProvisionedClusterEncryptionAtRestDataVolumeKMSKeyID	string	The KMS key ID used for data encryption at rest in the provisioned Kafka cluster.

Tables

AWSKafkaClusterOperationBrokerEBSVolumes

AWSKafkaClusterOperations

AWSKafkaClusterOperationSteps

AWSKafkaClusters

Learn more...