---
title: "Add-VBRAmazonS3CompatibleRepository"
description: "This cmdlet adds S3 compatible and S3-integrated object storage repositories to Veeam Backup & Replication."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/add-vbramazons3compatiblerepository.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Backup Infrastructure > Object Storage Repositories > Adding Amazon S3 and S3 Compatible Object Storage > Add-VBRAmazonS3CompatibleRepository"
dateModified: "2026-08-19"
---

# Add-VBRAmazonS3CompatibleRepository

## Short Description
Adds S3 compatible and S3-integrated object storage repositories to the backup infrastructure.

**Platform**: VMware, Hyper-V

**Product Edition**: Enterprise, Enterprise Plus, Veeam Universal License

## Syntax
```
Add-VBRAmazonS3CompatibleRepository [-Name <String>] [-Description <String>]
 -AmazonS3Folder <VBRAmazonS3Folder> -Connection <VBRAmazonS3CompatibleConnection> [-EnableSizeLimit]
 [-SizeLimit <Int32>] [-EnableBackupImmutability] [-ImmutabilityMode <VBRRepositoryImmutabilityMode>]
 [-ImmutabilityPeriod <Int32>] [-MountServerOptions <VBRRepositoryMountServerOptions[]>]
 [-ProxyAppliance <CHost>] [-EnableConcurrentTasksLimit] [-MaxConcurrentTasks <Int32>] [-ForceOwnershipChange]
 [-EnableReadOnlyMode] [-EnableBucketAutoProvision] [-MachinesPerBucketLimit <Int32>] [-Force] [<CommonParameters>]
```

## Detailed Description
This cmdlet adds S3 compatible and S3-integrated object storage repositories to Veeam Backup & Replication.

## Parameters

<table style="width:100%;" class="Blue_Table">
      <tr style="vertical-align:top">
        <th style="width:20%;">
          <p>Parameter</p>
        </th>
        <th style="width:20%;">
          <p>Description</p>
        </th>
        <th style="width:20%;">
          <p>Type</p>
        </th>
        <th style="width:10%;">
          <p>Required</p>
        </th>
        <th style="width:10%;">
          <p>Position</p>
        </th>
        <th style="width:10%;">
          <p>Accept Pipeline Input</p>
        </th>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">AmazonS3Folder</span></p>
        </td>
        <td>
          <p>Specifies an S3 compatible folder. Veeam Backup & Replication will store backup files in this folder.</p><p>Accepts the <code>VBRAmazonS3Folder</code> object. To get this object, run the <a href="get-vbramazons3folder.md"><code>Get-VBRAmazonS3Folder</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbramazons3folder.md"><code>VBRAmazonS3Folder</code></a></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByValue)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Connection</span></p>
        </td>
        <td>
          <p>Specifies an active session with S3 compatible object storage. The cmdlet will add it as a backup repository.</p><p>Accepts the <code>VBRAmazonS3CompatibleConnection</code> object. To get this object, run the <a href="connect-vbramazons3compatibleservice.md"><code>Connect-VBRAmazonS3CompatibleService</code></a> cmdlet and set the <code>CapacityTier</code> property as the <code>ServiceType</code> parameter value.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRAmazonS3CompatibleConnection</code></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Description</span></p>
        </td>
        <td>
          <p>Specifies a description of an S3 compatible object storage. The cmdlet will add object storage with this description.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EnableBackupImmutability</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will enable the immutability option.</p><p>Default: <code>False.</code></p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EnableBucketAutoProvision</span></p>
        </td>
        <td>
          <p>For creating multiple child buckets.</p><p>Defines that the cmdlet will create multiple child buckets automatically.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EnableConcurrentTasksLimit</span></p>
        </td>
        <td>
          <p>Enables limits for concurrent tasks that can be processed by the object storage repository.</p><p>Use the <code>MaxConcurrentTasks</code> parameter to specify the number of tasks.</p><p>Default: <code>False</code>.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EnableReadOnlyMode</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will add the object storage repository in the read-only mode. If you enable this option, Veeam Backup & Replication will not write or modify data in the object storage repository. You can use the object storage repository for restore operations only.</p><p>Default: <code>False</code>.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EnableSizeLimit</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will enable size limits for data blocks that you want to store in an S3 compatible storage.</p><p>Use the <code>SizeLimit</code> parameter to specify the size limits.</p><p>Default: <code>False</code>.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Force</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will add an object storage repository without showing warnings in the PowerShell console.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ForceOwnershipChange</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will force ownership change of the object storage folder.</p><p>If you do not provide this parameter and the object storage folder is owned by another host, you will not be able to add object storage to the backup infrastructure.</p><p>Default: <code>False</code>.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ImmutabilityMode</span></p>
        </td>
        <td>
          <p>Specifies the immutability retention period:</p><ul><li><code>BackupRetention</code>: Use this option if you want the immutability period to depend on the backup job retention.</li><li><code>RepositoryRetention</code>: Use this option if you want to ignore the job retention and specify the immutability period explicitly.</li></ul>
        </td>
        <td style="width:10%;">
          <p><code>VBRRepositoryImmutabilityMode</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ImmutabilityPeriod</span></p>
        </td>
        <td>
          <p>For the <code>EnableBackupImmutability</code> parameter.</p><p>Defines the immutability period in days.</p><p>Default: 30 days.</p><p>Maximum: 999 days.</p>
        </td>
        <td style="width:10%;">
          <p><code>Int32</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">MachinesPerBucketLimit</span></p>
        </td>
        <td>
          <p>For creating multiple child buckets.</p><p>Specifies a number of per-machine backup chains in a sub bucket. The cmdlet will create child buckets according to the amount of per-machine backup chains.</p><p>Default: <code>10</code>.</p>
        </td>
        <td style="width:10%;">
          <p><code>Int32</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">MaxConcurrentTasks</span></p>
        </td>
        <td>
          <p>Specifies a maximum number of concurrent tasks that can be processed at once by the object storage repository.</p>
        </td>
        <td style="width:10%;">
          <p><code>Int32</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">MountServerOptions</span></p>
        </td>
        <td>
          <p>Specifies settings of a mount server for object storage repositories.</p><p><strong>Note</strong>: This parameter is required for object storage repositories that you want to add as performance extents to a scale-out backup repository.</p><p>Accepts the <code>VBRRepositoryMountServerOptions</code> object. To create this object, run the <a href="new-vbrrepositorymountserveroptions.md"><code>New-VBRRepositoryMountServerOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrrepositorymountserveroptions.md"><code>VBRRepositoryMountServerOptions[]</code></a></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Name</span></p>
        </td>
        <td>
          <p>Specifies a name of an S3 compatible object storage. The cmdlet will add object storage with this name.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ProxyAppliance</span></p>
        </td>
        <td>
          <p>Specifies a helper appliance. Veeam Backup & Replication will use this appliance to perform a health check of backup files and apply retention to file backup job files.</p>
        </td>
        <td style="width:10%;">
          <p><code>CHost</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">SizeLimit</span></p>
        </td>
        <td>
          <p>For the <code>EnableSizeLimit</code> parameter.</p><p>Specifies size limits in GB for data blocks that you want to store in an S3 compatible object storage added as a backup repository.</p><p>Permitted value: <code>1024</code>–<code>1073741824</code>.</p><p>Default: <code>10240</code>.</p><p><strong>Note</strong>: [For S3-integrated repository] If you specify size limits that exceed an actual capacity of the S3-integrated repository, you will get a warning. Provide the <code>Force</code> parameter to skip this warning.</p>
        </td>
        <td style="width:10%;">
          <p><code>Int32</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
    </table>

