/AWS1/CL_TRNDESCRIBEDCONNECTOR

Describes the parameters for the connector, as identified by the ConnectorId.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_arn TYPE /AWS1/TRNARN /AWS1/TRNARN

The unique Amazon Resource Name (ARN) for the connector.

iv_egresstype TYPE /AWS1/TRNCONNECTOREGRESSTYPE /AWS1/TRNCONNECTOREGRESSTYPE

Type of egress configuration for the connector. SERVICE_MANAGED uses Transfer Family managed NAT gateways, while VPC_LATTICE routes traffic through customer VPCs using VPC Lattice.

iv_status TYPE /AWS1/TRNCONNECTORSTATUS /AWS1/TRNCONNECTORSTATUS

Current status of the connector. PENDING indicates creation/update in progress, ACTIVE means ready for operations, and ERRORED indicates a failure requiring attention.

Optional arguments:

iv_connectorid TYPE /AWS1/TRNCONNECTORID /AWS1/TRNCONNECTORID

The unique identifier for the connector.

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.

it_tags TYPE /AWS1/CL_TRNTAG=>TT_TAGS TT_TAGS

Key-value pairs that can be used to group and search for connectors.

io_sftpconfig TYPE REF TO /AWS1/CL_TRNSFTPCNCTORCONFIG /AWS1/CL_TRNSFTPCNCTORCONFIG

A structure that contains the parameters for an SFTP connector object.

it_svcmanagedegripaddresses TYPE /AWS1/CL_TRNSVCMANAGEDEGRIPA00=>TT_SVCMANAGEDEGRESSIPADDRESSES TT_SVCMANAGEDEGRESSIPADDRESSES

The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.

iv_securitypolicyname TYPE /AWS1/TRNCNCTORSECPOLICYNAME /AWS1/TRNCNCTORSECPOLICYNAME

The text name of the security policy for the specified connector.

io_egressconfig TYPE REF TO /AWS1/CL_TRNDESCRDCNCTOREGRCFG /AWS1/CL_TRNDESCRDCNCTOREGRCFG

Current egress configuration of the connector, showing how traffic is routed to the SFTP server. Contains VPC Lattice settings when using VPC_LATTICE egress type.

When using the VPC_LATTICE egress type, Transfer Family uses a managed Service Network to simplify the resource sharing process.

iv_errormessage TYPE /AWS1/TRNCONNECTORERRORMESSAGE /AWS1/TRNCONNECTORERRORMESSAGE

Error message providing details when the connector is in ERRORED status. Contains information to help troubleshoot connector creation or operation failures.

iv_ipaddresstype TYPE /AWS1/TRNCNCTRSIPADDRESSTYPE /AWS1/TRNCNCTRSIPADDRESSTYPE

IP address type for the connector's network connections. When set to IPV4, the connector uses IPv4 addresses only. When set to DUALSTACK, the connector supports both IPv4 and IPv6 addresses, with IPv6 preferred when available.

---

Queryable Attributes

Arn

The unique Amazon Resource Name (ARN) for the connector.

Accessible with the following methods

Method	Description
GET_ARN()	Getter for ARN, with configurable default
ASK_ARN()	Getter for ARN w/ exceptions if field has no value
HAS_ARN()	Determine if ARN has a value

ConnectorId

The unique identifier for the connector.

Accessible with the following methods

Method	Description
GET_CONNECTORID()	Getter for CONNECTORID, with configurable default
ASK_CONNECTORID()	Getter for CONNECTORID w/ exceptions if field has no value
HAS_CONNECTORID()	Determine if CONNECTORID has a value

Url

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.

Accessible with the following methods

Method	Description
GET_URL()	Getter for URL, with configurable default
ASK_URL()	Getter for URL w/ exceptions if field has no value
HAS_URL()	Determine if URL has a value

As2Config

A structure that contains the parameters for an AS2 connector object.

Accessible with the following methods

Method	Description
GET_AS2CONFIG()	Getter for AS2CONFIG

AccessRole

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.

Accessible with the following methods

Method	Description
GET_ACCESSROLE()	Getter for ACCESSROLE, with configurable default
ASK_ACCESSROLE()	Getter for ACCESSROLE w/ exceptions if field has no value
HAS_ACCESSROLE()	Determine if ACCESSROLE has a value

