@Generated(value="software.amazon.awssdk:codegen") public final class DescribedUser extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DescribedUser.Builder,DescribedUser>
Describes the properties of a user that was specified.
Modifier and Type | Class and Description |
---|---|
static interface |
DescribedUser.Builder |
Modifier and Type | Method and Description |
---|---|
String |
arn()
Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.
|
static DescribedUser.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() |
boolean |
hasHomeDirectoryMappings()
Returns true if the HomeDirectoryMappings property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasSshPublicKeys()
Returns true if the SshPublicKeys property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
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.
|
List<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.
|
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.
|
String |
homeDirectoryTypeAsString()
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 |
policy()
Specifies the name of the policy in use for the described user.
|
PosixProfile |
posixProfile()
Returns the value of the PosixProfile property for this object.
|
String |
role()
Specifies the IAM role that controls your users' access to your Amazon S3 bucket.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribedUser.Builder> |
serializableBuilderClass() |
List<SshPublicKey> |
sshPublicKeys()
Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
|
List<Tag> |
tags()
Specifies the key-value pairs for the user requested.
|
DescribedUser.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 that was requested to be described.
|
copy
public final String arn()
Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.
public final 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
.
your-Amazon-S3-bucket-name>/home/username
.public final boolean hasHomeDirectoryMappings()
public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasHomeDirectoryMappings()
to see if a value was sent in this field.
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 final 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.
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 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.
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 policy()
Specifies the name of the policy in use for the described user.
public final PosixProfile posixProfile()
public final 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 server to access your resources when servicing your users' transfer requests.
public final boolean hasSshPublicKeys()
public final List<SshPublicKey> sshPublicKeys()
Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasSshPublicKeys()
to see if a value was sent in this field.
public final boolean hasTags()
public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTags()
to see if a value was sent in this field.
public final 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 server.
public DescribedUser.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribedUser.Builder,DescribedUser>
public static DescribedUser.Builder builder()
public static Class<? extends DescribedUser.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()