s3control/aws.sdk.kotlin.services.s3control.model/S3Retention

S3Retention

Contains the S3 Object Lock retention mode to be applied to all objects in the S3 Batch Operations job. If you don't provide Mode and RetainUntilDate data types in your operation, you will remove the retention from your objects. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

Types

Builder

class Builder

Companion

object Companion

Properties

eventHold

val eventHold: S3ObjectLockRetentionEventHold?

The event hold status to be applied to all objects in the Batch Operations job. Set to ON to enable an event hold or OFF to disable it.

eventHoldDuration

val eventHoldDuration: S3ObjectLockRetentionEventHoldDuration?

The event hold duration to be applied to all objects in the Batch Operations job. The duration specifies how long the object remains protected after the event hold is released.

mode

val mode: S3ObjectLockRetentionMode?

The Object Lock retention mode to be applied to all objects in the Batch Operations job.

retainUntilDate

val retainUntilDate: Instant?

The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

Functions

copy

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

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String