[ aws . backup ]

update-backup-plan

Description

Replaces the body of a saved backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-backup-plan
--backup-plan-id <value>
--backup-plan <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--backup-plan-id (string)

Uniquely identifies a backup plan.

--backup-plan (structure)

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

BackupPlanName -> (string)

The optional display name of a backup plan.

Rules -> (list)

An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

(structure)

Specifies a scheduled task used to back up a selection of resources.

RuleName -> (string)

An optional display name for a backup rule.

TargetBackupVaultName -> (string)

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 lowercase letters, numbers, and hyphens.

ScheduleExpression -> (string)

A CRON expression specifying when AWS Backup initiates a backup job.

StartWindowMinutes -> (long)

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.

CompletionWindowMinutes -> (long)

A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by AWS Backup. This value is optional.

Lifecycle -> (structure)

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS 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 “expire after days” 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.

MoveToColdStorageAfterDays -> (long)

Specifies the number of days after creation that a recovery point is moved to cold storage.

DeleteAfterDays -> (long)

Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays .

RecoveryPointTags -> (map)

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

key -> (string)

value -> (string)

CopyActions -> (list)

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

(structure)

The details of the copy operation.

Lifecycle -> (structure)

Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “expire after days” 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.

MoveToColdStorageAfterDays -> (long)

Specifies the number of days after creation that a recovery point is moved to cold storage.

DeleteAfterDays -> (long)

Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays .

DestinationBackupVaultArn -> (string)

An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. For example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault .

JSON Syntax:

{
  "BackupPlanName": "string",
  "Rules": [
    {
      "RuleName": "string",
      "TargetBackupVaultName": "string",
      "ScheduleExpression": "string",
      "StartWindowMinutes": long,
      "CompletionWindowMinutes": long,
      "Lifecycle": {
        "MoveToColdStorageAfterDays": long,
        "DeleteAfterDays": long
      },
      "RecoveryPointTags": {"string": "string"
        ...},
      "CopyActions": [
        {
          "Lifecycle": {
            "MoveToColdStorageAfterDays": long,
            "DeleteAfterDays": long
          },
          "DestinationBackupVaultArn": "string"
        }
        ...
      ]
    }
    ...
  ]
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

BackupPlanId -> (string)

Uniquely identifies a backup plan.

BackupPlanArn -> (string)

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50 .

CreationDate -> (timestamp)

The date and time a backup plan is updated, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

VersionId -> (string)

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.