AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-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):

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

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

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

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



17
18
19
20
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/materials.rb', line 17

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

Instance Attribute Details

#description ⇒ String<JSON> (readonly)

Returns:

  • (String<JSON>) 


26
27
28
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/materials.rb', line 26

def description
  @description
end

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

Returns:

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


23
24
25
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/encryption/materials.rb', line 23

def key
  @key
end