Class: Ansible::Ruby::Modules::S3_bucket

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/amazon/s3_bucket.rb

Overview

Manage S3 buckets in AWS, Ceph, Walrus and FakeS3

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#ceph ⇒ Boolean?

Returns Enable API compatibility with Ceph. It takes into account the S3 API subset working with Ceph in order to provide the same module behaviour where possible.

Returns:

  • (Boolean, nil) —

    Enable API compatibility with Ceph. It takes into account the S3 API subset working with Ceph in order to provide the same module behaviour where possible.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_bucket.rb', line 28

attribute :ceph

#force ⇒ :yes, ...

Returns When trying to delete a bucket, delete all keys (including versions and delete markers) in the bucket first (an s3 bucket must be empty for a successful deletion).

Returns:

  • (:yes, :no, nil) —

    When trying to delete a bucket, delete all keys (including versions and delete markers) in the bucket first (an s3 bucket must be empty for a successful deletion)



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_bucket.rb', line 12

attribute :force

#name ⇒ String

Returns Name of the s3 bucket.

Returns:

  • (String) —

    Name of the s3 bucket



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_bucket.rb', line 16

attribute :name

#policy ⇒ String?

Returns The JSON policy as a string.

Returns:

  • (String, nil) —

    The JSON policy as a string.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_bucket.rb', line 20

attribute :policy

#requester_pays ⇒ :yes, ...

Returns With Requester Pays buckets, the requester instead of the bucket owner pays the cost of the request and the data download from the bucket.

Returns:

  • (:yes, :no, nil) —

    With Requester Pays buckets, the requester instead of the bucket owner pays the cost of the request and the data download from the bucket.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_bucket.rb', line 32

attribute :requester_pays

#s3_url ⇒ String?

Returns S3 URL endpoint for usage with Ceph, Eucalypus, fakes3, etc. Otherwise assumes AWS.

Returns:

  • (String, nil) —

    S3 URL endpoint for usage with Ceph, Eucalypus, fakes3, etc. Otherwise assumes AWS



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_bucket.rb', line 24

attribute :s3_url

#state ⇒ :present, ...

Returns Create or remove the s3 bucket.

Returns:

  • (:present, :absent, nil) —

    Create or remove the s3 bucket



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_bucket.rb', line 36

attribute :state

#tags ⇒ Hash?

Returns tags dict to apply to bucket.

Returns:

  • (Hash, nil) —

    tags dict to apply to bucket



40
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_bucket.rb', line 40

attribute :tags

#versioning ⇒ Symbol?

Returns Whether versioning is enabled or disabled (note that once versioning is enabled, it can only be suspended).

Returns:

  • (Symbol, nil) —

    Whether versioning is enabled or disabled (note that once versioning is enabled, it can only be suspended)



44
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/s3_bucket.rb', line 44

attribute :versioning