Package software.amazon.awssdk.services.backup.model

Interface BackupRuleInput.Builder

All Superinterfaces:
Buildable, CopyableBuilder<BackupRuleInput.Builder,BackupRuleInput>, SdkBuilder<BackupRuleInput.Builder,BackupRuleInput>, SdkPojo
Enclosing class:
BackupRuleInput
public static interface BackupRuleInput.Builder extends SdkPojo, CopyableBuilder<BackupRuleInput.Builder,BackupRuleInput>

  • Method Details

    • ruleName

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

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

      BackupRuleInput.Builder scheduleExpression(String 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.

    • startWindowMinutes

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

      This parameter has a maximum value of 100 years (52,560,000 minutes).

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

      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.

      This parameter has a maximum value of 100 years (52,560,000 minutes).

      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:
      Returns a reference to this object so that method calls can be chained together.

    • completionWindowMinutes

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

      BackupRuleInput.Builder lifecycle(Lifecycle lifecycle)

      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 “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 parameter has a maximum value of 100 years (36,500 days).

      Parameters:
      lifecycle - The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 “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 parameter has a maximum value of 100 years (36,500 days).

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

    • lifecycle

      default BackupRuleInput.Builder lifecycle(Consumer<Lifecycle.Builder> lifecycle)

      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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 “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 parameter has a maximum value of 100 years (36,500 days).

      This is a convenience method 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:

    • recoveryPointTags

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

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • copyActions

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

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

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

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

      This is a convenience method that creates an instance of the CopyAction.Builder avoiding the need to create one manually via CopyAction.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to copyActions(List<CopyAction>).

      Parameters:
      copyActions - a consumer that will call methods on CopyAction.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • enableContinuousBackup

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

      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

      BackupRuleInput.Builder scheduleExpressionTimezone(String 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.