/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.backup.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class StartBackupJobRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* 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. *
*/ private String backupVaultName; /** ** An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource * type. *
*/ private String resourceArn; /** *
* Specifies the IAM role ARN used to create the target recovery point; for example,
* arn:aws:iam::123456789012:role/S3Access
.
*
* 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.
*
* 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. *
*
* 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).
*
* 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.
*
* 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. *
*/ private Lifecycle lifecycle; /** ** To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a * key-value pair. *
*/ private java.util.Map* 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.
*
* 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. *
* * @param 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. */ public void setBackupVaultName(String backupVaultName) { this.backupVaultName = 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. *
* * @return 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. */ public String getBackupVaultName() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBackupJobRequest withBackupVaultName(String backupVaultName) { setBackupVaultName(backupVaultName); return this; } /** ** An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource * type. *
* * @param resourceArn * An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the * resource type. */ public void setResourceArn(String resourceArn) { this.resourceArn = resourceArn; } /** ** An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource * type. *
* * @return An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the * resource type. */ public String getResourceArn() { return this.resourceArn; } /** ** An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource * type. *
* * @param resourceArn * An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the * resource type. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBackupJobRequest withResourceArn(String resourceArn) { setResourceArn(resourceArn); return this; } /** *
* Specifies the IAM role ARN used to create the target recovery point; for example,
* arn:aws:iam::123456789012:role/S3Access
.
*
arn:aws:iam::123456789012:role/S3Access
.
*/
public void setIamRoleArn(String iamRoleArn) {
this.iamRoleArn = iamRoleArn;
}
/**
*
* Specifies the IAM role ARN used to create the target recovery point; for example,
* arn:aws:iam::123456789012:role/S3Access
.
*
arn:aws:iam::123456789012:role/S3Access
.
*/
public String getIamRoleArn() {
return this.iamRoleArn;
}
/**
*
* Specifies the IAM role ARN used to create the target recovery point; for example,
* arn:aws:iam::123456789012:role/S3Access
.
*
arn:aws:iam::123456789012:role/S3Access
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartBackupJobRequest withIamRoleArn(String iamRoleArn) {
setIamRoleArn(iamRoleArn);
return this;
}
/**
*
* 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.
*
StartBackupJob
. Retrying a successful request with the same idempotency token results in a
* success message with no action taken.
*/
public void setIdempotencyToken(String idempotencyToken) {
this.idempotencyToken = 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.
*
StartBackupJob
. Retrying a successful request with the same idempotency token results in a
* success message with no action taken.
*/
public String getIdempotencyToken() {
return this.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.
*
StartBackupJob
. Retrying a successful request with the same idempotency token results in a
* success message with no action taken.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartBackupJobRequest withIdempotencyToken(String idempotencyToken) {
setIdempotencyToken(idempotencyToken);
return this;
}
/**
* * 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. *
*
* 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).
*
* 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).
*/
public void setStartWindowMinutes(Long startWindowMinutes) {
this.startWindowMinutes = 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. *
*
* 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).
*
* 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).
*/
public Long getStartWindowMinutes() {
return this.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. *
*
* 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).
*
* 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).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartBackupJobRequest withStartWindowMinutes(Long startWindowMinutes) {
setStartWindowMinutes(startWindowMinutes);
return this;
}
/**
*
* 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.
*
StartWindowMinutes
, or if the backup started later than
* scheduled.
*/
public void setCompleteWindowMinutes(Long completeWindowMinutes) {
this.completeWindowMinutes = 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.
*
StartWindowMinutes
, or if the backup started later than
* scheduled.
*/
public Long getCompleteWindowMinutes() {
return this.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.
*
StartWindowMinutes
, or if the backup started later than
* scheduled.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartBackupJobRequest withCompleteWindowMinutes(Long completeWindowMinutes) {
setCompleteWindowMinutes(completeWindowMinutes);
return this;
}
/**
* * 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. *
* * @param 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. */ public void setLifecycle(Lifecycle lifecycle) { this.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. *
* * @return 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. */ public Lifecycle getLifecycle() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBackupJobRequest withLifecycle(Lifecycle lifecycle) { setLifecycle(lifecycle); return this; } /** *
* To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a * key-value pair. *
* * @return To help organize your resources, you can assign your own metadata to the resources that you create. Each * tag is a key-value pair. */ public java.util.Map* To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a * key-value pair. *
* * @param 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. */ public void setRecoveryPointTags(java.util.Map* To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a * key-value pair. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public StartBackupJobRequest withRecoveryPointTags(java.util.Map* 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.
*
* Valid values: Set to
* 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.
*/
public java.util.Map"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.
*
* Valid values: Set to
* 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.
*/
public void setBackupOptions(java.util.Map"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.
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartBackupJobRequest withBackupOptions(java.util.Map