DescribedConnector - AWS Transfer Family

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

DescribedConnector

描述连接器的参数,由ConnectorId标识。

内容

Arn

的唯一 Amazon 资源名称(ARN)。

类型:字符串

长度约束:最小长度为 20。长度上限为 1600。

模式:arn:\S+

必需:是

AccessRole

连接器用于通过 AS2 或 SFTP 协议发送文件。对于访问角色,请提供要使用的 AWS Identity and Access Management 角色的 Amazon 资源名称 (ARN)。

对于 AS2 连接器

借助 AS2,您可以通过调用 StartFileTransfer 并在请求参数中指定文件路径 SendFilePaths 来发送文件。我们使用文件的父目录(例如 --send-file-paths /bucket/dir/file.txt,父目录是 /bucket/dir/)来临时存储经过处理的 AS2 消息文件,存储 MDN(当从合作伙伴那里收到时),以及写入包含传输相关元数据的最终 JSON 文件。因此,AccessRole 需要提供对 StartFileTransfer 请求中所使用文件位置父目录的读取和写入权限。此外,您还需要提供对您想要使用 StartFileTransfer 发送的文件父目录的读取和写入权限。

如果您对 AS2 连接器执行基本身份验证,则访问角色需要密钥secretsmanager:GetSecretValue权限。如果使用客户管理的密钥而不是 Secrets Manager 中的 AWS 托管密钥对密钥进行加密,则该角色还需要该密钥的kms:Decrypt权限。

对于 SFTP 连接器

因此, 确保提供对 StartFileTransfer 请求中所使用文件位置父目录的读取和写入权限。此外,请确保该角色向提供secretsmanager:GetSecretValue权限 AWS Secrets Manager。

类型:字符串

长度约束:最小长度为 20。最大长度为 2048。

模式:arn:.*role/\S+

必需:否

As2Config

包含 AS2 连接器对象参数的结构。

类型:As2ConnectorConfig 对象

必需:否

ConnectorId

连接器的唯一标识符。

类型:字符串

长度限制:固定长度为 19。

模式:c-([0-9a-f]{17})

必需:否

LoggingRole

(IAM) 角色的亚马逊资源名称 AWS Identity and Access Management (ARN),它允许连接器开启对 Amazon S3 CloudWatch 事件的日志记录。设置后,您可以在 CloudWatch 日志中查看连接器活动。

类型:字符串

长度约束:最小长度为 20。最大长度为 2048。

模式:arn:.*role/\S+

必需:否

SecurityPolicyName

指定连接器的安全策略的文本名称。

类型:字符串

长度限制:长度下限为 0。最大长度为 100。

模式:TransferSFTPConnectorSecurityPolicy-[A-Za-z0-9-]+

必需:否

ServiceManagedEgressIpAddresses

此连接器的出口 IP 地址列表。这些 IP 地址是在您创建连接器时自动分配的。

类型:字符串数组

模式:\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}

必需:否

SftpConfig

包含 SFTP 连接器对象参数的结构。

类型:SftpConnectorConfig 对象

必需:否

Tags

可用于分组和搜索连接器的键/值对。

类型:Tag 对象数组

数组成员:最少 1 个物品。最多 50 项。

必需:否

Url

合作伙伴的 AS2 或 SFTP 端点的 URL。

类型:字符串

长度约束:最小长度为 0。最大长度为 255。

必需:否

另请参阅

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