/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Describes the properties of a user that was specified.See
* Also:
AWS
* API Reference
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
* .
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
* .
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
* .
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
* .
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
* .
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
* .
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
* .
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
* .
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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::VectorSpecifies 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::VectorSpecifies the public key portion of the Secure Shell (SSH) keys stored for * the described user.
*/ inline void SetSshPublicKeys(Aws::VectorSpecifies the public key portion of the Secure Shell (SSH) keys stored for * the described user.
*/ inline DescribedUser& WithSshPublicKeys(const Aws::VectorSpecifies the public key portion of the Secure Shell (SSH) keys stored for * the described user.
*/ inline DescribedUser& WithSshPublicKeys(Aws::VectorSpecifies 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::VectorSpecifies 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::VectorSpecifies 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::VectorSpecifies 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::VectorSpecifies 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::VectorSpecifies 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