Package software.amazon.awscdk.services.transfer

Interface CfnUserProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnUserProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:48.569Z") @Stability(Stable) public interface CfnUserProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnUser.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.transfer.*;
 CfnUserProps cfnUserProps = CfnUserProps.builder()
         .role("role")
         .serverId("serverId")
         .userName("userName")
         // the properties below are optional
         .homeDirectory("homeDirectory")
         .homeDirectoryMappings(List.of(HomeDirectoryMapEntryProperty.builder()
                 .entry("entry")
                 .target("target")
                 // the properties below are optional
                 .type("type")
                 .build()))
         .homeDirectoryType("homeDirectoryType")
         .policy("policy")
         .posixProfile(PosixProfileProperty.builder()
                 .gid(123)
                 .uid(123)
                 // the properties below are optional
                 .secondaryGids(List.of(123))
                 .build())
         .sshPublicKeys(List.of("sshPublicKeys"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    CfnUserProps.Builder
    A builder for CfnUserProps
    static final class 
    CfnUserProps.Jsii$Proxy
    An implementation for CfnUserProps

  • Method Summary

    Modifier and Type
    Method
    Description
    static CfnUserProps.Builder
    builder()
     
    default String
    getHomeDirectory()
    The landing directory (folder) for a user when they log in to the server using the client.
    default Object
    getHomeDirectoryMappings()
    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.
    default String
    getHomeDirectoryType()
    The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
    default String
    getPolicy()
    A session policy for your user so you can use the same IAM role across multiple users.
    default Object
    getPosixProfile()
    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.
    String
    getRole()
    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.
    String
    getServerId()
    A system-assigned unique identifier for a server instance.
    default List<String>
    getSshPublicKeys()
    Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
    default List<CfnTag>
    getTags()
    Key-value pairs that can be used to group and search for users.
    String
    getUserName()
    A unique string that identifies a user and is associated with a ServerId .

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson