Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Kafka.Types.ClusterInfo

Description

Synopsis

data ClusterInfo = ClusterInfo' {
- creationTime :: Maybe POSIX
- activeOperationArn :: Maybe Text
- state :: Maybe ClusterState
- clusterArn :: Maybe Text
- numberOfBrokerNodes :: Maybe Int
- enhancedMonitoring :: Maybe EnhancedMonitoring
- brokerNodeGroupInfo :: Maybe BrokerNodeGroupInfo
- openMonitoring :: Maybe OpenMonitoring
- currentBrokerSoftwareInfo :: Maybe BrokerSoftwareInfo
- currentVersion :: Maybe Text
- stateInfo :: Maybe StateInfo
- loggingInfo :: Maybe LoggingInfo
- zookeeperConnectString :: Maybe Text
- clusterName :: Maybe Text
- zookeeperConnectStringTls :: Maybe Text
- clientAuthentication :: Maybe ClientAuthentication
- tags :: Maybe (HashMap Text Text)
- encryptionInfo :: Maybe EncryptionInfo
}
newClusterInfo :: ClusterInfo
clusterInfo_creationTime :: Lens' ClusterInfo (Maybe UTCTime)
clusterInfo_activeOperationArn :: Lens' ClusterInfo (Maybe Text)
clusterInfo_state :: Lens' ClusterInfo (Maybe ClusterState)
clusterInfo_clusterArn :: Lens' ClusterInfo (Maybe Text)
clusterInfo_numberOfBrokerNodes :: Lens' ClusterInfo (Maybe Int)
clusterInfo_enhancedMonitoring :: Lens' ClusterInfo (Maybe EnhancedMonitoring)
clusterInfo_brokerNodeGroupInfo :: Lens' ClusterInfo (Maybe BrokerNodeGroupInfo)
clusterInfo_openMonitoring :: Lens' ClusterInfo (Maybe OpenMonitoring)
clusterInfo_currentBrokerSoftwareInfo :: Lens' ClusterInfo (Maybe BrokerSoftwareInfo)
clusterInfo_currentVersion :: Lens' ClusterInfo (Maybe Text)
clusterInfo_stateInfo :: Lens' ClusterInfo (Maybe StateInfo)
clusterInfo_loggingInfo :: Lens' ClusterInfo (Maybe LoggingInfo)
clusterInfo_zookeeperConnectString :: Lens' ClusterInfo (Maybe Text)
clusterInfo_clusterName :: Lens' ClusterInfo (Maybe Text)
clusterInfo_zookeeperConnectStringTls :: Lens' ClusterInfo (Maybe Text)
clusterInfo_clientAuthentication :: Lens' ClusterInfo (Maybe ClientAuthentication)
clusterInfo_tags :: Lens' ClusterInfo (Maybe (HashMap Text Text))
clusterInfo_encryptionInfo :: Lens' ClusterInfo (Maybe EncryptionInfo)

Documentation

data ClusterInfo Source #

Returns information about a cluster.

See: newClusterInfo smart constructor.

Constructors

ClusterInfo'

Fields

creationTime :: Maybe POSIX
The time when the cluster was created.
activeOperationArn :: Maybe Text
Arn of active cluster operation.
state :: Maybe ClusterState
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
clusterArn :: Maybe Text
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
numberOfBrokerNodes :: Maybe Int
The number of broker nodes in the cluster.
enhancedMonitoring :: Maybe 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.
brokerNodeGroupInfo :: Maybe BrokerNodeGroupInfo
Information about the broker nodes.
openMonitoring :: Maybe OpenMonitoring
Settings for open monitoring using Prometheus.
currentBrokerSoftwareInfo :: Maybe BrokerSoftwareInfo
Information about the version of software currently deployed on the Kafka brokers in the cluster.
currentVersion :: Maybe Text
The current version of the MSK cluster.
stateInfo :: Maybe StateInfo
loggingInfo :: Maybe LoggingInfo
zookeeperConnectString :: Maybe Text
The connection string to use to connect to the Apache ZooKeeper cluster.
clusterName :: Maybe Text
The name of the cluster.
zookeeperConnectStringTls :: Maybe Text
The connection string to use to connect to zookeeper cluster on Tls port.
clientAuthentication :: Maybe ClientAuthentication
Includes all client authentication information.
tags :: Maybe (HashMap Text Text)
Tags attached to the cluster.
encryptionInfo :: Maybe EncryptionInfo
Includes all encryption-related information.

Instances

Instances details

