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

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::S3_bucket

Defined in:

lib/ansible/ruby/modules/generated/extras/cloud/amazon/s3_bucket.rb

Instance Method Summary

• #force ⇒ Boolean^?

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

• #name ⇒ String

  Name of the s3 bucket.

• #policy ⇒ String^?

  The JSON policy as a string.

• #requester_pays ⇒ Boolean^?

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

• #s3_url ⇒ Object^?

  S3 URL endpoint for usage with Eucalypus, fakes3, etc.

• #state ⇒ :present, ...

  Create or remove the s3 bucket.

• #tags ⇒ Hash^?

  Tags dict to apply to bucket.

• #versioning ⇒ Boolean^?

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

Methods inherited from Base

#to_h

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

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

Constructor Details

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

Instance Method Details

#force ⇒ Boolean^?

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

Returns:

• (Boolean, nil) —

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

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

attribute :force

#name ⇒ String

Returns Name of the s3 bucket.

Returns:

• (String) —

  Name of the s3 bucket

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

attribute :name

#policy ⇒ String^?

Returns The JSON policy as a string.

Returns:

• (String, nil) —

  The JSON policy as a string.

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

attribute :policy

#requester_pays ⇒ Boolean^?

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:

• (Boolean, 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.

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

attribute :requester_pays

#s3_url ⇒ Object^?

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

Returns:

• (Object, nil) —

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

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

attribute :s3_url

#state ⇒ :present, ...

Returns Create or remove the s3 bucket.

Returns:

• (:present, :absent, nil) —

  Create or remove the s3 bucket

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

attribute :state

#tags ⇒ Hash^?

Returns tags dict to apply to bucket.

Returns:

• (Hash, nil) —

  tags dict to apply to bucket

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

attribute :tags

#versioning ⇒ Boolean^?

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

Returns:

• (Boolean, nil) —

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

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

attribute :versioning