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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config

Returns:



10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
 
# File 'lib/aws-sdk-s3/types.rb', line 10957

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:



10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
 
# File 'lib/aws-sdk-s3/types.rb', line 10957

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*.

<note markdown=“1”> ‘Tag` filters are not supported for directory buckets.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-filters.html

Returns:



10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
 
# File 'lib/aws-sdk-s3/types.rb', line 10957

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) 


10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
 
# File 'lib/aws-sdk-s3/types.rb', line 10957

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.

<note markdown=“1”> This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

</note>

Returns:



10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
 
# File 'lib/aws-sdk-s3/types.rb', line 10957

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.

<note markdown=“1”> This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

</note>

Returns:



10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
 
# File 'lib/aws-sdk-s3/types.rb', line 10957

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].

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints

Returns:

  • (String) 


10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
 
# File 'lib/aws-sdk-s3/types.rb', line 10957

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) 


10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
 
# File 'lib/aws-sdk-s3/types.rb', line 10957

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.

<note markdown=“1”> This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

</note>

Returns:



10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
 
# File 'lib/aws-sdk-s3/types.rb', line 10957

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