Interface AwsBackupBackupPlanRuleDetails.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AwsBackupBackupPlanRuleDetails.Builder,
,AwsBackupBackupPlanRuleDetails> SdkBuilder<AwsBackupBackupPlanRuleDetails.Builder,
,AwsBackupBackupPlanRuleDetails> SdkPojo
- Enclosing class:
AwsBackupBackupPlanRuleDetails
-
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 is canceled by Backup.copyActions
(Collection<AwsBackupBackupPlanRuleCopyActionsDetails> copyActions) An array ofCopyAction
objects, each of which contains details of the copy operation.copyActions
(Consumer<AwsBackupBackupPlanRuleCopyActionsDetails.Builder>... copyActions) An array ofCopyAction
objects, each of which contains details of the copy operation.copyActions
(AwsBackupBackupPlanRuleCopyActionsDetails... copyActions) An array ofCopyAction
objects, each of which contains details of the copy operation.enableContinuousBackup
(Boolean enableContinuousBackup) Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).Defines when a protected resource is transitioned to cold storage and when it expires.lifecycle
(AwsBackupBackupPlanLifecycleDetails lifecycle) Defines when a protected resource is transitioned to cold storage and when it expires.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.startWindowMinutes
(Long startWindowMinutes) A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.targetBackupVault
(String targetBackupVault) 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
-
targetBackupVault
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.
- Parameters:
targetBackupVault
- The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.- 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.
- Parameters:
startWindowMinutes
- A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.- 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.
- 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.
-
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.
-
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.
-
enableContinuousBackup
Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).
- Parameters:
enableContinuousBackup
- Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).- 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 is canceled by Backup.
- Parameters:
completionWindowMinutes
- A value in minutes after a backup job is successfully started before it must be completed, or it is canceled by Backup.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
copyActions
AwsBackupBackupPlanRuleDetails.Builder copyActions(Collection<AwsBackupBackupPlanRuleCopyActionsDetails> copyActions) An array of
CopyAction
objects, each of which contains details of the copy operation.- Parameters:
copyActions
- An array ofCopyAction
objects, each of which contains details of the copy operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
copyActions
AwsBackupBackupPlanRuleDetails.Builder copyActions(AwsBackupBackupPlanRuleCopyActionsDetails... copyActions) An array of
CopyAction
objects, each of which contains details of the copy operation.- Parameters:
copyActions
- An array ofCopyAction
objects, each of which contains details of the copy operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
copyActions
AwsBackupBackupPlanRuleDetails.Builder copyActions(Consumer<AwsBackupBackupPlanRuleCopyActionsDetails.Builder>... copyActions) An array of
This is a convenience method that creates an instance of theCopyAction
objects, each of which contains details of the copy operation.AwsBackupBackupPlanRuleCopyActionsDetails.Builder
avoiding the need to create one manually viaAwsBackupBackupPlanRuleCopyActionsDetails.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocopyActions(List<AwsBackupBackupPlanRuleCopyActionsDetails>)
.- Parameters:
copyActions
- a consumer that will call methods onAwsBackupBackupPlanRuleCopyActionsDetails.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.
- Parameters:
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. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lifecycle
default AwsBackupBackupPlanRuleDetails.Builder lifecycle(Consumer<AwsBackupBackupPlanLifecycleDetails.Builder> 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. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.
This is a convenience method that creates an instance of theAwsBackupBackupPlanLifecycleDetails.Builder
avoiding the need to create one manually viaAwsBackupBackupPlanLifecycleDetails.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolifecycle(AwsBackupBackupPlanLifecycleDetails)
.- Parameters:
lifecycle
- a consumer that will call methods onAwsBackupBackupPlanLifecycleDetails.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-