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

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Associates the specified Key Management Service customer master key (CMK) with the specified log group.

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

CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK 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 CMK with a log group but the CMK does not exist or the CMK 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 CMK to use when encrypting log data. This must be a symmetric CMK. For more information, see Amazon Resource Names - Key Management Service and Using Symmetric and Asymmetric Keys.

Instances

Instances details

Eq AssociateKmsKey Source #
Instance details Defined in Amazonka.CloudWatchLogs.AssociateKmsKey Methods (==) :: AssociateKmsKey -> AssociateKmsKey -> Bool # (/=) :: AssociateKmsKey -> AssociateKmsKey -> Bool #
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 #
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 #
NFData AssociateKmsKey Source #
Instance details Defined in Amazonka.CloudWatchLogs.AssociateKmsKey Methods rnf :: AssociateKmsKey -> () #
Hashable AssociateKmsKey Source #
Instance details Defined in Amazonka.CloudWatchLogs.AssociateKmsKey Methods hashWithSalt :: Int -> AssociateKmsKey -> Int # hash :: AssociateKmsKey -> Int #
ToJSON AssociateKmsKey Source #
Instance details Defined in Amazonka.CloudWatchLogs.AssociateKmsKey Methods toJSON :: AssociateKmsKey -> Value # toEncoding :: AssociateKmsKey -> Encoding # toJSONList :: [AssociateKmsKey] -> Value # toEncodingList :: [AssociateKmsKey] -> Encoding #
AWSRequest AssociateKmsKey Source #
Instance details Defined in Amazonka.CloudWatchLogs.AssociateKmsKey Associated Types type AWSResponse AssociateKmsKey # Methods request :: AssociateKmsKey -> Request AssociateKmsKey # response :: MonadResource m => Logger -> Service -> Proxy AssociateKmsKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AssociateKmsKey))) #
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 #
type Rep AssociateKmsKey Source #
Instance details Defined in Amazonka.CloudWatchLogs.AssociateKmsKey type Rep AssociateKmsKey = D1 ('MetaData "AssociateKmsKey" "Amazonka.CloudWatchLogs.AssociateKmsKey" "libZSservicesZSamazonka-cloudwatch-logsZSamazonka-cloudwatch-logs" 'False) (C1 ('MetaCons "AssociateKmsKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "logGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse AssociateKmsKey Source #
Instance details Defined in Amazonka.CloudWatchLogs.AssociateKmsKey type AWSResponse AssociateKmsKey = AssociateKmsKeyResponse

newAssociateKmsKey Source #

Arguments

:: Text	`$sel:logGroupName:AssociateKmsKey'`
-> Text	`$sel:kmsKeyId: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:

$sel:logGroupName:AssociateKmsKey', associateKmsKey_logGroupName - The name of the log group.

$sel:kmsKeyId:AssociateKmsKey', associateKmsKey_kmsKeyId - The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. This must be a symmetric CMK. For more information, see Amazon Resource Names - Key Management Service 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 CMK to use when encrypting log data. This must be a symmetric CMK. For more information, see Amazon Resource Names - Key Management Service and Using Symmetric and Asymmetric Keys.

Destructuring the Response

data AssociateKmsKeyResponse Source #

See: newAssociateKmsKeyResponse smart constructor.

Constructors

AssociateKmsKeyResponse'

Instances

Instances details

Eq AssociateKmsKeyResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.AssociateKmsKey Methods (==) :: AssociateKmsKeyResponse -> AssociateKmsKeyResponse -> Bool # (/=) :: AssociateKmsKeyResponse -> AssociateKmsKeyResponse -> Bool #
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 #
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 #
NFData AssociateKmsKeyResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.AssociateKmsKey Methods rnf :: AssociateKmsKeyResponse -> () #
type Rep AssociateKmsKeyResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.AssociateKmsKey type Rep AssociateKmsKeyResponse = D1 ('MetaData "AssociateKmsKeyResponse" "Amazonka.CloudWatchLogs.AssociateKmsKey" "libZSservicesZSamazonka-cloudwatch-logsZSamazonka-cloudwatch-logs" '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.