Struct aws_sdk_s3::types::DefaultRetention

#[non_exhaustive]
pub struct DefaultRetention {
    pub mode: Option<ObjectLockRetentionMode>,
    pub days: i32,
    pub years: i32,
}

The container element for 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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

mode: Option<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.

days: i32

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

years: i32

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

Implementations

impl DefaultRetention

pub fn mode(&self) -> Option<&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.

pub fn days(&self) -> i32

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

pub fn years(&self) -> i32

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

impl DefaultRetention

pub fn builder() -> DefaultRetentionBuilder

Creates a new builder-style object to manufacture DefaultRetention.

Trait Implementations

impl Clone for DefaultRetention

fn clone(&self) -> DefaultRetention

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DefaultRetention

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DefaultRetention

fn eq(&self, other: &DefaultRetention) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DefaultRetention