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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-s3/types.rb

Overview

Specifies lifecycle rules for an Amazon S3 bucket. For more information, see [Put Bucket Lifecycle Configuration] in the *Amazon S3 API Reference*. For examples, see [Put Bucket Lifecycle Configuration Examples].

[1]: docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html [2]: docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html#API_PutBucketLifecycleConfiguration_Examples

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:



16607
16608
16609
16610
16611
16612
16613
16614
16615
16616
16617
16618
 
# File 'lib/aws-sdk-s3/types.rb', line 16607

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

#expiration ⇒ Types::LifecycleExpiration

Specifies the expiration for the lifecycle of the object.

Returns:



16607
16608
16609
16610
16611
16612
16613
16614
16615
16616
16617
16618
 
# File 'lib/aws-sdk-s3/types.rb', line 16607

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

#id ⇒ String

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

Returns:

  • (String) 


16607
16608
16609
16610
16611
16612
16613
16614
16615
16616
16617
16618
 
# File 'lib/aws-sdk-s3/types.rb', line 16607

class Rule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :status,
  :transition,
  :noncurrent_version_transition,
  :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:



16607
16608
16609
16610
16611
16612
16613
16614
16615
16616
16617
16618
 
# File 'lib/aws-sdk-s3/types.rb', line 16607

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

#noncurrent_version_transition ⇒ Types::NoncurrentVersionTransition

Container for the transition rule that describes when noncurrent objects transition to the ‘STANDARD_IA`, `ONEZONE_IA`, `INTELLIGENT_TIERING`, `GLACIER_IR`, `GLACIER`, or `DEEP_ARCHIVE` 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 the `STANDARD_IA`, `ONEZONE_IA`, `INTELLIGENT_TIERING`, `GLACIER_IR`, `GLACIER`, or `DEEP_ARCHIVE` storage class at a specific period in the object’s lifetime.

Returns:



16607
16608
16609
16610
16611
16612
16613
16614
16615
16616
16617
16618
 
# File 'lib/aws-sdk-s3/types.rb', line 16607

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

#prefix ⇒ String

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

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) 


16607
16608
16609
16610
16611
16612
16613
16614
16615
16616
16617
16618
 
# File 'lib/aws-sdk-s3/types.rb', line 16607

class Rule < Struct.new(
  :expiration,
  :id,
  :prefix,
  :status,
  :transition,
  :noncurrent_version_transition,
  :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) 


16607
16608
16609
16610
16611
16612
16613
16614
16615
16616
16617
16618
 
# File 'lib/aws-sdk-s3/types.rb', line 16607

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

#transition ⇒ Types::Transition

Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see [Transitioning Objects Using Amazon S3 Lifecycle] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html

Returns:



16607
16608
16609
16610
16611
16612
16613
16614
16615
16616
16617
16618
 
# File 'lib/aws-sdk-s3/types.rb', line 16607

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