Interface StartBackupJobRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BackupRequest.Builder, Buildable, CopyableBuilder<StartBackupJobRequest.Builder,StartBackupJobRequest>, SdkBuilder<StartBackupJobRequest.Builder,StartBackupJobRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartBackupJobRequest

public static interface StartBackupJobRequest.Builder extends BackupRequest.Builder, SdkPojo, CopyableBuilder<StartBackupJobRequest.Builder,StartBackupJobRequest>
  • Method Details

    • backupVaultName

      StartBackupJobRequest.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.
    • resourceArn

      StartBackupJobRequest.Builder resourceArn(String resourceArn)

      An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

      Parameters:
      resourceArn - An Amazon Resource Name (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.
    • iamRoleArn

      StartBackupJobRequest.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.
    • idempotencyToken

      StartBackupJobRequest.Builder idempotencyToken(String idempotencyToken)

      A customer-chosen string that you can use to distinguish between otherwise identical calls to StartBackupJob. 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 StartBackupJob. 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.
    • startWindowMinutes

      StartBackupJobRequest.Builder startWindowMinutes(Long startWindowMinutes)

      A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours. If this value is included, it must be at least 60 minutes to avoid errors.

      This parameter has a maximum value of 100 years (52,560,000 minutes).

      During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).

      Parameters:
      startWindowMinutes - A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours. If this value is included, it must be at least 60 minutes to avoid errors.

      This parameter has a maximum value of 100 years (52,560,000 minutes).

      During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).

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

      StartBackupJobRequest.Builder completeWindowMinutes(Long completeWindowMinutes)

      A value in minutes during which a successfully started backup must complete, or else Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.

      Like StartWindowMinutes, this parameter has a maximum value of 100 years (52,560,000 minutes).

      Parameters:
      completeWindowMinutes - A value in minutes during which a successfully started backup must complete, or else Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.

      Like StartWindowMinutes, this parameter has a maximum value of 100 years (52,560,000 minutes).

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

      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire 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 parameter has a maximum value of 100 years (36,500 days).

      Parameters:
      lifecycle - The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire 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 parameter has a maximum value of 100 years (36,500 days).

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

      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire 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 parameter has a maximum value of 100 years (36,500 days).

      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:
    • recoveryPointTags

      StartBackupJobRequest.Builder recoveryPointTags(Map<String,String> recoveryPointTags)

      To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

      Parameters:
      recoveryPointTags - To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • backupOptions

      StartBackupJobRequest.Builder backupOptions(Map<String,String> backupOptions)

      Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

      Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

      Parameters:
      backupOptions - Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

      Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

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

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

      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.