Class: MintPress::Aws::S3::Bucket

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

Properties (Read/Write)

  • #acl ⇒ [String] (Default Value: MintPress::Aws::S3::BucketAcl.new)
    'The canned ACL to apply to the bucket.'
    Property Attributes
    • create_bucket_prop ⇒ 'acl'
    • read_only ⇒ false
    • source ⇒ "create_bucket"
    • orig_name ⇒ 'acl'
    • default ⇒ MintPress::Aws::S3::BucketAcl.new
    

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

property :acl, create_bucket_prop: 'acl', type: [String], read_only: false, source: "create_bucket", description: 'The canned ACL to apply to the bucket.', orig_name: 'acl', default: MintPress::Aws::S3::BucketAcl.new
  • #bucket ⇒ [String]
    'The name of the bucket to create.'
    Property Attributes
    • create_bucket_prop ⇒ 'bucket'
    • read_only ⇒ false
    • source ⇒ "create_bucket"
    • delete_bucket_prop ⇒ 'bucket'
    

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

property :bucket, create_bucket_prop: 'bucket', type: [String], read_only: false, source: "create_bucket", description: 'The name of the bucket to create.', delete_bucket_prop: 'bucket'
  • #create_bucket_configuration ⇒ [String]
    'The configuration information for the bucket.'
    Property Attributes
    • create_bucket_prop ⇒ "create_bucket_configuration.location_constraint.location_constraint"
    • read_only ⇒ false
    • source ⇒ "create_bucket"
    

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

property :create_bucket_configuration, create_bucket_prop: "create_bucket_configuration.location_constraint.location_constraint", type: [String], read_only: false, source: "create_bucket", description: 'The configuration information for the bucket.'
  • #grant_full_control ⇒ [String]
    'Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.'
    Property Attributes
    • create_bucket_prop ⇒ 'grant_full_control'
    • read_only ⇒ false
    • source ⇒ "create_bucket"
    

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

property :grant_full_control, create_bucket_prop: 'grant_full_control', type: [String], read_only: false, source: "create_bucket", description: 'Allows grantee the read, write, read ACP, and write ACP permissions on
the bucket.'
  • #grant_read ⇒ [String]
    'Allows grantee to list the objects in the bucket.'
    Property Attributes
    • create_bucket_prop ⇒ 'grant_read'
    • read_only ⇒ false
    • source ⇒ "create_bucket"
    

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

property :grant_read, create_bucket_prop: 'grant_read', type: [String], read_only: false, source: "create_bucket", description: 'Allows grantee to list the objects in the bucket.'
  • #grant_read_acp ⇒ [String]
    'Allows grantee to read the bucket ACL.'
    Property Attributes
    • create_bucket_prop ⇒ 'grant_read_acp'
    • read_only ⇒ false
    • source ⇒ "create_bucket"
    

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

property :grant_read_acp, create_bucket_prop: 'grant_read_acp', type: [String], read_only: false, source: "create_bucket", description: 'Allows grantee to read the bucket ACL.'
  • #grant_write ⇒ [String]
    'Allows grantee to create, overwrite, and delete any object in the bucket.'
    Property Attributes
    • create_bucket_prop ⇒ 'grant_write'
    • read_only ⇒ false
    • source ⇒ "create_bucket"
    

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

property :grant_write, create_bucket_prop: 'grant_write', type: [String], read_only: false, source: "create_bucket", description: 'Allows grantee to create, overwrite, and delete any object in the
bucket.'
  • #grant_write_acp ⇒ [String]
    'Allows grantee to write the ACL for the applicable bucket.'
    Property Attributes
    • create_bucket_prop ⇒ 'grant_write_acp'
    • read_only ⇒ false
    • source ⇒ "create_bucket"
    

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

property :grant_write_acp, create_bucket_prop: 'grant_write_acp', type: [String], read_only: false, source: "create_bucket", description: 'Allows grantee to write the ACL for the applicable bucket.'
  • #object_lock_enabled_for_bucket ⇒ [TrueClass,FalseClass]
    'Specifies whether you want S3 Object Lock to be enabled for the new bucket.'
    Property Attributes
    • create_bucket_prop ⇒ 'object_lock_enabled_for_bucket'
    • read_only ⇒ false
    • source ⇒ "create_bucket"
    

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

property :object_lock_enabled_for_bucket, create_bucket_prop: 'object_lock_enabled_for_bucket', type: [TrueClass,FalseClass], read_only: false, source: "create_bucket", description: 'Specifies whether you want S3 Object Lock to be enabled for the new
bucket.'
  • #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_bucket_prop ⇒ 'expected_bucket_owner'
    • read_only ⇒ false
    • source ⇒ "delete_bucket"
    

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

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

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Bucket"
    • orig_name ⇒ 'cors'
    • default ⇒ MintPress::Aws::S3::BucketCor.new
    

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

property :cors, disposition: :association, source: "Bucket", orig_name: 'cors', type: [MintPress::Aws::S3::BucketCor], default: MintPress::Aws::S3::BucketCor.new
  • #lifecycle ⇒ [MintPress::Aws::S3::BucketLifecycle] (Default Value: MintPress::Aws::S3::BucketLifecycle.new)

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Bucket"
    • orig_name ⇒ 'lifecycle'
    • default ⇒ MintPress::Aws::S3::BucketLifecycle.new
    

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

property :lifecycle, disposition: :association, source: "Bucket", orig_name: 'lifecycle', type: [MintPress::Aws::S3::BucketLifecycle], default: MintPress::Aws::S3::BucketLifecycle.new
  • #lifecycle_configuration ⇒ [MintPress::Aws::S3::BucketLifecycleConfiguration] (Default Value: MintPress::Aws::S3::BucketLifecycleConfiguration.new)

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Bucket"
    • orig_name ⇒ 'lifecycle_configuration'
    • default ⇒ MintPress::Aws::S3::BucketLifecycleConfiguration.new
    

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

property :lifecycle_configuration, disposition: :association, source: "Bucket", orig_name: 'lifecycle_configuration', type: [MintPress::Aws::S3::BucketLifecycleConfiguration], default: MintPress::Aws::S3::BucketLifecycleConfiguration.new
  • #logging ⇒ [MintPress::Aws::S3::BucketLogging] (Default Value: MintPress::Aws::S3::BucketLogging.new)

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Bucket"
    • orig_name ⇒ 'logging'
    • default ⇒ MintPress::Aws::S3::BucketLogging.new
    

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

property :logging, disposition: :association, source: "Bucket", orig_name: 'logging', type: [MintPress::Aws::S3::BucketLogging], default: MintPress::Aws::S3::BucketLogging.new
  • #multipart_uploads ⇒ Hash of ⇒ [MintPress::Aws::S3::MultipartUpload]

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Bucket"
    • orig_name ⇒ 'multipart_uploads'
    

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

property :multipart_uploads, disposition: :association, source: "Bucket", orig_name: 'multipart_uploads', type: [MintPress::Aws::S3::MultipartUpload], array: false, hash: true
  • #notification ⇒ [MintPress::Aws::S3::BucketNotification] (Default Value: MintPress::Aws::S3::BucketNotification.new)

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Bucket"
    • orig_name ⇒ 'notification'
    • default ⇒ MintPress::Aws::S3::BucketNotification.new
    

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

property :notification, disposition: :association, source: "Bucket", orig_name: 'notification', type: [MintPress::Aws::S3::BucketNotification], default: MintPress::Aws::S3::BucketNotification.new
  • #object ⇒ [MintPress::Aws::S3::Object] (Default Value: MintPress::Aws::S3::Object.new)

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

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

property :object, disposition: :association, source: "Bucket", orig_name: 'object', type: [MintPress::Aws::S3::Object], default: MintPress::Aws::S3::Object.new
  • #object_versions ⇒ Hash of ⇒ [MintPress::Aws::S3::ObjectVersion]

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Bucket"
    • orig_name ⇒ 'object_versions'
    

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

