software.amazon.awssdk.services.transfer.model

Class DescribedUser

java.lang.Object

software.amazon.awssdk.services.transfer.model.DescribedUser

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DescribedUser.Builder,DescribedUser>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribedUser
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DescribedUser.Builder,DescribedUser>

Returns properties of the user that you wish to describe.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribedUser.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
static DescribedUser.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
String	policy() Specifies the name of the policy in use for the described user.
String	role() This property specifies the IAM role that controls your user’s access to your Amazon S3 bucket.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribedUser.Builder>	serializableBuilderClass()
List<SshPublicKey>	sshPublicKeys() This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
List<Tag>	tags() This property contains 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()
String	userName() This property is the name of the user that was requested to be described.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

arn

public String arn()

This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.

Returns:

This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.

homeDirectory

public 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 would be: /bucket_name/home/username .

Returns:

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 would be: /bucket_name/home/username .

policy

public String policy()

Specifies the name of the policy in use for the described user.

Returns:

Specifies the name of the policy in use for the described user.

role

public 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.

Returns:

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.

sshPublicKeys

public List<SshPublicKey> sshPublicKeys()

This property contains 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.

Returns:

This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.

tags

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

userName

public 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.

Returns:

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.

toBuilder

public DescribedUser.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribedUser.Builder,DescribedUser>

Returns:

a builder for type T

builder

public static DescribedUser.Builder builder()

serializableBuilderClass

public static Class<? extends DescribedUser.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.