aws_transfer_user
account_id
Type: STRING
arn
Type: STRING
Provider name: Arn
Description: Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.
home_directory
Type: STRING
Provider name: HomeDirectory
Description: The landing directory (folder) for a user when they log in to the server using the client. A HomeDirectory example is /bucket_name/home/mydirectory. The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.
home_directory_mappings
Type: UNORDERED_LIST_STRUCT
Provider name: HomeDirectoryMappings
Description: Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL. In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to ‘/’ and set Target to the HomeDirectory parameter value.
entry
Type: STRING
Provider name: Entry
Description: Represents an entry for HomeDirectoryMappings.
target
Type: STRING
Provider name: Target
Description: Represents the map target that is used in a HomeDirectoryMapEntry.
type
Type: STRING
Provider name: Type
Description: Specifies the type of mapping. Set the type to FILE if you want the mapping to point to a file, or DIRECTORY for the directory to point to a directory. By default, home directory mappings have a Type of DIRECTORY when you create a Transfer Family server. You would need to explicitly set Type to FILE if you want a mapping to have a file target.
home_directory_type
Type: STRING
Provider name: HomeDirectoryType
Description: 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. If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your template.
policy
Type: STRING
Provider name: Policy
Description: A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user’s access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
posix_profile
Type: STRUCT
Provider name: PosixProfile
Description: Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users’ access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.
gid
Type: INT64
Provider name: Gid
Description: The POSIX group ID used for all EFS operations by this user.
secondary_gids
Type: UNORDERED_LIST_INT64
Provider name: SecondaryGids
Description: The secondary POSIX group IDs used for all EFS operations by this user.
uid
Type: INT64
Provider name: Uid
Description: The POSIX user ID used for all EFS operations by this user.
role
Type: STRING
Provider name: Role
Description: 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.
server_id
Type: STRING
Provider name: ServerId
Description: A system-assigned unique identifier for a server that has this user assigned.
ssh_public_keys
Type: UNORDERED_LIST_STRUCT
Provider name: SshPublicKeys
Description: Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
date_imported
Type: TIMESTAMP
Provider name: DateImported
Description: Specifies the date that the public key was added to the Transfer Family user.
ssh_public_key_body
Type: STRING
Provider name: SshPublicKeyBody
Description: Specifies the content of the SSH public key as specified by the PublicKeyId. Transfer Family accepts RSA, ECDSA, and ED25519 keys.
ssh_public_key_id
Type: STRING
Provider name: SshPublicKeyId
Description: Specifies the SshPublicKeyId parameter contains the identifier of the public key.
Type: UNORDERED_LIST_STRING
user_name
Type: STRING
Provider name: UserName
Description: Specifies the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your server.
