aws_s3 - manage objects in S3.¶

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Support
- Author

Synopsis ¶

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.

Requirements ¶

The below requirements are needed on the host that executes this module.

boto
boto3
botocore
python >= 2.6

Parameters ¶

Parameter	Choices/Defaults	Comments
aws_access_key		AWS access key id. If not set then the value of the AWS_ACCESS_KEY environment variable is used. aliases: ec2_access_key, access_key
aws_secret_key		AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used. aliases: ec2_secret_key, secret_key
bucket required		Bucket name.
dest (added in 1.3)		The destination file path when downloading an object/key with a GET operation.
dualstack bool (added in 2.7)	Choices: no ← yes	Enables Amazon S3 Dual-Stack Endpoints, allowing S3 communications using both IPv4 and IPv6. Requires at least botocore version 1.4.45.
ec2_url		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.
encrypt (added in 2.0)	Default: yes	When set for PUT mode, asks for server-side encryption.
encryption_kms_key_id (added in 2.7)		KMS key id to use when encrypting objects using `aws:kms` encryption. Ignored if encryption is not `aws:kms`
encryption_mode (added in 2.7)	Choices: AES256 ← aws:kms	What encryption mode to use if `encrypt` is set
expiration	Default: 600	Time limit (in seconds) for the URL generated and returned by S3/Walrus when performing a mode=put or mode=geturl operation.
headers (added in 2.0)		Custom headers for PUT operation, as a dictionary of 'key=value' and 'key=value,key=value'.
ignore_nonexistent_bucket (added in 2.3)		Overrides initial bucket lookups in case bucket or iam policies are restrictive. Example: a user may have the GetObject permission but no other permissions. In this case using the option mode: get will fail without specifying ignore_nonexistent_bucket: True.
marker (added in 2.0)		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.
max_keys (added in 2.0)	Default: 1000	Max number of results to return in list mode, set this if you want to retrieve fewer than the default 1000 keys.
metadata (added in 1.6)		Metadata for PUT operation, as a dictionary of 'key=value' and 'key=value,key=value'.
mode required	Choices: 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+).
object		Keyname of the object inside the bucket. Can be used to create "virtual directories", see examples.
overwrite	Default: always	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], true is equal to 'always' and false is equal to 'never', new in 2.0. When this is set to 'different', the md5 sum of the local file is compared with the 'ETag' of the object/key in S3. The ETag may or may not be an MD5 digest of the object data. See the ETag response header here https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonResponseHeaders.html aliases: force
permission (added in 2.0)	Default: private	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' for a bucket or 'private', 'public-read', 'public-read-write', 'aws-exec-read', 'authenticated-read', 'bucket-owner-read', 'bucket-owner-full-control' for an object. Multiple permissions can be specified as a list.
prefix (added in 2.0)	Default:	Limits the response to keys that begin with the specified prefix for list mode
profile (added in 1.6)		Uses a boto profile. Only works with boto >= 2.24.0.
region (added in 1.8)		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. aliases: aws_region, ec2_region
retries (added in 2.0)	Default: 0	On recoverable failure, how many times to retry before actually failing.
rgw (added in 2.2)	Default: no	Enable Ceph RGW S3 support. This option requires an explicit url via s3_url.
s3_url		S3 URL endpoint for usage with Ceph, Eucalypus, fakes3, etc. Otherwise assumes AWS aliases: S3_URL
security_token (added in 1.6)		AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. aliases: access_token
src (added in 1.3)		The source file path when performing a PUT operation.
validate_certs bool (added in 1.5)	Choices: no yes ←	When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
version (added in 2.0)		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.

Notes ¶

Note

In 2.4, this module has been renamed from s3 into aws_s3.
If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION
Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples ¶

- name: Simple PUT operation
  aws_s3:
    bucket: mybucket
    object: /my/desired/key.txt
    src: /usr/local/myfile.txt
    mode: put

- name: Simple PUT operation in Ceph RGW S3
  aws_s3:
    bucket: mybucket
    object: /my/desired/key.txt
    src: /usr/local/myfile.txt
    mode: put
    rgw: true
    s3_url: "http://localhost:8000"

- name: Simple GET operation
  aws_s3:
    bucket: mybucket
    object: /my/desired/key.txt
    dest: /usr/local/myfile.txt
    mode: get

- name: Get a specific version of an object.
  aws_s3:
    bucket: mybucket
    object: /my/desired/key.txt
    version: 48c9ee5131af7a716edc22df9772aa6f
    dest: /usr/local/myfile.txt
    mode: get

- name: PUT/upload with metadata
  aws_s3:
    bucket: mybucket
    object: /my/desired/key.txt
    src: /usr/local/myfile.txt
    mode: put
    metadata: 'Content-Encoding=gzip,Cache-Control=no-cache'

- name: PUT/upload with custom headers
  aws_s3:
    bucket: mybucket
    object: /my/desired/key.txt
    src: /usr/local/myfile.txt
    mode: put
    headers: '[email protected]'

- name: List keys simple
  aws_s3:
    bucket: mybucket
    mode: list

- name: List keys all options
  aws_s3:
    bucket: mybucket
    mode: list
    prefix: /my/desired/
    marker: /my/desired/0023.txt
    max_keys: 472

- name: Create an empty bucket
  aws_s3:
    bucket: mybucket
    mode: create
    permission: public-read

- name: Create a bucket with key as directory, in the EU region
  aws_s3:
    bucket: mybucket
    object: /my/directory/path
    mode: create
    region: eu-west-1

- name: Delete a bucket and all contents
  aws_s3:
    bucket: mybucket
    mode: delete

- name: GET an object but don't download if the file checksums match. New in 2.0
  aws_s3:
    bucket: mybucket
    object: /my/desired/key.txt
    dest: /usr/local/myfile.txt
    mode: get
    overwrite: different

- name: Delete an object from a bucket
  aws_s3:
    bucket: mybucket
    object: /my/desired/key.txt
    mode: delobj

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
contents string	(for getstr operation)	contents of the object as string Sample: Hello, world!
expiry int	(for geturl operation)	number of seconds the presigned url is valid for Sample: 600
msg string	always	msg indicating the status of the operation Sample: PUT operation complete
s3_keys list	(for list operation)	list of object keys Sample: ['prefix1/', 'prefix1/key1', 'prefix1/key2']
url string	(for put and geturl operations)	url of the object Sample: https://my-bucket.s3.amazonaws.com/my-key.txt?AWSAccessKeyId=<access-key>&Expires=1506888865&Signature=<signature>

Status ¶

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

Maintenance ¶

This module is flagged as core which means that it is maintained by the Ansible Core Team. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Core Team, see here.

Support ¶

For more information about Red Hat’s support of this module, please refer to this Knowledge Base article

Author ¶

Lester Wade (@lwade)
Sloane Hertel (@s-hertel)

Hint

If you notice any issues in this documentation you can edit this document to improve it.