

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# CreateCluster
<a name="API_CreateCluster"></a>

**注意**  
 AWS Snowball 邊緣 不再提供給新客戶。新客戶應探索[AWS DataSync](https://aws.amazon.com/datasync/)線上傳輸、用於安全實體傳輸的[AWS 資料傳輸終端機](https://aws.amazon.com/data-transfer-terminal/)，或 AWS 合作夥伴解決方案。針對邊緣運算，探索 [AWS Outposts](https://aws.amazon.com/outposts/)。

建立空的叢集。每個叢集支援五個節點。您可以分別使用 [CreateJob](API_CreateJob.md)動作來為每個節點建立任務。在建立這五個節點任務之前，叢集不會運送。

## 請求語法
<a name="API_CreateCluster_RequestSyntax"></a>

```
{
   "AddressId": "string",
   "Description": "string",
   "ForceCreateJobs": boolean,
   "ForwardingAddressId": "string",
   "InitialClusterSize": number,
   "JobType": "string",
   "KmsKeyARN": "string",
   "LongTermPricingIds": [ "string" ],
   "Notification": { 
      "DevicePickupSnsTopicARN": "string",
      "JobStatesToNotify": [ "string" ],
      "NotifyAll": boolean,
      "SnsTopicARN": "string"
   },
   "OnDeviceServiceConfiguration": { 
      "EKSOnDeviceService": { 
         "EKSAnywhereVersion": "string",
         "KubernetesVersion": "string"
      },
      "NFSOnDeviceService": { 
         "StorageLimit": number,
         "StorageUnit": "string"
      },
      "S3OnDeviceService": { 
         "FaultTolerance": number,
         "ServiceSize": number,
         "StorageLimit": number,
         "StorageUnit": "string"
      },
      "TGWOnDeviceService": { 
         "StorageLimit": number,
         "StorageUnit": "string"
      }
   },
   "RemoteManagement": "string",
   "Resources": { 
      "Ec2AmiResources": [ 
         { 
            "AmiId": "string",
            "SnowballAmiId": "string"
         }
      ],
      "LambdaResources": [ 
         { 
            "EventTriggers": [ 
               { 
                  "EventResourceARN": "string"
               }
            ],
            "LambdaArn": "string"
         }
      ],
      "S3Resources": [ 
         { 
            "BucketArn": "string",
            "KeyRange": { 
               "BeginMarker": "string",
               "EndMarker": "string"
            },
            "TargetOnDeviceServices": [ 
               { 
                  "ServiceName": "string",
                  "TransferOption": "string"
               }
            ]
         }
      ]
   },
   "RoleARN": "string",
   "ShippingOption": "string",
   "SnowballCapacityPreference": "string",
   "SnowballType": "string",
   "TaxDocuments": { 
      "IND": { 
         "GSTIN": "string"
      }
   }
}
```

## 請求參數
<a name="API_CreateCluster_RequestParameters"></a>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

請求接受採用 JSON 格式的下列資料。

 ** [AddressId](#API_CreateCluster_RequestSyntax) **   <a name="Snowball-CreateCluster-request-AddressId"></a>
您要叢集運送目的地之地址的 ID。  
類型：字串  
長度限制：固定長度為 40。  
模式：`ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`  
必要：是

 ** [Description](#API_CreateCluster_RequestSyntax) **   <a name="Snowball-CreateCluster-request-Description"></a>
此特定叢集的選用描述，例如 `Environmental Data Cluster-01`。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`.*`  
必要：否

 ** [ForceCreateJobs](#API_CreateCluster_RequestSyntax) **   <a name="Snowball-CreateCluster-request-ForceCreateJobs"></a>
當使用者嘗試過度佈建或佈建不足叢集時，強制 建立叢集。如果叢集的初始大小大於 （過度佈建） 或小於 （過度佈建），則叢集會過度佈建或佈建不足，以符合 指定的容量需求`OnDeviceServiceConfiguration`。  
類型：布林值  
必要：否

 ** [ForwardingAddressId](#API_CreateCluster_RequestSyntax) **   <a name="Snowball-CreateCluster-request-ForwardingAddressId"></a>
您的區域不支援此欄位。  
類型：字串  
長度限制：固定長度為 40。  
模式：`ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`  
必要：否

 ** [InitialClusterSize](#API_CreateCluster_RequestSyntax) **   <a name="Snowball-CreateCluster-request-InitialClusterSize"></a>
如果提供，則會自動建立每個任務並與新叢集建立關聯。如果未提供， 將被視為 0。  
類型：整數  
有效範圍：最小值為 0。最大值為 16。  
必要：否

 ** [JobType](#API_CreateCluster_RequestSyntax) **   <a name="Snowball-CreateCluster-request-JobType"></a>
此叢集的任務類型。目前，叢集支援的唯一任務類型是 `LOCAL_USE`。  
如需 Snowball Edge 裝置類型的資訊，請參閱《Snowball Edge 開發人員指南》中的[裝置硬體資訊](https://docs.aws.amazon.com/snowball/latest/developer-guide/device-differences.html)。  
類型：字串  
有效值:`IMPORT | EXPORT | LOCAL_USE`   
必要：是

 ** [KmsKeyARN](#API_CreateCluster_RequestSyntax) **   <a name="Snowball-CreateCluster-request-KmsKeyARN"></a>
您要與此叢集建立關聯的`KmsKeyARN`值。 `KmsKeyARN`值是透過在 AWS Key Management Service (AWS KMS) 中使用 [CreateKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) API 動作來建立。  
類型：字串  
長度限制：長度上限為 255。  
模式：`arn:aws.*:kms:.*:[0-9]{12}:key/.*`  
必要：否

 ** [LongTermPricingIds](#API_CreateCluster_RequestSyntax) **   <a name="Snowball-CreateCluster-request-LongTermPricingIds"></a>
列出長期定價 ID，用於與為新叢集自動建立的任務建立關聯。  
類型：字串陣列  
長度限制：固定長度為 41。  
模式：`LTPID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`  
必要：否

 ** [Notification](#API_CreateCluster_RequestSyntax) **   <a name="Snowball-CreateCluster-request-Notification"></a>
此叢集的 Amazon Simple Notification Service (Amazon SNS) 通知設定。  
類型：[Notification](API_Notification.md) 物件  
必要：否

 ** [OnDeviceServiceConfiguration](#API_CreateCluster_RequestSyntax) **   <a name="Snowball-CreateCluster-request-OnDeviceServiceConfiguration"></a>
指定 Snowball Edge 裝置上的 服務或 服務，您傳輸的資料將從其中匯出或匯入至其中。 AWS Snowball Edge 裝置叢集支援 Amazon S3 和 NFS （網路檔案系統）。  
類型：[OnDeviceServiceConfiguration](API_OnDeviceServiceConfiguration.md) 物件  
必要：否

 ** [RemoteManagement](#API_CreateCluster_RequestSyntax) **   <a name="Snowball-CreateCluster-request-RemoteManagement"></a>
可讓您從內部網路外部安全地操作和管理叢集中的 Snow 裝置。設定為 時`INSTALLED_AUTOSTART`，當裝置到達您的位置時，將會自動提供遠端管理。否則，您需要使用 Snowball 用戶端來管理裝置。  
類型：字串  
有效值:`INSTALLED_ONLY | INSTALLED_AUTOSTART | NOT_INSTALLED`   
必要：否

 ** [Resources](#API_CreateCluster_RequestSyntax) **   <a name="Snowball-CreateCluster-request-Resources"></a>
與叢集任務相關聯的資源。這些資源包括 Amazon S3 儲存貯體，以及以 Python 語言撰寫的選用 AWS Lambda 函數。  
類型：[JobResource](API_JobResource.md) 物件  
必要：否

 ** [RoleARN](#API_CreateCluster_RequestSyntax) **   <a name="Snowball-CreateCluster-request-RoleARN"></a>
`RoleARN` 您要與此叢集建立關聯的 。 `RoleArn`值是透過在 AWS Identity and Access Management (IAM) 中使用 [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) API 動作來建立。  
類型：字串  
長度限制：長度上限為 255。  
模式：`arn:aws.*:iam::[0-9]{12}:role/.*`  
必要：否

 ** [ShippingOption](#API_CreateCluster_RequestSyntax) **   <a name="Snowball-CreateCluster-request-ShippingOption"></a>
此叢集中每個節點的運送速度。此速度不會決定您會多快取得每個 Snowball Edge 裝置，而是代表每個裝置在傳輸時移動到目的地的速度。區域運送速度如下：  
+ 在澳洲，您可以存取快速運送。一般而言，Snow 裝置運送快遞大約會在一天內交付。
+ 在歐盟 (EU)，您可以存取快速運送。一般而言，Snow 裝置運送快遞大約會在一天內交付。此外，歐盟內的大部分國家採用標準運送方式，通常不需一週即可送達。
+ 在印度，Snow 裝置會在一到七天內交付。
+ 在美國 (US)，您可以使用 1 天運送和 2 天運送。
+ 在澳洲，您可以存取快速運送。一般而言，Express 運送的裝置大約會在一天內交付。
+ 在歐盟 (EU)，您可以存取快速運送。一般而言，Snow 裝置運送快遞大約會在一天內交付。此外，歐盟內的大部分國家採用標準運送方式，通常不需一週即可送達。
+ 在印度，Snow 裝置會在一到七天內交付。
+ 在美國，您可以使用 1 天運送和 2 天運送。
類型：字串  
有效值:`SECOND_DAY | NEXT_DAY | EXPRESS | STANDARD`   
必要：是

 ** [SnowballCapacityPreference](#API_CreateCluster_RequestSyntax) **   <a name="Snowball-CreateCluster-request-SnowballCapacityPreference"></a>
如果您的任務是在其中一個美國區域建立，您可以選擇指定此任務所需的 Snow 裝置大小。在所有其他區域中，Snowball 隨附 80 TB 的儲存容量。  
如需有關 Snowball Edge 裝置類型的資訊，請參閱《Snowball Edge 開發人員指南》中的[裝置硬體資訊](/snowball/latest/developer-guide/device-differences.html)。  
類型：字串  
有效值:`T50 | T80 | T100 | T42 | T98 | T8 | T14 | T32 | NoPreference | T240 | T13`   
必要：否

 ** [SnowballType](#API_CreateCluster_RequestSyntax) **   <a name="Snowball-CreateCluster-request-SnowballType"></a>
要用於此叢集的 Snow Family 裝置類型。  
對於叢集任務， AWS Snowball Edge 目前僅支援 `EDGE` 裝置類型。
如需有關 Snowball Edge 裝置類型的資訊，請參閱《Snowball Edge 開發人員指南》中的[裝置硬體資訊](https://docs.aws.amazon.com/snowball/latest/developer-guide/device-differences.html)。  
類型：字串  
有效值:`STANDARD | EDGE | EDGE_C | EDGE_CG | EDGE_S | SNC1_HDD | SNC1_SSD | V3_5C | V3_5S | RACK_5U_C`   
必要：是

 ** [TaxDocuments](#API_CreateCluster_RequestSyntax) **   <a name="Snowball-CreateCluster-request-TaxDocuments"></a>
您的 中所需的稅務文件 AWS 區域。  
類型：[TaxDocuments](API_TaxDocuments.md) 物件  
必要：否

## 回應語法
<a name="API_CreateCluster_ResponseSyntax"></a>

```
{
   "ClusterId": "string",
   "JobListEntries": [ 
      { 
         "CreationDate": number,
         "Description": "string",
         "IsMaster": boolean,
         "JobId": "string",
         "JobState": "string",
         "JobType": "string",
         "SnowballType": "string"
      }
   ]
}
```

## 回應元素
<a name="API_CreateCluster_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [ClusterId](#API_CreateCluster_ResponseSyntax) **   <a name="Snowball-CreateCluster-response-ClusterId"></a>
叢集自動產生的 ID。  
類型：字串  
長度限制：固定長度為 39。  
模式：`CID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`

 ** [JobListEntries](#API_CreateCluster_ResponseSyntax) **   <a name="Snowball-CreateCluster-response-JobListEntries"></a>
為此叢集建立的任務清單。如需語法，請參閱本指南中的 [ListJobsResult\$1JobListEntries](https://amazonaws.com/snowball/latest/api-reference/API_ListJobs.html#API_ListJobs_ResponseSyntax)。  
類型：[JobListEntry](API_JobListEntry.md) 物件陣列

## 錯誤
<a name="API_CreateCluster_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** Ec2RequestFailedException **   
您的使用者缺少執行嘗試動作所需的 Amazon EC2 許可。  
HTTP 狀態碼：400

 ** InvalidInputCombinationException **   
任務或叢集建立失敗。一或多個輸入無效。確認 [CreateCluster：SnowballType](#Snowball-CreateCluster-request-SnowballType) 值支援您的 [CreateJob：JobType](API_CreateJob.md#Snowball-CreateJob-request-JobType)，然後再試一次。  
HTTP 狀態碼：400

 ** InvalidResourceException **   
找不到指定的資源。請檢查您在上次請求中提供的資訊，然後再試一次。    
 ** ResourceType **   
提供的資源值無效。
HTTP 狀態碼：400

 ** KMSRequestFailedException **   
提供的 AWS Key Management Service 金鑰缺少執行指定 [CreateJob](API_CreateJob.md)或 [UpdateJob](API_UpdateJob.md)動作的許可。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateCluster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/snowball-2016-06-30/CreateCluster) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/snowball-2016-06-30/CreateCluster) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/snowball-2016-06-30/CreateCluster) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/snowball-2016-06-30/CreateCluster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/snowball-2016-06-30/CreateCluster) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/snowball-2016-06-30/CreateCluster) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/snowball-2016-06-30/CreateCluster) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/snowball-2016-06-30/CreateCluster) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/snowball-2016-06-30/CreateCluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/snowball-2016-06-30/CreateCluster) 