Class: MintPress::Aws::S3::ObjectTagging

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

Properties (Read/Write)

  • #bucket ⇒ [String]
    'The bucket name containing the object for which to get the tagging 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. When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.'
    Property Attributes
    • delete_object_tagging_prop ⇒ 'bucket'
    • read_only ⇒ false
    • source ⇒ "get_object_tagging"
    • get_object_tagging_prop ⇒ 'bucket'
    

19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_tagging.rb', line 19

property :bucket, delete_object_tagging_prop: 'bucket', type: [String], read_only: false, source: "get_object_tagging", description: 'The bucket name containing the object for which to get the tagging
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.

When using this API with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this operation using S3 on Outposts through the AWS SDKs,
you provide the Outposts bucket ARN in place of the bucket name. For
more information about S3 on Outposts ARNs, see Using S3 on
Outposts in the Amazon Simple Storage Service Developer Guide.', get_object_tagging_prop: 'bucket'
  • #key ⇒ [String] (Default Value: Proc.new { self.name })
    'Object key for which to get the tagging information.'
    Property Attributes
    • delete_object_tagging_prop ⇒ 'key'
    • read_only ⇒ false
    • source ⇒ "get_object_tagging"
    • get_object_tagging_prop ⇒ 'key'
    • default ⇒ Proc.new { self.name }
    

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

property :key, delete_object_tagging_prop: 'key', type: [String], read_only: false, source: "get_object_tagging", description: 'Object key for which to get the tagging information.', get_object_tagging_prop: 'key', default: Proc.new { self.name }
  • #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
    • delete_object_tagging_prop ⇒ 'expected_bucket_owner'
    • read_only ⇒ false
    • source ⇒ "get_object_tagging"
    • get_object_tagging_prop ⇒ 'expected_bucket_owner'
    

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

property :expected_bucket_owner, delete_object_tagging_prop: 'expected_bucket_owner', type: [String], read_only: false, source: "get_object_tagging", 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.', get_object_tagging_prop: 'expected_bucket_owner'
  • #version ⇒ [String]
    'The versionId of the object for which to get the tagging information.'
    Property Attributes
    • delete_object_tagging_prop ⇒ 'version_id'
    • read_only ⇒ false
    • source ⇒ "get_object_tagging"
    • get_object_tagging_prop ⇒ 'version_id'
    

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

property :version, delete_object_tagging_prop: 'version_id', type: [String], read_only: false, source: "get_object_tagging", description: 'The versionId of the object for which to get the tagging information.', get_object_tagging_prop: 'version_id'
  • #name ⇒ String

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of ObjectTagging.

Instance Method Details

#delete ⇒ Object

#delete_cascade ⇒ Object

#get ⇒ Object