You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing LifecycleRule as input to an Aws::Client method, you can use a vanilla 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
    },
  ],
  noncurrent_version_transitions: [
    {
      noncurrent_days: 1,
      storage_class: "GLACIER", # accepts GLACIER, STANDARD_IA
    },
  ],
  noncurrent_version_expiration: {
    noncurrent_days: 1,
  },
  abort_incomplete_multipart_upload: {
    days_after_initiation: 1,
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#abort_incomplete_multipart_uploadTypes::AbortIncompleteMultipartUpload

Specifies the days since the initiation of an Incomplete Multipart Upload that Lifecycle will wait before permanently removing all parts of the upload.

Returns:

  • (Types::AbortIncompleteMultipartUpload)

    Specifies the days since the initiation of an Incomplete Multipart Upload that Lifecycle will wait before permanently removing all parts of the upload.

#filterTypes::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.

Returns:

#idString

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

Returns:

  • (String)

    Unique identifier for the rule.

#noncurrent_version_expirationTypes::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.

Returns:

#noncurrent_version_transitionsArray<Types::NoncurrentVersionTransition>

#prefixString

Prefix identifying one or more objects to which the rule applies. This is deprecated; use Filter instead.

Returns:

  • (String)

    Prefix identifying one or more objects to which the rule applies.

#statusString

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

Possible values:

  • Enabled
  • Disabled

Returns:

  • (String)

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

#transitionsArray<Types::Transition>

Returns: