Create Backup Plan

backup_create_backup_plan

R Documentation

Creates a backup plan using a backup plan name and backup rules

Description

Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains information that Backup uses to schedule tasks that create recovery points for resources.

If you call create_backup_plan with a plan that already exists, you receive an AlreadyExistsException exception.

Usage

backup_create_backup_plan(BackupPlan, BackupPlanTags, CreatorRequestId)

Arguments

BackupPlan

[required] The body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

BackupPlanTags

The tags to assign to the backup plan.

CreatorRequestId

Identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

Value

A list with the following syntax:

list(
  BackupPlanId = "string",
  BackupPlanArn = "string",
  CreationDate = as.POSIXct(
    "2015-01-01"
  ),
  VersionId = "string",
  AdvancedBackupSettings = list(
    list(
      ResourceType = "string",
      BackupOptions = list(
        "string"
      )
    )
  )
)

Request syntax

svc$create_backup_plan(
  BackupPlan = list(
    BackupPlanName = "string",
    Rules = list(
      list(
        RuleName = "string",
        TargetBackupVaultName = "string",
        ScheduleExpression = "string",
        StartWindowMinutes = 123,
        CompletionWindowMinutes = 123,
        Lifecycle = list(
          MoveToColdStorageAfterDays = 123,
          DeleteAfterDays = 123,
          OptInToArchiveForSupportedResources = TRUE|FALSE
        ),
        RecoveryPointTags = list(
          "string"
        ),
        CopyActions = list(
          list(
            Lifecycle = list(
              MoveToColdStorageAfterDays = 123,
              DeleteAfterDays = 123,
              OptInToArchiveForSupportedResources = TRUE|FALSE
            ),
            DestinationBackupVaultArn = "string"
          )
        ),
        EnableContinuousBackup = TRUE|FALSE,
        ScheduleExpressionTimezone = "string"
      )
    ),
    AdvancedBackupSettings = list(
      list(
        ResourceType = "string",
        BackupOptions = list(
          "string"
        )
      )
    )
  ),
  BackupPlanTags = list(
    "string"
  ),
  CreatorRequestId = "string"
)