Get-VBOAmazonInstanceType

Short Description

Returns an instance type that the Amazon archiver appliance will use.

Syntax

Get-VBOAmazonInstanceType -AmazonS3ConnectionSettings <VBOAmazonS3ConnectionSettings> [-Name <String>] -RegionId <String> [<CommonParameters>]

Detailed Description

This cmdlet returns the VBOAmazonInstanceType object.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
AmazonS3ConnectionSettings	Specifies an active session with Amazon S3 object storage repository.	Accepts the VBOAmazonS3ConnectionSettings object. To create this object, run the New-VBOAmazonS3ConnectionSettings cmdlet.	True	Named	False
Name	Specifies a name of an instance type. The cmdlet will return the instance type with this name.	String	False	Named	False
RegionId	Specifies a region of Amazon S3 object storage repository. You can select the following region IDs: us-east-2 us-east-1 us-west-1 us-west-2 af-south-1 ap-east-1 ap-southeast-3 ap-south-1 ap-northeast-3 ap-northeast-2 ap-southeast-1 ap-southeast-2 ap-northeast-1 ca-central-1 eu-central-1 eu-west-1 eu-west-2 eu-south-1 eu-west-3 eu-north-1 me-south-1 sa-east-1 us-gov-east-1 us-gov-west-1 For more information, see this Amazon article.	String	True	Named	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

AmazonS3ConnectionSettings

Specifies an active session with Amazon S3 object storage repository.

Accepts the VBOAmazonS3ConnectionSettings object.

To create this object, run the New-VBOAmazonS3ConnectionSettings cmdlet.

True

Named

False

Name

Specifies a name of an instance type. The cmdlet will return the instance type with this name.

String

False

Named

False

RegionId

Specifies a region of Amazon S3 object storage repository. You can select the following region IDs:

us-east-2
us-east-1
us-west-1
us-west-2
af-south-1
ap-east-1
ap-southeast-3
ap-south-1
ap-northeast-3
ap-northeast-2
ap-southeast-1
ap-southeast-2
ap-northeast-1
ca-central-1
eu-central-1
eu-west-1
eu-west-2
eu-south-1
eu-west-3
eu-north-1
me-south-1
sa-east-1
us-gov-east-1
us-gov-west-1

For more information, see this Amazon article.

String

True

Named

False

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 VBOAmazonInstanceType object that the Amazon archiver appliance will use.

Example

Getting Instance Type

This example shows how to get the instance type that the Amazon archiver appliance will use.

$S3account = Get-VBOAmazonS3Account -AccessKey "?Iqws8NewidZydk"

$S3connection = New-VBOAmazonS3ConnectionSettings -Account $S3account -RegionType Global

Get-VBOAmazonInstanceType -AmazonS3ConnectionSettings $S3connection -RegionId eu-central-1 -Name m6i.2xlarge

Perform the following steps:

Run the Get-VBOAmazonS3Account cmdlet. Specify the AccessKey parameter value. Save the result to the $S3account variable.
Run the New-VBOAmazonS3ConnectionSettings cmdlet. Set the $S3account variable as the Account parameter value. Specify the RegionType parameter value. Save the result to the $S3connection variable.
Run the Get-VBOAmazonInstanceType cmdlet. Specify the following settings:

Set the $S3connection variable as the AmazonS3ConnectionSettings parameter value.
Specify the RegionId parameter value.
Specify the Name parameter value.

Related Commands