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

Interface StartCopyJobRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BackupRequest.Builder, Buildable, CopyableBuilder<StartCopyJobRequest.Builder,StartCopyJobRequest>, SdkBuilder<StartCopyJobRequest.Builder,StartCopyJobRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartCopyJobRequest
public static interface StartCopyJobRequest.Builder extends BackupRequest.Builder, SdkPojo, CopyableBuilder<StartCopyJobRequest.Builder,StartCopyJobRequest>

  • Method Details

    • recoveryPointArn

      StartCopyJobRequest.Builder recoveryPointArn(String recoveryPointArn)

      An ARN that uniquely identifies a recovery point to use for the copy job; 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 to use for the copy job; 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.

    • sourceBackupVaultName

      StartCopyJobRequest.Builder sourceBackupVaultName(String sourceBackupVaultName)

      The name of a logical source 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:
      sourceBackupVaultName - The name of a logical source 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.

    • destinationBackupVaultArn

      StartCopyJobRequest.Builder destinationBackupVaultArn(String destinationBackupVaultArn)

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

      Parameters:
      destinationBackupVaultArn - An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; 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.

    • iamRoleArn

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

    • idempotencyToken

      StartCopyJobRequest.Builder idempotencyToken(String idempotencyToken)

      A customer-chosen string that you can use to distinguish between otherwise identical calls to StartCopyJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

      Parameters:
      idempotencyToken - A customer-chosen string that you can use to distinguish between otherwise identical calls to StartCopyJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lifecycle

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

    • lifecycle

      default StartCopyJobRequest.Builder lifecycle(Consumer<Lifecycle.Builder> lifecycle)
      Sets the value of the Lifecycle property for this object. 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:

    • overrideConfiguration

      StartCopyJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartCopyJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.