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.CloudWatchLogs.AssociateKmsKey

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Associates the specified KMS key with the specified log group.

Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS keyis still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.

CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.

It can take up to 5 minutes for this operation to take effect.

If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.

Synopsis

Creating a Request

data AssociateKmsKey Source #

See: newAssociateKmsKey smart constructor.

Constructors

AssociateKmsKey'
Fields logGroupName :: Text The name of the log group. kmsKeyId :: Text The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. This must be a symmetric KMS key. For more information, see Amazon Resource Names and Using Symmetric and Asymmetric Keys.

Instances

Instances details

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

newAssociateKmsKey Source #

Arguments

:: Text	`AssociateKmsKey`
-> Text	`AssociateKmsKey`
-> AssociateKmsKey

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

AssociateKmsKey, associateKmsKey_logGroupName - The name of the log group.

AssociateKmsKey, associateKmsKey_kmsKeyId - The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. This must be a symmetric KMS key. For more information, see Amazon Resource Names and Using Symmetric and Asymmetric Keys.

Request Lenses

associateKmsKey_logGroupName :: Lens' AssociateKmsKey Text Source #

The name of the log group.

associateKmsKey_kmsKeyId :: Lens' AssociateKmsKey Text Source #

The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. This must be a symmetric KMS key. For more information, see Amazon Resource Names and Using Symmetric and Asymmetric Keys.

Destructuring the Response

data AssociateKmsKeyResponse Source #

See: newAssociateKmsKeyResponse smart constructor.

Constructors

AssociateKmsKeyResponse'

Instances

Instances details

Generic AssociateKmsKeyResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.AssociateKmsKey Associated Types type Rep AssociateKmsKeyResponse :: Type -> Type # Methods from :: AssociateKmsKeyResponse -> Rep AssociateKmsKeyResponse x # to :: Rep AssociateKmsKeyResponse x -> AssociateKmsKeyResponse #
Read AssociateKmsKeyResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.AssociateKmsKey Methods readsPrec :: Int -> ReadS AssociateKmsKeyResponse # readList :: ReadS [AssociateKmsKeyResponse] # readPrec :: ReadPrec AssociateKmsKeyResponse # readListPrec :: ReadPrec [AssociateKmsKeyResponse] #
Show AssociateKmsKeyResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.AssociateKmsKey Methods showsPrec :: Int -> AssociateKmsKeyResponse -> ShowS # show :: AssociateKmsKeyResponse -> String # showList :: [AssociateKmsKeyResponse] -> ShowS #
NFData AssociateKmsKeyResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.AssociateKmsKey Methods rnf :: AssociateKmsKeyResponse -> () #
Eq AssociateKmsKeyResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.AssociateKmsKey Methods (==) :: AssociateKmsKeyResponse -> AssociateKmsKeyResponse -> Bool # (/=) :: AssociateKmsKeyResponse -> AssociateKmsKeyResponse -> Bool #
type Rep AssociateKmsKeyResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.AssociateKmsKey type Rep AssociateKmsKeyResponse = D1 ('MetaData "AssociateKmsKeyResponse" "Amazonka.CloudWatchLogs.AssociateKmsKey" "amazonka-cloudwatch-logs-2.0-6gvDalNFsfE8djZ4aTfA4V" 'False) (C1 ('MetaCons "AssociateKmsKeyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newAssociateKmsKeyResponse :: AssociateKmsKeyResponse Source #

Create a value of AssociateKmsKeyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.