Package software.amazon.awscdk.services.transfer

Class CfnUser

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.transfer.CfnUser
All Implemented Interfaces:
IInspectable, ITaggable, IUserRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)", date="2025-10-14T12:28:22.058Z") @Stability(Stable) public class CfnUser extends CfnResource implements IInspectable, IUserRef, ITaggable
The AWS::Transfer::User resource creates a user and associates them with an existing 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 AWS 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.

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.*;
 CfnUser cfnUser = CfnUser.Builder.create(this, "MyCfnUser")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnUser

      protected CfnUser(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnUser

      protected CfnUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnUser

      @Stability(Stable) public CfnUser(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnUserProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name associated with the user, in the form arn:aws:transfer:region: *account-id* :user/ *server-id* / *username* .

      An example of a user ARN is: arn:aws:transfer:us-east-1:123456789012:user/user1 .

    • getAttrServerId

      @Stability(Stable) @NotNull public String getAttrServerId()
      The ID of the server to which the user is attached.

      An example ServerId is s-01234567890abcdef .

    • getAttrUserName

      @Stability(Stable) @NotNull public String getAttrUserName()
      A unique string that identifies a Transfer Family user account associated with a server.

      An example UserName is transfer-user-1 .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getUserRef

      @Stability(Stable) @NotNull public UserReference getUserRef()
      A reference to a User resource.
      Specified by:
      getUserRef in interface IUserRef

    • getRole

      @Stability(Stable) @NotNull public 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.

    • setRole

      @Stability(Stable) public void setRole(@NotNull String value)
      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.

    • getServerId

      @Stability(Stable) @NotNull public String getServerId()
      A system-assigned unique identifier for a server instance.

    • setServerId

      @Stability(Stable) public void setServerId(@NotNull String value)
      A system-assigned unique identifier for a server instance.

    • getUserName

      @Stability(Stable) @NotNull public String getUserName()
      A unique string that identifies a user and is associated with a ServerId .

    • setUserName

      @Stability(Stable) public void setUserName(@NotNull String value)
      A unique string that identifies a user and is associated with a ServerId .

    • getHomeDirectory

      @Stability(Stable) @Nullable public String getHomeDirectory()
      The landing directory (folder) for a user when they log in to the server using the client.

    • setHomeDirectory

      @Stability(Stable) public void setHomeDirectory(@Nullable String value)
      The landing directory (folder) for a user when they log in to the server using the client.

    • getHomeDirectoryMappings

      @Stability(Stable) @Nullable public 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.

    • setHomeDirectoryMappings

      @Stability(Stable) public void setHomeDirectoryMappings(@Nullable IResolvable value)
      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.

    • setHomeDirectoryMappings

      @Stability(Stable) public void setHomeDirectoryMappings(@Nullable List<Object> value)
      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.

    • getHomeDirectoryType

      @Stability(Stable) @Nullable public String getHomeDirectoryType()
      The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.

    • setHomeDirectoryType

      @Stability(Stable) public void setHomeDirectoryType(@Nullable String value)
      The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.

    • getPolicy

      @Stability(Stable) @Nullable public String getPolicy()
      A session policy for your user so you can use the same IAM role across multiple users.

    • setPolicy

      @Stability(Stable) public void setPolicy(@Nullable String value)
      A session policy for your user so you can use the same IAM role across multiple users.

    • getPosixProfile

      @Stability(Stable) @Nullable public 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.

    • setPosixProfile

      @Stability(Stable) public void setPosixProfile(@Nullable IResolvable value)
      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.

    • setPosixProfile

      @Stability(Stable) public void setPosixProfile(@Nullable CfnUser.PosixProfileProperty value)
      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.

    • getSshPublicKeys

      @Stability(Stable) @Nullable public List<String> getSshPublicKeys()
      Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.

    • setSshPublicKeys

      @Stability(Stable) public void setSshPublicKeys(@Nullable List<String> value)
      Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Key-value pairs that can be used to group and search for users.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Key-value pairs that can be used to group and search for users.