Class: Aws::S3::Encryption::Materials

Inherits:
Object
  • Object
show all
Defined in:
lib/aws-sdk-resources/services/s3/encryption/materials.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Materials

Returns a new instance of Materials.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :encryption_key (required, OpenSSL::PKey::RSA, String) —

    The master key to use for encrypting/decrypting all objects.

  • :materials_description (String<JSON>) — default: '{}' —

    The encryption materials description. This is must be a JSON document string.

  • :materials_location (Symbol) — default: :metadata —

    Where to store the envelope encryption keys. This must be one of the following values:

    • ‘:metadata`

    • ‘:instruction_file`

  • :instruction_file_suffix (String) — default: '.instruction' 


24
25
26
27
 
# File 'lib/aws-sdk-resources/services/s3/encryption/materials.rb', line 24

def initialize(options = {})
  @key = validate_key(options[:key])
  @description = validate_desc(options[:description])
end

Instance Attribute Details

#description ⇒ String<JSON> (readonly)

Returns:

  • (String<JSON>) 


33
34
35
 
# File 'lib/aws-sdk-resources/services/s3/encryption/materials.rb', line 33

def description
  @description
end

#key ⇒ OpenSSL::PKey::RSA, String (readonly)

Returns:

  • (OpenSSL::PKey::RSA, String) 


30
31
32
 
# File 'lib/aws-sdk-resources/services/s3/encryption/materials.rb', line 30

def key
  @key
end