Documentation

s3_bucket - Manage s3 buckets in AWS

New in version 2.0.

Synopsis

Manage s3 buckets in AWS

Requirements (on host that executes module)

  • python >= 2.6
  • boto

Options

parameter required default choices comments
aws_access_key
 no
    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
    		 no
      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
      ec2_url
      		 no
        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.
        force
        		 no
        • yes
        • no
        When trying to delete a bucket, delete all keys in the bucket first (an s3 bucket must be empty for a successful deletion)
        name
        		 yes
          Name of the s3 bucket
          policy
          		 no
            The JSON policy as a string.
            profile
            (added in 1.6)
            		 no
              uses a boto profile. Only works with boto >= 2.24.0
              region
              		 no
                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
                		 no
                • yes
                • no
                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
                		 no
                  S3 URL endpoint for usage with Eucalypus, fakes3, etc. Otherwise assumes AWS

                  aliases: S3_URL
                  security_token
                  (added in 1.6)
                  		 no
                    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
                    		 no present
                    • present
                    • absent
                    Create or remove the s3 bucket
                    tags
                    		 no
                      tags dict to apply to bucket
                      validate_certs
                      (added in 1.5)
                      		 no yes
                      • yes
                      • no
                      When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
                      versioning
                      		 no
                      • yes
                      • no
                      Whether versioning is enabled or disabled (note that once versioning is enabled, it can only be suspended)

                      Examples

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

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

# 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

                      Notes

                      Note

                      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

                      Note

                      Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html

                      Note

                      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

                      This is an Extras Module

                      For more information on what this means please read Extras Modules

                      For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.