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

ListedUser

class ListedUser

Returns properties of the user that you specify.

Types

Builder

class Builder

Companion

object Companion

Properties

arn

val arn: String

Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.

homeDirectory

val homeDirectory: String?

The landing directory (folder) for a user when they log in to the server using the client.

homeDirectoryType

val homeDirectoryType: HomeDirectoryType?

The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it to LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your users.

role

val role: String?

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

sshPublicKeyCount

val sshPublicKeyCount: Int?

Specifies the number of SSH public keys stored for the user you specified.

userName

val userName: String?

Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.

Functions

copy

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

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String