---
title: "Set-VBRAmazonS3ExternalRepository"
description: "This cmdlet modifies external Amazon S3 storage repository added to the backup infrastructure. Consider the following: This cmdlet requires the PSCredential object. Use the Get-Credential cmdlet to get the PSCredentials object."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/set-vbramazons3externalrepository.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Backup Infrastructure > External Repositories > Set-VBRAmazonS3ExternalRepository"
dateModified: "2026-08-19"
---

# Set-VBRAmazonS3ExternalRepository

## Short Description
Modifies external Amazon S3 storage repository.

**Platform**: VMware, Hyper-V

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

## Syntax
```
Set-VBRAmazonS3ExternalRepository -ExternalRepository <VBRAmazonS3ExternalRepository> [-Name <String>]
 [-Description <String>] [-MountServerOptions <VBRRepositoryMountServerOptions[]>] [-DecryptBackups]
 [-DecryptionKey <VBREncryptionKey>] [-GatewayServer <CHost>] [<CommonParameters>]
```

## Detailed Description
This cmdlet modifies external Amazon S3 storage repository added to the backup infrastructure.

::: note

Consider the following:

- This cmdlet requires the `PSCredential` object. Use the [`Get-Credential`](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.security/get-credential?view=powershell-7.4) cmdlet to get the `PSCredentials` object.
- To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameters 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">DecryptBackups</span></p>
        </td>
        <td>
          <p>Defines that Veeam Backup & Replication will decrypt encrypted backups.</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">DecryptionKey</span></p>
        </td>
        <td>
          <p>Specifies the password that Veeam Backup & Replication will use to decrypt the backup files.</p><p>Default: <code>False</code>.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBREncryptionKey</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 the description of external Amazon S3 storage repository.</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">ExternalRepository</span></p>
        </td>
        <td>
          <p>Specifies the external Amazon S3 repository that you want to modify.</p><p>Accepts the <code>VBRAmazonS3ExternalRepository</code> object. To get this object, run the <a href="get-vbrexternalrepository.md"><code>Get-VBRExternalRepository</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRAmazonS3ExternalRepository</code></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">GatewayServer</span></p>
        </td>
        <td>
          <p>Specifies the gateway server. Veeam Backup & Replication will use this server to access an Amazon S3 bucket.</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">MountServerOptions</span></p>
        </td>
        <td>
          <p>Specifies the mount server settings for the servers that you plan to use as mount servers during the restore process.</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 the name of external Amazon S3 storage repository.</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>
    </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
The cmdlet returns the `VBRAmazonS3ExternalRepository` object that contains settings of the modified external Amazon S3 storage repository added to the backup infrastructure..

## Examples

::: example
### Modifying Decryption Password of External Amazon S3 Storage Repository

This example shows how to modify the decryption password for external Amazon S3 storage repository.

```
$repository = Get-VBRExternalRepository -Name "External Repository"
$securepassword = Read-Host -Prompt "Enter password" -AsSecureString
$key = Add-VBREncryptionKey -Password $securepassword
Set-VBRAmazonS3ExternalRepository -ExternalRepository $repository -DecryptBackups -DecryptionKey $key
```

Perform the following steps:

1. Run the [`Get-VBRExternalRepository`](get-vbrexternalrepository.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$repository` variable.
2. Run the [`Read-Host`](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/read-host?view=powershell-6) cmdlet. Specify the message which the console will display as a prompt. Provide the `AsSecureString` parameter. Save the result to the `$securepassword` variable.
3. Run the [`Add-VBREncryptionKey`](add-vbrencryptionkey.md) cmdlet. Set the `$securepassword` variable as the `Password` parameter value. Save the result to the `$key` variable.
4. Run the `Set-VBRAmazonS3ExternalRepository` cmdlet. Specify the following settings:

   - Set the `$repository` variable as the `ExternalRepository` parameter value.
   - Provide the `DecryptBackups` parameter.
   - Set the `$key` variable as the `DecryptionKey` parameter value.

:::

## Related Commands

- [`Get-VBRExternalRepository`](get-vbrexternalrepository.md)
- [`Add-VBREncryptionKey`](add-vbrencryptionkey.md)