cloudwatchlogs_associate_kms_key: Associates the specified AWS Key Management Service (AWS KMS)...

Description Usage Arguments Value Request syntax

View source: R/cloudwatchlogs_operations.R

Description

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.

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.

Usage

1
cloudwatchlogs_associate_kms_key(logGroupName, kmsKeyId)

Arguments

logGroupName

[required] The name of the log group.

kmsKeyId

[required] 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 - AWS Key Management Service (AWS KMS) and Using Symmetric and Asymmetric Keys.

Value

An empty list.

Request syntax

1
2
3
4
svc$associate_kms_key(
  logGroupName = "string",
  kmsKeyId = "string"
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.