aws_transfer_agreement

access_role

Type: STRING
Provider name: AccessRole
Description: Connectors 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_id

Type: STRING

agreement_id

Type: STRING
Provider name: AgreementId
Description: A unique identifier for the agreement. This identifier is returned when you create an agreement.

arn

Type: STRING
Provider name: Arn
Description: The unique Amazon Resource Name (ARN) for the agreement.

base_directory

Type: STRING
Provider name: BaseDirectory
Description: The landing directory (folder) for files that are transferred by using the AS2 protocol.

custom_directories

Type: STRUCT
Provider name: CustomDirectories
Description: A CustomDirectoriesType structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.

• Failed files
• MDN files
• Payload files
• Status files
• Temporary files

• failed_files_directory
  Type: STRING
  Provider name: FailedFilesDirectory
  Description: Specifies a location to store failed AS2 message files.
  
• mdn_files_directory
  Type: STRING
  Provider name: MdnFilesDirectory
  Description: Specifies a location to store MDN files.
  
• payload_files_directory
  Type: STRING
  Provider name: PayloadFilesDirectory
  Description: Specifies a location to store the payload for AS2 message files.
  
• status_files_directory
  Type: STRING
  Provider name: StatusFilesDirectory
  Description: Specifies a location to store AS2 status messages.
  
• temporary_files_directory
  Type: STRING
  Provider name: TemporaryFilesDirectory
  Description: Specifies a location to store temporary AS2 message files.
  

description

Type: STRING
Provider name: Description
Description: The name or short description that’s used to identify the agreement.

enforce_message_signing

Type: STRING
Provider name: EnforceMessageSigning
Description: Determines whether or not unsigned messages from your trading partners will be accepted.

• ENABLED: Transfer Family rejects unsigned messages from your trading partner.
• DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.

local_profile_id

Type: STRING
Provider name: LocalProfileId
Description: A unique identifier for the AS2 local profile.

partner_profile_id

Type: STRING
Provider name: PartnerProfileId
Description: A unique identifier for the partner profile used in the agreement.

preserve_filename

Type: STRING
Provider name: PreserveFilename
Description: Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

• ENABLED: the filename provided by your trading parter is preserved when the file is saved.
• DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations.

server_id

Type: STRING
Provider name: ServerId
Description: A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.

status

Type: STRING
Provider name: Status
Description: The current status of the agreement, either ACTIVE or INACTIVE.

tags

Type: UNORDERED_LIST_STRING