CreateLocationFsxWindows - AWS DataSync

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

CreateLocationFsxWindows

FSx 为亚马逊 Windows 文件服务器文件系统创建传输位置。 AWS DataSync 可以将此位置用作传输数据的源或目的地。

在开始之前,请务必了解 Windows 文件服务器文件系统的 DataSync访问 FSx 方式。

请求语法

{ "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" }

请求参数

有关所有操作的通用参数的信息,请参阅常用参数

请求接受采用 JSON 格式的以下数据。

CmkSecretConfig

指定由客户 DataSync AWS KMS key管理的密钥的配置信息,其中包括 DataSync 用于访问特定 FSx Windows 存储位置的密码。

当您在CreateLocationFsxWindows请求中包含此参数时,您仅提供 KMS 密钥 ARN。 DataSync 使用此 KMS 密钥和Password您为指定的密钥来创建存储位置访问凭证的 DataSync托管密钥。

确保该用户 DataSync 有权访问您指定的 KMS 密钥。有关更多信息,请参阅使用使用自定义 AWS KMS key密钥加密的服务托管密钥

注意

可使用 CmkSecretConfig(带有 Password)或 CustomSecretConfig(不带 Password)为 CreateLocationFsxWindows 请求提供凭证。不要为同一个请求提供这两个参数。

类型:CmkSecretConfig 对象

必需:否

CustomSecretConfig

指定客户管理的 Secr FSx ets Manager 密钥的配置信息,其中 Windows 文件服务器存储位置的密码以纯文本形式存储在 Secrets Manager 中。此配置包括密钥 ARN,以及提供密钥访问权限的 IAM 角色的 ARN。有关更多信息,请参阅使用您管理的密钥

注意

可使用 CmkSecretConfig(带有 Password)或 CustomSecretConfig(不带 Password)为 CreateLocationFsxWindows 请求提供凭证。不要为同一个请求提供这两个参数。

类型:CustomSecretConfig 对象

必需:否

Domain

指定 Windows 文件服务器文件系统所属 FSx 的 Windows 域的名称。

如果您的环境中有多个 Active Directory 域,则配置此参数可确保这些域 DataSync 连接到正确的文件系统。

类型:字符串

长度约束:最大长度为 253。

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

必需:否

FsxFilesystemArn

为 Windows 文件服务器文件系统指定亚马逊资源名称 (ARN)。 FSx

类型:字符串

长度限制:最大长度为 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 的 Windows 文件服务器文件系统中的文件、文件夹和文件元数据的用户的密码。

类型:字符串

长度约束:最大长度为 104。

模式:^.{0,104}$

必需:否

SecurityGroupArns

指定提供对文件系统首选子网访问权限的 Amazon EC2 安全组的 ARN。

您指定的安全组必须能够与文件系统的安全组通信。有关为文件系统访问配置安全组的信息,请参阅《Amazon f FSx or Windows 文件服务器用户指南》

注意

如果您选择的安全组不允许从其自身进行连接,请执行以下操作之一:

  • 将安全组配置为允许其在自身内部进行通信。

  • 选择可与挂载目标的安全组进行通信的其他安全组。

类型:字符串数组

数组成员:最少 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 的 Windows 文件服务器文件系统中的文件、文件夹和文件元数据的用户。

有关选择具有适当访问权限级别的用户进行传输的信息,请参阅 Windows 文件服务器位置 FSx 所需的权限

类型:字符串

长度约束:最大长度为 104。

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

必需:是

响应语法

{ "LocationArn": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

LocationArn

您创建的 Windows 文件服务器文件系统位置的 ARN。 FSx

类型:字符串

长度限制:最大长度为 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

另请参阅

有关以特定语言之一使用此 API 的更多信息 AWS SDKs,请参阅以下内容: