public static interface DescribeRecoveryPointResponse.Builder extends BackupResponse.Builder, SdkPojo, CopyableBuilder<DescribeRecoveryPointResponse.Builder,DescribeRecoveryPointResponse>
| Modifier and Type | Method and Description |
|---|---|
DescribeRecoveryPointResponse.Builder |
backupSizeInBytes(Long backupSizeInBytes)
The size, in bytes, of a backup.
|
DescribeRecoveryPointResponse.Builder |
backupVaultArn(String backupVaultArn)
An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. |
DescribeRecoveryPointResponse.Builder |
backupVaultName(String backupVaultName)
The name of a logical container where backups are stored.
|
DescribeRecoveryPointResponse.Builder |
calculatedLifecycle(CalculatedLifecycle calculatedLifecycle)
A
CalculatedLifecycle object containing DeleteAt and
MoveToColdStorageAt timestamps. |
default DescribeRecoveryPointResponse.Builder |
calculatedLifecycle(Consumer<CalculatedLifecycle.Builder> calculatedLifecycle)
A
CalculatedLifecycle object containing DeleteAt and
MoveToColdStorageAt timestamps. |
DescribeRecoveryPointResponse.Builder |
completionDate(Instant completionDate)
The date and time that a job to create a recovery point is completed, in Unix format and Coordinated
Universal Time (UTC).
|
DescribeRecoveryPointResponse.Builder |
compositeMemberIdentifier(String compositeMemberIdentifier)
This is the identifier of a resource within a composite group, such as nested (child) recovery point
belonging to a composite (parent) stack.
|
default DescribeRecoveryPointResponse.Builder |
createdBy(Consumer<RecoveryPointCreator.Builder> 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.Builder |
createdBy(RecoveryPointCreator 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.Builder |
creationDate(Instant creationDate)
The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC).
|
DescribeRecoveryPointResponse.Builder |
encryptionKeyArn(String 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.Builder |
iamRoleArn(String iamRoleArn)
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access. |
DescribeRecoveryPointResponse.Builder |
isEncrypted(Boolean 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.Builder |
isParent(Boolean isParent)
This returns the boolean value that a recovery point is a parent (composite) job.
|
DescribeRecoveryPointResponse.Builder |
lastRestoreTime(Instant lastRestoreTime)
The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time
(UTC).
|
default DescribeRecoveryPointResponse.Builder |
lifecycle(Consumer<Lifecycle.Builder> lifecycle)
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
|
DescribeRecoveryPointResponse.Builder |
lifecycle(Lifecycle lifecycle)
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
|
DescribeRecoveryPointResponse.Builder |
parentRecoveryPointArn(String 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. |
DescribeRecoveryPointResponse.Builder |
recoveryPointArn(String 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.Builder |
resourceArn(String resourceArn)
An ARN that uniquely identifies a saved resource.
|
DescribeRecoveryPointResponse.Builder |
resourceName(String resourceName)
This is the non-unique name of the resource that belongs to the specified backup.
|
DescribeRecoveryPointResponse.Builder |
resourceType(String 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.Builder |
sourceBackupVaultArn(String 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. |
DescribeRecoveryPointResponse.Builder |
status(RecoveryPointStatus status)
A status code specifying the state of the recovery point.
|
DescribeRecoveryPointResponse.Builder |
status(String status)
A status code specifying the state of the recovery point.
|
DescribeRecoveryPointResponse.Builder |
statusMessage(String statusMessage)
A status message explaining the status of the recovery point.
|
DescribeRecoveryPointResponse.Builder |
storageClass(StorageClass storageClass)
Specifies the storage class of the recovery point.
|
DescribeRecoveryPointResponse.Builder |
storageClass(String storageClass)
Specifies the storage class of the recovery point.
|
build, responseMetadata, responseMetadatasdkHttpResponse, sdkHttpResponseequalsBySdkFields, sdkFieldscopyapplyMutation, buildDescribeRecoveryPointResponse.Builder recoveryPointArn(String 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.
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.Builder backupVaultName(String 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.
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.Builder backupVaultArn(String backupVaultArn)
An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
backupVaultArn - An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.DescribeRecoveryPointResponse.Builder sourceBackupVaultArn(String 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.
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.Builder resourceArn(String resourceArn)
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
resourceArn - An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.DescribeRecoveryPointResponse.Builder resourceType(String 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.
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.Builder createdBy(RecoveryPointCreator 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.
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.default DescribeRecoveryPointResponse.Builder createdBy(Consumer<RecoveryPointCreator.Builder> 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.
RecoveryPointCreator.Builder avoiding
the need to create one manually via RecoveryPointCreator.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to createdBy(RecoveryPointCreator).
createdBy - a consumer that will call methods on RecoveryPointCreator.BuildercreatedBy(RecoveryPointCreator)DescribeRecoveryPointResponse.Builder iamRoleArn(String iamRoleArn)
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access.
iamRoleArn - Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access.DescribeRecoveryPointResponse.Builder status(String 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.
For SAP HANA on Amazon EC2 STOPPED status 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.
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.
For SAP HANA on Amazon EC2 STOPPED status 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.
RecoveryPointStatus,
RecoveryPointStatusDescribeRecoveryPointResponse.Builder status(RecoveryPointStatus 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.
For SAP HANA on Amazon EC2 STOPPED status 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.
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.
For SAP HANA on Amazon EC2 STOPPED status 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.
RecoveryPointStatus,
RecoveryPointStatusDescribeRecoveryPointResponse.Builder statusMessage(String statusMessage)
A status message explaining the status of the recovery point.
statusMessage - A status message explaining the status of the recovery point.DescribeRecoveryPointResponse.Builder creationDate(Instant 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.
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.Builder completionDate(Instant 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.
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.Builder backupSizeInBytes(Long backupSizeInBytes)
The size, in bytes, of a backup.
backupSizeInBytes - The size, in bytes, of a backup.DescribeRecoveryPointResponse.Builder calculatedLifecycle(CalculatedLifecycle calculatedLifecycle)
A CalculatedLifecycle object containing DeleteAt and
MoveToColdStorageAt timestamps.
calculatedLifecycle - A CalculatedLifecycle object containing DeleteAt and
MoveToColdStorageAt timestamps.default DescribeRecoveryPointResponse.Builder calculatedLifecycle(Consumer<CalculatedLifecycle.Builder> calculatedLifecycle)
A CalculatedLifecycle object containing DeleteAt and
MoveToColdStorageAt timestamps.
CalculatedLifecycle.Builder avoiding the
need to create one manually via CalculatedLifecycle.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to calculatedLifecycle(CalculatedLifecycle).
calculatedLifecycle - a consumer that will call methods on CalculatedLifecycle.BuildercalculatedLifecycle(CalculatedLifecycle)DescribeRecoveryPointResponse.Builder lifecycle(Lifecycle 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.
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.
default DescribeRecoveryPointResponse.Builder lifecycle(Consumer<Lifecycle.Builder> 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.
This is a convenience method that creates an instance of theLifecycle.Builder avoiding the need to
create one manually via Lifecycle.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result
is passed to lifecycle(Lifecycle).
lifecycle - a consumer that will call methods on Lifecycle.Builderlifecycle(Lifecycle)DescribeRecoveryPointResponse.Builder encryptionKeyArn(String 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.
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.Builder isEncrypted(Boolean 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.
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.Builder storageClass(String storageClass)
Specifies the storage class of the recovery point. Valid values are WARM or COLD.
storageClass - Specifies the storage class of the recovery point. Valid values are WARM or
COLD.StorageClass,
StorageClassDescribeRecoveryPointResponse.Builder storageClass(StorageClass storageClass)
Specifies the storage class of the recovery point. Valid values are WARM or COLD.
storageClass - Specifies the storage class of the recovery point. Valid values are WARM or
COLD.StorageClass,
StorageClassDescribeRecoveryPointResponse.Builder lastRestoreTime(Instant 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.
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.Builder parentRecoveryPointArn(String 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.
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
.DescribeRecoveryPointResponse.Builder compositeMemberIdentifier(String 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.
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.Builder isParent(Boolean isParent)
This returns the boolean value that a recovery point is a parent (composite) job.
isParent - This returns the boolean value that a recovery point is a parent (composite) job.DescribeRecoveryPointResponse.Builder resourceName(String resourceName)
This is the non-unique name of the resource that belongs to the specified backup.
resourceName - This is the non-unique name of the resource that belongs to the specified backup.Copyright © 2023. All rights reserved.