Set-VBRAmazonAccount

Short Description

Modifies AWS credentials records.

Applies to

Platform: VMware, Hyper-V

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

Syntax

Set-VBRAmazonAccount -Account <VBRAmazonAccount> [-AccessKey <string>] [-SecretKey <string>] [-Description <string>]  [<CommonParameters>]

Detailed Description

This cmdlet allows you to modify AWS credentials records. You can modify credentials records for the following services:

  • Amazon S3
  • Amazon EC2
  • S3 Compatible (including IBM Cloud Object Storage)

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Account

Specifies AWS credentials records that you want to modify.

Accepts the VBRAmazonAccount type.

True

Named

True (ByValue)

 

Description

Specifies a description for AWS credentials records.

False

Named

False

 

AccessKey

Specifies an access key. The cmdlet will use this access key to add AWS credentials records to Veeam Backup & Replication.

False

Named

False

 

SecretKey

Specifies a secret key. The cmdlet will use this secret key to add AWS credentials records to Veeam Backup & Replication.

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 modify an AWS credentials record.

  1. Run Get-VBRAmazonAccount to get the Amazon credentials record. Save the result to the $creds variable.
  2. Run Set-VBRAmazonAccount with the $creds variable. Use the SecretKey parameter to set the new secret key.

$creds = Get-VBRAmazonAccount -AccessKey "ABCDEFGHIGKLMNOP"

Set-VBRAmazonAccount -Account $creds -SecretKey "vmdkfdvdvdvEIE

Related Commands

Get-VBRAmazonAccount