Package software.amazon.awssdk.services.transfer.model

Class CreateUserRequest

    • Method Detail

      • homeDirectory

        public final String homeDirectory()

        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 if HomeDirectoryType is set to PATH.

        Returns:
        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 if HomeDirectoryType is set to PATH.

      • homeDirectoryType

        public final HomeDirectoryType homeDirectoryType()

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

        If the service returns an enum value that is not available in the current SDK version, homeDirectoryType will return HomeDirectoryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from homeDirectoryTypeAsString().

        Returns:
        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 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.

        See Also:
        HomeDirectoryType

      • homeDirectoryTypeAsString

        public final String homeDirectoryTypeAsString()

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

        If the service returns an enum value that is not available in the current SDK version, homeDirectoryType will return HomeDirectoryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from homeDirectoryTypeAsString().

        Returns:
        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 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.

        See Also:
        HomeDirectoryType

      • hasHomeDirectoryMappings

        public final boolean hasHomeDirectoryMappings()
        For responses, this returns true if the service returned a value for the HomeDirectoryMappings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • homeDirectoryMappings

        public final List<HomeDirectoryMapEntry> 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 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 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" } ]

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHomeDirectoryMappings() method.

        Returns:
        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 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 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" } ]

      • policy

        public final String policy()

        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.

        Returns:
        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.

      • posixProfile

        public final PosixProfile posixProfile()

        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.

        Returns:
        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.

      • role

        public final String role()

        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.

        Returns:
        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.

      • serverId

        public final String serverId()

        A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

        Returns:
        A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

      • sshPublicKeyBody

        public final String sshPublicKeyBody()

        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, or ecdsa-sha2-nistp521, depending on the size of the key you generated.

        Returns:
        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 , or ecdsa-sha2-nistp521, depending on the size of the key you generated.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final List<Tag> tags()

        Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.

      • userName

        public final String userName()

        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.

        Returns:
        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.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object