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

Interface RecoveryPointByBackupVault.Builder

All Superinterfaces:
Buildable, CopyableBuilder<RecoveryPointByBackupVault.Builder,RecoveryPointByBackupVault>, SdkBuilder<RecoveryPointByBackupVault.Builder,RecoveryPointByBackupVault>, SdkPojo
Enclosing class:
RecoveryPointByBackupVault
public static interface RecoveryPointByBackupVault.Builder extends SdkPojo, CopyableBuilder<RecoveryPointByBackupVault.Builder,RecoveryPointByBackupVault>

  • Method Details

    • recoveryPointArn

      RecoveryPointByBackupVault.Builder recoveryPointArn(String recoveryPointArn)

      An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

      Parameters:
      recoveryPointArn - An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 .
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • backupVaultName

      RecoveryPointByBackupVault.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 Amazon Web Services 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 Amazon Web Services 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

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

      RecoveryPointByBackupVault.Builder sourceBackupVaultArn(String sourceBackupVaultArn)

      The backup vault where the recovery point was originally copied from. If the recovery point is restored to the same account this value will be null.

      Parameters:
      sourceBackupVaultArn - The backup vault where the recovery point was originally copied from. If the recovery point is restored to the same account this value will be null.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceArn

      RecoveryPointByBackupVault.Builder resourceArn(String resourceArn)

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

      Parameters:
      resourceArn - An ARN that uniquely identifies a 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

      RecoveryPointByBackupVault.Builder resourceType(String resourceType)

      The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

      Parameters:
      resourceType - The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdBy

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

    • createdBy

      default RecoveryPointByBackupVault.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 that is 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

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

      RecoveryPointByBackupVault.Builder status(String status)

      A status code specifying the state of the recovery point.

      Parameters:
      status - A status code specifying the state of the recovery point.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      RecoveryPointByBackupVault.Builder status(RecoveryPointStatus status)

      A status code specifying the state of the recovery point.

      Parameters:
      status - A status code specifying the state of the recovery point.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusMessage

      RecoveryPointByBackupVault.Builder statusMessage(String statusMessage)

      A message explaining the reason of the recovery point deletion failure.

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

    • creationDate

      RecoveryPointByBackupVault.Builder creationDate(Instant creationDate)

      The date and time 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 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

      RecoveryPointByBackupVault.Builder completionDate(Instant completionDate)

      The date and time a job to restore 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 a job to restore 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

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

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

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

      RecoveryPointByBackupVault.Builder encryptionKeyArn(String encryptionKeyArn)

      The server-side encryption key that is 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 that is 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

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

    • lastRestoreTime

      RecoveryPointByBackupVault.Builder lastRestoreTime(Instant lastRestoreTime)

      The date and time 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 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

      RecoveryPointByBackupVault.Builder parentRecoveryPointArn(String parentRecoveryPointArn)

      This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.

      Parameters:
      parentRecoveryPointArn - This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • compositeMemberIdentifier

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

      RecoveryPointByBackupVault.Builder isParent(Boolean isParent)

      This is a boolean value indicating this is a parent (composite) recovery point.

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

    • resourceName

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

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

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