Get Backup Plan From Template

backup_get_backup_plan_from_template

R Documentation

Returns the template specified by its templateId as a backup plan

Description

Returns the template specified by its templateId as a backup plan.

Usage

backup_get_backup_plan_from_template(BackupPlanTemplateId)

Arguments

BackupPlanTemplateId

[required] Uniquely identifies a stored backup plan template.

Value

A list with the following syntax:

list(
  BackupPlanDocument = 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"
        ),
        RuleId = "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"
        )
      )
    )
  )
)

Request syntax

svc$get_backup_plan_from_template(
  BackupPlanTemplateId = "string"
)