AWS SDK for C++  1.9.45
AWS SDK for C++
Public Member Functions | List of all members
Aws::Transfer::Model::CreateUserRequest Class Reference

#include <CreateUserRequest.h>

+ Inheritance diagram for Aws::Transfer::Model::CreateUserRequest:

Public Member Functions

 CreateUserRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetHomeDirectory () const
 
bool HomeDirectoryHasBeenSet () const
 
void SetHomeDirectory (const Aws::String &value)
 
void SetHomeDirectory (Aws::String &&value)
 
void SetHomeDirectory (const char *value)
 
CreateUserRequestWithHomeDirectory (const Aws::String &value)
 
CreateUserRequestWithHomeDirectory (Aws::String &&value)
 
CreateUserRequestWithHomeDirectory (const char *value)
 
const HomeDirectoryTypeGetHomeDirectoryType () const
 
bool HomeDirectoryTypeHasBeenSet () const
 
void SetHomeDirectoryType (const HomeDirectoryType &value)
 
void SetHomeDirectoryType (HomeDirectoryType &&value)
 
CreateUserRequestWithHomeDirectoryType (const HomeDirectoryType &value)
 
CreateUserRequestWithHomeDirectoryType (HomeDirectoryType &&value)
 
const Aws::Vector< HomeDirectoryMapEntry > & GetHomeDirectoryMappings () const
 
bool HomeDirectoryMappingsHasBeenSet () const
 
void SetHomeDirectoryMappings (const Aws::Vector< HomeDirectoryMapEntry > &value)
 
void SetHomeDirectoryMappings (Aws::Vector< HomeDirectoryMapEntry > &&value)
 
CreateUserRequestWithHomeDirectoryMappings (const Aws::Vector< HomeDirectoryMapEntry > &value)
 
CreateUserRequestWithHomeDirectoryMappings (Aws::Vector< HomeDirectoryMapEntry > &&value)
 
CreateUserRequestAddHomeDirectoryMappings (const HomeDirectoryMapEntry &value)
 
CreateUserRequestAddHomeDirectoryMappings (HomeDirectoryMapEntry &&value)
 
const Aws::StringGetPolicy () const
 
bool PolicyHasBeenSet () const
 
void SetPolicy (const Aws::String &value)
 
void SetPolicy (Aws::String &&value)
 
void SetPolicy (const char *value)
 
CreateUserRequestWithPolicy (const Aws::String &value)
 
CreateUserRequestWithPolicy (Aws::String &&value)
 
CreateUserRequestWithPolicy (const char *value)
 
const PosixProfileGetPosixProfile () const
 
bool PosixProfileHasBeenSet () const
 
void SetPosixProfile (const PosixProfile &value)
 
void SetPosixProfile (PosixProfile &&value)
 
CreateUserRequestWithPosixProfile (const PosixProfile &value)
 
CreateUserRequestWithPosixProfile (PosixProfile &&value)
 
const Aws::StringGetRole () const
 
bool RoleHasBeenSet () const
 
void SetRole (const Aws::String &value)
 
void SetRole (Aws::String &&value)
 
void SetRole (const char *value)
 
CreateUserRequestWithRole (const Aws::String &value)
 
CreateUserRequestWithRole (Aws::String &&value)
 
CreateUserRequestWithRole (const char *value)
 
const Aws::StringGetServerId () const
 
bool ServerIdHasBeenSet () const
 
void SetServerId (const Aws::String &value)
 
void SetServerId (Aws::String &&value)
 
void SetServerId (const char *value)
 
CreateUserRequestWithServerId (const Aws::String &value)
 
CreateUserRequestWithServerId (Aws::String &&value)
 
CreateUserRequestWithServerId (const char *value)
 
const Aws::StringGetSshPublicKeyBody () const
 
bool SshPublicKeyBodyHasBeenSet () const
 
void SetSshPublicKeyBody (const Aws::String &value)
 
void SetSshPublicKeyBody (Aws::String &&value)
 
void SetSshPublicKeyBody (const char *value)
 
CreateUserRequestWithSshPublicKeyBody (const Aws::String &value)
 
