ansible / ansible.builtin / v2.9.17 / module / s3_website Configure an s3 bucket as a website | "added in version" 2.2 of ansible.builtin" Authors: Rob White (@wimnat) preview | supported by communityansible.builtin.s3_website (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
Configure an s3 bucket as a website
# 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
name: description: - Name of the s3 bucket required: true state: choices: - present - absent default: present description: - Add or remove s3 website configuration region: aliases: - aws_region - ec2_region description: - '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. ' type: str suffix: default: index.html description: - '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. ' ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - 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. type: str profile: aliases: - aws_profile description: - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str error_key: description: - The object key name to use when a 4XX class error occurs. To remove an error key, set to None. aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(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 U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Not used by boto 2 based modules. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str security_token: aliases: - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool redirect_all_requests: description: - Describes the redirect behavior for every request to this s3 bucket website endpoint debug_botocore_endpoint_logs: default: 'no' description: - 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. type: bool
error_document: contains: key: description: object key name to use when a 4XX class error occurs returned: when error_document parameter set sample: error.html type: str description: error document returned: always type: complex index_document: contains: suffix: description: suffix that is appended to a request that is for a directory on the website endpoint returned: success sample: index.html type: str description: index document returned: always type: complex redirect_all_requests_to: contains: host_name: description: name of the host where requests will be redirected. returned: when redirect all requests parameter set sample: ansible.com type: str description: where to redirect requests returned: always type: complex routing_rules: contains: condition: description: object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html key_prefix_equals: null returned: when routing rule present sample: docs/ type: str redirect: replace_key_prefix_with: description: object key prefix to use in the redirect request returned: when routing rule present sample: documents/ type: str routing_rule: host_name: description: name of the host where requests will be redirected. returned: when host name set as part of redirect rule sample: ansible.com type: str description: routing rules returned: always type: complex