AWS CDK Reference

Appearance

v2.273.0

CfnUserProps Struct ​

Properties for defining a CfnUser.

Source
Generated code

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_transfer as transfer } from 'aws-cdk-lib';
const cfnUserProps: transfer.CfnUserProps = {
  role: 'role',
  serverId: 'serverId',
  userName: 'userName',

  // the properties below are optional
  homeDirectory: 'homeDirectory',
  homeDirectoryMappings: [{
    entry: 'entry',
    target: 'target',

    // the properties below are optional
    type: 'type',
  }],
  homeDirectoryType: 'homeDirectoryType',
  policy: 'policy',
  posixProfile: {
    gid: 123,
    uid: 123,

    // the properties below are optional
    secondaryGids: [123],
  },
  sshPublicKeys: ['sshPublicKeys'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

homeDirectorystringhome_directorystrhomeDirectoryStringHomeDirectorystringHomeDirectory*string#
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 .

homeDirectoryMappingsIResolvable | IResolvable | CfnUser.HomeDirectoryMapEntryProperty[]home_directory_mappingstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, HomeDirectoryMapEntryProperty]]]homeDirectoryMappingsIResolvableHomeDirectoryMappingsIResolvableHomeDirectoryMappingsinterface{}#
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.
notes

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 AWS Identity and Access Management (IAM) role provides access to paths in Target . This value can be set only when HomeDirectoryType is set to LOGICAL .

The following is an Entry and Target 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 set Entry to / and set Target to the value the user should see for their home directory when they log in.

The following is an Entry and Target pair example for chroot .

[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]

homeDirectoryTypestringhome_directory_typestrhomeDirectoryTypeStringHomeDirectoryTypestringHomeDirectoryType*string#
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
notes

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.

policystringpolicystrpolicyStringPolicystringPolicy*string#
A session policy for your user so you can use the same IAM role across multiple users.
notes

This policy restricts user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName} , ${Transfer:HomeDirectory} , and ${Transfer:HomeBucket} .

For session policies, AWS 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 AWS Security Token Service API Reference .

posixProfileIResolvable | CfnUser.PosixProfilePropertyposix_profiletyping.Union[IResolvable, PosixProfileProperty]posixProfileIResolvablePosixProfileIResolvablePosixProfileinterface{}#
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.

rolestringrolestrroleStringRolestringRole*stringrequired#
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system.
notes

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.

serverIdstringserver_idstrserverIdStringServerIdstringServerId*stringrequired#
A system-assigned unique identifier for a server instance.

This is the specific server that you added your user to.

sshPublicKeysstring[]ssh_public_keystyping.List[str]sshPublicKeysList<String>SshPublicKeysstring[]SshPublicKeys*[]*string#
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: []

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
Key-value pairs that can be used to group and search for users.

Tags are metadata attached to users for any purpose.

userNamestringuser_namestruserNameStringUserNamestringUserName*stringrequired#
A unique string that identifies a user and is associated with a `ServerId` .
notes

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.

Used as props by ​