Package software.amazon.awssdk.services.backup.model

Interface DescribeRecoveryPointResponse.Builder

All Superinterfaces:
AwsResponse.Builder, BackupResponse.Builder, Buildable, CopyableBuilder<DescribeRecoveryPointResponse.Builder,DescribeRecoveryPointResponse>, SdkBuilder<DescribeRecoveryPointResponse.Builder,DescribeRecoveryPointResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeRecoveryPointResponse
public static interface DescribeRecoveryPointResponse.Builder extends BackupResponse.Builder, SdkPojo, CopyableBuilder<DescribeRecoveryPointResponse.Builder,DescribeRecoveryPointResponse>

  • Method Details

    • recoveryPointArn

      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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • backupVaultName

      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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • backupVaultArn

      DescribeRecoveryPointResponse.Builder backupVaultArn(String backupVaultArn)

      An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

      Parameters:
      backupVaultArn - An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceBackupVaultArn

      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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceArn

      DescribeRecoveryPointResponse.Builder resourceArn(String resourceArn)

      An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

      Parameters:
      resourceArn - An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceType

      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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • createdBy

      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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdBy

      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.

      This is a convenience method that creates an instance of the 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).

      Parameters:
      createdBy - a consumer that will call methods on RecoveryPointCreator.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • iamRoleArn

      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.

      Parameters:
      iamRoleArn - Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      DescribeRecoveryPointResponse.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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusMessage

      DescribeRecoveryPointResponse.Builder statusMessage(String statusMessage)

      A status message explaining the status of the recovery point.

      Parameters:
      statusMessage - A status message explaining the status of the recovery point.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationDate

      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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • completionDate

      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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • backupSizeInBytes

      DescribeRecoveryPointResponse.Builder backupSizeInBytes(Long backupSizeInBytes)

      The size, in bytes, of a backup.

      Parameters:
      backupSizeInBytes - The size, in bytes, of a backup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • calculatedLifecycle

      DescribeRecoveryPointResponse.Builder calculatedLifecycle(CalculatedLifecycle calculatedLifecycle)

      A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

      Parameters:
      calculatedLifecycle - A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • calculatedLifecycle

      default DescribeRecoveryPointResponse.Builder calculatedLifecycle(Consumer<CalculatedLifecycle.Builder> calculatedLifecycle)

      A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

      This is a convenience method that creates an instance of the 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).

      Parameters:
      calculatedLifecycle - a consumer that will call methods on CalculatedLifecycle.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lifecycle

      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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • lifecycle

      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 the Lifecycle.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).

      Parameters:
      lifecycle - a consumer that will call methods on Lifecycle.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • encryptionKeyArn

      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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • isEncrypted

      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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • storageClass

      DescribeRecoveryPointResponse.Builder storageClass(String storageClass)

      Specifies the storage class of the recovery point. Valid values are WARM or COLD.

      Parameters:
      storageClass - Specifies the storage class of the recovery point. Valid values are WARM or COLD.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageClass

      DescribeRecoveryPointResponse.Builder storageClass(StorageClass storageClass)

      Specifies the storage class of the recovery point. Valid values are WARM or COLD.

      Parameters:
      storageClass - Specifies the storage class of the recovery point. Valid values are WARM or COLD.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lastRestoreTime

      DescribeRecoveryPointResponse.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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • parentRecoveryPointArn

      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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • compositeMemberIdentifier

      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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • isParent

      DescribeRecoveryPointResponse.Builder isParent(Boolean isParent)

      This returns the boolean value that a recovery point is a parent (composite) job.

      Parameters:
      isParent - This returns the boolean value that a recovery point is a parent (composite) job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceName

      DescribeRecoveryPointResponse.Builder resourceName(String resourceName)

      This is the non-unique name of the resource that belongs to the specified backup.

      Parameters:
      resourceName - This is the non-unique name of the resource that belongs to the specified backup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vaultType

      DescribeRecoveryPointResponse.Builder vaultType(String vaultType)

      This is the type of vault in which the described recovery point is stored.

      Parameters:
      vaultType - This is the type of vault in which the described recovery point is stored.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vaultType

      DescribeRecoveryPointResponse.Builder vaultType(VaultType vaultType)

      This is the type of vault in which the described recovery point is stored.

      Parameters:
      vaultType - This is the type of vault in which the described recovery point is stored.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: