Add-VBRAmazonS3Repository

In this article

    Short Description

    Adds Amazon S3 object storage repository to backup infrastructure.

    Product Edition:  Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Add-VBRAmazonS3Repository -AmazonS3Folder <VBRAmazonS3Folder> -Connection <VBRAmazonS3Connection> [-Name <String>][-Description <String>] [-EnableSizeLimit [<SwitchParameter>]] [-SizeLimit <Int32>] [-EnableIAStorageClass [<SwitchParameter>]] [-EnableOZIAStorageClass [<SwitchParameter>]] [-EnableBackupImmutability [<SwitchParameter>]] [-ImmutabilityPeriod <Int32>] [<CommonParameters>]

    Detailed Description

    This cmdlet adds Amazon S3 object storage repository to Veeam Backup & Replication. You can specify the Amazon S3 folder and set the infrequent storage class type.

    For more information about the Amazon storage classes, see Amazon S3 Storage Classes of AWS Documentation.

    Add-VBRAmazonS3Repository Important!

    Run Add-VBRAmazonS3ExternalRepository to add Amazon S3 object storage as an external backup repository.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    AmazonS3Folder

    Specifies an Amazon S3 folder.

    Accepts the VBRAmazonS3Folder type.

    True

    Named

    True (ByValue)

     

    Connection

    Specifies an active session with Amazon S3 object storage that you want to add as the backup repository.

    Accepts the VBRAmazonS3Connection object. To get this object, run the Connect-VBRAmazonS3Service cmdlet and set the CapacityTier property as the ServiceType parameter value.

    True

    Named

    False

     

    Name

    Specifies a name of an Amazon S3 object storage. The cmdlet will add object storage with this name.

    False

    Named

    False

     

    Description

    Specifies a description of an Amazon S3 object storage. The cmdlet will add object storage with this description.

    False

    Named

    False

     

    EnableSizeLimit

    Indicates that the cmdlet will enable size limits for data blocks that you want to store in an Amazon S3 object storage.

    Use the SizeLimit parameter to specify the size limits.

    False

    Named

    False

     

    SizeLimit

    For the EnableSizeLimit parameter.

    Specifies size limits in GB for data blocks that you want to store in an Amazon S3 object storage.

    Permitted value: 1024 - 1073741824.

    Default: 10240.

    False

    Named

    False

     

    EnableIAStorageClass

    Defines that the cmdlet will enable the infrequent access storage class for data blocks that are stored in an Amazon S3 object storage.

    False

    Named

    False

     

    EnableOZIAStorageClass

    Defines that the cmdlet will enable the One Zone-IA storage class for data blocks that are stored in an Amazon S3 object storage.

    False

    Named

    False

     

    EnableBackupImmutability

    Defines that the cmdlet will enable the immutability option.

    False

    Named

    False

     

    ImmutabilityPeriod

    For the EnableBackupImmutability parameter.

    Defines the immutability period in days.

    Default: 30

    False

    Named

    False

     

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Return Type

    Example

    This example shows how to add Amazon S3 object storage as a backup repository to Veeam Backup & Replication. The repository will have the following settings:

    • The object storage limits are enabled and are set to 1024 GB.
    • The infrequent access storage class is enabled.

    You will need to perform the following steps:

    1. Run Get-VBRAmazonAccount to get an Amazon S3 credentials record. Save the result to the $account variable.
    2. Run Connect-VBRAmazonS3Service with the $account variable to connect to Amazon S3 object storage. Save the result to the $connect variable.
    3. Run Get-VBRAmazonS3Bucket with the $connect variable to get an Amazon S3 bucket. Save the result to the $bucket variable.
    4. Run Get-VBRAmazonS3Folder with the $bucket and the $connect variables to get an Amazon S3 folder. Save the result to the $folder variable.
    5. Run Add-VBRAmazonS3Repository with the $connect and the $folder variables. Use the following parameters:
    • EnableIAStorageClass to enable the infrequent access storage class.
    • EnableSizeLimit to enable size limits for an Amazon S3 object storage added as a backup repository.
    • SizeLimit to specify size limits for an Amazon S3 object storage added as a backup repository.

    $account = Get-VBRAmazonAccount

    $connect = Connect-VBRAmazonS3Service -Account $account[1] -RegionType Global -ServiceType CapacityTier

    $bucket = Get-VBRAmazonS3Bucket -Connection $connect -Name "Bucket-01"

    $folder = Get-VBRAmazonS3Folder -Name "bucket" -Bucket $bucket -Connection $connect

    Add-VBRAmazonS3Repository -Name "AmazonS3Repository" -Connection $connect -AmazonS3Folder $folder  -EnableIAStorageClass -EnableSizeLimit -SizeLimit 1024

    Related Commands

    Get-VBRAmazonAccount

    Connect-VBRAmazonS3Service

    Get-VBRAmazonS3Bucket

    Get-VBRAmazonS3Folder

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.