CreateBackupPlanCommand

Use a bare-bones client and the command you need to make an API call.

CreateBackupPlanCommandInput

[CreateBackupPlanCommandInput](@aws-sdk/client-backup!CreateBackupPlanCommandInput:Interface)

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 <code>CreateBackupPlan</code> with a plan that already exists, you receive an <code>AlreadyExistsException</code> exception.

BackupPlan

The body of a backup plan. Includes a <code>BackupPlanName</code> and one or more sets of <code>Rules</code>.

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 <code>CreatorRequestId</code> 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.

The input for [CreateBackupPlanCommand](@aws-sdk/client-backup!CreateBackupPlanCommand:Class).

$metadata

AdvancedBackupSettings

The settings for a resource type. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

BackupPlanArn

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

BackupPlanId

CreationDate

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

VersionId

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

CreateBackupPlanCommandOutput

The output of [CreateBackupPlanCommand](@aws-sdk/client-backup!CreateBackupPlanCommand:Class).

$fault

$response

$retryable

(constructor)

options

Constructs a new instance of the <code>ServiceException</code> class

Code

Context

Message

Type

[Symbol.hasInstance]

instance

Custom instanceof check to support the operator for ServiceException base class

isInstance

value

Checks if a value is an instance of ServiceException (duck typed)

name

AlreadyExistsException

The required resource already exists.

InvalidParameterValueException

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

LimitExceededException

A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.

MissingParameterValueException

Indicates that a required parameter is missing.

ServiceUnavailableException

The request failed due to a temporary failure of the server.

BackupServiceException

Base exception class for all service exceptions from Backup service.