Network.AWS.CloudWatchLogs.AssociateKMSKey

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

Associating an AWS 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 Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.

Note that 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 will receive an InvalidParameterException error.

Creating a Request

associateKMSKey

Arguments

:: Text

akkLogGroupName

-> Text

akkKmsKeyId

-> AssociateKMSKey

Creates a value of AssociateKMSKey with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• akkLogGroupName - The name of the log group.
• akkKmsKeyId - The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. For more information, see Amazon Resource Names - AWS Key Management Service (AWS KMS) .

data AssociateKMSKey

See: associateKMSKey smart constructor.

Instances

Eq AssociateKMSKey

Methods

(==) :: AssociateKMSKey -> AssociateKMSKey -> Bool

(/=) :: AssociateKMSKey -> AssociateKMSKey -> Bool

Data AssociateKMSKey

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AssociateKMSKey -> c AssociateKMSKey

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AssociateKMSKey

toConstr :: AssociateKMSKey -> Constr

dataTypeOf :: AssociateKMSKey -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AssociateKMSKey)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AssociateKMSKey)

gmapT :: (forall b. Data b => b -> b) -> AssociateKMSKey -> AssociateKMSKey

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AssociateKMSKey -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AssociateKMSKey -> r

gmapQ :: (forall d. Data d => d -> u) -> AssociateKMSKey -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> AssociateKMSKey -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AssociateKMSKey -> m AssociateKMSKey

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AssociateKMSKey -> m AssociateKMSKey

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AssociateKMSKey -> m AssociateKMSKey

Read AssociateKMSKey

Methods

readsPrec :: Int -> ReadS AssociateKMSKey

readList :: ReadS [AssociateKMSKey]

readPrec :: ReadPrec AssociateKMSKey

readListPrec :: ReadPrec [AssociateKMSKey]

Show AssociateKMSKey

Methods

showsPrec :: Int -> AssociateKMSKey -> ShowS

show :: AssociateKMSKey -> String

showList :: [AssociateKMSKey] -> ShowS

Generic AssociateKMSKey

Associated Types

type Rep AssociateKMSKey :: * -> *

Methods

from :: AssociateKMSKey -> Rep AssociateKMSKey x

to :: Rep AssociateKMSKey x -> AssociateKMSKey

Hashable AssociateKMSKey

Methods

hashWithSalt :: Int -> AssociateKMSKey -> Int

hash :: AssociateKMSKey -> Int

ToJSON AssociateKMSKey

Methods

toJSON :: AssociateKMSKey -> Value

toEncoding :: AssociateKMSKey -> Encoding

toJSONList :: [AssociateKMSKey] -> Value

toEncodingList :: [AssociateKMSKey] -> Encoding

NFData AssociateKMSKey

Methods

rnf :: AssociateKMSKey -> ()

AWSRequest AssociateKMSKey

Associated Types

type Rs AssociateKMSKey :: *

Methods

request :: AssociateKMSKey -> Request AssociateKMSKey

response :: MonadResource m => Logger -> Service -> Proxy * AssociateKMSKey -> ClientResponse -> m (Response AssociateKMSKey)

ToQuery AssociateKMSKey

Methods

toQuery :: AssociateKMSKey -> QueryString

ToPath AssociateKMSKey

Methods

toPath :: AssociateKMSKey -> ByteString

ToHeaders AssociateKMSKey

Methods

toHeaders :: AssociateKMSKey -> [Header]

type Rep AssociateKMSKey

type Rep AssociateKMSKey = D1 (MetaData "AssociateKMSKey" "Network.AWS.CloudWatchLogs.AssociateKMSKey" "amazonka-cloudwatch-logs-1.5.0-3vuxaAoYUATHD7OLMfoSU1" False) (C1 (MetaCons "AssociateKMSKey'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_akkLogGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_akkKmsKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs AssociateKMSKey

type Rs AssociateKMSKey = AssociateKMSKeyResponse

Request Lenses

akkLogGroupName :: Lens' AssociateKMSKey Text

The name of the log group.

akkKmsKeyId :: Lens' AssociateKMSKey Text

The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. For more information, see Amazon Resource Names - AWS Key Management Service (AWS KMS) .

Destructuring the Response

associateKMSKeyResponse :: AssociateKMSKeyResponse

Creates a value of AssociateKMSKeyResponse with the minimum fields required to make a request.

data AssociateKMSKeyResponse

See: associateKMSKeyResponse smart constructor.

Instances

Eq AssociateKMSKeyResponse

Methods

(==) :: AssociateKMSKeyResponse -> AssociateKMSKeyResponse -> Bool

(/=) :: AssociateKMSKeyResponse -> AssociateKMSKeyResponse -> Bool

Data AssociateKMSKeyResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AssociateKMSKeyResponse -> c AssociateKMSKeyResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AssociateKMSKeyResponse

toConstr :: AssociateKMSKeyResponse -> Constr

dataTypeOf :: AssociateKMSKeyResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AssociateKMSKeyResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AssociateKMSKeyResponse)

gmapT :: (forall b. Data b => b -> b) -> AssociateKMSKeyResponse -> AssociateKMSKeyResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AssociateKMSKeyResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AssociateKMSKeyResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> AssociateKMSKeyResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> AssociateKMSKeyResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AssociateKMSKeyResponse -> m AssociateKMSKeyResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AssociateKMSKeyResponse -> m AssociateKMSKeyResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AssociateKMSKeyResponse -> m AssociateKMSKeyResponse

Read AssociateKMSKeyResponse

Methods

readsPrec :: Int -> ReadS AssociateKMSKeyResponse

readList :: ReadS [AssociateKMSKeyResponse]

readPrec :: ReadPrec AssociateKMSKeyResponse

readListPrec :: ReadPrec [AssociateKMSKeyResponse]

Show AssociateKMSKeyResponse

Methods

showsPrec :: Int -> AssociateKMSKeyResponse -> ShowS

show :: AssociateKMSKeyResponse -> String

showList :: [AssociateKMSKeyResponse] -> ShowS

Generic AssociateKMSKeyResponse

Associated Types

type Rep AssociateKMSKeyResponse :: * -> *

Methods

from :: AssociateKMSKeyResponse -> Rep AssociateKMSKeyResponse x

to :: Rep AssociateKMSKeyResponse x -> AssociateKMSKeyResponse

NFData AssociateKMSKeyResponse

Methods

rnf :: AssociateKMSKeyResponse -> ()

type Rep AssociateKMSKeyResponse

type Rep AssociateKMSKeyResponse = D1 (MetaData "AssociateKMSKeyResponse" "Network.AWS.CloudWatchLogs.AssociateKMSKey" "amazonka-cloudwatch-logs-1.5.0-3vuxaAoYUATHD7OLMfoSU1" False) (C1 (MetaCons "AssociateKMSKeyResponse'" PrefixI False) U1)