AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Import/Export Snowball CreateCluster API operation.

Syntax

New-SNOWCluster
-AddressId <String>
-Description <String>
-Notification_DevicePickupSnsTopicARN <String>
-Resources_Ec2AmiResource <Ec2AmiResource[]>
-EKSOnDeviceService_EKSAnywhereVersion <String>
-S3OnDeviceService_FaultTolerance <Int32>
-ForceCreateJob <Boolean>
-ForwardingAddressId <String>
-IND_GSTIN <String>
-InitialClusterSize <Int32>
-Notification_JobStatesToNotify <String[]>
-JobType <JobType>
-KmsKeyARN <String>
-EKSOnDeviceService_KubernetesVersion <String>
-Resources_LambdaResource <LambdaResource[]>
-LongTermPricingId <String[]>
-Notification_NotifyAll <Boolean>
-RemoteManagement <RemoteManagement>
-RoleARN <String>
-Resources_S3Resource <S3Resource[]>
-S3OnDeviceService_ServiceSize <Int32>
-ShippingOption <ShippingOption>
-SnowballCapacityPreference <SnowballCapacity>
-SnowballType <SnowballType>
-Notification_SnsTopicARN <String>
-NFSOnDeviceService_StorageLimit <Int32>
-S3OnDeviceService_StorageLimit <Double>
-TGWOnDeviceService_StorageLimit <Int32>
-NFSOnDeviceService_StorageUnit <StorageUnit>
-S3OnDeviceService_StorageUnit <StorageUnit>
-TGWOnDeviceService_StorageUnit <StorageUnit>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonSnowballConfig>

Description

Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.

Parameters

-AddressId <String>
The ID for the address that you want the cluster shipped to.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ClientConfig <AmazonSnowballConfig>
Amazon.PowerShell.Cmdlets.SNOW.AmazonSnowballClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
An optional description of this specific cluster, for example Environmental Data Cluster-01.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EKSOnDeviceService_EKSAnywhereVersion <String>
The optional version of EKS Anywhere on the Snow Family device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnDeviceServiceConfiguration_EKSOnDeviceService_EKSAnywhereVersion
-EKSOnDeviceService_KubernetesVersion <String>
The Kubernetes version for EKS Anywhere on the Snow Family device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnDeviceServiceConfiguration_EKSOnDeviceService_KubernetesVersion
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ForceCreateJob <Boolean>
Force to create cluster when user attempts to overprovision or underprovision a cluster. A cluster is overprovisioned or underprovisioned if the initial size of the cluster is more (overprovisioned) or less (underprovisioned) than what needed to meet capacity requirement specified with OnDeviceServiceConfiguration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesForceCreateJobs
-ForwardingAddressId <String>
The forwarding address ID for a cluster. This field is not supported in most regions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IND_GSTIN <String>
The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTaxDocuments_IND_GSTIN
-InitialClusterSize <Int32>
If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobType <JobType>
The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-KmsKeyARN <String>
The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in Key Management Service (KMS).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LongTermPricingId <String[]>
Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLongTermPricingIds
-NFSOnDeviceService_StorageLimit <Int32>
The maximum NFS storage for one Snow Family device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnDeviceServiceConfiguration_NFSOnDeviceService_StorageLimit
-NFSOnDeviceService_StorageUnit <StorageUnit>
The scale unit of the NFS storage on the device.Valid values: TB.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnDeviceServiceConfiguration_NFSOnDeviceService_StorageUnit
-Notification_DevicePickupSnsTopicARN <String>
Used to send SNS notifications for the person picking up the device (identified during job creation).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Notification_JobStatesToNotify <String[]>
The list of job states that will trigger a notification for this job. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Notification_NotifyAll <Boolean>
Any change in job state will trigger a notification for this job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Notification_SnsTopicARN <String>
The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action.You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RemoteManagement <RemoteManagement>
Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Resources_Ec2AmiResource <Ec2AmiResource[]>
The Amazon Machine Images (AMIs) associated with this job. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResources_Ec2AmiResources
-Resources_LambdaResource <LambdaResource[]>
The Python-language Lambda functions for this job. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResources_LambdaResources
-Resources_S3Resource <S3Resource[]>
An array of S3Resource objects. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResources_S3Resources
-RoleARN <String>
The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in Identity and Access Management (IAM).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3OnDeviceService_FaultTolerance <Int32>
>Fault tolerance level of the cluster. This indicates the number of nodes that can go down without degrading the performance of the cluster. This additional input helps when the specified StorageLimit matches more than one Amazon S3 compatible storage on Snow family devices service configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnDeviceServiceConfiguration_S3OnDeviceService_FaultTolerance
-S3OnDeviceService_ServiceSize <Int32>
Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snow family devices. If specified, the other input can be omitted.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnDeviceServiceConfiguration_S3OnDeviceService_ServiceSize
-S3OnDeviceService_StorageLimit <Double>
If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used. If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has the same storage limit as specified, the other input need to be provided.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnDeviceServiceConfiguration_S3OnDeviceService_StorageLimit
-S3OnDeviceService_StorageUnit <StorageUnit>
Storage unit. Currently the only supported unit is TB.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnDeviceServiceConfiguration_S3OnDeviceService_StorageUnit
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ClusterId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Snowball.Model.CreateClusterResponse). Specifying the name of a property of type Amazon.Snowball.Model.CreateClusterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ShippingOption <ShippingOption>
The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows:
  • In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.
  • In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.
  • In India, Snow devices are delivered in one to seven days.
  • In the United States of America (US), you have access to one-day shipping and two-day shipping.
  • In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.
  • In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.
  • In India, Snow devices are delivered in one to seven days.
  • In the US, you have access to one-day shipping and two-day shipping.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-SnowballCapacityPreference <SnowballCapacity>
If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SnowballType <SnowballType>
The type of Snow Family devices to use for this cluster. For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-TGWOnDeviceService_StorageLimit <Int32>
The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnDeviceServiceConfiguration_TGWOnDeviceService_StorageLimit
-TGWOnDeviceService_StorageUnit <StorageUnit>
The scale unit of the virtual tapes on the device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnDeviceServiceConfiguration_TGWOnDeviceService_StorageUnit

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.Snowball.Model.CreateClusterResponse
This cmdlet returns a System.String object. The service call response (type Amazon.Snowball.Model.CreateClusterResponse) can be returned by specifying '-Select *'.
Service User Guide
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z