community.aws.s3_lifecycle 模块 – 在 AWS 中管理 S3 存储桶生命周期规则
注意
此模块是 community.aws 集合（版本 9.0.0）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install community.aws。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。
要在 playbook 中使用它，请指定：community.aws.s3_lifecycle。
community.aws 1.0.0 中的新增功能
概要
在 AWS 中管理 S3 存储桶生命周期规则。
要求
执行此模块的主机需要以下要求。
python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0
参数
参数 |
注释 |
|---|---|
指定自不完整的多部分上传启动以来，Amazon S3 在永久删除上传的所有部分之前将等待的天数。 |
|
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 和 profile 选项互斥。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 |
|
用于验证 SSL 证书的 CA 捆绑包的位置。 也可以使用 |
|
用于修改 botocore 配置的字典。 参数可以在 AWS 文档中找到 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。 |
|
使用 也可以使用 选项
|
|
要连接到的 URL，而不是默认的 AWS 端点。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 也可以按优先级降序使用 ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 |
|
指示受规则约束的对象的生命周期（按它们将过期的日期）。 值必须是 ISO-8601 格式，时间必须是午夜，并且必须指定 GMT 时区。 此项不能与 expire_object_delete_marker 一起指定。 |
|
表示受该规则约束的对象的生命周期，以天为单位。 该值必须为非零正整数。 此项不能与 expire_object_delete_marker 一起指定。 |
|
表示 Amazon S3 是否会移除没有非当前版本的删除标记。 如果设置为 此项不能与 expiration_days 或 expiration_date 一起指定。 选项
|
|
S3 存储桶的名称。 |
|
非当前版本应被删除的天数。 如果设置了 noncurrent_version_keep_newer，则必须设置此项。 |
|
要保留的非当前版本的最小数量。 需要 noncurrent_version_expiration_days。 |
|
非当前版本将转换到的存储类别。 选项
|
|
非当前版本将转换为 noncurrent_version_storage_class 中指定的存储类别的天数。 |
|
要应用于规则的非当前版本的转换行为列表。 每个存储类别只能使用一次。每个转换行为都包含这些元素 transition_days storage_class |
|
标识应用规则的一个或多个对象的前缀。 如果未指定前缀，则规则将应用于整个存储桶。 |
|
用于身份验证的已命名的 AWS 配置文件。 有关已命名配置文件的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 也可以使用 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。 |
|
是否将所有当前转换替换为新转换。 当 选项
|
|
要使用的 AWS 区域。 对于 IAM、Route53 和 CloudFront 等全局服务，将忽略 region。 也可以使用 有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。
对 |
|
规则的唯一标识符。 该值不能超过 255 个字符。 如果未提供值，将为该规则生成唯一值。 |
|
AWS secret access key. 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级降序使用 secret_key 和 profile 选项互斥。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。 ec2_secret_key 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 |
|
用于临时凭证的 AWS STS 会话令牌。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级降序使用 security_token 和 profile 选项互斥。 别名 aws_session_token 和 session_token 在 3.2.0 版本中添加，参数在 6.0.0 版本中从 security_token 重命名为 session_token。 security_token、aws_security_token 和 access_token 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 |
|
创建或删除生命周期规则。 选项
|
|
如果为 如果为 选项
|
|
要转换到的存储类别。 选项
|
|
表示受规则约束的对象将转换到不同存储类别的日期时的生命周期。 值必须是 ISO-8601 格式，时间必须是午夜，并且必须指定 GMT 时区。 如果未指定 (transition_days)，则此参数为必填项。 |
|
表示对象在多少天后转换到不同的存储类别。 如果未指定 transition_date，则此参数为必填项。 |
|
要应用于规则的转换行为列表。 每个存储类别只能使用一次。每个转换行为都可能包含这些元素 transition_days transition_date storage_class |
|
如果设置为 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项
|
|
在返回之前等待配置完成。 选项
|
注意
注意
如果将过期时间指定为天数，则转换时间也必须以天数指定。
如果将过期时间指定为日期，则转换时间也必须以日期指定。
警告： 对于模块，环境变量和配置文件是从 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 a lifecycle rule on a bucket to expire (delete) items with a prefix of /logs/ after 30 days
community.aws.s3_lifecycle:
name: mybucket
expiration_days: 30
prefix: logs/
status: enabled
state: present
- name: Configure a lifecycle rule to transition all items with a prefix of /logs/ to glacier after 7 days and then delete after 90 days
community.aws.s3_lifecycle:
name: mybucket
transition_days: 7
expiration_days: 90
prefix: logs/
status: enabled
state: present
# Note that midnight GMT must be specified.
# Be sure to quote your date strings
- name: Configure a lifecycle rule to transition all items with a prefix of /logs/ to glacier on 31 Dec 2020 and then delete on 31 Dec 2030.
community.aws.s3_lifecycle:
name: mybucket
transition_date: "2020-12-30T00:00:00.000Z"
expiration_date: "2030-12-30T00:00:00.000Z"
prefix: logs/
status: enabled
state: present
- name: Disable the rule created above
community.aws.s3_lifecycle:
name: mybucket
prefix: logs/
status: disabled
state: present
- name: Delete the lifecycle rule created above
community.aws.s3_lifecycle:
name: mybucket
prefix: logs/
state: absent
- name: Configure a lifecycle rule to transition all backup files older than 31 days in /backups/ to standard infrequent access class.
community.aws.s3_lifecycle:
name: mybucket
prefix: backups/
storage_class: standard_ia
transition_days: 31
state: present
status: enabled
- name: Configure a lifecycle rule to transition files to infrequent access after 30 days and glacier after 90
community.aws.s3_lifecycle:
name: mybucket
prefix: logs/
state: present
status: enabled
transitions:
- transition_days: 30
storage_class: standard_ia
- transition_days: 90
storage_class: glacier