DescribedUser (AWS Java SDK for AWS Transfer for SFTP 1.11.786 API)

java.lang.Object
- com.amazonaws.services.transfer.model.DescribedUser

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribedUser
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Returns properties of the user that you want to describe.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribedUser()

Constructors
Constructor and Description
`DescribedUser()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribedUser`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` Contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
`String`	`getHomeDirectory()` Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user.
`List<HomeDirectoryMapEntry>`	`getHomeDirectoryMappings()` Logical directory mappings that you specified for what Amazon S3 paths and keys should be visible to your user and how you want to make them visible.
`String`	`getHomeDirectoryType()` The type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server.
`String`	`getPolicy()` Specifies the name of the policy in use for the described user.
`String`	`getRole()` Specifies the IAM role that controls your users' access to your Amazon S3 bucket.
`List<SshPublicKey>`	`getSshPublicKeys()` Contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
`List<Tag>`	`getTags()` Contains the key-value pairs for the user requested.
`String`	`getUserName()` The name of the user that was requested to be described.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setArn(String arn)` Contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
`void`	`setHomeDirectory(String homeDirectory)` Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user.
`void`	`setHomeDirectoryMappings(Collection<HomeDirectoryMapEntry> homeDirectoryMappings)` Logical directory mappings that you specified for what Amazon S3 paths and keys should be visible to your user and how you want to make them visible.
`void`	`setHomeDirectoryType(String homeDirectoryType)` The type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server.
`void`	`setPolicy(String policy)` Specifies the name of the policy in use for the described user.
`void`	`setRole(String role)` Specifies the IAM role that controls your users' access to your Amazon S3 bucket.
`void`	`setSshPublicKeys(Collection<SshPublicKey> sshPublicKeys)` Contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
`void`	`setTags(Collection<Tag> tags)` Contains the key-value pairs for the user requested.
`void`	`setUserName(String userName)` The name of the user that was requested to be described.
`String`	`toString()` Returns a string representation of this object.
`DescribedUser`	`withArn(String arn)` Contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
`DescribedUser`	`withHomeDirectory(String homeDirectory)` Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user.
`DescribedUser`	`withHomeDirectoryMappings(Collection<HomeDirectoryMapEntry> homeDirectoryMappings)` Logical directory mappings that you specified for what Amazon S3 paths and keys should be visible to your user and how you want to make them visible.
`DescribedUser`	`withHomeDirectoryMappings(HomeDirectoryMapEntry... homeDirectoryMappings)` Logical directory mappings that you specified for what Amazon S3 paths and keys should be visible to your user and how you want to make them visible.
`DescribedUser`	`withHomeDirectoryType(HomeDirectoryType homeDirectoryType)` The type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server.
`DescribedUser`	`withHomeDirectoryType(String homeDirectoryType)` The type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server.
`DescribedUser`	`withPolicy(String policy)` Specifies the name of the policy in use for the described user.
`DescribedUser`	`withRole(String role)` Specifies the IAM role that controls your users' access to your Amazon S3 bucket.
`DescribedUser`	`withSshPublicKeys(Collection<SshPublicKey> sshPublicKeys)` Contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
`DescribedUser`	`withSshPublicKeys(SshPublicKey... sshPublicKeys)` Contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
`DescribedUser`	`withTags(Collection<Tag> tags)` Contains the key-value pairs for the user requested.
`DescribedUser`	`withTags(Tag... tags)` Contains the key-value pairs for the user requested.
`DescribedUser`	`withUserName(String userName)` The name of the user that was requested to be described.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribedUser
```
public DescribedUser()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    Contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
    
    Parameters:
    
    arn - Contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
  - getArn
```
public String getArn()
```
    Contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
    
    Returns:
    
    Contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
  - withArn
```
public DescribedUser withArn(String arn)
```
    Contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
    
    Parameters:
    
    arn - Contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHomeDirectory
```
public void setHomeDirectory(String homeDirectory)
```
    Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .
    
    Parameters:
    
    homeDirectory - Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .
  - getHomeDirectory
```
public String getHomeDirectory()
```
    Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .
    
    Returns:
    
    Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .
  - withHomeDirectory
```
public DescribedUser withHomeDirectory(String homeDirectory)
```
    Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .
    
    Parameters:
    
    homeDirectory - Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getHomeDirectoryMappings
```
public List<HomeDirectoryMapEntry> getHomeDirectoryMappings()
```
    Logical directory mappings that you specified for 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 AWS IAM Role provides access to paths in Target.
    
    In most cases, you can use this value instead of the scope-down 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.
    
    Returns:
    
    Logical directory mappings that you specified for 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 AWS IAM Role provides access to paths in Target.
    
    In most cases, you can use this value instead of the scope-down 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.
  - setHomeDirectoryMappings
```
public void setHomeDirectoryMappings(Collection<HomeDirectoryMapEntry> homeDirectoryMappings)
```
    Logical directory mappings that you specified for 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 AWS IAM Role provides access to paths in Target.
    
    In most cases, you can use this value instead of the scope-down 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.
    
    Parameters:
    
    homeDirectoryMappings - Logical directory mappings that you specified for 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 AWS IAM Role provides access to paths in Target .
    
    In most cases, you can use this value instead of the scope-down 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.
  - withHomeDirectoryMappings
```
public DescribedUser withHomeDirectoryMappings(HomeDirectoryMapEntry... homeDirectoryMappings)
```
    Logical directory mappings that you specified for 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 AWS IAM Role provides access to paths in Target.
    
    In most cases, you can use this value instead of the scope-down 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setHomeDirectoryMappings(java.util.Collection) or withHomeDirectoryMappings(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    homeDirectoryMappings - Logical directory mappings that you specified for 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 AWS IAM Role provides access to paths in Target .
    
    In most cases, you can use this value instead of the scope-down 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withHomeDirectoryMappings
```
public DescribedUser withHomeDirectoryMappings(Collection<HomeDirectoryMapEntry> homeDirectoryMappings)
```
    Logical directory mappings that you specified for 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 AWS IAM Role provides access to paths in Target.
    
    In most cases, you can use this value instead of the scope-down 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.
    
    Parameters:
    
    homeDirectoryMappings - Logical directory mappings that you specified for 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 AWS IAM Role provides access to paths in Target .
    
    In most cases, you can use this value instead of the scope-down 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.
    
    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) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.
    
    Parameters:
    
    homeDirectoryType - The type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.
    
    See Also:
    
    HomeDirectoryType
  - getHomeDirectoryType
```
public String getHomeDirectoryType()
```
    The type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.
    
    Returns:
    
    The type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.
    
    See Also:
    
    HomeDirectoryType
  - withHomeDirectoryType
```
public DescribedUser withHomeDirectoryType(String homeDirectoryType)
```
    The type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.
    
    Parameters:
    
    homeDirectoryType - The type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HomeDirectoryType
  - withHomeDirectoryType
```
public DescribedUser withHomeDirectoryType(HomeDirectoryType homeDirectoryType)
```
    The type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.
    
    Parameters:
    
    homeDirectoryType - The type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HomeDirectoryType
  - setPolicy
```
public void setPolicy(String policy)
```
    Specifies the name of the policy in use for the described user.
    
    Parameters:
    
    policy - Specifies the name of the policy in use for the described user.
  - getPolicy
```
public String getPolicy()
```
    Specifies the name of the policy in use for the described user.
    
    Returns:
    
    Specifies the name of the policy in use for the described user.
  - withPolicy
```
public DescribedUser withPolicy(String policy)
```
    Specifies the name of the policy in use for the described user.
    
    Parameters:
    
    policy - Specifies the name of the policy in use for the described user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRole
```
public void setRole(String role)
```
    Specifies the IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.
    
    Parameters:
    
    role - Specifies the IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.
  - getRole
```
public String getRole()
```
    Specifies the IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.
    
    Returns:
    
    Specifies the IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.
  - withRole
```
public DescribedUser withRole(String role)
```
    Specifies the IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.
    
    Parameters:
    
    role - Specifies the IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSshPublicKeys
```
public List<SshPublicKey> getSshPublicKeys()
```
    Contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
    
    Returns:
    
    Contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
  - setSshPublicKeys
```
public void setSshPublicKeys(Collection<SshPublicKey> sshPublicKeys)
```
    Contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
    
    Parameters:
    
    sshPublicKeys - Contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
  - withSshPublicKeys
```
public DescribedUser withSshPublicKeys(SshPublicKey... sshPublicKeys)
```
    Contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
    
    NOTE: This method appends the values to the existing list (if any). Use setSshPublicKeys(java.util.Collection) or withSshPublicKeys(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    sshPublicKeys - Contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSshPublicKeys
```
public DescribedUser withSshPublicKeys(Collection<SshPublicKey> sshPublicKeys)
```
    Contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
    
    Parameters:
    
    sshPublicKeys - Contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    Contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
    
    Returns:
    
    Contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    Contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
    
    Parameters:
    
    tags - Contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
  - withTags
```
public DescribedUser withTags(Tag... tags)
```
    Contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - Contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public DescribedUser withTags(Collection<Tag> tags)
```
    Contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
    
    Parameters:
    
    tags - Contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserName
```
public void setUserName(String userName)
```
    The name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your file transfer protocol-enabled server.
    
    Parameters:
    
    userName - The name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your file transfer protocol-enabled server.
  - getUserName
```
public String getUserName()
```
    The name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your file transfer protocol-enabled server.
    
    Returns:
    
    The name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your file transfer protocol-enabled server.
  - withUserName
```
public DescribedUser withUserName(String userName)
```
    The name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your file transfer protocol-enabled server.
    
    Parameters:
    
    userName - The name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your file transfer protocol-enabled server.
    
    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 DescribedUser clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class DescribedUser

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DescribedUser

Method Detail

setArn

getArn

withArn

setHomeDirectory

getHomeDirectory

withHomeDirectory

getHomeDirectoryMappings

setHomeDirectoryMappings

withHomeDirectoryMappings

withHomeDirectoryMappings

setHomeDirectoryType

getHomeDirectoryType

withHomeDirectoryType

withHomeDirectoryType

setPolicy

getPolicy

withPolicy

setRole

getRole

withRole

getSshPublicKeys

setSshPublicKeys

withSshPublicKeys

withSshPublicKeys

getTags

setTags

withTags

withTags

setUserName

getUserName

withUserName

toString

equals

hashCode

clone

marshall