Managed Streaming for Kafka

2020/09/15 - Managed Streaming for Kafka - 3 new 4 updated api methods

Changes  Added new API's to support SASL SCRAM Authentication with MSK Clusters.

BatchDisassociateScramSecret (new) Link ¶

Disassociates one or more Scram Secrets from an Amazon MSK cluster.

See also: AWS API Documentation

Request Syntax

client.batch_disassociate_scram_secret(
    ClusterArn='string',
    SecretArnList=[
        'string',
    ]
)
type ClusterArn

string

param ClusterArn

[REQUIRED]

The Amazon Resource Name (ARN) of the cluster to be updated.

type SecretArnList

list

param SecretArnList

[REQUIRED]

List of AWS Secrets Manager secret ARNs.

  • (string) --

rtype

dict

returns

Response Syntax

{
    'ClusterArn': 'string',
    'UnprocessedScramSecrets': [
        {
            'ErrorCode': 'string',
            'ErrorMessage': 'string',
            'SecretArn': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    200 response

    • ClusterArn (string) --

      The Amazon Resource Name (ARN) of the cluster.

    • UnprocessedScramSecrets (list) --

      List of errors when disassociating secrets to cluster.

      • (dict) --

        Error info for scram secret associate/disassociate failure.

        • ErrorCode (string) --

          Error code for associate/disassociate failure.

        • ErrorMessage (string) --

          Error message for associate/disassociate failure.

        • SecretArn (string) --

          AWS Secrets Manager secret ARN.

ListScramSecrets (new) Link ¶

Returns a list of the Scram Secrets associated with an Amazon MSK cluster.

See also: AWS API Documentation

Request Syntax

client.list_scram_secrets(
    ClusterArn='string',
    MaxResults=123,
    NextToken='string'
)
type ClusterArn

string

param ClusterArn

[REQUIRED]

The arn of the cluster.

type MaxResults

integer

param MaxResults

The maxResults of the query.

type NextToken

string

param NextToken

The nextToken of the query.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'SecretArnList': [
        'string',
    ]
}

Response Structure

  • (dict) --

    200 response

    • NextToken (string) --

      Paginated results marker.

    • SecretArnList (list) --

      The list of scram secrets associated with the cluster.

      • (string) --

BatchAssociateScramSecret (new) Link ¶

Associates one or more Scram Secrets with an Amazon MSK cluster.

See also: AWS API Documentation

Request Syntax

client.batch_associate_scram_secret(
    ClusterArn='string',
    SecretArnList=[
        'string',
    ]
)
type ClusterArn

string

param ClusterArn

[REQUIRED]

The Amazon Resource Name (ARN) of the cluster to be updated.

type SecretArnList

list

param SecretArnList

[REQUIRED]

List of AWS Secrets Manager secret ARNs.

  • (string) --

rtype

dict

returns

Response Syntax

{
    'ClusterArn': 'string',
    'UnprocessedScramSecrets': [
        {
            'ErrorCode': 'string',
            'ErrorMessage': 'string',
            'SecretArn': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    200 response

    • ClusterArn (string) --

      The Amazon Resource Name (ARN) of the cluster.

    • UnprocessedScramSecrets (list) --

      List of errors when associating secrets to cluster.

      • (dict) --

        Error info for scram secret associate/disassociate failure.

        • ErrorCode (string) --

          Error code for associate/disassociate failure.

        • ErrorMessage (string) --

          Error message for associate/disassociate failure.

        • SecretArn (string) --

          AWS Secrets Manager secret ARN.

CreateCluster (updated) Link ¶
Changes (request)
{'ClientAuthentication': {'Sasl': {'Scram': {'Enabled': 'boolean'}}}}

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': {
                'VolumeSize': 123
            }
        }
    },
    ClientAuthentication={
        'Sasl': {
            'Scram': {
                'Enabled': True|False
            }
        },
        'Tls': {
            'CertificateAuthorityArnList': [
                'string',
            ]
        }
    },
    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',
    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'
    }
)
type BrokerNodeGroupInfo

dict

param BrokerNodeGroupInfo

[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 be in Availability Zone us-east-1e.

    • (string) --

  • InstanceType (string) -- [REQUIRED]

    The type of Amazon EC2 instances to use for Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.

  • 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.

      • VolumeSize (integer) --

        The size in GiB of the EBS volume for the data drive on each broker node.

type ClientAuthentication

dict

param ClientAuthentication

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.

  • Tls (dict) --

    Details for ClientAuthentication using TLS.

    • CertificateAuthorityArnList (list) --

      List of ACM Certificate Authority ARNs.

      • (string) --

type ClusterName

string

param ClusterName

[REQUIRED]

The name of the cluster.

type ConfigurationInfo

dict

param ConfigurationInfo

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.

type EncryptionInfo

dict

param EncryptionInfo

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.

type EnhancedMonitoring

string

param EnhancedMonitoring

Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER.

type OpenMonitoring

dict

param OpenMonitoring

The settings for open monitoring.

  • Prometheus (dict) -- [REQUIRED]

    Prometheus settings.

    • JmxExporter (dict) --

      Indicates whether you want to enable or disable the JMX Exporter.

      • EnabledInBroker (boolean) -- [REQUIRED]

        Indicates whether you want to enable or disable the JMX Exporter.

    • NodeExporter (dict) --

      Indicates whether you want to enable or disable the Node Exporter.

      • EnabledInBroker (boolean) -- [REQUIRED]

        Indicates whether you want to enable or disable the Node Exporter.

type KafkaVersion

string

param KafkaVersion

[REQUIRED]

The version of Apache Kafka.

type LoggingInfo

dict

param LoggingInfo
  • 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) --

