Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kafka.Types.Cluster

Description

Synopsis

data Cluster = Cluster' {
- activeOperationArn :: Maybe Text
- clusterArn :: Maybe Text
- clusterName :: Maybe Text
- clusterType :: Maybe ClusterType
- creationTime :: Maybe ISO8601
- currentVersion :: Maybe Text
- provisioned :: Maybe Provisioned
- serverless :: Maybe Serverless
- state :: Maybe ClusterState
- stateInfo :: Maybe StateInfo
- tags :: Maybe (HashMap Text Text)
}
newCluster :: Cluster
cluster_activeOperationArn :: Lens' Cluster (Maybe Text)
cluster_clusterArn :: Lens' Cluster (Maybe Text)
cluster_clusterName :: Lens' Cluster (Maybe Text)
cluster_clusterType :: Lens' Cluster (Maybe ClusterType)
cluster_creationTime :: Lens' Cluster (Maybe UTCTime)
cluster_currentVersion :: Lens' Cluster (Maybe Text)
cluster_provisioned :: Lens' Cluster (Maybe Provisioned)
cluster_serverless :: Lens' Cluster (Maybe Serverless)
cluster_state :: Lens' Cluster (Maybe ClusterState)
cluster_stateInfo :: Lens' Cluster (Maybe StateInfo)
cluster_tags :: Lens' Cluster (Maybe (HashMap Text Text))

Documentation

data Cluster Source #

Returns information about a cluster.

See: newCluster smart constructor.

Constructors

Cluster'

Fields

activeOperationArn :: Maybe Text
The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.
clusterArn :: Maybe Text
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
clusterName :: Maybe Text
The name of the cluster.
clusterType :: Maybe ClusterType
Cluster Type.
creationTime :: Maybe ISO8601
The time when the cluster was created.
currentVersion :: Maybe Text
The current version of the MSK cluster.
provisioned :: Maybe Provisioned
Information about the provisioned cluster.
serverless :: Maybe Serverless
Information about the serverless cluster.
state :: Maybe ClusterState
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
stateInfo :: Maybe StateInfo
State Info for the Amazon MSK cluster.
tags :: Maybe (HashMap Text Text)
Tags attached to the cluster.

Instances

Instances details

FromJSON Cluster Source #
Instance details Defined in Amazonka.Kafka.Types.Cluster Methods parseJSON :: Value -> Parser Cluster # parseJSONList :: Value -> Parser [Cluster] #
Generic Cluster Source #
Instance details Defined in Amazonka.Kafka.Types.Cluster Associated Types type Rep Cluster :: Type -> Type # Methods from :: Cluster -> Rep Cluster x # to :: Rep Cluster x -> Cluster #
Read Cluster Source #
Instance details Defined in Amazonka.Kafka.Types.Cluster Methods readsPrec :: Int -> ReadS Cluster # readList :: ReadS [Cluster] # readPrec :: ReadPrec Cluster # readListPrec :: ReadPrec [Cluster] #
Show Cluster Source #
Instance details Defined in Amazonka.Kafka.Types.Cluster Methods showsPrec :: Int -> Cluster -> ShowS # show :: Cluster -> String # showList :: [Cluster] -> ShowS #
NFData Cluster Source #
Instance details Defined in Amazonka.Kafka.Types.Cluster Methods rnf :: Cluster -> () #
Eq Cluster Source #
Instance details Defined in Amazonka.Kafka.Types.Cluster Methods (==) :: Cluster -> Cluster -> Bool # (/=) :: Cluster -> Cluster -> Bool #
Hashable Cluster Source #
Instance details Defined in Amazonka.Kafka.Types.Cluster Methods hashWithSalt :: Int -> Cluster -> Int # hash :: Cluster -> Int #
type Rep Cluster Source #
Instance details Defined in Amazonka.Kafka.Types.Cluster type Rep Cluster = D1 ('MetaData "Cluster" "Amazonka.Kafka.Types.Cluster" "amazonka-kafka-2.0-Go9aKmtSH8zJub8xGjzkib" 'False) (C1 ('MetaCons "Cluster'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "activeOperationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "clusterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "clusterType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterType)) :: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))))) :: ((S1 ('MetaSel ('Just "currentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "provisioned") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Provisioned)) :: S1 ('MetaSel ('Just "serverless") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Serverless)))) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterState)) :: (S1 ('MetaSel ('Just "stateInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StateInfo)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))))))

newCluster :: Cluster Source #

Create a value of Cluster 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:activeOperationArn:Cluster', cluster_activeOperationArn - The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.

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

$sel:clusterName:Cluster', cluster_clusterName - The name of the cluster.

$sel:clusterType:Cluster', cluster_clusterType - Cluster Type.

$sel:creationTime:Cluster', cluster_creationTime - The time when the cluster was created.

$sel:currentVersion:Cluster', cluster_currentVersion - The current version of the MSK cluster.

$sel:provisioned:Cluster', cluster_provisioned - Information about the provisioned cluster.

$sel:serverless:Cluster', cluster_serverless - Information about the serverless cluster.

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

$sel:stateInfo:Cluster', cluster_stateInfo - State Info for the Amazon MSK cluster.

$sel:tags:Cluster', cluster_tags - Tags attached to the cluster.

cluster_activeOperationArn :: Lens' Cluster (Maybe Text) Source #

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

cluster_clusterArn :: Lens' Cluster (Maybe Text) Source #

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

cluster_clusterName :: Lens' Cluster (Maybe Text) Source #

The name of the cluster.

cluster_clusterType :: Lens' Cluster (Maybe ClusterType) Source #

Cluster Type.

cluster_creationTime :: Lens' Cluster (Maybe UTCTime) Source #

The time when the cluster was created.