Interface CopyJob.Builder

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

  • Method Details

    • accountId

      CopyJob.Builder accountId(String accountId)

      The account ID that owns the copy job.

      Parameters:
      accountId - The account ID that owns the copy job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • copyJobId

      CopyJob.Builder copyJobId(String copyJobId)

      Uniquely identifies a copy job.

      Parameters:
      copyJobId - Uniquely identifies a copy job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceBackupVaultArn

      CopyJob.Builder sourceBackupVaultArn(String sourceBackupVaultArn)

      An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

      Parameters:
      sourceBackupVaultArn - An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceRecoveryPointArn

      CopyJob.Builder sourceRecoveryPointArn(String sourceRecoveryPointArn)

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

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

    • destinationBackupVaultArn

      CopyJob.Builder destinationBackupVaultArn(String destinationBackupVaultArn)

      An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

      Parameters:
      destinationBackupVaultArn - An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinationRecoveryPointArn

      CopyJob.Builder destinationRecoveryPointArn(String destinationRecoveryPointArn)

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

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

    • resourceArn

      CopyJob.Builder resourceArn(String resourceArn)

      The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

      Parameters:
      resourceArn - The Amazon Web Services resource to be copied; 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.

    • creationDate

      CopyJob.Builder creationDate(Instant creationDate)

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

      CopyJob.Builder completionDate(Instant completionDate)

      The date and time a copy job 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 copy job 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.

    • state

      CopyJob.Builder state(String state)

      The current state of a copy job.

      Parameters:
      state - The current state of a copy job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      CopyJob.Builder state(CopyJobState state)

      The current state of a copy job.

      Parameters:
      state - The current state of a copy job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusMessage

      CopyJob.Builder statusMessage(String statusMessage)

      A detailed message explaining the status of the job to copy a resource.

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

    • backupSizeInBytes

      CopyJob.Builder backupSizeInBytes(Long backupSizeInBytes)

      The size, in bytes, of a copy job.

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

    • iamRoleArn

      CopyJob.Builder iamRoleArn(String iamRoleArn)

      Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

      Parameters:
      iamRoleArn - Specifies the IAM role ARN used to copy 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.

    • createdBy

      CopyJob.Builder createdBy(RecoveryPointCreator createdBy)
      Sets the value of the CreatedBy property for this object.
      Parameters:
      createdBy - The new value for the CreatedBy property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdBy

      default CopyJob.Builder createdBy(Consumer<RecoveryPointCreator.Builder> createdBy)
      Sets the value of the CreatedBy property for this object. 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:

    • resourceType

      CopyJob.Builder resourceType(String resourceType)

      The type of Amazon Web Services resource to be copied; 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 be copied; 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.

    • parentJobId

      CopyJob.Builder parentJobId(String parentJobId)

      This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.

      Parameters:
      parentJobId - This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isParent

      CopyJob.Builder isParent(Boolean isParent)

      This is a boolean value indicating this is a parent (composite) copy job.

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

    • compositeMemberIdentifier

      CopyJob.Builder compositeMemberIdentifier(String 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.

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

    • numberOfChildJobs

      CopyJob.Builder numberOfChildJobs(Long numberOfChildJobs)

      The number of child (nested) copy jobs.

      Parameters:
      numberOfChildJobs - The number of child (nested) copy jobs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • childJobsInStateWithStrings

      CopyJob.Builder childJobsInStateWithStrings(Map<String,Long> childJobsInState)

      This returns the statistics of the included child (nested) copy jobs.

      Parameters:
      childJobsInState - This returns the statistics of the included child (nested) copy jobs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • childJobsInState

      CopyJob.Builder childJobsInState(Map<CopyJobState,Long> childJobsInState)

      This returns the statistics of the included child (nested) copy jobs.

      Parameters:
      childJobsInState - This returns the statistics of the included child (nested) copy jobs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceName

      CopyJob.Builder resourceName(String resourceName)

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

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

    • messageCategory

      CopyJob.Builder messageCategory(String messageCategory)

      This parameter is the job count for the specified message category.

      Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and InvalidParameters. See Monitoring for a list of MessageCategory strings.

      The the value ANY returns count of all message categories.

      AGGREGATE_ALL aggregates job counts for all message categories and returns the sum

      Parameters:
      messageCategory - This parameter is the job count for the specified message category.

      Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and InvalidParameters. See Monitoring for a list of MessageCategory strings.

      The the value ANY returns count of all message categories.

      AGGREGATE_ALL aggregates job counts for all message categories and returns the sum

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