Skip to content

/AWS1/CL_TRNDESCRIBEDSERVER

Describes the properties of a file transfer protocol-enabled server that was specified.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_arn TYPE /AWS1/TRNARN /AWS1/TRNARN

Specifies the unique Amazon Resource Name (ARN) of the server.

Optional arguments:

iv_certificate TYPE /AWS1/TRNCERTIFICATE /AWS1/TRNCERTIFICATE

Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

io_protocoldetails TYPE REF TO /AWS1/CL_TRNPROTOCOLDETAILS /AWS1/CL_TRNPROTOCOLDETAILS

The protocol settings that are configured for your server.

Avoid placing Network Load Balancers (NLBs) or NAT gateways in front of Transfer Family servers, as this increases costs and can cause performance issues, including reduced connection limits for FTPS. For more details, see Avoid placing NLBs and NATs in front of Transfer Family.

  • To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.

  • To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call.

  • To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode parameter.

  • As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

iv_domain TYPE /AWS1/TRNDOMAIN /AWS1/TRNDOMAIN

Specifies the domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.

io_endpointdetails TYPE REF TO /AWS1/CL_TRNENDPOINTDETAILS /AWS1/CL_TRNENDPOINTDETAILS

The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

iv_endpointtype TYPE /AWS1/TRNENDPOINTTYPE /AWS1/TRNENDPOINTTYPE

Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.

iv_hostkeyfingerprint TYPE /AWS1/TRNHOSTKEYFINGERPRINT /AWS1/TRNHOSTKEYFINGERPRINT

Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output of the ssh-keygen -l -f my-new-server-key command.

io_identityproviderdetails TYPE REF TO /AWS1/CL_TRNIDPVDRDETAILS /AWS1/CL_TRNIDPVDRDETAILS

Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a server is AWS_DIRECTORY_SERVICE or SERVICE_MANAGED.

iv_identityprovidertype TYPE /AWS1/TRNIDENTITYPROVIDERTYPE /AWS1/TRNIDENTITYPROVIDERTYPE

The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service.

Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter.

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter.

Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter for the IdentityProviderDetails data type.

iv_loggingrole TYPE /AWS1/TRNNULLABLEROLE /AWS1/TRNNULLABLEROLE

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user activity in your CloudWatch logs.

iv_postauthntctnloginbanner TYPE /AWS1/TRNPOSTAUTHNLOGINBANNER /AWS1/TRNPOSTAUTHNLOGINBANNER

Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.

The SFTP protocol does not support post-authentication display banners.

iv_preauthntctnloginbanner TYPE /AWS1/TRNPREAUTHNLOGINBANNER /AWS1/TRNPREAUTHNLOGINBANNER

Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:

This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.

it_protocols TYPE /AWS1/CL_TRNPROTOCOLS_W=>TT_PROTOCOLS TT_PROTOCOLS

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

  • SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

  • FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

  • FTP (File Transfer Protocol): Unencrypted file transfer

  • AS2 (Applicability Statement 2): used for transporting structured business-to-business data

  • If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.

  • If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

  • If Protocol includes FTP, then AddressAllocationIds cannot be associated.

  • If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

  • If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.

iv_securitypolicyname TYPE /AWS1/TRNSECURITYPOLICYNAME /AWS1/TRNSECURITYPOLICYNAME

Specifies the name of the security policy for the server.

iv_serverid TYPE /AWS1/TRNSERVERID /AWS1/TRNSERVERID

Specifies the unique system-assigned identifier for a server that you instantiate.

iv_state TYPE /AWS1/TRNSTATE /AWS1/TRNSTATE

The condition of the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.

it_tags TYPE /AWS1/CL_TRNTAG=>TT_TAGS TT_TAGS

Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.

iv_usercount TYPE /AWS1/TRNUSERCOUNT /AWS1/TRNUSERCOUNT

Specifies the number of users that are assigned to a server you specified with the ServerId.

io_workflowdetails TYPE REF TO /AWS1/CL_TRNWORKFLOWDETAILS /AWS1/CL_TRNWORKFLOWDETAILS

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded.

it_structuredlogdestinations TYPE /AWS1/CL_TRNSTRUCTUREDLOGDST00=>TT_STRUCTUREDLOGDESTINATIONS TT_STRUCTUREDLOGDESTINATIONS

Specifies the log groups to which your server logs are sent.

To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:

arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:

For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:

If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an update-server call. For example:

update-server --server-id s-1234567890abcdef0 --structured-log-destinations

