Package software.amazon.awscdk.services.transfer

Class CfnUser

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.transfer.CfnUser
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.943Z") @Stability(Stable) public class CfnUser extends CfnResource implements IInspectable
A CloudFormation AWS::Transfer::User.

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")
                 .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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnUserProps props)
      Create a new AWS::Transfer::User.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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()
      Key-value pairs that can be used to group and search for users.

      Tags are metadata attached to users for any purpose.

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

      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.

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

      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.

    • getServerId

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

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

    • setServerId

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

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

    • getUserName

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

    • setUserName

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

    • getHomeDirectory

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

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

      A HomeDirectory example is /bucket_name/home/mydirectory .

    • getHomeDirectoryMappings

      @Stability(Stable) @Nullable public Object getHomeDirectoryMappings()
      Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible.

      You will need to specify the " Entry " and " Target " pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your IAM role provides access to paths in Target . The following is an example.

      '[ { "Entry": "/", "Target": "/bucket3/customized-reports/" } ]'

      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.

      If the target of a logical directory entry does not exist in Amazon S3, the entry will be ignored. As a workaround, you can use the Amazon S3 API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: AWS s3api put-object --bucket bucketname --key path/to/folder/ . Make sure that the end of the key name ends in a '/' for it to be considered a folder.

    • setHomeDirectoryMappings

      @Stability(Stable) public void setHomeDirectoryMappings(@Nullable IResolvable value)
      Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible.

      You will need to specify the " Entry " and " Target " pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your IAM role provides access to paths in Target . The following is an example.

      '[ { "Entry": "/", "Target": "/bucket3/customized-reports/" } ]'

      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.

      If the target of a logical directory entry does not exist in Amazon S3, the entry will be ignored. As a workaround, you can use the Amazon S3 API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: AWS s3api put-object --bucket bucketname --key path/to/folder/ . Make sure that the end of the key name ends in a '/' for it to be considered a folder.

    • setHomeDirectoryMappings

      @Stability(Stable) public void setHomeDirectoryMappings(@Nullable List<Object> value)
      Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible.

      You will need to specify the " Entry " and " Target " pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your IAM role provides access to paths in Target . The following is an example.

      '[ { "Entry": "/", "Target": "/bucket3/customized-reports/" } ]'

      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.

      If the target of a logical directory entry does not exist in Amazon S3, the entry will be ignored. As a workaround, you can use the Amazon S3 API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: AWS s3api put-object --bucket bucketname --key path/to/folder/ . Make sure that the end of the key name ends in a '/' for it to be considered a folder.

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

      If you set it to PATH , the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it 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.

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

      If you set it to PATH , the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it 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.

    • getPolicy

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

      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 .

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

      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 .

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

      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.

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

      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.

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

      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.

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