Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

CreateClusterCommand

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SnowballClient, CreateClusterCommand } from "@aws-sdk/client-snowball"; // ES Modules import
// const { SnowballClient, CreateClusterCommand } = require("@aws-sdk/client-snowball"); // CommonJS import
const client = new SnowballClient(config);
const input = { // CreateClusterRequest
  JobType: "IMPORT" || "EXPORT" || "LOCAL_USE", // required
  Resources: { // JobResource
    S3Resources: [ // S3ResourceList
      { // S3Resource
        BucketArn: "STRING_VALUE",
        KeyRange: { // KeyRange
          BeginMarker: "STRING_VALUE",
          EndMarker: "STRING_VALUE",
        },
        TargetOnDeviceServices: [ // TargetOnDeviceServiceList
          { // TargetOnDeviceService
            ServiceName: "NFS_ON_DEVICE_SERVICE" || "S3_ON_DEVICE_SERVICE",
            TransferOption: "IMPORT" || "EXPORT" || "LOCAL_USE",
          },
        ],
      },
    ],
    LambdaResources: [ // LambdaResourceList
      { // LambdaResource
        LambdaArn: "STRING_VALUE",
        EventTriggers: [ // EventTriggerDefinitionList
          { // EventTriggerDefinition
            EventResourceARN: "STRING_VALUE",
          },
        ],
      },
    ],
    Ec2AmiResources: [ // Ec2AmiResourceList
      { // Ec2AmiResource
        AmiId: "STRING_VALUE", // required
        SnowballAmiId: "STRING_VALUE",
      },
    ],
  },
  OnDeviceServiceConfiguration: { // OnDeviceServiceConfiguration
    NFSOnDeviceService: { // NFSOnDeviceServiceConfiguration
      StorageLimit: Number("int"),
      StorageUnit: "TB",
    },
    TGWOnDeviceService: { // TGWOnDeviceServiceConfiguration
      StorageLimit: Number("int"),
      StorageUnit: "TB",
    },
    EKSOnDeviceService: { // EKSOnDeviceServiceConfiguration
      KubernetesVersion: "STRING_VALUE",
      EKSAnywhereVersion: "STRING_VALUE",
    },
    S3OnDeviceService: { // S3OnDeviceServiceConfiguration
      StorageLimit: Number("double"),
      StorageUnit: "TB",
      ServiceSize: Number("int"),
      FaultTolerance: Number("int"),
    },
  },
  Description: "STRING_VALUE",
  AddressId: "STRING_VALUE", // required
  KmsKeyARN: "STRING_VALUE",
  RoleARN: "STRING_VALUE",
  SnowballType: "STANDARD" || "EDGE" || "EDGE_C" || "EDGE_CG" || "EDGE_S" || "SNC1_HDD" || "SNC1_SSD" || "V3_5C" || "V3_5S" || "RACK_5U_C", // required
  ShippingOption: "SECOND_DAY" || "NEXT_DAY" || "EXPRESS" || "STANDARD", // required
  Notification: { // Notification
    SnsTopicARN: "STRING_VALUE",
    JobStatesToNotify: [ // JobStateList
      "New" || "PreparingAppliance" || "PreparingShipment" || "InTransitToCustomer" || "WithCustomer" || "InTransitToAWS" || "WithAWSSortingFacility" || "WithAWS" || "InProgress" || "Complete" || "Cancelled" || "Listing" || "Pending",
    ],
    NotifyAll: true || false,
    DevicePickupSnsTopicARN: "STRING_VALUE",
  },
  ForwardingAddressId: "STRING_VALUE",
  TaxDocuments: { // TaxDocuments
    IND: { // INDTaxDocuments
      GSTIN: "STRING_VALUE",
    },
  },
  RemoteManagement: "INSTALLED_ONLY" || "INSTALLED_AUTOSTART" || "NOT_INSTALLED",
  InitialClusterSize: Number("int"),
  ForceCreateJobs: true || false,
  LongTermPricingIds: [ // LongTermPricingIdList
    "STRING_VALUE",
  ],
  SnowballCapacityPreference: "T50" || "T80" || "T100" || "T42" || "T98" || "T8" || "T14" || "T32" || "NoPreference" || "T240" || "T13",
};
const command = new CreateClusterCommand(input);
const response = await client.send(command);
// { // CreateClusterResult
//   ClusterId: "STRING_VALUE",
//   JobListEntries: [ // JobListEntryList
//     { // JobListEntry
//       JobId: "STRING_VALUE",
//       JobState: "New" || "PreparingAppliance" || "PreparingShipment" || "InTransitToCustomer" || "WithCustomer" || "InTransitToAWS" || "WithAWSSortingFacility" || "WithAWS" || "InProgress" || "Complete" || "Cancelled" || "Listing" || "Pending",
//       IsMaster: true || false,
//       JobType: "IMPORT" || "EXPORT" || "LOCAL_USE",
//       SnowballType: "STANDARD" || "EDGE" || "EDGE_C" || "EDGE_CG" || "EDGE_S" || "SNC1_HDD" || "SNC1_SSD" || "V3_5C" || "V3_5S" || "RACK_5U_C",
//       CreationDate: new Date("TIMESTAMP"),
//       Description: "STRING_VALUE",
//     },
//   ],
// };

Example Usage

Loading code editorLoading code editor

CreateClusterCommand Input

See CreateClusterCommandInput for more details

Parameter	Type	Description
`AddressId` Required	`string \| undefined`	The ID for the address that you want the cluster shipped to.
`JobType` Required	`JobType \| undefined`	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.
`ShippingOption` Required	`ShippingOption \| undefined`	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.
`SnowballType` Required	`SnowballType \| undefined`	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.
`Description`	`string \| undefined`	An optional description of this specific cluster, for example `Environmental Data Cluster-01`.
`ForceCreateJobs`	`boolean \| undefined`	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`.
`ForwardingAddressId`	`string \| undefined`	The forwarding address ID for a cluster. This field is not supported in most regions.
`InitialClusterSize`	`number \| undefined`	If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.
`KmsKeyARN`	`string \| undefined`	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).
`LongTermPricingIds`	`string[] \| undefined`	Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.
`Notification`	`Notification \| undefined`	The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
`OnDeviceServiceConfiguration`	`OnDeviceServiceConfiguration \| undefined`	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).
`RemoteManagement`	`RemoteManagement \| undefined`	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.
`Resources`	`JobResource \| undefined`	The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language.
`RoleARN`	`string \| undefined`	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).
`SnowballCapacityPreference`	`SnowballCapacity \| undefined`	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.
`TaxDocuments`	`TaxDocuments \| undefined`	The tax documents required in your Amazon Web Services Region.

CreateClusterCommand Output

See CreateClusterCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`ClusterId`	`string \| undefined`	The automatically generated ID for a cluster.
`JobListEntries`	`JobListEntry[] \| undefined`	List of jobs created for this cluster. For syntax, see ListJobsResult$JobListEntries in this guide.

Throws

Name	Fault	Details
Ec2RequestFailedException	client	Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.
InvalidInputCombinationException	client	Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.
InvalidResourceException	client	The specified resource can't be found. Check the information you provided in your last request, and try again.
KMSRequestFailedException	client	The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
SnowballServiceException		Base exception class for all service exceptions from Snowball service.

Getting Started

References