LoggingRole

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.

Accessible with the following methods

Method	Description
GET_LOGGINGROLE()	Getter for LOGGINGROLE, with configurable default
ASK_LOGGINGROLE()	Getter for LOGGINGROLE w/ exceptions if field has no value
HAS_LOGGINGROLE()	Determine if LOGGINGROLE has a value

Tags

Key-value pairs that can be used to group and search for connectors.

Accessible with the following methods

Method	Description
GET_TAGS()	Getter for TAGS, with configurable default
ASK_TAGS()	Getter for TAGS w/ exceptions if field has no value
HAS_TAGS()	Determine if TAGS has a value

SftpConfig

A structure that contains the parameters for an SFTP connector object.

Accessible with the following methods

Method	Description
GET_SFTPCONFIG()	Getter for SFTPCONFIG

ServiceManagedEgressIpAddresses

The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.

Accessible with the following methods

Method	Description
GET_SVCMANAGEDEGRIPADDRESSES()	Getter for SVCMANAGEDEGRESSIPADDRESSES, with configurable de
ASK_SVCMANAGEDEGRIPADDRESSES()	Getter for SVCMANAGEDEGRESSIPADDRESSES w/ exceptions if fiel
HAS_SVCMANAGEDEGRIPADDRESSES()	Determine if SVCMANAGEDEGRESSIPADDRESSES has a value

SecurityPolicyName

The text name of the security policy for the specified connector.

Accessible with the following methods

Method	Description
GET_SECURITYPOLICYNAME()	Getter for SECURITYPOLICYNAME, with configurable default
ASK_SECURITYPOLICYNAME()	Getter for SECURITYPOLICYNAME w/ exceptions if field has no
HAS_SECURITYPOLICYNAME()	Determine if SECURITYPOLICYNAME has a value

EgressConfig

Current egress configuration of the connector, showing how traffic is routed to the SFTP server. Contains VPC Lattice settings when using VPC_LATTICE egress type.

When using the VPC_LATTICE egress type, Transfer Family uses a managed Service Network to simplify the resource sharing process.

Accessible with the following methods

Method	Description
GET_EGRESSCONFIG()	Getter for EGRESSCONFIG

EgressType

Type of egress configuration for the connector. SERVICE_MANAGED uses Transfer Family managed NAT gateways, while VPC_LATTICE routes traffic through customer VPCs using VPC Lattice.

Accessible with the following methods

Method	Description
GET_EGRESSTYPE()	Getter for EGRESSTYPE, with configurable default
ASK_EGRESSTYPE()	Getter for EGRESSTYPE w/ exceptions if field has no value
HAS_EGRESSTYPE()	Determine if EGRESSTYPE has a value

ErrorMessage

Error message providing details when the connector is in ERRORED status. Contains information to help troubleshoot connector creation or operation failures.

Accessible with the following methods

Method	Description
GET_ERRORMESSAGE()	Getter for ERRORMESSAGE, with configurable default
ASK_ERRORMESSAGE()	Getter for ERRORMESSAGE w/ exceptions if field has no value
HAS_ERRORMESSAGE()	Determine if ERRORMESSAGE has a value

Status

Current status of the connector. PENDING indicates creation/update in progress, ACTIVE means ready for operations, and ERRORED indicates a failure requiring attention.

Accessible with the following methods

Method	Description
GET_STATUS()	Getter for STATUS, with configurable default
ASK_STATUS()	Getter for STATUS w/ exceptions if field has no value
HAS_STATUS()	Determine if STATUS has a value

IpAddressType

IP address type for the connector's network connections. When set to IPV4, the connector uses IPv4 addresses only. When set to DUALSTACK, the connector supports both IPv4 and IPv6 addresses, with IPv6 preferred when available.

Accessible with the following methods

Method	Description
GET_IPADDRESSTYPE()	Getter for IPADDRESSTYPE, with configurable default
ASK_IPADDRESSTYPE()	Getter for IPADDRESSTYPE w/ exceptions if field has no value
HAS_IPADDRESSTYPE()	Determine if IPADDRESSTYPE has a value