/AWS1/CL_TRN=>CREATEUSER()
¶
About CreateUser¶
Creates a user and associates them with an existing file transfer protocol-enabled server.
You can only create and associate users with servers that have the
IdentityProviderType
set to SERVICE_MANAGED
. Using parameters for
CreateUser
, you can specify the user name, set the home directory, store the
user's public key, and assign the user's Identity and Access Management (IAM)
role. You can also optionally add a session policy, and assign metadata with tags that can
be used to group and search for users.
Method Signature¶
IMPORTING¶
Required arguments:¶
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.
IV_SERVERID
TYPE /AWS1/TRNSERVERID
/AWS1/TRNSERVERID
¶
A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.
IV_USERNAME
TYPE /AWS1/TRNUSERNAME
/AWS1/TRNUSERNAME
¶
A unique string that identifies a user and is associated with a
ServerId
. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.', and at sign '@'. The user name can't start with a hyphen, period, or at sign.
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
.The
HomeDirectory
parameter is only used ifHomeDirectoryType
is set toPATH
.
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 toLOGICAL
, you need to provide mappings in theHomeDirectoryMappings
for how you want to make Amazon S3 or Amazon EFS paths visible to your users.If
HomeDirectoryType
isLOGICAL
, you must provide mappings, using theHomeDirectoryMappings
parameter. If, on the other hand,HomeDirectoryType
isPATH
, you provide an absolute path using theHomeDirectory
parameter. You cannot have bothHomeDirectory
andHomeDirectoryMappings
in your template.
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
andTarget
pair, whereEntry
shows how the path is made visible andTarget
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 inTarget
. This value can be set only whenHomeDirectoryType
is set to LOGICAL.The following is an
Entry
andTarget
pair example.
[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
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 setEntry
to/
and setTarget
to the value the user should see for their home directory when they log in.The following is an
Entry
andTarget
pair example forchroot
.
[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
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}
.This policy applies only when the domain of
ServerId
is Amazon S3. Amazon EFS does not use session policies.For session policies, Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the
Policy
argument.For an example of a session policy, see Example session policy.
For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.
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 EFS file systems. The POSIX permissions that are set on files and directories in Amazon EFS determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.
IV_SSHPUBLICKEYBODY
TYPE /AWS1/TRNSSHPUBLICKEYBODY
/AWS1/TRNSSHPUBLICKEYBODY
¶
The public portion of the Secure Shell (SSH) key used to authenticate the user to the server.
The three standard SSH public key format elements are
<key type>
,<body base64>
, and an optional<comment>
, with spaces between each element.Transfer Family accepts RSA, ECDSA, and ED25519 keys.
For RSA keys, the key type is
ssh-rsa
.For ED25519 keys, the key type is
ssh-ed25519
.For ECDSA keys, the key type is either
ecdsa-sha2-nistp256
,ecdsa-sha2-nistp384
, orecdsa-sha2-nistp521
, depending on the size of the key you generated.
IT_TAGS
TYPE /AWS1/CL_TRNTAG=>TT_TAGS
TT_TAGS
¶
Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.