Disconnect-VBRAmazonS3Service
Short Description
Stops active sessions with Amazon S3 and S3 compatible object storage.
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 |
Type |
Required |
Position |
Accept Pipeline Input |
|---|---|---|---|---|---|
|
Connection |
Specifies a session with Amazon S3 object storage that you want to stop. |
|
True |
Named |
True (ByValue) |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Examples
Stopping Active Session with Amazon S3 Object Storage
This example shows how to stops an active session with Amazon S3 object storage.
|
$account = Get-VBRAmazonAccount -AccessKey "ABCDEFGHIGKLMNOP" $session = Connect-VBRAmazonS3Service -Account $account -RegionType Global -ServiceType CapacityTier Disconnect-VBRAmazonS3Service -Connection $session |
Perform the following steps:
- Run the
Get-VBRAmazonAccountReturns AWS credentials records. cmdlet. Specify theAccessKeyparameter value. Save the result to the$accountvariable. - Run the
Connect-VBRAmazonS3ServiceConnects to Amazon S3 object storage. cmdlet. Set the$accountvariable as theAccountparameter value. Specify theRegionTypeandServiceTypeparameter values. Save the result to the$sessionvariable. - Run the
Disconnect-VBRAmazonS3Servicecmdlet. Set the$sessionvariable as theConnectionparameter value.
Related Commands
Get-VBRAmazonAccountReturns AWS credentials records.Connect-VBRAmazonS3ServiceConnects to Amazon S3 object storage.