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

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

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

  • :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.



15
16
17
18
# File 'aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryption/materials.rb', line 15

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

Instance Attribute Details

#descriptionString<JSON> (readonly)

Returns:

  • (String<JSON>)


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

def description
  @description
end

#keyOpenSSL::PKey::RSA, String (readonly)

Returns:

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


21
22
23
# File 'aws-sdk-resources/lib/aws-sdk-resources/services/s3/encryption/materials.rb', line 21

def key
  @key
end