Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.FSx.Types.Backup

Description

Synopsis

data Backup = Backup' {
- directoryInformation :: Maybe ActiveDirectoryBackupAttributes
- failureDetails :: Maybe BackupFailureDetails
- kmsKeyId :: Maybe Text
- ownerId :: Maybe Text
- progressPercent :: Maybe Natural
- resourceARN :: Maybe Text
- resourceType :: Maybe ResourceType
- sourceBackupId :: Maybe Text
- sourceBackupRegion :: Maybe Text
- tags :: Maybe (NonEmpty Tag)
- volume :: Maybe Volume
- backupId :: Text
- lifecycle :: BackupLifecycle
- type' :: BackupType
- creationTime :: POSIX
- fileSystem :: FileSystem
}
newBackup :: Text -> BackupLifecycle -> BackupType -> UTCTime -> FileSystem -> Backup
backup_directoryInformation :: Lens' Backup (Maybe ActiveDirectoryBackupAttributes)
backup_failureDetails :: Lens' Backup (Maybe BackupFailureDetails)
backup_kmsKeyId :: Lens' Backup (Maybe Text)
backup_ownerId :: Lens' Backup (Maybe Text)
backup_progressPercent :: Lens' Backup (Maybe Natural)
backup_resourceARN :: Lens' Backup (Maybe Text)
backup_resourceType :: Lens' Backup (Maybe ResourceType)
backup_sourceBackupId :: Lens' Backup (Maybe Text)
backup_sourceBackupRegion :: Lens' Backup (Maybe Text)
backup_tags :: Lens' Backup (Maybe (NonEmpty Tag))
backup_volume :: Lens' Backup (Maybe Volume)
backup_backupId :: Lens' Backup Text
backup_lifecycle :: Lens' Backup BackupLifecycle
backup_type :: Lens' Backup BackupType
backup_creationTime :: Lens' Backup UTCTime
backup_fileSystem :: Lens' Backup FileSystem

Documentation

data Backup Source #

A backup of an Amazon FSx for Windows File Server, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system.

See: newBackup smart constructor.

Constructors

Backup'

Fields

directoryInformation :: Maybe ActiveDirectoryBackupAttributes
The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.
failureDetails :: Maybe BackupFailureDetails
Details explaining any failures that occurred when creating a backup.
kmsKeyId :: Maybe Text
The ID of the Key Management Service (KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
ownerId :: Maybe Text
progressPercent :: Maybe Natural
resourceARN :: Maybe Text
The Amazon Resource Name (ARN) for the backup resource.
resourceType :: Maybe ResourceType
Specifies the resource type that's backed up.
sourceBackupId :: Maybe Text
sourceBackupRegion :: Maybe Text
The source Region of the backup. Specifies the Region from where this backup is copied.
tags :: Maybe (NonEmpty Tag)
The tags associated with a particular file system.
volume :: Maybe Volume
backupId :: Text
The ID of the backup.
lifecycle :: BackupLifecycle
The lifecycle status of the backup.
- AVAILABLE - The backup is fully available.
- PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup.
- CREATING - Amazon FSx is creating the backup.
- TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to Amazon S3.
- COPYING - Amazon FSx is copying the backup.
- DELETED - Amazon FSx deleted the backup and it's no longer available.
- FAILED - Amazon FSx couldn't finish the backup.
type' :: BackupType
The type of the file-system backup.
creationTime :: POSIX
The time when a particular backup was created.
fileSystem :: FileSystem
The metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.

Instances

Instances details

FromJSON Backup Source #
Instance details Defined in Amazonka.FSx.Types.Backup Methods parseJSON :: Value -> Parser Backup # parseJSONList :: Value -> Parser [Backup] #
Generic Backup Source #
Instance details Defined in Amazonka.FSx.Types.Backup Associated Types type Rep Backup :: Type -> Type # Methods from :: Backup -> Rep Backup x # to :: Rep Backup x -> Backup #
Read Backup Source #
Instance details Defined in Amazonka.FSx.Types.Backup Methods readsPrec :: Int -> ReadS Backup # readList :: ReadS [Backup] # readPrec :: ReadPrec Backup # readListPrec :: ReadPrec [Backup] #
Show Backup Source #
Instance details Defined in Amazonka.FSx.Types.Backup Methods showsPrec :: Int -> Backup -> ShowS # show :: Backup -> String # showList :: [Backup] -> ShowS #
NFData Backup Source #
Instance details Defined in Amazonka.FSx.Types.Backup Methods rnf :: Backup -> () #
Eq Backup Source #
Instance details Defined in Amazonka.FSx.Types.Backup Methods (==) :: Backup -> Backup -> Bool # (/=) :: Backup -> Backup -> Bool #
Hashable Backup Source #
Instance details Defined in Amazonka.FSx.Types.Backup Methods hashWithSalt :: Int -> Backup -> Int # hash :: Backup -> Int #
type Rep Backup Source #
Instance details Defined in Amazonka.FSx.Types.Backup type Rep Backup = D1 ('MetaData "Backup" "Amazonka.FSx.Types.Backup" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "Backup'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "directoryInformation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActiveDirectoryBackupAttributes)) :: S1 ('MetaSel ('Just "failureDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BackupFailureDetails))) :: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "ownerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "progressPercent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "resourceARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceType)) :: S1 ('MetaSel ('Just "sourceBackupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "sourceBackupRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag)))) :: (S1 ('MetaSel ('Just "volume") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Volume)) :: S1 ('MetaSel ('Just "backupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "lifecycle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BackupLifecycle) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BackupType)) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "fileSystem") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FileSystem))))))

