Class DescribedUser
- java.lang.Object
-
- software.amazon.awssdk.services.transfer.model.DescribedUser
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DescribedUser.Builder,DescribedUser>
@Generated("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.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribedUser.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasHomeDirectoryMappings()
For responses, this returns true if the service returned a value for the HomeDirectoryMappings property.boolean
hasSshPublicKeys()
For responses, this returns true if the service returned a value for the SshPublicKeys property.boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.String
homeDirectory()
The landing directory (folder) for a user when they log in to the server using the client.List<HomeDirectoryMapEntry>
homeDirectoryMappings()
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible.HomeDirectoryType
homeDirectoryType()
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.String
homeDirectoryTypeAsString()
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.String
policy()
A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users.PosixProfile
posixProfile()
Specifies the full POSIX identity, including user ID (Uid
), group ID (Gid
), and any secondary groups IDs (SecondaryGids
), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems.String
role()
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system.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()
String
toString()
Returns a string representation of this object.String
userName()
Specifies the name of the user that was requested to be described.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
arn
public final String arn()
Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.
- Returns:
- Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.
-
homeDirectory
public final 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
.The
HomeDirectory
parameter is only used ifHomeDirectoryType
is set toPATH
.- Returns:
- 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
.The
HomeDirectory
parameter is only used ifHomeDirectoryType
is set toPATH
.
-
hasHomeDirectoryMappings
public final boolean hasHomeDirectoryMappings()
For responses, this returns true if the service returned a value for the HomeDirectoryMappings property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
homeDirectoryMappings
public final List<HomeDirectoryMapEntry> homeDirectoryMappings()
Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the
Entry
andTarget
pair, whereEntry
shows how the path is made visible andTarget
is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths inTarget
. This value can be set only whenHomeDirectoryType
is set to LOGICAL.In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory ("
chroot
"). To do this, you can setEntry
to '/' and setTarget
to the HomeDirectory parameter value.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasHomeDirectoryMappings()
method.- Returns:
- Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to
your user and how you want to make them visible. You must specify the
Entry
andTarget
pair, whereEntry
shows how the path is made visible andTarget
is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths inTarget
. This value can be set only whenHomeDirectoryType
is set to LOGICAL.In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory ("
chroot
"). To do this, you can setEntry
to '/' and setTarget
to the HomeDirectory parameter value.
-
homeDirectoryType
public final HomeDirectoryType homeDirectoryType()
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to
PATH
, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it toLOGICAL
, you need to provide mappings in theHomeDirectoryMappings
for how you want to make Amazon S3 or Amazon EFS paths visible to your users.If
HomeDirectoryType
isLOGICAL
, you must provide mappings, using theHomeDirectoryMappings
parameter. If, on the other hand,HomeDirectoryType
isPATH
, you provide an absolute path using theHomeDirectory
parameter. You cannot have bothHomeDirectory
andHomeDirectoryMappings
in your template.If the service returns an enum value that is not available in the current SDK version,
homeDirectoryType
will returnHomeDirectoryType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhomeDirectoryTypeAsString()
.- Returns:
- The type of landing directory (folder) that you want your users' home directory to be when they log in to
the server. If you set it to
PATH
, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it toLOGICAL
, you need to provide mappings in theHomeDirectoryMappings
for how you want to make Amazon S3 or Amazon EFS paths visible to your users.If
HomeDirectoryType
isLOGICAL
, you must provide mappings, using theHomeDirectoryMappings
parameter. If, on the other hand,HomeDirectoryType
isPATH
, you provide an absolute path using theHomeDirectory
parameter. You cannot have bothHomeDirectory
andHomeDirectoryMappings
in your template. - See Also:
HomeDirectoryType
-
homeDirectoryTypeAsString
public final String homeDirectoryTypeAsString()
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to
PATH
, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it toLOGICAL
, you need to provide mappings in theHomeDirectoryMappings
for how you want to make Amazon S3 or Amazon EFS paths visible to your users.If
HomeDirectoryType
isLOGICAL
, you must provide mappings, using theHomeDirectoryMappings
parameter. If, on the other hand,HomeDirectoryType
isPATH
, you provide an absolute path using theHomeDirectory
parameter. You cannot have bothHomeDirectory
andHomeDirectoryMappings
in your template.If the service returns an enum value that is not available in the current SDK version,
homeDirectoryType
will returnHomeDirectoryType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhomeDirectoryTypeAsString()
.- Returns:
- The type of landing directory (folder) that you want your users' home directory to be when they log in to
the server. If you set it to
PATH
, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it toLOGICAL
, you need to provide mappings in theHomeDirectoryMappings
for how you want to make Amazon S3 or Amazon EFS paths visible to your users.If
HomeDirectoryType
isLOGICAL
, you must provide mappings, using theHomeDirectoryMappings
parameter. If, on the other hand,HomeDirectoryType
isPATH
, you provide an absolute path using theHomeDirectory
parameter. You cannot have bothHomeDirectory
andHomeDirectoryMappings
in your template. - See Also:
HomeDirectoryType
-
policy
public final String policy()
A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include
${Transfer:UserName}
,${Transfer:HomeDirectory}
, and${Transfer:HomeBucket}
.- Returns:
- A session policy for your user so that you can use the same Identity and Access Management (IAM) role
across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket.
Variables that you can use inside this policy include
${Transfer:UserName}
,${Transfer:HomeDirectory}
, and${Transfer:HomeBucket}
.
-
posixProfile
public final PosixProfile posixProfile()
Specifies the full POSIX identity, including user ID (
Uid
), group ID (Gid
), and any secondary groups IDs (SecondaryGids
), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.- Returns:
- Specifies the full POSIX identity, including user ID (
Uid
), group ID (Gid
), and any secondary groups IDs (SecondaryGids
), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.
-
role
public final String role()
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon 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 Amazon 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.
- Returns:
- The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon 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 Amazon 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.
-
hasSshPublicKeys
public final boolean hasSshPublicKeys()
For responses, this returns true if the service returned a value for the SshPublicKeys property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
sshPublicKeys
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSshPublicKeys()
method.- Returns:
- Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tags
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
-
userName
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.
- Returns:
- 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.
-
toBuilder
public DescribedUser.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribedUser.Builder,DescribedUser>
-
builder
public static DescribedUser.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribedUser.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-