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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new MSK configuration.

Synopsis

data CreateConfiguration = CreateConfiguration' {
- description :: Maybe Text
- kafkaVersions :: Maybe [Text]
- serverProperties :: Base64
- name :: Text
}
newCreateConfiguration :: ByteString -> Text -> CreateConfiguration
createConfiguration_description :: Lens' CreateConfiguration (Maybe Text)
createConfiguration_kafkaVersions :: Lens' CreateConfiguration (Maybe [Text])
createConfiguration_serverProperties :: Lens' CreateConfiguration ByteString
createConfiguration_name :: Lens' CreateConfiguration Text
data CreateConfigurationResponse = CreateConfigurationResponse' {
- arn :: Maybe Text
- creationTime :: Maybe ISO8601
- latestRevision :: Maybe ConfigurationRevision
- name :: Maybe Text
- state :: Maybe ConfigurationState
- httpStatus :: Int
}
newCreateConfigurationResponse :: Int -> CreateConfigurationResponse
createConfigurationResponse_arn :: Lens' CreateConfigurationResponse (Maybe Text)
createConfigurationResponse_creationTime :: Lens' CreateConfigurationResponse (Maybe UTCTime)
createConfigurationResponse_latestRevision :: Lens' CreateConfigurationResponse (Maybe ConfigurationRevision)
createConfigurationResponse_name :: Lens' CreateConfigurationResponse (Maybe Text)
createConfigurationResponse_state :: Lens' CreateConfigurationResponse (Maybe ConfigurationState)
createConfigurationResponse_httpStatus :: Lens' CreateConfigurationResponse Int

Creating a Request

data CreateConfiguration Source #

See: newCreateConfiguration smart constructor.

Constructors

CreateConfiguration'

Fields

description :: Maybe Text
The description of the configuration.
kafkaVersions :: Maybe [Text]
The versions of Apache Kafka with which you can use this MSK configuration.
serverProperties :: Base64
Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.
name :: Text
The name of the configuration.

Instances

Instances details

