amazonka-backup-2.0: Amazon Backup SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Backup.Types.LegalHold

Description

 
Synopsis

Documentation

data LegalHold Source #

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.

See: newLegalHold smart constructor.

Constructors

LegalHold' 

Fields

Instances

Instances details
FromJSON LegalHold Source # 
Instance details

Defined in Amazonka.Backup.Types.LegalHold

Methods

parseJSON :: Value -> Parser LegalHold #

parseJSONList :: Value -> Parser [LegalHold] #

Generic LegalHold Source # 
Instance details

Defined in Amazonka.Backup.Types.LegalHold

Associated Types

type Rep LegalHold :: Type -> Type #

Methods

from :: LegalHold -> Rep LegalHold x #

to :: Rep LegalHold x -> LegalHold #

Read LegalHold Source # 
Instance details

Defined in Amazonka.Backup.Types.LegalHold

Methods

readsPrec :: Int -> ReadS LegalHold #

readList :: ReadS [LegalHold] #

readPrec :: ReadPrec LegalHold #

readListPrec :: ReadPrec [LegalHold] #

Show LegalHold Source # 
Instance details

Defined in Amazonka.Backup.Types.LegalHold

Methods

showsPrec :: Int -> LegalHold -> ShowS #

show :: LegalHold -> String #

showList :: [LegalHold] -> ShowS #

NFData LegalHold Source # 
Instance details

Defined in Amazonka.Backup.Types.LegalHold

Methods

rnf :: LegalHold -> () #

Eq LegalHold Source # 
Instance details

Defined in Amazonka.Backup.Types.LegalHold

Methods

(==) :: LegalHold -> LegalHold -> Bool #

(/=) :: LegalHold -> LegalHold -> Bool #

Hashable LegalHold Source # 
Instance details

Defined in Amazonka.Backup.Types.LegalHold

Methods

hashWithSalt :: Int -> LegalHold -> Int #

hash :: LegalHold -> Int #

type Rep LegalHold Source # 
Instance details

Defined in Amazonka.Backup.Types.LegalHold

type Rep LegalHold = D1 ('MetaData "LegalHold" "Amazonka.Backup.Types.LegalHold" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "LegalHold'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cancellationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "legalHoldArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "legalHoldId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LegalHoldStatus)) :*: S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newLegalHold :: LegalHold Source #

Create a value of LegalHold with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cancellationDate:LegalHold', legalHold_cancellationDate - This is the time in number format when legal hold was cancelled.

$sel:creationDate:LegalHold', legalHold_creationDate - This is the time in number format when legal hold was created.

$sel:description:LegalHold', legalHold_description - This is the description of a legal hold.

$sel:legalHoldArn:LegalHold', legalHold_legalHoldArn - This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

$sel:legalHoldId:LegalHold', legalHold_legalHoldId - ID of specific legal hold on one or more recovery points.

$sel:status:LegalHold', legalHold_status - This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.

$sel:title:LegalHold', legalHold_title - This is the title of a legal hold.

legalHold_cancellationDate :: Lens' LegalHold (Maybe UTCTime) Source #

This is the time in number format when legal hold was cancelled.

legalHold_creationDate :: Lens' LegalHold (Maybe UTCTime) Source #

This is the time in number format when legal hold was created.

legalHold_description :: Lens' LegalHold (Maybe Text) Source #

This is the description of a legal hold.

legalHold_legalHoldArn :: Lens' LegalHold (Maybe Text) Source #

This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

legalHold_legalHoldId :: Lens' LegalHold (Maybe Text) Source #

ID of specific legal hold on one or more recovery points.

legalHold_status :: Lens' LegalHold (Maybe LegalHoldStatus) Source #

This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.

legalHold_title :: Lens' LegalHold (Maybe Text) Source #

This is the title of a legal hold.