Class DescribeRecoveryPointResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeRecoveryPointResponse.Builder,
DescribeRecoveryPointResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Long
The size, in bytes, of a backup.final String
An ARN that uniquely identifies a backup vault; for example,arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.final String
The name of a logical container where backups are stored.builder()
final CalculatedLifecycle
ACalculatedLifecycle
object containingDeleteAt
andMoveToColdStorageAt
timestamps.final Instant
The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal Time (UTC).final String
This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack.final RecoveryPointCreator
Contains identifying information about the creation of a recovery point, including theBackupPlanArn
,BackupPlanId
,BackupPlanVersion
, andBackupRuleId
of the backup plan used to create it.final Instant
The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC).final String
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
.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final String
Specifies the IAM role ARN used to create the target recovery point; for example,arn:aws:iam::123456789012:role/S3Access
.final Boolean
A Boolean value that is returned asTRUE
if the specified recovery point is encrypted, orFALSE
if the recovery point is not encrypted.final Boolean
isParent()
This returns the boolean value that a recovery point is a parent (composite) job.final Instant
The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC).final Lifecycle
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.final String
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
.final String
An ARN that uniquely identifies a recovery point; for example,arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.final String
An ARN that uniquely identifies a saved resource.final String
This is the non-unique name of the resource that belongs to the specified backup.final String
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.static Class
<? extends DescribeRecoveryPointResponse.Builder> final String
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
.final RecoveryPointStatus
status()
A status code specifying the state of the recovery point.final String
A status code specifying the state of the recovery point.final String
A status message explaining the status of the recovery point.final StorageClass
Specifies the storage class of the recovery point.final String
Specifies the storage class of the recovery point.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final VaultType
This is the type of vault in which the described recovery point is stored.final String
This is the type of vault in which the described recovery point is stored.Methods inherited from class software.amazon.awssdk.services.backup.model.BackupResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
.- Returns:
- An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
-
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.
- Returns:
- 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.
-
backupVaultArn
An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.- Returns:
- An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
-
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 benull
.- Returns:
- 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 benull
.
-
resourceArn
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
- Returns:
- An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
-
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.
- Returns:
- 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.
-
createdBy
Contains identifying information about the creation of a recovery point, including the
BackupPlanArn
,BackupPlanId
,BackupPlanVersion
, andBackupRuleId
of the backup plan used to create it.- Returns:
- Contains identifying information about the creation of a recovery point, including the
BackupPlanArn
,BackupPlanId
,BackupPlanVersion
, andBackupRuleId
of the backup plan used to create it.
-
iamRoleArn
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access
.- Returns:
- Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access
.
-
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.If the service returns an enum value that is not available in the current SDK version,
status
will returnRecoveryPointStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- 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. - See Also:
-
statusAsString
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.If the service returns an enum value that is not available in the current SDK version,
status
will returnRecoveryPointStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- 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. - See Also:
-
statusMessage
A status message explaining the status of the recovery point.
- Returns:
- A status message explaining the status of the recovery point.
-
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.- Returns:
- 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.
-
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.- Returns:
- 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.
-
backupSizeInBytes
The size, in bytes, of a backup.
- Returns:
- The size, in bytes, of a backup.
-
calculatedLifecycle
A
CalculatedLifecycle
object containingDeleteAt
andMoveToColdStorageAt
timestamps.- Returns:
- A
CalculatedLifecycle
object containingDeleteAt
andMoveToColdStorageAt
timestamps.
-
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.
- Returns:
- 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.
-
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
.- Returns:
- 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
.
-
isEncrypted
A Boolean value that is returned as
TRUE
if the specified recovery point is encrypted, orFALSE
if the recovery point is not encrypted.- Returns:
- A Boolean value that is returned as
TRUE
if the specified recovery point is encrypted, orFALSE
if the recovery point is not encrypted.
-
storageClass
Specifies the storage class of the recovery point. Valid values are
WARM
orCOLD
.If the service returns an enum value that is not available in the current SDK version,
storageClass
will returnStorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageClassAsString()
.- Returns:
- Specifies the storage class of the recovery point. Valid values are
WARM
orCOLD
. - See Also:
-
storageClassAsString
Specifies the storage class of the recovery point. Valid values are
WARM
orCOLD
.If the service returns an enum value that is not available in the current SDK version,
storageClass
will returnStorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageClassAsString()
.- Returns:
- Specifies the storage class of the recovery point. Valid values are
WARM
orCOLD
. - See Also:
-
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.- Returns:
- 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.
-
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
.- Returns:
- 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
.
-
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.
- Returns:
- 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.
-
isParent
This returns the boolean value that a recovery point is a parent (composite) job.
- Returns:
- This returns the boolean value that a recovery point is a parent (composite) job.
-
resourceName
This is the non-unique name of the resource that belongs to the specified backup.
- Returns:
- This is the non-unique name of the resource that belongs to the specified backup.
-
vaultType
This is the type of vault in which the described recovery point is stored.
If the service returns an enum value that is not available in the current SDK version,
vaultType
will returnVaultType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvaultTypeAsString()
.- Returns:
- This is the type of vault in which the described recovery point is stored.
- See Also:
-
vaultTypeAsString
This is the type of vault in which the described recovery point is stored.
If the service returns an enum value that is not available in the current SDK version,
vaultType
will returnVaultType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvaultTypeAsString()
.- Returns:
- This is the type of vault in which the described recovery point is stored.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeRecoveryPointResponse.Builder,
DescribeRecoveryPointResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-