Veeam Backup for Microsoft Office 365 4.0
PowerShell Reference
Related documents

Add-VBOAmazonS3Account

Short Description

Creates Amazon S3 storage account credentials.

Syntax

Add-VBOAmazonS3Account -AccessKey <string> -SecurityKey <securestring> [-Description <string>][<CommonParameters>]

Detailed Description

This cmdlet creates the VBRAmazonAccount object. Veeam Backup for Microsoft Office 365 will use these storage account credentials to access Amazon S3 storage.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

AccessKey

Specifies an access key. The cmdlet will use this key to add Amazon S3 storage account credentials to Veeam Backup for Microsoft Office 365.

String

True

Named

False

 

SecurityKey

Specifies a secret key. The cmdlet will use this secret key to add the Amazon storage account credentials to Veeam Backup for Microsoft Office 365.

SecureString

True

Named

False

 

Description

Specifies a description for Amazon S3 storage account credentials.

String

False

Named

False

 

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the VBOAmazonS3Account object that contains Amazon S3 storage account credentials.

Examples

Add-VBOAmazonS3AccountExample 1. Adding Amazon S3 Storage Account Credentials

This example shows how to add Amazon S3 storage account credentials to Veeam Backup for Microsoft Office 365.

$securepassword = Read-Host "Enter your password" -AsSecureString

Enter your password: **********

Add-VBOAmazonS3Account -AccessKey "867F16FDE95B12DF" -SecurityKey $securepassword

Perform the following steps:

  1. Run the Read-Host cmdlet. Specify the message that the console will display as a prompt. Specify the AsSecureString parameter. Save the result to the $securepassword variable.
  2. Enter the password.
  3. Run the Add-VBOAmazonS3Account cmdlet. Specify the AccessKey parameter value. Set $securepassword as the SecurityKey parameter value.

Add-VBOAmazonS3AccountExample 2. Adding Amazon S3 Storage Account Credentials with Description

This example shows how to add Amazon S3 storage account credentials with a description.

$securepassword = Read-Host "Enter your password" -AsSecureString

Enter your password: **********

Add-VBOAmazonS3Account -AccessKey "eu7^vuKvvhcrtbP" -SecurityKey $securepassword -Description "Amazon S3 Credential Records"

Perform the following steps:

  1. Run the Read-Host cmdlet. Specify the message that the console will display as a prompt. Specify the AsSecureString parameter. Save the result to the $securepassword variable.
  2. Enter the password.
  3. Run the Add-VBOAmazonS3Account cmdlet. Specify the following settings:
  • Set the $securepassword variable as the SecurityKey parameter value.
  • Specify the AccessKey parameter value.
  • Specify the Description parameter value.

Related Commands

Read-Host

This Document Help Center
User GuideRESTful API ReferencePowerShell ReferenceVeeam Explorers User GuideVeeam Explorers PowerShell Reference
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.