CreateLocationSmb

為伺服器訊息區塊 (SMB) 檔案伺服器建立傳輸位置。 AWS DataSync 可以使用此位置做為傳輸資料的來源或目的地。

開始之前，請確定您了解 DataSync 如何存取 SMB 檔案伺服器。如需詳細資訊，請參閱提供 SMB 檔案伺服器的 DataSync 存取權。

請求語法


{
   "AgentArns": [ "string" ],
   "AuthenticationType": "string",
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "DnsIpAddresses": [ "string" ],
   "Domain": "string",
   "KerberosKeytab": blob,
   "KerberosKrb5Conf": blob,
   "KerberosPrincipal": "string",
   "MountOptions": { 
      "Version": "string"
   },
   "Password": "string",
   "ServerHostname": "string",
   "Subdirectory": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "User": "string"
}

請求參數

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

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

AgentArns

指定可連線至 SMB 檔案伺服器的 DataSync 代理程式（或代理程式）。您可以使用代理程式的 Amazon Resource Name (ARN) 來指定代理程式。

類型：字串陣列

陣列成員：項目數下限為 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}$

必要：是

AuthenticationType

指定 DataSync 用來連線至 SMB 檔案伺服器的身分驗證通訊協定。DataSync 支援 NTLM（預設）和KERBEROS身分驗證。

如需詳細資訊，請參閱提供 SMB 檔案伺服器的 DataSync 存取權。

類型：字串

有效值:NTLM | KERBEROS

必要：否

CmkSecretConfig

指定 DataSync 受管秘密的組態資訊，或 PasswordKerberosKeytab（分別為 NTLM（預設）和KERBEROS身分驗證類型），DataSync 會使用客戶受管存取特定 SMB 儲存位置 AWS KMS key。

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

請確定 DataSync 具有存取您指定 KMS 金鑰的許可。

注意

您可以使用 CmkSecretConfig（搭配 Password或 KerberosKeytab) 或 CustomSecretConfig（不含任何 Password和 KerberosKeytab) 來提供CreateLocationSmbRequest請求的登入資料。請勿同時為相同的請求提供 CmkSecretConfig和 CustomSecretConfig 參數。

類型：CmkSecretConfig 物件

必要：否

CustomSecretConfig

指定客戶受管 Secrets Manager 秘密的組態資訊，其中 SMB 儲存位置憑證會以純文字（適用於 Password) 或二進位（適用於 ) 形式存放在 Secrets Manager 中KerberosKeytab。此組態包含秘密 ARN，以及提供秘密存取權之 IAM 角色的 ARN。

注意

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

類型：CustomSecretConfig 物件

必要：否

DnsIpAddresses

指定 SMB 檔案伺服器所屬之 DNS 伺服器的 IPv4 或 IPv6 地址。此參數僅適用於 AuthenticationType 設為的情況KERBEROS。

如果您的環境中有多個網域，設定此參數可確保 DataSync 連線至正確的 SMB 檔案伺服器。

類型：字串陣列

陣列成員：最多 2 個項目。

長度限制：長度下限為 7。長度上限為 39。

模式：\A((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6}))\z

必要：否

Domain

指定 SMB 檔案伺服器所屬的 Windows 網域名稱。此參數僅適用於 AuthenticationType 設定為的情況NTLM。

如果您的環境中有多個網域，設定此參數可確保 DataSync 連線至正確的檔案伺服器。

類型：字串

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

模式：^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$

必要：否

KerberosKeytab

指定您的 Kerberos 金鑰資料表 (keytab) 檔案，其中包含 Kerberos 主體和加密金鑰之間的映射。

為了避免任務執行錯誤，請確定您用來建立 keytab 檔案的 Kerberos 主體與您為指定的完全相符KerberosPrincipal。

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

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

必要：否

KerberosKrb5Conf

指定定義 Kerberos 領域組態的 Kerberos 組態檔案 (krb5.conf)。

檔案必須為 base64 編碼。如果您使用的是 AWS CLI，編碼會為您完成。

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

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

必要：否

KerberosPrincipal

指定 Kerberos 主體，這是 Kerberos 領域中的身分，有權存取 SMB 檔案伺服器中的檔案、資料夾和檔案中繼資料。

Kerberos 主體可能看起來像 HOST/kerberosuser@MYDOMAIN.ORG。

主體名稱區分大小寫。如果您為此參數指定的委託人與您用來建立 keytab 檔案的委託人不完全相符，您的 DataSync 任務執行將會失敗。

類型：字串

長度限制：長度下限為 1。長度上限為 256。

模式：^.+$

必要：否

MountOptions

指定 DataSync 用來存取 SMB 檔案伺服器的 SMB 通訊協定版本。

類型：SmbMountOptions 物件

必要：否

Password

指定可掛載 SMB 檔案伺服器的使用者密碼，並具有存取傳輸所涉及檔案和資料夾的許可。此參數僅適用於 AuthenticationType 設定為的情況NTLM。

類型：字串

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

模式：^.{0,104}$

必要：否

ServerHostname

指定 DataSync 代理程式連線之 SMB 檔案伺服器的網域名稱或 IP 地址 (IPv4 或 IPv6)。

注意

如果您使用 Kerberos 身分驗證，則必須指定網域名稱。

類型：字串

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

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

必要：是

Subdirectory

指定由 SMB 檔案伺服器匯出的共用名稱，DataSync 會在其中讀取或寫入資料。您可以在共用路徑中包含子目錄（例如，/path/to/subdirectory)。請確定您網路中的其他 SMB 用戶端也可以掛載此路徑。

若要複製子目錄中的所有資料，DataSync 必須能夠掛載 SMB 共用並存取其所有資料。如需詳細資訊，請參閱提供 SMB 檔案伺服器的 DataSync 存取權。

類型：字串

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

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

必要：是

Tags

指定可協助您分類、篩選和搜尋 AWS 資源的標籤。建議您為位置建立至少一個名稱標籤。

類型：TagListEntry 物件陣列

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

必要：否

User

指定可掛載和存取 SMB 檔案伺服器中檔案、資料夾和檔案中繼資料的使用者。此參數僅適用於 AuthenticationType 設定為的情況NTLM。

如需選擇具有適當傳輸存取權層級之使用者的相關資訊，請參閱提供 SMB 檔案伺服器的 DataSync 存取權。

類型：字串

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

模式：^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$

必要：否

回應語法


{
   "LocationArn": "string"
}

回應元素

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

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

LocationArn

您建立之 SMB 位置的 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

範例

請求範例

下列範例會建立 SMB 檔案伺服器的位置。


{
   "AgentArns":[
      "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs",
      "arn:aws:datasync:us-east-2:111222333444:agent/agent-2345noo35nnee1123ovo3"
   ],
   "Domain":"AMAZON",
   "MountOptions":{
      "Version":"SMB3"
   },
   "Password":"string",
   "ServerHostname":"MyServer.amazon.com",
   "Subdirectory":"share",
   "Tags":[
      {
         "Key":"department",
         "Value":"finance"
      }
   ],
   "User":"user-1"
}

回應範例

回應會傳回 SMB 檔案伺服器的位置 ARN。


{
    "LocationArn": "arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49"
}

另請參閱

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

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

CreateLocationS3

CreateTask