Class: Ansible::Ruby::Modules::S3

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/core/cloud/amazon/s3.rb

Instance Method Summary

• #aws_access_key ⇒ Object^?

  AWS access key id.

• #aws_secret_key ⇒ Object^?

  AWS secret key.

• #bucket ⇒ String

  Bucket name.

• #dest ⇒ String^?

  The destination file path when downloading an object/key with a GET operation.

• #encrypt ⇒ Boolean^?

  When set for PUT mode, asks for server-side encryption.

• #expiration ⇒ Integer^?

  Time limit (in seconds) for the URL generated and returned by S3/Walrus when performing a mode=put or mode=geturl operation.

• #headers ⇒ String^?

  Custom headers for PUT operation, as a dictionary of ‘key=value’ and ‘key=value,key=value’.

• #marker ⇒ String^?

  Specifies the key to start with when using list mode.

• #max_keys ⇒ Integer^?

  Max number of results to return in list mode, set this if you want to retrieve fewer than the default 1000 keys.

• #metadata ⇒ String^?

  Metadata for PUT operation, as a dictionary of ‘key=value’ and ‘key=value,key=value’.

• #mode ⇒ :get, ...

  Switches the module behaviour between put (upload), get (download), geturl (return download url, Ansible 1.3+), getstr (download object as string (1.3+)), list (list keys, Ansible 2.0+), create (bucket), delete (bucket), and delobj (delete object, Ansible 2.0+).

• #object ⇒ String^?

  Keyname of the object inside the bucket.

• #overwrite ⇒ Boolean^?

  Force overwrite either locally on the filesystem or remotely with the object/key.

• #permission ⇒ String^?

  This option lets the user set the canned permissions on the object/bucket that are created.

• #prefix ⇒ String^?

  Limits the response to keys that begin with the specified prefix for list mode.

• #region ⇒ String^?

  AWS region to create the bucket in.

• #retries ⇒ Integer^?

  On recoverable failure, how many times to retry before actually failing.

• #s3_url ⇒ Object^?

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

• #src ⇒ String^?

  The source file path when performing a PUT operation.

• #version ⇒ String^?

  Version ID of the object inside the bucket.

Methods inherited from Base

#to_h

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

attr_options, attribute, #initialize, #to_h, validates

Constructor Details

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

Instance Method Details

#aws_access_key ⇒ Object^?

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

attribute :aws_access_key

#aws_secret_key ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/s3.rb', line 13

attribute :aws_secret_key

#bucket ⇒ String

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

attribute :bucket

#dest ⇒ String^?

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

attribute :dest

#encrypt ⇒ Boolean^?

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

attribute :encrypt

#expiration ⇒ Integer^?

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

attribute :expiration

#headers ⇒ String^?

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

attribute :headers

#marker ⇒ String^?

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

attribute :marker

#max_keys ⇒ Integer^?

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

attribute :max_keys

#metadata ⇒ String^?

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

attribute :metadata

#mode ⇒ :get, ...

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/s3.rb', line 48

attribute :mode

#object ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/s3.rb', line 52

attribute :object

#overwrite ⇒ Boolean^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/s3.rb', line 68

attribute :overwrite

#permission ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/s3.rb', line 56

attribute :permission

#prefix ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/s3.rb', line 60

attribute :prefix

#region ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/s3.rb', line 72

attribute :region

#retries ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/s3.rb', line 76

attribute :retries

#s3_url ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/s3.rb', line 80

attribute :s3_url

#src ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/s3.rb', line 83

attribute :src

#version ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/core/cloud/amazon/s3.rb', line 64

attribute :version