BackupRuleInput (AWS Java SDK for AWS Backup 1.12.170 API)

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

BackupRuleInput()

Constructors
Constructor and Description
`BackupRuleInput()`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`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)`
`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`	`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`	`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.

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

- Constructor Detail
  - BackupRuleInput
```
public BackupRuleInput()
```
- Method Detail
  - setRuleName
```
public void setRuleName(String ruleName)
```
    A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
    
    Parameters:
    
    ruleName - A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
  - getRuleName
```
public String getRuleName()
```
    A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
    
    Returns:
    
    A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
  - withRuleName
```
public BackupRuleInput withRuleName(String ruleName)
```
    A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
    
    Parameters:
    
    ruleName - A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
    
    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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
  - withTargetBackupVaultName
```
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.
    
    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 Amazon Web Services 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 in UTC specifying when Backup initiates a backup job.
    
    Parameters:
    
    scheduleExpression - A CRON expression in UTC specifying when Backup initiates a backup job.
  - getScheduleExpression
```
public String getScheduleExpression()
```
    A CRON expression in UTC specifying when Backup initiates a backup job.
    
    Returns:
    
    A CRON expression in UTC specifying when Backup initiates a backup job.
  - withScheduleExpression
```
public BackupRuleInput withScheduleExpression(String scheduleExpression)
```
    A CRON expression in UTC specifying when Backup initiates a backup job.
    
    Parameters:
    
    scheduleExpression - A CRON expression in UTC specifying when 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 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.
    
    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 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 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 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 Backup. This value is optional.
  - withCompletionWindowMinutes
```
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.
    
    Parameters:
    
    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.
    
    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. 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.
    
    Only resource types that support full Backup management can transition their backups to cold storage. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
    
    Parameters:
    
    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.
    
    Only resource types that support full Backup management can transition their backups to cold storage. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
  - getLifecycle
```
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.
    
    Only resource types that support full Backup management can transition their backups to cold storage. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
    
    Returns:
    
    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.
    
    Only resource types that support full Backup management can transition their backups to cold storage. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
  - withLifecycle
```
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.
    
    Only resource types that support full Backup management can transition their backups to cold storage. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
    
    Parameters:
    
    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.
    
    Only resource types that support full Backup management can transition their backups to cold storage. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
    
    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 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.
    
    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 BackupRuleInput addRecoveryPointTagsEntry(String key,
                                                 String value)
```
    Add a single RecoveryPointTags entry
    
    See Also:
    
    withRecoveryPointTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearRecoveryPointTagsEntries
```
public BackupRuleInput clearRecoveryPointTagsEntries()
```
    Removes all the entries added into RecoveryPointTags.
    
    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 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.
    
    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 BackupRuleInput 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.
  - setEnableContinuousBackup
```
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.
    
    Parameters:
    
    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.
  - getEnableContinuousBackup
```
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.
    
    Returns:
    
    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.
  - withEnableContinuousBackup
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnableContinuousBackup
```
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.
    
    Returns:
    
    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.
  - 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 BackupRuleInput clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class BackupRuleInput

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BackupRuleInput

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

getCopyActions

setCopyActions

withCopyActions

withCopyActions

setEnableContinuousBackup

getEnableContinuousBackup

withEnableContinuousBackup

isEnableContinuousBackup

toString

equals

hashCode

clone

marshall