com.amazonaws.services.backup.model

Class StartBackupJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.backup.model.StartBackupJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartBackupJobRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartBackupJobRequest()

Method Summary

Modifier and Type	Method and Description
StartBackupJobRequest	addRecoveryPointTagsEntry(String key, String value)
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)
String	getBackupVaultName() The name of a logical container where backups are stored.
Long	getCompleteWindowMinutes() The amount of time AWS Backup attempts a backup before canceling the job and returning an error.
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 can be used to distinguish between 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() The amount of time in minutes before beginning a backup.
int	hashCode()
void	setBackupVaultName(String backupVaultName) The name of a logical container where backups are stored.
void	setCompleteWindowMinutes(Long completeWindowMinutes) The amount of time AWS Backup attempts a backup before canceling the job and returning an error.
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 can be used to distinguish between 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) The amount of time in minutes before beginning a backup.
String	toString() Returns a string representation of this object.
StartBackupJobRequest	withBackupVaultName(String backupVaultName) The name of a logical container where backups are stored.
StartBackupJobRequest	withCompleteWindowMinutes(Long completeWindowMinutes) The amount of time AWS Backup attempts a backup before canceling the job and returning an error.
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 can be used to distinguish between 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) The amount of time in minutes before beginning a backup.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartBackupJobRequest

public StartBackupJobRequest()

Method Detail

setBackupVaultName

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

getBackupVaultName

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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Returns:

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.

withBackupVaultName

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

setResourceArn

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.

Parameters:

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

getResourceArn

public String getResourceArn()

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

Returns:

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

withResourceArn

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.

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.

setIamRoleArn

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.

Parameters:

iamRoleArn - Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

getIamRoleArn

public String getIamRoleArn()

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Returns:

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

withIamRoleArn

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.

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.

setIdempotencyToken

public void setIdempotencyToken(String idempotencyToken)

A customer chosen string that can be used to distinguish between calls to StartBackupJob. Idempotency tokens time out after one hour. Therefore, if you call StartBackupJob multiple times with the same idempotency token within one hour, AWS Backup recognizes that you are requesting only one backup job and initiates only one. If you change the idempotency token for each call, AWS Backup recognizes that you are requesting to start multiple backups.

Parameters:

idempotencyToken - A customer chosen string that can be used to distinguish between calls to StartBackupJob. Idempotency tokens time out after one hour. Therefore, if you call StartBackupJob multiple times with the same idempotency token within one hour, AWS Backup recognizes that you are requesting only one backup job and initiates only one. If you change the idempotency token for each call, AWS Backup recognizes that you are requesting to start multiple backups.

getIdempotencyToken

public String getIdempotencyToken()

A customer chosen string that can be used to distinguish between calls to StartBackupJob. Idempotency tokens time out after one hour. Therefore, if you call StartBackupJob multiple times with the same idempotency token within one hour, AWS Backup recognizes that you are requesting only one backup job and initiates only one. If you change the idempotency token for each call, AWS Backup recognizes that you are requesting to start multiple backups.

Returns:

A customer chosen string that can be used to distinguish between calls to StartBackupJob. Idempotency tokens time out after one hour. Therefore, if you call StartBackupJob multiple times with the same idempotency token within one hour, AWS Backup recognizes that you are requesting only one backup job and initiates only one. If you change the idempotency token for each call, AWS Backup recognizes that you are requesting to start multiple backups.

withIdempotencyToken

public StartBackupJobRequest withIdempotencyToken(String idempotencyToken)

A customer chosen string that can be used to distinguish between calls to StartBackupJob. Idempotency tokens time out after one hour. Therefore, if you call StartBackupJob multiple times with the same idempotency token within one hour, AWS Backup recognizes that you are requesting only one backup job and initiates only one. If you change the idempotency token for each call, AWS Backup recognizes that you are requesting to start multiple backups.

Parameters:

idempotencyToken - A customer chosen string that can be used to distinguish between calls to StartBackupJob. Idempotency tokens time out after one hour. Therefore, if you call StartBackupJob multiple times with the same idempotency token within one hour, AWS Backup recognizes that you are requesting only one backup job and initiates only one. If you change the idempotency token for each call, AWS Backup recognizes that you are requesting to start multiple backups.

Returns:

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

setStartWindowMinutes

public void setStartWindowMinutes(Long startWindowMinutes)

The amount of time in minutes before beginning a backup.

Parameters:

startWindowMinutes - The amount of time in minutes before beginning a backup.

getStartWindowMinutes

public Long getStartWindowMinutes()

The amount of time in minutes before beginning a backup.

Returns:

The amount of time in minutes before beginning a backup.

withStartWindowMinutes

public StartBackupJobRequest withStartWindowMinutes(Long startWindowMinutes)

The amount of time in minutes before beginning a backup.

Parameters:

startWindowMinutes - The amount of time in minutes before beginning a backup.

Returns:

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

setCompleteWindowMinutes

public void setCompleteWindowMinutes(Long completeWindowMinutes)

The amount of time AWS Backup attempts a backup before canceling the job and returning an error.

Parameters:

completeWindowMinutes - The amount of time AWS Backup attempts a backup before canceling the job and returning an error.

getCompleteWindowMinutes

public Long getCompleteWindowMinutes()

The amount of time AWS Backup attempts a backup before canceling the job and returning an error.

Returns:

The amount of time AWS Backup attempts a backup before canceling the job and returning an error.

withCompleteWindowMinutes

public StartBackupJobRequest withCompleteWindowMinutes(Long completeWindowMinutes)

The amount of time AWS Backup attempts a backup before canceling the job and returning an error.

Parameters:

completeWindowMinutes - The amount of time AWS Backup attempts a backup before canceling the job and returning an error.

Returns:

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

setLifecycle

public void setLifecycle(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.

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.

getLifecycle

public Lifecycle getLifecycle()

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.

Returns:

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.

withLifecycle

public StartBackupJobRequest withLifecycle(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.

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.

Returns:

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

getRecoveryPointTags

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.

Returns:

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

setRecoveryPointTags

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.

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.

withRecoveryPointTags

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.

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.

addRecoveryPointTagsEntry

public StartBackupJobRequest addRecoveryPointTagsEntry(String key,
                                                       String value)

clearRecoveryPointTagsEntries

public StartBackupJobRequest clearRecoveryPointTagsEntries()

Removes all the entries added into RecoveryPointTags.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartBackupJobRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()