software.amazon.awssdk.services.backup.model

Class BackupRule

java.lang.Object

software.amazon.awssdk.services.backup.model.BackupRule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BackupRule.Builder,BackupRule>

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

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

Method Summary

Modifier and Type	Method and Description
static BackupRule.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 Backup.
List<CopyAction>	copyActions() An array of CopyAction objects, which contains the details of the copy operation.
Boolean	enableContinuousBackup() Specifies whether Backup creates continuous backups.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCopyActions() For responses, this returns true if the service returned a value for the CopyActions property.
int	hashCode()
boolean	hasRecoveryPointTags() For responses, this returns true if the service returned a value for the RecoveryPointTags property.
Lifecycle	lifecycle() The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
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.
String	ruleId() Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
String	ruleName() A display name for a backup rule.
String	scheduleExpression() A cron expression in UTC specifying when Backup initiates a backup job.
List<SdkField<?>>	sdkFields()
static Class<? extends BackupRule.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.
BackupRule.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()

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.

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

scheduleExpression

public final String scheduleExpression()

A cron expression in UTC specifying when Backup initiates a backup job. For more information about Amazon Web Services cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Two examples of Amazon Web Services cron expressions are 15 * ? * * * (take a backup every hour at 15 minutes past the hour) and 0 12 * * ? * (take a backup every day at 12 noon UTC). For a table of examples, click the preceding link and scroll down the page.

Returns:

A cron expression in UTC specifying when Backup initiates a backup job. For more information about Amazon Web Services cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Two examples of Amazon Web Services cron expressions are 15 * ? * * * (take a backup every hour at 15 minutes past the hour) and 0 12 * * ? * (take a backup every day at 12 noon UTC). For a table of examples, click the preceding link and scroll down the page.

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. If this value is included, it must be at least 60 minutes to avoid errors.

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

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. If this value is included, it must be at least 60 minutes to avoid errors.

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

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

lifecycle

public final Lifecycle lifecycle()

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 “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.

Returns:

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 “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.

hasRecoveryPointTags

public final boolean hasRecoveryPointTags()

For responses, this returns true if the service returned a value for the RecoveryPointTags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

recoveryPointTags

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRecoveryPointTags() method.

Returns:

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

ruleId

public final String ruleId()

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.

hasCopyActions

public final boolean hasCopyActions()

For responses, this returns true if the service returned a value for the CopyActions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCopyActions() method.

Returns:

An array of CopyAction objects, which contains the details of the copy operation.

enableContinuousBackup

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

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.

toBuilder

public BackupRule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BackupRule.Builder,BackupRule>

builder

public static BackupRule.Builder builder()

serializableBuilderClass

public static Class<? extends BackupRule.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