/AWS1/CL_BUPDESCRRECPOINTOUT¶
DescribeRecoveryPointOutput
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_recoverypointarn TYPE /AWS1/BUPARN /AWS1/BUPARN¶
An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
iv_backupvaultname TYPE /AWS1/BUPBACKUPVAULTNAME /AWS1/BUPBACKUPVAULTNAME¶
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.
iv_backupvaultarn TYPE /AWS1/BUPARN /AWS1/BUPARN¶
An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
iv_sourcebackupvaultarn TYPE /AWS1/BUPARN /AWS1/BUPARN¶
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:backup-vault:aBackupVault. If the recovery is restored to the same Amazon Web Services account or Region, this value will benull.
iv_resourcearn TYPE /AWS1/BUPARN /AWS1/BUPARN¶
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
iv_resourcetype TYPE /AWS1/BUPRESOURCETYPE /AWS1/BUPRESOURCETYPE¶
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.
io_createdby TYPE REF TO /AWS1/CL_BUPRECPOINTCREATOR /AWS1/CL_BUPRECPOINTCREATOR¶
Contains identifying information about the creation of a recovery point, including the
BackupPlanArn,BackupPlanId,BackupPlanVersion, andBackupRuleIdof the backup plan used to create it.
iv_iamrolearn TYPE /AWS1/BUPIAMROLEARN /AWS1/BUPIAMROLEARN¶
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access.
iv_status TYPE /AWS1/BUPRECOVERYPOINTSTATUS /AWS1/BUPRECOVERYPOINTSTATUS¶
A status code specifying the state of the recovery point. For more information, see Recovery point status in the Backup Developer Guide.
CREATINGstatus indicates that an Backup job has been initiated for a resource. The backup process has started and is actively processing a backup job for the associated recovery point.
AVAILABLEstatus indicates that the backup was successfully created for the recovery point. The backup process has completed without any issues, and the recovery point is now ready for use.
PARTIALstatus indicates a composite recovery point has one or more nested recovery points that were not in the backup.
EXPIREDstatus 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.
STOPPEDstatus 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. For recovery points of Amazon S3, Amazon RDS, and Amazon Aurora resources, this status occurs when the retention period of a continuous backup rule is changed.To resolve
STOPPEDstatus, 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.For SAP HANA on Amazon EC2
STOPPEDstatus occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details.
iv_statusmessage TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING¶
A status message explaining the status of the recovery point.
iv_creationdate TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP¶
The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDateis accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
iv_initiationdate TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP¶
The date and time when the backup job that created this recovery point was initiated, in Unix format and Coordinated Universal Time (UTC).
iv_completiondate TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP¶
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
CompletionDateis accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
iv_backupsizeinbytes TYPE /AWS1/BUPLONG /AWS1/BUPLONG¶
The size, in bytes, of a backup.
io_calculatedlifecycle TYPE REF TO /AWS1/CL_BUPCALCULATEDLC /AWS1/CL_BUPCALCULATEDLC¶
A
CalculatedLifecycleobject containingDeleteAtandMoveToColdStorageAttimestamps.
io_lifecycle TYPE REF TO /AWS1/CL_BUPLIFECYCLE /AWS1/CL_BUPLIFECYCLE¶
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 can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.
iv_encryptionkeyarn TYPE /AWS1/BUPARN /AWS1/BUPARN¶
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.
iv_isencrypted TYPE /AWS1/BUPBOOLEAN2 /AWS1/BUPBOOLEAN2¶
A Boolean value that is returned as
TRUEif the specified recovery point is encrypted, orFALSEif the recovery point is not encrypted.
iv_storageclass TYPE /AWS1/BUPSTORAGECLASS /AWS1/BUPSTORAGECLASS¶
Specifies the storage class of the recovery point. Valid values are
WARMorCOLD.
iv_lastrestoretime TYPE /AWS1/BUPTIMESTAMP /AWS1/BUPTIMESTAMP¶
The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of
LastRestoreTimeis accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
iv_parentrecoverypointarn TYPE /AWS1/BUPARN /AWS1/BUPARN¶
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.
iv_compositememberidentifier TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING¶
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.
iv_isparent TYPE /AWS1/BUPBOOLEAN2 /AWS1/BUPBOOLEAN2¶
This returns the boolean value that a recovery point is a parent (composite) job.
iv_resourcename TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING¶
The name of the resource that belongs to the specified backup.
iv_vaulttype TYPE /AWS1/BUPVAULTTYPE /AWS1/BUPVAULTTYPE¶
The type of vault in which the described recovery point is stored.
iv_indexstatus TYPE /AWS1/BUPINDEXSTATUS /AWS1/BUPINDEXSTATUS¶
This is the current status for the backup index associated with the specified recovery point.
Statuses are:
PENDING|ACTIVE|FAILED|DELETINGA recovery point with an index that has the status of
ACTIVEcan be included in a search.
iv_indexstatusmessage TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING¶
A string in the form of a detailed message explaining the status of a backup index associated with the recovery point.
Queryable Attributes¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RECOVERYPOINTARN() |
Getter for RECOVERYPOINTARN, with configurable default |
ASK_RECOVERYPOINTARN() |
Getter for RECOVERYPOINTARN w/ exceptions if field has no va |
HAS_RECOVERYPOINTARN() |
Determine if RECOVERYPOINTARN has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BACKUPVAULTNAME() |
Getter for BACKUPVAULTNAME, with configurable default |
ASK_BACKUPVAULTNAME() |
Getter for BACKUPVAULTNAME w/ exceptions if field has no val |
HAS_BACKUPVAULTNAME() |
Determine if BACKUPVAULTNAME has a value |
BackupVaultArn¶
An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BACKUPVAULTARN() |
Getter for BACKUPVAULTARN, with configurable default |
ASK_BACKUPVAULTARN() |
Getter for BACKUPVAULTARN w/ exceptions if field has no valu |
HAS_BACKUPVAULTARN() |
Determine if BACKUPVAULTARN has a value |
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:backup-vault:aBackupVault. If the recovery is restored to the same Amazon Web Services account or Region, this value will benull.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SOURCEBACKUPVAULTARN() |
Getter for SOURCEBACKUPVAULTARN, with configurable default |
ASK_SOURCEBACKUPVAULTARN() |
Getter for SOURCEBACKUPVAULTARN w/ exceptions if field has n |
HAS_SOURCEBACKUPVAULTARN() |
Determine if SOURCEBACKUPVAULTARN has a value |
ResourceArn¶
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCEARN() |
Getter for RESOURCEARN, with configurable default |
ASK_RESOURCEARN() |
Getter for RESOURCEARN w/ exceptions if field has no value |
HAS_RESOURCEARN() |
Determine if RESOURCEARN has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCETYPE() |
Getter for RESOURCETYPE, with configurable default |
ASK_RESOURCETYPE() |
Getter for RESOURCETYPE w/ exceptions if field has no value |
HAS_RESOURCETYPE() |
Determine if RESOURCETYPE has a value |
CreatedBy¶
Contains identifying information about the creation of a recovery point, including the
BackupPlanArn,BackupPlanId,BackupPlanVersion, andBackupRuleIdof the backup plan used to create it.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDBY() |
Getter for CREATEDBY |
IamRoleArn¶
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IAMROLEARN() |
Getter for IAMROLEARN, with configurable default |
ASK_IAMROLEARN() |
Getter for IAMROLEARN w/ exceptions if field has no value |
HAS_IAMROLEARN() |
Determine if IAMROLEARN has a value |
Status¶
A status code specifying the state of the recovery point. For more information, see Recovery point status in the Backup Developer Guide.
CREATINGstatus indicates that an Backup job has been initiated for a resource. The backup process has started and is actively processing a backup job for the associated recovery point.
AVAILABLEstatus indicates that the backup was successfully created for the recovery point. The backup process has completed without any issues, and the recovery point is now ready for use.
PARTIALstatus indicates a composite recovery point has one or more nested recovery points that were not in the backup.
EXPIREDstatus 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.
STOPPEDstatus 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. For recovery points of Amazon S3, Amazon RDS, and Amazon Aurora resources, this status occurs when the retention period of a continuous backup rule is changed.To resolve
STOPPEDstatus, 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.For SAP HANA on Amazon EC2
STOPPEDstatus occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
StatusMessage¶
A status message explaining the status of the recovery point.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUSMESSAGE() |
Getter for STATUSMESSAGE, with configurable default |
ASK_STATUSMESSAGE() |
Getter for STATUSMESSAGE w/ exceptions if field has no value |
HAS_STATUSMESSAGE() |
Determine if STATUSMESSAGE has a value |
CreationDate¶
The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of
CreationDateis accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONDATE() |
Getter for CREATIONDATE, with configurable default |
ASK_CREATIONDATE() |
Getter for CREATIONDATE w/ exceptions if field has no value |
HAS_CREATIONDATE() |
Determine if CREATIONDATE has a value |
InitiationDate¶
The date and time when the backup job that created this recovery point was initiated, in Unix format and Coordinated Universal Time (UTC).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INITIATIONDATE() |
Getter for INITIATIONDATE, with configurable default |
ASK_INITIATIONDATE() |
Getter for INITIATIONDATE w/ exceptions if field has no valu |
HAS_INITIATIONDATE() |
Determine if INITIATIONDATE has a value |
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
CompletionDateis accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COMPLETIONDATE() |
Getter for COMPLETIONDATE, with configurable default |
ASK_COMPLETIONDATE() |
Getter for COMPLETIONDATE w/ exceptions if field has no valu |
HAS_COMPLETIONDATE() |
Determine if COMPLETIONDATE has a value |
BackupSizeInBytes¶
The size, in bytes, of a backup.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BACKUPSIZEINBYTES() |
Getter for BACKUPSIZEINBYTES, with configurable default |
ASK_BACKUPSIZEINBYTES() |
Getter for BACKUPSIZEINBYTES w/ exceptions if field has no v |
HAS_BACKUPSIZEINBYTES() |
Determine if BACKUPSIZEINBYTES has a value |
CalculatedLifecycle¶
A
CalculatedLifecycleobject containingDeleteAtandMoveToColdStorageAttimestamps.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CALCULATEDLIFECYCLE() |
Getter for CALCULATEDLIFECYCLE |
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 can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LIFECYCLE() |
Getter for LIFECYCLE |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENCRYPTIONKEYARN() |
Getter for ENCRYPTIONKEYARN, with configurable default |
ASK_ENCRYPTIONKEYARN() |
Getter for ENCRYPTIONKEYARN w/ exceptions if field has no va |
HAS_ENCRYPTIONKEYARN() |
Determine if ENCRYPTIONKEYARN has a value |
IsEncrypted¶
A Boolean value that is returned as
TRUEif the specified recovery point is encrypted, orFALSEif the recovery point is not encrypted.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ISENCRYPTED() |
Getter for ISENCRYPTED |
StorageClass¶
Specifies the storage class of the recovery point. Valid values are
WARMorCOLD.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STORAGECLASS() |
Getter for STORAGECLASS, with configurable default |
ASK_STORAGECLASS() |
Getter for STORAGECLASS w/ exceptions if field has no value |
HAS_STORAGECLASS() |
Determine if STORAGECLASS has a value |
LastRestoreTime¶
The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of
LastRestoreTimeis accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTRESTORETIME() |
Getter for LASTRESTORETIME, with configurable default |
ASK_LASTRESTORETIME() |
Getter for LASTRESTORETIME w/ exceptions if field has no val |
HAS_LASTRESTORETIME() |
Determine if LASTRESTORETIME has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PARENTRECOVERYPOINTARN() |
Getter for PARENTRECOVERYPOINTARN, with configurable default |
ASK_PARENTRECOVERYPOINTARN() |
Getter for PARENTRECOVERYPOINTARN w/ exceptions if field has |
HAS_PARENTRECOVERYPOINTARN() |
Determine if PARENTRECOVERYPOINTARN has a value |
CompositeMemberIdentifier¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COMPOSITEMEMBERID() |
Getter for COMPOSITEMEMBERIDENTIFIER, with configurable defa |
ASK_COMPOSITEMEMBERID() |
Getter for COMPOSITEMEMBERIDENTIFIER w/ exceptions if field |
HAS_COMPOSITEMEMBERID() |
Determine if COMPOSITEMEMBERIDENTIFIER has a value |
IsParent¶
This returns the boolean value that a recovery point is a parent (composite) job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ISPARENT() |
Getter for ISPARENT |
ResourceName¶
The name of the resource that belongs to the specified backup.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCENAME() |
Getter for RESOURCENAME, with configurable default |
ASK_RESOURCENAME() |
Getter for RESOURCENAME w/ exceptions if field has no value |
HAS_RESOURCENAME() |
Determine if RESOURCENAME has a value |
VaultType¶
The type of vault in which the described recovery point is stored.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VAULTTYPE() |
Getter for VAULTTYPE, with configurable default |
ASK_VAULTTYPE() |
Getter for VAULTTYPE w/ exceptions if field has no value |
HAS_VAULTTYPE() |
Determine if VAULTTYPE has a value |
IndexStatus¶
This is the current status for the backup index associated with the specified recovery point.
Statuses are:
PENDING|ACTIVE|FAILED|DELETINGA recovery point with an index that has the status of
ACTIVEcan be included in a search.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INDEXSTATUS() |
Getter for INDEXSTATUS, with configurable default |
ASK_INDEXSTATUS() |
Getter for INDEXSTATUS w/ exceptions if field has no value |
HAS_INDEXSTATUS() |
Determine if INDEXSTATUS has a value |
IndexStatusMessage¶
A string in the form of a detailed message explaining the status of a backup index associated with the recovery point.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INDEXSTATUSMESSAGE() |
Getter for INDEXSTATUSMESSAGE, with configurable default |
ASK_INDEXSTATUSMESSAGE() |
Getter for INDEXSTATUSMESSAGE w/ exceptions if field has no |
HAS_INDEXSTATUSMESSAGE() |
Determine if INDEXSTATUSMESSAGE has a value |