s3_website - Configure an s3 bucket as a website  New in version 2.2.   
Synopsis Requirements   Parameters Notes Examples Return Values 
Status Author    Synopsis  Configure an s3 bucket as a website  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   Default:None   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   Default:None   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   Default:None   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.     error_key   Default:None   The object key name to use when a 4XX class error occurs. To remove an error key, set to None.     name required   Default:None   Name of the s3 bucket     profile (added in 1.6)   Default:None   Uses a boto profile. Only works with boto >= 2.24.0.     redirect_all_requests   Default:None   Describes the redirect behavior for every request to this s3 bucket website endpoint     region   Default:None   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. 
aliases: aws_region, ec2_region     security_token (added in 1.6)   Default:None   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    Add or remove s3 website configuration     suffix   Default:index.html   Suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html). The suffix must not include a slash character.     validate_certs (added in 1.5)   
Choices: no 
yes ←    When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.     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
 Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/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.

# Configure an s3 bucket to redirect all requests to example.com
- s3_website:
    name: mybucket.com
    redirect_all_requests: example.com
    state: present

# Remove website configuration from an s3 bucket
- s3_website:
    name: mybucket.com
    state: absent

# Configure an s3 bucket as a website with index and error pages
- s3_website:
    name: mybucket.com
    suffix: home.htm
    error_key: errors/404.htm
    state: present
 Return Values Common return values are documented here, the following are the fields unique to this module:   Key Returned Description    error_document complex  always  error document        key string  when error_document parameter set  object key name to use when a 4XX class error occurs  Sample: error.html     index_document complex  always  index document        suffix string  success  suffix that is appended to a request that is for a directory on the website endpoint  Sample: index.html     redirect_all_requests_to complex  always  where to redirect requests        host_name string  when redirect all requests parameter set  name of the host where requests will be redirected.  Sample: ansible.com     routing_rules complex  always  routing rules        redirect            routing_rule            condition string  when routing rule present  object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html  Sample: docs/     Status This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface. Author  Rob White (@wimnat)   Hint If you notice any issues in this documentation you can edit this document to improve it. 

    © 2012–2018 Michael DeHaan
{'path': 'public/docs/ansible~2.5/modules/s3_website_module.html', 'source': 'DevDocs.IO'}