s3_bucket – Manage S3 buckets in AWS, DigitalOcean, Ceph, Walrus and FakeS3 — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# s3_bucket – Manage S3 buckets in AWS, DigitalOcean, Ceph, Walrus and FakeS3

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Status

## Synopsis

- Manage S3 buckets in AWS, DigitalOcean, Ceph, Walrus and FakeS3

## Requirements

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

- boto
- boto3
- python >= 2.6

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
aws_access_key string |  | AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. aliases: ec2_access_key, access_key
aws_secret_key string |  | AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. aliases: ec2_secret_key, secret_key
ceph boolean | Choices: no yes | Enable API compatibility with Ceph. It takes into account the S3 API subset working with Ceph in order to provide the same module behaviour where possible.
debug_botocore_endpoint_logs boolean added in 2.8 | Choices: no ← yes | 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.
ec2_url string |  | 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.
encryption - added in 2.9 | Choices: none AES256 aws:kms | Describes the default server-side encryption to apply to new objects in the bucket. In order to remove the server-side encryption, the encryption needs to be set to 'none' explicitly.
encryption_key_id - added in 2.9 |  | KMS master key ID to use for the default encryption. This parameter is allowed if encryption is aws:kms. If not specified then it will default to the AWS provided KMS key.
force boolean | Choices: no ← yes | When trying to delete a bucket, delete all keys (including versions and delete markers) in the bucket first (an s3 bucket must be empty for a successful deletion)
name - / required |  | Name of the s3 bucket
policy - |  | The JSON policy as a string.
profile string |  | Uses a boto profile. Only works with boto >= 2.24.0.
purge_tags boolean added in 2.9 | Choices: no yes ← | whether to remove tags that aren't present in the `tags` parameter
region string |  | 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 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region aliases: aws_region, ec2_region
requester_pays boolean | Choices: no ← yes | With Requester Pays buckets, the requester instead of the bucket owner pays the cost of the request and the data download from the bucket.
s3_url - |  | S3 URL endpoint for usage with DigitalOcean, Ceph, Eucalyptus and fakes3 etc. Assumes AWS if not specified. For Walrus, use FQDN of the endpoint without scheme nor path. aliases: S3_URL
security_token string |  | 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
state - | Choices: present ← absent | Create or remove the s3 bucket
tags - |  | tags dict to apply to bucket
validate_certs boolean | Choices: no yes ← | When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
versioning boolean | Choices: no yes | Whether versioning is enabled or disabled (note that once versioning is enabled, it can only be suspended)

## Notes

Note

- If `requestPayment`, `policy`, `tagging` or `versioning` operations/API aren’t implemented by the endpoint, module doesn’t fail if related parameters requester_pays, policy, tags or versioning are `None`.
- 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

    # Note: These examples do not set authentication details, see the AWS Guide for details.

    # Create a simple s3 bucket
    - s3_bucket:
        name: mys3bucket
        state: present

    # Create a simple s3 bucket on Ceph Rados Gateway
    - s3_bucket:
        name: mys3bucket
        s3_url: http://your-ceph-rados-gateway-server.xxx
        ceph: true

    # Remove an s3 bucket and any keys it contains
    - s3_bucket:
        name: mys3bucket
        state: absent
        force: yes

    # Create a bucket, add a policy from a file, enable requester pays, enable versioning and tag
    - s3_bucket:
        name: mys3bucket
        policy: "{{ lookup('file','policy.json') }}"
        requester_pays: yes
        versioning: yes
        tags:
          example: tag1
          another: tag2

    # Create a simple DigitalOcean Spaces bucket using their provided regional endpoint
    - s3_bucket:
        name: mydobucket
        s3_url: 'https://nyc3.digitaloceanspaces.com'

## Status

- This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]
- This module is maintained by the Ansible Core Team. [core]

### Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

### Authors

- Rob White (@wimnat)

Hint

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