property :object_versions, disposition: :association, source: "Bucket", orig_name: 'object_versions', type: [MintPress::Aws::S3::ObjectVersion], array: false, hash: true
  • #objects ⇒ Hash of ⇒ [MintPress::Aws::S3::ObjectSummary]

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Bucket"
    • orig_name ⇒ 'objects'
    

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

property :objects, disposition: :association, source: "Bucket", orig_name: 'objects', type: [MintPress::Aws::S3::ObjectSummary], array: false, hash: true
  • #policy ⇒ [MintPress::Aws::S3::BucketPolicy] (Default Value: MintPress::Aws::S3::BucketPolicy.new)

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Bucket"
    • orig_name ⇒ 'policy'
    • default ⇒ MintPress::Aws::S3::BucketPolicy.new
    

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

property :policy, disposition: :association, source: "Bucket", orig_name: 'policy', type: [MintPress::Aws::S3::BucketPolicy], default: MintPress::Aws::S3::BucketPolicy.new
  • #request_payment ⇒ [MintPress::Aws::S3::BucketPayment] (Default Value: MintPress::Aws::S3::BucketPayment.new)

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Bucket"
    • orig_name ⇒ 'request_payment'
    • default ⇒ MintPress::Aws::S3::BucketPayment.new
    

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

property :request_payment, disposition: :association, source: "Bucket", orig_name: 'request_payment', type: [MintPress::Aws::S3::BucketPayment], default: MintPress::Aws::S3::BucketPayment.new
  • #tagging ⇒ [MintPress::Aws::S3::BucketTagging] (Default Value: MintPress::Aws::S3::BucketTagging.new)

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Bucket"
    • orig_name ⇒ 'tagging'
    • default ⇒ MintPress::Aws::S3::BucketTagging.new
    

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

property :tagging, disposition: :association, source: "Bucket", orig_name: 'tagging', type: [MintPress::Aws::S3::BucketTagging], default: MintPress::Aws::S3::BucketTagging.new
  • #versioning ⇒ [MintPress::Aws::S3::BucketVersioning] (Default Value: MintPress::Aws::S3::BucketVersioning.new)

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Bucket"
    • orig_name ⇒ 'versioning'
    • default ⇒ MintPress::Aws::S3::BucketVersioning.new
    

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

property :versioning, disposition: :association, source: "Bucket", orig_name: 'versioning', type: [MintPress::Aws::S3::BucketVersioning], default: MintPress::Aws::S3::BucketVersioning.new
  • #website ⇒ [MintPress::Aws::S3::BucketWebsite] (Default Value: MintPress::Aws::S3::BucketWebsite.new)

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "Bucket"
    • orig_name ⇒ 'website'
    • default ⇒ MintPress::Aws::S3::BucketWebsite.new
    

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

property :website, disposition: :association, source: "Bucket", orig_name: 'website', type: [MintPress::Aws::S3::BucketWebsite], default: MintPress::Aws::S3::BucketWebsite.new
  • #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 
    

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

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
    

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

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

Properties (Read Only)

  • #creation_date ⇒ [Time]
    'Date the bucket was created.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::Bucket"
    • orig_name ⇒ 'creation_date'
    • read_only ⇒ true
    

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

property :creation_date, disposition: :read_only_attribute, description: 'Date the bucket was created.', source: "MintPress::Aws::S3::Bucket", orig_name: 'creation_date', type: [Time], read_only: true
  • #name ⇒ [String]
    'The name of the bucket.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::Bucket"
    • orig_name ⇒ 'name'
    • read_only ⇒ true
    

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

property :name, disposition: :read_only_attribute, description: 'The name of the bucket.', source: "MintPress::Aws::S3::Bucket", orig_name: 'name', type: [String], read_only: true

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

Returns a new instance of Bucket.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#list ⇒ Object