CreateUserRequestWithSshPublicKeyBody (Aws::String &&value)
 
CreateUserRequestWithSshPublicKeyBody (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateUserRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateUserRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateUserRequestAddTags (const Tag &value)
 
CreateUserRequestAddTags (Tag &&value)
 
const Aws::StringGetUserName () const
 
bool UserNameHasBeenSet () const
 
void SetUserName (const Aws::String &value)
 
void SetUserName (Aws::String &&value)
 
void SetUserName (const char *value)
 
CreateUserRequestWithUserName (const Aws::String &value)
 
CreateUserRequestWithUserName (Aws::String &&value)
 
CreateUserRequestWithUserName (const char *value)
 
- Public Member Functions inherited from Aws::Transfer::TransferRequest
virtual ~TransferRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 26 of file CreateUserRequest.h.

Constructor & Destructor Documentation

◆ CreateUserRequest()

Aws::Transfer::Model::CreateUserRequest::CreateUserRequest ( )

Member Function Documentation

◆ AddHomeDirectoryMappings() [1/2]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::AddHomeDirectoryMappings ( const HomeDirectoryMapEntry value)
inline

Logical directory mappings that specify what Amazon S3 or EFS 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 or EFS path. If you only specify a target, it will be displayed as is. You will need to also make sure that your IAM role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]

In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("<code>chroot</code>"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry will be ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object –bucket bucketname –key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

Definition at line 361 of file CreateUserRequest.h.

◆ AddHomeDirectoryMappings() [2/2]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::AddHomeDirectoryMappings ( HomeDirectoryMapEntry &&  value)
inline

Logical directory mappings that specify what Amazon S3 or EFS 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 or EFS path. If you only specify a target, it will be displayed as is. You will need to also make sure that your IAM role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]

In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("<code>chroot</code>"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry will be ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object –bucket bucketname –key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

Definition at line 390 of file CreateUserRequest.h.

◆ AddTags() [1/2]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::AddTags ( const Tag value)
inline

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

Definition at line 826 of file CreateUserRequest.h.

◆ AddTags() [2/2]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::AddTags ( Tag &&  value)
inline

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

Definition at line 832 of file CreateUserRequest.h.

◆ GetHomeDirectory()

const Aws::String& Aws::Transfer::Model::CreateUserRequest::GetHomeDirectory ( ) const
inline

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.

Definition at line 47 of file CreateUserRequest.h.

◆ GetHomeDirectoryMappings()

const Aws::Vector<HomeDirectoryMapEntry>& Aws::Transfer::Model::CreateUserRequest::GetHomeDirectoryMappings ( ) const
inline

Logical directory mappings that specify what Amazon S3 or EFS 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 or EFS path. If you only specify a target, it will be displayed as is. You will need to also make sure that your IAM role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]

