CreateLocationFsxWindows - AWS DataSync

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

CreateLocationFsxWindows

建立 Amazon FSx for Windows File Server 檔案系統的傳輸位置。 AWS DataSync 可以使用此位置做為傳輸資料的來源或目的地。

開始之前,請確定您了解 DataSync 如何存取 FSx for Windows File Server 檔案系統

請求語法

{ "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "Domain": "string", "FsxFilesystemArn": "string", "Password": "string", "SecurityGroupArns": [ "string" ], "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "User": "string" }

請求參數

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

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

CmkSecretConfig

指定 DataSync 受管秘密的組態資訊,其中包含 DataSync 使用客戶受管存取特定 FSx Windows 儲存位置的密碼 AWS KMS key。

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

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

注意

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

類型:CmkSecretConfig 物件

必要:否

CustomSecretConfig

指定客戶受管 Secrets Manager 秘密的組態資訊,其中 FSx for Windows File Server 儲存位置的密碼存放在 Secrets Manager 的純文字中。此組態包含秘密 ARN,以及提供秘密存取權之 IAM 角色的 ARN。如需詳細資訊,請參閱使用您管理的秘密

注意

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

類型:CustomSecretConfig 物件

必要:否

Domain

指定 FSx for Windows File Server 檔案系統所屬的 Windows 網域名稱。

如果您的環境中有多個 Active Directory 網域,請設定此參數可確保 DataSync 連線至正確的檔案系統。

類型:字串

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

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

必要:否

FsxFilesystemArn

指定 FSx for Windows File Server 檔案系統的 Amazon Resource Name (ARN)。

類型:字串

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

模式:^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$

必要:是

Password

指定具有許可的使用者密碼,以掛載和存取 FSx for Windows File Server 檔案系統中的檔案、資料夾和檔案中繼資料。

類型:字串

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

模式:^.{0,104}$

必要:否

SecurityGroupArns

指定 Amazon EC2 安全群組ARNs,可讓您存取檔案系統偏好的子網路。

您指定的安全群組必須能夠與檔案系統的安全群組通訊。如需為檔案系統存取設定安全群組的詳細資訊,請參閱 Amazon FSx for Windows File Server 使用者指南

注意

如果您選擇不允許其本身連線的安全群組,請執行下列其中一項操作:

  • 設定安全群組以允許其自行通訊。

  • 選擇可與掛載目標安全群組通訊的不同安全群組。

類型:字串陣列

陣列成員:項目數下限為 1。項目數上限為 5。

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

模式:^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$

必要:是

Subdirectory

使用正斜線指定檔案系統的掛載路徑。這是 DataSync 讀取或寫入資料的位置 (取決於這是來源還是目的地位置)。

類型:字串

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

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

必要:否

Tags

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

類型:TagListEntry 物件陣列

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

必要:否

User

指定具有許可的使用者,以掛載和存取 FSx for Windows File Server 檔案系統中的檔案、資料夾和檔案中繼資料。

如需有關為傳輸選擇具有適當存取層級的使用者的資訊,請參閱 FSx for Windows File Server 位置的必要許可

類型:字串

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

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

必要:是

回應語法

{ "LocationArn": "string" }

回應元素

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

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

LocationArn

您建立的 FSx for Windows File Server 檔案系統位置的 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 的詳細資訊,請參閱下列內容: