/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include <aws/awstransfer/Transfer_EXPORTS.h> #include <aws/core/utils/memory/stl/AWSString.h> #include <aws/core/utils/memory/stl/AWSVector.h> #include <aws/awstransfer/model/HomeDirectoryType.h> #include <aws/awstransfer/model/PosixProfile.h> #include <aws/awstransfer/model/HomeDirectoryMapEntry.h> #include <aws/awstransfer/model/SshPublicKey.h> #include <aws/awstransfer/model/Tag.h> #include <utility> namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Transfer { namespace Model { /** * <p>Describes the properties of a user that was specified.</p><p><h3>See * Also:</h3> <a * href="http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribedUser">AWS * API Reference</a></p> */ class DescribedUser { public: AWS_TRANSFER_API DescribedUser(); AWS_TRANSFER_API DescribedUser(Aws::Utils::Json::JsonView jsonValue); AWS_TRANSFER_API DescribedUser& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_TRANSFER_API Aws::Utils::Json::JsonValue Jsonize() const; /** * <p>Specifies the unique Amazon Resource Name (ARN) for the user that was * requested to be described.</p> */ inline const Aws::String& GetArn() const{ return m_arn; } /** * <p>Specifies the unique Amazon Resource Name (ARN) for the user that was * requested to be described.</p> */ inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } /** * <p>Specifies the unique Amazon Resource Name (ARN) for the user that was * requested to be described.</p> */ inline void SetArn(const Aws::String& value) { m_arnHasBeenSet = true; m_arn = value; } /** * <p>Specifies the unique Amazon Resource Name (ARN) for the user that was * requested to be described.</p> */ inline void SetArn(Aws::String&& value) { m_arnHasBeenSet = true; m_arn = std::move(value); } /** * <p>Specifies the unique Amazon Resource Name (ARN) for the user that was * requested to be described.</p> */ inline void SetArn(const char* value) { m_arnHasBeenSet = true; m_arn.assign(value); } /** * <p>Specifies the unique Amazon Resource Name (ARN) for the user that was * requested to be described.</p> */ inline DescribedUser& WithArn(const Aws::String& value) { SetArn(value); return *this;} /** * <p>Specifies the unique Amazon Resource Name (ARN) for the user that was * requested to be described.</p> */ inline DescribedUser& WithArn(Aws::String&& value) { SetArn(std::move(value)); return *this;} /** * <p>Specifies the unique Amazon Resource Name (ARN) for the user that was * requested to be described.</p> */ inline DescribedUser& WithArn(const char* value) { SetArn(value); return *this;} /** * <p>The landing directory (folder) for a user when they log in to the server * using the client.</p> <p>A <code>HomeDirectory</code> example is * <code>/bucket_name/home/mydirectory</code>.</p> */ inline const Aws::String& GetHomeDirectory() const{ return m_homeDirectory; } /** * <p>The landing directory (folder) for a user when they log in to the server * using the client.</p> <p>A <code>HomeDirectory</code> example is * <code>/bucket_name/home/mydirectory</code>.</p> */ inline bool HomeDirectoryHasBeenSet() const { return m_homeDirectoryHasBeenSet; } /** * <p>The landing directory (folder) for a user when they log in to the server * using the client.</p> <p>A <code>HomeDirectory</code> example is * <code>/bucket_name/home/mydirectory</code>.</p> */ inline void SetHomeDirectory(const Aws::String& value) { m_homeDirectoryHasBeenSet = true; m_homeDirectory = value; } /** * <p>The landing directory (folder) for a user when they log in to the server * using the client.</p> <p>A <code>HomeDirectory</code> example is * <code>/bucket_name/home/mydirectory</code>.</p> */ inline void SetHomeDirectory(Aws::String&& value) { m_homeDirectoryHasBeenSet = true; m_homeDirectory = std::move(value); } /** * <p>The landing directory (folder) for a user when they log in to the server * using the client.</p> <p>A <code>HomeDirectory</code> example is * <code>/bucket_name/home/mydirectory</code>.</p> */ inline void SetHomeDirectory(const char* value) { m_homeDirectoryHasBeenSet = true; m_homeDirectory.assign(value); } /** * <p>The landing directory (folder) for a user when they log in to the server * using the client.</p> <p>A <code>HomeDirectory</code> example is * <code>/bucket_name/home/mydirectory</code>.</p> */ inline DescribedUser& WithHomeDirectory(const Aws::String& value) { SetHomeDirectory(value); return *this;} /** * <p>The landing directory (folder) for a user when they log in to the server * using the client.</p> <p>A <code>HomeDirectory</code> example is * <code>/bucket_name/home/mydirectory</code>.</p> */ inline DescribedUser& WithHomeDirectory(Aws::String&& value) { SetHomeDirectory(std::move(value)); return *this;} /** * <p>The landing directory (folder) for a user when they log in to the server * using the client.</p> <p>A <code>HomeDirectory</code> example is * <code>/bucket_name/home/mydirectory</code>.</p> */ inline DescribedUser& WithHomeDirectory(const char* value) { SetHomeDirectory(value); return *this;} /** * <p>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 <code>Entry</code> and <code>Target</code> pair, where * <code>Entry</code> shows how the path is made visible and <code>Target</code> 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 in <code>Target</code>. This value can be * set only when <code>HomeDirectoryType</code> is set to <i>LOGICAL</i>.</p> <p>In * most cases, you can use this value instead of the session policy to lock your * user down to the designated home directory ("<code>chroot</code>"). To do this, * you can set <code>Entry</code> to '/' and set <code>Target</code> to the * HomeDirectory parameter value.</p> */ inline const Aws::Vector<HomeDirectoryMapEntry>& GetHomeDirectoryMappings() const{ return m_homeDirectoryMappings; } /** * <p>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 <code>Entry</code> and <code>Target</code> pair, where * <code>Entry</code> shows how the path is made visible and <code>Target</code> 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 in <code>Target</code>. This value can be * set only when <code>HomeDirectoryType</code> is set to <i>LOGICAL</i>.</p> <p>In * most cases, you can use this value instead of the session policy to lock your * user down to the designated home directory ("<code>chroot</code>"). To do this, * you can set <code>Entry</code> to '/' and set <code>Target</code> to the * HomeDirectory parameter value.</p> */ inline bool HomeDirectoryMappingsHasBeenSet() const { return m_homeDirectoryMappingsHasBeenSet; } /** * <p>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 <code>Entry</code> and <code>Target</code> pair, where * <code>Entry</code> shows how the path is made visible and <code>Target</code> 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 in <code>Target</code>. This value can be * set only when <code>HomeDirectoryType</code> is set to <i>LOGICAL</i>.</p> <p>In * most cases, you can use this value instead of the session policy to lock your * user down to the designated home directory ("<code>chroot</code>"). To do this, * you can set <code>Entry</code> to '/' and set <code>Target</code> to the * HomeDirectory parameter value.</p> */ inline void SetHomeDirectoryMappings(const Aws::Vector<HomeDirectoryMapEntry>& value) { m_homeDirectoryMappingsHasBeenSet = true; m_homeDirectoryMappings = value; } /** * <p>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 <code>Entry</code> and <code>Target</code> pair, where * <code>Entry</code> shows how the path is made visible and <code>Target</code> 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 in <code>Target</code>. This value can be * set only when <code>HomeDirectoryType</code> is set to <i>LOGICAL</i>.</p> <p>In * most cases, you can use this value instead of the session policy to lock your * user down to the designated home directory ("<code>chroot</code>"). To do this, * you can set <code>Entry</code> to '/' and set <code>Target</code> to the * HomeDirectory parameter value.</p> */ inline void SetHomeDirectoryMappings(Aws::Vector<HomeDirectoryMapEntry>&& value) { m_homeDirectoryMappingsHasBeenSet = true; m_homeDirectoryMappings = std::move(value); } /** * <p>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 <code>Entry</code> and <code>Target</code> pair, where * <code>Entry</code> shows how the path is made visible and <code>Target</code> 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 in <code>Target</code>. This value can be * set only when <code>HomeDirectoryType</code> is set to <i>LOGICAL</i>.</p> <p>In * most cases, you can use this value instead of the session policy to lock your * user down to the designated home directory ("<code>chroot</code>"). To do this, * you can set <code>Entry</code> to '/' and set <code>Target</code> to the * HomeDirectory parameter value.</p> */ inline DescribedUser& WithHomeDirectoryMappings(const Aws::Vector<HomeDirectoryMapEntry>& value) { SetHomeDirectoryMappings(value); return *this;} /** * <p>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 <code>Entry</code> and <code>Target</code> pair, where * <code>Entry</code> shows how the path is made visible and <code>Target</code> 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 in <code>Target</code>. This value can be * set only when <code>HomeDirectoryType</code> is set to <i>LOGICAL</i>.</p> <p>In * most cases, you can use this value instead of the session policy to lock your * user down to the designated home directory ("<code>chroot</code>"). To do this, * you can set <code>Entry</code> to '/' and set <code>Target</code> to the * HomeDirectory parameter value.</p> */ inline DescribedUser& WithHomeDirectoryMappings(Aws::Vector<HomeDirectoryMapEntry>&& value) { SetHomeDirectoryMappings(std::move(value)); return *this;} /** * <p>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 <code>Entry</code> and <code>Target</code> pair, where * <code>Entry</code> shows how the path is made visible and <code>Target</code> 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 in <code>Target</code>. This value can be * set only when <code>HomeDirectoryType</code> is set to <i>LOGICAL</i>.</p> <p>In * most cases, you can use this value instead of the session policy to lock your * user down to the designated home directory ("<code>chroot</code>"). To do this, * you can set <code>Entry</code> to '/' and set <code>Target</code> to the * HomeDirectory parameter value.</p> */ inline DescribedUser& AddHomeDirectoryMappings(const HomeDirectoryMapEntry& value) { m_homeDirectoryMappingsHasBeenSet = true; m_homeDirectoryMappings.push_back(value); return *this; } /** * <p>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 <code>Entry</code> and <code>Target</code> pair, where * <code>Entry</code> shows how the path is made visible and <code>Target</code> 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 in <code>Target</code>. This value can be * set only when <code>HomeDirectoryType</code> is set to <i>LOGICAL</i>.</p> <p>In * most cases, you can use this value instead of the session policy to lock your * user down to the designated home directory ("<code>chroot</code>"). To do this, * you can set <code>Entry</code> to '/' and set <code>Target</code> to the * HomeDirectory parameter value.</p> */ inline DescribedUser& AddHomeDirectoryMappings(HomeDirectoryMapEntry&& value) { m_homeDirectoryMappingsHasBeenSet = true; m_homeDirectoryMappings.push_back(std::move(value)); return *this; } /** * <p>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 * <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths * as is in their file transfer protocol clients. If you set it * <code>LOGICAL</code>, you need to provide mappings in the * <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon * EFS paths visible to your users.</p> */ inline const HomeDirectoryType& GetHomeDirectoryType() const{ return m_homeDirectoryType; } /** * <p>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 * <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths * as is in their file transfer protocol clients. If you set it * <code>LOGICAL</code>, you need to provide mappings in the * <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon * EFS paths visible to your users.</p> */ inline bool HomeDirectoryTypeHasBeenSet() const { return m_homeDirectoryTypeHasBeenSet; } /** * <p>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 * <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths * as is in their file transfer protocol clients. If you set it * <code>LOGICAL</code>, you need to provide mappings in the * <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon * EFS paths visible to your users.</p> */ inline void SetHomeDirectoryType(const HomeDirectoryType& value) { m_homeDirectoryTypeHasBeenSet = true; m_homeDirectoryType = value; } /** * <p>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 * <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths * as is in their file transfer protocol clients. If you set it * <code>LOGICAL</code>, you need to provide mappings in the * <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon * EFS paths visible to your users.</p> */ inline void SetHomeDirectoryType(HomeDirectoryType&& value) { m_homeDirectoryTypeHasBeenSet = true; m_homeDirectoryType = std::move(value); } /** * <p>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 * <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths * as is in their file transfer protocol clients. If you set it * <code>LOGICAL</code>, you need to provide mappings in the * <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon * EFS paths visible to your users.</p> */ inline DescribedUser& WithHomeDirectoryType(const HomeDirectoryType& value) { SetHomeDirectoryType(value); return *this;} /** * <p>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 * <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths * as is in their file transfer protocol clients. If you set it * <code>LOGICAL</code>, you need to provide mappings in the * <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon * EFS paths visible to your users.</p> */ inline DescribedUser& WithHomeDirectoryType(HomeDirectoryType&& value) { SetHomeDirectoryType(std::move(value)); return *this;} /** * <p>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 <code>${Transfer:UserName}</code>, * <code>${Transfer:HomeDirectory}</code>, and * <code>${Transfer:HomeBucket}</code>.</p> */ inline const Aws::String& GetPolicy() const{ return m_policy; } /** * <p>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 <code>${Transfer:UserName}</code>, * <code>${Transfer:HomeDirectory}</code>, and * <code>${Transfer:HomeBucket}</code>.</p> */ inline bool PolicyHasBeenSet() const { return m_policyHasBeenSet; } /** * <p>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 <code>${Transfer:UserName}</code>, * <code>${Transfer:HomeDirectory}</code>, and * <code>${Transfer:HomeBucket}</code>.</p> */ inline void SetPolicy(const Aws::String& value) { m_policyHasBeenSet = true; m_policy = value; } /** * <p>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 <code>${Transfer:UserName}</code>, * <code>${Transfer:HomeDirectory}</code>, and * <code>${Transfer:HomeBucket}</code>.</p> */ inline void SetPolicy(Aws::String&& value) { m_policyHasBeenSet = true; m_policy = std::move(value); } /** * <p>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 <code>${Transfer:UserName}</code>, * <code>${Transfer:HomeDirectory}</code>, and * <code>${Transfer:HomeBucket}</code>.</p> */ inline void SetPolicy(const char* value) { m_policyHasBeenSet = true; m_policy.assign(value); } /** * <p>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 <code>${Transfer:UserName}</code>, * <code>${Transfer:HomeDirectory}</code>, and * <code>${Transfer:HomeBucket}</code>.</p> */ inline DescribedUser& WithPolicy(const Aws::String& value) { SetPolicy(value); return *this;} /** * <p>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 <code>${Transfer:UserName}</code>, * <code>${Transfer:HomeDirectory}</code>, and * <code>${Transfer:HomeBucket}</code>.</p> */ inline DescribedUser& WithPolicy(Aws::String&& value) { SetPolicy(std::move(value)); return *this;} /** * <p>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 <code>${Transfer:UserName}</code>, * <code>${Transfer:HomeDirectory}</code>, and * <code>${Transfer:HomeBucket}</code>.</p> */ inline DescribedUser& WithPolicy(const char* value) { SetPolicy(value); return *this;} /** * <p>Specifies the full POSIX identity, including user ID (<code>Uid</code>), * group ID (<code>Gid</code>), and any secondary groups IDs * (<code>SecondaryGids</code>), 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.</p> */ inline const PosixProfile& GetPosixProfile() const{ return m_posixProfile; } /** * <p>Specifies the full POSIX identity, including user ID (<code>Uid</code>), * group ID (<code>Gid</code>), and any secondary groups IDs * (<code>SecondaryGids</code>), 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.</p> */ inline bool PosixProfileHasBeenSet() const { return m_posixProfileHasBeenSet; } /** * <p>Specifies the full POSIX identity, including user ID (<code>Uid</code>), * group ID (<code>Gid</code>), and any secondary groups IDs * (<code>SecondaryGids</code>), 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.</p> */ inline void SetPosixProfile(const PosixProfile& value) { m_posixProfileHasBeenSet = true; m_posixProfile = value; } /** * <p>Specifies the full POSIX identity, including user ID (<code>Uid</code>), * group ID (<code>Gid</code>), and any secondary groups IDs * (<code>SecondaryGids</code>), 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.</p> */ inline void SetPosixProfile(PosixProfile&& value) { m_posixProfileHasBeenSet = true; m_posixProfile = std::move(value); } /** * <p>Specifies the full POSIX identity, including user ID (<code>Uid</code>), * group ID (<code>Gid</code>), and any secondary groups IDs * (<code>SecondaryGids</code>), 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.</p> */ inline DescribedUser& WithPosixProfile(const PosixProfile& value) { SetPosixProfile(value); return *this;} /** * <p>Specifies the full POSIX identity, including user ID (<code>Uid</code>), * group ID (<code>Gid</code>), and any secondary groups IDs * (<code>SecondaryGids</code>), 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.</p> */ inline DescribedUser& WithPosixProfile(PosixProfile&& value) { SetPosixProfile(std::move(value)); return *this;} /** * <p>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.</p> */ inline const Aws::String& GetRole() const{ return m_role; } /** * <p>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.</p> */ inline bool RoleHasBeenSet() const { return m_roleHasBeenSet; } /** * <p>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.</p> */ inline void SetRole(const Aws::String& value) { m_roleHasBeenSet = true; m_role = value; } /** * <p>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.</p> */ inline void SetRole(Aws::String&& value) { m_roleHasBeenSet = true; m_role = std::move(value); } /** * <p>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.</p> */ inline void SetRole(const char* value) { m_roleHasBeenSet = true; m_role.assign(value); } /** * <p>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.</p> */ inline DescribedUser& WithRole(const Aws::String& value) { SetRole(value); return *this;} /** * <p>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.</p> */ inline DescribedUser& WithRole(Aws::String&& value) { SetRole(std::move(value)); return *this;} /** * <p>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.</p> */ inline DescribedUser& WithRole(const char* value) { SetRole(value); return *this;} /** * <p>Specifies the public key portion of the Secure Shell (SSH) keys stored for * the described user.</p> */ inline const Aws::Vector<SshPublicKey>& GetSshPublicKeys() const{ return m_sshPublicKeys; } /** * <p>Specifies the public key portion of the Secure Shell (SSH) keys stored for * the described user.</p> */ inline bool SshPublicKeysHasBeenSet() const { return m_sshPublicKeysHasBeenSet; } /** * <p>Specifies the public key portion of the Secure Shell (SSH) keys stored for * the described user.</p> */ inline void SetSshPublicKeys(const Aws::Vector<SshPublicKey>& value) { m_sshPublicKeysHasBeenSet = true; m_sshPublicKeys = value; } /** * <p>Specifies the public key portion of the Secure Shell (SSH) keys stored for * the described user.</p> */ inline void SetSshPublicKeys(Aws::Vector<SshPublicKey>&& value) { m_sshPublicKeysHasBeenSet = true; m_sshPublicKeys = std::move(value); } /** * <p>Specifies the public key portion of the Secure Shell (SSH) keys stored for * the described user.</p> */ inline DescribedUser& WithSshPublicKeys(const Aws::Vector<SshPublicKey>& value) { SetSshPublicKeys(value); return *this;} /** * <p>Specifies the public key portion of the Secure Shell (SSH) keys stored for * the described user.</p> */ inline DescribedUser& WithSshPublicKeys(Aws::Vector<SshPublicKey>&& value) { SetSshPublicKeys(std::move(value)); return *this;} /** * <p>Specifies the public key portion of the Secure Shell (SSH) keys stored for * the described user.</p> */ inline DescribedUser& AddSshPublicKeys(const SshPublicKey& value) { m_sshPublicKeysHasBeenSet = true; m_sshPublicKeys.push_back(value); return *this; } /** * <p>Specifies the public key portion of the Secure Shell (SSH) keys stored for * the described user.</p> */ inline DescribedUser& AddSshPublicKeys(SshPublicKey&& value) { m_sshPublicKeysHasBeenSet = true; m_sshPublicKeys.push_back(std::move(value)); return *this; } /** * <p>Specifies the key-value pairs for the user requested. Tag can be used to * search for and group users for a variety of purposes.</p> */ inline const Aws::Vector<Tag>& GetTags() const{ return m_tags; } /** * <p>Specifies the key-value pairs for the user requested. Tag can be used to * search for and group users for a variety of purposes.</p> */ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** * <p>Specifies the key-value pairs for the user requested. Tag can be used to * search for and group users for a variety of purposes.</p> */ inline void SetTags(const Aws::Vector<Tag>& value) { m_tagsHasBeenSet = true; m_tags = value; } /** * <p>Specifies the key-value pairs for the user requested. Tag can be used to * search for and group users for a variety of purposes.</p> */ inline void SetTags(Aws::Vector<Tag>&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** * <p>Specifies the key-value pairs for the user requested. Tag can be used to * search for and group users for a variety of purposes.</p> */ inline DescribedUser& WithTags(const Aws::Vector<Tag>& value) { SetTags(value); return *this;} /** * <p>Specifies the key-value pairs for the user requested. Tag can be used to * search for and group users for a variety of purposes.</p> */ inline DescribedUser& WithTags(Aws::Vector<Tag>&& value) { SetTags(std::move(value)); return *this;} /** * <p>Specifies the key-value pairs for the user requested. Tag can be used to * search for and group users for a variety of purposes.</p> */ inline DescribedUser& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; } /** * <p>Specifies the key-value pairs for the user requested. Tag can be used to * search for and group users for a variety of purposes.</p> */ inline DescribedUser& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } /** * <p>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.</p> */ inline const Aws::String& GetUserName() const{ return m_userName; } /** * <p>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.</p> */ inline bool UserNameHasBeenSet() const { return m_userNameHasBeenSet; } /** * <p>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.</p> */ inline void SetUserName(const Aws::String& value) { m_userNameHasBeenSet = true; m_userName = value; } /** * <p>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.</p> */ inline void SetUserName(Aws::String&& value) { m_userNameHasBeenSet = true; m_userName = std::move(value); } /** * <p>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.</p> */ inline void SetUserName(const char* value) { m_userNameHasBeenSet = true; m_userName.assign(value); } /** * <p>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.</p> */ inline DescribedUser& WithUserName(const Aws::String& value) { SetUserName(value); return *this;} /** * <p>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.</p> */ inline DescribedUser& WithUserName(Aws::String&& value) { SetUserName(std::move(value)); return *this;} /** * <p>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.</p> */ inline DescribedUser& WithUserName(const char* value) { SetUserName(value); return *this;} private: Aws::String m_arn; bool m_arnHasBeenSet = false; Aws::String m_homeDirectory; bool m_homeDirectoryHasBeenSet = false; Aws::Vector<HomeDirectoryMapEntry> m_homeDirectoryMappings; bool m_homeDirectoryMappingsHasBeenSet = false; HomeDirectoryType m_homeDirectoryType; bool m_homeDirectoryTypeHasBeenSet = false; Aws::String m_policy; bool m_policyHasBeenSet = false; PosixProfile m_posixProfile; bool m_posixProfileHasBeenSet = false; Aws::String m_role; bool m_roleHasBeenSet = false; Aws::Vector<SshPublicKey> m_sshPublicKeys; bool m_sshPublicKeysHasBeenSet = false; Aws::Vector<Tag> m_tags; bool m_tagsHasBeenSet = false; Aws::String m_userName; bool m_userNameHasBeenSet = false; }; } // namespace Model } // namespace Transfer } // namespace Aws