@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.
Constructor and Description |
---|
DescribedUser() |
Modifier and Type | Method and Description |
---|---|
DescribedUser |
clone() |
boolean |
equals(Object obj) |
String |
getArn()
This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
|
String |
getHomeDirectory()
This property 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 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 SFTP server.
|
String |
getPolicy()
Specifies the name of the policy in use for the described user.
|
String |
getRole()
This property specifies the IAM role that controls your user's access to your Amazon S3 bucket.
|
List<SshPublicKey> |
getSshPublicKeys()
This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
|
List<Tag> |
getTags()
This property contains the key-value pairs for the user requested.
|
String |
getUserName()
This property is 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)
This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
|
void |
setHomeDirectory(String homeDirectory)
This property 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 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 SFTP server.
|
void |
setPolicy(String policy)
Specifies the name of the policy in use for the described user.
|
void |
setRole(String role)
This property specifies the IAM role that controls your user's access to your Amazon S3 bucket.
|
void |
setSshPublicKeys(Collection<SshPublicKey> sshPublicKeys)
This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
|
void |
setTags(Collection<Tag> tags)
This property contains the key-value pairs for the user requested.
|
void |
setUserName(String userName)
This property is the name of the user that was requested to be described.
|
String |
toString()
Returns a string representation of this object.
|
DescribedUser |
withArn(String arn)
This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
|
DescribedUser |
withHomeDirectory(String homeDirectory)
This property 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 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 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 SFTP server.
|
DescribedUser |
withHomeDirectoryType(String homeDirectoryType)
The type of landing directory (folder) you mapped for your users' to see when they log into the SFTP server.
|
DescribedUser |
withPolicy(String policy)
Specifies the name of the policy in use for the described user.
|
DescribedUser |
withRole(String role)
This property specifies the IAM role that controls your user's access to your Amazon S3 bucket.
|
DescribedUser |
withSshPublicKeys(Collection<SshPublicKey> sshPublicKeys)
This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
|
DescribedUser |
withSshPublicKeys(SshPublicKey... sshPublicKeys)
This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
|
DescribedUser |
withTags(Collection<Tag> tags)
This property contains the key-value pairs for the user requested.
|
DescribedUser |
withTags(Tag... tags)
This property contains the key-value pairs for the user requested.
|
DescribedUser |
withUserName(String userName)
This property is the name of the user that was requested to be described.
|
public void setArn(String arn)
This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
arn
- This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be
described.public String getArn()
This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
public DescribedUser withArn(String arn)
This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
arn
- This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be
described.public void setHomeDirectory(String homeDirectory)
This property 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
.
homeDirectory
- This property 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
.public String getHomeDirectory()
This property 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
.
/your s3 bucket name/home/username
.public DescribedUser withHomeDirectory(String homeDirectory)
This property 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
.
homeDirectory
- This property 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
.public List<HomeDirectoryMapEntry> getHomeDirectoryMappings()
Logical directory mappings that you specified for what 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 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.
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 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.
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)
Logical directory mappings that you specified for what 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 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.
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
- Logical directory mappings that you specified for what 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 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.
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)
Logical directory mappings that you specified for what 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 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.
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
- Logical directory mappings that you specified for what 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 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.
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)
Logical directory mappings that you specified for what 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 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.
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
- Logical directory mappings that you specified for what 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 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.
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)
The type of landing directory (folder) you mapped for your users' to see when they log into the SFTP server. If
you set it to PATH
, the user will see the absolute Amazon S3 bucket paths as is in their SFTP
clients. If you set it LOGICAL
, you will need to provide mappings in the
HomeDirectoryMappings
for how you want to make S3 paths visible to your user.
homeDirectoryType
- The type of landing directory (folder) you mapped for your users' to see when they log into the SFTP
server. If you set it to PATH
, the user will see the absolute Amazon S3 bucket paths as is in
their SFTP clients. If you set it LOGICAL
, you will need to provide mappings in the
HomeDirectoryMappings
for how you want to make S3 paths visible to your user.HomeDirectoryType
public String getHomeDirectoryType()
The type of landing directory (folder) you mapped for your users' to see when they log into the SFTP server. If
you set it to PATH
, the user will see the absolute Amazon S3 bucket paths as is in their SFTP
clients. If you set it LOGICAL
, you will need to provide mappings in the
HomeDirectoryMappings
for how you want to make S3 paths visible to your user.
PATH
, the user will see the absolute Amazon S3 bucket paths as is
in their SFTP clients. If you set it LOGICAL
, you will need to provide mappings in the
HomeDirectoryMappings
for how you want to make S3 paths visible to your user.HomeDirectoryType
public DescribedUser withHomeDirectoryType(String homeDirectoryType)
The type of landing directory (folder) you mapped for your users' to see when they log into the SFTP server. If
you set it to PATH
, the user will see the absolute Amazon S3 bucket paths as is in their SFTP
clients. If you set it LOGICAL
, you will need to provide mappings in the
HomeDirectoryMappings
for how you want to make S3 paths visible to your user.
homeDirectoryType
- The type of landing directory (folder) you mapped for your users' to see when they log into the SFTP
server. If you set it to PATH
, the user will see the absolute Amazon S3 bucket paths as is in
their SFTP clients. If you set it LOGICAL
, you will need to provide mappings in the
HomeDirectoryMappings
for how you want to make S3 paths visible to your user.HomeDirectoryType
public DescribedUser withHomeDirectoryType(HomeDirectoryType homeDirectoryType)
The type of landing directory (folder) you mapped for your users' to see when they log into the SFTP server. If
you set it to PATH
, the user will see the absolute Amazon S3 bucket paths as is in their SFTP
clients. If you set it LOGICAL
, you will need to provide mappings in the
HomeDirectoryMappings
for how you want to make S3 paths visible to your user.
homeDirectoryType
- The type of landing directory (folder) you mapped for your users' to see when they log into the SFTP
server. If you set it to PATH
, the user will see the absolute Amazon S3 bucket paths as is in
their SFTP clients. If you set it LOGICAL
, you will need to provide mappings in the
HomeDirectoryMappings
for how you want to make S3 paths visible to your user.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)
This property specifies the IAM role that controls your user's 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 the SFTP server to access your resources when servicing your SFTP user's transfer requests.
role
- This property specifies the IAM role that controls your user's 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 the SFTP server to access your resources when servicing your SFTP user's
transfer requests.public String getRole()
This property specifies the IAM role that controls your user's 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 the SFTP server to access your resources when servicing your SFTP user's transfer requests.
public DescribedUser withRole(String role)
This property specifies the IAM role that controls your user's 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 the SFTP server to access your resources when servicing your SFTP user's transfer requests.
role
- This property specifies the IAM role that controls your user's 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 the SFTP server to access your resources when servicing your SFTP user's
transfer requests.public List<SshPublicKey> getSshPublicKeys()
This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
public void setSshPublicKeys(Collection<SshPublicKey> sshPublicKeys)
This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
sshPublicKeys
- This property contains the public key portion of the Secure Shell (SSH) keys stored for the described
user.public DescribedUser withSshPublicKeys(SshPublicKey... sshPublicKeys)
This property 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.
sshPublicKeys
- This property contains the public key portion of the Secure Shell (SSH) keys stored for the described
user.public DescribedUser withSshPublicKeys(Collection<SshPublicKey> sshPublicKeys)
This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
sshPublicKeys
- This property contains the public key portion of the Secure Shell (SSH) keys stored for the described
user.public List<Tag> getTags()
This property contains 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)
This property contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
tags
- This property contains 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)
This property 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.
tags
- This property contains 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)
This property contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
tags
- This property contains 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)
This property is 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 SFTP server.
userName
- This property is 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 SFTP
server.public String getUserName()
This property is 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 SFTP server.
public DescribedUser withUserName(String userName)
This property is 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 SFTP server.
userName
- This property is 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 SFTP
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.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.