Struct LifecycleRule

#[non_exhaustive]
pub struct LifecycleRule {
    pub expiration: Option<LifecycleExpiration>,
    pub id: Option<String>,
    pub prefix: Option<String>,
    pub filter: Option<LifecycleRuleFilter>,
    pub status: ExpirationStatus,
    pub transitions: Option<Vec<Transition>>,
    pub noncurrent_version_transitions: Option<Vec<NoncurrentVersionTransition>>,
    pub noncurrent_version_expiration: Option<NoncurrentVersionExpiration>,
    pub abort_incomplete_multipart_upload: Option<AbortIncompleteMultipartUpload>,
}

A lifecycle rule for individual objects in an Amazon S3 bucket.

For more information see, Managing your storage lifecycle in the Amazon S3 User Guide.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

expiration: Option<LifecycleExpiration>

Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

id: Option<String>

Unique identifier for the rule. The value cannot be longer than 255 characters.

prefix: Option<String>

👎Deprecated

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.

filter: Option<LifecycleRuleFilter>

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 contain a Prefix element.

Tag filters are not supported for directory buckets.

status: ExpirationStatus

If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

transitions: Option<Vec<Transition>>

Specifies when an Amazon S3 object transitions to a specified storage class.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

noncurrent_version_transitions: Option<Vec<NoncurrentVersionTransition>>

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.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

noncurrent_version_expiration: Option<NoncurrentVersionExpiration>

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.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

abort_incomplete_multipart_upload: Option<AbortIncompleteMultipartUpload>

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 Configuration in the Amazon S3 User Guide.

Implementations

impl LifecycleRule

pub fn expiration(&self) -> Option<&LifecycleExpiration>

Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

pub fn id(&self) -> Option<&str>

Unique identifier for the rule. The value cannot be longer than 255 characters.

pub fn prefix(&self) -> Option<&str>

👎Deprecated

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.

pub fn filter(&self) -> Option<&LifecycleRuleFilter>

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 contain a Prefix element.

Tag filters are not supported for directory buckets.

pub fn status(&self) -> &ExpirationStatus

If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

pub fn transitions(&self) -> &[Transition]

Specifies when an Amazon S3 object transitions to a specified storage class.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .transitions.is_none().

pub fn noncurrent_version_transitions(&self) -> &[NoncurrentVersionTransition]

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.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .noncurrent_version_transitions.is_none().

pub fn noncurrent_version_expiration( &self, ) -> Option<&NoncurrentVersionExpiration>

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.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

pub fn abort_incomplete_multipart_upload( &self, ) -> Option<&AbortIncompleteMultipartUpload>

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 Configuration in the Amazon S3 User Guide.

impl LifecycleRule

pub fn builder() -> LifecycleRuleBuilder

Creates a new builder-style object to manufacture LifecycleRule.

Trait Implementations

impl Clone for LifecycleRule

fn clone(&self) -> LifecycleRule

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LifecycleRule

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for LifecycleRule

fn eq(&self, other: &LifecycleRule) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for LifecycleRule