software.amazon.awssdk.services.transfer.model

Class CreateUserRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.transfer.model.TransferRequest

software.amazon.awssdk.services.transfer.model.CreateUserRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateUserRequest
extends TransferRequest
implements ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateUserRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateUserRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	homeDirectory() The landing directory (folder) for a user when they log in to the server using their SFTP client.
String	policy() A scope-down policy for your user so you can use the same IAM role across multiple users.
String	role() The IAM role that controls your user’s access to your Amazon S3 bucket.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateUserRequest.Builder>	serializableBuilderClass()
String	serverId() A system-assigned unique identifier for an SFTP server instance.
String	sshPublicKeyBody() The public portion of the Secure Shall (SSH) key used to authenticate the user to the SFTP server.
List<Tag>	tags() Key-value pairs that can be used to group and search for users.
CreateUserRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	userName() A unique string that identifies a user and is associated with a server as specified by the ServerId.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

homeDirectory

public String homeDirectory()

The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is /home/username .

Returns:

The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is /home/username .

policy

public String policy()

A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

Returns:

A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

role

public String role()

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:

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.

serverId

public String serverId()

A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.

Returns:

A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.

sshPublicKeyBody

public String sshPublicKeyBody()

The public portion of the Secure Shall (SSH) key used to authenticate the user to the SFTP server.

Returns:

The public portion of the Secure Shall (SSH) key used to authenticate the user to the SFTP server.

tags

public List<Tag> tags()

Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.

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

Returns:

Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.

userName

public String userName()

A unique string that identifies a user and is associated with a server as specified by the ServerId.

Returns:

A unique string that identifies a user and is associated with a server as specified by the ServerId.

toBuilder

public CreateUserRequest.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<CreateUserRequest.Builder,CreateUserRequest>

Specified by:

toBuilder in class TransferRequest

Returns:

a builder for type T

builder

public static CreateUserRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateUserRequest.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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

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.