Note
This plugin is part of the community.aws collection.
To install it use: ansible-galaxy collection install community.aws.
To use it in a playbook, specify: community.aws.s3_website.
New in version 1.0.0: of community.aws
The below requirements are needed on the host that executes this module.
| 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. If profile is set this parameter is ignored. Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. aliases: ec2_access_key, access_key | |
| aws_ca_bundle path | The location of a CA Bundle to use when validating SSL certificates. Only used for boto3 based modules. Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally. | |
| aws_config dictionary | A dictionary to modify the botocore configuration. Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration. | |
| 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. If profile is set this parameter is ignored. Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. aliases: ec2_secret_key, secret_key | |
| debug_botocore_endpoint_logs boolean |
| 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. aliases: aws_endpoint_url, endpoint_url | |
| error_key string | The object key name to use when a 4XX class error occurs. To remove an error key, set to None. | |
| name string / required | Name of the s3 bucket | |
| profile string | Uses a boto profile. Only works with boto >= 2.24.0. Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01. aliases: aws_profile | |
| redirect_all_requests string | Describes the redirect behavior for every request to this s3 bucket website endpoint | |
| 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 | |
| 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. If profile is set this parameter is ignored. Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. aliases: aws_security_token, access_token | |
| state string / required |
| Add or remove s3 website configuration |
| suffix string | 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 boolean |
| When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. |
Note
AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
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# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Configure an s3 bucket to redirect all requests to example.com
community.aws.s3_website:
name: mybucket.com
redirect_all_requests: example.com
state: present
- name: Remove website configuration from an s3 bucket
community.aws.s3_website:
name: mybucket.com
state: absent
- name: Configure an s3 bucket as a website with index and error pages
community.aws.s3_website:
name: mybucket.com
suffix: home.htm
error_key: errors/404.htm
state: present
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 | ||
| protocol string | when redirect all requests parameter set | protocol to use when redirecting requests. Sample: https | ||
| routing_rules list / elements=string | always | routing rules | ||
| condition complex | success | A container for describing a condition that must be met for the specified redirect to apply. | ||
| http_error_code_returned_equals string | always | The HTTP error code when the redirect is applied. | ||
| key_prefix_equals 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/ | ||
| redirect complex | always | Container for redirect information. | ||
| host_name string | when host name set as part of redirect rule | name of the host where requests will be redirected. Sample: ansible.com | ||
| http_redirect_code string | when routing rule present | The HTTP redirect code to use on the response. | ||
| protocol string | when routing rule present | Protocol to use when redirecting requests. Sample: http | ||
| replace_key_prefix_with string | when routing rule present | object key prefix to use in the redirect request Sample: documents/ | ||
| replace_key_with string | when routing rule present | object key prefix to use in the redirect request Sample: documents/ | ||
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/s3_website_module.html