@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.
Constructor and Description |
---|
ListedUser() |
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) you want your users' home directory to be when they log into the server.
|
String |
getRole()
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3
bucket or 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)
Marshalls this structured data using the given
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) you want your users' home directory to be when they log into the server.
|
void |
setRole(String role)
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3
bucket or 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) you want your users' home directory to be when they log into the server.
|
ListedUser |
withHomeDirectoryType(String homeDirectoryType)
The type of landing directory (folder) you want your users' home directory to be when they log into the server.
|
ListedUser |
withRole(String role)
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3
bucket or 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.
|
public void setArn(String arn)
Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
arn
- Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.public String getArn()
Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
public ListedUser withArn(String arn)
Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
arn
- Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.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
.
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
.
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
.
A HomeDirectory
example is /bucket_name/home/mydirectory
.
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
.
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
.
public void setHomeDirectoryType(String homeDirectoryType)
The type of landing directory (folder) you want your users' home directory to be when they log into the server.
If you set it to PATH
, the user will see the absolute Amazon S3 bucket or EFS paths as is in their
file transfer protocol clients. If you set it LOGICAL
, you need to provide mappings in the
HomeDirectoryMappings
for how you want to make Amazon S3 or EFS paths visible to your users.
homeDirectoryType
- The type of landing directory (folder) you want your users' home directory to be when they log into the
server. If you set it to PATH
, the user will see the absolute Amazon S3 bucket or EFS paths
as is in their file transfer protocol clients. If you set it LOGICAL
, you need to provide
mappings in the HomeDirectoryMappings
for how you want to make Amazon S3 or EFS paths visible
to your users.HomeDirectoryType
public String getHomeDirectoryType()
The type of landing directory (folder) you want your users' home directory to be when they log into the server.
If you set it to PATH
, the user will see the absolute Amazon S3 bucket or EFS paths as is in their
file transfer protocol clients. If you set it LOGICAL
, you need to provide mappings in the
HomeDirectoryMappings
for how you want to make Amazon S3 or EFS paths visible to your users.
PATH
, the user will see the absolute Amazon S3 bucket or EFS paths
as is in their file transfer protocol clients. If you set it LOGICAL
, you need to provide
mappings in the HomeDirectoryMappings
for how you want to make Amazon S3 or EFS paths
visible to your users.HomeDirectoryType
public ListedUser withHomeDirectoryType(String homeDirectoryType)
The type of landing directory (folder) you want your users' home directory to be when they log into the server.
If you set it to PATH
, the user will see the absolute Amazon S3 bucket or EFS paths as is in their
file transfer protocol clients. If you set it LOGICAL
, you need to provide mappings in the
HomeDirectoryMappings
for how you want to make Amazon S3 or EFS paths visible to your users.
homeDirectoryType
- The type of landing directory (folder) you want your users' home directory to be when they log into the
server. If you set it to PATH
, the user will see the absolute Amazon S3 bucket or EFS paths
as is in their file transfer protocol clients. If you set it LOGICAL
, you need to provide
mappings in the HomeDirectoryMappings
for how you want to make Amazon S3 or EFS paths visible
to your users.HomeDirectoryType
public ListedUser withHomeDirectoryType(HomeDirectoryType homeDirectoryType)
The type of landing directory (folder) you want your users' home directory to be when they log into the server.
If you set it to PATH
, the user will see the absolute Amazon S3 bucket or EFS paths as is in their
file transfer protocol clients. If you set it LOGICAL
, you need to provide mappings in the
HomeDirectoryMappings
for how you want to make Amazon S3 or EFS paths visible to your users.
homeDirectoryType
- The type of landing directory (folder) you want your users' home directory to be when they log into the
server. If you set it to PATH
, the user will see the absolute Amazon S3 bucket or EFS paths
as is in their file transfer protocol clients. If you set it LOGICAL
, you need to provide
mappings in the HomeDirectoryMappings
for how you want to make Amazon S3 or EFS paths visible
to your users.HomeDirectoryType
public void setRole(String role)
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or 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 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.
role
- Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon
S3 bucket or 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 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.
public String getRole()
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or 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 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.
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.
public ListedUser withRole(String role)
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or 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 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.
role
- Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon
S3 bucket or 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 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.
public void setSshPublicKeyCount(Integer sshPublicKeyCount)
Specifies the number of SSH public keys stored for the user you specified.
sshPublicKeyCount
- Specifies the number of SSH public keys stored for the user you specified.public Integer getSshPublicKeyCount()
Specifies the number of SSH public keys stored for the user you specified.
public ListedUser withSshPublicKeyCount(Integer sshPublicKeyCount)
Specifies the number of SSH public keys stored for the user you specified.
sshPublicKeyCount
- Specifies the number of SSH public keys stored for the user you specified.public void setUserName(String userName)
Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.
userName
- Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.public String getUserName()
Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.
public ListedUser withUserName(String userName)
Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.
userName
- Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.public String toString()
toString
in class Object
Object.toString()
public ListedUser clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.