/AWS1/CL_TRNDESCRIBEDUSER

Describes the properties of a user that was specified.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_arn TYPE /AWS1/TRNARN /AWS1/TRNARN

Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.

Optional arguments:

iv_homedirectory TYPE /AWS1/TRNHOMEDIRECTORY /AWS1/TRNHOMEDIRECTORY

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.

You can use the HomeDirectory parameter for HomeDirectoryType when it is set to either PATH or LOGICAL.

it_homedirectorymappings TYPE /AWS1/CL_TRNHOMEDIRECTORYMAP00=>TT_HOMEDIRECTORYMAPPINGS TT_HOMEDIRECTORYMAPPINGS

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.

iv_homedirectorytype TYPE /AWS1/TRNHOMEDIRECTORYTYPE /AWS1/TRNHOMEDIRECTORYTYPE

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.

iv_policy TYPE /AWS1/TRNPOLICY /AWS1/TRNPOLICY

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}.

io_posixprofile TYPE REF TO /AWS1/CL_TRNPOSIXPROFILE /AWS1/CL_TRNPOSIXPROFILE

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.

iv_role TYPE /AWS1/TRNROLE /AWS1/TRNROLE

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.

it_sshpublickeys TYPE /AWS1/CL_TRNSSHPUBLICKEY=>TT_SSHPUBLICKEYS TT_SSHPUBLICKEYS

Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.

To delete the public key body, set its value to zero keys, as shown here:

SshPublicKeys: []

it_tags TYPE /AWS1/CL_TRNTAG=>TT_TAGS TT_TAGS

Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

iv_username TYPE /AWS1/TRNUSERNAME /AWS1/TRNUSERNAME

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.

---

Queryable Attributes

Arn

Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.

Accessible with the following methods

Method	Description
GET_ARN()	Getter for ARN, with configurable default
ASK_ARN()	Getter for ARN w/ exceptions if field has no value
HAS_ARN()	Determine if ARN has a value

HomeDirectory

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.

You can use the HomeDirectory parameter for HomeDirectoryType when it is set to either PATH or LOGICAL.

Accessible with the following methods

Method	Description
GET_HOMEDIRECTORY()	Getter for HOMEDIRECTORY, with configurable default
ASK_HOMEDIRECTORY()	Getter for HOMEDIRECTORY w/ exceptions if field has no value
HAS_HOMEDIRECTORY()	Determine if HOMEDIRECTORY has a value

HomeDirectoryMappings

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.

Accessible with the following methods

Method	Description
GET_HOMEDIRECTORYMAPPINGS()	Getter for HOMEDIRECTORYMAPPINGS, with configurable default
ASK_HOMEDIRECTORYMAPPINGS()	Getter for HOMEDIRECTORYMAPPINGS w/ exceptions if field has
HAS_HOMEDIRECTORYMAPPINGS()	Determine if HOMEDIRECTORYMAPPINGS has a value

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.

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.

Accessible with the following methods

Method	Description
GET_HOMEDIRECTORYTYPE()	Getter for HOMEDIRECTORYTYPE, with configurable default
ASK_HOMEDIRECTORYTYPE()	Getter for HOMEDIRECTORYTYPE w/ exceptions if field has no v
HAS_HOMEDIRECTORYTYPE()	Determine if HOMEDIRECTORYTYPE has a value

Policy

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}.

Accessible with the following methods

Method	Description
GET_POLICY()	Getter for POLICY, with configurable default
ASK_POLICY()	Getter for POLICY w/ exceptions if field has no value
HAS_POLICY()	Determine if POLICY has a value

PosixProfile

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.

Accessible with the following methods

Method	Description
GET_POSIXPROFILE()	Getter for POSIXPROFILE

Role

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.

Accessible with the following methods

Method	Description
GET_ROLE()	Getter for ROLE, with configurable default
ASK_ROLE()	Getter for ROLE w/ exceptions if field has no value
HAS_ROLE()	Determine if ROLE has a value

SshPublicKeys

Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.

To delete the public key body, set its value to zero keys, as shown here:

SshPublicKeys: []

Accessible with the following methods

Method	Description
GET_SSHPUBLICKEYS()	Getter for SSHPUBLICKEYS, with configurable default
ASK_SSHPUBLICKEYS()	Getter for SSHPUBLICKEYS w/ exceptions if field has no value
HAS_SSHPUBLICKEYS()	Determine if SSHPUBLICKEYS has a value

Tags

Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

Accessible with the following methods

Method	Description
GET_TAGS()	Getter for TAGS, with configurable default
ASK_TAGS()	Getter for TAGS w/ exceptions if field has no value
HAS_TAGS()	Determine if TAGS has a value

UserName

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.

Accessible with the following methods

Method	Description
GET_USERNAME()	Getter for USERNAME, with configurable default
ASK_USERNAME()	Getter for USERNAME w/ exceptions if field has no value
HAS_USERNAME()	Determine if USERNAME has a value