`<CommonParameters>`

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see [ Microsoft Docs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7).

## Output Object
[`VBRAmazonS3CompatibleRepository`](vbramazons3compatiblerepository.md)

## Examples

::: example
### Adding Amazon S3 Object Storage to Backup Infrastructure

This example shows how to add an Amazon S3 compatible object storage repository to the backup infrastructure.

```
$account = Get-VBRAmazonAccount
$connect = Connect-VBRAmazonS3CompatibleService -Account $account -CustomRegionId "us-east-1" -ServicePoint "http://123.45.67.89:9000"
$bucket = Get-VBRAmazonS3Bucket -Connection $connect -Name "New Bucket"
$folder = Get-VBRAmazonS3Folder -Name "New Folder" -Bucket $bucket -Connection $connect
Add-VBRAmazonS3CompatibleRepository -AmazonS3Folder $folder -Connection $connect -Name "New Repository"
```

Perform the following steps:

1. Run the [`Get-VBRAmazonAccount`](get-vbramazonaccount.md) cmdlet. Save the result to the `$account` variable.
2. Run the [`Connect-VBRAmazonS3CompatibleService`](connect-vbramazons3compatibleservice.md) cmdlet. Set the `$account` variable as the `Account` parameter value. Specify the `CustomRegionId` and `ServicePoint` parameter values. Save the result to the `$connect` variable.
3. Run the [`Get-VBRAmazonS3Bucket`](get-vbramazons3bucket.md) cmdlet. Set the `$connect` variable as the `Connection` parameter value. Specify the `Name` parameter value. Save the result to the `$bucket` variable.
4. Run the [`Get-VBRAmazonS3Folder`](get-vbramazons3folder.md) cmdlet. Specify the `Name` parameter value. Set the `$bucket` variable as the `Bucket` parameter value. Set the `$connect` variable as the `Connection` parameter value. Save the result to the `$folder` variable.
5. Run the `Add-VBRAmazonS3CompatibleRepository` cmdlet. Set the `$folder` variable as the `AmazonS3Folder` parameter value. Set the `$connect` variable as the `Connection` parameter value. Specify the `Name` parameter value.

:::

## Related Commands

- [`Get-VBRAmazonAccount`](get-vbramazonaccount.md)
- [`Connect-VBRAmazonS3CompatibleService`](connect-vbramazons3compatibleservice.md)
- [`Get-VBRAmazonS3Bucket`](get-vbramazons3bucket.md)
- [`Get-VBRAmazonS3Folder`](get-vbramazons3folder.md)