---
title: "Set-VBRAmazonS3CompatibleRepository"
description: "This cmdlet modifies settings for S3 compatible object storage added as a backup repository Veeam Backup & Replication. To modify settings, specify new values for the necessary parameters."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/set-vbramazons3compatiblerepository.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Backup Infrastructure > Object Storage Repositories > Adding Amazon S3 and S3 Compatible Object Storage > Set-VBRAmazonS3CompatibleRepository"
dateModified: "2026-08-19"
---

# Set-VBRAmazonS3CompatibleRepository

## Short Description
Modifies settings for S3 compatible object storage added as a backup repository.

**Platform**: VMware, Hyper-V

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

## Syntax
```
Set-VBRAmazonS3CompatibleRepository -Repository <VBRAmazonS3CompatibleRepository> [-Name <String>]
 [-Description <String>] [-UseGatewayServer] [-ConnectionType <VBRRepositoryConnectionType>]
 [-GatewayServer <CHost[]>] [-ProxyAppliance <CHost>] [-EnableSizeLimit] [-SizeLimit <Int32>]
 [-ImmutabilityMode <VBRRepositoryImmutabilityMode>] [-ImmutabilityPeriod <Int32>]
 [-MountServerOptions <VBRRepositoryMountServerOptions[]>] [-EnableConcurrentTasksLimit]
 [-MaxConcurrentTasks <Int32>] [-EnableBucketAutoProvision] [-MachinesPerBucketLimit <Int32>] [-Force] [<CommonParameters>]
```

## Detailed Description
This cmdlet modifies settings for S3 compatible object storage added as a backup repository Veeam Backup & Replication.

::: note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

:::

## 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">ConnectionType</span></p>
        </td>
        <td>
          <p>Specifies how Veeam Backup & Replication will access the object storage repository:</p><ul><li><code>Direct</code>: Use this option if you want Veeam Backup & Replication to use a proxy server to transfer data from the processed VM to object storage repositories.</li><li><code>Gateway</code>: Use this option if you want Veeam Backup & Replication to use a gateway server to transfer data from processed VM to object storage repositories. <strong>Note</strong>: Provide the <code>GatewayServer</code> parameter to specify the server.</li></ul><p>Default: <code>Direct</code>.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRRepositoryConnectionType</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">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">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>
        </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>Enables size limits for data blocks that you want to store in an S3 compatible object 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 modify 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">GatewayServer</span></p>
        </td>
        <td>
          <p>Specifies an array of gateway servers that you want to use to transfer data from processed VM to object storage repositories.</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">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">Repository</span></p>
        </td>
        <td>
          <p>Specifies an S3 compatible object storage that you want to modify.</p><p>Accepts the <code>VBRAmazonS3Repository</code> object. To create this object, run the <a href="get-vbrobjectstoragerepository.md"><code>Get-VBRObjectStorageRepository</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbramazons3compatiblerepository.md"><code>VBRAmazonS3CompatibleRepository</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">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.</p><p>Permitted value: <code>1024</code>–<code>1073741824</code>.</p><p>Default: <code>10240</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">UseGatewayServer</span></p>
        </td>
        <td>
          <p><strong>Note</strong>: This parameter is deprecated and will be ignored. Use the <code>GatewayServer</code> parameter instead.</p><p>Defines that the cmdlet will use a gateway server to transfer data from processed VM to object storage repositories.</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>
    </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
### Modifying Gateway Server Settings of S3 Compatible Object Storage

This example shows how to modify settings for an S3 compatible object storage added as a backup repository. The cmdlet will use custom gateway servers to connect to S3 compatible object storage.

```
$amazon = Get-VBRObjectStorageRepository -Type AmazonS3Compatible
$gateserv = Get-VBRServer -Name "north.tech.local", "north2.tech.local"
Set-VBRAmazonS3CompatibleRepository -Repository $amazon -ConnectionType Gateway -GatewayServer $gateserv
```

Perform the following steps:

1. Run the [`Get-VBRObjectStorageRepository`](get-vbrobjectstoragerepository.md) cmdlet. Set the `AmazonS3Compatible` option for the `Type` parameter. Save the result to the `$amazon` variable.
2. Run the [`Get-VBRServer`](get-vbrserver.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$gateserv` variable.
3. Run the `Set-VBRAmazonS3CompatibleRepository` cmdlet. Set the `$amazon` variable as the `Repository` parameter value. Set the `Gateway` value for the `ConnectionType` parameter. Set the `$gateserv` variable as the `GatewayServer` parameter value.

:::

## Related Commands

- [`Get-VBRObjectStorageRepository`](get-vbrobjectstoragerepository.md)
- [`Get-VBRServer`](get-vbrserver.md)