In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("<code>chroot</code>"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry will be ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object –bucket bucketname –key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

Definition at line 187 of file CreateUserRequest.h.

◆ GetHomeDirectoryType()

const HomeDirectoryType& Aws::Transfer::Model::CreateUserRequest::GetHomeDirectoryType ( ) const
inline

The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS 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 or EFS paths visible to your users.

Definition at line 107 of file CreateUserRequest.h.

◆ GetPolicy()

const Aws::String& Aws::Transfer::Model::CreateUserRequest::GetPolicy ( ) const
inline

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

This only applies when domain of ServerId is S3. EFS does not use scope down policy.

For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a scope-down policy, see Example scope-down policy.

For more information, see AssumeRole in the AWS Security Token Service API Reference.

Definition at line 409 of file CreateUserRequest.h.

◆ GetPosixProfile()

const PosixProfile& Aws::Transfer::Model::CreateUserRequest::GetPosixProfile ( ) const
inline

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 EFS file systems. The POSIX permissions that are set on files and directories in Amazon EFS determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

Definition at line 546 of file CreateUserRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Transfer::Model::CreateUserRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Transfer::TransferRequest.

◆ GetRole()

const Aws::String& Aws::Transfer::Model::CreateUserRequest::GetRole ( ) const
inline

Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or 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 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.

Definition at line 608 of file CreateUserRequest.h.

◆ GetServerId()

const Aws::String& Aws::Transfer::Model::CreateUserRequest::GetServerId ( ) const
inline

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

Definition at line 692 of file CreateUserRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Transfer::Model::CreateUserRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file CreateUserRequest.h.

◆ GetSshPublicKeyBody()

const Aws::String& Aws::Transfer::Model::CreateUserRequest::GetSshPublicKeyBody ( ) const
inline

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

Definition at line 741 of file CreateUserRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::Transfer::Model::CreateUserRequest::GetTags ( ) const
inline

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

Definition at line 790 of file CreateUserRequest.h.

◆ GetUserName()

const Aws::String& Aws::Transfer::Model::CreateUserRequest::GetUserName ( ) const
inline

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

Definition at line 842 of file CreateUserRequest.h.

◆ HomeDirectoryHasBeenSet()

bool Aws::Transfer::Model::CreateUserRequest::HomeDirectoryHasBeenSet ( ) const
inline

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.

Definition at line 54 of file CreateUserRequest.h.

◆ HomeDirectoryMappingsHasBeenSet()

bool Aws::Transfer::Model::CreateUserRequest::HomeDirectoryMappingsHasBeenSet ( ) const
inline

Logical directory mappings that specify what Amazon S3 or EFS 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 or EFS path. If you only specify a target, it will be displayed as is. You will need to also make sure that your IAM role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]

In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("<code>chroot</code>"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry will be ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object –bucket bucketname –key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

Definition at line 216 of file CreateUserRequest.h.

◆ HomeDirectoryTypeHasBeenSet()

bool Aws::Transfer::Model::CreateUserRequest::HomeDirectoryTypeHasBeenSet ( ) const
inline

The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS 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 or EFS paths visible to your users.

Definition at line 117 of file CreateUserRequest.h.

◆ PolicyHasBeenSet()

bool Aws::Transfer::Model::CreateUserRequest::PolicyHasBeenSet ( ) const
inline

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

This only applies when domain of ServerId is S3. EFS does not use scope down policy.

For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a scope-down policy, see Example scope-down policy.

For more information, see AssumeRole in the AWS Security Token Service API Reference.

Definition at line 427 of file CreateUserRequest.h.

◆ PosixProfileHasBeenSet()

bool Aws::Transfer::Model::CreateUserRequest::PosixProfileHasBeenSet ( ) const
inline

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 EFS file systems. The POSIX permissions that are set on files and directories in Amazon EFS determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

Definition at line 556 of file CreateUserRequest.h.

◆ RoleHasBeenSet()

bool Aws::Transfer::Model::CreateUserRequest::RoleHasBeenSet ( ) const
inline

Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or 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 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.

Definition at line 619 of file CreateUserRequest.h.

◆ SerializePayload()

Aws::String Aws::Transfer::Model::CreateUserRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ ServerIdHasBeenSet()

bool Aws::Transfer::Model::CreateUserRequest::ServerIdHasBeenSet ( ) const
inline

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

Definition at line 698 of file CreateUserRequest.h.

◆ SetHomeDirectory() [1/3]

void Aws::Transfer::Model::CreateUserRequest::SetHomeDirectory ( Aws::String &&  value)
inline

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.

Definition at line 68 of file CreateUserRequest.h.

◆ SetHomeDirectory() [2/3]

void Aws::Transfer::Model::CreateUserRequest::SetHomeDirectory ( const Aws::String value)
inline

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.

Definition at line 61 of file CreateUserRequest.h.

◆ SetHomeDirectory() [3/3]

void Aws::Transfer::Model::CreateUserRequest::SetHomeDirectory ( const char *  value)
inline

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.

Definition at line 75 of file CreateUserRequest.h.

◆ SetHomeDirectoryMappings() [1/2]

void Aws::Transfer::Model::CreateUserRequest::SetHomeDirectoryMappings ( Aws::Vector< HomeDirectoryMapEntry > &&  value)
inline

Logical directory mappings that specify what Amazon S3 or EFS 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 or EFS path. If you only specify a target, it will be displayed as is. You will need to also make sure that your IAM role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]

