BackupRule (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.backup.model.BackupRule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BackupRule
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies a scheduled task used to back up a selection of resources.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

BackupRule()

Constructors
Constructor and Description
`BackupRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BackupRule`	`addRecoveryPointTagsEntry(String key, String value)` Add a single RecoveryPointTags entry
`BackupRule`	`clearRecoveryPointTagsEntries()` Removes all the entries added into RecoveryPointTags.
`BackupRule`	`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 AWS Backup.
`List<CopyAction>`	`getCopyActions()` An array of `CopyAction` objects, which contains the details of the copy operation.
`Lifecycle`	`getLifecycle()` The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
`Map<String,String>`	`getRecoveryPointTags()` An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.
`String`	`getRuleId()` Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
`String`	`getRuleName()` An optional display name for a backup rule.
`String`	`getScheduleExpression()` A CRON expression specifying when AWS Backup initiates a backup job.
`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()`
`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 AWS Backup.
`void`	`setCopyActions(Collection<CopyAction> copyActions)` An array of `CopyAction` objects, which contains the details of the copy operation.
`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)` An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.
`void`	`setRuleId(String ruleId)` Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
`void`	`setRuleName(String ruleName)` An optional display name for a backup rule.
`void`	`setScheduleExpression(String scheduleExpression)` A CRON expression specifying when AWS Backup initiates a backup job.
`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.
`BackupRule`	`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 AWS Backup.
`BackupRule`	`withCopyActions(Collection<CopyAction> copyActions)` An array of `CopyAction` objects, which contains the details of the copy operation.
`BackupRule`	`withCopyActions(CopyAction... copyActions)` An array of `CopyAction` objects, which contains the details of the copy operation.
`BackupRule`	`withLifecycle(Lifecycle lifecycle)` The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
`BackupRule`	`withRecoveryPointTags(Map<String,String> recoveryPointTags)` An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.
`BackupRule`	`withRuleId(String ruleId)` Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
`BackupRule`	`withRuleName(String ruleName)` An optional display name for a backup rule.
`BackupRule`	`withScheduleExpression(String scheduleExpression)` A CRON expression specifying when AWS Backup initiates a backup job.
`BackupRule`	`withStartWindowMinutes(Long startWindowMinutes)` A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.
`BackupRule`	`withTargetBackupVaultName(String targetBackupVaultName)` The name of a logical container where backups are stored.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BackupRule
```
public BackupRule()
```
- Method Detail
  - setRuleName
```
public void setRuleName(String ruleName)
```
    An optional display name for a backup rule.
    
    Parameters:
    
    ruleName - An optional display name for a backup rule.
  - getRuleName
```
public String getRuleName()
```
    An optional display name for a backup rule.
    
    Returns:
    
    An optional display name for a backup rule.
  - withRuleName
```
public BackupRule withRuleName(String ruleName)
```
    An optional display name for a backup rule.
    
    Parameters:
    
    ruleName - An optional display name for a backup rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargetBackupVaultName
```
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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    
    Parameters:
    
    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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
  - getTargetBackupVaultName
```
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 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.
  - withTargetBackupVaultName
```
public BackupRule 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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    
    Parameters:
    
    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 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.
  - setScheduleExpression
```
public void setScheduleExpression(String scheduleExpression)
```
    A CRON expression specifying when AWS Backup initiates a backup job.
    
    Parameters:
    
    scheduleExpression - A CRON expression specifying when AWS Backup initiates a backup job.
  - getScheduleExpression
```
public String getScheduleExpression()
```
    A CRON expression specifying when AWS Backup initiates a backup job.
    
    Returns:
    
    A CRON expression specifying when AWS Backup initiates a backup job.
  - withScheduleExpression
```
public BackupRule withScheduleExpression(String scheduleExpression)
```
    A CRON expression specifying when AWS Backup initiates a backup job.
    
    Parameters:
    
    scheduleExpression - A CRON expression specifying when AWS Backup initiates a backup job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartWindowMinutes
```
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.
    
    Parameters:
    
    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.
  - getStartWindowMinutes
```
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.
    
    Returns:
    
    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.
  - withStartWindowMinutes
```
public BackupRule 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCompletionWindowMinutes
```
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 AWS Backup. This value is optional.
    
    Parameters:
    
    completionWindowMinutes - A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by AWS Backup. This value is optional.
  - getCompletionWindowMinutes
```
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 AWS Backup. This value is optional.
    
    Returns:
    
    A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by AWS Backup. This value is optional.
  - withCompletionWindowMinutes
```
public BackupRule 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 AWS Backup. This value is optional.
    
    Parameters:
    
    completionWindowMinutes - A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by AWS Backup. This value is optional.
    
    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 transitions and expires 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 transitions and expires 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 transitions and expires 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 transitions and expires 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 BackupRule withLifecycle(Lifecycle lifecycle)
```
    The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires 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 transitions and expires 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()
```
    An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.
    
    Returns:
    
    An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.
  - setRecoveryPointTags
```
public void setRecoveryPointTags(Map<String,String> recoveryPointTags)
```
    An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.
    
    Parameters:
    
    recoveryPointTags - An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.
  - withRecoveryPointTags
```
public BackupRule withRecoveryPointTags(Map<String,String> recoveryPointTags)
```
    An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.
    
    Parameters:
    
    recoveryPointTags - An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addRecoveryPointTagsEntry
```
public BackupRule addRecoveryPointTagsEntry(String key,
                                            String value)
```
    Add a single RecoveryPointTags entry
    
    See Also:
    
    withRecoveryPointTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearRecoveryPointTagsEntries
```
public BackupRule clearRecoveryPointTagsEntries()
```
    Removes all the entries added into RecoveryPointTags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRuleId
```
public void setRuleId(String ruleId)
```
    Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
    
    Parameters:
    
    ruleId - Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
  - getRuleId
```
public String getRuleId()
```
    Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
    
    Returns:
    
    Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
  - withRuleId
```
public BackupRule withRuleId(String ruleId)
```
    Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
    
    Parameters:
    
    ruleId - Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCopyActions
```
public List<CopyAction> getCopyActions()
```
    An array of CopyAction objects, which contains the details of the copy operation.
    
    Returns:
    
    An array of CopyAction objects, which contains the details of the copy operation.
  - setCopyActions
```
public void setCopyActions(Collection<CopyAction> copyActions)
```
    An array of CopyAction objects, which contains the details of the copy operation.
    
    Parameters:
    
    copyActions - An array of CopyAction objects, which contains the details of the copy operation.
  - withCopyActions
```
public BackupRule 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.
    
    Parameters:
    
    copyActions - An array of CopyAction objects, which contains the details of the copy operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCopyActions
```
public BackupRule withCopyActions(Collection<CopyAction> copyActions)
```
    An array of CopyAction objects, which contains the details of the copy operation.
    
    Parameters:
    
    copyActions - An array of CopyAction objects, which contains the details of the copy operation.
    
    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 BackupRule clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class BackupRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BackupRule

Method Detail

setRuleName

getRuleName

withRuleName

setTargetBackupVaultName

getTargetBackupVaultName

withTargetBackupVaultName

setScheduleExpression

getScheduleExpression

withScheduleExpression

setStartWindowMinutes

getStartWindowMinutes

withStartWindowMinutes

setCompletionWindowMinutes

getCompletionWindowMinutes

withCompletionWindowMinutes

setLifecycle

getLifecycle

withLifecycle

getRecoveryPointTags

setRecoveryPointTags

withRecoveryPointTags

addRecoveryPointTagsEntry

clearRecoveryPointTagsEntries

setRuleId

getRuleId

withRuleId

getCopyActions

setCopyActions

withCopyActions

withCopyActions

toString

equals

hashCode

clone

marshall