You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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",
}

Describes the server-side encryption that will be applied to the restore results.

Instance Attribute Summary collapse

Instance Attribute Details

#encryption_typeString

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

Returns:

  • (String)


2104
2105
2106
2107
2108
2109
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2104

class Encryption < Struct.new(
  :encryption_type,
  :kms_key_id,
  :kms_context)
  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)


2104
2105
2106
2107
2108
2109
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2104

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

#kms_key_idString

If the encryption type is aws:kms, this optional value specifies the AWS KMS key ID to use for encryption of job results.

Returns:

  • (String)


2104
2105
2106
2107
2108
2109
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 2104

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