/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Transfer { namespace Model { /** *

Describes the properties of a user that was specified.

See * Also:

AWS * API Reference

*/ class AWS_TRANSFER_API DescribedUser { public: DescribedUser(); DescribedUser(Aws::Utils::Json::JsonView jsonValue); DescribedUser& operator=(Aws::Utils::Json::JsonView jsonValue); Aws::Utils::Json::JsonValue Jsonize() const; /** *

Specifies the unique Amazon Resource Name (ARN) for the user that was * requested to be described.

*/ inline const Aws::String& GetArn() const{ return m_arn; } /** *

Specifies the unique Amazon Resource Name (ARN) for the user that was * requested to be described.

*/ inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } /** *

Specifies the unique Amazon Resource Name (ARN) for the user that was * requested to be described.

*/ inline void SetArn(const Aws::String& value) { m_arnHasBeenSet = true; m_arn = value; } /** *

Specifies the unique Amazon Resource Name (ARN) for the user that was * requested to be described.

*/ inline void SetArn(Aws::String&& value) { m_arnHasBeenSet = true; m_arn = std::move(value); } /** *

Specifies the unique Amazon Resource Name (ARN) for the user that was * requested to be described.

*/ inline void SetArn(const char* value) { m_arnHasBeenSet = true; m_arn.assign(value); } /** *

Specifies the unique Amazon Resource Name (ARN) for the user that was * requested to be described.

*/ inline DescribedUser& WithArn(const Aws::String& value) { SetArn(value); return *this;} /** *

Specifies the unique Amazon Resource Name (ARN) for the user that was * requested to be described.

*/ inline DescribedUser& WithArn(Aws::String&& value) { SetArn(std::move(value)); return *this;} /** *

Specifies the unique Amazon Resource Name (ARN) for the user that was * requested to be described.

*/ inline DescribedUser& WithArn(const char* value) { SetArn(value); return *this;} /** *

Specifies the landing directory (or folder), which is the location that files * are written to or read from in an Amazon S3 bucket, for the described user. An * example is your-Amazon-S3-bucket-name>/home/username * .

*/ inline const Aws::String& GetHomeDirectory() const{ return m_homeDirectory; } /** *

Specifies the landing directory (or folder), which is the location that files * are written to or read from in an Amazon S3 bucket, for the described user. An * example is your-Amazon-S3-bucket-name>/home/username * .

*/ inline bool HomeDirectoryHasBeenSet() const { return m_homeDirectoryHasBeenSet; } /** *

Specifies the landing directory (or folder), which is the location that files * are written to or read from in an Amazon S3 bucket, for the described user. An * example is your-Amazon-S3-bucket-name>/home/username * .

*/ inline void SetHomeDirectory(const Aws::String& value) { m_homeDirectoryHasBeenSet = true; m_homeDirectory = value; } /** *

Specifies the landing directory (or folder), which is the location that files * are written to or read from in an Amazon S3 bucket, for the described user. An * example is your-Amazon-S3-bucket-name>/home/username * .

*/ inline void SetHomeDirectory(Aws::String&& value) { m_homeDirectoryHasBeenSet = true; m_homeDirectory = std::move(value); } /** *

Specifies the landing directory (or folder), which is the location that files * are written to or read from in an Amazon S3 bucket, for the described user. An * example is your-Amazon-S3-bucket-name>/home/username * .

*/ inline void SetHomeDirectory(const char* value) { m_homeDirectoryHasBeenSet = true; m_homeDirectory.assign(value); } /** *

Specifies the landing directory (or folder), which is the location that files * are written to or read from in an Amazon S3 bucket, for the described user. An * example is your-Amazon-S3-bucket-name>/home/username * .

*/ inline DescribedUser& WithHomeDirectory(const Aws::String& value) { SetHomeDirectory(value); return *this;} /** *

Specifies the landing directory (or folder), which is the location that files * are written to or read from in an Amazon S3 bucket, for the described user. An * example is your-Amazon-S3-bucket-name>/home/username * .

*/ inline DescribedUser& WithHomeDirectory(Aws::String&& value) { SetHomeDirectory(std::move(value)); return *this;} /** *

Specifies the landing directory (or folder), which is the location that files * are written to or read from in an Amazon S3 bucket, for the described user. An * example is your-Amazon-S3-bucket-name>/home/username * .

*/ inline DescribedUser& WithHomeDirectory(const char* value) { SetHomeDirectory(value); return *this;} /** *

Specifies the logical directory mappings that specify what Amazon S3 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 path. If you only specify a target, * it will be displayed as is. You will need to also make sure that your AWS * Identity and Access Management (IAM) role provides access to paths in * Target.

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

*/ inline const Aws::Vector& GetHomeDirectoryMappings() const{ return m_homeDirectoryMappings; } /** *

Specifies the logical directory mappings that specify what Amazon S3 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 path. If you only specify a target, * it will be displayed as is. You will need to also make sure that your AWS * Identity and Access Management (IAM) role provides access to paths in * Target.

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

*/ inline bool HomeDirectoryMappingsHasBeenSet() const { return m_homeDirectoryMappingsHasBeenSet; } /** *

Specifies the logical directory mappings that specify what Amazon S3 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 path. If you only specify a target, * it will be displayed as is. You will need to also make sure that your AWS * Identity and Access Management (IAM) role provides access to paths in * Target.

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

*/ inline void SetHomeDirectoryMappings(const Aws::Vector& value) { m_homeDirectoryMappingsHasBeenSet = true; m_homeDirectoryMappings = value; } /** *

Specifies the logical directory mappings that specify what Amazon S3 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 path. If you only specify a target, * it will be displayed as is. You will need to also make sure that your AWS * Identity and Access Management (IAM) role provides access to paths in * Target.

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

*/ inline void SetHomeDirectoryMappings(Aws::Vector&& value) { m_homeDirectoryMappingsHasBeenSet = true; m_homeDirectoryMappings = std::move(value); } /** *

Specifies the logical directory mappings that specify what Amazon S3 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 path. If you only specify a target, * it will be displayed as is. You will need to also make sure that your AWS * Identity and Access Management (IAM) role provides access to paths in * Target.

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

*/ inline DescribedUser& WithHomeDirectoryMappings(const Aws::Vector& value) { SetHomeDirectoryMappings(value); return *this;} /** *

Specifies the logical directory mappings that specify what Amazon S3 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 path. If you only specify a target, * it will be displayed as is. You will need to also make sure that your AWS * Identity and Access Management (IAM) role provides access to paths in * Target.

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

*/ inline DescribedUser& WithHomeDirectoryMappings(Aws::Vector&& value) { SetHomeDirectoryMappings(std::move(value)); return *this;} /** *

Specifies the logical directory mappings that specify what Amazon S3 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 path. If you only specify a target, * it will be displayed as is. You will need to also make sure that your AWS * Identity and Access Management (IAM) role provides access to paths in * Target.

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

*/ inline DescribedUser& AddHomeDirectoryMappings(const HomeDirectoryMapEntry& value) { m_homeDirectoryMappingsHasBeenSet = true; m_homeDirectoryMappings.push_back(value); return *this; } /** *

Specifies the logical directory mappings that specify what Amazon S3 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 path. If you only specify a target, * it will be displayed as is. You will need to also make sure that your AWS * Identity and Access Management (IAM) role provides access to paths in * Target.

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

*/ inline DescribedUser& AddHomeDirectoryMappings(HomeDirectoryMapEntry&& value) { m_homeDirectoryMappingsHasBeenSet = true; m_homeDirectoryMappings.push_back(std::move(value)); return *this; } /** *

Specifies the type of landing directory (folder) you mapped for your users to * see when they log into the file transfer protocol-enabled server. If you set it * to PATH, the user will see the absolute Amazon S3 bucket 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 paths visible to your users.

*/ inline const HomeDirectoryType& GetHomeDirectoryType() const{ return m_homeDirectoryType; } /** *

Specifies the type of landing directory (folder) you mapped for your users to * see when they log into the file transfer protocol-enabled server. If you set it * to PATH, the user will see the absolute Amazon S3 bucket 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 paths visible to your users.

*/ inline bool HomeDirectoryTypeHasBeenSet() const { return m_homeDirectoryTypeHasBeenSet; } /** *

Specifies the type of landing directory (folder) you mapped for your users to * see when they log into the file transfer protocol-enabled server. If you set it * to PATH, the user will see the absolute Amazon S3 bucket 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 paths visible to your users.

*/ inline void SetHomeDirectoryType(const HomeDirectoryType& value) { m_homeDirectoryTypeHasBeenSet = true; m_homeDirectoryType = value; } /** *

Specifies the type of landing directory (folder) you mapped for your users to * see when they log into the file transfer protocol-enabled server. If you set it * to PATH, the user will see the absolute Amazon S3 bucket 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 paths visible to your users.

*/ inline void SetHomeDirectoryType(HomeDirectoryType&& value) { m_homeDirectoryTypeHasBeenSet = true; m_homeDirectoryType = std::move(value); } /** *

Specifies the type of landing directory (folder) you mapped for your users to * see when they log into the file transfer protocol-enabled server. If you set it * to PATH, the user will see the absolute Amazon S3 bucket 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 paths visible to your users.

*/ inline DescribedUser& WithHomeDirectoryType(const HomeDirectoryType& value) { SetHomeDirectoryType(value); return *this;} /** *

Specifies the type of landing directory (folder) you mapped for your users to * see when they log into the file transfer protocol-enabled server. If you set it * to PATH, the user will see the absolute Amazon S3 bucket 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 paths visible to your users.

*/ inline DescribedUser& WithHomeDirectoryType(HomeDirectoryType&& value) { SetHomeDirectoryType(std::move(value)); return *this;} /** *

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

*/ inline const Aws::String& GetPolicy() const{ return m_policy; } /** *

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

*/ inline bool PolicyHasBeenSet() const { return m_policyHasBeenSet; } /** *

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

*/ inline void SetPolicy(const Aws::String& value) { m_policyHasBeenSet = true; m_policy = value; } /** *

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

*/ inline void SetPolicy(Aws::String&& value) { m_policyHasBeenSet = true; m_policy = std::move(value); } /** *

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

*/ inline void SetPolicy(const char* value) { m_policyHasBeenSet = true; m_policy.assign(value); } /** *

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

*/ inline DescribedUser& WithPolicy(const Aws::String& value) { SetPolicy(value); return *this;} /** *

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

*/ inline DescribedUser& WithPolicy(Aws::String&& value) { SetPolicy(std::move(value)); return *this;} /** *

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

*/ inline DescribedUser& WithPolicy(const char* value) { SetPolicy(value); return *this;} /** *

Specifies the IAM role that controls your users' 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 a file transfer protocol-enabled server to access your * resources when servicing your users' transfer requests.

*/ inline const Aws::String& GetRole() const{ return m_role; } /** *

Specifies the IAM role that controls your users' 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 a file transfer protocol-enabled server to access your * resources when servicing your users' transfer requests.

*/ inline bool RoleHasBeenSet() const { return m_roleHasBeenSet; } /** *

Specifies the IAM role that controls your users' 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 a file transfer protocol-enabled server to access your * resources when servicing your users' transfer requests.

*/ inline void SetRole(const Aws::String& value) { m_roleHasBeenSet = true; m_role = value; } /** *

Specifies the IAM role that controls your users' 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 a file transfer protocol-enabled server to access your * resources when servicing your users' transfer requests.

*/ inline void SetRole(Aws::String&& value) { m_roleHasBeenSet = true; m_role = std::move(value); } /** *

Specifies the IAM role that controls your users' 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 a file transfer protocol-enabled server to access your * resources when servicing your users' transfer requests.

*/ inline void SetRole(const char* value) { m_roleHasBeenSet = true; m_role.assign(value); } /** *

Specifies the IAM role that controls your users' 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 a file transfer protocol-enabled server to access your * resources when servicing your users' transfer requests.

*/ inline DescribedUser& WithRole(const Aws::String& value) { SetRole(value); return *this;} /** *

Specifies the IAM role that controls your users' 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 a file transfer protocol-enabled server to access your * resources when servicing your users' transfer requests.

*/ inline DescribedUser& WithRole(Aws::String&& value) { SetRole(std::move(value)); return *this;} /** *

Specifies the IAM role that controls your users' 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 a file transfer protocol-enabled server to access your * resources when servicing your users' transfer requests.

*/ inline DescribedUser& WithRole(const char* value) { SetRole(value); return *this;} /** *

Specifies the public key portion of the Secure Shell (SSH) keys stored for * the described user.

*/ inline const Aws::Vector& GetSshPublicKeys() const{ return m_sshPublicKeys; } /** *

Specifies the public key portion of the Secure Shell (SSH) keys stored for * the described user.

*/ inline bool SshPublicKeysHasBeenSet() const { return m_sshPublicKeysHasBeenSet; } /** *

Specifies the public key portion of the Secure Shell (SSH) keys stored for * the described user.

*/ inline void SetSshPublicKeys(const Aws::Vector& value) { m_sshPublicKeysHasBeenSet = true; m_sshPublicKeys = value; } /** *

Specifies the public key portion of the Secure Shell (SSH) keys stored for * the described user.

*/ inline void SetSshPublicKeys(Aws::Vector&& value) { m_sshPublicKeysHasBeenSet = true; m_sshPublicKeys = std::move(value); } /** *

Specifies the public key portion of the Secure Shell (SSH) keys stored for * the described user.

*/ inline DescribedUser& WithSshPublicKeys(const Aws::Vector& value) { SetSshPublicKeys(value); return *this;} /** *

Specifies the public key portion of the Secure Shell (SSH) keys stored for * the described user.

*/ inline DescribedUser& WithSshPublicKeys(Aws::Vector&& value) { SetSshPublicKeys(std::move(value)); return *this;} /** *

Specifies the public key portion of the Secure Shell (SSH) keys stored for * the described user.

*/ inline DescribedUser& AddSshPublicKeys(const SshPublicKey& value) { m_sshPublicKeysHasBeenSet = true; m_sshPublicKeys.push_back(value); return *this; } /** *

Specifies the public key portion of the Secure Shell (SSH) keys stored for * the described user.

*/ inline DescribedUser& AddSshPublicKeys(SshPublicKey&& value) { m_sshPublicKeysHasBeenSet = true; m_sshPublicKeys.push_back(std::move(value)); return *this; } /** *

Specifies the key-value pairs for the user requested. Tag can be used to * search for and group users for a variety of purposes.

*/ inline const Aws::Vector& GetTags() const{ return m_tags; } /** *

Specifies the key-value pairs for the user requested. Tag can be used to * search for and group users for a variety of purposes.

*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *

Specifies the key-value pairs for the user requested. Tag can be used to * search for and group users for a variety of purposes.

*/ inline void SetTags(const Aws::Vector& value) { m_tagsHasBeenSet = true; m_tags = value; } /** *

Specifies the key-value pairs for the user requested. Tag can be used to * search for and group users for a variety of purposes.

*/ inline void SetTags(Aws::Vector&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** *

Specifies the key-value pairs for the user requested. Tag can be used to * search for and group users for a variety of purposes.

*/ inline DescribedUser& WithTags(const Aws::Vector& value) { SetTags(value); return *this;} /** *

Specifies the key-value pairs for the user requested. Tag can be used to * search for and group users for a variety of purposes.

*/ inline DescribedUser& WithTags(Aws::Vector&& value) { SetTags(std::move(value)); return *this;} /** *

Specifies the key-value pairs for the user requested. Tag can be used to * search for and group users for a variety of purposes.

*/ inline DescribedUser& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; } /** *

Specifies the key-value pairs for the user requested. Tag can be used to * search for and group users for a variety of purposes.

*/ inline DescribedUser& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } /** *

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 file transfer protocol-enabled server.

*/ inline const Aws::String& GetUserName() const{ return m_userName; } /** *

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 file transfer protocol-enabled server.

*/ inline bool UserNameHasBeenSet() const { return m_userNameHasBeenSet; } /** *

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 file transfer protocol-enabled server.

*/ inline void SetUserName(const Aws::String& value) { m_userNameHasBeenSet = true; m_userName = value; } /** *

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 file transfer protocol-enabled server.

*/ inline void SetUserName(Aws::String&& value) { m_userNameHasBeenSet = true; m_userName = std::move(value); } /** *

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 file transfer protocol-enabled server.

*/ inline void SetUserName(const char* value) { m_userNameHasBeenSet = true; m_userName.assign(value); } /** *

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 file transfer protocol-enabled server.

*/ inline DescribedUser& WithUserName(const Aws::String& value) { SetUserName(value); return *this;} /** *

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 file transfer protocol-enabled server.

*/ inline DescribedUser& WithUserName(Aws::String&& value) { SetUserName(std::move(value)); return *this;} /** *

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 file transfer protocol-enabled server.

*/ inline DescribedUser& WithUserName(const char* value) { SetUserName(value); return *this;} private: Aws::String m_arn; bool m_arnHasBeenSet; Aws::String m_homeDirectory; bool m_homeDirectoryHasBeenSet; Aws::Vector m_homeDirectoryMappings; bool m_homeDirectoryMappingsHasBeenSet; HomeDirectoryType m_homeDirectoryType; bool m_homeDirectoryTypeHasBeenSet; Aws::String m_policy; bool m_policyHasBeenSet; Aws::String m_role; bool m_roleHasBeenSet; Aws::Vector m_sshPublicKeys; bool m_sshPublicKeysHasBeenSet; Aws::Vector m_tags; bool m_tagsHasBeenSet; Aws::String m_userName; bool m_userNameHasBeenSet; }; } // namespace Model } // namespace Transfer } // namespace Aws