type NumberOfBrokerNodes

integer

param NumberOfBrokerNodes

[REQUIRED]

The number of broker nodes in the cluster.

type Tags

dict

param Tags

Create tags when creating the cluster.

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{
    'ClusterArn': 'string',
    'ClusterName': 'string',
    'State': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'FAILED'
}

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 CREATING, ACTIVE, and FAILED.

DescribeCluster (updated) Link ¶
Changes (response)
{'ClusterInfo': {'ClientAuthentication': {'Sasl': {'Scram': {'Enabled': 'boolean'}}}}}

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'
)
type ClusterArn

string

param ClusterArn

[REQUIRED]

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

rtype

dict

returns

Response Syntax

{
    'ClusterInfo': {
        'ActiveOperationArn': 'string',
        'BrokerNodeGroupInfo': {
            'BrokerAZDistribution': 'DEFAULT',
            'ClientSubnets': [
                'string',
            ],
            'InstanceType': 'string',
            'SecurityGroups': [
                'string',
            ],
            'StorageInfo': {
                'EbsStorageInfo': {
                    'VolumeSize': 123
                }
            }
        },
        'ClientAuthentication': {
            'Sasl': {
                'Scram': {
                    'Enabled': True|False
                }
            },
            'Tls': {
                'CertificateAuthorityArnList': [
                    'string',
                ]
            }
        },
        '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',
        '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'|'UPDATING'|'DELETING'|'FAILED',
        'StateInfo': {
            'Code': 'string',
            'Message': 'string'
        },
        'Tags': {
            'string': 'string'
        },
        'ZookeeperConnectString': 'string'
    }
}

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 be in Availability Zone us-east-1e.

          • (string) --

        • InstanceType (string) --

          The type of Amazon EC2 instances to use for Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.

        • 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.

            • VolumeSize (integer) --

              The size in GiB of the EBS volume for the data drive on each broker node.

      • 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.

        • Tls (dict) --

          Details for ClientAuthentication using TLS.

          • CertificateAuthorityArnList (list) --

            List of ACM Certificate Authority ARNs.

            • (string) --

      • 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 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 three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of monitoring, see Monitoring.

      • OpenMonitoring (dict) --

        Settings for open monitoring using Prometheus.

        • Prometheus (dict) --

          Prometheus settings.

          • JmxExporter (dict) --

            Indicates whether you want to enable or disable the JMX Exporter.

            • EnabledInBroker (boolean) --

              Indicates whether you want to enable or disable the JMX Exporter.

          • NodeExporter (dict) --

            Indicates whether you want to enable or disable the Node Exporter.

            • EnabledInBroker (boolean) --

              Indicates whether you want to enable or disable 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 CREATING, ACTIVE, and FAILED.

      • 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.

GetBootstrapBrokers (updated) Link ¶
Changes (response)
{'BootstrapBrokerStringSaslScram': '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'
)
type ClusterArn

string

param ClusterArn

[REQUIRED]

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

rtype

dict

returns

Response Syntax

{
    'BootstrapBrokerString': 'string',
    'BootstrapBrokerStringTls': 'string',
    'BootstrapBrokerStringSaslScram': '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.

ListClusters (updated) Link ¶
Changes (response)
{'ClusterInfoList': {'ClientAuthentication': {'Sasl': {'Scram': {'Enabled': 'boolean'}}}}}

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'
)
type ClusterNameFilter

string

param ClusterNameFilter

Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

type MaxResults

integer

param MaxResults

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

type NextToken

string

param NextToken

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

rtype

dict

returns

Response Syntax

{
    'ClusterInfoList': [
        {
            'ActiveOperationArn': 'string',
            'BrokerNodeGroupInfo': {
                'BrokerAZDistribution': 'DEFAULT',
                'ClientSubnets': [
                    'string',
                ],
                'InstanceType': 'string',
                'SecurityGroups': [
                    'string',
                ],
                'StorageInfo': {
                    'EbsStorageInfo': {
                        'VolumeSize': 123
                    }
                }
            },
            'ClientAuthentication': {
                'Sasl': {
                    'Scram': {
                        'Enabled': True|False
                    }
                },
                'Tls': {
                    'CertificateAuthorityArnList': [
                        'string',
                    ]
                }
            },
            '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',
            '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'|'UPDATING'|'DELETING'|'FAILED',
            'StateInfo': {
                'Code': 'string',
                'Message': 'string'
            },
            'Tags': {
                'string': 'string'
            },
            'ZookeeperConnectString': 'string'
        },
    ],
    '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 be in Availability Zone us-east-1e.

            • (string) --

          • InstanceType (string) --

            The type of Amazon EC2 instances to use for Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.

          • 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.

              • VolumeSize (integer) --

                The size in GiB of the EBS volume for the data drive on each broker node.

        • 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.

          • Tls (dict) --

            Details for ClientAuthentication using TLS.

            • CertificateAuthorityArnList (list) --

              List of ACM Certificate Authority ARNs.

              • (string) --

        • 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 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 three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of monitoring, see Monitoring.

        • OpenMonitoring (dict) --

          Settings for open monitoring using Prometheus.

          • Prometheus (dict) --

            Prometheus settings.

            • JmxExporter (dict) --

              Indicates whether you want to enable or disable the JMX Exporter.

              • EnabledInBroker (boolean) --

                Indicates whether you want to enable or disable the JMX Exporter.

            • NodeExporter (dict) --

              Indicates whether you want to enable or disable the Node Exporter.

              • EnabledInBroker (boolean) --

                Indicates whether you want to enable or disable 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 CREATING, ACTIVE, and FAILED.

        • 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.

    • 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.