DescribedServer
Describes the properties of a file transfer protocol-enabled server that was specified.
Types
Properties
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.
Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols
is set to FTPS
.
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.
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.
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.
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
.
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.
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 EFSevents. When set, you can view user activity in your CloudWatch logs.
Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.
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:
The protocol settings that are configured for your server.
Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.
Specifies the name of the security policy that is attached to the server.
Specifies the log groups to which your server logs are sent.
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.