backup_create_backup_plan: Creates a backup plan using a backup plan name and backup...

Description Usage Arguments Value Request syntax

View source: R/backup_operations.R

Description

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

If you call create_backup_plan with a plan that already exists, an AlreadyExistsException is returned.

Usage

1
backup_create_backup_plan(BackupPlan, BackupPlanTags, CreatorRequestId)

Arguments

BackupPlan

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

BackupPlanTags

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this 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.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
list(
  BackupPlanId = "string",
  BackupPlanArn = "string",
  CreationDate = as.POSIXct(
    "2015-01-01"
  ),
  VersionId = "string",
  AdvancedBackupSettings = list(
    list(
      ResourceType = "string",
      BackupOptions = list(
        "string"
      )
    )
  )
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
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
        ),
        RecoveryPointTags = list(
          "string"
        ),
        CopyActions = list(
          list(
            Lifecycle = list(
              MoveToColdStorageAfterDays = 123,
              DeleteAfterDays = 123
            ),
            DestinationBackupVaultArn = "string"
          )
        )
      )
    ),
    AdvancedBackupSettings = list(
      list(
        ResourceType = "string",
        BackupOptions = list(
          "string"
        )
      )
    )
  ),
  BackupPlanTags = list(
    "string"
  ),
  CreatorRequestId = "string"
)

paws.storage documentation built on March 7, 2021, 5:07 p.m.