@Generated(value="software.amazon.awssdk:codegen") public final class ListedUser extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ListedUser.Builder,ListedUser>
Returns properties of the user that you specify.
Modifier and Type | Class and Description |
---|---|
static interface |
ListedUser.Builder |
Modifier and Type | Method and Description |
---|---|
String |
arn()
Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
|
static ListedUser.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
homeDirectory()
Specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by
their ARN.
|
HomeDirectoryType |
homeDirectoryType()
Specifies the type of landing directory (folder) you mapped for your users' home directory.
|
String |
homeDirectoryTypeAsString()
Specifies the type of landing directory (folder) you mapped for your users' home directory.
|
String |
role()
Specifies the role that is in use by this user.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ListedUser.Builder> |
serializableBuilderClass() |
Integer |
sshPublicKeyCount()
Specifies the number of SSH public keys stored for the user you specified.
|
ListedUser.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
String |
userName()
Specifies the name of the user whose ARN was specified.
|
copy
public final String arn()
Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
public final String homeDirectory()
Specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.
public final HomeDirectoryType homeDirectoryType()
Specifies the type of landing directory (folder) you mapped for your users' home directory. 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.
If the service returns an enum value that is not available in the current SDK version, homeDirectoryType
will return HomeDirectoryType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from homeDirectoryTypeAsString()
.
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 final String homeDirectoryTypeAsString()
Specifies the type of landing directory (folder) you mapped for your users' home directory. 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.
If the service returns an enum value that is not available in the current SDK version, homeDirectoryType
will return HomeDirectoryType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from homeDirectoryTypeAsString()
.
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 final String role()
Specifies the role that is in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows a file transfer protocol-enabled server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.
public final Integer sshPublicKeyCount()
Specifies the number of SSH public keys stored for the user you specified.
public final String userName()
Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.
public ListedUser.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ListedUser.Builder,ListedUser>
public static ListedUser.Builder builder()
public static Class<? extends ListedUser.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()