CreateLocationObjectStorage - AWS DataSync
請求語法請求參數回應語法回應元素錯誤另請參閱

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

CreateLocationObjectStorage

建立物件儲存系統的傳輸位置。 AWS DataSync 可以使用此位置做為傳輸資料的來源或目的地。您可以使用或不使用 DataSync 代理程式進行傳輸。

開始之前，請確定您了解 DataSync 使用物件儲存系統的先決條件。

請求語法

{
   "AccessKey": "string",
   "AgentArns": [ "string" ],
   "BucketName": "string",
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "SecretKey": "string",
   "ServerCertificate": blob,
   "ServerHostname": "string",
   "ServerPort": number,
   "ServerProtocol": "string",
   "Subdirectory": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

請求參數

如需所有動作的一般參數資訊，請參閱《Common Parameters》。

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

AccessKey

如果需要憑證才能與物件儲存伺服器進行驗證，請指定存取金鑰 (例如，使用者名稱)。

類型：字串

長度限制：長度下限為 0。長度上限為 200。

模式：^.*$

必要：否

AgentArns

（選用） 指定可與物件儲存系統連線之 DataSync 代理程式的 Amazon Resource Name (ARNs)。如果您要設定無代理程式跨雲端傳輸，則不需要為此參數指定值。

注意

首次建立儲存位置時，請務必正確設定此參數。您無法在建立代理程式之後，從儲存位置新增或移除代理程式。

類型：字串陣列

陣列成員：項目數下限為 1。最多 8 個項目。

長度限制：長度上限為 128。

模式：^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$

必要：否

BucketName

指定傳輸中涉及的物件儲存貯體的名稱。

類型：字串

長度限制：長度下限為 3。長度上限為 63。

模式：^[a-zA-Z0-9_\-\+\.\(\)\$\p{Zs}]+$

必要：是

CmkSecretConfig

指定 DataSync 受管秘密的組態資訊，其中包括 SecretKey DataSync 使用客戶受管存取特定物件儲存位置的 AWS KMS key。

當您將此參數包含在CreateLocationObjectStorage請求中時，您只需提供 KMS 金鑰 ARN。DataSync 會將此 KMS 金鑰與您為 SecretKey 參數指定的值搭配使用，以建立 DataSync 受管秘密來存放位置存取憑證。

請確定 DataSync 具有存取您指定 KMS 金鑰的許可。如需詳細資訊，請參閱使用以自訂加密的服務受管秘密 AWS KMS key。

注意

您可以使用 CmkSecretConfig（搭配 SecretKey) 或 CustomSecretConfig（不含 SecretKey) 來提供CreateLocationObjectStorage請求的登入資料。請勿為相同的請求提供這兩個參數。

類型：CmkSecretConfig 物件

必要：否

CustomSecretConfig

指定客戶受管 Secrets Manager 秘密的組態資訊，其中特定物件儲存位置的私密金鑰會以純文字儲存在 Secrets Manager 中。此組態包含秘密 ARN，以及提供秘密存取權之 IAM 角色的 ARN。如需詳細資訊，請參閱使用您管理的秘密。

注意

您可以使用 CmkSecretConfig（搭配 SecretKey) 或 CustomSecretConfig（不含 SecretKey) 來提供CreateLocationObjectStorage請求的登入資料。請勿為相同的請求提供這兩個參數。

類型：CustomSecretConfig 物件

必要：否

SecretKey

如果需要憑證才能與物件儲存伺服器進行驗證，請指定私密金鑰 (例如，密碼)。

注意

如果您使用 提供秘密SecretKey，但未使用 CmkSecretConfig或 提供秘密組態詳細資訊CustomSecretConfig，則 DataSync 會使用您 AWS 帳戶的 Secrets Manager 秘密來存放字符。

類型：字串

長度限制：長度下限為 0。長度上限為 200。

模式：^.*$

必要：否

ServerCertificate

如果系統使用私有或自我簽署憑證授權單位 (CA)，則指定 DataSync 的憑證鏈來驗證您的物件儲存系統。您必須指定具有完整憑證鏈的單一.pem檔案 （例如 file:///home/user/.ssh/object_storage_certificates.pem)。

憑證鏈可能包括：

  • 物件儲存系統的憑證

  • 所有中繼憑證 （如果有的話）

  • 簽署 CA 的根憑證

您可以將憑證串連至.pem檔案 （在 base64 編碼之前最多可達 32768 個位元組）。下列範例cat命令會建立包含三個憑證object_storage_certificates.pem的檔案：

cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem

若要使用此參數，請將 ServerProtocol設定為 HTTPS。

類型：Base64 編碼的二進位資料物件

長度限制：長度上限為 32768。

必要：否

ServerHostname

指定 DataSync 代理程式連線之物件儲存伺服器的網域名稱或 IP 地址 (IPv4 或 IPv6)。

類型：字串

長度限制：長度上限為 255。

模式：^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$

必要：是

ServerPort

指定物件儲存伺服器接受傳入網路流量的連接埠 (例如，連接埠 443)。

類型：整數

有效範圍：最小值為 1。最大值為 65536。

必要：否

ServerProtocol

指定物件儲存伺服器用來通訊的通訊協定。若未指定，預設值為 HTTPS。

類型：字串

有效值:HTTPS | HTTP

必要：否

Subdirectory

指定物件儲存伺服器的物件字首。如果這是來源位置，DataSync 只會複製具有此字首的物件。如果這是目的地位置，DataSync 會寫入具有此字首的所有物件。

類型：字串

長度限制：長度上限為 4096。

模式：^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$

必要：否

Tags

指定代表您要新增至資源之標籤的鍵/值對。標籤可協助您管理、篩選和搜尋資源。建議您為位置建立名稱標籤。

類型：TagListEntry 物件陣列

陣列成員：項目數下限為 0。項目數上限為 50。

必要：否

回應語法

{
   "LocationArn": "string"
}

回應元素

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

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

LocationArn

指定您建立之物件儲存系統位置的 ARN。

類型：字串

長度限制：長度上限為 128。

模式：^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

錯誤

如需所有動作常見錯誤的資訊，請參閱常見錯誤。

InternalException

當服務發生錯誤 AWS DataSync 時，會擲回此例外狀況。

HTTP 狀態碼：500

InvalidRequestException

當用戶端提交格式不正確的請求時，會擲回此例外狀況。

HTTP 狀態碼：400

另請參閱

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：