Try SpotterManage S3 bucket lifecycle rules in AWS
| "added in version" 1.0.0 of community.aws"
Authors: Rob White (@wimnat)
Install with ansible-galaxy collection install community.aws:==4.3.0
collections:
- name: community.aws
version: 4.3.0Manage S3 bucket lifecycle rules in AWS.
# 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
name:
description:
- Name of the S3 bucket.
required: true
type: str
wait:
default: false
description:
- Wait for the configuration to complete before returning.
type: bool
version_added: 1.5.0
version_added_collection: community.aws
state:
choices:
- present
- absent
default: present
description:
- Create or remove the lifecycle rule.
type: str
prefix:
description:
- Prefix identifying one or more objects to which the rule applies.
- If no prefix is specified, the rule will apply to the whole bucket.
type: str
region:
aliases:
- aws_region
- ec2_region
description:
- 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
status:
choices:
- enabled
- disabled
default: enabled
description:
- If C(enabled), the rule is currently being applied.
- If C(disabled), the rule is not currently being applied.
type: str
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:
- Uses a boto profile. Only works with boto >= 2.24.0.
- 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
rule_id:
description:
- Unique identifier for the rule.
- The value cannot be longer than 255 characters.
- A unique value for the rule will be generated if no value is provided.
type: str
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
transitions:
description:
- A list of transition behaviors to be applied to the rule.
- Each storage class may be used only once. Each transition behavior may contain these
elements I(transition_days) I(transition_date) I(storage_class)
elements: dict
type: list
aws_ca_bundle:
description:
- 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.'
type: path
storage_class:
choices:
- glacier
- onezone_ia
- standard_ia
- intelligent_tiering
- deep_archive
default: glacier
description:
- The storage class to transition to.
type: str
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- 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 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:
- 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 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:
- AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or 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 boto versions >= 2.6.0.
type: bool
expiration_date:
description:
- Indicates the lifetime of the objects that are subject to the rule by the date they
will expire.
- The value must be ISO-8601 format, the time must be midnight and a GMT timezone
must be specified.
- This cannot be specified with I(expire_object_delete_marker)
type: str
expiration_days:
description:
- Indicates the lifetime, in days, of the objects that are subject to the rule.
- The value must be a non-zero positive integer.
- This cannot be specified with I(expire_object_delete_marker)
type: int
transition_date:
description:
- Indicates the lifetime of the objects that are subject to the rule by the date they
will transition to a different storage class.
- The value must be ISO-8601 format, the time must be midnight and a GMT timezone
must be specified.
- If (transition_days) is not specified, this parameter is required.
type: str
transition_days:
description:
- Indicates when, in days, an object transitions to a different storage class.
- If I(transition_date) is not specified, this parameter is required.
type: int
purge_transitions:
default: true
description:
- Whether to replace all the current transition(s) with the new transition(s).
- When C(false), the provided transition(s) will be added, replacing transitions with
the same storage_class. When true, existing transitions will be removed and replaced
with the new transition(s)
type: bool
expire_object_delete_marker:
description:
- Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions.
- If set to C(true), the delete marker will be expired; if set to C(false) the policy
takes no action.
- This cannot be specified with I(expiration_days) or I(expiration_date).
type: bool
version_added: 2.2.0
version_added_collection: community.aws
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
noncurrent_version_transitions:
description:
- A list of transition behaviors to be applied to noncurrent versions for the rule.
- Each storage class may be used only once. Each transition behavior contains these
elements I(transition_days) I(storage_class)
elements: dict
type: list
noncurrent_version_storage_class:
choices:
- glacier
- onezone_ia
- standard_ia
- intelligent_tiering
- deep_archive
default: glacier
description:
- The storage class to which non-current versions are transitioned.
required: false
type: str
noncurrent_version_expiration_days:
description:
- The number of days after which non-current versions should be deleted.
required: false
type: int
noncurrent_version_transition_days:
description:
- The number of days after which non-current versions will be transitioned to the
storage class specified in I(noncurrent_version_storage_class).
required: false
type: int
abort_incomplete_multipart_upload_days:
description:
- Specifies the days since the initiation of an incomplete multipart upload that Amazon
S3 will wait before permanently removing all parts of the upload.
type: int
version_added: 2.2.0
version_added_collection: community.aws