DescribedServer

Describes the properties of a file transfer protocol-enabled server that was specified.
Information returned includes the following: the server Amazon Resource Name (ARN),
the
authentication configuration and type, the logging role, the server ID and state,
and assigned
tags or metadata.

Contents

Arn

Specifies the unique Amazon Resource Name (ARN) for a file transfer protocol-enabled
server to be described.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 1600.

Pattern: arn:.*

Required: Yes

Certificate

The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required
when Protocols is set to FTPS.

Defines the mode of authentication method enabled for this service. A value of
SERVICE_MANAGED means that you are using this file transfer protocol-enabled
server to store and access user credentials within the service. A value of
API_GATEWAY indicates that you have integrated an API Gateway endpoint that
will be invoked for authenticating your user into the service.

Type: String

Valid Values: SERVICE_MANAGED | API_GATEWAY

Required: No

LoggingRole

An AWS Identity and Access Management (IAM) entity that allows a file transfer
protocol-enabled server to turn on Amazon CloudWatch logging for Amazon S3 events.
When set,
user activity can be viewed in your CloudWatch logs.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:.*role/.*

Required: No

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:

Unique system-assigned identifier for a file transfer protocol-enabled server that
you
instantiate.

Type: String

Length Constraints: Fixed length of 19.

Pattern: ^s-([0-9a-f]{17})$

Required: No

State

The condition of a file transfer protocol-enabled server for 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.