Skip to content

ClusterInfo

Source code in docs_src/capo_kafka/types/cluster_info.py
class ClusterInfo(TypedDict, closed=True):
    active_operation_arn: NotRequired["capo_kafka.types.__string.__string"]
    """<p>Arn of active cluster operation.</p>"""
    broker_node_group_info: NotRequired[
        "capo_kafka.types.broker_node_group_info.BrokerNodeGroupInfo"
    ]
    """<p>Information about the broker nodes.</p>"""
    rebalancing: NotRequired["capo_kafka.types.rebalancing.Rebalancing"]
    """<p>Contains information about intelligent rebalancing for new MSK Provisioned clusters with Express brokers. By default, intelligent rebalancing status is ACTIVE.</p>"""
    client_authentication: NotRequired[
        "capo_kafka.types.client_authentication.ClientAuthentication"
    ]
    """<p>Includes all client authentication information.</p>"""
    cluster_arn: NotRequired["capo_kafka.types.__string.__string"]
    """<p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>"""
    cluster_name: NotRequired["capo_kafka.types.__string.__string"]
    """<p>The name of the cluster.</p>"""
    creation_time: NotRequired[
        "capo_kafka.types.__timestamp_iso8601.__timestampIso8601"
    ]
    """<p>The time when the cluster was created.</p>"""
    current_broker_software_info: NotRequired[
        "capo_kafka.types.broker_software_info.BrokerSoftwareInfo"
    ]
    """<p>Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.</p>"""
    current_version: NotRequired["capo_kafka.types.__string.__string"]
    """<p>The current version of the MSK cluster.</p>"""
    encryption_info: NotRequired["capo_kafka.types.encryption_info.EncryptionInfo"]
    """<p>Includes all encryption-related information.</p>"""
    enhanced_monitoring: NotRequired[
        "capo_kafka.types.enhanced_monitoring.EnhancedMonitoring"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html">Monitoring</a>.</p>"""
    open_monitoring: NotRequired["capo_kafka.types.open_monitoring.OpenMonitoring"]
    """<p>Settings for open monitoring using Prometheus.</p>"""
    logging_info: NotRequired["capo_kafka.types.logging_info.LoggingInfo"]
    number_of_broker_nodes: NotRequired["capo_kafka.types.__integer.__integer"]
    """<p>The number of broker nodes in the cluster.</p>"""
    state: NotRequired["capo_kafka.types.cluster_state.ClusterState"]
    """<p>The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.</p>"""
    state_info: NotRequired["capo_kafka.types.state_info.StateInfo"]
    tags: NotRequired["capo_kafka.types.__map_of__string.__mapOf__string"]
    """<p>Tags attached to the cluster.</p>"""
    zookeeper_connect_string: NotRequired["capo_kafka.types.__string.__string"]
    """<p>The connection string to use to connect to the Apache ZooKeeper cluster.</p>"""
    zookeeper_connect_string_tls: NotRequired["capo_kafka.types.__string.__string"]
    """<p>The connection string to use to connect to zookeeper cluster on Tls port.</p>"""
    storage_mode: NotRequired["capo_kafka.types.storage_mode.StorageMode"]
    """<p>This controls storage mode for supported storage tiers.</p>"""
    customer_action_status: NotRequired[
        "capo_kafka.types.customer_action_status.CustomerActionStatus"
    ]
    """<p>Determines if there is an action required from the customer.</p>"""

active_operation_arn instance-attribute

active_operation_arn: NotRequired[__string]

Arn of active cluster operation.

broker_node_group_info instance-attribute

broker_node_group_info: NotRequired[BrokerNodeGroupInfo]

Information about the broker nodes.

client_authentication instance-attribute

client_authentication: NotRequired[ClientAuthentication]

Includes all client authentication information.

cluster_arn instance-attribute

cluster_arn: NotRequired[__string]

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

cluster_name instance-attribute

cluster_name: NotRequired[__string]

The name of the cluster.

creation_time instance-attribute

creation_time: NotRequired[__timestampIso8601]

The time when the cluster was created.

current_broker_software_info instance-attribute

current_broker_software_info: NotRequired[BrokerSoftwareInfo]

Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

current_version instance-attribute

current_version: NotRequired[__string]

The current version of the MSK cluster.

customer_action_status instance-attribute

customer_action_status: NotRequired[CustomerActionStatus]

Determines if there is an action required from the customer.

encryption_info instance-attribute

encryption_info: NotRequired[EncryptionInfo]

Includes all encryption-related information.

enhanced_monitoring instance-attribute

enhanced_monitoring: NotRequired[EnhancedMonitoring]

Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.

logging_info instance-attribute

logging_info: NotRequired[LoggingInfo]

number_of_broker_nodes instance-attribute

number_of_broker_nodes: NotRequired[__integer]

The number of broker nodes in the cluster.

open_monitoring instance-attribute

open_monitoring: NotRequired[OpenMonitoring]

Settings for open monitoring using Prometheus.

rebalancing instance-attribute

rebalancing: NotRequired[Rebalancing]

Contains information about intelligent rebalancing for new MSK Provisioned clusters with Express brokers. By default, intelligent rebalancing status is ACTIVE.

state instance-attribute

state: NotRequired[ClusterState]

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

state_info instance-attribute

state_info: NotRequired[StateInfo]

storage_mode instance-attribute

storage_mode: NotRequired[StorageMode]

This controls storage mode for supported storage tiers.

tags instance-attribute

tags: NotRequired[__mapOf__string]

Tags attached to the cluster.

zookeeper_connect_string instance-attribute

zookeeper_connect_string: NotRequired[__string]

The connection string to use to connect to the Apache ZooKeeper cluster.

zookeeper_connect_string_tls instance-attribute

zookeeper_connect_string_tls: NotRequired[__string]

The connection string to use to connect to zookeeper cluster on Tls port.