public static interface StartBackupJobRequest.Builder extends BackupRequest.Builder, SdkPojo, CopyableBuilder<StartBackupJobRequest.Builder,StartBackupJobRequest>
| 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 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 you can use to distinguish between otherwise identical 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.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildStartBackupJobRequest.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.
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.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.
resourceArn - An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on
the resource type.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.
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 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.
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.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).
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).
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).
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).
StartBackupJobRequest.Builder lifecycle(Lifecycle 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).
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).
default StartBackupJobRequest.Builder lifecycle(Consumer<Lifecycle.Builder> 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 theLifecycle.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).
lifecycle - a consumer that will call methods on Lifecycle.Builderlifecycle(Lifecycle)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.
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.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.
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.
StartBackupJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderStartBackupJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.