Class: Aws::CloudWatchLogs::Types::AssociateKmsKeyRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudwatchlogs/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#kms_key_id ⇒ String

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

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms [2]: docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html

Returns:

  • (String) 


334
335
336
337
338
339
340
 
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 334

class AssociateKmsKeyRequest < Struct.new(
  :log_group_name,
  :kms_key_id,
  :resource_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_name ⇒ String

The name of the log group.

In your ‘AssociateKmsKey` operation, you must specify either the `resourceIdentifier` parameter or the `logGroup` parameter, but you can’t specify both.

Returns:

  • (String) 


334
335
336
337
338
339
340
 
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 334

class AssociateKmsKeyRequest < Struct.new(
  :log_group_name,
  :kms_key_id,
  :resource_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#resource_identifier ⇒ String

Specifies the target for this operation. You must specify one of the following:

  • Specify the following ARN to have future [GetQueryResults] operations in this account encrypt the results with the specified KMS key. Replace REGION and ACCOUNT_ID with your Region and account ID.

    ‘arn:aws:logs:REGION:ACCOUNT_ID:query-result:*`

  • Specify the ARN of a log group to have CloudWatch Logs use the KMS key to encrypt log events that are ingested and stored by that log group. The log group ARN must be in the following format. Replace REGION and ACCOUNT_ID with your Region and account ID.

    ‘arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME `

In your ‘AssociateKmsKey` operation, you must specify either the `resourceIdentifier` parameter or the `logGroup` parameter, but you can’t specify both.

[1]: docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html

Returns:

  • (String) 


334
335
336
337
338
339
340
 
# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 334

class AssociateKmsKeyRequest < Struct.new(
  :log_group_name,
  :kms_key_id,
  :resource_identifier)
  SENSITIVE = []
  include Aws::Structure
end