In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("<code>chroot</code>"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry will be ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object –bucket bucketname –key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

Definition at line 274 of file CreateUserRequest.h.

◆ SetHomeDirectoryMappings() [2/2]

void Aws::Transfer::Model::CreateUserRequest::SetHomeDirectoryMappings ( const Aws::Vector< HomeDirectoryMapEntry > &  value)
inline

Logical directory mappings that specify what Amazon S3 or EFS 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 or EFS path. If you only specify a target, it will be displayed as is. You will need to also make sure that your IAM role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]

In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("<code>chroot</code>"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry will be ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object –bucket bucketname –key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

Definition at line 245 of file CreateUserRequest.h.

◆ SetHomeDirectoryType() [1/2]

void Aws::Transfer::Model::CreateUserRequest::SetHomeDirectoryType ( const HomeDirectoryType value)
inline

The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS 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 or EFS paths visible to your users.

Definition at line 127 of file CreateUserRequest.h.

◆ SetHomeDirectoryType() [2/2]

void Aws::Transfer::Model::CreateUserRequest::SetHomeDirectoryType ( HomeDirectoryType &&  value)
inline

The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS 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 or EFS paths visible to your users.

Definition at line 137 of file CreateUserRequest.h.

◆ SetPolicy() [1/3]

void Aws::Transfer::Model::CreateUserRequest::SetPolicy ( Aws::String &&  value)
inline

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

This only applies when domain of ServerId is S3. EFS does not use scope down policy.

For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a scope-down policy, see Example scope-down policy.

For more information, see AssumeRole in the AWS Security Token Service API Reference.

Definition at line 463 of file CreateUserRequest.h.

◆ SetPolicy() [2/3]

void Aws::Transfer::Model::CreateUserRequest::SetPolicy ( const Aws::String value)
inline

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

This only applies when domain of ServerId is S3. EFS does not use scope down policy.

For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a scope-down policy, see Example scope-down policy.

For more information, see AssumeRole in the AWS Security Token Service API Reference.

Definition at line 445 of file CreateUserRequest.h.

◆ SetPolicy() [3/3]

void Aws::Transfer::Model::CreateUserRequest::SetPolicy ( const char *  value)
inline

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

This only applies when domain of ServerId is S3. EFS does not use scope down policy.

For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a scope-down policy, see Example scope-down policy.

For more information, see AssumeRole in the AWS Security Token Service API Reference.

Definition at line 481 of file CreateUserRequest.h.

◆ SetPosixProfile() [1/2]

void Aws::Transfer::Model::CreateUserRequest::SetPosixProfile ( const PosixProfile value)
inline

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 EFS file systems. The POSIX permissions that are set on files and directories in Amazon EFS determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

Definition at line 566 of file CreateUserRequest.h.

◆ SetPosixProfile() [2/2]

void Aws::Transfer::Model::CreateUserRequest::SetPosixProfile ( PosixProfile &&  value)
inline

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 EFS file systems. The POSIX permissions that are set on files and directories in Amazon EFS determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

Definition at line 576 of file CreateUserRequest.h.

◆ SetRole() [1/3]

void Aws::Transfer::Model::CreateUserRequest::SetRole ( Aws::String &&  value)
inline

Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or 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 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.

Definition at line 641 of file CreateUserRequest.h.

◆ SetRole() [2/3]

void Aws::Transfer::Model::CreateUserRequest::SetRole ( const Aws::String value)
inline

Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or 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 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.

Definition at line 630 of file CreateUserRequest.h.

◆ SetRole() [3/3]

void Aws::Transfer::Model::CreateUserRequest::SetRole ( const char *  value)
inline

Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or 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 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.

Definition at line 652 of file CreateUserRequest.h.

◆ SetServerId() [1/3]

void Aws::Transfer::Model::CreateUserRequest::SetServerId ( Aws::String &&  value)
inline

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

Definition at line 710 of file CreateUserRequest.h.

◆ SetServerId() [2/3]

void Aws::Transfer::Model::CreateUserRequest::SetServerId ( const Aws::String value)
inline

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

Definition at line 704 of file CreateUserRequest.h.

◆ SetServerId() [3/3]

void Aws::Transfer::Model::CreateUserRequest::SetServerId ( const char *  value)
inline

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

Definition at line 716 of file CreateUserRequest.h.

◆ SetSshPublicKeyBody() [1/3]

void Aws::Transfer::Model::CreateUserRequest::SetSshPublicKeyBody ( Aws::String &&  value)
inline

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

Definition at line 759 of file CreateUserRequest.h.

◆ SetSshPublicKeyBody() [2/3]

void Aws::Transfer::Model::CreateUserRequest::SetSshPublicKeyBody ( const Aws::String value)
inline

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

Definition at line 753 of file CreateUserRequest.h.

◆ SetSshPublicKeyBody() [3/3]

void Aws::Transfer::Model::CreateUserRequest::SetSshPublicKeyBody ( const char *  value)
inline

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

Definition at line 765 of file CreateUserRequest.h.

◆ SetTags() [1/2]

void Aws::Transfer::Model::CreateUserRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

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

Definition at line 808 of file CreateUserRequest.h.

◆ SetTags() [2/2]

void Aws::Transfer::Model::CreateUserRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

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

Definition at line 802 of file CreateUserRequest.h.

◆ SetUserName() [1/3]

void Aws::Transfer::Model::CreateUserRequest::SetUserName ( Aws::String &&  value)
inline

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

Definition at line 869 of file CreateUserRequest.h.

◆ SetUserName() [2/3]

void Aws::Transfer::Model::CreateUserRequest::SetUserName ( const Aws::String value)
inline

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

Definition at line 860 of file CreateUserRequest.h.

◆ SetUserName() [3/3]

void Aws::Transfer::Model::CreateUserRequest::SetUserName ( const char *  value)
inline

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

Definition at line 878 of file CreateUserRequest.h.

◆ SshPublicKeyBodyHasBeenSet()

bool Aws::Transfer::Model::CreateUserRequest::SshPublicKeyBodyHasBeenSet ( ) const
inline

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

Definition at line 747 of file CreateUserRequest.h.

◆ TagsHasBeenSet()

bool Aws::Transfer::Model::CreateUserRequest::TagsHasBeenSet ( ) const
inline

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

Definition at line 796 of file CreateUserRequest.h.

◆ UserNameHasBeenSet()

bool Aws::Transfer::Model::CreateUserRequest::UserNameHasBeenSet ( ) const
inline

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

Definition at line 851 of file CreateUserRequest.h.

◆ WithHomeDirectory() [1/3]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithHomeDirectory ( Aws::String &&  value)
inline

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.

Definition at line 89 of file CreateUserRequest.h.

◆ WithHomeDirectory() [2/3]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithHomeDirectory ( const Aws::String value)
inline

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.

Definition at line 82 of file CreateUserRequest.h.

◆ WithHomeDirectory() [3/3]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithHomeDirectory ( const char *  value)
inline

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.

Definition at line 96 of file CreateUserRequest.h.

◆ WithHomeDirectoryMappings() [1/2]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithHomeDirectoryMappings ( Aws::Vector< HomeDirectoryMapEntry > &&  value)
inline

Logical directory mappings that specify what Amazon S3 or EFS 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 or EFS path. If you only specify a target, it will be displayed as is. You will need to also make sure that your IAM role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]

