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

Interface ListedUser.Builder

    • Method Detail

      • arn

        ListedUser.Builder arn​(String arn)

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

        Parameters:
        arn - Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • homeDirectory

        ListedUser.Builder homeDirectory​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • homeDirectoryType

        ListedUser.Builder homeDirectoryType​(String 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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        HomeDirectoryType, HomeDirectoryType

      • homeDirectoryType

        ListedUser.Builder homeDirectoryType​(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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        HomeDirectoryType, HomeDirectoryType

      • role

        ListedUser.Builder role​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • sshPublicKeyCount

        ListedUser.Builder sshPublicKeyCount​(Integer sshPublicKeyCount)

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

        Parameters:
        sshPublicKeyCount - Specifies the number of SSH public keys stored for the user you specified.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userName

        ListedUser.Builder userName​(String userName)

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

        Parameters:
        userName - Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.
        Returns:
        Returns a reference to this object so that method calls can be chained together.