Class: Aws::S3Control::Types::SSEKMSFilter

Inherits:

Struct

Object
Struct
Aws::S3Control::Types::SSEKMSFilter

show all

Defined in:: gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb

Overview

A filter that returns objects that are encrypted by server-side encryption with Amazon Web Services KMS (SSE-KMS).

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#bucket_key_enabled ⇒ Boolean
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Amazon Web Services Key Management Service (Amazon Web Services KMS) keys (SSE-KMS).
#kms_key_arn ⇒ String
The Amazon Resource Name (ARN) of the customer managed KMS key to use for the filter to return objects that are encrypted by the specified key.

Instance Attribute Details

#bucket_key_enabled ⇒ `Boolean`

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Amazon Web Services Key Management Service (Amazon Web Services KMS) keys (SSE-KMS). If specified, will filter SSE-KMS encrypted objects by S3 Bucket Key status. For more information, see Reducing the cost of SSE-KMS with Amazon S3 Bucket Keys in the Amazon S3 User Guide.

Returns:

(Boolean)

# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 8091

class SSEKMSFilter < Struct.new(
  :kms_key_arn,
  :bucket_key_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arn ⇒ `String`

The Amazon Resource Name (ARN) of the customer managed KMS key to use for the filter to return objects that are encrypted by the specified key. For best performance, we recommend using the KMSKeyArn filter in conjunction with other object metadata filters, like MatchAnyPrefix, CreatedAfter, or MatchAnyStorageClass.

You must provide the full KMS Key ARN. You can't use an alias name or alias ARN. For more information, see KMS keys in the Amazon Web Services Key Management Service Developer Guide.