Eq ClusterInfo Source #
Instance details Defined in Amazonka.Kafka.Types.ClusterInfo Methods (==) :: ClusterInfo -> ClusterInfo -> Bool # (/=) :: ClusterInfo -> ClusterInfo -> Bool #
Read ClusterInfo Source #
Instance details Defined in Amazonka.Kafka.Types.ClusterInfo Methods readsPrec :: Int -> ReadS ClusterInfo # readList :: ReadS [ClusterInfo] # readPrec :: ReadPrec ClusterInfo # readListPrec :: ReadPrec [ClusterInfo] #
Show ClusterInfo Source #
Instance details Defined in Amazonka.Kafka.Types.ClusterInfo Methods showsPrec :: Int -> ClusterInfo -> ShowS # show :: ClusterInfo -> String # showList :: [ClusterInfo] -> ShowS #
Generic ClusterInfo Source #
Instance details Defined in Amazonka.Kafka.Types.ClusterInfo Associated Types type Rep ClusterInfo :: Type -> Type # Methods from :: ClusterInfo -> Rep ClusterInfo x # to :: Rep ClusterInfo x -> ClusterInfo #
NFData ClusterInfo Source #
Instance details Defined in Amazonka.Kafka.Types.ClusterInfo Methods rnf :: ClusterInfo -> () #
Hashable ClusterInfo Source #
Instance details Defined in Amazonka.Kafka.Types.ClusterInfo Methods hashWithSalt :: Int -> ClusterInfo -> Int # hash :: ClusterInfo -> Int #
FromJSON ClusterInfo Source #
Instance details Defined in Amazonka.Kafka.Types.ClusterInfo Methods parseJSON :: Value -> Parser ClusterInfo # parseJSONList :: Value -> Parser [ClusterInfo] #
type Rep ClusterInfo Source #
Instance details Defined in Amazonka.Kafka.Types.ClusterInfo type Rep ClusterInfo = D1 ('MetaData "ClusterInfo" "Amazonka.Kafka.Types.ClusterInfo" "libZSservicesZSamazonka-kafkaZSamazonka-kafka" 'False) (C1 ('MetaCons "ClusterInfo'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "activeOperationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterState)) :: S1 ('MetaSel ('Just "clusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "numberOfBrokerNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "enhancedMonitoring") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EnhancedMonitoring))) :: (S1 ('MetaSel ('Just "brokerNodeGroupInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BrokerNodeGroupInfo)) :: (S1 ('MetaSel ('Just "openMonitoring") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OpenMonitoring)) :: S1 ('MetaSel ('Just "currentBrokerSoftwareInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BrokerSoftwareInfo)))))) :: (((S1 ('MetaSel ('Just "currentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stateInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StateInfo))) :: (S1 ('MetaSel ('Just "loggingInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingInfo)) :: S1 ('MetaSel ('Just "zookeeperConnectString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "clusterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "zookeeperConnectStringTls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "clientAuthentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClientAuthentication)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "encryptionInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionInfo))))))))

newClusterInfo :: ClusterInfo Source #

Create a value of ClusterInfo with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:creationTime:ClusterInfo', clusterInfo_creationTime - The time when the cluster was created.

$sel:activeOperationArn:ClusterInfo', clusterInfo_activeOperationArn - Arn of active cluster operation.

$sel:state:ClusterInfo', clusterInfo_state - The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

$sel:clusterArn:ClusterInfo', clusterInfo_clusterArn - The Amazon Resource Name (ARN) that uniquely identifies the cluster.

$sel:numberOfBrokerNodes:ClusterInfo', clusterInfo_numberOfBrokerNodes - The number of broker nodes in the cluster.

$sel:enhancedMonitoring:ClusterInfo', clusterInfo_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.

$sel:brokerNodeGroupInfo:ClusterInfo', clusterInfo_brokerNodeGroupInfo - Information about the broker nodes.

$sel:openMonitoring:ClusterInfo', clusterInfo_openMonitoring - Settings for open monitoring using Prometheus.

$sel:currentBrokerSoftwareInfo:ClusterInfo', clusterInfo_currentBrokerSoftwareInfo - Information about the version of software currently deployed on the Kafka brokers in the cluster.

$sel:currentVersion:ClusterInfo', clusterInfo_currentVersion - The current version of the MSK cluster.

$sel:stateInfo:ClusterInfo', clusterInfo_stateInfo - Undocumented member.

$sel:loggingInfo:ClusterInfo', clusterInfo_loggingInfo - Undocumented member.

$sel:zookeeperConnectString:ClusterInfo', clusterInfo_zookeeperConnectString - The connection string to use to connect to the Apache ZooKeeper cluster.

$sel:clusterName:ClusterInfo', clusterInfo_clusterName - The name of the cluster.

$sel:zookeeperConnectStringTls:ClusterInfo', clusterInfo_zookeeperConnectStringTls - The connection string to use to connect to zookeeper cluster on Tls port.

$sel:clientAuthentication:ClusterInfo', clusterInfo_clientAuthentication - Includes all client authentication information.

$sel:tags:ClusterInfo', clusterInfo_tags - Tags attached to the cluster.

$sel:encryptionInfo:ClusterInfo', clusterInfo_encryptionInfo - Includes all encryption-related information.

clusterInfo_creationTime :: Lens' ClusterInfo (Maybe UTCTime) Source #

The time when the cluster was created.

clusterInfo_activeOperationArn :: Lens' ClusterInfo (Maybe Text) Source #

Arn of active cluster operation.

clusterInfo_state :: Lens' ClusterInfo (Maybe ClusterState) Source #

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

clusterInfo_clusterArn :: Lens' ClusterInfo (Maybe Text) Source #

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

clusterInfo_numberOfBrokerNodes :: Lens' ClusterInfo (Maybe Int) Source #

The number of broker nodes in the cluster.

clusterInfo_enhancedMonitoring :: Lens' ClusterInfo (Maybe EnhancedMonitoring) Source #

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.

clusterInfo_brokerNodeGroupInfo :: Lens' ClusterInfo (Maybe BrokerNodeGroupInfo) Source #

Information about the broker nodes.

clusterInfo_openMonitoring :: Lens' ClusterInfo (Maybe OpenMonitoring) Source #

Settings for open monitoring using Prometheus.

clusterInfo_currentBrokerSoftwareInfo :: Lens' ClusterInfo (Maybe BrokerSoftwareInfo) Source #

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

clusterInfo_currentVersion :: Lens' ClusterInfo (Maybe Text) Source #

The current version of the MSK cluster.

clusterInfo_stateInfo :: Lens' ClusterInfo (Maybe StateInfo) Source #

Undocumented member.

clusterInfo_loggingInfo :: Lens' ClusterInfo (Maybe LoggingInfo) Source #

Undocumented member.