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

# ClusterMetadata
<a name="API_ClusterMetadata"></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/)。

包含有關特定叢集的中繼資料。

## 目錄
<a name="API_ClusterMetadata_Contents"></a>

 ** AddressId **   <a name="Snowball-Type-ClusterMetadata-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}`  
必要：否

 ** ClusterId **   <a name="Snowball-Type-ClusterMetadata-ClusterId"></a>
叢集自動產生的 ID。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`.*`  
必要：否

 ** ClusterState **   <a name="Snowball-Type-ClusterMetadata-ClusterState"></a>
叢集的目前狀態。  
類型：字串  
有效值:`AwaitingQuorum | Pending | InUse | Complete | Cancelled`   
必要：否

 ** CreationDate **   <a name="Snowball-Type-ClusterMetadata-CreationDate"></a>
此叢集的建立日期。  
類型：Timestamp  
必要：否

 ** Description **   <a name="Snowball-Type-ClusterMetadata-Description"></a>
叢集的選用描述。  
類型：字串  
長度限制：長度下限為 1。長度上限為 1024。  
模式：`.*`  
必要：否

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

 ** JobType **   <a name="Snowball-Type-ClusterMetadata-JobType"></a>
此叢集的任務類型。目前，叢集支援的唯一任務類型為 `LOCAL_USE`。  
類型：字串  
有效值:`IMPORT | EXPORT | LOCAL_USE`   
必要：否

 ** KmsKeyARN **   <a name="Snowball-Type-ClusterMetadata-KmsKeyARN"></a>
與此叢集相關聯的 `KmsKeyARN` Amazon Resource Name (ARN)。此 ARN 是使用 [CreateKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html) API 動作 in AWS Key Management Service (AWS KMS。  
類型：字串  
長度限制：長度上限為 255。  
模式：`arn:aws.*:kms:.*:[0-9]{12}:key/.*`  
必要：否

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

 ** OnDeviceServiceConfiguration **   <a name="Snowball-Type-ClusterMetadata-OnDeviceServiceConfiguration"></a>
代表 AWS Snowball Edge 裝置上的 服務的中繼資料和組態設定。  
類型：[OnDeviceServiceConfiguration](API_OnDeviceServiceConfiguration.md) 物件  
必要：否

 ** Resources **   <a name="Snowball-Type-ClusterMetadata-Resources"></a>
可包含更新[JobResource](API_JobResource.md)物件或[S3Resource](API_S3Resource.md)物件的[LambdaResource](API_LambdaResource.md)物件陣列。  
類型：[JobResource](API_JobResource.md) 物件  
必要：否

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

 ** SnowballType **   <a name="Snowball-Type-ClusterMetadata-SnowballType"></a>
用於此叢集的 Snowball Edge 裝置類型。  
對於叢集任務， AWS Snowball Edge 目前僅支援`EDGE`裝置類型。
類型：字串  
有效值:`STANDARD | EDGE | EDGE_C | EDGE_CG | EDGE_S | SNC1_HDD | SNC1_SSD | V3_5C | V3_5S | RACK_5U_C`   
必要：否

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

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

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/snowball-2016-06-30/ClusterMetadata) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/snowball-2016-06-30/ClusterMetadata) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/snowball-2016-06-30/ClusterMetadata)