New-VBOAmazonS3ServiceConnectionSettings

In this article

    Short Description

    Defines connection settings to Amazon S3 object storage.

    Syntax

    New-VBOAmazonS3ServiceConnectionSettings -Account <VBOAmazonS3Account> -RegionType {Global | USGovernment | China}  [<CommonParameters>]

    Detailed Description

    This cmdlet creates the VBOAmazonS3ServiceConnectionSettings object. This object contains connection settings to Amazon S3 object storage.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Account

    Specifies Amazon S3 storage account credentials. The cmdlet will use these storage account credentials to connect to Amazon S3 object storage.

    Accepts the VBOAmazonS3Account object. To get this object, run the Get-VBOAmazonS3Account cmdlet.

    True

    Named

    False

     

    RegionType

    Specifies the region type of Amazon S3 object storage. The cmdlet will connect to the selected region type and will set up a connection with Amazon S3 object storage. You can select the following types of regions:

    • Global
    • USGovernment
    • China

    VBOAmazonS3RegionType

    True

    Named

    False

     

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Output Object

    The cmdlet returns the VBOAmazonS3ServiceConnectionSettings object that defines connection settings to Amazon S3 object storage.

    Examples

    New-VBOAmazonS3ServiceConnectionSettingsExample 1. Connecting to Amazon S3 Object Storage of Global Region Type

    This example shows how to connect to Amazon S3 object storage of the global region type.

    $account = Get-VBOAmazonS3Account -Id "26e61916-0257-4a05-8f65-204628d2ed7a"

    New-VBOAmazonS3ServiceConnectionSettings -Account $account -RegionType Global

    Perform the following steps:

    1. Run the Get-VBOAmazonS3Account cmdlet. Specify the Id parameter value. Save the result to the $account variable.
    2. Run the New-VBOAmazonS3ServiceConnectionSettings cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType parameter value.

    New-VBOAmazonS3ServiceConnectionSettingsExample 2. Connecting to Amazon S3 Object Storage of US Government Region Type

    This example shows how to connect to Amazon S3 object storage of the US Government region type.

    $account = Get-VBOAmazonS3Account -Id "d1fc1171-3206-429f-9563-51b9af8df0ac"

    New-VBOAmazonS3ServiceConnectionSettings -Account $account -RegionType USGovernment

    Perform the following steps:

    1. Run the Get-VBOAmazonS3Account cmdlet. Specify the Id parameter value. Save the result to the $account variable.
    2. Run the New-VBOAmazonS3ServiceConnectionSettings cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType parameter value.

    New-VBOAmazonS3ServiceConnectionSettingsExample 3. Connecting to Amazon S3 Object Storage of China Region Type

    This example shows how to connect to Amazon S3 object storage of the China region type.

    $account = Get-VBOAmazonS3Account -Id "f7e0a65d-1042-4ab0-bc73-699acbb5cb79"

    New-VBOAmazonS3ServiceConnectionSettings -Account $account -RegionType China

    Perform the following steps:

    1. Run the Get-VBOAmazonS3Account cmdlet. Specify the Id parameter value. Save the result to the $account variable.
    2. Run the New-VBOAmazonS3ServiceConnectionSettings cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType parameter value.

    Related Commands

    Get-VBOAmazonS3Account