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

Class ListedUser

    • Method Detail

      • arn

        public final String arn()

        Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.

        Returns:
        Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.

      • 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

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

        The IAM role that controls your users' access to your Amazon S3 bucket for servers with Domain=S3, or your EFS file system for servers with Domain=EFS.

        The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 buckets or EFS file systems.

        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.

        The IAM role that controls your users' access to your Amazon S3 bucket for servers with Domain=S3, or your EFS file system for servers with Domain=EFS.

        The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 buckets or EFS file systems.

      • sshPublicKeyCount

        public final Integer sshPublicKeyCount()

        Specifies the number of SSH public keys stored for the user you specified.

        Returns:
        Specifies the number of SSH public keys stored for the user you specified.

      • userName

        public final String userName()

        Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.

        Returns:
        Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)