Skip to content

/AWS1/CL_S3_LIFECYCLERULE

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.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_status TYPE /AWS1/S3_EXPIRATIONSTATUS /AWS1/S3_EXPIRATIONSTATUS

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

Optional arguments:

io_expiration TYPE REF TO /AWS1/CL_S3_LIFECYCLEEXPIR /AWS1/CL_S3_LIFECYCLEEXPIR

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

iv_id TYPE /AWS1/S3_ID /AWS1/S3_ID

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

iv_prefix TYPE /AWS1/S3_PREFIX /AWS1/S3_PREFIX

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

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.

io_filter TYPE REF TO /AWS1/CL_S3_LCRULEFILTER /AWS1/CL_S3_LCRULEFILTER

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.

it_transitions TYPE /AWS1/CL_S3_TRANSITION=>TT_TRANSITIONLIST TT_TRANSITIONLIST

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.

it_noncurrentversiontranss TYPE /AWS1/CL_S3_NONCURRVRSTRANS=>TT_NONCURRENTVERSIONTRANSLIST TT_NONCURRENTVERSIONTRANSLIST

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.

io_noncurrentversionexpir TYPE REF TO /AWS1/CL_S3_NONCURRVRSEXPIR /AWS1/CL_S3_NONCURRVRSEXPIR

NoncurrentVersionExpiration

io_abortincompletempupload TYPE REF TO /AWS1/CL_S3_ABTINCMPLMPUPLOAD /AWS1/CL_S3_ABTINCMPLMPUPLOAD

AbortIncompleteMultipartUpload

Queryable Attributes

Expiration

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

Accessible with the following methods

Method Description
GET_EXPIRATION() Getter for EXPIRATION

ID

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

Accessible with the following methods

Method Description
GET_ID() Getter for ID, with configurable default
ASK_ID() Getter for ID w/ exceptions if field has no value
HAS_ID() Determine if ID has a value

Prefix

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

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.

Accessible with the following methods

Method Description
GET_PREFIX() Getter for PREFIX, with configurable default
ASK_PREFIX() Getter for PREFIX w/ exceptions if field has no value
HAS_PREFIX() Determine if PREFIX has a value

Filter

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.

Accessible with the following methods

Method Description
GET_FILTER() Getter for FILTER

Status

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

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS, with configurable default
ASK_STATUS() Getter for STATUS w/ exceptions if field has no value
HAS_STATUS() Determine if STATUS has a value

Transitions

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.

Accessible with the following methods

Method Description
GET_TRANSITIONS() Getter for TRANSITIONS, with configurable default
ASK_TRANSITIONS() Getter for TRANSITIONS w/ exceptions if field has no value
HAS_TRANSITIONS() Determine if TRANSITIONS has a value

NoncurrentVersionTransitions

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.

Accessible with the following methods

Method Description
GET_NONCURRENTVERSIONTRANSS() Getter for NONCURRENTVERSIONTRANSITIONS, with configurable d
ASK_NONCURRENTVERSIONTRANSS() Getter for NONCURRENTVERSIONTRANSITIONS w/ exceptions if fie
HAS_NONCURRENTVERSIONTRANSS() Determine if NONCURRENTVERSIONTRANSITIONS has a value

NoncurrentVersionExpiration

NoncurrentVersionExpiration

Accessible with the following methods

Method Description
GET_NONCURRENTVERSIONEXPIR() Getter for NONCURRENTVERSIONEXPIRATION

AbortIncompleteMultipartUpload

AbortIncompleteMultipartUpload

Accessible with the following methods

Method Description
GET_ABORTINCOMPLETEMPUPLOAD() Getter for ABORTINCOMPLETEMPUPLOAD

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_LIFECYCLERULES

TYPES TT_LIFECYCLERULES TYPE STANDARD TABLE OF REF TO /AWS1/CL_S3_LIFECYCLERULE WITH DEFAULT KEY
.