Struct aws_sdk_fsx::types::RetentionPeriod

#[non_exhaustive]
pub struct RetentionPeriod {
    pub type: Option<RetentionPeriodType>,
    pub value: Option<i32>,
}

Specifies the retention period of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. Files can't be deleted or modified during the retention period.

For more information, see Working with the retention period in SnapLock.

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.

type: Option<RetentionPeriodType>

Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

value: Option<i32>

Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

• Seconds: 0 - 65,535

• Minutes: 0 - 65,535

• Hours: 0 - 24

• Days: 0 - 365

• Months: 0 - 12

• Years: 0 - 100

Implementations

impl RetentionPeriod

pub fn type(&self) -> Option<&RetentionPeriodType>

Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

pub fn value(&self) -> Option<i32>

Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

• Seconds: 0 - 65,535

• Minutes: 0 - 65,535

• Hours: 0 - 24

• Days: 0 - 365

• Months: 0 - 12

• Years: 0 - 100

impl RetentionPeriod

pub fn builder() -> RetentionPeriodBuilder

Creates a new builder-style object to manufacture RetentionPeriod.

Trait Implementations

impl Clone for RetentionPeriod

fn clone(&self) -> RetentionPeriod

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RetentionPeriod

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

Formats the value using the given formatter.

impl PartialEq for RetentionPeriod

fn eq(&self, other: &RetentionPeriod) -> 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 RetentionPeriod