io_s3storageoptions TYPE REF TO /AWS1/CL_TRNS3STORAGEOPTIONS /AWS1/CL_TRNS3STORAGEOPTIONS

Specifies whether or not performance for your Amazon S3 directories is optimized.

  • If using the console, this is enabled by default.

  • If using the API or CLI, this is disabled by default.

By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

it_as2svcmanagedegripaddre00 TYPE /AWS1/CL_TRNSVCMANAGEDEGRIPA00=>TT_SVCMANAGEDEGRESSIPADDRESSES TT_SVCMANAGEDEGRESSIPADDRESSES

The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs.

These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.

iv_ipaddresstype TYPE /AWS1/TRNIPADDRESSTYPE /AWS1/TRNIPADDRESSTYPE

Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your Transfer Family endpoint. The default value is IPV4.

The IpAddressType parameter has the following limitations:

  • It cannot be changed while the server is online. You must stop the server before modifying this parameter.

  • It cannot be updated to DUALSTACK if the server has AddressAllocationIds specified.

When using DUALSTACK as the IpAddressType, you cannot set the AddressAllocationIds parameter for the EndpointDetails for the server.

Queryable Attributes

Arn

Specifies the unique Amazon Resource Name (ARN) of the server.

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

Certificate

Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

Accessible with the following methods

Method Description
GET_CERTIFICATE() Getter for CERTIFICATE, with configurable default
ASK_CERTIFICATE() Getter for CERTIFICATE w/ exceptions if field has no value
HAS_CERTIFICATE() Determine if CERTIFICATE has a value

ProtocolDetails

The protocol settings that are configured for your server.

Avoid placing Network Load Balancers (NLBs) or NAT gateways in front of Transfer Family servers, as this increases costs and can cause performance issues, including reduced connection limits for FTPS. For more details, see Avoid placing NLBs and NATs in front of Transfer Family.

  • To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.

  • To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call.

  • To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode parameter.

  • As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

Accessible with the following methods

Method Description
GET_PROTOCOLDETAILS() Getter for PROTOCOLDETAILS

Domain

Specifies the domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.

Accessible with the following methods

Method Description
GET_DOMAIN() Getter for DOMAIN, with configurable default
ASK_DOMAIN() Getter for DOMAIN w/ exceptions if field has no value
HAS_DOMAIN() Determine if DOMAIN has a value

EndpointDetails

The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

Accessible with the following methods

Method Description
GET_ENDPOINTDETAILS() Getter for ENDPOINTDETAILS

EndpointType

Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.

Accessible with the following methods

Method Description
GET_ENDPOINTTYPE() Getter for ENDPOINTTYPE, with configurable default
ASK_ENDPOINTTYPE() Getter for ENDPOINTTYPE w/ exceptions if field has no value
HAS_ENDPOINTTYPE() Determine if ENDPOINTTYPE has a value

HostKeyFingerprint

Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output of the ssh-keygen -l -f my-new-server-key command.

Accessible with the following methods

Method Description
GET_HOSTKEYFINGERPRINT() Getter for HOSTKEYFINGERPRINT, with configurable default
ASK_HOSTKEYFINGERPRINT() Getter for HOSTKEYFINGERPRINT w/ exceptions if field has no
HAS_HOSTKEYFINGERPRINT() Determine if HOSTKEYFINGERPRINT has a value

IdentityProviderDetails

Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a server is AWS_DIRECTORY_SERVICE or SERVICE_MANAGED.

Accessible with the following methods

Method Description
GET_IDENTITYPROVIDERDETAILS() Getter for IDENTITYPROVIDERDETAILS

IdentityProviderType

The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service.

Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter.

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter.

Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter for the IdentityProviderDetails data type.

Accessible with the following methods

Method Description
GET_IDENTITYPROVIDERTYPE() Getter for IDENTITYPROVIDERTYPE, with configurable default
ASK_IDENTITYPROVIDERTYPE() Getter for IDENTITYPROVIDERTYPE w/ exceptions if field has n
HAS_IDENTITYPROVIDERTYPE() Determine if IDENTITYPROVIDERTYPE has a value

LoggingRole

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, you can view user 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

PostAuthenticationLoginBanner

Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.

The SFTP protocol does not support post-authentication display banners.

Accessible with the following methods

