@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class BackupRuleInput extends Object implements Serializable, Cloneable, StructuredPojo
Specifies a scheduled task used to back up a selection of resources.
| Constructor and Description |
|---|
BackupRuleInput() |
| Modifier and Type | Method and Description |
|---|---|
BackupRuleInput |
addRecoveryPointTagsEntry(String key,
String value)
Add a single RecoveryPointTags entry
|
BackupRuleInput |
clearRecoveryPointTagsEntries()
Removes all the entries added into RecoveryPointTags.
|
BackupRuleInput |
clone() |
boolean |
equals(Object obj) |
Long |
getCompletionWindowMinutes()
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled
by Backup.
|
List<CopyAction> |
getCopyActions()
An array of
CopyAction objects, which contains the details of the copy operation. |
Boolean |
getEnableContinuousBackup()
Specifies whether Backup creates continuous backups.
|
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 |
getRuleName()
A display name for a backup rule.
|
String |
getScheduleExpression()
A CRON expression in UTC specifying when Backup initiates a backup job.
|
String |
getScheduleExpressionTimezone()
This is the timezone in which the schedule expression is set.
|
Long |
getStartWindowMinutes()
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.
|
String |
getTargetBackupVaultName()
The name of a logical container where backups are stored.
|
int |
hashCode() |
Boolean |
isEnableContinuousBackup()
Specifies whether Backup creates continuous backups.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller. |
void |
setCompletionWindowMinutes(Long completionWindowMinutes)
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled
by Backup.
|
void |
setCopyActions(Collection<CopyAction> copyActions)
An array of
CopyAction objects, which contains the details of the copy operation. |
void |
setEnableContinuousBackup(Boolean enableContinuousBackup)
Specifies whether Backup creates continuous backups.
|
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 |
setRuleName(String ruleName)
A display name for a backup rule.
|
void |
setScheduleExpression(String scheduleExpression)
A CRON expression in UTC specifying when Backup initiates a backup job.
|
void |
setScheduleExpressionTimezone(String scheduleExpressionTimezone)
This is the timezone in which the schedule expression is set.
|
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.
|
void |
setTargetBackupVaultName(String targetBackupVaultName)
The name of a logical container where backups are stored.
|
String |
toString()
Returns a string representation of this object.
|
BackupRuleInput |
withCompletionWindowMinutes(Long completionWindowMinutes)
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled
by Backup.
|
BackupRuleInput |
withCopyActions(Collection<CopyAction> copyActions)
An array of
CopyAction objects, which contains the details of the copy operation. |
BackupRuleInput |
withCopyActions(CopyAction... copyActions)
An array of
CopyAction objects, which contains the details of the copy operation. |
BackupRuleInput |
withEnableContinuousBackup(Boolean enableContinuousBackup)
Specifies whether Backup creates continuous backups.
|
BackupRuleInput |
withLifecycle(Lifecycle lifecycle)
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
|
BackupRuleInput |
withRecoveryPointTags(Map<String,String> recoveryPointTags)
To help organize your resources, you can assign your own metadata to the resources that you create.
|
BackupRuleInput |
withRuleName(String ruleName)
A display name for a backup rule.
|
BackupRuleInput |
withScheduleExpression(String scheduleExpression)
A CRON expression in UTC specifying when Backup initiates a backup job.
|
BackupRuleInput |
withScheduleExpressionTimezone(String scheduleExpressionTimezone)
This is the timezone in which the schedule expression is set.
|
BackupRuleInput |
withStartWindowMinutes(Long startWindowMinutes)
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.
|
BackupRuleInput |
withTargetBackupVaultName(String targetBackupVaultName)
The name of a logical container where backups are stored.
|
public void setRuleName(String ruleName)
A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
ruleName - A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.public String getRuleName()
A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
public BackupRuleInput withRuleName(String ruleName)
A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
ruleName - A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.public void setTargetBackupVaultName(String targetBackupVaultName)
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.
targetBackupVaultName - 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 getTargetBackupVaultName()
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 BackupRuleInput withTargetBackupVaultName(String targetBackupVaultName)
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.
targetBackupVaultName - 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 setScheduleExpression(String scheduleExpression)
A CRON expression in UTC specifying when Backup initiates a backup job.
scheduleExpression - A CRON expression in UTC specifying when Backup initiates a backup job.public String getScheduleExpression()
A CRON expression in UTC specifying when Backup initiates a backup job.
public BackupRuleInput withScheduleExpression(String scheduleExpression)
A CRON expression in UTC specifying when Backup initiates a backup job.
scheduleExpression - A CRON expression in UTC specifying when Backup initiates a backup job.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. 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. 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. 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 BackupRuleInput 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. 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. 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 setCompletionWindowMinutes(Long completionWindowMinutes)
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.
completionWindowMinutes - A value in minutes after a backup job is successfully started before it must be completed or it will be
canceled by Backup. This value is optional.public Long getCompletionWindowMinutes()
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.
public BackupRuleInput withCompletionWindowMinutes(Long completionWindowMinutes)
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.
completionWindowMinutes - A value in minutes after a backup job is successfully started before it must be completed or it will be
canceled by Backup. This value is optional.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 BackupRuleInput 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 BackupRuleInput 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 BackupRuleInput addRecoveryPointTagsEntry(String key, String value)
public BackupRuleInput clearRecoveryPointTagsEntries()
public List<CopyAction> getCopyActions()
An array of CopyAction objects, which contains the details of the copy operation.
CopyAction objects, which contains the details of the copy operation.public void setCopyActions(Collection<CopyAction> copyActions)
An array of CopyAction objects, which contains the details of the copy operation.
copyActions - An array of CopyAction objects, which contains the details of the copy operation.public BackupRuleInput withCopyActions(CopyAction... copyActions)
An array of CopyAction objects, which contains the details of the copy operation.
NOTE: This method appends the values to the existing list (if any). Use
setCopyActions(java.util.Collection) or withCopyActions(java.util.Collection) if you want to
override the existing values.
copyActions - An array of CopyAction objects, which contains the details of the copy operation.public BackupRuleInput withCopyActions(Collection<CopyAction> copyActions)
An array of CopyAction objects, which contains the details of the copy operation.
copyActions - An array of CopyAction objects, which contains the details of the copy operation.public void setEnableContinuousBackup(Boolean enableContinuousBackup)
Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.
enableContinuousBackup - Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups
capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot
backups.public Boolean getEnableContinuousBackup()
Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.
public BackupRuleInput withEnableContinuousBackup(Boolean enableContinuousBackup)
Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.
enableContinuousBackup - Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups
capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot
backups.public Boolean isEnableContinuousBackup()
Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.
public void setScheduleExpressionTimezone(String scheduleExpressionTimezone)
This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
scheduleExpressionTimezone - This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC.
You can modify this to a specified timezone.public String getScheduleExpressionTimezone()
This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
public BackupRuleInput withScheduleExpressionTimezone(String scheduleExpressionTimezone)
This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
scheduleExpressionTimezone - This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC.
You can modify this to a specified timezone.public String toString()
toString in class ObjectObject.toString()public BackupRuleInput clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.