Interface BackupRule.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<BackupRule.Builder,
,BackupRule> SdkBuilder<BackupRule.Builder,
,BackupRule> SdkPojo
- Enclosing class:
BackupRule
-
Method Summary
Modifier and TypeMethodDescriptioncompletionWindowMinutes
(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.copyActions
(Collection<CopyAction> copyActions) An array ofCopyAction
objects, which contains the details of the copy operation.copyActions
(Consumer<CopyAction.Builder>... copyActions) An array ofCopyAction
objects, which contains the details of the copy operation.copyActions
(CopyAction... copyActions) An array ofCopyAction
objects, which contains the details of the copy operation.enableContinuousBackup
(Boolean enableContinuousBackup) Specifies whether 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.The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.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.Uniquely identifies a rule that is used to schedule the backup of a selection of resources.A display name for a backup rule.scheduleExpression
(String scheduleExpression) A cron expression in UTC specifying when Backup initiates a backup job.scheduleExpressionTimezone
(String scheduleExpressionTimezone) This is the timezone in which the schedule expression is set.startWindowMinutes
(Long startWindowMinutes) A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.targetBackupVaultName
(String targetBackupVaultName) The name of a logical container where backups are stored.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
-
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.
-
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) and0 12 * * ? *
(take a backup every day at 12 noon UTC). For a table of examples, click the preceding link and scroll down the page.- Parameters:
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 are15 * ? * * *
(take a backup every hour at 15 minutes past the hour) and0 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:
- Returns a reference to this object so that method calls can be chained together.
-
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 toRUNNING
) or until the job status changes toEXPIRED
(which is expected to occur when the start window time is over).- 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. 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 toRUNNING
) or until the job status changes toEXPIRED
(which is expected to occur when the start window time is over).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theLifecycle.Builder
avoiding the need to create one manually viaLifecycle.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolifecycle(Lifecycle)
.- Parameters:
lifecycle
- a consumer that will call methods onLifecycle.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
An array of
CopyAction
objects, which contains the details of the copy operation.- Parameters:
copyActions
- An array ofCopyAction
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
An array of
CopyAction
objects, which contains the details of the copy operation.- Parameters:
copyActions
- An array ofCopyAction
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
An array of
This is a convenience method that creates an instance of theCopyAction
objects, which contains the details of the copy operation.CopyAction.Builder
avoiding the need to create one manually viaCopyAction.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocopyActions(List<CopyAction>)
.- Parameters:
copyActions
- a consumer that will call methods onCopyAction.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
scheduleExpressionTimezone
This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
- Parameters:
scheduleExpressionTimezone
- This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-