New-VBRAmazonEC2DiskConfiguration

Short Description

Creates storage volume settings for Amazon EC2 instances.

Applies to

Platform: VMware, Hyper-V

Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

New-VBRAmazonEC2DiskConfiguration -DiskName <string> [-Include] [-DiskType <VBRAmazonEC2DiskType>{GeneralPurposeSSD | ProvisionedIOPSSSD | ColdHDD | ThroughtputOptimizedHDD | Magnetic}] [-ProvisionedIOPSNumber <int>] [<CommonParameters>]

Detailed Description

This cmdlet creates the VBRAmazonEC2DiskConfiguration object. This object contains storage volume settings for Amazon EC2 instances.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
DiskName	Specifies the disk of the source machine. Veeam Backup & Replication will restore this disk to Amazon EC2. Note: You must specify the disk name in the "VMNAME.vhdx" format.	String	True	Named	False
Include	Defines that Veeam Backup & Replication will restore selected disks to Amazon EC2. Default: True. Note: To disable this option, set the parameter value to $false. That is, parameter_name:$false.	SwitchParameter	False	Named	False
DiskType	Specifies the storage volume type. Veeam Backup & Replication will saves disks of the restored machine as Amazon Elastic Block Store (EBS) volumes. You can select the following types of EBS volumes: GeneralPurposeSSD - use this option to create General Purpose SSD (gp2) volumes. ProvisionedIOPSSSD - use this option to create Provisioned IOPS SSD volumes. ColdHDD - use this option to create Cold HDD volumes. ThroughtputOptimizedHDD - use this option to create Throughput Optimized HDD volumes. Magnetic - use this option to create Magnetic volumes. GeneralPurposeSSD3 - use this option to create General Purpose SSD (gp3) volumes. ProvisionedIOPSSSD2 - use this option to create Provisioned IOPS SSD (io2) volumes.	VBRAmazonEC2DiskType	False	Named	False
ProvisionedIOPSNumber	For the ProvisionedIOPSSSD option. Specifies the number of input/output operations per second for the volume.	Int	False	Named	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

None.

Examples

Example 1. Defining Storage Volume Settings for Computer

This example shows how to define Cold HDD storage volume for a computer disk backed-up with Veeam Agent for Microsoft Windows.

$backup = Get-VBRBackup -Name "Windows Servers Backup"

$restorePoint = Get-VBRRestorePoint -Backup $backup | Sort-Object -Property CreationTime -Descending | Select-Object -First 1

$diskNames = Get-VBRComputerDisk -RestorePoint $restorePoint

$diskConfig = New-VBRAmazonEC2DiskConfiguration -DiskName $diskNames[0].UniqueId -DiskType ColdHDD -Include

Perform the following steps:

Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Get-VBRRestorePoint cmdlet. Specify the Backup parameter value.
Pipe the cmdlet output to the Sort-Object cmdlet. Set the CreationTime value for the Property parameter. Provide the Descending parameter.
Pipe the cmdlet output to the Select-Object cmdlet. Specify the First parameter value. Save the result to the $restorePoint variable.
Run the Get-VBRComputerDisk cmdlet. Set the $restorePoint value for the RestorePoint parameter. Save the result to the $diskNames variable.
Run the New-VBRAmazonEC2DiskConfiguration cmdlet. Specify the following:

Set the $diskNames[0].UniqueId variable as the DiskName parameter value.
Specify the DiskType and Include parameter values.
Save the result to the $diskConfig variable.

Example 2. Defining Storage Volume Settings for Hyper-V VMs

This example shows how to define Cold HDD storage volume for a disk of a Microsoft Hyper-V VM.

$backup = Get-VBRBackup -Name "VM Backup Job"

$restorePoint = Get-VBRRestorePoint -Backup $backup | Sort-Object -Property CreationTime -Descending | Select-Object -First 1

$diskConfig = New-VBRAmazonEC2DiskConfiguration -DiskName $restorePoint.AuxData.Disks[0].TargetFilePath -DiskType ColdHDD -Include

Perform the following steps:

Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Get-VBRRestorePoint cmdlet. Specify the Backup parameter value.
Pipe the cmdlet output to the Sort-Object cmdlet. Set the CreationTime value for the Property parameter. Provide the Descending parameter.
Pipe the cmdlet output to the Select-Object cmdlet. Specify the First parameter value. Save the result to the $restorePoint variable.
Run the New-VBRAmazonEC2DiskConfiguration cmdlet. Specify the following:

Set the $restorePoint.AuxData.Disks[0].TargetFilePath variable as the DiskName parameter value.
Specify the DiskType and Include parameter values.
Save the result to the $diskConfig variable.

Example 3. Defining Storage Volume Settings for Other Workloads

This example shows how to define Cold HDD storage volume for for a disk of a workload other than computers backed-up with Veeam Agent for Microsoft Windows. This example shows how to do it for a VMware vSphere VM.

$backup = Get-VBRBackup -Name "VM Backup Job"

$restorePoint = Get-VBRRestorePoint -Backup $backup | Sort-Object -Property CreationTime -Descending | Select-Object -First 1

$diskConfig = New-VBRAmazonEC2DiskConfiguration -DiskName $restorePoint.AuxData.Disks[0].FileName -DiskType ColdHDD -Include

Perform the following steps:

Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Get-VBRRestorePoint cmdlet. Specify the Backup parameter value.
Pipe the cmdlet output to the Sort-Object cmdlet. Set the CreationTime value for the Property parameter. Provide the Descending parameter.
Pipe the cmdlet output to the Select-Object cmdlet. Specify the First parameter value. Save the result to the $restorePoint variable.
Run the New-VBRAmazonEC2DiskConfiguration cmdlet. Specify the following:

Set the $restorePoint.AuxData.Disks[0].FileName variable as the DiskName parameter value.
Specify the DiskType and Include parameter values.
Save the result to the $diskConfig variable.