s3_lifecycle

Manage S3 bucket lifecycle rules in AWS

Collection: community.aws

Full Name: community.aws.s3_lifecycle

Synopsis

Manage S3 bucket lifecycle rules in AWS

Parameters

Name	Type	Required	Default
abort_incomplete_multipart_upload_days	int
access_key	str
aws_ca_bundle	path
aws_config	dict
debug_botocore_endpoint_logs	bool		`false`
endpoint_url	str
expiration_date	str
expiration_days	int
expire_object_delete_marker	bool
maximum_object_size	int
minimum_object_size	int
name	str	yes
noncurrent_version_expiration_days	int
noncurrent_version_keep_newer	int
noncurrent_version_storage_class	str		`glacier`
noncurrent_version_transition_days	int
noncurrent_version_transitions	list
prefix	str
profile	str
purge_transitions	bool		`true`
region	str
rule_id	str
secret_key	str
session_token	str
state	str		`present`
status	str		`enabled`
storage_class	str		`glacier`
transition_date	str
transition_days	int
transitions	list
validate_certs	bool		`true`
wait	bool		`false`

Example

yaml

- 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