StartBackupJob#

Description#

Request to create a backup task.

Request Parameters#

Required parameters#

  • BackupVaultName — The name of the backup vault.

    • Type: String

    • Required: Yes

  • IamRoleArn — The Amazon Resource Name (ARN) of the role used for authentication when the resource is backed up (not implemented, added to ensure compatibility with AWS).

    • Type: String

    • Required: Yes

  • ResourceArn — The Amazon Resource Name (ARN) of the resource that is to be backed up.

    • Type: String

    • Required: Yes

Optional parameters#

  • CompleteWindowMinutes — Time in minutes after the start of the backup job, during which it should be completed . Otherwise, it will be canceled.

    • Type: Integer

    • Required: No

  • Lifecycle.DeleteAfterDays — Number of days from the recovery point creation date, after which it will be deleted.

    • Type: Integer

    • Required: No

  • StartWindowMinutes — Time in minutes during which a backup job should start running. Otherwise the job will be cancelled.

    • Type: Integer

    • Required: No

Response Elements#

  • BackupJobId — The backup job ID.

    • Type: String

  • CreationDate — The time when the backup job was created.

    • Type: Timestamp

Examples#

c2-bs StartBackupJob BackupVaultName Default ResourceArn arn:c2:ec2::my_project@my_customer:instance/i-00000000 IamRoleArn ""

c2-bs StartBackupJob BackupVaultName Default ResourceArn arn:c2:ec2::my_project@my_customer:instance/i-00000000 IamRoleArn "" Lifecycle.DeleteAfterDays 3 StartWindowMinutes 120