AWS::Transfer::Connector
Creates the connector, which captures the parameters for an outbound connection for the AS2 protocol. The connector is required for sending files to an externally hosted AS2 server. For more details about connectors, see Create AS2 connectors.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Transfer::Connector", "Properties" : { "AccessRole" :
String
, "As2Config" :As2Config
, "LoggingRole" :String
, "Tags" :[ Tag, ... ]
, "Url" :String
} }
YAML
Type: AWS::Transfer::Connector Properties: AccessRole:
String
As2Config:As2Config
LoggingRole:String
Tags:- Tag
Url:String
Properties
AccessRole
-
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, theAccessRole
needs to provide read and write access to the parent directory of the file location used in theStartFileTransfer
request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send withStartFileTransfer
.Required: Yes
Type: String
Minimum:
20
Maximum:
2048
Pattern:
arn:.*role/.*
Update requires: No interruption
As2Config
-
A structure that contains the parameters for a connector object.
Required: Yes
Type: As2Config
Update requires: No interruption
LoggingRole
-
The Amazon Resource Name (ARN) of the AWS 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.
Required: No
Type: String
Minimum:
20
Maximum:
2048
Pattern:
arn:.*role/.*
Update requires: No interruption
Tags
-
Key-value pairs that can be used to group and search for connectors.
Required: No
Type: List of Tag
Maximum:
50
Update requires: No interruption
Url
-
The URL of the partner's AS2 endpoint.
Required: Yes
Type: String
Maximum:
255
Update requires: No interruption