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

VirtualMachineRestoreOptions

The following properties and subschemas represent the VirtualMachineRestoreOptions JSON schema.

VirtualMachineRestoreOptions

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.
startInstance	Required	boolean	Defines whether to start the restored EC2 instance after the restore operation is completed.
toAlternative	Optional	VirtualMachineToAlternativeRestoreOptions	[Applies if you want to restore to a new location or with different settings] Specifies restore settings.

VirtualMachineToAlternativeRestoreOptions

Property	Required/Optional	Type	Description
name	Required	string	Specifies a name for the restored EC2 instance.
regionId	Required	string($uuid)	Specifies a system ID assigned in the Veeam Backup for AWS REST API to the target AWS region for the restored EC2 instance.
vmType	Required	string	Specifies a type for the restored EC2 instance.
subnetId	Required	string	AWS ID of a subnet to which the restored EC2 instance must be connected.
networkSecurityGroupId	Required	string	AWS ID of a security group to which the restored EC2 instance must be connected.
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 key (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.