In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("<code>chroot</code>"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry will be ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object –bucket bucketname –key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

Definition at line 332 of file CreateUserRequest.h.

◆ WithHomeDirectoryMappings() [2/2]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithHomeDirectoryMappings ( const Aws::Vector< HomeDirectoryMapEntry > &  value)
inline

Logical directory mappings that specify what Amazon S3 or EFS 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 or EFS path. If you only specify a target, it will be displayed as is. You will need to also make sure that your IAM role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]

In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("<code>chroot</code>"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry will be ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object –bucket bucketname –key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

Definition at line 303 of file CreateUserRequest.h.

◆ WithHomeDirectoryType() [1/2]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithHomeDirectoryType ( const HomeDirectoryType value)
inline

The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS 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 or EFS paths visible to your users.

Definition at line 147 of file CreateUserRequest.h.

◆ WithHomeDirectoryType() [2/2]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithHomeDirectoryType ( HomeDirectoryType &&  value)
inline

The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS 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 or EFS paths visible to your users.

Definition at line 157 of file CreateUserRequest.h.

◆ WithPolicy() [1/3]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithPolicy ( Aws::String &&  value)
inline

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

This only applies when domain of ServerId is S3. EFS does not use scope down policy.

For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a scope-down policy, see Example scope-down policy.

For more information, see AssumeRole in the AWS Security Token Service API Reference.

Definition at line 517 of file CreateUserRequest.h.

◆ WithPolicy() [2/3]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithPolicy ( const Aws::String value)
inline

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

This only applies when domain of ServerId is S3. EFS does not use scope down policy.

For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a scope-down policy, see Example scope-down policy.

For more information, see AssumeRole in the AWS Security Token Service API Reference.

Definition at line 499 of file CreateUserRequest.h.

◆ WithPolicy() [3/3]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithPolicy ( const char *  value)
inline

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

This only applies when domain of ServerId is S3. EFS does not use scope down policy.

For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a scope-down policy, see Example scope-down policy.

For more information, see AssumeRole in the AWS Security Token Service API Reference.

Definition at line 535 of file CreateUserRequest.h.

◆ WithPosixProfile() [1/2]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithPosixProfile ( const PosixProfile value)
inline

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 EFS file systems. The POSIX permissions that are set on files and directories in Amazon EFS determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

Definition at line 586 of file CreateUserRequest.h.

◆ WithPosixProfile() [2/2]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithPosixProfile ( PosixProfile &&  value)
inline

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 EFS file systems. The POSIX permissions that are set on files and directories in Amazon EFS determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

Definition at line 596 of file CreateUserRequest.h.

◆ WithRole() [1/3]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithRole ( Aws::String &&  value)
inline

Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or 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 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.

Definition at line 674 of file CreateUserRequest.h.

◆ WithRole() [2/3]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithRole ( const Aws::String value)
inline

Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or 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 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.

Definition at line 663 of file CreateUserRequest.h.

◆ WithRole() [3/3]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithRole ( const char *  value)
inline

Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or 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 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.

Definition at line 685 of file CreateUserRequest.h.

◆ WithServerId() [1/3]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithServerId ( Aws::String &&  value)
inline

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

Definition at line 728 of file CreateUserRequest.h.

◆ WithServerId() [2/3]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithServerId ( const Aws::String value)
inline

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

Definition at line 722 of file CreateUserRequest.h.

◆ WithServerId() [3/3]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithServerId ( const char *  value)
inline

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

Definition at line 734 of file CreateUserRequest.h.

◆ WithSshPublicKeyBody() [1/3]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithSshPublicKeyBody ( Aws::String &&  value)
inline

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

Definition at line 777 of file CreateUserRequest.h.

◆ WithSshPublicKeyBody() [2/3]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithSshPublicKeyBody ( const Aws::String value)
inline

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

Definition at line 771 of file CreateUserRequest.h.

◆ WithSshPublicKeyBody() [3/3]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithSshPublicKeyBody ( const char *  value)
inline

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

Definition at line 783 of file CreateUserRequest.h.

◆ WithTags() [1/2]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

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

Definition at line 820 of file CreateUserRequest.h.

◆ WithTags() [2/2]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

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

Definition at line 814 of file CreateUserRequest.h.

◆ WithUserName() [1/3]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithUserName ( Aws::String &&  value)
inline

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

Definition at line 896 of file CreateUserRequest.h.

◆ WithUserName() [2/3]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithUserName ( const Aws::String value)
inline

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

Definition at line 887 of file CreateUserRequest.h.

◆ WithUserName() [3/3]

CreateUserRequest& Aws::Transfer::Model::CreateUserRequest::WithUserName ( const char *  value)
inline

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

Definition at line 905 of file CreateUserRequest.h.


The documentation for this class was generated from the following file: