2023/04/27 - Managed Streaming for Kafka - 9 new 10 updated api methods
Changes Amazon MSK has added new APIs that allows multi-VPC private connectivity and cluster policy support for Amazon MSK clusters that simplify connectivity and access between your Apache Kafka clients hosted in different VPCs and AWS accounts and your Amazon MSK clusters.
Get the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.
See also: AWS API Documentation
Request Syntax
client.get_cluster_policy(
ClusterArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the cluster.
dict
Response Syntax
{
'CurrentVersion': 'string',
'Policy': 'string'
}
Response Structure
(dict) --
Successful response.
CurrentVersion (string) --
The version of cluster policy.
Policy (string) --
The cluster policy.
Returns a list of all the VPC connections in this Region.
See also: AWS API Documentation
Request Syntax
client.list_client_vpc_connections(
ClusterArn='string',
MaxResults=123,
NextToken='string'
)
string
The Amazon Resource Name (ARN) of the cluster.
integer
The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
string
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.
dict
Response Syntax
{
'ClientVpcConnections': [
{
'Authentication': 'string',
'CreationTime': datetime(2015, 1, 1),
'State': 'CREATING'|'AVAILABLE'|'INACTIVE'|'DEACTIVATING'|'DELETING'|'FAILED'|'REJECTED'|'REJECTING',
'VpcConnectionArn': 'string',
'Owner': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
200 response
ClientVpcConnections (list) --
List of client VPC connections.
(dict) --
The client VPC connection object.
Authentication (string) --
Information about the auth scheme of Vpc Connection.
CreationTime (datetime) --
Creation time of the Vpc Connection.
State (string) --
State of the Vpc Connection.
VpcConnectionArn (string) --
The ARN that identifies the Vpc Connection.
Owner (string) --
The Owner of the Vpc Connection.
NextToken (string) --
The paginated results marker. When the result of a ListClientVpcConnections operation is truncated, the call returns NextToken in the response. To get another batch of configurations, provide this token in your next request.
Returns a list of all the VPC connections in this Region.
See also: AWS API Documentation
Request Syntax
client.list_vpc_connections(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
string
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.
dict
Response Syntax
{
'VpcConnections': [
{
'VpcConnectionArn': 'string',
'TargetClusterArn': 'string',
'CreationTime': datetime(2015, 1, 1),
'Authentication': 'string',
'VpcId': 'string',
'State': 'CREATING'|'AVAILABLE'|'INACTIVE'|'DEACTIVATING'|'DELETING'|'FAILED'|'REJECTED'|'REJECTING'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
200 response
VpcConnections (list) --
List of VPC connections.
(dict) --
The VPC connection object.
VpcConnectionArn (string) --
The ARN that identifies the Vpc Connection.
TargetClusterArn (string) --
The ARN that identifies the Cluster which the Vpc Connection belongs to.
CreationTime (datetime) --
Creation time of the Vpc Connection.
Authentication (string) --
Information about the auth scheme of Vpc Connection.
VpcId (string) --
The vpcId that belongs to the Vpc Connection.
State (string) --
State of the Vpc Connection.
NextToken (string) --
The paginated results marker. When the result of a ListClientVpcConnections operation is truncated, the call returns NextToken in the response. To get another batch of configurations, provide this token in your next request.
Creates a new MSK VPC connection.
See also: AWS API Documentation
Request Syntax
client.create_vpc_connection(
TargetClusterArn='string',
Authentication='string',
VpcId='string',
ClientSubnets=[
'string',
],
SecurityGroups=[
'string',
],
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The cluster Amazon Resource Name (ARN) for the VPC connection.
string
[REQUIRED]
The authentication type of VPC connection.
string
[REQUIRED]
The VPC ID of VPC connection.
list
[REQUIRED]
The list of client subnets.
(string) --
list
[REQUIRED]
The list of security groups.
(string) --
dict
A map of tags for the VPC connection.
(string) --
(string) --
dict
Response Syntax
{
'VpcConnectionArn': 'string',
'State': 'CREATING'|'AVAILABLE'|'INACTIVE'|'DEACTIVATING'|'DELETING'|'FAILED'|'REJECTED'|'REJECTING',
'Authentication': 'string',
'VpcId': 'string',
'ClientSubnets': [
'string',
],
'SecurityGroups': [
'string',
],
'CreationTime': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
200 response
VpcConnectionArn (string) --
The VPC connection ARN.
State (string) --
The State of Vpc Connection.
Authentication (string) --
The authentication type of VPC connection.
VpcId (string) --
The VPC ID of the VPC connection.
ClientSubnets (list) --
The list of client subnets.
(string) --
SecurityGroups (list) --
The list of security groups.
(string) --
CreationTime (datetime) --
The creation time of VPC connection.
Tags (dict) --
A map of tags for the VPC connection.
(string) --
(string) --
Returns a description of this MSK VPC connection.
See also: AWS API Documentation
Request Syntax
client.describe_vpc_connection(
Arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC connection.
dict
Response Syntax
{
'VpcConnectionArn': 'string',
'TargetClusterArn': 'string',
'State': 'CREATING'|'AVAILABLE'|'INACTIVE'|'DEACTIVATING'|'DELETING'|'FAILED'|'REJECTED'|'REJECTING',
'Authentication': 'string',
'VpcId': 'string',
'Subnets': [
'string',
],
'SecurityGroups': [
'string',
],
'CreationTime': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
200 response
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC connection.
TargetClusterArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies an MSK cluster.
State (string) --
The state of VPC connection.
Authentication (string) --
The authentication type of VPC connection.
VpcId (string) --
The VPC Id for the VPC connection.
Subnets (list) --
The list of subnets for the VPC connection.
(string) --
SecurityGroups (list) --
The list of security groups for the VPC connection.
(string) --
CreationTime (datetime) --
The creation time of the VPC connection.
Tags (dict) --
A map of tags for the VPC connection.
(string) --
(string) --
Deletes a MSK VPC connection.
See also: AWS API Documentation
Request Syntax
client.delete_vpc_connection(
Arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies an MSK VPC connection.
dict
Response Syntax
{
'VpcConnectionArn': 'string',
'State': 'CREATING'|'AVAILABLE'|'INACTIVE'|'DEACTIVATING'|'DELETING'|'FAILED'|'REJECTED'|'REJECTING'
}
Response Structure
(dict) --
Successful response.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies an MSK VPC connection.
State (string) --
The state of the VPC connection.
Creates or updates the MSK cluster policy specified by the cluster Amazon Resource Name (ARN) in the request.
See also: AWS API Documentation
Request Syntax
client.put_cluster_policy(
ClusterArn='string',
CurrentVersion='string',
Policy='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the cluster.
string
The policy version.
string
[REQUIRED]
The policy.
dict
Response Syntax
{
'CurrentVersion': 'string'
}
Response Structure
(dict) --
Successful response.
CurrentVersion (string) --
The policy version.
Returns empty response.
See also: AWS API Documentation
Request Syntax
client.reject_client_vpc_connection(
ClusterArn='string',
VpcConnectionArn='string'
)
string
The Amazon Resource Name (ARN) of the cluster.
string
[REQUIRED]
The VPC connection ARN.
dict
Response Syntax
{}
Response Structure
(dict) --
200 response
Deletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.
See also: AWS API Documentation
Request Syntax
client.delete_cluster_policy(
ClusterArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the cluster.
dict
Response Syntax
{}
Response Structure
(dict) --
Successful response.
{'BrokerNodeGroupInfo': {'ConnectivityInfo': {'VpcConnectivity': {'ClientAuthentication': {'Sasl': {'Iam': {'Enabled': 'boolean'},
'Scram': {'Enabled': 'boolean'}},
'Tls': {'Enabled': 'boolean'}}}},
'ZoneIds': ['string']}}
Creates a new MSK cluster.
See also: AWS API Documentation
Request Syntax
client.create_cluster(
BrokerNodeGroupInfo={
'BrokerAZDistribution': 'DEFAULT',
'ClientSubnets': [
'string',
],
'InstanceType': 'string',
'SecurityGroups': [
'string',
],
'StorageInfo': {
'EbsStorageInfo': {
'ProvisionedThroughput': {
'Enabled': True|False,
'VolumeThroughput': 123
},
'VolumeSize': 123
}
},
'ConnectivityInfo': {
'PublicAccess': {
'Type': 'string'
},
'VpcConnectivity': {
'ClientAuthentication': {
'Sasl': {
'Scram': {
'Enabled': True|False
},
'Iam': {
'Enabled': True|False
}
},
'Tls': {
'Enabled': True|False
}
}
}
},
'ZoneIds': [
'string',
]
},
ClientAuthentication={
'Sasl': {
'Scram': {
'Enabled': True|False
},
'Iam': {
'Enabled': True|False
}
},
'Tls': {
'CertificateAuthorityArnList': [
'string',
],
'Enabled': True|False
},
'Unauthenticated': {
'Enabled': True|False
}
},
ClusterName='string',
ConfigurationInfo={
'Arn': 'string',
'Revision': 123
},
EncryptionInfo={
'EncryptionAtRest': {
'DataVolumeKMSKeyId': 'string'
},
'EncryptionInTransit': {
'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT',
'InCluster': True|False
}
},
EnhancedMonitoring='DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION',
OpenMonitoring={
'Prometheus': {
'JmxExporter': {
'EnabledInBroker': True|False
},
'NodeExporter': {
'EnabledInBroker': True|False
}
}
},
KafkaVersion='string',
LoggingInfo={
'BrokerLogs': {
'CloudWatchLogs': {
'Enabled': True|False,
'LogGroup': 'string'
},
'Firehose': {
'DeliveryStream': 'string',
'Enabled': True|False
},
'S3': {
'Bucket': 'string',
'Enabled': True|False,
'Prefix': 'string'
}
}
},
NumberOfBrokerNodes=123,
Tags={
'string': 'string'
},
StorageMode='LOCAL'|'TIERED'
)
dict
[REQUIRED]
Information about the broker nodes in the cluster.
BrokerAZDistribution (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.
ClientSubnets (list) -- [REQUIRED]
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.
(string) --
InstanceType (string) -- [REQUIRED]
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.
SecurityGroups (list) --
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.
(string) --
StorageInfo (dict) --
Contains information about storage volumes attached to MSK broker nodes.
EbsStorageInfo (dict) --
EBS volume information.
ProvisionedThroughput (dict) --
EBS volume provisioned throughput information.
Enabled (boolean) --
Provisioned throughput is enabled or not.
VolumeThroughput (integer) --
Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
VolumeSize (integer) --
The size in GiB of the EBS volume for the data drive on each broker node.
ConnectivityInfo (dict) --
Information about the broker access configuration.
PublicAccess (dict) --
Public access control for brokers.
Type (string) --
The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
VpcConnectivity (dict) --
VPC connectivity access control for brokers.
ClientAuthentication (dict) --
Includes all client authentication information for VPC connectivity.
Sasl (dict) --
SASL authentication type details for VPC connectivity.
Scram (dict) --
Details for SASL/SCRAM client authentication for VPC connectivity.
Enabled (boolean) --
SASL/SCRAM authentication is on or off for VPC connectivity.
Iam (dict) --
Details for SASL/IAM client authentication for VPC connectivity.
Enabled (boolean) --
SASL/IAM authentication is on or off for VPC connectivity.
Tls (dict) --
TLS authentication type details for VPC connectivity.
Enabled (boolean) --
TLS authentication is on or off for VPC connectivity.
ZoneIds (list) --
The list of zoneIds for the cluster in the virtual private cloud (VPC).
(string) --
dict
Includes all client authentication related information.
Sasl (dict) --
Details for ClientAuthentication using SASL.
Scram (dict) --
Details for SASL/SCRAM client authentication.
Enabled (boolean) --
SASL/SCRAM authentication is enabled or not.
Iam (dict) --
Indicates whether IAM access control is enabled.
Enabled (boolean) --
Indicates whether IAM access control is enabled.
Tls (dict) --
Details for ClientAuthentication using TLS.
CertificateAuthorityArnList (list) --
List of ACM Certificate Authority ARNs.
(string) --
Enabled (boolean) --
Specifies whether you want to turn on or turn off TLS authentication.
Unauthenticated (dict) --
Contains information about unauthenticated traffic to the cluster.
Enabled (boolean) --
Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
string
[REQUIRED]
The name of the cluster.
dict
Represents the configuration that you want MSK to use for the brokers in a cluster.
Arn (string) -- [REQUIRED]
ARN of the configuration to use.
Revision (integer) -- [REQUIRED]
The revision of the configuration to use.
dict
Includes all encryption-related information.
EncryptionAtRest (dict) --
The data-volume encryption details.
DataVolumeKMSKeyId (string) -- [REQUIRED]
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.
EncryptionInTransit (dict) --
The details for encryption in transit.
ClientBroker (string) --
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.
InCluster (boolean) --
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
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.
dict
The settings for open monitoring.
Prometheus (dict) -- [REQUIRED]
Prometheus settings.
JmxExporter (dict) --
Indicates whether you want to turn on or turn off the JMX Exporter.
EnabledInBroker (boolean) -- [REQUIRED]
Indicates whether you want to turn on or turn off the JMX Exporter.
NodeExporter (dict) --
Indicates whether you want to turn on or turn off the Node Exporter.
EnabledInBroker (boolean) -- [REQUIRED]
Indicates whether you want to turn on or turn off the Node Exporter.
string
[REQUIRED]
The version of Apache Kafka.
dict
BrokerLogs (dict) -- [REQUIRED]
CloudWatchLogs (dict) --
Enabled (boolean) -- [REQUIRED]
LogGroup (string) --
Firehose (dict) --
DeliveryStream (string) --
Enabled (boolean) -- [REQUIRED]
S3 (dict) --
Bucket (string) --
Enabled (boolean) -- [REQUIRED]
Prefix (string) --
integer
[REQUIRED]
The number of broker nodes in the cluster.
dict
Create tags when creating the cluster.
(string) --
(string) --
string
This controls storage mode for supported storage tiers.
dict
Response Syntax
{
'ClusterArn': 'string',
'ClusterName': 'string',
'State': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'HEALING'|'MAINTENANCE'|'REBOOTING_BROKER'|'UPDATING'
}
Response Structure
(dict) --
ClusterArn (string) --
The Amazon Resource Name (ARN) of the cluster.
ClusterName (string) --
The name of the MSK cluster.
State (string) --
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
{'Provisioned': {'BrokerNodeGroupInfo': {'ConnectivityInfo': {'VpcConnectivity': {'ClientAuthentication': {'Sasl': {'Iam': {'Enabled': 'boolean'},
'Scram': {'Enabled': 'boolean'}},
'Tls': {'Enabled': 'boolean'}}}},
'ZoneIds': ['string']}}}
Creates a new MSK cluster.
See also: AWS API Documentation
Request Syntax
client.create_cluster_v2(
ClusterName='string',
Tags={
'string': 'string'
},
Provisioned={
'BrokerNodeGroupInfo': {
'BrokerAZDistribution': 'DEFAULT',
'ClientSubnets': [
'string',
],
'InstanceType': 'string',
'SecurityGroups': [
'string',
],
'StorageInfo': {
'EbsStorageInfo': {
'ProvisionedThroughput': {
'Enabled': True|False,
'VolumeThroughput': 123
},
'VolumeSize': 123
}
},
'ConnectivityInfo': {
'PublicAccess': {
'Type': 'string'
},
'VpcConnectivity': {
'ClientAuthentication': {
'Sasl': {
'Scram': {
'Enabled': True|False
},
'Iam': {
'Enabled': True|False
}
},
'Tls': {
'Enabled': True|False
}
}
}
},
'ZoneIds': [
'string',
]
},
'ClientAuthentication': {
'Sasl': {
'Scram': {
'Enabled': True|False
},
'Iam': {
'Enabled': True|False
}
},
'Tls': {
'CertificateAuthorityArnList': [
'string',
],
'Enabled': True|False
},
'Unauthenticated': {
'Enabled': True|False
}
},
'ConfigurationInfo': {
'Arn': 'string',
'Revision': 123
},
'EncryptionInfo': {
'EncryptionAtRest': {
'DataVolumeKMSKeyId': 'string'
},
'EncryptionInTransit': {
'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT',
'InCluster': True|False
}
},
'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION',
'OpenMonitoring': {
'Prometheus': {
'JmxExporter': {
'EnabledInBroker': True|False
},
'NodeExporter': {
'EnabledInBroker': True|False
}
}
},
'KafkaVersion': 'string',
'LoggingInfo': {
'BrokerLogs': {
'CloudWatchLogs': {
'Enabled': True|False,
'LogGroup': 'string'
},
'Firehose': {
'DeliveryStream': 'string',
'Enabled': True|False
},
'S3': {
'Bucket': 'string',
'Enabled': True|False,
'Prefix': 'string'
}
}
},
'NumberOfBrokerNodes': 123,
'StorageMode': 'LOCAL'|'TIERED'
},
Serverless={
'VpcConfigs': [
{
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
],
'ClientAuthentication': {
'Sasl': {
'Iam': {
'Enabled': True|False
}
}
}
}
)
string
[REQUIRED]
The name of the cluster.
dict
A map of tags that you want the cluster to have.
(string) --
(string) --
dict
Information about the provisioned cluster.
BrokerNodeGroupInfo (dict) -- [REQUIRED]
Information about the brokers.
BrokerAZDistribution (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.
ClientSubnets (list) -- [REQUIRED]
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.
(string) --
InstanceType (string) -- [REQUIRED]
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.
SecurityGroups (list) --
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.
(string) --
StorageInfo (dict) --
Contains information about storage volumes attached to MSK broker nodes.
EbsStorageInfo (dict) --
EBS volume information.
ProvisionedThroughput (dict) --
EBS volume provisioned throughput information.
Enabled (boolean) --
Provisioned throughput is enabled or not.
VolumeThroughput (integer) --
Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
VolumeSize (integer) --
The size in GiB of the EBS volume for the data drive on each broker node.
ConnectivityInfo (dict) --
Information about the broker access configuration.
PublicAccess (dict) --
Public access control for brokers.
Type (string) --
The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
VpcConnectivity (dict) --
VPC connectivity access control for brokers.
ClientAuthentication (dict) --
Includes all client authentication information for VPC connectivity.
Sasl (dict) --
SASL authentication type details for VPC connectivity.
Scram (dict) --
Details for SASL/SCRAM client authentication for VPC connectivity.
Enabled (boolean) --
SASL/SCRAM authentication is on or off for VPC connectivity.
Iam (dict) --
Details for SASL/IAM client authentication for VPC connectivity.
Enabled (boolean) --
SASL/IAM authentication is on or off for VPC connectivity.
Tls (dict) --
TLS authentication type details for VPC connectivity.
Enabled (boolean) --
TLS authentication is on or off for VPC connectivity.
ZoneIds (list) --
The list of zoneIds for the cluster in the virtual private cloud (VPC).
(string) --
ClientAuthentication (dict) --
Includes all client authentication information.
Sasl (dict) --
Details for ClientAuthentication using SASL.
Scram (dict) --
Details for SASL/SCRAM client authentication.
Enabled (boolean) --
SASL/SCRAM authentication is enabled or not.
Iam (dict) --
Indicates whether IAM access control is enabled.
Enabled (boolean) --
Indicates whether IAM access control is enabled.
Tls (dict) --
Details for ClientAuthentication using TLS.
CertificateAuthorityArnList (list) --
List of ACM Certificate Authority ARNs.
(string) --
Enabled (boolean) --
Specifies whether you want to turn on or turn off TLS authentication.
Unauthenticated (dict) --
Contains information about unauthenticated traffic to the cluster.
Enabled (boolean) --
Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
ConfigurationInfo (dict) --
Represents the configuration that you want Amazon MSK to use for the brokers in a cluster.
Arn (string) -- [REQUIRED]
ARN of the configuration to use.
Revision (integer) -- [REQUIRED]
The revision of the configuration to use.
EncryptionInfo (dict) --
Includes all encryption-related information.
EncryptionAtRest (dict) --
The data-volume encryption details.
DataVolumeKMSKeyId (string) -- [REQUIRED]
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.
EncryptionInTransit (dict) --
The details for encryption in transit.
ClientBroker (string) --
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.
InCluster (boolean) --
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.
EnhancedMonitoring (string) --
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.
OpenMonitoring (dict) --
The settings for open monitoring.
Prometheus (dict) -- [REQUIRED]
Prometheus settings.
JmxExporter (dict) --
Indicates whether you want to turn on or turn off the JMX Exporter.
EnabledInBroker (boolean) -- [REQUIRED]
Indicates whether you want to turn on or turn off the JMX Exporter.
NodeExporter (dict) --
Indicates whether you want to turn on or turn off the Node Exporter.
EnabledInBroker (boolean) -- [REQUIRED]
Indicates whether you want to turn on or turn off the Node Exporter.
KafkaVersion (string) -- [REQUIRED]
The Apache Kafka version that you want for the cluster.
LoggingInfo (dict) --
Log delivery information for the cluster.
BrokerLogs (dict) -- [REQUIRED]
CloudWatchLogs (dict) --
Enabled (boolean) -- [REQUIRED]
LogGroup (string) --
Firehose (dict) --
DeliveryStream (string) --
Enabled (boolean) -- [REQUIRED]
S3 (dict) --
Bucket (string) --
Enabled (boolean) -- [REQUIRED]
Prefix (string) --
NumberOfBrokerNodes (integer) -- [REQUIRED]
The number of broker nodes in the cluster.
StorageMode (string) --
This controls storage mode for supported storage tiers.
dict
Information about the serverless cluster.
VpcConfigs (list) -- [REQUIRED]
The configuration of the Amazon VPCs for the cluster.
(dict) --
The configuration of the Amazon VPCs for the cluster.
SubnetIds (list) -- [REQUIRED]
The IDs of the subnets associated with the cluster.
(string) --
SecurityGroupIds (list) --
The IDs of the security groups associated with the cluster.
(string) --
ClientAuthentication (dict) --
Includes all client authentication information.
Sasl (dict) --
Details for ClientAuthentication using SASL.
Iam (dict) --
Indicates whether IAM access control is enabled.
Enabled (boolean) --
Indicates whether IAM access control is enabled.
dict
Response Syntax
{
'ClusterArn': 'string',
'ClusterName': 'string',
'State': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'HEALING'|'MAINTENANCE'|'REBOOTING_BROKER'|'UPDATING',
'ClusterType': 'PROVISIONED'|'SERVERLESS'
}
Response Structure
(dict) --
ClusterArn (string) --
The Amazon Resource Name (ARN) of the cluster.
ClusterName (string) --
The name of the MSK cluster.
State (string) --
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
ClusterType (string) --
The type of the cluster. The possible states are PROVISIONED or SERVERLESS.
{'ClusterInfo': {'BrokerNodeGroupInfo': {'ConnectivityInfo': {'VpcConnectivity': {'ClientAuthentication': {'Sasl': {'Iam': {'Enabled': 'boolean'},
'Scram': {'Enabled': 'boolean'}},
'Tls': {'Enabled': 'boolean'}}}},
'ZoneIds': ['string']}}}
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
See also: AWS API Documentation
Request Syntax
client.describe_cluster(
ClusterArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
dict
Response Syntax
{
'ClusterInfo': {
'ActiveOperationArn': 'string',
'BrokerNodeGroupInfo': {
'BrokerAZDistribution': 'DEFAULT',
'ClientSubnets': [
'string',
],
'InstanceType': 'string',
'SecurityGroups': [
'string',
],
'StorageInfo': {
'EbsStorageInfo': {
'ProvisionedThroughput': {
'Enabled': True|False,
'VolumeThroughput': 123
},
'VolumeSize': 123
}
},
'ConnectivityInfo': {
'PublicAccess': {
'Type': 'string'
},
'VpcConnectivity': {
'ClientAuthentication': {
'Sasl': {
'Scram': {
'Enabled': True|False
},
'Iam': {
'Enabled': True|False
}
},
'Tls': {
'Enabled': True|False
}
}
}
},
'ZoneIds': [
'string',
]
},
'ClientAuthentication': {
'Sasl': {
'Scram': {
'Enabled': True|False
},
'Iam': {
'Enabled': True|False
}
},
'Tls': {
'CertificateAuthorityArnList': [
'string',
],
'Enabled': True|False
},
'Unauthenticated': {
'Enabled': True|False
}
},
'ClusterArn': 'string',
'ClusterName': 'string',
'CreationTime': datetime(2015, 1, 1),
'CurrentBrokerSoftwareInfo': {
'ConfigurationArn': 'string',
'ConfigurationRevision': 123,
'KafkaVersion': 'string'
},
'CurrentVersion': 'string',
'EncryptionInfo': {
'EncryptionAtRest': {
'DataVolumeKMSKeyId': 'string'
},
'EncryptionInTransit': {
'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT',
'InCluster': True|False
}
},
'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION',
'OpenMonitoring': {
'Prometheus': {
'JmxExporter': {
'EnabledInBroker': True|False
},
'NodeExporter': {
'EnabledInBroker': True|False
}
}
},
'LoggingInfo': {
'BrokerLogs': {
'CloudWatchLogs': {
'Enabled': True|False,
'LogGroup': 'string'
},
'Firehose': {
'DeliveryStream': 'string',
'Enabled': True|False
},
'S3': {
'Bucket': 'string',
'Enabled': True|False,
'Prefix': 'string'
}
}
},
'NumberOfBrokerNodes': 123,
'State': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'HEALING'|'MAINTENANCE'|'REBOOTING_BROKER'|'UPDATING',
'StateInfo': {
'Code': 'string',
'Message': 'string'
},
'Tags': {
'string': 'string'
},
'ZookeeperConnectString': 'string',
'ZookeeperConnectStringTls': 'string',
'StorageMode': 'LOCAL'|'TIERED'
}
}
Response Structure
(dict) --
Successful response.
ClusterInfo (dict) --
The cluster information.
ActiveOperationArn (string) --
Arn of active cluster operation.
BrokerNodeGroupInfo (dict) --
Information about the broker nodes.
BrokerAZDistribution (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.
ClientSubnets (list) --
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.
(string) --
InstanceType (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.
SecurityGroups (list) --
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.
(string) --
StorageInfo (dict) --
Contains information about storage volumes attached to MSK broker nodes.
EbsStorageInfo (dict) --
EBS volume information.
ProvisionedThroughput (dict) --
EBS volume provisioned throughput information.
Enabled (boolean) --
Provisioned throughput is enabled or not.
VolumeThroughput (integer) --
Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
VolumeSize (integer) --
The size in GiB of the EBS volume for the data drive on each broker node.
ConnectivityInfo (dict) --
Information about the broker access configuration.
PublicAccess (dict) --
Public access control for brokers.
Type (string) --
The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
VpcConnectivity (dict) --
VPC connectivity access control for brokers.
ClientAuthentication (dict) --
Includes all client authentication information for VPC connectivity.
Sasl (dict) --
SASL authentication type details for VPC connectivity.
Scram (dict) --
Details for SASL/SCRAM client authentication for VPC connectivity.
Enabled (boolean) --
SASL/SCRAM authentication is on or off for VPC connectivity.
Iam (dict) --
Details for SASL/IAM client authentication for VPC connectivity.
Enabled (boolean) --
SASL/IAM authentication is on or off for VPC connectivity.
Tls (dict) --
TLS authentication type details for VPC connectivity.
Enabled (boolean) --
TLS authentication is on or off for VPC connectivity.
ZoneIds (list) --
The list of zoneIds for the cluster in the virtual private cloud (VPC).
(string) --
ClientAuthentication (dict) --
Includes all client authentication information.
Sasl (dict) --
Details for ClientAuthentication using SASL.
Scram (dict) --
Details for SASL/SCRAM client authentication.
Enabled (boolean) --
SASL/SCRAM authentication is enabled or not.
Iam (dict) --
Indicates whether IAM access control is enabled.
Enabled (boolean) --
Indicates whether IAM access control is enabled.
Tls (dict) --
Details for ClientAuthentication using TLS.
CertificateAuthorityArnList (list) --
List of ACM Certificate Authority ARNs.
(string) --
Enabled (boolean) --
Specifies whether you want to turn on or turn off TLS authentication.
Unauthenticated (dict) --
Contains information about unauthenticated traffic to the cluster.
Enabled (boolean) --
Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
ClusterArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
ClusterName (string) --
The name of the cluster.
CreationTime (datetime) --
The time when the cluster was created.
CurrentBrokerSoftwareInfo (dict) --
Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.
ConfigurationArn (string) --
The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.
ConfigurationRevision (integer) --
The revision of the configuration to use. This field isn't visible in this preview release.
KafkaVersion (string) --
The version of Apache Kafka.
CurrentVersion (string) --
The current version of the MSK cluster.
EncryptionInfo (dict) --
Includes all encryption-related information.
EncryptionAtRest (dict) --
The data-volume encryption details.
DataVolumeKMSKeyId (string) --
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.
EncryptionInTransit (dict) --
The details for encryption in transit.
ClientBroker (string) --
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.
InCluster (boolean) --
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.
EnhancedMonitoring (string) --
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 (dict) --
Settings for open monitoring using Prometheus.
Prometheus (dict) --
Prometheus settings.
JmxExporter (dict) --
Indicates whether you want to turn on or turn off the JMX Exporter.
EnabledInBroker (boolean) --
Indicates whether you want to turn on or turn off the JMX Exporter.
NodeExporter (dict) --
Indicates whether you want to turn on or turn off the Node Exporter.
EnabledInBroker (boolean) --
Indicates whether you want to turn on or turn off the Node Exporter.
LoggingInfo (dict) --
BrokerLogs (dict) --
CloudWatchLogs (dict) --
Enabled (boolean) --
LogGroup (string) --
Firehose (dict) --
DeliveryStream (string) --
Enabled (boolean) --
S3 (dict) --
Bucket (string) --
Enabled (boolean) --
Prefix (string) --
NumberOfBrokerNodes (integer) --
The number of broker nodes in the cluster.
State (string) --
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
StateInfo (dict) --
Code (string) --
Message (string) --
Tags (dict) --
Tags attached to the cluster.
(string) --
(string) --
ZookeeperConnectString (string) --
The connection string to use to connect to the Apache ZooKeeper cluster.
ZookeeperConnectStringTls (string) --
The connection string to use to connect to zookeeper cluster on Tls port.
StorageMode (string) --
This controls storage mode for supported storage tiers.
{'ClusterInfo': {'Provisioned': {'BrokerNodeGroupInfo': {'ConnectivityInfo': {'VpcConnectivity': {'ClientAuthentication': {'Sasl': {'Iam': {'Enabled': 'boolean'},
'Scram': {'Enabled': 'boolean'}},
'Tls': {'Enabled': 'boolean'}}}},
'ZoneIds': ['string']}}}}
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
See also: AWS API Documentation
Request Syntax
client.describe_cluster_v2(
ClusterArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
dict
Response Syntax
{
'ClusterInfo': {
'ActiveOperationArn': 'string',
'ClusterType': 'PROVISIONED'|'SERVERLESS',
'ClusterArn': 'string',
'ClusterName': 'string',
'CreationTime': datetime(2015, 1, 1),
'CurrentVersion': 'string',
'State': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'HEALING'|'MAINTENANCE'|'REBOOTING_BROKER'|'UPDATING',
'StateInfo': {
'Code': 'string',
'Message': 'string'
},
'Tags': {
'string': 'string'
},
'Provisioned': {
'BrokerNodeGroupInfo': {
'BrokerAZDistribution': 'DEFAULT',
'ClientSubnets': [
'string',
],
'InstanceType': 'string',
'SecurityGroups': [
'string',
],
'StorageInfo': {
'EbsStorageInfo': {
'ProvisionedThroughput': {
'Enabled': True|False,
'VolumeThroughput': 123
},
'VolumeSize': 123
}
},
'ConnectivityInfo': {
'PublicAccess': {
'Type': 'string'
},
'VpcConnectivity': {
'ClientAuthentication': {
'Sasl': {
'Scram': {
'Enabled': True|False
},
'Iam': {
'Enabled': True|False
}
},
'Tls': {
'Enabled': True|False
}
}
}
},
'ZoneIds': [
'string',
]
},
'CurrentBrokerSoftwareInfo': {
'ConfigurationArn': 'string',
'ConfigurationRevision': 123,
'KafkaVersion': 'string'
},
'ClientAuthentication': {
'Sasl': {
'Scram': {
'Enabled': True|False
},
'Iam': {
'Enabled': True|False
}
},
'Tls': {
'CertificateAuthorityArnList': [
'string',
],
'Enabled': True|False
},
'Unauthenticated': {
'Enabled': True|False
}
},
'EncryptionInfo': {
'EncryptionAtRest': {
'DataVolumeKMSKeyId': 'string'
},
'EncryptionInTransit': {
'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT',
'InCluster': True|False
}
},
'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION',
'OpenMonitoring': {
'Prometheus': {
'JmxExporter': {
'EnabledInBroker': True|False
},
'NodeExporter': {
'EnabledInBroker': True|False
}
}
},
'LoggingInfo': {
'BrokerLogs': {
'CloudWatchLogs': {
'Enabled': True|False,
'LogGroup': 'string'
},
'Firehose': {
'DeliveryStream': 'string',
'Enabled': True|False
},
'S3': {
'Bucket': 'string',
'Enabled': True|False,
'Prefix': 'string'
}
}
},
'NumberOfBrokerNodes': 123,
'ZookeeperConnectString': 'string',
'ZookeeperConnectStringTls': 'string',
'StorageMode': 'LOCAL'|'TIERED'
},
'Serverless': {
'VpcConfigs': [
{
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
],
'ClientAuthentication': {
'Sasl': {
'Iam': {
'Enabled': True|False
}
}
}
}
}
}
Response Structure
(dict) --
Successful response.
ClusterInfo (dict) --
The cluster information.
ActiveOperationArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.
ClusterType (string) --
Cluster Type.
ClusterArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
ClusterName (string) --
The name of the cluster.
CreationTime (datetime) --
The time when the cluster was created.
CurrentVersion (string) --
The current version of the MSK cluster.
State (string) --
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
StateInfo (dict) --
State Info for the Amazon MSK cluster.
Code (string) --
Message (string) --
Tags (dict) --
Tags attached to the cluster.
(string) --
(string) --
Provisioned (dict) --
Information about the provisioned cluster.
BrokerNodeGroupInfo (dict) --
Information about the brokers.
BrokerAZDistribution (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.
ClientSubnets (list) --
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.
(string) --
InstanceType (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.
SecurityGroups (list) --
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.
(string) --
StorageInfo (dict) --
Contains information about storage volumes attached to MSK broker nodes.
EbsStorageInfo (dict) --
EBS volume information.
ProvisionedThroughput (dict) --
EBS volume provisioned throughput information.
Enabled (boolean) --
Provisioned throughput is enabled or not.
VolumeThroughput (integer) --
Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
VolumeSize (integer) --
The size in GiB of the EBS volume for the data drive on each broker node.
ConnectivityInfo (dict) --
Information about the broker access configuration.
PublicAccess (dict) --
Public access control for brokers.
Type (string) --
The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
VpcConnectivity (dict) --
VPC connectivity access control for brokers.
ClientAuthentication (dict) --
Includes all client authentication information for VPC connectivity.
Sasl (dict) --
SASL authentication type details for VPC connectivity.
Scram (dict) --
Details for SASL/SCRAM client authentication for VPC connectivity.
Enabled (boolean) --
SASL/SCRAM authentication is on or off for VPC connectivity.
Iam (dict) --
Details for SASL/IAM client authentication for VPC connectivity.
Enabled (boolean) --
SASL/IAM authentication is on or off for VPC connectivity.
Tls (dict) --
TLS authentication type details for VPC connectivity.
Enabled (boolean) --
TLS authentication is on or off for VPC connectivity.
ZoneIds (list) --
The list of zoneIds for the cluster in the virtual private cloud (VPC).
(string) --
CurrentBrokerSoftwareInfo (dict) --
Information about the Apache Kafka version deployed on the brokers.
ConfigurationArn (string) --
The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.
ConfigurationRevision (integer) --
The revision of the configuration to use. This field isn't visible in this preview release.
KafkaVersion (string) --
The version of Apache Kafka.
ClientAuthentication (dict) --
Includes all client authentication information.
Sasl (dict) --
Details for ClientAuthentication using SASL.
Scram (dict) --
Details for SASL/SCRAM client authentication.
Enabled (boolean) --
SASL/SCRAM authentication is enabled or not.
Iam (dict) --
Indicates whether IAM access control is enabled.
Enabled (boolean) --
Indicates whether IAM access control is enabled.
Tls (dict) --
Details for ClientAuthentication using TLS.
CertificateAuthorityArnList (list) --
List of ACM Certificate Authority ARNs.
(string) --
Enabled (boolean) --
Specifies whether you want to turn on or turn off TLS authentication.
Unauthenticated (dict) --
Contains information about unauthenticated traffic to the cluster.
Enabled (boolean) --
Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
EncryptionInfo (dict) --
Includes all encryption-related information.
EncryptionAtRest (dict) --
The data-volume encryption details.
DataVolumeKMSKeyId (string) --
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.
EncryptionInTransit (dict) --
The details for encryption in transit.
ClientBroker (string) --
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.
InCluster (boolean) --
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.
EnhancedMonitoring (string) --
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.
OpenMonitoring (dict) --
The settings for open monitoring.
Prometheus (dict) --
Prometheus settings.
JmxExporter (dict) --
Indicates whether you want to turn on or turn off the JMX Exporter.
EnabledInBroker (boolean) --
Indicates whether you want to turn on or turn off the JMX Exporter.
NodeExporter (dict) --
Indicates whether you want to turn on or turn off the Node Exporter.
EnabledInBroker (boolean) --
Indicates whether you want to turn on or turn off the Node Exporter.
LoggingInfo (dict) --
Log delivery information for the cluster.
BrokerLogs (dict) --
CloudWatchLogs (dict) --
Enabled (boolean) --
LogGroup (string) --
Firehose (dict) --
DeliveryStream (string) --
Enabled (boolean) --
S3 (dict) --
Bucket (string) --
Enabled (boolean) --
Prefix (string) --
NumberOfBrokerNodes (integer) --
The number of broker nodes in the cluster.
ZookeeperConnectString (string) --
The connection string to use to connect to the Apache ZooKeeper cluster.
ZookeeperConnectStringTls (string) --
The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port.
StorageMode (string) --
This controls storage mode for supported storage tiers.
Serverless (dict) --
Information about the serverless cluster.
VpcConfigs (list) --
The configuration of the Amazon VPCs for the cluster.
(dict) --
The configuration of the Amazon VPCs for the cluster.
SubnetIds (list) --
The IDs of the subnets associated with the cluster.
(string) --
SecurityGroupIds (list) --
The IDs of the security groups associated with the cluster.
(string) --
ClientAuthentication (dict) --
Includes all client authentication information.
Sasl (dict) --
Details for ClientAuthentication using SASL.
Iam (dict) --
Indicates whether IAM access control is enabled.
Enabled (boolean) --
Indicates whether IAM access control is enabled.
{'ClusterOperationInfo': {'SourceClusterInfo': {'ConnectivityInfo': {'VpcConnectivity': {'ClientAuthentication': {'Sasl': {'Iam': {'Enabled': 'boolean'},
'Scram': {'Enabled': 'boolean'}},
'Tls': {'Enabled': 'boolean'}}}}},
'TargetClusterInfo': {'ConnectivityInfo': {'VpcConnectivity': {'ClientAuthentication': {'Sasl': {'Iam': {'Enabled': 'boolean'},
'Scram': {'Enabled': 'boolean'}},
'Tls': {'Enabled': 'boolean'}}}}},
'VpcConnectionInfo': {'CreationTime': 'timestamp',
'Owner': 'string',
'UserIdentity': {'PrincipalId': 'string',
'Type': 'AWSACCOUNT '
'| '
'AWSSERVICE'},
'VpcConnectionArn': 'string'}}}
Returns a description of the cluster operation specified by the ARN.
See also: AWS API Documentation
Request Syntax
client.describe_cluster_operation(
ClusterOperationArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the MSK cluster operation.
dict
Response Syntax
{
'ClusterOperationInfo': {
'ClientRequestId': 'string',
'ClusterArn': 'string',
'CreationTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ErrorInfo': {
'ErrorCode': 'string',
'ErrorString': 'string'
},
'OperationArn': 'string',
'OperationState': 'string',
'OperationSteps': [
{
'StepInfo': {
'StepStatus': 'string'
},
'StepName': 'string'
},
],
'OperationType': 'string',
'SourceClusterInfo': {
'BrokerEBSVolumeInfo': [
{
'KafkaBrokerNodeId': 'string',
'ProvisionedThroughput': {
'Enabled': True|False,
'VolumeThroughput': 123
},
'VolumeSizeGB': 123
},
],
'ConfigurationInfo': {
'Arn': 'string',
'Revision': 123
},
'NumberOfBrokerNodes': 123,
'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION',
'OpenMonitoring': {
'Prometheus': {
'JmxExporter': {
'EnabledInBroker': True|False
},
'NodeExporter': {
'EnabledInBroker': True|False
}
}
},
'KafkaVersion': 'string',
'LoggingInfo': {
'BrokerLogs': {
'CloudWatchLogs': {
'Enabled': True|False,
'LogGroup': 'string'
},
'Firehose': {
'DeliveryStream': 'string',
'Enabled': True|False
},
'S3': {
'Bucket': 'string',
'Enabled': True|False,
'Prefix': 'string'
}
}
},
'InstanceType': 'string',
'ClientAuthentication': {
'Sasl': {
'Scram': {
'Enabled': True|False
},
'Iam': {
'Enabled': True|False
}
},
'Tls': {
'CertificateAuthorityArnList': [
'string',
],
'Enabled': True|False
},
'Unauthenticated': {
'Enabled': True|False
}
},
'EncryptionInfo': {
'EncryptionAtRest': {
'DataVolumeKMSKeyId': 'string'
},
'EncryptionInTransit': {
'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT',
'InCluster': True|False
}
},
'ConnectivityInfo': {
'PublicAccess': {
'Type': 'string'
},
'VpcConnectivity': {
'ClientAuthentication': {
'Sasl': {
'Scram': {
'Enabled': True|False
},
'Iam': {
'Enabled': True|False
}
},
'Tls': {
'Enabled': True|False
}
}
}
},
'StorageMode': 'LOCAL'|'TIERED'
},
'TargetClusterInfo': {
'BrokerEBSVolumeInfo': [
{
'KafkaBrokerNodeId': 'string',
'ProvisionedThroughput': {
'Enabled': True|False,
'VolumeThroughput': 123
},
'VolumeSizeGB': 123
},
],
'ConfigurationInfo': {
'Arn': 'string',
'Revision': 123
},
'NumberOfBrokerNodes': 123,
'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION',
'OpenMonitoring': {
'Prometheus': {
'JmxExporter': {
'EnabledInBroker': True|False
},
'NodeExporter': {
'EnabledInBroker': True|False
}
}
},
'KafkaVersion': 'string',
'LoggingInfo': {
'BrokerLogs': {
'CloudWatchLogs': {
'Enabled': True|False,
'LogGroup': 'string'
},
'Firehose': {
'DeliveryStream': 'string',
'Enabled': True|False
},
'S3': {
'Bucket': 'string',
'Enabled': True|False,
'Prefix': 'string'
}
}
},
'InstanceType': 'string',
'ClientAuthentication': {
'Sasl': {
'Scram': {
'Enabled': True|False
},
'Iam': {
'Enabled': True|False
}
},
'Tls': {
'CertificateAuthorityArnList': [
'string',
],
'Enabled': True|False
},
'Unauthenticated': {
'Enabled': True|False
}
},
'EncryptionInfo': {
'EncryptionAtRest': {
'DataVolumeKMSKeyId': 'string'
},
'EncryptionInTransit': {
'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT',
'InCluster': True|False
}
},
'ConnectivityInfo': {
'PublicAccess': {
'Type': 'string'
},
'VpcConnectivity': {
'ClientAuthentication': {
'Sasl': {
'Scram': {
'Enabled': True|False
},
'Iam': {
'Enabled': True|False
}
},
'Tls': {
'Enabled': True|False
}
}
}
},
'StorageMode': 'LOCAL'|'TIERED'
},
'VpcConnectionInfo': {
'VpcConnectionArn': 'string',
'Owner': 'string',
'UserIdentity': {
'Type': 'AWSACCOUNT'|'AWSSERVICE',
'PrincipalId': 'string'
},
'CreationTime': datetime(2015, 1, 1)
}
}
}
Response Structure
(dict) --
200 response
ClusterOperationInfo (dict) --
Cluster operation information
ClientRequestId (string) --
The ID of the API request that triggered this operation.
ClusterArn (string) --
ARN of the cluster.
CreationTime (datetime) --
The time that the operation was created.
EndTime (datetime) --
The time at which the operation finished.
ErrorInfo (dict) --
Describes the error if the operation fails.
ErrorCode (string) --
A number describing the error programmatically.
ErrorString (string) --
An optional field to provide more details about the error.
OperationArn (string) --
ARN of the cluster operation.
OperationState (string) --
State of the cluster operation.
OperationSteps (list) --
Steps completed during the operation.
(dict) --
Step taken during a cluster operation.
StepInfo (dict) --
Information about the step and its status.
StepStatus (string) --
The steps current status.
StepName (string) --
The name of the step.
OperationType (string) --
Type of the cluster operation.
SourceClusterInfo (dict) --
Information about cluster attributes before a cluster is updated.
BrokerEBSVolumeInfo (list) --
Specifies the size of the EBS volume and the ID of the associated broker.
(dict) --
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.
KafkaBrokerNodeId (string) --
The ID of the broker to update.
ProvisionedThroughput (dict) --
EBS volume provisioned throughput information.
Enabled (boolean) --
Provisioned throughput is enabled or not.
VolumeThroughput (integer) --
Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
VolumeSizeGB (integer) --
Size of the EBS volume to update.
ConfigurationInfo (dict) --
Information about the changes in the configuration of the brokers.
Arn (string) --
ARN of the configuration to use.
Revision (integer) --
The revision of the configuration to use.
NumberOfBrokerNodes (integer) --
The number of broker nodes in the cluster.
EnhancedMonitoring (string) --
Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
OpenMonitoring (dict) --
The settings for open monitoring.
Prometheus (dict) --
Prometheus settings.
JmxExporter (dict) --
Indicates whether you want to turn on or turn off the JMX Exporter.
EnabledInBroker (boolean) --
Indicates whether you want to turn on or turn off the JMX Exporter.
NodeExporter (dict) --
Indicates whether you want to turn on or turn off the Node Exporter.
EnabledInBroker (boolean) --
Indicates whether you want to turn on or turn off the Node Exporter.
KafkaVersion (string) --
The Apache Kafka version.
LoggingInfo (dict) --
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.
BrokerLogs (dict) --
CloudWatchLogs (dict) --
Enabled (boolean) --
LogGroup (string) --
Firehose (dict) --
DeliveryStream (string) --
Enabled (boolean) --
S3 (dict) --
Bucket (string) --
Enabled (boolean) --
Prefix (string) --
InstanceType (string) --
Information about the Amazon MSK broker type.
ClientAuthentication (dict) --
Includes all client authentication information.
Sasl (dict) --
Details for ClientAuthentication using SASL.
Scram (dict) --
Details for SASL/SCRAM client authentication.
Enabled (boolean) --
SASL/SCRAM authentication is enabled or not.
Iam (dict) --
Indicates whether IAM access control is enabled.
Enabled (boolean) --
Indicates whether IAM access control is enabled.
Tls (dict) --
Details for ClientAuthentication using TLS.
CertificateAuthorityArnList (list) --
List of ACM Certificate Authority ARNs.
(string) --
Enabled (boolean) --
Specifies whether you want to turn on or turn off TLS authentication.
Unauthenticated (dict) --
Contains information about unauthenticated traffic to the cluster.
Enabled (boolean) --
Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
EncryptionInfo (dict) --
Includes all encryption-related information.
EncryptionAtRest (dict) --
The data-volume encryption details.
DataVolumeKMSKeyId (string) --
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.
EncryptionInTransit (dict) --
The details for encryption in transit.
ClientBroker (string) --
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.
InCluster (boolean) --
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.
ConnectivityInfo (dict) --
Information about the broker access configuration.
PublicAccess (dict) --
Public access control for brokers.
Type (string) --
The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
VpcConnectivity (dict) --
VPC connectivity access control for brokers.
ClientAuthentication (dict) --
Includes all client authentication information for VPC connectivity.
Sasl (dict) --
SASL authentication type details for VPC connectivity.
Scram (dict) --
Details for SASL/SCRAM client authentication for VPC connectivity.
Enabled (boolean) --
SASL/SCRAM authentication is on or off for VPC connectivity.
Iam (dict) --
Details for SASL/IAM client authentication for VPC connectivity.
Enabled (boolean) --
SASL/IAM authentication is on or off for VPC connectivity.
Tls (dict) --
TLS authentication type details for VPC connectivity.
Enabled (boolean) --
TLS authentication is on or off for VPC connectivity.
StorageMode (string) --
This controls storage mode for supported storage tiers.
TargetClusterInfo (dict) --
Information about cluster attributes after a cluster is updated.
BrokerEBSVolumeInfo (list) --
Specifies the size of the EBS volume and the ID of the associated broker.
(dict) --
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.
KafkaBrokerNodeId (string) --
The ID of the broker to update.
ProvisionedThroughput (dict) --
EBS volume provisioned throughput information.
Enabled (boolean) --
Provisioned throughput is enabled or not.
VolumeThroughput (integer) --
Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
VolumeSizeGB (integer) --
Size of the EBS volume to update.
ConfigurationInfo (dict) --
Information about the changes in the configuration of the brokers.
Arn (string) --
ARN of the configuration to use.
Revision (integer) --
The revision of the configuration to use.
NumberOfBrokerNodes (integer) --
The number of broker nodes in the cluster.
EnhancedMonitoring (string) --
Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
OpenMonitoring (dict) --
The settings for open monitoring.
Prometheus (dict) --
Prometheus settings.
JmxExporter (dict) --
Indicates whether you want to turn on or turn off the JMX Exporter.
EnabledInBroker (boolean) --
Indicates whether you want to turn on or turn off the JMX Exporter.
NodeExporter (dict) --
Indicates whether you want to turn on or turn off the Node Exporter.
EnabledInBroker (boolean) --
Indicates whether you want to turn on or turn off the Node Exporter.
KafkaVersion (string) --
The Apache Kafka version.
LoggingInfo (dict) --
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.
BrokerLogs (dict) --
CloudWatchLogs (dict) --
Enabled (boolean) --
LogGroup (string) --
Firehose (dict) --
DeliveryStream (string) --
Enabled (boolean) --
S3 (dict) --
Bucket (string) --
Enabled (boolean) --
Prefix (string) --
InstanceType (string) --
Information about the Amazon MSK broker type.
ClientAuthentication (dict) --
Includes all client authentication information.
Sasl (dict) --
Details for ClientAuthentication using SASL.
Scram (dict) --
Details for SASL/SCRAM client authentication.
Enabled (boolean) --
SASL/SCRAM authentication is enabled or not.
Iam (dict) --
Indicates whether IAM access control is enabled.
Enabled (boolean) --
Indicates whether IAM access control is enabled.
Tls (dict) --
Details for ClientAuthentication using TLS.
CertificateAuthorityArnList (list) --
List of ACM Certificate Authority ARNs.
(string) --
Enabled (boolean) --
Specifies whether you want to turn on or turn off TLS authentication.
Unauthenticated (dict) --
Contains information about unauthenticated traffic to the cluster.
Enabled (boolean) --
Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
EncryptionInfo (dict) --
Includes all encryption-related information.
EncryptionAtRest (dict) --
The data-volume encryption details.
DataVolumeKMSKeyId (string) --
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.
EncryptionInTransit (dict) --
The details for encryption in transit.
ClientBroker (string) --
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.
InCluster (boolean) --
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.
ConnectivityInfo (dict) --
Information about the broker access configuration.
PublicAccess (dict) --
Public access control for brokers.
Type (string) --
The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
VpcConnectivity (dict) --
VPC connectivity access control for brokers.
ClientAuthentication (dict) --
Includes all client authentication information for VPC connectivity.
Sasl (dict) --
SASL authentication type details for VPC connectivity.
Scram (dict) --
Details for SASL/SCRAM client authentication for VPC connectivity.
Enabled (boolean) --
SASL/SCRAM authentication is on or off for VPC connectivity.
Iam (dict) --
Details for SASL/IAM client authentication for VPC connectivity.
Enabled (boolean) --
SASL/IAM authentication is on or off for VPC connectivity.
Tls (dict) --
TLS authentication type details for VPC connectivity.
Enabled (boolean) --
TLS authentication is on or off for VPC connectivity.
StorageMode (string) --
This controls storage mode for supported storage tiers.
VpcConnectionInfo (dict) --
Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) of the VPC connection.
Owner (string) --
The owner of the VPC Connection.
UserIdentity (dict) --
Description of the requester that calls the API operation.
Type (string) --
The identity type of the requester that calls the API operation.
PrincipalId (string) --
A unique identifier for the requester that calls the API operation.
CreationTime (datetime) --
The time when Amazon MSK creates the VPC Connnection.
{'BootstrapBrokerStringVpcConnectivitySaslIam': 'string',
'BootstrapBrokerStringVpcConnectivitySaslScram': 'string',
'BootstrapBrokerStringVpcConnectivityTls': 'string'}
A list of brokers that a client application can use to bootstrap.
See also: AWS API Documentation
Request Syntax
client.get_bootstrap_brokers(
ClusterArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
dict
Response Syntax
{
'BootstrapBrokerString': 'string',
'BootstrapBrokerStringTls': 'string',
'BootstrapBrokerStringSaslScram': 'string',
'BootstrapBrokerStringSaslIam': 'string',
'BootstrapBrokerStringPublicTls': 'string',
'BootstrapBrokerStringPublicSaslScram': 'string',
'BootstrapBrokerStringPublicSaslIam': 'string',
'BootstrapBrokerStringVpcConnectivityTls': 'string',
'BootstrapBrokerStringVpcConnectivitySaslScram': 'string',
'BootstrapBrokerStringVpcConnectivitySaslIam': 'string'
}
Response Structure
(dict) --
Successful response.
BootstrapBrokerString (string) --
A string containing one or more hostname:port pairs.
BootstrapBrokerStringTls (string) --
A string containing one or more DNS names (or IP) and TLS port pairs.
BootstrapBrokerStringSaslScram (string) --
A string containing one or more DNS names (or IP) and Sasl Scram port pairs.
BootstrapBrokerStringSaslIam (string) --
A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.
BootstrapBrokerStringPublicTls (string) --
A string containing one or more DNS names (or IP) and TLS port pairs.
BootstrapBrokerStringPublicSaslScram (string) --
A string containing one or more DNS names (or IP) and Sasl Scram port pairs.
BootstrapBrokerStringPublicSaslIam (string) --
A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.
BootstrapBrokerStringVpcConnectivityTls (string) --
A string containing one or more DNS names (or IP) and TLS port pairs for VPC connectivity.
BootstrapBrokerStringVpcConnectivitySaslScram (string) --
A string containing one or more DNS names (or IP) and SASL/SCRAM port pairs for VPC connectivity.
BootstrapBrokerStringVpcConnectivitySaslIam (string) --
A string containing one or more DNS names (or IP) and SASL/IAM port pairs for VPC connectivity.
{'ClusterOperationInfoList': {'SourceClusterInfo': {'ConnectivityInfo': {'VpcConnectivity': {'ClientAuthentication': {'Sasl': {'Iam': {'Enabled': 'boolean'},
'Scram': {'Enabled': 'boolean'}},
'Tls': {'Enabled': 'boolean'}}}}},
'TargetClusterInfo': {'ConnectivityInfo': {'VpcConnectivity': {'ClientAuthentication': {'Sasl': {'Iam': {'Enabled': 'boolean'},
'Scram': {'Enabled': 'boolean'}},
'Tls': {'Enabled': 'boolean'}}}}},
'VpcConnectionInfo': {'CreationTime': 'timestamp',
'Owner': 'string',
'UserIdentity': {'PrincipalId': 'string',
'Type': 'AWSACCOUNT '
'| '
'AWSSERVICE'},
'VpcConnectionArn': 'string'}}}
Returns a list of all the operations that have been performed on the specified MSK cluster.
See also: AWS API Documentation
Request Syntax
client.list_cluster_operations(
ClusterArn='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
integer
The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
string
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.
dict
Response Syntax
{
'ClusterOperationInfoList': [
{
'ClientRequestId': 'string',
'ClusterArn': 'string',
'CreationTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ErrorInfo': {
'ErrorCode': 'string',
'ErrorString': 'string'
},
'OperationArn': 'string',
'OperationState': 'string',
'OperationSteps': [
{
'StepInfo': {
'StepStatus': 'string'
},
'StepName': 'string'
},
],
'OperationType': 'string',
'SourceClusterInfo': {
'BrokerEBSVolumeInfo': [
{
'KafkaBrokerNodeId': 'string',
'ProvisionedThroughput': {
'Enabled': True|False,
'VolumeThroughput': 123
},
'VolumeSizeGB': 123
},
],
'ConfigurationInfo': {
'Arn': 'string',
'Revision': 123
},
'NumberOfBrokerNodes': 123,
'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION',
'OpenMonitoring': {
'Prometheus': {
'JmxExporter': {
'EnabledInBroker': True|False
},
'NodeExporter': {
'EnabledInBroker': True|False
}
}
},
'KafkaVersion': 'string',
'LoggingInfo': {
'BrokerLogs': {
'CloudWatchLogs': {
'Enabled': True|False,
'LogGroup': 'string'
},
'Firehose': {
'DeliveryStream': 'string',
'Enabled': True|False
},
'S3': {
'Bucket': 'string',
'Enabled': True|False,
'Prefix': 'string'
}
}
},
'InstanceType': 'string',
'ClientAuthentication': {
'Sasl': {
'Scram': {
'Enabled': True|False
},
'Iam': {
'Enabled': True|False
}
},
'Tls': {
'CertificateAuthorityArnList': [
'string',
],
'Enabled': True|False
},
'Unauthenticated': {
'Enabled': True|False
}
},
'EncryptionInfo': {
'EncryptionAtRest': {
'DataVolumeKMSKeyId': 'string'
},
'EncryptionInTransit': {
'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT',
'InCluster': True|False
}
},
'ConnectivityInfo': {
'PublicAccess': {
'Type': 'string'
},
'VpcConnectivity': {
'ClientAuthentication': {
'Sasl': {
'Scram': {
'Enabled': True|False
},
'Iam': {
'Enabled': True|False
}
},
'Tls': {
'Enabled': True|False
}
}
}
},
'StorageMode': 'LOCAL'|'TIERED'
},
'TargetClusterInfo': {
'BrokerEBSVolumeInfo': [
{
'KafkaBrokerNodeId': 'string',
'ProvisionedThroughput': {
'Enabled': True|False,
'VolumeThroughput': 123
},
'VolumeSizeGB': 123
},
],
'ConfigurationInfo': {
'Arn': 'string',
'Revision': 123
},
'NumberOfBrokerNodes': 123,
'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION',
'OpenMonitoring': {
'Prometheus': {
'JmxExporter': {
'EnabledInBroker': True|False
},
'NodeExporter': {
'EnabledInBroker': True|False
}
}
},
'KafkaVersion': 'string',
'LoggingInfo': {
'BrokerLogs': {
'CloudWatchLogs': {
'Enabled': True|False,
'LogGroup': 'string'
},
'Firehose': {
'DeliveryStream': 'string',
'Enabled': True|False
},
'S3': {
'Bucket': 'string',
'Enabled': True|False,
'Prefix': 'string'
}
}
},
'InstanceType': 'string',
'ClientAuthentication': {
'Sasl': {
'Scram': {
'Enabled': True|False
},
'Iam': {
'Enabled': True|False
}
},
'Tls': {
'CertificateAuthorityArnList': [
'string',
],
'Enabled': True|False
},
'Unauthenticated': {
'Enabled': True|False
}
},
'EncryptionInfo': {
'EncryptionAtRest': {
'DataVolumeKMSKeyId': 'string'
},
'EncryptionInTransit': {
'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT',
'InCluster': True|False
}
},
'ConnectivityInfo': {
'PublicAccess': {
'Type': 'string'
},
'VpcConnectivity': {
'ClientAuthentication': {
'Sasl': {
'Scram': {
'Enabled': True|False
},
'Iam': {
'Enabled': True|False
}
},
'Tls': {
'Enabled': True|False
}
}
}
},
'StorageMode': 'LOCAL'|'TIERED'
},
'VpcConnectionInfo': {
'VpcConnectionArn': 'string',
'Owner': 'string',
'UserIdentity': {
'Type': 'AWSACCOUNT'|'AWSSERVICE',
'PrincipalId': 'string'
},
'CreationTime': datetime(2015, 1, 1)
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Successful response.
ClusterOperationInfoList (list) --
An array of cluster operation information objects.
(dict) --
Returns information about a cluster operation.
ClientRequestId (string) --
The ID of the API request that triggered this operation.
ClusterArn (string) --
ARN of the cluster.
CreationTime (datetime) --
The time that the operation was created.
EndTime (datetime) --
The time at which the operation finished.
ErrorInfo (dict) --
Describes the error if the operation fails.
ErrorCode (string) --
A number describing the error programmatically.
ErrorString (string) --
An optional field to provide more details about the error.
OperationArn (string) --
ARN of the cluster operation.
OperationState (string) --
State of the cluster operation.
OperationSteps (list) --
Steps completed during the operation.
(dict) --
Step taken during a cluster operation.
StepInfo (dict) --
Information about the step and its status.
StepStatus (string) --
The steps current status.
StepName (string) --
The name of the step.
OperationType (string) --
Type of the cluster operation.
SourceClusterInfo (dict) --
Information about cluster attributes before a cluster is updated.
BrokerEBSVolumeInfo (list) --
Specifies the size of the EBS volume and the ID of the associated broker.
(dict) --
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.
KafkaBrokerNodeId (string) --
The ID of the broker to update.
ProvisionedThroughput (dict) --
EBS volume provisioned throughput information.
Enabled (boolean) --
Provisioned throughput is enabled or not.
VolumeThroughput (integer) --
Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
VolumeSizeGB (integer) --
Size of the EBS volume to update.
ConfigurationInfo (dict) --
Information about the changes in the configuration of the brokers.
Arn (string) --
ARN of the configuration to use.
Revision (integer) --
The revision of the configuration to use.
NumberOfBrokerNodes (integer) --
The number of broker nodes in the cluster.
EnhancedMonitoring (string) --
Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
OpenMonitoring (dict) --
The settings for open monitoring.
Prometheus (dict) --
Prometheus settings.
JmxExporter (dict) --
Indicates whether you want to turn on or turn off the JMX Exporter.
EnabledInBroker (boolean) --
Indicates whether you want to turn on or turn off the JMX Exporter.
NodeExporter (dict) --
Indicates whether you want to turn on or turn off the Node Exporter.
EnabledInBroker (boolean) --
Indicates whether you want to turn on or turn off the Node Exporter.
KafkaVersion (string) --
The Apache Kafka version.
LoggingInfo (dict) --
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.
BrokerLogs (dict) --
CloudWatchLogs (dict) --
Enabled (boolean) --
LogGroup (string) --
Firehose (dict) --
DeliveryStream (string) --
Enabled (boolean) --
S3 (dict) --
Bucket (string) --
Enabled (boolean) --
Prefix (string) --
InstanceType (string) --
Information about the Amazon MSK broker type.
ClientAuthentication (dict) --
Includes all client authentication information.
Sasl (dict) --
Details for ClientAuthentication using SASL.
Scram (dict) --
Details for SASL/SCRAM client authentication.
Enabled (boolean) --
SASL/SCRAM authentication is enabled or not.
Iam (dict) --
Indicates whether IAM access control is enabled.
Enabled (boolean) --
Indicates whether IAM access control is enabled.
Tls (dict) --
Details for ClientAuthentication using TLS.
CertificateAuthorityArnList (list) --
List of ACM Certificate Authority ARNs.
(string) --
Enabled (boolean) --
Specifies whether you want to turn on or turn off TLS authentication.
Unauthenticated (dict) --
Contains information about unauthenticated traffic to the cluster.
Enabled (boolean) --
Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
EncryptionInfo (dict) --
Includes all encryption-related information.
EncryptionAtRest (dict) --
The data-volume encryption details.
DataVolumeKMSKeyId (string) --
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.
EncryptionInTransit (dict) --
The details for encryption in transit.
ClientBroker (string) --
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.
InCluster (boolean) --
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.
ConnectivityInfo (dict) --
Information about the broker access configuration.
PublicAccess (dict) --
Public access control for brokers.
Type (string) --
The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
VpcConnectivity (dict) --
VPC connectivity access control for brokers.
ClientAuthentication (dict) --
Includes all client authentication information for VPC connectivity.
Sasl (dict) --
SASL authentication type details for VPC connectivity.
Scram (dict) --
Details for SASL/SCRAM client authentication for VPC connectivity.
Enabled (boolean) --
SASL/SCRAM authentication is on or off for VPC connectivity.
Iam (dict) --
Details for SASL/IAM client authentication for VPC connectivity.
Enabled (boolean) --
SASL/IAM authentication is on or off for VPC connectivity.
Tls (dict) --
TLS authentication type details for VPC connectivity.
Enabled (boolean) --
TLS authentication is on or off for VPC connectivity.
StorageMode (string) --
This controls storage mode for supported storage tiers.
TargetClusterInfo (dict) --
Information about cluster attributes after a cluster is updated.
BrokerEBSVolumeInfo (list) --
Specifies the size of the EBS volume and the ID of the associated broker.
(dict) --
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.
KafkaBrokerNodeId (string) --
The ID of the broker to update.
ProvisionedThroughput (dict) --
EBS volume provisioned throughput information.
Enabled (boolean) --
Provisioned throughput is enabled or not.
VolumeThroughput (integer) --
Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
VolumeSizeGB (integer) --
Size of the EBS volume to update.
ConfigurationInfo (dict) --
Information about the changes in the configuration of the brokers.
Arn (string) --
ARN of the configuration to use.
Revision (integer) --
The revision of the configuration to use.
NumberOfBrokerNodes (integer) --
The number of broker nodes in the cluster.
EnhancedMonitoring (string) --
Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
OpenMonitoring (dict) --
The settings for open monitoring.
Prometheus (dict) --
Prometheus settings.
JmxExporter (dict) --
Indicates whether you want to turn on or turn off the JMX Exporter.
EnabledInBroker (boolean) --
Indicates whether you want to turn on or turn off the JMX Exporter.
NodeExporter (dict) --
Indicates whether you want to turn on or turn off the Node Exporter.
EnabledInBroker (boolean) --
Indicates whether you want to turn on or turn off the Node Exporter.
KafkaVersion (string) --
The Apache Kafka version.
LoggingInfo (dict) --
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.
BrokerLogs (dict) --
CloudWatchLogs (dict) --
Enabled (boolean) --
LogGroup (string) --
Firehose (dict) --
DeliveryStream (string) --
Enabled (boolean) --
S3 (dict) --
Bucket (string) --
Enabled (boolean) --
Prefix (string) --
InstanceType (string) --
Information about the Amazon MSK broker type.
ClientAuthentication (dict) --
Includes all client authentication information.
Sasl (dict) --
Details for ClientAuthentication using SASL.
Scram (dict) --
Details for SASL/SCRAM client authentication.
Enabled (boolean) --
SASL/SCRAM authentication is enabled or not.
Iam (dict) --
Indicates whether IAM access control is enabled.
Enabled (boolean) --
Indicates whether IAM access control is enabled.
Tls (dict) --
Details for ClientAuthentication using TLS.
CertificateAuthorityArnList (list) --
List of ACM Certificate Authority ARNs.
(string) --
Enabled (boolean) --
Specifies whether you want to turn on or turn off TLS authentication.
Unauthenticated (dict) --
Contains information about unauthenticated traffic to the cluster.
Enabled (boolean) --
Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
EncryptionInfo (dict) --
Includes all encryption-related information.
EncryptionAtRest (dict) --
The data-volume encryption details.
DataVolumeKMSKeyId (string) --
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.
EncryptionInTransit (dict) --
The details for encryption in transit.
ClientBroker (string) --
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.
InCluster (boolean) --
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.
ConnectivityInfo (dict) --
Information about the broker access configuration.
PublicAccess (dict) --
Public access control for brokers.
Type (string) --
The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
VpcConnectivity (dict) --
VPC connectivity access control for brokers.
ClientAuthentication (dict) --
Includes all client authentication information for VPC connectivity.
Sasl (dict) --
SASL authentication type details for VPC connectivity.
Scram (dict) --
Details for SASL/SCRAM client authentication for VPC connectivity.
Enabled (boolean) --
SASL/SCRAM authentication is on or off for VPC connectivity.
Iam (dict) --
Details for SASL/IAM client authentication for VPC connectivity.
Enabled (boolean) --
SASL/IAM authentication is on or off for VPC connectivity.
Tls (dict) --
TLS authentication type details for VPC connectivity.
Enabled (boolean) --
TLS authentication is on or off for VPC connectivity.
StorageMode (string) --
This controls storage mode for supported storage tiers.
VpcConnectionInfo (dict) --
Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) of the VPC connection.
Owner (string) --
The owner of the VPC Connection.
UserIdentity (dict) --
Description of the requester that calls the API operation.
Type (string) --
The identity type of the requester that calls the API operation.
PrincipalId (string) --
A unique identifier for the requester that calls the API operation.
CreationTime (datetime) --
The time when Amazon MSK creates the VPC Connnection.
NextToken (string) --
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.
{'ClusterInfoList': {'BrokerNodeGroupInfo': {'ConnectivityInfo': {'VpcConnectivity': {'ClientAuthentication': {'Sasl': {'Iam': {'Enabled': 'boolean'},
'Scram': {'Enabled': 'boolean'}},
'Tls': {'Enabled': 'boolean'}}}},
'ZoneIds': ['string']}}}
Returns a list of all the MSK clusters in the current Region.
See also: AWS API Documentation
Request Syntax
client.list_clusters(
ClusterNameFilter='string',
MaxResults=123,
NextToken='string'
)
string
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
The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
string
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.
dict
Response Syntax
{
'ClusterInfoList': [
{
'ActiveOperationArn': 'string',
'BrokerNodeGroupInfo': {
'BrokerAZDistribution': 'DEFAULT',
'ClientSubnets': [
'string',
],
'InstanceType': 'string',
'SecurityGroups': [
'string',
],
'StorageInfo': {
'EbsStorageInfo': {
'ProvisionedThroughput': {
'Enabled': True|False,
'VolumeThroughput': 123
},
'VolumeSize': 123
}
},
'ConnectivityInfo': {
'PublicAccess': {
'Type': 'string'
},
'VpcConnectivity': {
'ClientAuthentication': {
'Sasl': {
'Scram': {
'Enabled': True|False
},
'Iam': {
'Enabled': True|False
}
},
'Tls': {
'Enabled': True|False
}
}
}
},
'ZoneIds': [
'string',
]
},
'ClientAuthentication': {
'Sasl': {
'Scram': {
'Enabled': True|False
},
'Iam': {
'Enabled': True|False
}
},
'Tls': {
'CertificateAuthorityArnList': [
'string',
],
'Enabled': True|False
},
'Unauthenticated': {
'Enabled': True|False
}
},
'ClusterArn': 'string',
'ClusterName': 'string',
'CreationTime': datetime(2015, 1, 1),
'CurrentBrokerSoftwareInfo': {
'ConfigurationArn': 'string',
'ConfigurationRevision': 123,
'KafkaVersion': 'string'
},
'CurrentVersion': 'string',
'EncryptionInfo': {
'EncryptionAtRest': {
'DataVolumeKMSKeyId': 'string'
},
'EncryptionInTransit': {
'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT',
'InCluster': True|False
}
},
'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION',
'OpenMonitoring': {
'Prometheus': {
'JmxExporter': {
'EnabledInBroker': True|False
},
'NodeExporter': {
'EnabledInBroker': True|False
}
}
},
'LoggingInfo': {
'BrokerLogs': {
'CloudWatchLogs': {
'Enabled': True|False,
'LogGroup': 'string'
},
'Firehose': {
'DeliveryStream': 'string',
'Enabled': True|False
},
'S3': {
'Bucket': 'string',
'Enabled': True|False,
'Prefix': 'string'
}
}
},
'NumberOfBrokerNodes': 123,
'State': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'HEALING'|'MAINTENANCE'|'REBOOTING_BROKER'|'UPDATING',
'StateInfo': {
'Code': 'string',
'Message': 'string'
},
'Tags': {
'string': 'string'
},
'ZookeeperConnectString': 'string',
'ZookeeperConnectStringTls': 'string',
'StorageMode': 'LOCAL'|'TIERED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Successful response.
ClusterInfoList (list) --
Information on each of the MSK clusters in the response.
(dict) --
Returns information about a cluster.
ActiveOperationArn (string) --
Arn of active cluster operation.
BrokerNodeGroupInfo (dict) --
Information about the broker nodes.
BrokerAZDistribution (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.
ClientSubnets (list) --
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.
(string) --
InstanceType (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.
SecurityGroups (list) --
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.
(string) --
StorageInfo (dict) --
Contains information about storage volumes attached to MSK broker nodes.
EbsStorageInfo (dict) --
EBS volume information.
ProvisionedThroughput (dict) --
EBS volume provisioned throughput information.
Enabled (boolean) --
Provisioned throughput is enabled or not.
VolumeThroughput (integer) --
Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
VolumeSize (integer) --
The size in GiB of the EBS volume for the data drive on each broker node.
ConnectivityInfo (dict) --
Information about the broker access configuration.
PublicAccess (dict) --
Public access control for brokers.
Type (string) --
The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
VpcConnectivity (dict) --
VPC connectivity access control for brokers.
ClientAuthentication (dict) --
Includes all client authentication information for VPC connectivity.
Sasl (dict) --
SASL authentication type details for VPC connectivity.
Scram (dict) --
Details for SASL/SCRAM client authentication for VPC connectivity.
Enabled (boolean) --
SASL/SCRAM authentication is on or off for VPC connectivity.
Iam (dict) --
Details for SASL/IAM client authentication for VPC connectivity.
Enabled (boolean) --
SASL/IAM authentication is on or off for VPC connectivity.
Tls (dict) --
TLS authentication type details for VPC connectivity.
Enabled (boolean) --
TLS authentication is on or off for VPC connectivity.
ZoneIds (list) --
The list of zoneIds for the cluster in the virtual private cloud (VPC).
(string) --
ClientAuthentication (dict) --
Includes all client authentication information.
Sasl (dict) --
Details for ClientAuthentication using SASL.
Scram (dict) --
Details for SASL/SCRAM client authentication.
Enabled (boolean) --
SASL/SCRAM authentication is enabled or not.
Iam (dict) --
Indicates whether IAM access control is enabled.
Enabled (boolean) --
Indicates whether IAM access control is enabled.
Tls (dict) --
Details for ClientAuthentication using TLS.
CertificateAuthorityArnList (list) --
List of ACM Certificate Authority ARNs.
(string) --
Enabled (boolean) --
Specifies whether you want to turn on or turn off TLS authentication.
Unauthenticated (dict) --
Contains information about unauthenticated traffic to the cluster.
Enabled (boolean) --
Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
ClusterArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
ClusterName (string) --
The name of the cluster.
CreationTime (datetime) --
The time when the cluster was created.
CurrentBrokerSoftwareInfo (dict) --
Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.
ConfigurationArn (string) --
The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.
ConfigurationRevision (integer) --
The revision of the configuration to use. This field isn't visible in this preview release.
KafkaVersion (string) --
The version of Apache Kafka.
CurrentVersion (string) --
The current version of the MSK cluster.
EncryptionInfo (dict) --
Includes all encryption-related information.
EncryptionAtRest (dict) --
The data-volume encryption details.
DataVolumeKMSKeyId (string) --
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.
EncryptionInTransit (dict) --
The details for encryption in transit.
ClientBroker (string) --
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.
InCluster (boolean) --
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.
EnhancedMonitoring (string) --
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 (dict) --
Settings for open monitoring using Prometheus.
Prometheus (dict) --
Prometheus settings.
JmxExporter (dict) --
Indicates whether you want to turn on or turn off the JMX Exporter.
EnabledInBroker (boolean) --
Indicates whether you want to turn on or turn off the JMX Exporter.
NodeExporter (dict) --
Indicates whether you want to turn on or turn off the Node Exporter.
EnabledInBroker (boolean) --
Indicates whether you want to turn on or turn off the Node Exporter.
LoggingInfo (dict) --
BrokerLogs (dict) --
CloudWatchLogs (dict) --
Enabled (boolean) --
LogGroup (string) --
Firehose (dict) --
DeliveryStream (string) --
Enabled (boolean) --
S3 (dict) --
Bucket (string) --
Enabled (boolean) --
Prefix (string) --
NumberOfBrokerNodes (integer) --
The number of broker nodes in the cluster.
State (string) --
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
StateInfo (dict) --
Code (string) --
Message (string) --
Tags (dict) --
Tags attached to the cluster.
(string) --
(string) --
ZookeeperConnectString (string) --
The connection string to use to connect to the Apache ZooKeeper cluster.
ZookeeperConnectStringTls (string) --
The connection string to use to connect to zookeeper cluster on Tls port.
StorageMode (string) --
This controls storage mode for supported storage tiers.
NextToken (string) --
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.
{'ClusterInfoList': {'Provisioned': {'BrokerNodeGroupInfo': {'ConnectivityInfo': {'VpcConnectivity': {'ClientAuthentication': {'Sasl': {'Iam': {'Enabled': 'boolean'},
'Scram': {'Enabled': 'boolean'}},
'Tls': {'Enabled': 'boolean'}}}},
'ZoneIds': ['string']}}}}
Returns a list of all the MSK clusters in the current Region.
See also: AWS API Documentation
Request Syntax
client.list_clusters_v2(
ClusterNameFilter='string',
ClusterTypeFilter='string',
MaxResults=123,
NextToken='string'
)
string
Specify a prefix of the names of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.
string
Specify either PROVISIONED or SERVERLESS.
integer
The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
string
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.
dict
Response Syntax
{
'ClusterInfoList': [
{
'ActiveOperationArn': 'string',
'ClusterType': 'PROVISIONED'|'SERVERLESS',
'ClusterArn': 'string',
'ClusterName': 'string',
'CreationTime': datetime(2015, 1, 1),
'CurrentVersion': 'string',
'State': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'HEALING'|'MAINTENANCE'|'REBOOTING_BROKER'|'UPDATING',
'StateInfo': {
'Code': 'string',
'Message': 'string'
},
'Tags': {
'string': 'string'
},
'Provisioned': {
'BrokerNodeGroupInfo': {
'BrokerAZDistribution': 'DEFAULT',
'ClientSubnets': [
'string',
],
'InstanceType': 'string',
'SecurityGroups': [
'string',
],
'StorageInfo': {
'EbsStorageInfo': {
'ProvisionedThroughput': {
'Enabled': True|False,
'VolumeThroughput': 123
},
'VolumeSize': 123
}
},
'ConnectivityInfo': {
'PublicAccess': {
'Type': 'string'
},
'VpcConnectivity': {
'ClientAuthentication': {
'Sasl': {
'Scram': {
'Enabled': True|False
},
'Iam': {
'Enabled': True|False
}
},
'Tls': {
'Enabled': True|False
}
}
}
},
'ZoneIds': [
'string',
]
},
'CurrentBrokerSoftwareInfo': {
'ConfigurationArn': 'string',
'ConfigurationRevision': 123,
'KafkaVersion': 'string'
},
'ClientAuthentication': {
'Sasl': {
'Scram': {
'Enabled': True|False
},
'Iam': {
'Enabled': True|False
}
},
'Tls': {
'CertificateAuthorityArnList': [
'string',
],
'Enabled': True|False
},
'Unauthenticated': {
'Enabled': True|False
}
},
'EncryptionInfo': {
'EncryptionAtRest': {
'DataVolumeKMSKeyId': 'string'
},
'EncryptionInTransit': {
'ClientBroker': 'TLS'|'TLS_PLAINTEXT'|'PLAINTEXT',
'InCluster': True|False
}
},
'EnhancedMonitoring': 'DEFAULT'|'PER_BROKER'|'PER_TOPIC_PER_BROKER'|'PER_TOPIC_PER_PARTITION',
'OpenMonitoring': {
'Prometheus': {
'JmxExporter': {
'EnabledInBroker': True|False
},
'NodeExporter': {
'EnabledInBroker': True|False
}
}
},
'LoggingInfo': {
'BrokerLogs': {
'CloudWatchLogs': {
'Enabled': True|False,
'LogGroup': 'string'
},
'Firehose': {
'DeliveryStream': 'string',
'Enabled': True|False
},
'S3': {
'Bucket': 'string',
'Enabled': True|False,
'Prefix': 'string'
}
}
},
'NumberOfBrokerNodes': 123,
'ZookeeperConnectString': 'string',
'ZookeeperConnectStringTls': 'string',
'StorageMode': 'LOCAL'|'TIERED'
},
'Serverless': {
'VpcConfigs': [
{
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
],
'ClientAuthentication': {
'Sasl': {
'Iam': {
'Enabled': True|False
}
}
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Successful response.
ClusterInfoList (list) --
Information on each of the MSK clusters in the response.
(dict) --
Returns information about a cluster.
ActiveOperationArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.
ClusterType (string) --
Cluster Type.
ClusterArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
ClusterName (string) --
The name of the cluster.
CreationTime (datetime) --
The time when the cluster was created.
CurrentVersion (string) --
The current version of the MSK cluster.
State (string) --
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
StateInfo (dict) --
State Info for the Amazon MSK cluster.
Code (string) --
Message (string) --
Tags (dict) --
Tags attached to the cluster.
(string) --
(string) --
Provisioned (dict) --
Information about the provisioned cluster.
BrokerNodeGroupInfo (dict) --
Information about the brokers.
BrokerAZDistribution (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.
ClientSubnets (list) --
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.
(string) --
InstanceType (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.
SecurityGroups (list) --
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.
(string) --
StorageInfo (dict) --
Contains information about storage volumes attached to MSK broker nodes.
EbsStorageInfo (dict) --
EBS volume information.
ProvisionedThroughput (dict) --
EBS volume provisioned throughput information.
Enabled (boolean) --
Provisioned throughput is enabled or not.
VolumeThroughput (integer) --
Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
VolumeSize (integer) --
The size in GiB of the EBS volume for the data drive on each broker node.
ConnectivityInfo (dict) --
Information about the broker access configuration.
PublicAccess (dict) --
Public access control for brokers.
Type (string) --
The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
VpcConnectivity (dict) --
VPC connectivity access control for brokers.
ClientAuthentication (dict) --
Includes all client authentication information for VPC connectivity.
Sasl (dict) --
SASL authentication type details for VPC connectivity.
Scram (dict) --
Details for SASL/SCRAM client authentication for VPC connectivity.
Enabled (boolean) --
SASL/SCRAM authentication is on or off for VPC connectivity.
Iam (dict) --
Details for SASL/IAM client authentication for VPC connectivity.
Enabled (boolean) --
SASL/IAM authentication is on or off for VPC connectivity.
Tls (dict) --
TLS authentication type details for VPC connectivity.
Enabled (boolean) --
TLS authentication is on or off for VPC connectivity.
ZoneIds (list) --
The list of zoneIds for the cluster in the virtual private cloud (VPC).
(string) --
CurrentBrokerSoftwareInfo (dict) --
Information about the Apache Kafka version deployed on the brokers.
ConfigurationArn (string) --
The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.
ConfigurationRevision (integer) --
The revision of the configuration to use. This field isn't visible in this preview release.
KafkaVersion (string) --
The version of Apache Kafka.
ClientAuthentication (dict) --
Includes all client authentication information.
Sasl (dict) --
Details for ClientAuthentication using SASL.
Scram (dict) --
Details for SASL/SCRAM client authentication.
Enabled (boolean) --
SASL/SCRAM authentication is enabled or not.
Iam (dict) --
Indicates whether IAM access control is enabled.
Enabled (boolean) --
Indicates whether IAM access control is enabled.
Tls (dict) --
Details for ClientAuthentication using TLS.
CertificateAuthorityArnList (list) --
List of ACM Certificate Authority ARNs.
(string) --
Enabled (boolean) --
Specifies whether you want to turn on or turn off TLS authentication.
Unauthenticated (dict) --
Contains information about unauthenticated traffic to the cluster.
Enabled (boolean) --
Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
EncryptionInfo (dict) --
Includes all encryption-related information.
EncryptionAtRest (dict) --
The data-volume encryption details.
DataVolumeKMSKeyId (string) --
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.
EncryptionInTransit (dict) --
The details for encryption in transit.
ClientBroker (string) --
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.
InCluster (boolean) --
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.
EnhancedMonitoring (string) --
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.
OpenMonitoring (dict) --
The settings for open monitoring.
Prometheus (dict) --
Prometheus settings.
JmxExporter (dict) --
Indicates whether you want to turn on or turn off the JMX Exporter.
EnabledInBroker (boolean) --
Indicates whether you want to turn on or turn off the JMX Exporter.
NodeExporter (dict) --
Indicates whether you want to turn on or turn off the Node Exporter.
EnabledInBroker (boolean) --
Indicates whether you want to turn on or turn off the Node Exporter.
LoggingInfo (dict) --
Log delivery information for the cluster.
BrokerLogs (dict) --
CloudWatchLogs (dict) --
Enabled (boolean) --
LogGroup (string) --
Firehose (dict) --
DeliveryStream (string) --
Enabled (boolean) --
S3 (dict) --
Bucket (string) --
Enabled (boolean) --
Prefix (string) --
NumberOfBrokerNodes (integer) --
The number of broker nodes in the cluster.
ZookeeperConnectString (string) --
The connection string to use to connect to the Apache ZooKeeper cluster.
ZookeeperConnectStringTls (string) --
The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port.
StorageMode (string) --
This controls storage mode for supported storage tiers.
Serverless (dict) --
Information about the serverless cluster.
VpcConfigs (list) --
The configuration of the Amazon VPCs for the cluster.
(dict) --
The configuration of the Amazon VPCs for the cluster.
SubnetIds (list) --
The IDs of the subnets associated with the cluster.
(string) --
SecurityGroupIds (list) --
The IDs of the security groups associated with the cluster.
(string) --
ClientAuthentication (dict) --
Includes all client authentication information.
Sasl (dict) --
Details for ClientAuthentication using SASL.
Iam (dict) --
Indicates whether IAM access control is enabled.
Enabled (boolean) --
Indicates whether IAM access control is enabled.
NextToken (string) --
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.
{'ConnectivityInfo': {'VpcConnectivity': {'ClientAuthentication': {'Sasl': {'Iam': {'Enabled': 'boolean'},
'Scram': {'Enabled': 'boolean'}},
'Tls': {'Enabled': 'boolean'}}}}}
Updates the cluster's connectivity configuration.
See also: AWS API Documentation
Request Syntax
client.update_connectivity(
ClusterArn='string',
ConnectivityInfo={
'PublicAccess': {
'Type': 'string'
},
'VpcConnectivity': {
'ClientAuthentication': {
'Sasl': {
'Scram': {
'Enabled': True|False
},
'Iam': {
'Enabled': True|False
}
},
'Tls': {
'Enabled': True|False
}
}
}
},
CurrentVersion='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the configuration.
dict
[REQUIRED]
Information about the broker access configuration.
PublicAccess (dict) --
Public access control for brokers.
Type (string) --
The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
VpcConnectivity (dict) --
VPC connectivity access control for brokers.
ClientAuthentication (dict) --
Includes all client authentication information for VPC connectivity.
Sasl (dict) --
SASL authentication type details for VPC connectivity.
Scram (dict) --
Details for SASL/SCRAM client authentication for VPC connectivity.
Enabled (boolean) --
SASL/SCRAM authentication is on or off for VPC connectivity.
Iam (dict) --
Details for SASL/IAM client authentication for VPC connectivity.
Enabled (boolean) --
SASL/IAM authentication is on or off for VPC connectivity.
Tls (dict) --
TLS authentication type details for VPC connectivity.
Enabled (boolean) --
TLS authentication is on or off for VPC connectivity.
string
[REQUIRED]
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.
dict
Response Syntax
{
'ClusterArn': 'string',
'ClusterOperationArn': 'string'
}
Response Structure
(dict) --
Successful response.
ClusterArn (string) --
The Amazon Resource Name (ARN) of the cluster.
ClusterOperationArn (string) --
The Amazon Resource Name (ARN) of the cluster operation.