Class: Aws::S3::Types::LifecycleRule

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::LifecycleRule

Defined in:

gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #abort_incomplete_multipart_upload ⇒ Types::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.

• #expiration ⇒ Types::LifecycleExpiration

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

• #filter ⇒ Types::LifecycleRuleFilter

  The Filter is used to identify objects that a Lifecycle Rule applies to.

• #id ⇒ String

  Unique identifier for the rule.

• #noncurrent_version_expiration ⇒ Types::NoncurrentVersionExpiration

  Specifies when noncurrent object versions expire.

• #noncurrent_version_transitions ⇒ Array<Types::NoncurrentVersionTransition>

  Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class.

• #prefix ⇒ String

  The general purpose bucket prefix that identifies one or more objects to which the rule applies.

• #status ⇒ String

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

• #transitions ⇒ Array<Types::Transition>

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

Instance Attribute Details

#abort_incomplete_multipart_upload ⇒ Types::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.

Returns:

• (Types::AbortIncompleteMultipartUpload)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10847

class LifecycleRule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :filter,
  :status,
  :transitions,
  :noncurrent_version_transitions,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  SENSITIVE = []
  include Aws::Structure
end

#expiration ⇒ Types::LifecycleExpiration

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

Returns:

• (Types::LifecycleExpiration)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10847

class LifecycleRule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :filter,
  :status,
  :transitions,
  :noncurrent_version_transitions,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  SENSITIVE = []
  include Aws::Structure
end

#filter ⇒ Types::LifecycleRuleFilter

The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, ObjectSizeGreaterThan, ObjectSizeLessThan, or And specified. Filter is required if the LifecycleRule does not contain a Prefix element.

For more information about Tag filters, see Adding filters to Lifecycle rules in the Amazon S3 User Guide.

Tag filters are not supported for directory buckets.

Returns:

• (Types::LifecycleRuleFilter)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10847

class LifecycleRule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :filter,
  :status,
  :transitions,
  :noncurrent_version_transitions,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10847

class LifecycleRule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :filter,
  :status,
  :transitions,
  :noncurrent_version_transitions,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  SENSITIVE = []
  include Aws::Structure
end

#noncurrent_version_expiration ⇒ Types::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.

Returns:

• (Types::NoncurrentVersionExpiration)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10847

class LifecycleRule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :filter,
  :status,
  :transitions,
  :noncurrent_version_transitions,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  SENSITIVE = []
  include Aws::Structure
end

#noncurrent_version_transitions ⇒ Array<Types::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.

Returns:

• (Array<Types::NoncurrentVersionTransition>)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10847

class LifecycleRule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :filter,
  :status,
  :transitions,
  :noncurrent_version_transitions,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  SENSITIVE = []
  include Aws::Structure
end

#prefix ⇒ String

The general purpose bucket prefix that identifies one or more objects to which the rule applies. We recommend using Filter instead of Prefix for new PUTs. Previous configurations where a prefix is defined will continue to operate as before.

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.

Returns:

• (String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10847

class LifecycleRule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :filter,
  :status,
  :transitions,
  :noncurrent_version_transitions,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10847

class LifecycleRule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :filter,
  :status,
  :transitions,
  :noncurrent_version_transitions,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  SENSITIVE = []
  include Aws::Structure
end

#transitions ⇒ Array<Types::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.

Returns:

• (Array<Types::Transition>)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10847

class LifecycleRule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :filter,
  :status,
  :transitions,
  :noncurrent_version_transitions,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  SENSITIVE = []
  include Aws::Structure
end