Try SpotterEfficiently upload multiple files to S3
| "added in version" 2.3 of ansible.builtin"
Authors: Ted Timmons (@tedder)
preview | supported by community
pipInstall with pip install ansible==2.9.17
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.
- name: basic upload
s3_sync:
bucket: tedder
file_root: roles/s3/files/
- name: all the options
s3_sync:
bucket: tedder
file_root: roles/s3/files
mime_map:
.yml: application/text
.json: application/text
key_prefix: config_files/web
file_change_strategy: force
permission: public-read
cache_control: "public, max-age=31536000"
include: "*"
exclude: "*.txt,.*"
mode:
choices:
- push
default: push
description:
- sync direction.
bucket:
description:
- Bucket name.
required: true
delete:
default: false
description:
- Remove remote files that exist in bucket but are not present in the file root.
required: false
type: bool
version_added: '2.4'
version_added_collection: ansible.builtin
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION
environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will
use EC2 endpoints). Ignored for modules where region is required. Must be specified
for all other modules if region is not used. If not set then the value of the EC2_URL
environment variable, if any, is used.
type: str
exclude:
default: .*
description:
- Shell pattern-style file matching.
- Used after include to remove files (for instance, skip "*.txt")
- For multiple patterns, comma-separate them.
required: false
include:
default: '*'
description:
- Shell pattern-style file matching.
- Used before exclude to determine eligible files (for instance, only "*.gif")
- For multiple patterns, comma-separate them.
required: false
profile:
aliases:
- aws_profile
description:
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
mime_map:
description:
- 'Dict entry from extension to MIME type. This will override any default/sniffed
MIME type. For example C({".txt": "application/text", ".yml": "application/text"})
'
required: false
file_root:
description:
- File/directory path for synchronization. This is a local path.
- This root path is scrubbed from the key name, so subdirectories will remain as keys.
required: true
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
- Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
key_prefix:
description:
- In addition to file path, prepend s3 path with this prefix. Module will add slash
at end of prefix if necessary.
required: false
permission:
choices:
- ''
- private
- public-read
- public-read-write
- authenticated-read
- aws-exec-read
- bucket-owner-read
- bucket-owner-full-control
description:
- Canned ACL to apply to synced files.
- Changing this ACL only changes newly synced files, it does not trigger a full reupload.
required: false
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- Not used by boto 2 based modules.
- 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
from the controller if not run locally.'
type: path
cache_control:
description:
- This is a string.
- Cache-Control header set on uploaded objects.
- Directives are separated by commas.
required: false
version_added: '2.4'
version_added_collection: ansible.builtin
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(EC2_ACCESS_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(EC2_SECRET_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
security_token:
aliases:
- aws_security_token
- access_token
description:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(EC2_SECURITY_TOKEN) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
type: bool
file_change_strategy:
choices:
- force
- checksum
- date_size
default: date_size
description:
- Difference determination method to allow changes-only syncing. Unlike rsync, files
are not patched- they are fully skipped or fully uploaded.
- date_size will upload if file sizes don't match or if local file modified date is
newer than s3's version
- checksum will compare etag values based on s3's implementation of chunked md5s.
- force will always upload all files.
required: false
debug_botocore_endpoint_logs:
default: 'no'
description:
- Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action"
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the aws_resource_action callback to output to total list made
during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also
be used.
type: bool
filelist_actionable:
description: file listing (dicts) of files that will be uploaded after the strategy
decision
returned: always
sample:
- bytes: 151
chopped_path: policy.json
fullpath: roles/cf/files/policy.json
mime_type: application/json
modified_epoch: 1477931256
s3_path: s3sync/policy.json
whysize: 151 / 151
whytime: 1477931256 / 1477929260
type: list
filelist_initial:
description: file listing (dicts) from initial globbing
returned: always
sample:
- bytes: 151
chopped_path: policy.json
fullpath: roles/cf/files/policy.json
modified_epoch: 1477416706
type: list
filelist_local_etag:
description: file listing (dicts) including calculated local etag
returned: always
sample:
- bytes: 151
chopped_path: policy.json
fullpath: roles/cf/files/policy.json
mime_type: application/json
modified_epoch: 1477416706
s3_path: s3sync/policy.json
type: list
filelist_s3:
description: file listing (dicts) including information about previously-uploaded
versions
returned: always
sample:
- bytes: 151
chopped_path: policy.json
fullpath: roles/cf/files/policy.json
mime_type: application/json
modified_epoch: 1477416706
s3_path: s3sync/policy.json
type: list
filelist_typed:
description: file listing (dicts) with calculated or overridden mime types
returned: always
sample:
- bytes: 151
chopped_path: policy.json
fullpath: roles/cf/files/policy.json
mime_type: application/json
modified_epoch: 1477416706
type: list
uploaded:
description: file listing (dicts) of files that were actually uploaded
returned: always
sample:
- bytes: 151
chopped_path: policy.json
fullpath: roles/cf/files/policy.json
s3_path: s3sync/policy.json
whysize: 151 / 151
whytime: 1477931637 / 1477931489
type: list