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

Class: Aws::Glacier::Types::Encryption

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

Overview

Note:

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

{
  encryption_type: "aws:kms", # accepts aws:kms, AES256
  kms_key_id: "string",
  kms_context: "string",
}

Contains information about the encryption used to store the job results in Amazon S3.

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 or aws:kms.

Returns:

  • (String)


706
707
708
709
710
711
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 706

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

#kms_contextString

Optional. If the encryption type is aws:kms, you can use this value to specify the encryption context for the job results.

Returns:

  • (String)


706
707
708
709
710
711
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 706

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

#kms_key_idString

The AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS fail if not made by using Secure Sockets Layer (SSL) or Signature Version 4.

Returns:

  • (String)


706
707
708
709
710
711
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 706

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