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.
See also: AWS API Documentation
create-cluster
--job-type <value>
--resources <value>
[--on-device-service-configuration <value>]
[--description <value>]
--address-id <value>
[--kms-key-arn <value>]
--role-arn <value>
--snowball-type <value>
--shipping-option <value>
[--notification <value>]
[--forwarding-address-id <value>]
[--tax-documents <value>]
[--remote-management <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--job-type
(string)
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 .
Possible values:
IMPORT
EXPORT
LOCAL_USE
--resources
(structure)
The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language.
S3Resources -> (list)
An array of
S3Resource
objects.(structure)
Each
S3Resource
object represents an Amazon S3 bucket that your transferred data will be exported from or imported into. For export jobs, this object can have an optionalKeyRange
value. The length of the range is defined at job creation, and has either an inclusiveBeginMarker
, an inclusiveEndMarker
, or both. Ranges are UTF-8 binary sorted.BucketArn -> (string)
The Amazon Resource Name (ARN) of an Amazon S3 bucket.
KeyRange -> (structure)
For export jobs, you can provide an optional
KeyRange
within a specific Amazon S3 bucket. The length of the range is defined at job creation, and has either an inclusiveBeginMarker
, an inclusiveEndMarker
, or both. Ranges are UTF-8 binary sorted.BeginMarker -> (string)
The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
EndMarker -> (string)
The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
TargetOnDeviceServices -> (list)
Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System).
(structure)
An object that represents the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System).
ServiceName -> (string)
Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.
TransferOption -> (string)
Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.
LambdaResources -> (list)
The Python-language Lambda functions for this job.
(structure)
Identifies
LambdaArn -> (string)
An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.
EventTriggers -> (list)
The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.
(structure)
The container for the EventTriggerDefinition$EventResourceARN .
EventResourceARN -> (string)
The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function’s event trigger associated with this job.
Ec2AmiResources -> (list)
The Amazon Machine Images (AMIs) associated with this job.
(structure)
A JSON-formatted object that contains the IDs for an Amazon Machine Image (AMI), including the Amazon EC2 AMI ID and the Snow device AMI ID. Each AMI has these two IDs to simplify identifying the AMI in both the Amazon Web Services Cloud and on the device.
AmiId -> (string)
The ID of the AMI in Amazon EC2.
SnowballAmiId -> (string)
The ID of the AMI on the Snow device.
JSON Syntax:
{
"S3Resources": [
{
"BucketArn": "string",
"KeyRange": {
"BeginMarker": "string",
"EndMarker": "string"
},
"TargetOnDeviceServices": [
{
"ServiceName": "NFS_ON_DEVICE_SERVICE"|"S3_ON_DEVICE_SERVICE",
"TransferOption": "IMPORT"|"EXPORT"|"LOCAL_USE"
}
...
]
}
...
],
"LambdaResources": [
{
"LambdaArn": "string",
"EventTriggers": [
{
"EventResourceARN": "string"
}
...
]
}
...
],
"Ec2AmiResources": [
{
"AmiId": "string",
"SnowballAmiId": "string"
}
...
]
}
--on-device-service-configuration
(structure)
Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS (Network File System).
NFSOnDeviceService -> (structure)
Represents the NFS (Network File System) service on a Snow Family device.
StorageLimit -> (integer)
The maximum NFS storage for one Snow Family device.
StorageUnit -> (string)
The scale unit of the NFS storage on the device.
Valid values: TB.
TGWOnDeviceService -> (structure)
Represents the Storage Gateway service Tape Gateway type on a Snow Family device.
StorageLimit -> (integer)
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.
StorageUnit -> (string)
The scale unit of the virtual tapes on the device.
Shorthand Syntax:
NFSOnDeviceService={StorageLimit=integer,StorageUnit=string},TGWOnDeviceService={StorageLimit=integer,StorageUnit=string}
JSON Syntax:
{
"NFSOnDeviceService": {
"StorageLimit": integer,
"StorageUnit": "TB"
},
"TGWOnDeviceService": {
"StorageLimit": integer,
"StorageUnit": "TB"
}
}
--description
(string)
An optional description of this specific cluster, for example
Environmental Data Cluster-01
.
--address-id
(string)
The ID for the address that you want the cluster shipped to.
--kms-key-arn
(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).
--role-arn
(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).
--snowball-type
(string)
The type of Snow Family devices to use for this cluster.
Note
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 .
Possible values:
STANDARD
EDGE
EDGE_C
EDGE_CG
EDGE_S
SNC1_HDD
SNC1_SSD
V3_5C
--shipping-option
(string)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.
Possible values:
SECOND_DAY
NEXT_DAY
EXPRESS
STANDARD
--notification
(structure)The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
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.
JobStatesToNotify -> (list)
The list of job states that will trigger a notification for this job.
(string)
NotifyAll -> (boolean)
Any change in job state will trigger a notification for this job.
Shorthand Syntax:
SnsTopicARN=string,JobStatesToNotify=string,string,NotifyAll=booleanJSON Syntax:
{ "SnsTopicARN": "string", "JobStatesToNotify": ["New"|"PreparingAppliance"|"PreparingShipment"|"InTransitToCustomer"|"WithCustomer"|"InTransitToAWS"|"WithAWSSortingFacility"|"WithAWS"|"InProgress"|"Complete"|"Cancelled"|"Listing"|"Pending", ...], "NotifyAll": true|false }
--forwarding-address-id
(string)The forwarding address ID for a cluster. This field is not supported in most regions.
--tax-documents
(structure)The tax documents required in your Amazon Web Services Region.
IND -> (structure)
The tax documents required in Amazon Web Services Region in India.
GSTIN -> (string)
The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.
Shorthand Syntax:
IND={GSTIN=string}JSON Syntax:
{ "IND": { "GSTIN": "string" } }
--remote-management
(string)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.Possible values:
INSTALLED_ONLY
INSTALLED_AUTOSTART
--cli-input-json
|--cli-input-yaml
(string) Reads arguments from the JSON string provided. The JSON string follows the format provided by--generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with--cli-input-yaml
.
--generate-cli-skeleton
(string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the valueinput
, prints a sample input JSON that can be used as an argument for--cli-input-json
. Similarly, if providedyaml-input
it will print a sample input YAML that can be used with--cli-input-yaml
. If provided with the valueoutput
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.Global Options¶
--debug
(boolean)Turn on debug logging.
--endpoint-url
(string)Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)Disable automatic pagination.
--output
(string)The formatting style for command output.
json
text
table
yaml
yaml-stream
--query
(string)A JMESPath query to use in filtering the response data.
--profile
(string)Use a specific profile from your credential file.
--region
(string)The region to use. Overrides config/env settings.
--version
(string)Display the version of this tool.
--color
(string)Turn on/off color output.
on
off
auto
--no-sign-request
(boolean)Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb://
will always be treated as binary and use the file contents directly regardless of thecli-binary-format
setting. When usingfile://
the file contents will need to properly formatted for the configuredcli-binary-format
.
base64
raw-in-base64-out
--no-cli-pager
(boolean)Disable cli pager for output.
--cli-auto-prompt
(boolean)Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)Disable automatically prompt for CLI input parameters.
Output¶
ClusterId -> (string)
The automatically generated ID for a cluster.