Skip to content

/AWS1/IF_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

METHODS /AWS1/IF_TRN~UPDATECONNECTOR
  IMPORTING
    !IV_CONNECTORID TYPE /AWS1/TRNCONNECTORID OPTIONAL
    !IV_URL TYPE /AWS1/TRNURL OPTIONAL
    !IO_AS2CONFIG TYPE REF TO /AWS1/CL_TRNAS2CONNECTORCONFIG OPTIONAL
    !IV_ACCESSROLE TYPE /AWS1/TRNROLE OPTIONAL
    !IV_LOGGINGROLE TYPE /AWS1/TRNROLE OPTIONAL
    !IO_SFTPCONFIG TYPE REF TO /AWS1/CL_TRNSFTPCNCTORCONFIG OPTIONAL
    !IV_SECURITYPOLICYNAME TYPE /AWS1/TRNCNCTORSECPOLICYNAME OPTIONAL
    !IO_EGRESSCONFIG TYPE REF TO /AWS1/CL_TRNUPDATECNCTOREGRCFG OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_trnupdateconnectorrsp
  RAISING
    /AWS1/CX_TRNINTERNALSVCERROR
    /AWS1/CX_TRNINVALIDREQUESTEX
    /AWS1/CX_TRNRESOURCEEXISTSEX
    /AWS1/CX_TRNRESOURCENOTFOUNDEX
    /AWS1/CX_TRNSERVICEUNAVAILEX
    /AWS1/CX_TRNTHROTTLINGEX
    /AWS1/CX_TRNCLIENTEXC
    /AWS1/CX_TRNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

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.

When creating AS2 connectors or service-managed SFTP connectors (connectors without egress configuration), you must provide a URL to specify the remote server endpoint. For VPC Lattice type connectors, the URL must be null.

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, 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.

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.

io_egressconfig TYPE REF TO /AWS1/CL_TRNUPDATECNCTOREGRCFG /AWS1/CL_TRNUPDATECNCTOREGRCFG

Updates the egress configuration for the connector, allowing you to modify how traffic is routed from the connector to the SFTP server. Changes to VPC configuration may require connector restart.

RETURNING

oo_output TYPE REF TO /aws1/cl_trnupdateconnectorrsp /AWS1/CL_TRNUPDATECONNECTORRSP

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->updateconnector(
  io_as2config = new /aws1/cl_trnas2connectorconfig(
    iv_basicauthsecretid = |string|
    iv_compression = |string|
    iv_encryptionalgorithm = |string|
    iv_localprofileid = |string|
    iv_mdnresponse = |string|
    iv_mdnsigningalgorithm = |string|
    iv_messagesubject = |string|
    iv_partnerprofileid = |string|
    iv_preservecontenttype = |string|
    iv_signingalgorithm = |string|
  )
  io_egressconfig = new /aws1/cl_trnupdatecnctoregrcfg(
    io_vpclattice = new /aws1/cl_trnupcnctorvpclatti00(
      iv_portnumber = 123
      iv_resourceconfigurationarn = |string|
    )
  )
  io_sftpconfig = new /aws1/cl_trnsftpcnctorconfig(
    it_trustedhostkeys = VALUE /aws1/cl_trnsftpcnctortruste00=>tt_sftpcnctortrustedhostkeylst(
      ( new /aws1/cl_trnsftpcnctortruste00( |string| ) )
    )
    iv_maxconcurrentconnections = 123
    iv_usersecretid = |string|
  )
  iv_accessrole = |string|
  iv_connectorid = |string|
  iv_loggingrole = |string|
  iv_securitypolicyname = |string|
  iv_url = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_connectorid = lo_result->get_connectorid( ).
ENDIF.