Struct LegalHold

#[non_exhaustive]
pub struct LegalHold {
    pub title: Option<String>,
    pub status: Option<LegalHoldStatus>,
    pub description: Option<String>,
    pub legal_hold_id: Option<String>,
    pub legal_hold_arn: Option<String>,
    pub creation_date: Option<DateTime>,
    pub cancellation_date: Option<DateTime>,
}

A legal hold is an administrative tool that helps prevent backups from being deleted while under a hold. While the hold is in place, backups under a hold cannot be deleted and lifecycle policies that would alter the backup status (such as transition to cold storage) are delayed until the legal hold is removed. A backup can have more than one legal hold. Legal holds are applied to one or more backups (also known as recovery points). These backups can be filtered by resource types and by resource IDs.

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.

title: Option<String>

The title of a legal hold.

status: Option<LegalHoldStatus>

The status of the legal hold.

description: Option<String>

The description of a legal hold.

legal_hold_id: Option<String>

The ID of the legal hold.

legal_hold_arn: Option<String>

The Amazon Resource Name (ARN) of the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

creation_date: Option<DateTime>

The time when the legal hold was created.

cancellation_date: Option<DateTime>

The time when the legal hold was cancelled.

Implementations

impl LegalHold

pub fn title(&self) -> Option<&str>

The title of a legal hold.

pub fn status(&self) -> Option<&LegalHoldStatus>

The status of the legal hold.

pub fn description(&self) -> Option<&str>

The description of a legal hold.

pub fn legal_hold_id(&self) -> Option<&str>

The ID of the legal hold.

pub fn legal_hold_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

pub fn creation_date(&self) -> Option<&DateTime>

The time when the legal hold was created.

pub fn cancellation_date(&self) -> Option<&DateTime>

The time when the legal hold was cancelled.

impl LegalHold

pub fn builder() -> LegalHoldBuilder

Creates a new builder-style object to manufacture LegalHold.

Trait Implementations

impl Clone for LegalHold

fn clone(&self) -> LegalHold

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LegalHold

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

Formats the value using the given formatter.

impl PartialEq for LegalHold

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for LegalHold