Struct aws_sdk_kafka::types::ClusterInfo

#[non_exhaustive]
pub struct ClusterInfo {

    pub active_operation_arn: Option<String>,
    pub broker_node_group_info: Option<BrokerNodeGroupInfo>,
    pub client_authentication: Option<ClientAuthentication>,
    pub cluster_arn: Option<String>,
    pub cluster_name: Option<String>,
    pub creation_time: Option<DateTime>,
    pub current_broker_software_info: Option<BrokerSoftwareInfo>,
    pub current_version: Option<String>,
    pub encryption_info: Option<EncryptionInfo>,
    pub enhanced_monitoring: Option<EnhancedMonitoring>,
    pub open_monitoring: Option<OpenMonitoring>,
    pub logging_info: Option<LoggingInfo>,
    pub number_of_broker_nodes: Option<i32>,
    pub state: Option<ClusterState>,
    pub state_info: Option<StateInfo>,
    pub tags: Option<HashMap<String, String>>,
    pub zookeeper_connect_string: Option<String>,
    pub zookeeper_connect_string_tls: Option<String>,
    pub storage_mode: Option<StorageMode>,
    pub customer_action_status: Option<CustomerActionStatus>,
}

Returns information about a cluster.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

active_operation_arn: Option<String>

Arn of active cluster operation.

broker_node_group_info: Option<BrokerNodeGroupInfo>

Information about the broker nodes.

client_authentication: Option<ClientAuthentication>

Includes all client authentication information.

cluster_arn: Option<String>

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

cluster_name: Option<String>

The name of the cluster.

creation_time: Option<DateTime>

The time when the cluster was created.

current_broker_software_info: Option<BrokerSoftwareInfo>

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

current_version: Option<String>

The current version of the MSK cluster.

encryption_info: Option<EncryptionInfo>

Includes all encryption-related information.

enhanced_monitoring: Option<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.

open_monitoring: Option<OpenMonitoring>

Settings for open monitoring using Prometheus.

logging_info: Option<LoggingInfo>

number_of_broker_nodes: Option<i32>

The number of broker nodes in the cluster.

state: Option<ClusterState>

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

state_info: Option<StateInfo>

tags: Option<HashMap<String, String>>

Tags attached to the cluster.

zookeeper_connect_string: Option<String>

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

zookeeper_connect_string_tls: Option<String>

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

storage_mode: Option<StorageMode>

This controls storage mode for supported storage tiers.

customer_action_status: Option<CustomerActionStatus>

Determines if there is an action required from the customer.

Implementations

impl ClusterInfo

pub fn active_operation_arn(&self) -> Option<&str>

Arn of active cluster operation.

pub fn broker_node_group_info(&self) -> Option<&BrokerNodeGroupInfo>

Information about the broker nodes.

pub fn client_authentication(&self) -> Option<&ClientAuthentication>

Includes all client authentication information.

pub fn cluster_arn(&self) -> Option<&str>

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

pub fn cluster_name(&self) -> Option<&str>

The name of the cluster.

pub fn creation_time(&self) -> Option<&DateTime>

The time when the cluster was created.

pub fn current_broker_software_info(&self) -> Option<&BrokerSoftwareInfo>

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

pub fn current_version(&self) -> Option<&str>

The current version of the MSK cluster.

pub fn encryption_info(&self) -> Option<&EncryptionInfo>

Includes all encryption-related information.

pub fn enhanced_monitoring(&self) -> Option<&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.

pub fn open_monitoring(&self) -> Option<&OpenMonitoring>

Settings for open monitoring using Prometheus.

pub fn logging_info(&self) -> Option<&LoggingInfo>

pub fn number_of_broker_nodes(&self) -> Option<i32>

The number of broker nodes in the cluster.

pub fn state(&self) -> Option<&ClusterState>

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

pub fn state_info(&self) -> Option<&StateInfo>

pub fn tags(&self) -> Option<&HashMap<String, String>>

Tags attached to the cluster.

pub fn zookeeper_connect_string(&self) -> Option<&str>

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

pub fn zookeeper_connect_string_tls(&self) -> Option<&str>

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

pub fn storage_mode(&self) -> Option<&StorageMode>

This controls storage mode for supported storage tiers.

pub fn customer_action_status(&self) -> Option<&CustomerActionStatus>

Determines if there is an action required from the customer.

impl ClusterInfo

pub fn builder() -> ClusterInfoBuilder

Creates a new builder-style object to manufacture ClusterInfo.

Trait Implementations

impl Clone for ClusterInfo

fn clone(&self) -> ClusterInfo

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClusterInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ClusterInfo

fn eq(&self, other: &ClusterInfo) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ClusterInfo