/AWS1/CL_TRN=>UPDATECONNECTOR()
¶
About UpdateConnector¶
Updates some of the parameters for an existing connector. Provide the
ConnectorId
for the connector that you want to update, along with the new
values for the parameters to update.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_CONNECTORID
TYPE /AWS1/TRNCONNECTORID
/AWS1/TRNCONNECTORID
¶
The unique identifier for the connector.
Optional arguments:¶
IV_URL
TYPE /AWS1/TRNURL
/AWS1/TRNURL
¶
The URL of the partner's AS2 or SFTP endpoint.
IO_AS2CONFIG
TYPE REF TO /AWS1/CL_TRNAS2CONNECTORCONFIG
/AWS1/CL_TRNAS2CONNECTORCONFIG
¶
A structure that contains the parameters for an AS2 connector object.
IV_ACCESSROLE
TYPE /AWS1/TRNROLE
/AWS1/TRNROLE
¶
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, 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
.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 thekms: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 providessecretsmanager:GetSecretValue
permission to Secrets Manager.
IV_LOGGINGROLE
TYPE /AWS1/TRNROLE
/AWS1/TRNROLE
¶
The 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.
IO_SFTPCONFIG
TYPE REF TO /AWS1/CL_TRNSFTPCNCTORCONFIG
/AWS1/CL_TRNSFTPCNCTORCONFIG
¶
A structure that contains the parameters for an SFTP connector object.
IV_SECURITYPOLICYNAME
TYPE /AWS1/TRNCNCTORSECPOLICYNAME
/AWS1/TRNCNCTORSECPOLICYNAME
¶
Specifies the name of the security policy for the connector.