ToJSON CreateConfiguration Source #
Instance details Defined in Amazonka.Kafka.CreateConfiguration Methods toJSON :: CreateConfiguration -> Value # toEncoding :: CreateConfiguration -> Encoding # toJSONList :: [CreateConfiguration] -> Value # toEncodingList :: [CreateConfiguration] -> Encoding #
ToHeaders CreateConfiguration Source #
Instance details Defined in Amazonka.Kafka.CreateConfiguration Methods toHeaders :: CreateConfiguration -> [Header] #
ToPath CreateConfiguration Source #
Instance details Defined in Amazonka.Kafka.CreateConfiguration Methods toPath :: CreateConfiguration -> ByteString #
ToQuery CreateConfiguration Source #
Instance details Defined in Amazonka.Kafka.CreateConfiguration Methods toQuery :: CreateConfiguration -> QueryString #
AWSRequest CreateConfiguration Source #
Instance details Defined in Amazonka.Kafka.CreateConfiguration Associated Types type AWSResponse CreateConfiguration # Methods request :: (Service -> Service) -> CreateConfiguration -> Request CreateConfiguration # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateConfiguration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateConfiguration))) #
Generic CreateConfiguration Source #
Instance details Defined in Amazonka.Kafka.CreateConfiguration Associated Types type Rep CreateConfiguration :: Type -> Type # Methods from :: CreateConfiguration -> Rep CreateConfiguration x # to :: Rep CreateConfiguration x -> CreateConfiguration #
Read CreateConfiguration Source #
Instance details Defined in Amazonka.Kafka.CreateConfiguration Methods readsPrec :: Int -> ReadS CreateConfiguration # readList :: ReadS [CreateConfiguration] # readPrec :: ReadPrec CreateConfiguration # readListPrec :: ReadPrec [CreateConfiguration] #
Show CreateConfiguration Source #
Instance details Defined in Amazonka.Kafka.CreateConfiguration Methods showsPrec :: Int -> CreateConfiguration -> ShowS # show :: CreateConfiguration -> String # showList :: [CreateConfiguration] -> ShowS #
NFData CreateConfiguration Source #
Instance details Defined in Amazonka.Kafka.CreateConfiguration Methods rnf :: CreateConfiguration -> () #
Eq CreateConfiguration Source #
Instance details Defined in Amazonka.Kafka.CreateConfiguration Methods (==) :: CreateConfiguration -> CreateConfiguration -> Bool # (/=) :: CreateConfiguration -> CreateConfiguration -> Bool #
Hashable CreateConfiguration Source #
Instance details Defined in Amazonka.Kafka.CreateConfiguration Methods hashWithSalt :: Int -> CreateConfiguration -> Int # hash :: CreateConfiguration -> Int #
type AWSResponse CreateConfiguration Source #
Instance details Defined in Amazonka.Kafka.CreateConfiguration type AWSResponse CreateConfiguration = CreateConfigurationResponse
type Rep CreateConfiguration Source #
Instance details Defined in Amazonka.Kafka.CreateConfiguration type Rep CreateConfiguration = D1 ('MetaData "CreateConfiguration" "Amazonka.Kafka.CreateConfiguration" "amazonka-kafka-2.0-Go9aKmtSH8zJub8xGjzkib" 'False) (C1 ('MetaCons "CreateConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "kafkaVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "serverProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Base64) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateConfiguration Source #

Arguments

:: ByteString	`$sel:serverProperties:CreateConfiguration'`
-> Text	`CreateConfiguration`
-> CreateConfiguration

Create a value of CreateConfiguration 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:

CreateConfiguration, createConfiguration_description - The description of the configuration.

CreateConfiguration, createConfiguration_kafkaVersions - The versions of Apache Kafka with which you can use this MSK configuration.

$sel:serverProperties:CreateConfiguration', createConfiguration_serverProperties - Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

CreateConfiguration, createConfiguration_name - The name of the configuration.

Request Lenses

createConfiguration_description :: Lens' CreateConfiguration (Maybe Text) Source #

The description of the configuration.

createConfiguration_kafkaVersions :: Lens' CreateConfiguration (Maybe [Text]) Source #

The versions of Apache Kafka with which you can use this MSK configuration.

createConfiguration_serverProperties :: Lens' CreateConfiguration ByteString Source #

Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

createConfiguration_name :: Lens' CreateConfiguration Text Source #

The name of the configuration.

Destructuring the Response

data CreateConfigurationResponse Source #

See: newCreateConfigurationResponse smart constructor.

Constructors

CreateConfigurationResponse'

Fields

arn :: Maybe Text
The Amazon Resource Name (ARN) of the configuration.
creationTime :: Maybe ISO8601
The time when the configuration was created.
latestRevision :: Maybe ConfigurationRevision
Latest revision of the configuration.
name :: Maybe Text
The name of the configuration.
state :: Maybe ConfigurationState
The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CreateConfigurationResponse Source #
Instance details Defined in Amazonka.Kafka.CreateConfiguration Associated Types type Rep CreateConfigurationResponse :: Type -> Type # Methods from :: CreateConfigurationResponse -> Rep CreateConfigurationResponse x # to :: Rep CreateConfigurationResponse x -> CreateConfigurationResponse #
Read CreateConfigurationResponse Source #
Instance details Defined in Amazonka.Kafka.CreateConfiguration Methods readsPrec :: Int -> ReadS CreateConfigurationResponse # readList :: ReadS [CreateConfigurationResponse] # readPrec :: ReadPrec CreateConfigurationResponse # readListPrec :: ReadPrec [CreateConfigurationResponse] #
Show CreateConfigurationResponse Source #
Instance details Defined in Amazonka.Kafka.CreateConfiguration Methods showsPrec :: Int -> CreateConfigurationResponse -> ShowS # show :: CreateConfigurationResponse -> String # showList :: [CreateConfigurationResponse] -> ShowS #
NFData CreateConfigurationResponse Source #
Instance details Defined in Amazonka.Kafka.CreateConfiguration Methods rnf :: CreateConfigurationResponse -> () #
Eq CreateConfigurationResponse Source #
Instance details Defined in Amazonka.Kafka.CreateConfiguration Methods (==) :: CreateConfigurationResponse -> CreateConfigurationResponse -> Bool # (/=) :: CreateConfigurationResponse -> CreateConfigurationResponse -> Bool #
type Rep CreateConfigurationResponse Source #
Instance details Defined in Amazonka.Kafka.CreateConfiguration type Rep CreateConfigurationResponse = D1 ('MetaData "CreateConfigurationResponse" "Amazonka.Kafka.CreateConfiguration" "amazonka-kafka-2.0-Go9aKmtSH8zJub8xGjzkib" 'False) (C1 ('MetaCons "CreateConfigurationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "latestRevision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfigurationRevision)))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfigurationState)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateConfigurationResponse Source #

Arguments

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

Create a value of CreateConfigurationResponse 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:

CreateConfigurationResponse, createConfigurationResponse_arn - The Amazon Resource Name (ARN) of the configuration.

CreateConfigurationResponse, createConfigurationResponse_creationTime - The time when the configuration was created.

CreateConfigurationResponse, createConfigurationResponse_latestRevision - Latest revision of the configuration.

CreateConfiguration, createConfigurationResponse_name - The name of the configuration.

CreateConfigurationResponse, createConfigurationResponse_state - The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

$sel:httpStatus:CreateConfigurationResponse', createConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

createConfigurationResponse_arn :: Lens' CreateConfigurationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the configuration.

createConfigurationResponse_creationTime :: Lens' CreateConfigurationResponse (Maybe UTCTime) Source #

The time when the configuration was created.

createConfigurationResponse_latestRevision :: Lens' CreateConfigurationResponse (Maybe ConfigurationRevision) Source #

Latest revision of the configuration.

createConfigurationResponse_name :: Lens' CreateConfigurationResponse (Maybe Text) Source #

The name of the configuration.

createConfigurationResponse_state :: Lens' CreateConfigurationResponse (Maybe ConfigurationState) Source #

The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

createConfigurationResponse_httpStatus :: Lens' CreateConfigurationResponse Int Source #

The response's http status code.