Skip to content

/AWS1/CL_S3_DEFAULTRETENTION

The container element for optionally specifying the default Object Lock retention settings for new objects placed in the specified bucket.

  • The DefaultRetention settings require both a mode and a period.

  • The DefaultRetention period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_mode TYPE /AWS1/S3_OBJECTLOCKRETMODE /AWS1/S3_OBJECTLOCKRETMODE

The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. Must be used with either Days or Years.

iv_days TYPE /AWS1/S3_DAYS /AWS1/S3_DAYS

The number of days that you want to specify for the default retention period. Must be used with Mode.

iv_years TYPE /AWS1/S3_YEARS /AWS1/S3_YEARS

The number of years that you want to specify for the default retention period. Must be used with Mode.

io_defaulteventhold TYPE REF TO /AWS1/CL_S3_EVENTHOLDDURATION /AWS1/CL_S3_EVENTHOLDDURATION

The default event hold duration to be applied to new objects placed in the specified bucket. When configured, new objects will automatically have an event hold enabled with this duration.


Queryable Attributes

Mode

The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. Must be used with either Days or Years.

Accessible with the following methods

Method Description
GET_MODE() Getter for MODE, with configurable default
ASK_MODE() Getter for MODE w/ exceptions if field has no value
HAS_MODE() Determine if MODE has a value

Days

The number of days that you want to specify for the default retention period. Must be used with Mode.

Accessible with the following methods

Method Description
GET_DAYS() Getter for DAYS, with configurable default
ASK_DAYS() Getter for DAYS w/ exceptions if field has no value
HAS_DAYS() Determine if DAYS has a value

Years

The number of years that you want to specify for the default retention period. Must be used with Mode.

Accessible with the following methods

Method Description
GET_YEARS() Getter for YEARS, with configurable default
ASK_YEARS() Getter for YEARS w/ exceptions if field has no value
HAS_YEARS() Determine if YEARS has a value

DefaultEventHold

The default event hold duration to be applied to new objects placed in the specified bucket. When configured, new objects will automatically have an event hold enabled with this duration.

Accessible with the following methods

Method Description
GET_DEFAULTEVENTHOLD() Getter for DEFAULTEVENTHOLD