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 |
Synopsis
- data RecoveryPointByBackupVault = RecoveryPointByBackupVault' {
- backupSizeInBytes :: Maybe Integer
- backupVaultArn :: Maybe Text
- backupVaultName :: Maybe Text
- calculatedLifecycle :: Maybe CalculatedLifecycle
- completionDate :: Maybe POSIX
- compositeMemberIdentifier :: Maybe Text
- createdBy :: Maybe RecoveryPointCreator
- creationDate :: Maybe POSIX
- encryptionKeyArn :: Maybe Text
- iamRoleArn :: Maybe Text
- isEncrypted :: Maybe Bool
- isParent :: Maybe Bool
- lastRestoreTime :: Maybe POSIX
- lifecycle :: Maybe Lifecycle
- parentRecoveryPointArn :: Maybe Text
- recoveryPointArn :: Maybe Text
- resourceArn :: Maybe Text
- resourceType :: Maybe Text
- sourceBackupVaultArn :: Maybe Text
- status :: Maybe RecoveryPointStatus
- statusMessage :: Maybe Text
- newRecoveryPointByBackupVault :: RecoveryPointByBackupVault
- recoveryPointByBackupVault_backupSizeInBytes :: Lens' RecoveryPointByBackupVault (Maybe Integer)
- recoveryPointByBackupVault_backupVaultArn :: Lens' RecoveryPointByBackupVault (Maybe Text)
- recoveryPointByBackupVault_backupVaultName :: Lens' RecoveryPointByBackupVault (Maybe Text)
- recoveryPointByBackupVault_calculatedLifecycle :: Lens' RecoveryPointByBackupVault (Maybe CalculatedLifecycle)
- recoveryPointByBackupVault_completionDate :: Lens' RecoveryPointByBackupVault (Maybe UTCTime)
- recoveryPointByBackupVault_compositeMemberIdentifier :: Lens' RecoveryPointByBackupVault (Maybe Text)
- recoveryPointByBackupVault_createdBy :: Lens' RecoveryPointByBackupVault (Maybe RecoveryPointCreator)
- recoveryPointByBackupVault_creationDate :: Lens' RecoveryPointByBackupVault (Maybe UTCTime)
- recoveryPointByBackupVault_encryptionKeyArn :: Lens' RecoveryPointByBackupVault (Maybe Text)
- recoveryPointByBackupVault_iamRoleArn :: Lens' RecoveryPointByBackupVault (Maybe Text)
- recoveryPointByBackupVault_isEncrypted :: Lens' RecoveryPointByBackupVault (Maybe Bool)
- recoveryPointByBackupVault_isParent :: Lens' RecoveryPointByBackupVault (Maybe Bool)
- recoveryPointByBackupVault_lastRestoreTime :: Lens' RecoveryPointByBackupVault (Maybe UTCTime)
- recoveryPointByBackupVault_lifecycle :: Lens' RecoveryPointByBackupVault (Maybe Lifecycle)
- recoveryPointByBackupVault_parentRecoveryPointArn :: Lens' RecoveryPointByBackupVault (Maybe Text)
- recoveryPointByBackupVault_recoveryPointArn :: Lens' RecoveryPointByBackupVault (Maybe Text)
- recoveryPointByBackupVault_resourceArn :: Lens' RecoveryPointByBackupVault (Maybe Text)
- recoveryPointByBackupVault_resourceType :: Lens' RecoveryPointByBackupVault (Maybe Text)
- recoveryPointByBackupVault_sourceBackupVaultArn :: Lens' RecoveryPointByBackupVault (Maybe Text)
- recoveryPointByBackupVault_status :: Lens' RecoveryPointByBackupVault (Maybe RecoveryPointStatus)
- recoveryPointByBackupVault_statusMessage :: Lens' RecoveryPointByBackupVault (Maybe Text)
Documentation
data RecoveryPointByBackupVault Source #
Contains detailed information about the recovery points stored in a backup vault.
See: newRecoveryPointByBackupVault
smart constructor.
RecoveryPointByBackupVault' | |
|
Instances
newRecoveryPointByBackupVault :: RecoveryPointByBackupVault Source #
Create a value of RecoveryPointByBackupVault
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:backupSizeInBytes:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_backupSizeInBytes
- The size, in bytes, of a backup.
$sel:backupVaultArn:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_backupVaultArn
- An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
$sel:backupVaultName:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_backupVaultName
- The name of a logical container where backups are stored. Backup vaults
are identified by names that are unique to the account used to create
them and the Amazon Web Services Region where they are created. They
consist of lowercase letters, numbers, and hyphens.
$sel:calculatedLifecycle:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_calculatedLifecycle
- A CalculatedLifecycle
object containing DeleteAt
and
MoveToColdStorageAt
timestamps.
$sel:completionDate:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_completionDate
- The date and time a job to restore a recovery point is completed, in
Unix format and Coordinated Universal Time (UTC). The value of
CompletionDate
is accurate to milliseconds. For example, the value
1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:compositeMemberIdentifier:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_compositeMemberIdentifier
- This is the identifier of a resource within a composite group, such as
nested (child) recovery point belonging to a composite (parent) stack.
The ID is transferred from the
logical ID
within a stack.
$sel:createdBy:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_createdBy
- Contains identifying information about the creation of a recovery point,
including the BackupPlanArn
, BackupPlanId
, BackupPlanVersion
, and
BackupRuleId
of the backup plan that is used to create it.
$sel:creationDate:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_creationDate
- The date and time a recovery point is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate
is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:encryptionKeyArn:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_encryptionKeyArn
- The server-side encryption key that is used to protect your backups; for
example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.
$sel:iamRoleArn:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_iamRoleArn
- Specifies the IAM role ARN used to create the target recovery point; for
example, arn:aws:iam::123456789012:role/S3Access
.
$sel:isEncrypted:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_isEncrypted
- A Boolean value that is returned as TRUE
if the specified recovery
point is encrypted, or FALSE
if the recovery point is not encrypted.
$sel:isParent:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_isParent
- This is a boolean value indicating this is a parent (composite) recovery
point.
$sel:lastRestoreTime:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_lastRestoreTime
- The date and time a recovery point was last restored, in Unix format and
Coordinated Universal Time (UTC). The value of LastRestoreTime
is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:lifecycle:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_lifecycle
- The lifecycle defines when a protected resource is transitioned to cold
storage and when it expires. Backup transitions and expires backups
automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
$sel:parentRecoveryPointArn:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_parentRecoveryPointArn
- This is the Amazon Resource Name (ARN) of the parent (composite)
recovery point.
$sel:recoveryPointArn:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_recoveryPointArn
- An Amazon Resource Name (ARN) that uniquely identifies a recovery point;
for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
$sel:resourceArn:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_resourceArn
- An ARN that uniquely identifies a resource. The format of the ARN
depends on the resource type.
$sel:resourceType:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_resourceType
- The type of Amazon Web Services resource saved as a recovery point; for
example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon
Relational Database Service (Amazon RDS) database. For Windows Volume
Shadow Copy Service (VSS) backups, the only supported resource type is
Amazon EC2.
$sel:sourceBackupVaultArn:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_sourceBackupVaultArn
- The backup vault where the recovery point was originally copied from. If
the recovery point is restored to the same account this value will be
null
.
$sel:status:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_status
- A status code specifying the state of the recovery point.
$sel:statusMessage:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_statusMessage
- A message explaining the reason of the recovery point deletion failure.
recoveryPointByBackupVault_backupSizeInBytes :: Lens' RecoveryPointByBackupVault (Maybe Integer) Source #
The size, in bytes, of a backup.
recoveryPointByBackupVault_backupVaultArn :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #
An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
recoveryPointByBackupVault_backupVaultName :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
recoveryPointByBackupVault_calculatedLifecycle :: Lens' RecoveryPointByBackupVault (Maybe CalculatedLifecycle) Source #
A CalculatedLifecycle
object containing DeleteAt
and
MoveToColdStorageAt
timestamps.
recoveryPointByBackupVault_completionDate :: Lens' RecoveryPointByBackupVault (Maybe UTCTime) Source #
The date and time a job to restore a recovery point is completed, in
Unix format and Coordinated Universal Time (UTC). The value of
CompletionDate
is accurate to milliseconds. For example, the value
1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
recoveryPointByBackupVault_compositeMemberIdentifier :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #
This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.
recoveryPointByBackupVault_createdBy :: Lens' RecoveryPointByBackupVault (Maybe RecoveryPointCreator) Source #
Contains identifying information about the creation of a recovery point,
including the BackupPlanArn
, BackupPlanId
, BackupPlanVersion
, and
BackupRuleId
of the backup plan that is used to create it.
recoveryPointByBackupVault_creationDate :: Lens' RecoveryPointByBackupVault (Maybe UTCTime) Source #
The date and time a recovery point is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate
is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
recoveryPointByBackupVault_encryptionKeyArn :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #
The server-side encryption key that is used to protect your backups; for
example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.
recoveryPointByBackupVault_iamRoleArn :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #
Specifies the IAM role ARN used to create the target recovery point; for
example, arn:aws:iam::123456789012:role/S3Access
.
recoveryPointByBackupVault_isEncrypted :: Lens' RecoveryPointByBackupVault (Maybe Bool) Source #
A Boolean value that is returned as TRUE
if the specified recovery
point is encrypted, or FALSE
if the recovery point is not encrypted.
recoveryPointByBackupVault_isParent :: Lens' RecoveryPointByBackupVault (Maybe Bool) Source #
This is a boolean value indicating this is a parent (composite) recovery point.
recoveryPointByBackupVault_lastRestoreTime :: Lens' RecoveryPointByBackupVault (Maybe UTCTime) Source #
The date and time a recovery point was last restored, in Unix format and
Coordinated Universal Time (UTC). The value of LastRestoreTime
is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
recoveryPointByBackupVault_lifecycle :: Lens' RecoveryPointByBackupVault (Maybe Lifecycle) Source #
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
recoveryPointByBackupVault_parentRecoveryPointArn :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #
This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.
recoveryPointByBackupVault_recoveryPointArn :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #
An Amazon Resource Name (ARN) that uniquely identifies a recovery point;
for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
recoveryPointByBackupVault_resourceArn :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
recoveryPointByBackupVault_resourceType :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #
The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
recoveryPointByBackupVault_sourceBackupVaultArn :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #
The backup vault where the recovery point was originally copied from. If
the recovery point is restored to the same account this value will be
null
.
recoveryPointByBackupVault_status :: Lens' RecoveryPointByBackupVault (Maybe RecoveryPointStatus) Source #
A status code specifying the state of the recovery point.
recoveryPointByBackupVault_statusMessage :: Lens' RecoveryPointByBackupVault (Maybe Text) Source #
A message explaining the reason of the recovery point deletion failure.