@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribedUser extends Object implements Serializable, Cloneable, StructuredPojo
Describes the properties of a user that was specified.
Constructor and Description |
---|
DescribedUser() |
Modifier and Type | Method and Description |
---|---|
DescribedUser |
clone() |
boolean |
equals(Object obj) |
String |
getArn()
Specifies 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()
Specifies the logical directory mappings that specify what Amazon S3 paths and keys should be visible to your
user and how you want to make them visible.
|
String |
getHomeDirectoryType()
Specifies 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()
Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
|
List<Tag> |
getTags()
Specifies the key-value pairs for the user requested.
|
String |
getUserName()
Specifies the name of the user that was requested to be described.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setArn(String arn)
Specifies 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)
Specifies the logical directory mappings that specify what Amazon S3 paths and keys should be visible to your
user and how you want to make them visible.
|
void |
setHomeDirectoryType(String homeDirectoryType)
Specifies 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)
Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
|
void |
setTags(Collection<Tag> tags)
Specifies the key-value pairs for the user requested.
|
void |
setUserName(String userName)
Specifies the name of the user that was requested to be described.
|
String |
toString()
Returns a string representation of this object.
|
DescribedUser |
withArn(String arn)
Specifies 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)
Specifies the logical directory mappings that specify what Amazon S3 paths and keys should be visible to your
user and how you want to make them visible.
|
DescribedUser |
withHomeDirectoryMappings(HomeDirectoryMapEntry... homeDirectoryMappings)
Specifies the logical directory mappings that specify what Amazon S3 paths and keys should be visible to your
user and how you want to make them visible.
|
DescribedUser |
withHomeDirectoryType(HomeDirectoryType homeDirectoryType)
Specifies 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)
Specifies 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)
Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
|
DescribedUser |
withSshPublicKeys(SshPublicKey... sshPublicKeys)
Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
|
DescribedUser |
withTags(Collection<Tag> tags)
Specifies the key-value pairs for the user requested.
|
DescribedUser |
withTags(Tag... tags)
Specifies the key-value pairs for the user requested.
|
DescribedUser |
withUserName(String userName)
Specifies the name of the user that was requested to be described.
|
public void setArn(String arn)
Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.
arn
- Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.public String getArn()
Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.
public DescribedUser withArn(String arn)
Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.
arn
- Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.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-Amazon-S3-bucket-name>/home/username
.
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-Amazon-S3-bucket-name>/home/username
.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-Amazon-S3-bucket-name>/home/username
.
your-Amazon-S3-bucket-name>/home/username
.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-Amazon-S3-bucket-name>/home/username
.
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-Amazon-S3-bucket-name>/home/username
.public List<HomeDirectoryMapEntry> getHomeDirectoryMappings()
Specifies the logical directory mappings that specify 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 Identity and Access Management (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.
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 Identity and Access Management (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.
public void setHomeDirectoryMappings(Collection<HomeDirectoryMapEntry> homeDirectoryMappings)
Specifies the logical directory mappings that specify 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 Identity and Access Management (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.
homeDirectoryMappings
- Specifies the logical directory mappings that specify 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 Identity and Access Management (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.
public DescribedUser withHomeDirectoryMappings(HomeDirectoryMapEntry... homeDirectoryMappings)
Specifies the logical directory mappings that specify 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 Identity and Access Management (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.
homeDirectoryMappings
- Specifies the logical directory mappings that specify 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 Identity and Access Management (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.
public DescribedUser withHomeDirectoryMappings(Collection<HomeDirectoryMapEntry> homeDirectoryMappings)
Specifies the logical directory mappings that specify 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 Identity and Access Management (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.
homeDirectoryMappings
- Specifies the logical directory mappings that specify 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 Identity and Access Management (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.
public void setHomeDirectoryType(String homeDirectoryType)
Specifies 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.
homeDirectoryType
- Specifies 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.HomeDirectoryType
public String getHomeDirectoryType()
Specifies 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.
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.HomeDirectoryType
public DescribedUser withHomeDirectoryType(String homeDirectoryType)
Specifies 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.
homeDirectoryType
- Specifies 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.HomeDirectoryType
public DescribedUser withHomeDirectoryType(HomeDirectoryType homeDirectoryType)
Specifies 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.
homeDirectoryType
- Specifies 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.HomeDirectoryType
public void setPolicy(String policy)
Specifies the name of the policy in use for the described user.
policy
- Specifies the name of the policy in use for the described user.public String getPolicy()
Specifies the name of the policy in use for the described user.
public DescribedUser withPolicy(String policy)
Specifies the name of the policy in use for the described user.
policy
- Specifies the name of the policy in use for the described user.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.
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.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.
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.
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.public List<SshPublicKey> getSshPublicKeys()
Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
public void setSshPublicKeys(Collection<SshPublicKey> sshPublicKeys)
Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
sshPublicKeys
- Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.public DescribedUser withSshPublicKeys(SshPublicKey... sshPublicKeys)
Specifies 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.
sshPublicKeys
- Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.public DescribedUser withSshPublicKeys(Collection<SshPublicKey> sshPublicKeys)
Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
sshPublicKeys
- Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.public List<Tag> getTags()
Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
public void setTags(Collection<Tag> tags)
Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
tags
- Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a
variety of purposes.public DescribedUser withTags(Tag... tags)
Specifies 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.
tags
- Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a
variety of purposes.public DescribedUser withTags(Collection<Tag> tags)
Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
tags
- Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a
variety of purposes.public void setUserName(String userName)
Specifies 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.
userName
- Specifies 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.public String getUserName()
Specifies 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.
public DescribedUser withUserName(String userName)
Specifies 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.
userName
- Specifies 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.public String toString()
toString
in class Object
Object.toString()
public DescribedUser clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.