DescribedServer

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

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Specifies the domain of the storage system that is used for file transfers.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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:

Link copied to clipboard

The protocol settings that are configured for your server.

Link copied to clipboard

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:

Link copied to clipboard

Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.

Link copied to clipboard

Specifies the name of the security policy that is attached to the server.

Link copied to clipboard

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

Link copied to clipboard
val state: 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.

Link copied to clipboard

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

Link copied to clipboard
val tags: List<Tag>?

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

Link copied to clipboard

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

Link copied to clipboard

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

Functions

Link copied to clipboard
inline fun copy(block: DescribedServer.Builder.() -> Unit = {}): DescribedServer
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String