Skip to content

DefaultRetention

Source code in docs_src/capo_s3/types/default_retention.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class DefaultRetention(TypedDict, closed=True):
    mode: NotRequired[
        "capo_s3.types.object_lock_retention_mode.ObjectLockRetentionMode"
    ]
    """<p>The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. Must be used with either <code>Days</code> or <code>Years</code>.</p>"""
    days: NotRequired["capo_s3.types.days.Days"]
    """<p>The number of days that you want to specify for the default retention period. Must be used with <code>Mode</code>.</p>"""
    years: NotRequired["capo_s3.types.years.Years"]
    """<p>The number of years that you want to specify for the default retention period. Must be used with <code>Mode</code>.</p>"""
    default_event_hold: NotRequired[
        "capo_s3.types.event_hold_duration.EventHoldDuration"
    ]
    """<p>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.</p>"""

days instance-attribute 

days: NotRequired[Days]

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

default_event_hold instance-attribute 

default_event_hold: NotRequired[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 instance-attribute 

mode: NotRequired[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 instance-attribute 

years: NotRequired[Years]

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