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

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

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #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

#aws_access_key ⇒ Object?

Returns AWS access key id. If not set then the value of the AWS_ACCESS_KEY environment variable is used.

Returns:

  • (Object, nil) —

    AWS access key id. If not set then the value of the AWS_ACCESS_KEY environment variable is used.



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

attribute :aws_access_key

#aws_secret_key ⇒ Object?

Returns AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used.

Returns:

  • (Object, nil) —

    AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used.



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

attribute :aws_secret_key

#bucket ⇒ String

Returns Bucket name.

Returns:

  • (String) —

    Bucket name.



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

attribute :bucket

#dest ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :dest

#encrypt ⇒ Boolean?

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

Returns:

  • (Boolean, nil) —

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



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

attribute :encrypt

#expiration ⇒ Integer?

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

Returns:

  • (Integer, nil) —

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



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

attribute :expiration

#headers ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :headers

#marker ⇒ String?

Returns Specifies the key to start with when using list mode. Object keys are returned in alphabetical order, starting with key after the marker in order.

Returns:

  • (String, nil) —

    Specifies the key to start with when using list mode. Object keys are returned in alphabetical order, starting with key after the marker in order.



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

attribute :marker

#max_keys ⇒ Integer?

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

Returns:

  • (Integer, nil) —

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



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

attribute :max_keys

#metadata ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :metadata

#mode ⇒ :get, ...

Returns 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+).

Returns:

  • (:get, :put, :delete, :create, :geturl, :getstr, :delobj, :list) —

    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+).



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

attribute :mode

#object ⇒ String?

Returns Keyname of the object inside the bucket. Can be used to create “virtual directories”, see examples.

Returns:

  • (String, nil) —

    Keyname of the object inside the bucket. Can be used to create “virtual directories”, see examples.



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

attribute :object

#overwrite ⇒ Boolean?

Returns Force overwrite either locally on the filesystem or remotely with the object/key. Used with PUT and GET operations. Boolean or one of [Always, Never, Different], new in 2.0.

Returns:

  • (Boolean, nil) —

    Force overwrite either locally on the filesystem or remotely with the object/key. Used with PUT and GET operations. Boolean or one of [Always, Never, Different], new in 2.0



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

attribute :overwrite

#permission ⇒ String?

Returns This option lets the user set the canned permissions on the object/bucket that are created. The permissions that can be set are ‘private’, ‘public-read’, ‘public-read-write’, ‘authenticated-read’. Multiple permissions can be specified as a list.

Returns:

  • (String, nil) —

    This option lets the user set the canned permissions on the object/bucket that are created. The permissions that can be set are ‘private’, ‘public-read’, ‘public-read-write’, ‘authenticated-read’. Multiple permissions can be specified as a list.



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

attribute :permission

#prefix ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :prefix

#region ⇒ String?

Returns AWS region to create the bucket in. If not set then the value of the AWS_REGION and EC2_REGION environment variables are checked, followed by the aws_region and ec2_region settings in the Boto config file. If none of those are set the region defaults to the S3 Location: US Standard. Prior to ansible 1.8 this parameter could be specified but had no effect.

Returns:

  • (String, nil) —

    AWS region to create the bucket in. If not set then the value of the AWS_REGION and EC2_REGION environment variables are checked, followed by the aws_region and ec2_region settings in the Boto config file. If none of those are set the region defaults to the S3 Location: US Standard. Prior to ansible 1.8 this parameter could be specified but had no effect.



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

attribute :region

#retries ⇒ Integer?

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

Returns:

  • (Integer, nil) —

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



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

attribute :retries

#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



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

attribute :s3_url

#src ⇒ String?

Returns The source file path when performing a PUT operation.

Returns:

  • (String, nil) —

    The source file path when performing a PUT operation.



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

attribute :src

#version ⇒ String?

Returns Version ID of the object inside the bucket. Can be used to get a specific version of a file if versioning is enabled in the target bucket.

Returns:

  • (String, nil) —

    Version ID of the object inside the bucket. Can be used to get a specific version of a file if versioning is enabled in the target bucket.



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

attribute :version