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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new MSK cluster.

Synopsis

data CreateCluster = CreateCluster' {
- enhancedMonitoring :: Maybe EnhancedMonitoring
- openMonitoring :: Maybe OpenMonitoringInfo
- configurationInfo :: Maybe ConfigurationInfo
- loggingInfo :: Maybe LoggingInfo
- clientAuthentication :: Maybe ClientAuthentication
- tags :: Maybe (HashMap Text Text)
- encryptionInfo :: Maybe EncryptionInfo
- brokerNodeGroupInfo :: BrokerNodeGroupInfo
- kafkaVersion :: Text
- numberOfBrokerNodes :: Natural
- clusterName :: Text
}
newCreateCluster :: BrokerNodeGroupInfo -> Text -> Natural -> Text -> CreateCluster
createCluster_enhancedMonitoring :: Lens' CreateCluster (Maybe EnhancedMonitoring)
createCluster_openMonitoring :: Lens' CreateCluster (Maybe OpenMonitoringInfo)
createCluster_configurationInfo :: Lens' CreateCluster (Maybe ConfigurationInfo)
createCluster_loggingInfo :: Lens' CreateCluster (Maybe LoggingInfo)
createCluster_clientAuthentication :: Lens' CreateCluster (Maybe ClientAuthentication)
createCluster_tags :: Lens' CreateCluster (Maybe (HashMap Text Text))
createCluster_encryptionInfo :: Lens' CreateCluster (Maybe EncryptionInfo)
createCluster_brokerNodeGroupInfo :: Lens' CreateCluster BrokerNodeGroupInfo
createCluster_kafkaVersion :: Lens' CreateCluster Text
createCluster_numberOfBrokerNodes :: Lens' CreateCluster Natural
createCluster_clusterName :: Lens' CreateCluster Text
data CreateClusterResponse = CreateClusterResponse' {
- state :: Maybe ClusterState
- clusterArn :: Maybe Text
- clusterName :: Maybe Text
- httpStatus :: Int
}
newCreateClusterResponse :: Int -> CreateClusterResponse
createClusterResponse_state :: Lens' CreateClusterResponse (Maybe ClusterState)
createClusterResponse_clusterArn :: Lens' CreateClusterResponse (Maybe Text)
createClusterResponse_clusterName :: Lens' CreateClusterResponse (Maybe Text)
createClusterResponse_httpStatus :: Lens' CreateClusterResponse Int

Creating a Request

data CreateCluster Source #

See: newCreateCluster smart constructor.

Constructors

CreateCluster'

Fields

enhancedMonitoring :: Maybe EnhancedMonitoring
Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.
openMonitoring :: Maybe OpenMonitoringInfo
The settings for open monitoring.
configurationInfo :: Maybe ConfigurationInfo
Represents the configuration that you want MSK to use for the brokers in a cluster.
loggingInfo :: Maybe LoggingInfo
clientAuthentication :: Maybe ClientAuthentication
Includes all client authentication related information.
tags :: Maybe (HashMap Text Text)
Create tags when creating the cluster.
encryptionInfo :: Maybe EncryptionInfo
Includes all encryption-related information.
brokerNodeGroupInfo :: BrokerNodeGroupInfo
Information about the broker nodes in the cluster.
kafkaVersion :: Text
The version of Apache Kafka.
numberOfBrokerNodes :: Natural
The number of broker nodes in the cluster.
clusterName :: Text
The name of the cluster.

Instances

Instances details

