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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters.

Synopsis

data UpdateSecurity = UpdateSecurity' {
- clientAuthentication :: Maybe ClientAuthentication
- encryptionInfo :: Maybe EncryptionInfo
- clusterArn :: Text
- currentVersion :: Text
}
newUpdateSecurity :: Text -> Text -> UpdateSecurity
updateSecurity_clientAuthentication :: Lens' UpdateSecurity (Maybe ClientAuthentication)
updateSecurity_encryptionInfo :: Lens' UpdateSecurity (Maybe EncryptionInfo)
updateSecurity_clusterArn :: Lens' UpdateSecurity Text
updateSecurity_currentVersion :: Lens' UpdateSecurity Text
data UpdateSecurityResponse = UpdateSecurityResponse' {
- clusterArn :: Maybe Text
- clusterOperationArn :: Maybe Text
- httpStatus :: Int
}
newUpdateSecurityResponse :: Int -> UpdateSecurityResponse
updateSecurityResponse_clusterArn :: Lens' UpdateSecurityResponse (Maybe Text)
updateSecurityResponse_clusterOperationArn :: Lens' UpdateSecurityResponse (Maybe Text)
updateSecurityResponse_httpStatus :: Lens' UpdateSecurityResponse Int

Creating a Request

data UpdateSecurity Source #

See: newUpdateSecurity smart constructor.

Constructors

UpdateSecurity'

Fields

clientAuthentication :: Maybe ClientAuthentication
Includes all client authentication related information.
encryptionInfo :: Maybe EncryptionInfo
Includes all encryption-related information.
clusterArn :: Text
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
currentVersion :: Text
The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.

Instances

Instances details

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

newUpdateSecurity Source #

Arguments

:: Text	`$sel:clusterArn:UpdateSecurity'`
-> Text	`$sel:currentVersion:UpdateSecurity'`
-> UpdateSecurity

Create a value of UpdateSecurity 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:clientAuthentication:UpdateSecurity', updateSecurity_clientAuthentication - Includes all client authentication related information.

$sel:encryptionInfo:UpdateSecurity', updateSecurity_encryptionInfo - Includes all encryption-related information.

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

$sel:currentVersion:UpdateSecurity', updateSecurity_currentVersion - The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.

Request Lenses

updateSecurity_clientAuthentication :: Lens' UpdateSecurity (Maybe ClientAuthentication) Source #

Includes all client authentication related information.

updateSecurity_encryptionInfo :: Lens' UpdateSecurity (Maybe EncryptionInfo) Source #

Includes all encryption-related information.

updateSecurity_clusterArn :: Lens' UpdateSecurity Text Source #

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

updateSecurity_currentVersion :: Lens' UpdateSecurity Text Source #

The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.

Destructuring the Response

data UpdateSecurityResponse Source #

See: newUpdateSecurityResponse smart constructor.

Constructors

UpdateSecurityResponse'
Fields clusterArn :: Maybe Text The Amazon Resource Name (ARN) of the cluster. clusterOperationArn :: Maybe Text The Amazon Resource Name (ARN) of the cluster operation. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newUpdateSecurityResponse Source #

Arguments

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

Create a value of UpdateSecurityResponse 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:clusterArn:UpdateSecurity', updateSecurityResponse_clusterArn - The Amazon Resource Name (ARN) of the cluster.

$sel:clusterOperationArn:UpdateSecurityResponse', updateSecurityResponse_clusterOperationArn - The Amazon Resource Name (ARN) of the cluster operation.

$sel:httpStatus:UpdateSecurityResponse', updateSecurityResponse_httpStatus - The response's http status code.

Response Lenses

updateSecurityResponse_clusterArn :: Lens' UpdateSecurityResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

updateSecurityResponse_clusterOperationArn :: Lens' UpdateSecurityResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster operation.

updateSecurityResponse_httpStatus :: Lens' UpdateSecurityResponse Int Source #

The response's http status code.