Class: MintPress::Aws::S3::ObjectLegalHold

Inherits:

Object

• Object
• MintPress::Aws::S3::ObjectLegalHold

Includes:

MintLogger, AwsCommon, Mixins::Properties

Defined in:

src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_legal_hold.rb

Properties (Read/Write)

• #bucket ⇒ [String]
  'The bucket name containing the object whose Legal Hold status you want to retrieve. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.'
  Property Attributes
  • get_object_legal_hold_prop ⇒ 'bucket'
  • read_only ⇒ false
  • source ⇒ "get_object_legal_hold"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_legal_hold.rb', line 17
  
  property :bucket, get_object_legal_hold_prop: 'bucket', type: [String], read_only: false, source: "get_object_legal_hold", description: 'The bucket name containing the object whose Legal Hold status you want
  to retrieve.
  
  When using this API with an access point, you must direct requests to
  the access point hostname. The access point hostname takes the form
  AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
  When using this operation with an access point through the AWS SDKs,
  you provide the access point ARN in place of the bucket name. For more
  information about access point ARNs, see Using Access Points in
  the Amazon Simple Storage Service Developer Guide.'

• #key ⇒ [String] (Default Value: Proc.new { self.name })
  'The key name for the object whose Legal Hold status you want to retrieve.'
  Property Attributes
  • get_object_legal_hold_prop ⇒ 'key'
  • read_only ⇒ false
  • source ⇒ "get_object_legal_hold"
  • default ⇒ Proc.new { self.name }

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_legal_hold.rb', line 27
  
  property :key, get_object_legal_hold_prop: 'key', type: [String], read_only: false, source: "get_object_legal_hold", description: 'The key name for the object whose Legal Hold status you want to
  retrieve.', default: Proc.new { self.name }

• #request_payer ⇒ [String]
  'Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 Developer Guide.'
  Property Attributes
  • get_object_legal_hold_prop ⇒ 'request_payer'
  • read_only ⇒ false
  • source ⇒ "get_object_legal_hold"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_legal_hold.rb', line 29
  
  property :request_payer, get_object_legal_hold_prop: 'request_payer', type: [String], read_only: false, source: "get_object_legal_hold", description: 'Confirms that the requester knows that they will be charged for the
  request. Bucket owners need not specify this parameter in their
  requests. For information about downloading objects from requester
  pays buckets, see Downloading Objects in Requestor Pays Buckets
  in the Amazon S3 Developer Guide.'

• #expected_bucket_owner ⇒ [String]
  'The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.'
  Property Attributes
  • get_object_legal_hold_prop ⇒ 'expected_bucket_owner'
  • read_only ⇒ false
  • source ⇒ "get_object_legal_hold"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_legal_hold.rb', line 34
  
  property :expected_bucket_owner, get_object_legal_hold_prop: 'expected_bucket_owner', type: [String], read_only: false, source: "get_object_legal_hold", description: 'The account id of the expected bucket owner. If the bucket is owned by
  a different account, the request will fail with an HTTP 403 (Access
  Denied) error.'

• #version ⇒ [String]
  'The version ID of the object whose Legal Hold status you want to retrieve.'
  Property Attributes
  • get_object_legal_hold_prop ⇒ 'version_id'
  • read_only ⇒ false
  • source ⇒ "get_object_legal_hold"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_legal_hold.rb', line 37
  
  property :version, get_object_legal_hold_prop: 'version_id', type: [String], read_only: false, source: "get_object_legal_hold", description: 'The version ID of the object whose Legal Hold status you want to
  retrieve.'

• #name ⇒ String
  
  Property Attributes

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_legal_hold.rb', line 39
  
  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/s3/object_legal_hold.rb', line 43
  
  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/s3/object_legal_hold.rb', line 46
  
  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

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

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 = {}) ⇒ ObjectLegalHold

Returns a new instance of ObjectLegalHold.

Instance Method Details

#get ⇒ Object