Class: Aws::S3::Types::Encryption
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::Encryption
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-s3/types.rb
Overview
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
-
#encryption_type ⇒ String
The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).
-
#kms_context ⇒ String
If the encryption type is ‘aws:kms`, this optional value can be used to specify the encryption context for the restore results.
-
#kms_key_id ⇒ String
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.
Instance Attribute Details
#encryption_type ⇒ String
The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).
3766 3767 3768 3769 3770 3771 3772 |
# File 'lib/aws-sdk-s3/types.rb', line 3766 class Encryption < Struct.new( :encryption_type, :kms_key_id, :kms_context) SENSITIVE = [:kms_key_id] include Aws::Structure end |
#kms_context ⇒ String
If the encryption type is ‘aws:kms`, this optional value can be used to specify the encryption context for the restore results.
3766 3767 3768 3769 3770 3771 3772 |
# File 'lib/aws-sdk-s3/types.rb', line 3766 class Encryption < Struct.new( :encryption_type, :kms_key_id, :kms_context) SENSITIVE = [:kms_key_id] include Aws::Structure end |
#kms_key_id ⇒ String
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*.
[1]: docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
3766 3767 3768 3769 3770 3771 3772 |
# File 'lib/aws-sdk-s3/types.rb', line 3766 class Encryption < Struct.new( :encryption_type, :kms_key_id, :kms_context) SENSITIVE = [:kms_key_id] include Aws::Structure end |