s3/aws.sdk.kotlin.services.s3.model/DefaultRetention

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.

Types

Builder

class Builder

Companion

object Companion

Properties

days

val days: Int?

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

defaultEventHold

val defaultEventHold: 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.

mode

val mode: ObjectLockRetentionMode?

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.

years

val years: Int?

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

Functions

copy

inline fun copy(block: DefaultRetention.Builder.() -> Unit = {}): DefaultRetention

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String