Eq CreateCluster Source #
Instance details Defined in Amazonka.Kafka.CreateCluster Methods (==) :: CreateCluster -> CreateCluster -> Bool # (/=) :: CreateCluster -> CreateCluster -> Bool #
Read CreateCluster Source #
Instance details Defined in Amazonka.Kafka.CreateCluster Methods readsPrec :: Int -> ReadS CreateCluster # readList :: ReadS [CreateCluster] # readPrec :: ReadPrec CreateCluster # readListPrec :: ReadPrec [CreateCluster] #
Show CreateCluster Source #
Instance details Defined in Amazonka.Kafka.CreateCluster Methods showsPrec :: Int -> CreateCluster -> ShowS # show :: CreateCluster -> String # showList :: [CreateCluster] -> ShowS #
Generic CreateCluster Source #
Instance details Defined in Amazonka.Kafka.CreateCluster Associated Types type Rep CreateCluster :: Type -> Type # Methods from :: CreateCluster -> Rep CreateCluster x # to :: Rep CreateCluster x -> CreateCluster #
NFData CreateCluster Source #
Instance details Defined in Amazonka.Kafka.CreateCluster Methods rnf :: CreateCluster -> () #
Hashable CreateCluster Source #
Instance details Defined in Amazonka.Kafka.CreateCluster Methods hashWithSalt :: Int -> CreateCluster -> Int # hash :: CreateCluster -> Int #
ToJSON CreateCluster Source #
Instance details Defined in Amazonka.Kafka.CreateCluster Methods toJSON :: CreateCluster -> Value # toEncoding :: CreateCluster -> Encoding # toJSONList :: [CreateCluster] -> Value # toEncodingList :: [CreateCluster] -> Encoding #
AWSRequest CreateCluster Source #
Instance details Defined in Amazonka.Kafka.CreateCluster Associated Types type AWSResponse CreateCluster # Methods request :: CreateCluster -> Request CreateCluster # response :: MonadResource m => Logger -> Service -> Proxy CreateCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateCluster))) #
ToHeaders CreateCluster Source #
Instance details Defined in Amazonka.Kafka.CreateCluster Methods toHeaders :: CreateCluster -> [Header] #
ToPath CreateCluster Source #
Instance details Defined in Amazonka.Kafka.CreateCluster Methods toPath :: CreateCluster -> ByteString #
ToQuery CreateCluster Source #
Instance details Defined in Amazonka.Kafka.CreateCluster Methods toQuery :: CreateCluster -> QueryString #
type Rep CreateCluster Source #
Instance details Defined in Amazonka.Kafka.CreateCluster type Rep CreateCluster = D1 ('MetaData "CreateCluster" "Amazonka.Kafka.CreateCluster" "libZSservicesZSamazonka-kafkaZSamazonka-kafka" 'False) (C1 ('MetaCons "CreateCluster'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "enhancedMonitoring") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EnhancedMonitoring)) :: S1 ('MetaSel ('Just "openMonitoring") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OpenMonitoringInfo))) :: (S1 ('MetaSel ('Just "configurationInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfigurationInfo)) :: (S1 ('MetaSel ('Just "loggingInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingInfo)) :: 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)) :: S1 ('MetaSel ('Just "brokerNodeGroupInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BrokerNodeGroupInfo))) :: (S1 ('MetaSel ('Just "kafkaVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "numberOfBrokerNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :: S1 ('MetaSel ('Just "clusterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateCluster Source #
Instance details Defined in Amazonka.Kafka.CreateCluster type AWSResponse CreateCluster = CreateClusterResponse

newCreateCluster Source #

Arguments

:: BrokerNodeGroupInfo	`$sel:brokerNodeGroupInfo:CreateCluster'`
-> Text	`$sel:kafkaVersion:CreateCluster'`
-> Natural	`$sel:numberOfBrokerNodes:CreateCluster'`
-> Text	`$sel:clusterName:CreateCluster'`
-> CreateCluster

Create a value of CreateCluster 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:enhancedMonitoring:CreateCluster', createCluster_enhancedMonitoring - Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.

$sel:openMonitoring:CreateCluster', createCluster_openMonitoring - The settings for open monitoring.

$sel:configurationInfo:CreateCluster', createCluster_configurationInfo - Represents the configuration that you want MSK to use for the brokers in a cluster.

$sel:loggingInfo:CreateCluster', createCluster_loggingInfo - Undocumented member.

$sel:clientAuthentication:CreateCluster', createCluster_clientAuthentication - Includes all client authentication related information.

$sel:tags:CreateCluster', createCluster_tags - Create tags when creating the cluster.

$sel:encryptionInfo:CreateCluster', createCluster_encryptionInfo - Includes all encryption-related information.

$sel:brokerNodeGroupInfo:CreateCluster', createCluster_brokerNodeGroupInfo - Information about the broker nodes in the cluster.

$sel:kafkaVersion:CreateCluster', createCluster_kafkaVersion - The version of Apache Kafka.

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

$sel:clusterName:CreateCluster', createCluster_clusterName - The name of the cluster.

Request Lenses

createCluster_enhancedMonitoring :: Lens' CreateCluster (Maybe EnhancedMonitoring) Source #

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

createCluster_openMonitoring :: Lens' CreateCluster (Maybe OpenMonitoringInfo) Source #

The settings for open monitoring.

createCluster_configurationInfo :: Lens' CreateCluster (Maybe ConfigurationInfo) Source #

Represents the configuration that you want MSK to use for the brokers in a cluster.

createCluster_loggingInfo :: Lens' CreateCluster (Maybe LoggingInfo) Source #

Undocumented member.

createCluster_clientAuthentication :: Lens' CreateCluster (Maybe ClientAuthentication) Source #

Includes all client authentication related information.

createCluster_tags :: Lens' CreateCluster (Maybe (HashMap Text Text)) Source #

Create tags when creating the cluster.

createCluster_encryptionInfo :: Lens' CreateCluster (Maybe EncryptionInfo) Source #

Includes all encryption-related information.

createCluster_brokerNodeGroupInfo :: Lens' CreateCluster BrokerNodeGroupInfo Source #

Information about the broker nodes in the cluster.

createCluster_kafkaVersion :: Lens' CreateCluster Text Source #

The version of Apache Kafka.

createCluster_numberOfBrokerNodes :: Lens' CreateCluster Natural Source #

The number of broker nodes in the cluster.

createCluster_clusterName :: Lens' CreateCluster Text Source #

The name of the cluster.

Destructuring the Response

data CreateClusterResponse Source #

See: newCreateClusterResponse smart constructor.

Constructors

CreateClusterResponse'
Fields 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) of the cluster. clusterName :: Maybe Text The name of the MSK cluster. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateClusterResponse Source #
Instance details Defined in Amazonka.Kafka.CreateCluster Methods (==) :: CreateClusterResponse -> CreateClusterResponse -> Bool # (/=) :: CreateClusterResponse -> CreateClusterResponse -> Bool #
Read CreateClusterResponse Source #
Instance details Defined in Amazonka.Kafka.CreateCluster Methods readsPrec :: Int -> ReadS CreateClusterResponse # readList :: ReadS [CreateClusterResponse] # readPrec :: ReadPrec CreateClusterResponse # readListPrec :: ReadPrec [CreateClusterResponse] #
Show CreateClusterResponse Source #
Instance details Defined in Amazonka.Kafka.CreateCluster Methods showsPrec :: Int -> CreateClusterResponse -> ShowS # show :: CreateClusterResponse -> String # showList :: [CreateClusterResponse] -> ShowS #
Generic CreateClusterResponse Source #
Instance details Defined in Amazonka.Kafka.CreateCluster Associated Types type Rep CreateClusterResponse :: Type -> Type # Methods from :: CreateClusterResponse -> Rep CreateClusterResponse x # to :: Rep CreateClusterResponse x -> CreateClusterResponse #
NFData CreateClusterResponse Source #
Instance details Defined in Amazonka.Kafka.CreateCluster Methods rnf :: CreateClusterResponse -> () #
type Rep CreateClusterResponse Source #
Instance details Defined in Amazonka.Kafka.CreateCluster type Rep CreateClusterResponse = D1 ('MetaData "CreateClusterResponse" "Amazonka.Kafka.CreateCluster" "libZSservicesZSamazonka-kafkaZSamazonka-kafka" 'False) (C1 ('MetaCons "CreateClusterResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterState)) :: S1 ('MetaSel ('Just "clusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "clusterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateClusterResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateClusterResponse'`
-> CreateClusterResponse

Create a value of CreateClusterResponse 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:state:CreateClusterResponse', createClusterResponse_state - The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

$sel:clusterArn:CreateClusterResponse', createClusterResponse_clusterArn - The Amazon Resource Name (ARN) of the cluster.

$sel:clusterName:CreateCluster', createClusterResponse_clusterName - The name of the MSK cluster.

$sel:httpStatus:CreateClusterResponse', createClusterResponse_httpStatus - The response's http status code.

Response Lenses

createClusterResponse_state :: Lens' CreateClusterResponse (Maybe ClusterState) Source #

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

createClusterResponse_clusterArn :: Lens' CreateClusterResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

createClusterResponse_clusterName :: Lens' CreateClusterResponse (Maybe Text) Source #

The name of the MSK cluster.

createClusterResponse_httpStatus :: Lens' CreateClusterResponse Int Source #

The response's http status code.