Amazonka.CloudHSMV2.Types.Backup

Documentation

data Backup

Contains information about a backup of an AWS CloudHSM cluster. All backup objects contain the BackupId, BackupState, ClusterId, and CreateTimestamp parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp, SourceBackup, SourceCluster, and SourceRegion parameters. A backup that is pending deletion will include the DeleteTimestamp parameter.

See: newBackup smart constructor.

Constructors

Backup'

Fields

• backupState :: Maybe BackupState

  The state of the backup.

• clusterId :: Maybe Text

  The identifier (ID) of the cluster that was backed up.

• copyTimestamp :: Maybe POSIX

  The date and time when the backup was copied from a source backup.

• createTimestamp :: Maybe POSIX

  The date and time when the backup was created.

• deleteTimestamp :: Maybe POSIX

  The date and time when the backup will be permanently deleted.

• neverExpires :: Maybe Bool

  Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.

• sourceBackup :: Maybe Text

  The identifier (ID) of the source backup from which the new backup was copied.

• sourceCluster :: Maybe Text

  The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

• sourceRegion :: Maybe Text

  The AWS Region that contains the source backup from which the new backup was copied.

• tagList :: Maybe [Tag]

  The list of tags for the backup.

• backupId :: Text

  The identifier (ID) of the backup.

Instances

FromJSON Backup

Defined in Amazonka.CloudHSMV2.Types.Backup

Methods

parseJSON :: Value -> Parser Backup

parseJSONList :: Value -> Parser [Backup]

Generic Backup

Defined in Amazonka.CloudHSMV2.Types.Backup

Associated Types

type Rep Backup :: Type -> Type

Methods

from :: Backup -> Rep Backup x

to :: Rep Backup x -> Backup

Read Backup

Defined in Amazonka.CloudHSMV2.Types.Backup

Methods

readsPrec :: Int -> ReadS Backup

readList :: ReadS [Backup]

readPrec :: ReadPrec Backup

readListPrec :: ReadPrec [Backup]

Show Backup

Defined in Amazonka.CloudHSMV2.Types.Backup

Methods

showsPrec :: Int -> Backup -> ShowS

show :: Backup -> String

showList :: [Backup] -> ShowS

NFData Backup

Defined in Amazonka.CloudHSMV2.Types.Backup

Methods

rnf :: Backup -> ()

Eq Backup

Defined in Amazonka.CloudHSMV2.Types.Backup

Methods

(==) :: Backup -> Backup -> Bool

(/=) :: Backup -> Backup -> Bool

Hashable Backup

Defined in Amazonka.CloudHSMV2.Types.Backup

Methods

hashWithSalt :: Int -> Backup -> Int

hash :: Backup -> Int

type Rep Backup

Defined in Amazonka.CloudHSMV2.Types.Backup

type Rep Backup = D1 ('MetaData "Backup" "Amazonka.CloudHSMV2.Types.Backup" "amazonka-cloudhsmv2-2.0-JPONnjzt63Q1wP3HCntyXZ" 'False) (C1 ('MetaCons "Backup'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "backupState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BackupState)) :*: S1 ('MetaSel ('Just "clusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "copyTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "createTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "deleteTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "neverExpires") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "sourceBackup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sourceCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "sourceRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tagList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "backupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newBackup

Arguments

:: Text

$sel:backupId:Backup'

-> Backup

Create a value of Backup 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:backupState:Backup', backup_backupState - The state of the backup.

$sel:clusterId:Backup', backup_clusterId - The identifier (ID) of the cluster that was backed up.

$sel:copyTimestamp:Backup', backup_copyTimestamp - The date and time when the backup was copied from a source backup.

$sel:createTimestamp:Backup', backup_createTimestamp - The date and time when the backup was created.

$sel:deleteTimestamp:Backup', backup_deleteTimestamp - The date and time when the backup will be permanently deleted.

$sel:neverExpires:Backup', backup_neverExpires - Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.

$sel:sourceBackup:Backup', backup_sourceBackup - The identifier (ID) of the source backup from which the new backup was copied.

$sel:sourceCluster:Backup', backup_sourceCluster - The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

$sel:sourceRegion:Backup', backup_sourceRegion - The AWS Region that contains the source backup from which the new backup was copied.

$sel:tagList:Backup', backup_tagList - The list of tags for the backup.

$sel:backupId:Backup', backup_backupId - The identifier (ID) of the backup.

backup_backupState :: Lens' Backup (Maybe BackupState)

The state of the backup.

backup_clusterId :: Lens' Backup (Maybe Text)

The identifier (ID) of the cluster that was backed up.

backup_copyTimestamp :: Lens' Backup (Maybe UTCTime)

The date and time when the backup was copied from a source backup.

backup_createTimestamp :: Lens' Backup (Maybe UTCTime)

The date and time when the backup was created.

backup_deleteTimestamp :: Lens' Backup (Maybe UTCTime)

The date and time when the backup will be permanently deleted.

backup_neverExpires :: Lens' Backup (Maybe Bool)

Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.

backup_sourceBackup :: Lens' Backup (Maybe Text)

The identifier (ID) of the source backup from which the new backup was copied.

backup_sourceCluster :: Lens' Backup (Maybe Text)

The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

backup_sourceRegion :: Lens' Backup (Maybe Text)

The AWS Region that contains the source backup from which the new backup was copied.

backup_tagList :: Lens' Backup (Maybe [Tag])

The list of tags for the backup.

backup_backupId :: Lens' Backup Text

The identifier (ID) of the backup.