Method Description
GET_POSTAUTHNTCTNLOGINBANNER() Getter for POSTAUTHNTCTNLOGINBANNER, with configurable defau
ASK_POSTAUTHNTCTNLOGINBANNER() Getter for POSTAUTHNTCTNLOGINBANNER w/ exceptions if field h
HAS_POSTAUTHNTCTNLOGINBANNER() Determine if POSTAUTHNTCTNLOGINBANNER has a value

PreAuthenticationLoginBanner

Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:

This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.

Accessible with the following methods

Method Description
GET_PREAUTHNTCTNLOGINBANNER() Getter for PREAUTHENTICATIONLOGINBANNER, with configurable d
ASK_PREAUTHNTCTNLOGINBANNER() Getter for PREAUTHENTICATIONLOGINBANNER w/ exceptions if fie
HAS_PREAUTHNTCTNLOGINBANNER() Determine if PREAUTHENTICATIONLOGINBANNER has a value

Protocols

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

  • SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH

  • FTPS (File Transfer Protocol Secure): File transfer with TLS encryption

  • FTP (File Transfer Protocol): Unencrypted file transfer

  • AS2 (Applicability Statement 2): used for transporting structured business-to-business data

  • If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.

  • If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

  • If Protocol includes FTP, then AddressAllocationIds cannot be associated.

  • If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

  • If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.

Accessible with the following methods

Method Description
GET_PROTOCOLS() Getter for PROTOCOLS, with configurable default
ASK_PROTOCOLS() Getter for PROTOCOLS w/ exceptions if field has no value
HAS_PROTOCOLS() Determine if PROTOCOLS has a value

SecurityPolicyName

Specifies the name of the security policy for the server.

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

ServerId

Specifies the unique system-assigned identifier for a server that you instantiate.

Accessible with the following methods

Method Description
GET_SERVERID() Getter for SERVERID, with configurable default
ASK_SERVERID() Getter for SERVERID w/ exceptions if field has no value
HAS_SERVERID() Determine if SERVERID has a value

State

The condition of the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.

Accessible with the following methods

Method Description
GET_STATE() Getter for STATE, with configurable default
ASK_STATE() Getter for STATE w/ exceptions if field has no value
HAS_STATE() Determine if STATE has a value

Tags

Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.

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

UserCount

Specifies the number of users that are assigned to a server you specified with the ServerId.

Accessible with the following methods

Method Description
GET_USERCOUNT() Getter for USERCOUNT, with configurable default
ASK_USERCOUNT() Getter for USERCOUNT w/ exceptions if field has no value
HAS_USERCOUNT() Determine if USERCOUNT has a value

WorkflowDetails

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded.

Accessible with the following methods

Method Description
GET_WORKFLOWDETAILS() Getter for WORKFLOWDETAILS

StructuredLogDestinations

Specifies the log groups to which your server logs are sent.

To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:

arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:

For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:

If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an update-server call. For example:

update-server --server-id s-1234567890abcdef0 --structured-log-destinations

Accessible with the following methods

Method Description
GET_STRUCTUREDLOGDSTS() Getter for STRUCTUREDLOGDESTINATIONS, with configurable defa
ASK_STRUCTUREDLOGDSTS() Getter for STRUCTUREDLOGDESTINATIONS w/ exceptions if field
HAS_STRUCTUREDLOGDSTS() Determine if STRUCTUREDLOGDESTINATIONS has a value

S3StorageOptions

Specifies whether or not performance for your Amazon S3 directories is optimized.

  • If using the console, this is enabled by default.

  • If using the API or CLI, this is disabled by default.

By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

Accessible with the following methods

Method Description
GET_S3STORAGEOPTIONS() Getter for S3STORAGEOPTIONS

As2ServiceManagedEgressIpAddresses

The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs.

These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.

Accessible with the following methods

Method Description
GET_AS2SVCMANAGEDEGRIPADDR00() Getter for AS2SVCMANAGEDEGRIPADDRESSES, with configurable de
ASK_AS2SVCMANAGEDEGRIPADDR00() Getter for AS2SVCMANAGEDEGRIPADDRESSES w/ exceptions if fiel
HAS_AS2SVCMANAGEDEGRIPADDR00() Determine if AS2SVCMANAGEDEGRIPADDRESSES has a value

IpAddressType

Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your Transfer Family endpoint. The default value is IPV4.

The IpAddressType parameter has the following limitations:

  • It cannot be changed while the server is online. You must stop the server before modifying this parameter.

  • It cannot be updated to DUALSTACK if the server has AddressAllocationIds specified.

When using DUALSTACK as the IpAddressType, you cannot set the AddressAllocationIds parameter for the EndpointDetails for the server.

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