Class: Aws::S3::Types::Encryption

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass Encryption data as a hash:

{
  encryption_type: "AES256", # required, accepts AES256, aws:kms
  kms_key_id: "SSEKMSKeyId",
  kms_context: "KMSContext",
}

Contains the type of server-side encryption used.

Constant Summary collapse

SENSITIVE =
[:kms_key_id]

Instance Attribute Summary collapse

Instance Attribute Details

#encryption_typeString

The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).

Returns:

  • (String)


3285
3286
3287
3288
3289
3290
3291
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3285

class Encryption < Struct.new(
  :encryption_type,
  :kms_key_id,
  :kms_context)
  SENSITIVE = [:kms_key_id]
  include Aws::Structure
end

#kms_contextString

If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.

Returns:

  • (String)


3285
3286
3287
3288
3289
3290
3291
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3285

class Encryption < Struct.new(
  :encryption_type,
  :kms_key_id,
  :kms_context)
  SENSITIVE = [:kms_key_id]
  include Aws::Structure
end

#kms_key_idString

If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed key to use for encryption of job results. Amazon S3 only supports symmetric keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

Returns:

  • (String)


3285
3286
3287
3288
3289
3290
3291
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3285

class Encryption < Struct.new(
  :encryption_type,
  :kms_key_id,
  :kms_context)
  SENSITIVE = [:kms_key_id]
  include Aws::Structure
end