BackupRuleInput (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.backup.model.BackupRuleInput

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<BackupRuleInput.Builder,BackupRuleInput>

@Generated(value="software.amazon.awssdk:codegen")
public final class BackupRuleInput
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BackupRuleInput.Builder,BackupRuleInput>

Specifies a scheduled task used to back up a selection of resources.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface BackupRuleInput.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`BackupRuleInput.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static BackupRuleInput.Builder`	`builder()`
`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.
`List<CopyAction>`	`copyActions()` An array of `CopyAction` objects, which contains the details of the copy operation.
`Boolean`	`enableContinuousBackup()` Specifies whether AWS Backup creates continuous backups.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCopyActions()` Returns true if the CopyActions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasRecoveryPointTags()` Returns true if the RecoveryPointTags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`Lifecycle`	`lifecycle()` The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
`Map<String,String>`	`recoveryPointTags()` To help organize your resources, you can assign your own metadata to the resources that you create.
`String`	`ruleName()` An optional display name for a backup rule.
`String`	`scheduleExpression()` A CRON expression specifying when AWS Backup initiates a backup job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends BackupRuleInput.Builder>`	`serializableBuilderClass()`
`Long`	`startWindowMinutes()` A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.
`String`	`targetBackupVaultName()` The name of a logical container where backups are stored.
`BackupRuleInput.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - ruleName
```
public final String ruleName()
```
    An optional display name for a backup rule.
    
    Returns:
    
    An optional display name for a backup rule.
  - targetBackupVaultName
```
public final 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.
    
    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.
  - scheduleExpression
```
public final String scheduleExpression()
```
    A CRON expression specifying when AWS Backup initiates a backup job.
    
    Returns:
    
    A CRON expression specifying when AWS Backup initiates a backup job.
  - startWindowMinutes
```
public final 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.
    
    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.
  - completionWindowMinutes
```
public final 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.
    
    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.
  - lifecycle
```
public final 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.
    
    Only Amazon EFS file system backups can be transitioned to cold storage.
    
    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.
    
    Only Amazon EFS file system backups can be transitioned to cold storage.
  - hasRecoveryPointTags
```
public final boolean hasRecoveryPointTags()
```
    Returns true if the RecoveryPointTags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - recoveryPointTags
```
public final 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasRecoveryPointTags() to see if a value was sent in this field.
    
    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.
  - hasCopyActions
```
public final boolean hasCopyActions()
```
    Returns true if the CopyActions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - copyActions
```
public final List<CopyAction> copyActions()
```
    An array of CopyAction objects, which contains the details of the copy operation.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasCopyActions() to see if a value was sent in this field.
    
    Returns:
    
    An array of CopyAction objects, which contains the details of the copy operation.
  - enableContinuousBackup
```
public final Boolean enableContinuousBackup()
```
    Specifies whether AWS Backup creates continuous backups. True causes AWS Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes AWS Backup to create snapshot backups.
    
    Returns:
    
    Specifies whether AWS Backup creates continuous backups. True causes AWS Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes AWS Backup to create snapshot backups.
  - toBuilder
```
public BackupRuleInput.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<BackupRuleInput.Builder,BackupRuleInput>
  - builder
```
public static BackupRuleInput.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends BackupRuleInput.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class BackupRuleInput

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

ruleName

targetBackupVaultName

scheduleExpression

startWindowMinutes

completionWindowMinutes

lifecycle

hasRecoveryPointTags

recoveryPointTags

hasCopyActions

copyActions

enableContinuousBackup

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields