Class: MintPress::Aws::Glacier::S3Location

Inherits:

Object

• Object
• MintPress::Aws::Glacier::S3Location

Includes:

MintLogger, AwsCommon, Mixins::Properties

Defined in:

src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/s3_location.rb

Properties (Read/Write)

• #access_control_list ⇒ Array of ⇒ [MintPress::Aws::Glacier::Grant]
  'A list of grants that control access to the staged results.'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::Glacier::S3Location"
  • orig_name ⇒ 'access_control_list'

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/s3_location.rb', line 17
  
  property :access_control_list, disposition: :attribute, description: 'A list of grants that control access to the staged results.', source: "MintPress::Aws::Glacier::S3Location", orig_name: 'access_control_list', type: [MintPress::Aws::Glacier::Grant], array: true

• #bucket_name ⇒ [String] (Default Value: Proc.new { self.name })
  'The name of the Amazon S3 bucket where the job results are stored.'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::Glacier::S3Location"
  • orig_name ⇒ 'bucket_name'
  • default ⇒ Proc.new { self.name }

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/s3_location.rb', line 18
  
  property :bucket_name, disposition: :attribute, description: 'The name of the Amazon S3 bucket where the job results are stored.', source: "MintPress::Aws::Glacier::S3Location", orig_name: 'bucket_name', type: [String], default: Proc.new { self.name }

• #canned_acl ⇒ [String]
  'The canned access control list (ACL) to apply to the job results.'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::Glacier::S3Location"
  • orig_name ⇒ 'canned_acl'

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/s3_location.rb', line 19
  
  property :canned_acl, disposition: :attribute, description: 'The canned access control list (ACL) to apply to the job results.', source: "MintPress::Aws::Glacier::S3Location", orig_name: 'canned_acl', type: [String]

• #encryption ⇒ [MintPress::Aws::Glacier::Encryption] (Default Value: MintPress::Aws::Glacier::Encryption.new)
  'Contains information about the encryption used to store the job results in Amazon S3.'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::Glacier::S3Location"
  • orig_name ⇒ 'encryption'
  • default ⇒ MintPress::Aws::Glacier::Encryption.new

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/s3_location.rb', line 20
  
  property :encryption, disposition: :attribute, description: 'Contains information about the encryption used to store the job results in Amazon S3.', source: "MintPress::Aws::Glacier::S3Location", orig_name: 'encryption', type: [MintPress::Aws::Glacier::Encryption], default: MintPress::Aws::Glacier::Encryption.new

• #prefix ⇒ [String]
  'The prefix that is prepended to the results for this request.'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::Glacier::S3Location"
  • orig_name ⇒ 'prefix'

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/s3_location.rb', line 21
  
  property :prefix, disposition: :attribute, description: 'The prefix that is prepended to the results for this request.', source: "MintPress::Aws::Glacier::S3Location", orig_name: 'prefix', type: [String]

• #storage_class ⇒ [String]
  'The storage class used to store the job results.'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::Glacier::S3Location"
  • orig_name ⇒ 'storage_class'

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/s3_location.rb', line 22
  
  property :storage_class, disposition: :attribute, description: 'The storage class used to store the job results.', source: "MintPress::Aws::Glacier::S3Location", orig_name: 'storage_class', type: [String]

• #tagging ⇒ []
  'The tag-set that is applied to the job results.'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::Glacier::S3Location"
  • orig_name ⇒ 'tagging'

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/s3_location.rb', line 23
  
  property :tagging, disposition: :attribute, description: 'The tag-set that is applied to the job results.', source: "MintPress::Aws::Glacier::S3Location", orig_name: 'tagging', type: []

• #user_metadata ⇒ []
  'A map of metadata to store with the job results in Amazon S3.'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::Glacier::S3Location"
  • orig_name ⇒ 'user_metadata'

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/s3_location.rb', line 24
  
  property :user_metadata, disposition: :attribute, description: 'A map of metadata to store with the job results in Amazon S3.', source: "MintPress::Aws::Glacier::S3Location", orig_name: 'user_metadata', type: []

• #name ⇒ [String]
  
  Property Attributes

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/s3_location.rb', line 25
  
  property :name, type: [String]

• #region ⇒ String
  Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
  Property Attributes

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/s3_location.rb', line 29
  
  property :region, type: String

• #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
  The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
  Property Attributes
  • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/s3_location.rb', line 32
  
  property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary

• #initialize(opts = {}) ⇒ S3Location constructor
  A new instance of S3Location.

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ S3Location

Returns a new instance of S3Location.