Documentation

s3 - manage objects in S3.

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 python-boto.

Requirements (on host that executes module)

  • boto
  • python >= 2.6

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
      bucket
      yes
        Bucket name.
        dest
        (added in 1.3)
        no
          The destination file path when downloading an object/key with a GET operation.
          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.
            encrypt
            (added in 2.0)
            no
              When set for PUT mode, asks for server-side encryption
              expiration
              no 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)
                no
                  Custom headers for PUT operation, as a dictionary of 'key=value' and 'key=value,key=value'.
                  marker
                  (added in 2.0)
                  no
                    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)
                    no 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)
                      no
                        Metadata for PUT operation, as a dictionary of 'key=value' and 'key=value,key=value'.
                        mode
                        yes
                        • 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
                        no
                          Keyname of the object inside the bucket. Can be used to create "virtual directories", see examples.
                          overwrite
                          no True
                            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], new in 2.0
                            permission
                            (added in 2.0)
                            no 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'. Multiple permissions can be specified as a list.
                              prefix
                              (added in 2.0)
                              no
                                Limits the response to keys that begin with the specified prefix for list mode
                                profile
                                (added in 1.6)
                                no
                                  uses a boto profile. Only works with boto >= 2.24.0
                                  region
                                  (added in 1.8)
                                  no
                                    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.
                                    retries
                                    (added in 2.0)
                                    no
                                      On recoverable failure, how many times to retry before actually failing.
                                      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
                                          src
                                          (added in 1.3)
                                          no
                                            The source file path when performing a PUT operation.
                                            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.
                                            version
                                            (added in 2.0)
                                            no
                                              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.

                                              Examples

                                              # Simple PUT operation
                                              - s3: bucket=mybucket object=/my/desired/key.txt src=/usr/local/myfile.txt mode=put
                                              
                                              # Simple GET operation
                                              - s3: bucket=mybucket object=/my/desired/key.txt dest=/usr/local/myfile.txt mode=get
                                              
                                              # Get a specific version of an object.
                                              - s3: bucket=mybucket object=/my/desired/key.txt version=48c9ee5131af7a716edc22df9772aa6f dest=/usr/local/myfile.txt mode=get
                                              
                                              # PUT/upload with metadata
                                              - s3: bucket=mybucket object=/my/desired/key.txt src=/usr/local/myfile.txt mode=put metadata='Content-Encoding=gzip,Cache-Control=no-cache'
                                              
                                              # PUT/upload with custom headers
                                              - s3: bucket=mybucket object=/my/desired/key.txt src=/usr/local/myfile.txt mode=put headers=x-amz-grant-full-control=emailAddress=owner@example.com
                                              
                                              # List keys simple
                                              - s3: bucket=mybucket mode=list
                                              
                                              # List keys all options
                                              - s3: bucket=mybucket mode=list prefix=/my/desired/ marker=/my/desired/0023.txt max_keys=472
                                              
                                              # Create an empty bucket
                                              - s3: bucket=mybucket mode=create permission=public-read
                                              
                                              # Create a bucket with key as directory, in the EU region
                                              - s3: bucket=mybucket object=/my/directory/path mode=create region=eu-west-1
                                              
                                              # Delete a bucket and all contents
                                              - s3: bucket=mybucket mode=delete
                                              
                                              # GET an object but dont download if the file checksums match. New in 2.0
                                              - s3: bucket=mybucket object=/my/desired/key.txt dest=/usr/local/myfile.txt mode=get overwrite=different
                                              
                                              # Delete an object from a bucket
                                              - s3: bucket=mybucket object=/my/desired/key.txt mode=delobj
                                              

                                              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 a Core Module

                                              For more information on what this means please read Core Modules

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