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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.

Synopsis

data UpdateMonitoring = UpdateMonitoring' {
- enhancedMonitoring :: Maybe EnhancedMonitoring
- loggingInfo :: Maybe LoggingInfo
- openMonitoring :: Maybe OpenMonitoringInfo
- clusterArn :: Text
- currentVersion :: Text
}
newUpdateMonitoring :: Text -> Text -> UpdateMonitoring
updateMonitoring_enhancedMonitoring :: Lens' UpdateMonitoring (Maybe EnhancedMonitoring)
updateMonitoring_loggingInfo :: Lens' UpdateMonitoring (Maybe LoggingInfo)
updateMonitoring_openMonitoring :: Lens' UpdateMonitoring (Maybe OpenMonitoringInfo)
updateMonitoring_clusterArn :: Lens' UpdateMonitoring Text
updateMonitoring_currentVersion :: Lens' UpdateMonitoring Text
data UpdateMonitoringResponse = UpdateMonitoringResponse' {
- clusterArn :: Maybe Text
- clusterOperationArn :: Maybe Text
- httpStatus :: Int
}
newUpdateMonitoringResponse :: Int -> UpdateMonitoringResponse
updateMonitoringResponse_clusterArn :: Lens' UpdateMonitoringResponse (Maybe Text)
updateMonitoringResponse_clusterOperationArn :: Lens' UpdateMonitoringResponse (Maybe Text)
updateMonitoringResponse_httpStatus :: Lens' UpdateMonitoringResponse Int

Creating a Request

data UpdateMonitoring Source #

Request body for UpdateMonitoring.

See: newUpdateMonitoring smart constructor.

Constructors

UpdateMonitoring'

Fields

enhancedMonitoring :: Maybe EnhancedMonitoring
Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
loggingInfo :: Maybe LoggingInfo
openMonitoring :: Maybe OpenMonitoringInfo
The settings for open monitoring.
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

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

newUpdateMonitoring Source #

Arguments

:: Text	`UpdateMonitoring`
-> Text	`UpdateMonitoring`
-> UpdateMonitoring

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

UpdateMonitoring, updateMonitoring_enhancedMonitoring - Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

UpdateMonitoring, updateMonitoring_loggingInfo - Undocumented member.

UpdateMonitoring, updateMonitoring_openMonitoring - The settings for open monitoring.

UpdateMonitoring, updateMonitoring_clusterArn - The Amazon Resource Name (ARN) that uniquely identifies the cluster.

UpdateMonitoring, updateMonitoring_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

updateMonitoring_enhancedMonitoring :: Lens' UpdateMonitoring (Maybe EnhancedMonitoring) Source #

Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

updateMonitoring_loggingInfo :: Lens' UpdateMonitoring (Maybe LoggingInfo) Source #

Undocumented member.

updateMonitoring_openMonitoring :: Lens' UpdateMonitoring (Maybe OpenMonitoringInfo) Source #

The settings for open monitoring.

updateMonitoring_clusterArn :: Lens' UpdateMonitoring Text Source #

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

updateMonitoring_currentVersion :: Lens' UpdateMonitoring 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 UpdateMonitoringResponse Source #

See: newUpdateMonitoringResponse smart constructor.

Constructors

UpdateMonitoringResponse'
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

Generic UpdateMonitoringResponse Source #
Instance details Defined in Amazonka.Kafka.UpdateMonitoring Associated Types type Rep UpdateMonitoringResponse :: Type -> Type # Methods from :: UpdateMonitoringResponse -> Rep UpdateMonitoringResponse x # to :: Rep UpdateMonitoringResponse x -> UpdateMonitoringResponse #
Read UpdateMonitoringResponse Source #
Instance details Defined in Amazonka.Kafka.UpdateMonitoring Methods readsPrec :: Int -> ReadS UpdateMonitoringResponse # readList :: ReadS [UpdateMonitoringResponse] # readPrec :: ReadPrec UpdateMonitoringResponse # readListPrec :: ReadPrec [UpdateMonitoringResponse] #
Show UpdateMonitoringResponse Source #
Instance details Defined in Amazonka.Kafka.UpdateMonitoring Methods showsPrec :: Int -> UpdateMonitoringResponse -> ShowS # show :: UpdateMonitoringResponse -> String # showList :: [UpdateMonitoringResponse] -> ShowS #
NFData UpdateMonitoringResponse Source #
Instance details Defined in Amazonka.Kafka.UpdateMonitoring Methods rnf :: UpdateMonitoringResponse -> () #
Eq UpdateMonitoringResponse Source #
Instance details Defined in Amazonka.Kafka.UpdateMonitoring Methods (==) :: UpdateMonitoringResponse -> UpdateMonitoringResponse -> Bool # (/=) :: UpdateMonitoringResponse -> UpdateMonitoringResponse -> Bool #
type Rep UpdateMonitoringResponse Source #
Instance details Defined in Amazonka.Kafka.UpdateMonitoring type Rep UpdateMonitoringResponse = D1 ('MetaData "UpdateMonitoringResponse" "Amazonka.Kafka.UpdateMonitoring" "amazonka-kafka-2.0-Go9aKmtSH8zJub8xGjzkib" 'False) (C1 ('MetaCons "UpdateMonitoringResponse'" '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))))

newUpdateMonitoringResponse Source #

Arguments

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

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

UpdateMonitoring, updateMonitoringResponse_clusterArn - The Amazon Resource Name (ARN) of the cluster.

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

$sel:httpStatus:UpdateMonitoringResponse', updateMonitoringResponse_httpStatus - The response's http status code.

Response Lenses

updateMonitoringResponse_clusterArn :: Lens' UpdateMonitoringResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

updateMonitoringResponse_clusterOperationArn :: Lens' UpdateMonitoringResponse (Maybe Text) Source #

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

updateMonitoringResponse_httpStatus :: Lens' UpdateMonitoringResponse Int Source #

The response's http status code.