transfer/aws.sdk.kotlin.services.transfer.model/ListedServer

ListedServer

class ListedServer

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

Types

Builder

class Builder

Companion

object Companion

Properties

arn

val arn: String

Specifies the unique Amazon Resource Name (ARN) for a server to be listed.

domain

val domain: 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.

endpointType

val endpointType: EndpointType?

Specifies the type of VPC 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.

identityProviderType

val identityProviderType: 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.

loggingRole

val loggingRole: String?

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.

serverId

val serverId: String?

Specifies the unique system assigned identifier for the servers that were listed.

state

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.

userCount

val userCount: Int?

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

Functions

copy

inline fun copy(block: ListedServer.Builder.() -> Unit = {}): ListedServer

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String