Transfer Family Connector

AWS Transfer Family Connector is a resource that defines the connection details for integrating AWS Transfer Family with external systems or services. It allows secure, managed file transfers by specifying endpoints, authentication methods, and related configuration. This enables organizations to exchange data with partners or applications outside AWS while maintaining compliance and security.

aws.transfer_connector

Fields

TitleIDTypeData TypeDescription
_keycorestring
access_rolecorestringConnectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use. For AS2 connectors With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer. If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key. For SFTP connectors Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to Secrets Manager.
account_idcorestring
arncorestringThe unique Amazon Resource Name (ARN) for the connector.
as2_configcorejsonA structure that contains the parameters for an AS2 connector object.
connector_idcorestringThe unique identifier for the connector.
logging_rolecorestringThe Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.
security_policy_namecorestringThe text name of the security policy for the specified connector.
service_managed_egress_ip_addressescorearray<string>The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
sftp_configcorejsonA structure that contains the parameters for an SFTP connector object.
tagscorehstore
urlcorestringThe URL of the partner's AS2 or SFTP endpoint.