Class: Ansible::Ruby::Modules::Aws_s3

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb

Overview

This module allows the user to manage S3 buckets and the objects within them. Includes support for creating and deleting both objects and buckets, retrieving objects as files or strings and generating download links. This module has a dependency on boto3 and botocore.

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.

• #dualstack ⇒ :yes, ...

  Enables Amazon S3 Dual-Stack Endpoints, allowing S3 communications using both IPv4 and IPv6.,Requires at least botocore version 1.4.45.

• #encrypt ⇒ Boolean^?

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

• #encryption_kms_key_id ⇒ Object^?

  KMS key id to use when encrypting objects using C(aws:kms) encryption.

• #encryption_mode ⇒ :AES256, ...

  What encryption mode to use if C(encrypt) is set.

• #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’.

• #ignore_nonexistent_bucket ⇒ Object^?

  Overrides initial bucket lookups in case bucket or iam policies are restrictive.

• #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 ⇒ Array<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 ⇒ String^?

  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.

• #rgw ⇒ Boolean^?

  Enable Ceph RGW S3 support.

• #s3_url ⇒ String^?

  S3 URL endpoint for usage with Ceph, 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

#ansible_name, #to_h

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

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #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/cloud/amazon/aws_s3.rb', line 12

attribute :aws_access_key

#aws_secret_key ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb', line 15

attribute :aws_secret_key

#bucket ⇒ String

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

attribute :bucket

#dest ⇒ String^?

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

attribute :dest

#dualstack ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb', line 90

attribute :dualstack

#encrypt ⇒ Boolean^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb', line 26

attribute :encrypt

#encryption_kms_key_id ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb', line 105

attribute :encryption_kms_key_id

#encryption_mode ⇒ :AES256, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb', line 30

attribute :encryption_mode

#expiration ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb', line 34

attribute :expiration

#headers ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb', line 38

attribute :headers

#ignore_nonexistent_bucket ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb', line 102

attribute :ignore_nonexistent_bucket

#marker ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb', line 42

attribute :marker

#max_keys ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb', line 46

attribute :max_keys

#metadata ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb', line 50

attribute :metadata

#mode ⇒ :get, ...

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb', line 54

attribute :mode

#object ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb', line 58

attribute :object

#overwrite ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb', line 74

attribute :overwrite

#permission ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb', line 62

attribute :permission

#prefix ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb', line 66

attribute :prefix

#region ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb', line 78

attribute :region

#retries ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb', line 82

attribute :retries

#rgw ⇒ Boolean^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb', line 94

attribute :rgw

#s3_url ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb', line 86

attribute :s3_url

#src ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb', line 98

attribute :src

#version ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_s3.rb', line 70

attribute :version