This is an archive version of the document. To get the most up-to-date information, see the current version.

DiskBulkRestoreOptions

The following properties and subschemas represent the DiskBulkRestoreOptions JSON schema.

DiskBulkRestoreOptions

Property

Required/Optional

Type

Description

reason

Optional

string

Specifies a reason of a restore operation.

amazonAccountId

Optional

string($uuid)

[Applies if you use an IAM role to perform the restore operation] Specifies a system ID assigned to the IAM role in the Veeam Backup for AWS REST API.

accessKey

Optional

string

[Applies if you use access and secret keys to perform the restore operation] Specifies the access key of the AWS account.

secretKey

Optional

string

[Applies if you use access and secret keys to perform the restore operation] Specifies the secret key of the AWS account.

volumes

Required

DiskRestoreOptions

Specifies volume restore settings.

toAlternative

Optional

DiskBulkRestoreToAlternativeOptions

[Applies if you want to restore to a new location or with different settings] Specifies volume restore settings.

DiskBulkRestoreOptionsDiskRestoreOptions

Property

Required/Optional

Type

Description

diskId

Required

string

Specifies an ID of a volume that must be restored.

name

Optional

string

Specifies a name for the restored volume.

DiskBulkRestoreOptionsDiskBulkRestoreToAlternativeOptions

Property

Required/Optional

Type

Description

availabilityZoneId

Required

string($uuid)

Specifies a system ID assigned in the Veeam Backup for AWS REST API to the target Availability Zone for the restored EBS volumes.

preserveEncryptionForVolumes

Required

boolean

Defines whether to keep existing EBS volume encryption.

encryptionKeyId

Optional

string

[Applies only if you specified not to keep existing EBS volume encryption] Specifies AWS Key Management Service (AWS KMS) customer master keys (CMK).

Note: you can encrypt volumes only with the following CMKs:

  • CMKs that are stored in the AWS region that you specified.
  • CMKs on which the IAM role or IAM user whose access keys you specified have permissions.