Interface CfnBackupPlan.BackupRuleResourceTypeProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnBackupPlan.BackupRuleResourceTypeProperty extends
Specifies an object containing properties used to schedule a task to back up a selection of resources.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 BackupRuleResourceTypeProperty backupRuleResourceTypeProperty = BackupRuleResourceTypeProperty.builder()
         // the properties below are optional
                 // the properties below are optional
                 "recoveryPointTagsKey", "recoveryPointTags"))
  • Method Details

    • getRuleName

      @Stability(Stable) @NotNull String getRuleName()
      A display name for a backup rule.
    • getTargetBackupVault

      @Stability(Stable) @NotNull String getTargetBackupVault()
      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 letters, numbers, and hyphens.

    • getCompletionWindowMinutes

      @Stability(Stable) @Nullable default Number getCompletionWindowMinutes()
      A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup .
    • getCopyActions

      @Stability(Stable) @Nullable default Object getCopyActions()
      An array of CopyAction objects, which contains the details of the copy operation.
    • getEnableContinuousBackup

      @Stability(Stable) @Nullable default Object getEnableContinuousBackup()
      Enables continuous backup and point-in-time restores (PITR).
    • getLifecycle

      @Stability(Stable) @Nullable default Object getLifecycle()
      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.

    • getRecoveryPointTags

      @Stability(Stable) @Nullable default Object getRecoveryPointTags()
      To help organize your resources, you can assign your own metadata to the resources that you create.

      Each tag is a key-value pair.

    • getScheduleExpression

      @Stability(Stable) @Nullable default String getScheduleExpression()
      A CRON expression specifying when AWS Backup initiates a backup job.
    • getStartWindowMinutes

      @Stability(Stable) @Nullable default Number getStartWindowMinutes()
      An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully.

      If this value is included, it must be at least 60 minutes to avoid errors.

    • builder

      @Stability(Stable) static CfnBackupPlan.BackupRuleResourceTypeProperty.Builder builder()
      a CfnBackupPlan.BackupRuleResourceTypeProperty.Builder of CfnBackupPlan.BackupRuleResourceTypeProperty