class Aws::S3::Types::LifecycleRule
A lifecycle rule for individual objects in an Amazon S3
bucket.
@note When making an API call, you may pass LifecycleRule
data as a hash: { expiration: { date: Time.now, days: 1, expired_object_delete_marker: false, }, id: "ID", prefix: "Prefix", filter: { prefix: "Prefix", tag: { key: "ObjectKey", # required value: "Value", # required }, and: { prefix: "Prefix", tags: [ { key: "ObjectKey", # required value: "Value", # required }, ], }, }, status: "Enabled", # required, accepts Enabled, Disabled transitions: [ { date: Time.now, days: 1, storage_class: "GLACIER", # accepts GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE }, ], noncurrent_version_transitions: [ { noncurrent_days: 1, storage_class: "GLACIER", # accepts GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE }, ], noncurrent_version_expiration: { noncurrent_days: 1, }, abort_incomplete_multipart_upload: { days_after_initiation: 1, }, }
@!attribute [rw] expiration
Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker. @return [Types::LifecycleExpiration]
@!attribute [rw] id
Unique identifier for the rule. The value cannot be longer than 255 characters. @return [String]
@!attribute [rw] prefix
Prefix identifying one or more objects to which the rule applies. This is no longer used; use `Filter` instead. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [ XML related object key constraints][1]. [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints @return [String]
@!attribute [rw] filter
The `Filter` is used to identify objects that a Lifecycle Rule applies to. A `Filter` must have exactly one of `Prefix`, `Tag`, or `And` specified. `Filter` is required if the `LifecycleRule` does not containt a `Prefix` element. @return [Types::LifecycleRuleFilter]
@!attribute [rw] status
If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied. @return [String]
@!attribute [rw] transitions
Specifies when an Amazon S3 object transitions to a specified storage class. @return [Array<Types::Transition>]
@!attribute [rw] noncurrent_version_transitions
Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime. @return [Array<Types::NoncurrentVersionTransition>]
@!attribute [rw] noncurrent_version_expiration
Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime. @return [Types::NoncurrentVersionExpiration]
@!attribute [rw] abort_incomplete_multipart_upload
Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see [ Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy][1] in the *Amazon S3 User Guide*. [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config @return [Types::AbortIncompleteMultipartUpload]
@see docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/LifecycleRule AWS API Documentation
Constants
- SENSITIVE