Skip to content

S3  >  Structures  >  DefaultRetention

DefaultRetention

Structure Class

DefaultRetention dataclass

Bases: _SerdeShape

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

Note
  • 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.

Attributes

days class-attribute instance-attribute
days: int | None = ...

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

default_event_hold class-attribute instance-attribute
default_event_hold: EventHoldDuration | None = ...

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 class-attribute instance-attribute
mode: str | None = ...

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 class-attribute instance-attribute
years: int | None = ...

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