Class: Aws::S3::Types::Rule

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::Rule

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass Rule data as a hash:

{
  expiration: {
    date: Time.now,
    days: 1,
    expired_object_delete_marker: false,
  },
  id: "ID",
  prefix: "Prefix", # required
  status: "Enabled", # required, accepts Enabled, Disabled
  transition: {
    date: Time.now,
    days: 1,
    storage_class: "GLACIER", # accepts GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE
  },
  noncurrent_version_transition: {
    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,
  },
}

Specifies lifecycle rules for an Amazon S3 bucket. For more information, see [PUT Bucket lifecycle] in the *Amazon Simple Storage Service API Reference*.

[1]: docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html

See Also:

• AWS API Documentation

Instance Attribute Summary

• #abort_incomplete_multipart_upload ⇒ Types::AbortIncompleteMultipartUpload
• #expiration ⇒ Types::LifecycleExpiration
• #id ⇒ String

  Unique identifier for the rule.

• #noncurrent_version_expiration ⇒ Types::NoncurrentVersionExpiration
• #noncurrent_version_transition ⇒ Types::NoncurrentVersionTransition
• #prefix ⇒ String

  Object key prefix that identifies one or more objects to which this rule applies.

• #status ⇒ String

  If ‘Enabled`, the rule is currently being applied.

• #transition ⇒ Types::Transition

Instance Attribute Details

#abort_incomplete_multipart_upload ⇒ Types::AbortIncompleteMultipartUpload

Returns:

• (Types::AbortIncompleteMultipartUpload)

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

class Rule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :status,
  :transition,
  :noncurrent_version_transition,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  include Aws::Structure
end

#expiration ⇒ Types::LifecycleExpiration

Returns:

• (Types::LifecycleExpiration)

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

class Rule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :status,
  :transition,
  :noncurrent_version_transition,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  include Aws::Structure
end

#id ⇒ String

Unique identifier for the rule. The value can’t be longer than 255 characters.

Returns:

• (String)

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

class Rule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :status,
  :transition,
  :noncurrent_version_transition,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  include Aws::Structure
end

#noncurrent_version_expiration ⇒ Types::NoncurrentVersionExpiration

Returns:

• (Types::NoncurrentVersionExpiration)

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

class Rule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :status,
  :transition,
  :noncurrent_version_transition,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  include Aws::Structure
end

#noncurrent_version_transition ⇒ Types::NoncurrentVersionTransition

Returns:

• (Types::NoncurrentVersionTransition)

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

class Rule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :status,
  :transition,
  :noncurrent_version_transition,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  include Aws::Structure
end

#prefix ⇒ String

Object key prefix that identifies one or more objects to which this rule applies.

Returns:

• (String)

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

class Rule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :status,
  :transition,
  :noncurrent_version_transition,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  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 'lib/aws-sdk-s3/types.rb', line 9093

class Rule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :status,
  :transition,
  :noncurrent_version_transition,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  include Aws::Structure
end

#transition ⇒ Types::Transition

Returns:

• (Types::Transition)

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

class Rule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :status,
  :transition,
  :noncurrent_version_transition,
  :noncurrent_version_expiration,
  :abort_incomplete_multipart_upload)
  include Aws::Structure
end