Class: Ansible::Ruby::Modules::S3_sync

Inherits:

Base

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

Defined in:

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

Overview

The S3 module is great, but it is very slow for a large volume of files- even a dozen will be noticeable. In addition to speed, it handles globbing, inclusions/exclusions, mime types, expiration mapping, recursion, cache control and smart directory mapping.

Instance Method Summary

• #bucket ⇒ String

  Bucket name.

• #cache_control ⇒ Array<String>, ...

  This is a string.,Cache-Control header set on uploaded objects.,Directives are separated by commmas.

• #delete ⇒ Boolean^?

  Remove remote files that exist in bucket but are not present in the file root.

• #exclude ⇒ String^?

  Shell pattern-style file matching.,Used after include to remove files (for instance, skip “*.txt”),For multiple patterns, comma-separate them.

• #file_change_strategy ⇒ :force, ...

  Difference determination method to allow changes-only syncing.

• #file_root ⇒ String

  File/directory path for synchronization.

• #include ⇒ String^?

  Shell pattern-style file matching.,Used before exclude to determine eligible files (for instance, only “*.gif”),For multiple patterns, comma-separate them.

• #key_prefix ⇒ String^?

  In addition to file path, prepend s3 path with this prefix.

• #mime_map ⇒ Hash^?

  Dict entry from extension to MIME type.

• #mode ⇒ :push

  Sync direction.

• #permission ⇒ :"", :private, :"public-read", :"public-read-write", :"authenticated-read", :"aws-exec-read", :"bucket-owner-read", :"bucket-owner-full-control"^?

  Canned ACL to apply to synced files.,Changing this ACL only changes newly synced files, it does not trigger a full reupload.

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

#bucket ⇒ String

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

attribute :bucket

#cache_control ⇒ Array<String>, ...

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

attribute :cache_control

#delete ⇒ Boolean^?

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

attribute :delete

#exclude ⇒ String^?

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

attribute :exclude

#file_change_strategy ⇒ :force, ...

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

attribute :file_change_strategy

#file_root ⇒ String

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

attribute :file_root

#include ⇒ String^?

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

attribute :include

#key_prefix ⇒ String^?

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

attribute :key_prefix

#mime_map ⇒ Hash^?

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

attribute :mime_map

#mode ⇒ :push

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

attribute :mode

#permission ⇒ :"", :private, :"public-read", :"public-read-write", :"authenticated-read", :"aws-exec-read", :"bucket-owner-read", :"bucket-owner-full-control"^?

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

attribute :permission