community.aws.s3_website 模块 – 将 s3 存储桶配置为网站

注意

此模块是 community.aws 集合 (版本 9.0.0) 的一部分。

如果您正在使用 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装它，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.aws。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

要在 playbook 中使用它，请指定：community.aws.s3_website。

community.aws 1.0.0 中的新增功能

摘要

• 将 s3 存储桶配置为网站

要求

以下是执行此模块的主机所需的条件。

• python >= 3.6

• boto3 >= 1.28.0

• botocore >= 1.31.0

参数

参数	注释
access_key 别名：aws_access_key_id, aws_access_key, ec2_access_key 字符串	AWS 访问密钥 ID。 有关访问令牌的更多信息，请参见 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级递减的顺序使用 AWS_ACCESS_KEY_ID、AWS_ACCESS_KEY 或 EC2_ACCESS_KEY 环境变量。 aws_access_key 和 profile 选项是互斥的。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已被弃用，并将在 2024-12-01 后的版本中删除。 EC2_ACCESS_KEY 环境变量的支持已被弃用，并将在 2024-12-01 后的版本中删除。
aws_ca_bundle 路径	验证 SSL 证书时要使用的 CA 捆绑包的位置。 也可以使用 AWS_CA_BUNDLE 环境变量。
aws_config 字典	用于修改 botocore 配置的字典。 可以在 AWS 文档中找到参数 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器来解析任务期间进行的唯一（而不是总计）"resource:action" API 调用，并将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到 playbook 期间进行的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
endpoint_url 别名：ec2_url, aws_endpoint_url, s3_url 字符串	连接到默认 AWS 端点以外的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 也可以按优先级递减的顺序使用 AWS_URL 或 EC2_URL 环境变量。 ec2_url 和 s3_url 别名已被弃用，并将在 2024-12-01 后的版本中删除。 对EC2_URL环境变量的支持已弃用，并将在2024-12-01之后的一个版本中移除。
error_key 字符串	发生4XX类错误时使用的对象键名。要移除错误键，请设置为None。
name 字符串 / 必填	S3存储桶名称
profile 别名：aws_profile 字符串	用于身份验证的命名AWS配置文件。 有关命名配置文件的更多信息，请参阅AWS文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 也可以使用AWS_PROFILE环境变量。 profile选项与aws_access_key、aws_secret_key和security_token选项互斥。
redirect_all_requests 字符串	描述对这个S3存储桶网站端点的每个请求的重定向行为。
region 别名：aws_region, ec2_region 字符串	要使用的AWS区域。 对于IAM、Route53和CloudFront等全球服务，将忽略region。 也可以使用AWS_REGION或EC2_REGION环境变量。 有关更多信息，请参阅Amazon AWS文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。 ec2_region别名已弃用，并将在2024-12-01之后的一个版本中移除。 对EC2_REGION环境变量的支持已弃用，并将在2024-12-01之后的一个版本中移除。
secret_key 别名：aws_secret_access_key, aws_secret_key, ec2_secret_key 字符串	AWS密钥访问密钥。 有关访问令牌的更多信息，请参见 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级递减顺序使用AWS_SECRET_ACCESS_KEY、AWS_SECRET_KEY或EC2_SECRET_KEY环境变量。 secret_key和profile选项互斥。 为了与AWS botocore SDK保持一致，在5.1.0版本中添加了aws_secret_access_key别名。 ec2_secret_key别名已弃用，并将在2024-12-01之后的一个版本中移除。 对EC2_SECRET_KEY环境变量的支持已弃用，并将在2024-12-01之后的一个版本中移除。
session_token 别名：aws_session_token, security_token, aws_security_token, access_token 字符串	与临时凭证一起使用的AWS STS会话令牌。 有关访问令牌的更多信息，请参见 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级递减顺序使用AWS_SESSION_TOKEN、AWS_SECURITY_TOKEN或EC2_SECURITY_TOKEN环境变量。 security_token和profile选项互斥。 在3.2.0版本中添加了aws_session_token和session_token别名，在6.0.0版本中将参数名称从security_token重命名为session_token。 security_token、aws_security_token和access_token别名已弃用，并将在2024-12-01之后的一个版本中移除。 对EC2_SECRET_KEY和AWS_SECURITY_TOKEN环境变量的支持已弃用，并将在2024-12-01之后的一个版本中移除。
state 字符串 / 必填	添加或删除S3网站配置 选项 "present" "absent"
suffix 字符串	附加到对网站端点上的目录的请求的后缀（例如，如果后缀为index.html，并且您向samplebucket/images/发出请求，则返回的数据将是键名为images/index.html的对象的数据）。后缀不能包含斜杠字符。 默认值："index.html"
validate_certs 布尔值	设置为false时，将不会验证与AWS API通信的SSL证书。 强烈建议不要设置validate_certs=false，作为替代方案，请考虑改用aws_ca_bundle。 选项 false true ← (默认)

备注

注意

• 警告：对于模块，环境变量和配置文件是从Ansible的“主机”上下文读取的，而不是“控制器”上下文。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从Ansible的“控制器”上下文读取的，而不是“主机”上下文。

• Ansible使用的AWS SDK (boto3)也可能从Ansible“主机”上下文中的配置文件（通常为~/.aws/credentials）读取凭据和其他设置的默认值，例如区域。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

# 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

返回值

常用返回值已在 此处 记录，以下是此模块特有的字段

键	描述
error_document 复杂类型	错误文档 返回值：始终返回
key 字符串	发生4XX类错误时使用的对象键名 返回值：当设置error_document参数时返回 示例："error.html"
index_document 复杂类型	索引文档 返回值：始终返回
suffix 字符串	附加到对网站端点上的目录的请求的后缀 返回值：成功时返回 示例："index.html"
redirect_all_requests_to 复杂类型	重定向请求的目标位置 返回值：始终返回
host_name 字符串	将重定向请求的主机名。 返回值：当设置重定向所有请求参数时返回 示例："ansible.com"
protocol 字符串	重定向请求时使用的协议。 返回值：当设置重定向所有请求参数时返回 示例："https"
routing_rules 列表 / 元素=字符串	路由规则 返回值：始终返回
condition 复杂类型	用于描述必须满足才能应用指定重定向的条件的容器。 返回值：成功时返回
http_error_code_returned_equals 字符串	应用重定向时的HTTP错误代码。 返回值：始终返回
key_prefix_equals 字符串	应用重定向时的对象键名前缀。例如，要重定向对ExamplePage.html的请求，键前缀将为ExamplePage.html。 返回值：当存在路由规则时返回 示例："docs/"
redirect 复杂类型	重定向信息的容器。 返回值：始终返回
host_name 字符串	将重定向请求的主机名。 返回值：当主机名设置为重定向规则的一部分时返回 示例："ansible.com"
http_redirect_code 字符串	要在响应中使用的HTTP重定向代码。 返回值：当存在路由规则时返回
protocol 字符串	重定向请求时使用的协议。 返回值：当存在路由规则时返回 示例："http"
replace_key_prefix_with 字符串	在重定向请求中使用的对象键名前缀 返回值：当存在路由规则时返回 示例："documents/"
replace_key_with 字符串	在重定向请求中使用的对象键名前缀 返回值：当存在路由规则时返回 示例："documents/"

作者

• Rob White (@wimnat)

集合链接

• 问题追踪器
• 代码库 (源代码)
• 沟通