@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class StartBackupJobRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
StartBackupJobRequest() |
| Modifier and Type | Method and Description |
|---|---|
StartBackupJobRequest |
addBackupOptionsEntry(String key,
String value)
Add a single BackupOptions entry
|
StartBackupJobRequest |
addRecoveryPointTagsEntry(String key,
String value)
Add a single RecoveryPointTags entry
|
StartBackupJobRequest |
clearBackupOptionsEntries()
Removes all the entries added into BackupOptions.
|
StartBackupJobRequest |
clearRecoveryPointTagsEntries()
Removes all the entries added into RecoveryPointTags.
|
StartBackupJobRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Map<String,String> |
getBackupOptions()
Specifies the backup option for a selected resource.
|
String |
getBackupVaultName()
The name of a logical container where backups are stored.
|
Long |
getCompleteWindowMinutes()
A value in minutes during which a successfully started backup must complete, or else Backup will cancel the job.
|
String |
getIamRoleArn()
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access. |
String |
getIdempotencyToken()
A customer-chosen string that you can use to distinguish between otherwise identical calls to
StartBackupJob. |
Lifecycle |
getLifecycle()
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
|
Map<String,String> |
getRecoveryPointTags()
To help organize your resources, you can assign your own metadata to the resources that you create.
|
String |
getResourceArn()
An Amazon Resource Name (ARN) that uniquely identifies a resource.
|
Long |
getStartWindowMinutes()
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.
|
int |
hashCode() |
void |
setBackupOptions(Map<String,String> backupOptions)
Specifies the backup option for a selected resource.
|
void |
setBackupVaultName(String backupVaultName)
The name of a logical container where backups are stored.
|
void |
setCompleteWindowMinutes(Long completeWindowMinutes)
A value in minutes during which a successfully started backup must complete, or else Backup will cancel the job.
|
void |
setIamRoleArn(String iamRoleArn)
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access. |
void |
setIdempotencyToken(String idempotencyToken)
A customer-chosen string that you can use to distinguish between otherwise identical calls to
StartBackupJob. |
void |
setLifecycle(Lifecycle lifecycle)
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
|
void |
setRecoveryPointTags(Map<String,String> recoveryPointTags)
To help organize your resources, you can assign your own metadata to the resources that you create.
|
void |
setResourceArn(String resourceArn)
An Amazon Resource Name (ARN) that uniquely identifies a resource.
|
void |
setStartWindowMinutes(Long startWindowMinutes)
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.
|
String |
toString()
Returns a string representation of this object.
|
StartBackupJobRequest |
withBackupOptions(Map<String,String> backupOptions)
Specifies the backup option for a selected resource.
|
StartBackupJobRequest |
withBackupVaultName(String backupVaultName)
The name of a logical container where backups are stored.
|
StartBackupJobRequest |
withCompleteWindowMinutes(Long completeWindowMinutes)
A value in minutes during which a successfully started backup must complete, or else Backup will cancel the job.
|
StartBackupJobRequest |
withIamRoleArn(String iamRoleArn)
Specifies the IAM role ARN used to create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access. |
StartBackupJobRequest |
withIdempotencyToken(String idempotencyToken)
A customer-chosen string that you can use to distinguish between otherwise identical calls to
StartBackupJob. |
StartBackupJobRequest |
withLifecycle(Lifecycle lifecycle)
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
|
StartBackupJobRequest |
withRecoveryPointTags(Map<String,String> recoveryPointTags)
To help organize your resources, you can assign your own metadata to the resources that you create.
|
StartBackupJobRequest |
withResourceArn(String resourceArn)
An Amazon Resource Name (ARN) that uniquely identifies a resource.
|
StartBackupJobRequest |
withStartWindowMinutes(Long startWindowMinutes)
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic void setBackupVaultName(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.public String getBackupVaultName()
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 StartBackupJobRequest withBackupVaultName(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.public void setResourceArn(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.public String getResourceArn()
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
public StartBackupJobRequest withResourceArn(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.public void setIamRoleArn(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.public String getIamRoleArn()
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 StartBackupJobRequest withIamRoleArn(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.public void setIdempotencyToken(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.public String getIdempotencyToken()
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 StartBackupJobRequest withIdempotencyToken(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.public void setStartWindowMinutes(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).
public Long getStartWindowMinutes()
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).
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).
public StartBackupJobRequest withStartWindowMinutes(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).
public void setCompleteWindowMinutes(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).
public Long getCompleteWindowMinutes()
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).
StartWindowMinutes, or if the backup started later than
scheduled.
Like StartWindowMinutes, this parameter has a maximum value of 100 years (52,560,000
minutes).
public StartBackupJobRequest withCompleteWindowMinutes(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).
public void setLifecycle(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).
public Lifecycle getLifecycle()
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).
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).
public StartBackupJobRequest withLifecycle(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).
public Map<String,String> getRecoveryPointTags()
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(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.public StartBackupJobRequest withRecoveryPointTags(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.public StartBackupJobRequest addRecoveryPointTagsEntry(String key, String value)
public StartBackupJobRequest clearRecoveryPointTagsEntries()
public Map<String,String> getBackupOptions()
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 "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(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.
public StartBackupJobRequest withBackupOptions(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.
public StartBackupJobRequest addBackupOptionsEntry(String key, String value)
public StartBackupJobRequest clearBackupOptionsEntries()
public String toString()
toString in class ObjectObject.toString()public StartBackupJobRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()