software.amazon.awssdk.services.backup.model

Interface BackupRule.Builder

All Superinterfaces:

Buildable, CopyableBuilder<BackupRule.Builder,BackupRule>, SdkBuilder<BackupRule.Builder,BackupRule>, SdkPojo

Enclosing class:

BackupRule

public static interface BackupRule.Builder
extends SdkPojo, CopyableBuilder<BackupRule.Builder,BackupRule>

Method Summary

Modifier and Type	Method and Description
BackupRule.Builder	completionWindowMinutes(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.Builder	copyActions(Collection<CopyAction> copyActions) An array of CopyAction objects, which contains the details of the copy operation.
BackupRule.Builder	copyActions(Consumer<CopyAction.Builder>... copyActions) An array of CopyAction objects, which contains the details of the copy operation.
BackupRule.Builder	copyActions(CopyAction... copyActions) An array of CopyAction objects, which contains the details of the copy operation.
BackupRule.Builder	enableContinuousBackup(Boolean enableContinuousBackup) Specifies whether AWS Backup creates continuous backups.
default BackupRule.Builder	lifecycle(Consumer<Lifecycle.Builder> lifecycle) The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
BackupRule.Builder	lifecycle(Lifecycle lifecycle) The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
BackupRule.Builder	recoveryPointTags(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.Builder	ruleId(String ruleId) Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
BackupRule.Builder	ruleName(String ruleName) An optional display name for a backup rule.
BackupRule.Builder	scheduleExpression(String scheduleExpression) A CRON expression specifying when AWS Backup initiates a backup job.
BackupRule.Builder	startWindowMinutes(Long startWindowMinutes) A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.
BackupRule.Builder	targetBackupVaultName(String targetBackupVaultName) The name of a logical container where backups are stored.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

ruleName

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

targetBackupVaultName

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

scheduleExpression

BackupRule.Builder scheduleExpression(String scheduleExpression)

A CRON expression specifying when AWS Backup initiates a backup job. For more information about cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Prior to specifying a value for this parameter, we recommend testing your cron expression using one of the many available cron generator and testing tools.

Parameters:

scheduleExpression - A CRON expression specifying when AWS Backup initiates a backup job. For more information about cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Prior to specifying a value for this parameter, we recommend testing your cron expression using one of the many available cron generator and testing tools.

Returns:

Returns a reference to this object so that method calls can be chained together.

startWindowMinutes

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

completionWindowMinutes

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

lifecycle

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

Only Amazon EFS file system backups can be transitioned to cold storage.

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.

Only Amazon EFS file system backups can be transitioned to cold storage.

Returns:

Returns a reference to this object so that method calls can be chained together.

lifecycle

default BackupRule.Builder lifecycle(Consumer<Lifecycle.Builder> 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.

Only Amazon EFS file system backups can be transitioned to cold storage.

This is a convenience that creates an instance of the Lifecycle.Builder avoiding the need to create one manually via Lifecycle.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lifecycle(Lifecycle).

Parameters:

lifecycle - a consumer that will call methods on Lifecycle.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

lifecycle(Lifecycle)

recoveryPointTags

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

ruleId

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

copyActions

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

copyActions

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

copyActions

BackupRule.Builder copyActions(Consumer<CopyAction.Builder>... copyActions)

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #copyActions(List).

Parameters:

copyActions - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#copyActions(List)

enableContinuousBackup

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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.