Class: MintPress::Aws::S3::ObjectAcl

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_acl.rb

Properties (Read/Write)

  • #bucket ⇒ [String]
    'The bucket name that contains the object for which to get the ACL information. 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_acl_prop ⇒ 'bucket'
    • read_only ⇒ false
    • source ⇒ "get_object_acl"
    

20
21
22
23
24
25
26
27
28
29
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_acl.rb', line 20

property :bucket, get_object_acl_prop: 'bucket', type: [String], read_only: false, source: "get_object_acl", description: 'The bucket name that contains the object for which to get the ACL
information.

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]
    'The key of the object for which to get the ACL information.'
    Property Attributes
    • get_object_acl_prop ⇒ 'key'
    • read_only ⇒ false
    • source ⇒ "get_object_acl"
    

30
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_acl.rb', line 30

property :key, get_object_acl_prop: 'key', type: [String], read_only: false, source: "get_object_acl", description: 'The key of the object for which to get the ACL information.'
  • #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_acl_prop ⇒ 'request_payer'
    • read_only ⇒ false
    • source ⇒ "get_object_acl"
    

31
32
33
34
35
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_acl.rb', line 31

property :request_payer, get_object_acl_prop: 'request_payer', type: [String], read_only: false, source: "get_object_acl", 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_acl_prop ⇒ 'expected_bucket_owner'
    • read_only ⇒ false
    • source ⇒ "get_object_acl"
    

36
37
38
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_acl.rb', line 36

property :expected_bucket_owner, get_object_acl_prop: 'expected_bucket_owner', type: [String], read_only: false, source: "get_object_acl", 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.'
  • #object ⇒ [MintPress::Aws::S3::Object] (Default Value: MintPress::Aws::S3::Object.new)

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "MintPress::Aws::S3::ObjectAcl"
    • orig_name ⇒ 'object'
    • default ⇒ MintPress::Aws::S3::Object.new
    

44
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_acl.rb', line 44

property :object, disposition: :association, source: "MintPress::Aws::S3::ObjectAcl", orig_name: 'object', type: [MintPress::Aws::S3::Object], default: MintPress::Aws::S3::Object.new
  • #version ⇒ [String]
    'VersionId used to reference a specific version of the object.'
    Property Attributes
    • get_object_acl_prop ⇒ 'version_id'
    • read_only ⇒ false
    • source ⇒ "get_object_acl"
    

45
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_acl.rb', line 45

property :version, get_object_acl_prop: 'version_id', type: [String], read_only: false, source: "get_object_acl", description: 'VersionId used to reference a specific version of the object.'
  • #name ⇒ [String]

    Property Attributes 
    

46
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_acl.rb', line 46

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 
    

50
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_acl.rb', line 50

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
    

53
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_acl.rb', line 53

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

  • #bucket_name ⇒ [String] (Default Value: Proc.new { self.name })

    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::ObjectAcl"
    • orig_name ⇒ 'bucket_name'
    • default ⇒ Proc.new { self.name }
    

39
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_acl.rb', line 39

property :bucket_name, read_only: true, disposition: :read_only_attribute, source: "MintPress::Aws::S3::ObjectAcl", orig_name: 'bucket_name', type: [String], default: Proc.new { self.name }
  • #grants ⇒ Array of ⇒ [MintPress::Aws::S3::Grant]
    'A list of grants.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::ObjectAcl"
    • orig_name ⇒ 'grants'
    

40
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_acl.rb', line 40

property :grants, read_only: true, disposition: :read_only_attribute, description: 'A list of grants.', source: "MintPress::Aws::S3::ObjectAcl", orig_name: 'grants', type: [MintPress::Aws::S3::Grant], array: true
  • #object_key ⇒ [String]

    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::ObjectAcl"
    • orig_name ⇒ 'object_key'
    

41
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_acl.rb', line 41

property :object_key, read_only: true, disposition: :read_only_attribute, source: "MintPress::Aws::S3::ObjectAcl", orig_name: 'object_key', type: [String]
  • #owner ⇒ [MintPress::Aws::S3::Owner] (Default Value: MintPress::Aws::S3::Owner.new)
    'Container for the bucket owner"s display name and ID.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::ObjectAcl"
    • orig_name ⇒ 'owner'
    • default ⇒ MintPress::Aws::S3::Owner.new
    

42
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_acl.rb', line 42

property :owner, read_only: true, disposition: :read_only_attribute, description: 'Container for the bucket owner"s display name and ID.', source: "MintPress::Aws::S3::ObjectAcl", orig_name: 'owner', type: [MintPress::Aws::S3::Owner], default: MintPress::Aws::S3::Owner.new
  • #request_charged ⇒ [String]
    'If present, indicates that the requester was successfully charged for the request.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::ObjectAcl"
    • orig_name ⇒ 'request_charged'
    

43
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_acl.rb', line 43

property :request_charged, read_only: true, disposition: :read_only_attribute, description: 'If present, indicates that the requester was successfully charged for the request.', source: "MintPress::Aws::S3::ObjectAcl", orig_name: 'request_charged', type: [String]

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 collapse

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

Returns a new instance of ObjectAcl.

Instance Method Details

#get ⇒ Object