newBackup Source #

Arguments

:: Text	`$sel:backupId:Backup'`
-> BackupLifecycle	`Backup`
-> BackupType	`$sel:type':Backup'`
-> UTCTime	`Backup`
-> FileSystem	`$sel:fileSystem: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:directoryInformation:Backup', backup_directoryInformation - The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.

Backup, backup_failureDetails - Details explaining any failures that occurred when creating a backup.

Backup, backup_kmsKeyId - The ID of the Key Management Service (KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.

Backup, backup_ownerId - Undocumented member.

$sel:progressPercent:Backup', backup_progressPercent - Undocumented member.

Backup, backup_resourceARN - The Amazon Resource Name (ARN) for the backup resource.

$sel:resourceType:Backup', backup_resourceType - Specifies the resource type that's backed up.

$sel:sourceBackupId:Backup', backup_sourceBackupId - Undocumented member.

$sel:sourceBackupRegion:Backup', backup_sourceBackupRegion - The source Region of the backup. Specifies the Region from where this backup is copied.

Backup, backup_tags - The tags associated with a particular file system.

$sel:volume:Backup', backup_volume - Undocumented member.

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

Backup, backup_lifecycle - The lifecycle status of the backup.

AVAILABLE - The backup is fully available.
PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup.
CREATING - Amazon FSx is creating the backup.
TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to Amazon S3.
COPYING - Amazon FSx is copying the backup.
DELETED - Amazon FSx deleted the backup and it's no longer available.
FAILED - Amazon FSx couldn't finish the backup.

$sel:type':Backup', backup_type - The type of the file-system backup.

Backup, backup_creationTime - The time when a particular backup was created.

$sel:fileSystem:Backup', backup_fileSystem - The metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.

backup_directoryInformation :: Lens' Backup (Maybe ActiveDirectoryBackupAttributes) Source #

The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.

backup_failureDetails :: Lens' Backup (Maybe BackupFailureDetails) Source #

Details explaining any failures that occurred when creating a backup.

backup_kmsKeyId :: Lens' Backup (Maybe Text) Source #

The ID of the Key Management Service (KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.

backup_ownerId :: Lens' Backup (Maybe Text) Source #

Undocumented member.

backup_progressPercent :: Lens' Backup (Maybe Natural) Source #

Undocumented member.

backup_resourceARN :: Lens' Backup (Maybe Text) Source #

The Amazon Resource Name (ARN) for the backup resource.

backup_resourceType :: Lens' Backup (Maybe ResourceType) Source #

Specifies the resource type that's backed up.

backup_sourceBackupId :: Lens' Backup (Maybe Text) Source #

Undocumented member.

backup_sourceBackupRegion :: Lens' Backup (Maybe Text) Source #

The source Region of the backup. Specifies the Region from where this backup is copied.

backup_tags :: Lens' Backup (Maybe (NonEmpty Tag)) Source #

The tags associated with a particular file system.

backup_volume :: Lens' Backup (Maybe Volume) Source #

Undocumented member.

backup_backupId :: Lens' Backup Text Source #

The ID of the backup.

backup_lifecycle :: Lens' Backup BackupLifecycle Source #

The lifecycle status of the backup.

AVAILABLE - The backup is fully available.
PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup.
CREATING - Amazon FSx is creating the backup.
TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to Amazon S3.
COPYING - Amazon FSx is copying the backup.
DELETED - Amazon FSx deleted the backup and it's no longer available.
FAILED - Amazon FSx couldn't finish the backup.

backup_type :: Lens' Backup BackupType Source #

The type of the file-system backup.

backup_creationTime :: Lens' Backup UTCTime Source #

The time when a particular backup was created.

backup_fileSystem :: Lens' Backup FileSystem Source #

The metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.