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 |
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
Synopsis
- data DescribeRecoveryPoint = DescribeRecoveryPoint' {}
- newDescribeRecoveryPoint :: Text -> Text -> DescribeRecoveryPoint
- describeRecoveryPoint_backupVaultName :: Lens' DescribeRecoveryPoint Text
- describeRecoveryPoint_recoveryPointArn :: Lens' DescribeRecoveryPoint Text
- data DescribeRecoveryPointResponse = DescribeRecoveryPointResponse' {
- 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
- storageClass :: Maybe StorageClass
- httpStatus :: Int
- newDescribeRecoveryPointResponse :: Int -> DescribeRecoveryPointResponse
- describeRecoveryPointResponse_backupSizeInBytes :: Lens' DescribeRecoveryPointResponse (Maybe Integer)
- describeRecoveryPointResponse_backupVaultArn :: Lens' DescribeRecoveryPointResponse (Maybe Text)
- describeRecoveryPointResponse_backupVaultName :: Lens' DescribeRecoveryPointResponse (Maybe Text)
- describeRecoveryPointResponse_calculatedLifecycle :: Lens' DescribeRecoveryPointResponse (Maybe CalculatedLifecycle)
- describeRecoveryPointResponse_completionDate :: Lens' DescribeRecoveryPointResponse (Maybe UTCTime)
- describeRecoveryPointResponse_compositeMemberIdentifier :: Lens' DescribeRecoveryPointResponse (Maybe Text)
- describeRecoveryPointResponse_createdBy :: Lens' DescribeRecoveryPointResponse (Maybe RecoveryPointCreator)
- describeRecoveryPointResponse_creationDate :: Lens' DescribeRecoveryPointResponse (Maybe UTCTime)
- describeRecoveryPointResponse_encryptionKeyArn :: Lens' DescribeRecoveryPointResponse (Maybe Text)
- describeRecoveryPointResponse_iamRoleArn :: Lens' DescribeRecoveryPointResponse (Maybe Text)
- describeRecoveryPointResponse_isEncrypted :: Lens' DescribeRecoveryPointResponse (Maybe Bool)
- describeRecoveryPointResponse_isParent :: Lens' DescribeRecoveryPointResponse (Maybe Bool)
- describeRecoveryPointResponse_lastRestoreTime :: Lens' DescribeRecoveryPointResponse (Maybe UTCTime)
- describeRecoveryPointResponse_lifecycle :: Lens' DescribeRecoveryPointResponse (Maybe Lifecycle)
- describeRecoveryPointResponse_parentRecoveryPointArn :: Lens' DescribeRecoveryPointResponse (Maybe Text)
- describeRecoveryPointResponse_recoveryPointArn :: Lens' DescribeRecoveryPointResponse (Maybe Text)
- describeRecoveryPointResponse_resourceArn :: Lens' DescribeRecoveryPointResponse (Maybe Text)
- describeRecoveryPointResponse_resourceType :: Lens' DescribeRecoveryPointResponse (Maybe Text)
- describeRecoveryPointResponse_sourceBackupVaultArn :: Lens' DescribeRecoveryPointResponse (Maybe Text)
- describeRecoveryPointResponse_status :: Lens' DescribeRecoveryPointResponse (Maybe RecoveryPointStatus)
- describeRecoveryPointResponse_statusMessage :: Lens' DescribeRecoveryPointResponse (Maybe Text)
- describeRecoveryPointResponse_storageClass :: Lens' DescribeRecoveryPointResponse (Maybe StorageClass)
- describeRecoveryPointResponse_httpStatus :: Lens' DescribeRecoveryPointResponse Int
Creating a Request
data DescribeRecoveryPoint Source #
See: newDescribeRecoveryPoint
smart constructor.
DescribeRecoveryPoint' | |
|
Instances
newDescribeRecoveryPoint Source #
Create a value of DescribeRecoveryPoint
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:
DescribeRecoveryPoint
, describeRecoveryPoint_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.
DescribeRecoveryPoint
, describeRecoveryPoint_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
.
Request Lenses
describeRecoveryPoint_backupVaultName :: Lens' DescribeRecoveryPoint 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.
describeRecoveryPoint_recoveryPointArn :: Lens' DescribeRecoveryPoint 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
.
Destructuring the Response
data DescribeRecoveryPointResponse Source #
See: newDescribeRecoveryPointResponse
smart constructor.
DescribeRecoveryPointResponse' | |
|
Instances
newDescribeRecoveryPointResponse Source #
Create a value of DescribeRecoveryPointResponse
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:
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_backupSizeInBytes
- The size, in bytes, of a backup.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_backupVaultArn
- An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
DescribeRecoveryPoint
, describeRecoveryPointResponse_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 Region where they are created. They consist of lowercase
letters, numbers, and hyphens.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_calculatedLifecycle
- A CalculatedLifecycle
object containing DeleteAt
and
MoveToColdStorageAt
timestamps.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_completionDate
- The date and time that a job to create 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.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_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.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_createdBy
- Contains identifying information about the creation of a recovery point,
including the BackupPlanArn
, BackupPlanId
, BackupPlanVersion
, and
BackupRuleId
of the backup plan used to create it.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_creationDate
- The date and time that 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.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_encryptionKeyArn
- The server-side encryption key used to protect your backups; for
example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_iamRoleArn
- Specifies the IAM role ARN used to create the target recovery point; for
example, arn:aws:iam::123456789012:role/S3Access
.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_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.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_isParent
- This returns the boolean value that a recovery point is a parent
(composite) job.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_lastRestoreTime
- The date and time that 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.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_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 that are 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.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_parentRecoveryPointArn
- This is an ARN that uniquely identifies a parent (composite) recovery
point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
DescribeRecoveryPoint
, describeRecoveryPointResponse_recoveryPointArn
- An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_resourceArn
- An ARN that uniquely identifies a saved resource. The format of the ARN
depends on the resource type.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_resourceType
- The type of Amazon Web Services resource to save as a recovery point;
for example, an Amazon Elastic Block Store (Amazon EBS) volume or an
Amazon Relational Database Service (Amazon RDS) database.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_sourceBackupVaultArn
- An Amazon Resource Name (ARN) that uniquely identifies the source vault
where the resource was originally backed up in; for example,
arn:aws:backup:us-east-1:123456789012:vault:BackupVault
. If the
recovery is restored to the same Amazon Web Services account or Region,
this value will be null
.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_status
- A status code specifying the state of the recovery point.
PARTIAL
status indicates Backup could not create the recovery point
before the backup window closed. To increase your backup plan window
using the API, see
UpdateBackupPlan.
You can also increase your backup plan window using the Console by
choosing and editing your backup plan.
EXPIRED
status indicates that the recovery point has exceeded its
retention period, but Backup lacks permission or is otherwise unable to
delete it. To manually delete these recovery points, see
Step 3: Delete the recovery points
in the Clean up resources section of Getting started.
STOPPED
status occurs on a continuous backup where a user has taken
some action that causes the continuous backup to be disabled. This can
be caused by the removal of permissions, turning off versioning, turning
off events being sent to EventBridge, or disabling the EventBridge rules
that are put in place by Backup.
To resolve STOPPED
status, ensure that all requested permissions are
in place and that versioning is enabled on the S3 bucket. Once these
conditions are met, the next instance of a backup rule running will
result in a new continuous recovery point being created. The recovery
points with STOPPED status do not need to be deleted.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_statusMessage
- A status message explaining the reason for the recovery point deletion
failure.
$sel:storageClass:DescribeRecoveryPointResponse'
, describeRecoveryPointResponse_storageClass
- Specifies the storage class of the recovery point. Valid values are
WARM
or COLD
.
$sel:httpStatus:DescribeRecoveryPointResponse'
, describeRecoveryPointResponse_httpStatus
- The response's http status code.
Response Lenses
describeRecoveryPointResponse_backupSizeInBytes :: Lens' DescribeRecoveryPointResponse (Maybe Integer) Source #
The size, in bytes, of a backup.
describeRecoveryPointResponse_backupVaultArn :: Lens' DescribeRecoveryPointResponse (Maybe Text) Source #
An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
describeRecoveryPointResponse_backupVaultName :: Lens' DescribeRecoveryPointResponse (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 Region where they are created. They consist of lowercase letters, numbers, and hyphens.
describeRecoveryPointResponse_calculatedLifecycle :: Lens' DescribeRecoveryPointResponse (Maybe CalculatedLifecycle) Source #
A CalculatedLifecycle
object containing DeleteAt
and
MoveToColdStorageAt
timestamps.
describeRecoveryPointResponse_completionDate :: Lens' DescribeRecoveryPointResponse (Maybe UTCTime) Source #
The date and time that a job to create 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.
describeRecoveryPointResponse_compositeMemberIdentifier :: Lens' DescribeRecoveryPointResponse (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.
describeRecoveryPointResponse_createdBy :: Lens' DescribeRecoveryPointResponse (Maybe RecoveryPointCreator) Source #
Contains identifying information about the creation of a recovery point,
including the BackupPlanArn
, BackupPlanId
, BackupPlanVersion
, and
BackupRuleId
of the backup plan used to create it.
describeRecoveryPointResponse_creationDate :: Lens' DescribeRecoveryPointResponse (Maybe UTCTime) Source #
The date and time that 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.
describeRecoveryPointResponse_encryptionKeyArn :: Lens' DescribeRecoveryPointResponse (Maybe Text) Source #
The server-side encryption key used to protect your backups; for
example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.
describeRecoveryPointResponse_iamRoleArn :: Lens' DescribeRecoveryPointResponse (Maybe Text) Source #
Specifies the IAM role ARN used to create the target recovery point; for
example, arn:aws:iam::123456789012:role/S3Access
.
describeRecoveryPointResponse_isEncrypted :: Lens' DescribeRecoveryPointResponse (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.
describeRecoveryPointResponse_isParent :: Lens' DescribeRecoveryPointResponse (Maybe Bool) Source #
This returns the boolean value that a recovery point is a parent (composite) job.
describeRecoveryPointResponse_lastRestoreTime :: Lens' DescribeRecoveryPointResponse (Maybe UTCTime) Source #
The date and time that 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.
describeRecoveryPointResponse_lifecycle :: Lens' DescribeRecoveryPointResponse (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 that are 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.
describeRecoveryPointResponse_parentRecoveryPointArn :: Lens' DescribeRecoveryPointResponse (Maybe Text) Source #
This is an ARN that uniquely identifies a parent (composite) recovery
point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
describeRecoveryPointResponse_recoveryPointArn :: Lens' DescribeRecoveryPointResponse (Maybe Text) Source #
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
describeRecoveryPointResponse_resourceArn :: Lens' DescribeRecoveryPointResponse (Maybe Text) Source #
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
describeRecoveryPointResponse_resourceType :: Lens' DescribeRecoveryPointResponse (Maybe Text) Source #
The type of Amazon Web Services resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
describeRecoveryPointResponse_sourceBackupVaultArn :: Lens' DescribeRecoveryPointResponse (Maybe Text) Source #
An Amazon Resource Name (ARN) that uniquely identifies the source vault
where the resource was originally backed up in; for example,
arn:aws:backup:us-east-1:123456789012:vault:BackupVault
. If the
recovery is restored to the same Amazon Web Services account or Region,
this value will be null
.
describeRecoveryPointResponse_status :: Lens' DescribeRecoveryPointResponse (Maybe RecoveryPointStatus) Source #
A status code specifying the state of the recovery point.
PARTIAL
status indicates Backup could not create the recovery point
before the backup window closed. To increase your backup plan window
using the API, see
UpdateBackupPlan.
You can also increase your backup plan window using the Console by
choosing and editing your backup plan.
EXPIRED
status indicates that the recovery point has exceeded its
retention period, but Backup lacks permission or is otherwise unable to
delete it. To manually delete these recovery points, see
Step 3: Delete the recovery points
in the Clean up resources section of Getting started.
STOPPED
status occurs on a continuous backup where a user has taken
some action that causes the continuous backup to be disabled. This can
be caused by the removal of permissions, turning off versioning, turning
off events being sent to EventBridge, or disabling the EventBridge rules
that are put in place by Backup.
To resolve STOPPED
status, ensure that all requested permissions are
in place and that versioning is enabled on the S3 bucket. Once these
conditions are met, the next instance of a backup rule running will
result in a new continuous recovery point being created. The recovery
points with STOPPED status do not need to be deleted.
describeRecoveryPointResponse_statusMessage :: Lens' DescribeRecoveryPointResponse (Maybe Text) Source #
A status message explaining the reason for the recovery point deletion failure.
describeRecoveryPointResponse_storageClass :: Lens' DescribeRecoveryPointResponse (Maybe StorageClass) Source #
Specifies the storage class of the recovery point. Valid values are
WARM
or COLD
.
describeRecoveryPointResponse_httpStatus :: Lens' DescribeRecoveryPointResponse Int Source #
The response's http status code.