This is an archive version of the document. To get the most up-to-date information, see the current version.

Remove-VBRAmazonAccount

Short Description

Removes AWS credentials records from Veeam Backup & Replication.

Applies to

Platform: VMware, Hyper-V

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

Syntax

Remove-VBRAmazonAccount -Account <VBRAmazonAccount> [-WhatIf] [-Confirm]  [<CommonParameters>]

Detailed Description

This cmdlet removes AWS credentials records from Veeam Backup & Replication. You can remove 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 remove.

Accepts the VBRAmazonAccount type.

True

Named

True (ByValue)

 

WhatIf

Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

False

Named

False

 

Confirm

Specifies whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.

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

This example shows how to remove an AWS credentials record.

  1. Run Get-VBRAmazonAccount to get the AWS credentials record. Save the result to the $creds variable.
  2. Run Remove-VBRAmazonAccount with the $creds variable.

$creds = Get-VBRAmazonAccount -AccessKey "ABCDEFGHIGKLMNOP"

Remove-VBRAmazonAccount -Account $creds

Related Commands

Get-VBRAmazonAccount