com.amazonaws.services.transfer.model

Class CreateUserRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.transfer.model.CreateUserRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateUserRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateUserRequest()

Method Summary

Modifier and Type	Method and Description
CreateUserRequest	clone()
boolean	equals(Object obj)
String	getHomeDirectory() The landing directory (folder) for a user when they log in to the server using their SFTP client.
String	getPolicy() A scope-down policy for your user so you can use the same IAM role across multiple users.
String	getRole() The IAM role that controls your user's access to your Amazon S3 bucket.
String	getServerId() A system-assigned unique identifier for an SFTP server instance.
String	getSshPublicKeyBody() The public portion of the Secure Shall (SSH) key used to authenticate the user to the SFTP server.
List<Tag>	getTags() Key-value pairs that can be used to group and search for users.
String	getUserName() A unique string that identifies a user and is associated with a server as specified by the ServerId.
int	hashCode()
void	setHomeDirectory(String homeDirectory) The landing directory (folder) for a user when they log in to the server using their SFTP client.
void	setPolicy(String policy) A scope-down policy for your user so you can use the same IAM role across multiple users.
void	setRole(String role) The IAM role that controls your user's access to your Amazon S3 bucket.
void	setServerId(String serverId) A system-assigned unique identifier for an SFTP server instance.
void	setSshPublicKeyBody(String sshPublicKeyBody) The public portion of the Secure Shall (SSH) key used to authenticate the user to the SFTP server.
void	setTags(Collection<Tag> tags) Key-value pairs that can be used to group and search for users.
void	setUserName(String userName) A unique string that identifies a user and is associated with a server as specified by the ServerId.
String	toString() Returns a string representation of this object.
CreateUserRequest	withHomeDirectory(String homeDirectory) The landing directory (folder) for a user when they log in to the server using their SFTP client.
CreateUserRequest	withPolicy(String policy) A scope-down policy for your user so you can use the same IAM role across multiple users.
CreateUserRequest	withRole(String role) The IAM role that controls your user's access to your Amazon S3 bucket.
CreateUserRequest	withServerId(String serverId) A system-assigned unique identifier for an SFTP server instance.
CreateUserRequest	withSshPublicKeyBody(String sshPublicKeyBody) The public portion of the Secure Shall (SSH) key used to authenticate the user to the SFTP server.
CreateUserRequest	withTags(Collection<Tag> tags) Key-value pairs that can be used to group and search for users.
CreateUserRequest	withTags(Tag... tags) Key-value pairs that can be used to group and search for users.
CreateUserRequest	withUserName(String userName) A unique string that identifies a user and is associated with a server as specified by the ServerId.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateUserRequest

public CreateUserRequest()

Method Detail

setHomeDirectory

public void setHomeDirectory(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 .

Parameters:

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

getHomeDirectory

public String getHomeDirectory()

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 .

withHomeDirectory

public CreateUserRequest withHomeDirectory(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 .

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setPolicy

public void setPolicy(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}.

Parameters:

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

getPolicy

public String getPolicy()

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

withPolicy

public CreateUserRequest withPolicy(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}.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setRole

public void setRole(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.

Parameters:

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.

getRole

public String getRole()

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.

withRole

public CreateUserRequest withRole(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setServerId

public void setServerId(String serverId)

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

Parameters:

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

getServerId

public String getServerId()

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.

withServerId

public CreateUserRequest withServerId(String serverId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setSshPublicKeyBody

public void setSshPublicKeyBody(String sshPublicKeyBody)

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

Parameters:

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

getSshPublicKeyBody

public String getSshPublicKeyBody()

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.

withSshPublicKeyBody

public CreateUserRequest withSshPublicKeyBody(String sshPublicKeyBody)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

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

Returns:

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

setTags

public void setTags(Collection<Tag> tags)

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

Parameters:

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

withTags

public CreateUserRequest withTags(Tag... tags)

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

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateUserRequest withTags(Collection<Tag> tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setUserName

public void setUserName(String userName)

A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

Parameters:

userName - A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

getUserName

public String getUserName()

A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

Returns:

A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

withUserName

public CreateUserRequest withUserName(String userName)

A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

Parameters:

userName - A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateUserRequest clone()

Overrides:

clone in class AmazonWebServiceRequest