Disconnect-VBRAmazonS3Service

Short Description

Stops active sessions with Amazon S3 and S3 Compatible object storage.

Applies to

Platform: VMware, Hyper-V

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

Syntax

Disconnect-VBRAmazonS3Service -Connection <IVBRAmazonS3Connection>  [<CommonParameters>]

Detailed Description

This cmdlet stops active sessions with Amazon S3 object storage. You can stop current sessions for the following types of Amazon object storage:

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

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Connection

Specifies a session with Amazon S3 object storage that you want to stop.

Accept the IVBRAmazonS3Connection type.

True

Named

True (ByValue)

 

<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 stops an active session with Amazon S3 object storage.

  1. Run Get-VBRAmazonAccount to get the Amazon S3 credentials record. Use the AccessKey parameter to get the credentials record by the Amazon S3 access key. Save the result to the $account variable.
  2. Run Connect-VBRAmazonS3Service with the $account variable to start a session with Amazon S3 credentials records. Save the result to the $session variable.
  3. Run Disconnect-VBRAmazonS3Service with the $session variable.

$account = Get-VBRAmazonAccount -AccessKey "ABCDEFGHIGKLMNOP"

$session = Connect-VBRAmazonS3Service -Account $account -RegionType Global -ServiceType CapacityTier

Disconnect-VBRAmazonS3Service -Connection $session

Related Commands

Get-VBRAmazonAccount

Connect-VBRAmazonS3Service