software.amazon.awssdk.services.backup.model

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 Summary

Modifier and Type	Method and Description
StartBackupJobRequest.Builder	backupOptions(Map<String,String> backupOptions) Specifies the backup option for a selected resource.
StartBackupJobRequest.Builder	backupVaultName(String backupVaultName) The name of a logical container where backups are stored.
StartBackupJobRequest.Builder	completeWindowMinutes(Long completeWindowMinutes) A value in minutes during which a successfully started backup must complete, or else AWS Backup will cancel the job.
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.
StartBackupJobRequest.Builder	idempotencyToken(String idempotencyToken) A customer chosen string that can be used to distinguish between calls to StartBackupJob.
default StartBackupJobRequest.Builder	lifecycle(Consumer<Lifecycle.Builder> lifecycle) The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
StartBackupJobRequest.Builder	lifecycle(Lifecycle lifecycle) The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
StartBackupJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartBackupJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
StartBackupJobRequest.Builder	recoveryPointTags(Map<String,String> recoveryPointTags) To help organize your resources, you can assign your own metadata to the resources that you create.
StartBackupJobRequest.Builder	resourceArn(String resourceArn) An Amazon Resource Name (ARN) that uniquely identifies a resource.
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.

Methods inherited from interface software.amazon.awssdk.services.backup.model.BackupRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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 AWS 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 AWS 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 can be used to distinguish between calls to StartBackupJob.

Parameters:

idempotencyToken - A customer chosen string that can be used to distinguish between calls to StartBackupJob.

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.

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.

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

Parameters:

completeWindowMinutes - A value in minutes during which a successfully started backup must complete, or else AWS 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.

Returns:

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

lifecycle

StartBackupJobRequest.Builder lifecycle(Lifecycle lifecycle)

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS 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 “expire after days” 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.

Only Amazon EFS file system backups can be transitioned to cold storage.

Parameters:

lifecycle - The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS 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 “expire after days” 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.

Only Amazon EFS file system backups can be transitioned to cold storage.

Returns:

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

lifecycle

default StartBackupJobRequest.Builder lifecycle(Consumer<Lifecycle.Builder> lifecycle)

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS 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 “expire after days” 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.

Only Amazon EFS file system backups can be transitioned to cold storage.

This is a convenience 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:

lifecycle(Lifecycle)

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 VSS backup jobs.

Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows 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 VSS backup jobs.

Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows 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)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

StartBackupJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder