com.amazonaws.services.transfer.model

Class ListedUser

java.lang.Object

com.amazonaws.services.transfer.model.ListedUser

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListedUser
extends Object
implements Serializable, Cloneable, StructuredPojo

Returns properties of the user that you specify.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListedUser()

Method Summary

Modifier and Type	Method and Description
ListedUser	clone()
boolean	equals(Object obj)
String	getArn() Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
String	getHomeDirectory() The landing directory (folder) for a user when they log in to the server using the client.
String	getHomeDirectoryType() The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
String	getRole() 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.
Integer	getSshPublicKeyCount() Specifies the number of SSH public keys stored for the user you specified.
String	getUserName() Specifies the name of the user whose ARN was specified.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setArn(String arn) Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
void	setHomeDirectory(String homeDirectory) The landing directory (folder) for a user when they log in to the server using the client.
void	setHomeDirectoryType(String homeDirectoryType) The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
void	setRole(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.
void	setSshPublicKeyCount(Integer sshPublicKeyCount) Specifies the number of SSH public keys stored for the user you specified.
void	setUserName(String userName) Specifies the name of the user whose ARN was specified.
String	toString() Returns a string representation of this object.
ListedUser	withArn(String arn) Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
ListedUser	withHomeDirectory(String homeDirectory) The landing directory (folder) for a user when they log in to the server using the client.
ListedUser	withHomeDirectoryType(HomeDirectoryType homeDirectoryType) The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
ListedUser	withHomeDirectoryType(String homeDirectoryType) The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
ListedUser	withRole(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.
ListedUser	withSshPublicKeyCount(Integer sshPublicKeyCount) Specifies the number of SSH public keys stored for the user you specified.
ListedUser	withUserName(String userName) Specifies the name of the user whose ARN was specified.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListedUser

public ListedUser()

Method Detail

setArn

public void setArn(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.

getArn

public String getArn()

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.

withArn

public ListedUser withArn(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.

setHomeDirectory

public void setHomeDirectory(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.

getHomeDirectory

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.

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.

withHomeDirectory

public ListedUser withHomeDirectory(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.

setHomeDirectoryType

public void setHomeDirectoryType(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.

See Also:

HomeDirectoryType

getHomeDirectoryType

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

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

withHomeDirectoryType

public ListedUser withHomeDirectoryType(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

withHomeDirectoryType

public ListedUser withHomeDirectoryType(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

setRole

public void setRole(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.

getRole

public String getRole()

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.

withRole

public ListedUser withRole(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.

setSshPublicKeyCount

public void setSshPublicKeyCount(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.

getSshPublicKeyCount

public Integer getSshPublicKeyCount()

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.

withSshPublicKeyCount

public ListedUser withSshPublicKeyCount(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.

setUserName

public void setUserName(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.

getUserName

public String getUserName()

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.

withUserName

public ListedUser withUserName(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListedUser clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo