This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-iam/include/aws/iam/model/CreateUserRequest.h

374 lines
18 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/iam/IAM_EXPORTS.h>
#include <aws/iam/IAMRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/core/utils/memory/stl/AWSVector.h>
#include <aws/iam/model/Tag.h>
#include <utility>
namespace Aws
{
namespace IAM
{
namespace Model
{
/**
*/
class AWS_IAM_API CreateUserRequest : public IAMRequest
{
public:
CreateUserRequest();
// Service request name is the Operation name which will send this request out,
// each operation should has unique request name, so that we can get operation's name from this request.
// Note: this is not true for response, multiple operations may have the same response name,
// so we can not get operation's name from response.
inline virtual const char* GetServiceRequestName() const override { return "CreateUser"; }
Aws::String SerializePayload() const override;
protected:
void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
public:
/**
* <p> The path for the user name. For more information about paths, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional.
* If it is not included, it defaults to a slash (/).</p> <p>This parameter allows
* (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a
* string of characters consisting of either a forward slash (/) by itself or a
* string that must begin and end with forward slashes. In addition, it can contain
* any ASCII character from the ! (<code>\u0021</code>) through the DEL character
* (<code>\u007F</code>), including most punctuation characters, digits, and upper
* and lowercased letters.</p>
*/
inline const Aws::String& GetPath() const{ return m_path; }
/**
* <p> The path for the user name. For more information about paths, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional.
* If it is not included, it defaults to a slash (/).</p> <p>This parameter allows
* (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a
* string of characters consisting of either a forward slash (/) by itself or a
* string that must begin and end with forward slashes. In addition, it can contain
* any ASCII character from the ! (<code>\u0021</code>) through the DEL character
* (<code>\u007F</code>), including most punctuation characters, digits, and upper
* and lowercased letters.</p>
*/
inline bool PathHasBeenSet() const { return m_pathHasBeenSet; }
/**
* <p> The path for the user name. For more information about paths, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional.
* If it is not included, it defaults to a slash (/).</p> <p>This parameter allows
* (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a
* string of characters consisting of either a forward slash (/) by itself or a
* string that must begin and end with forward slashes. In addition, it can contain
* any ASCII character from the ! (<code>\u0021</code>) through the DEL character
* (<code>\u007F</code>), including most punctuation characters, digits, and upper
* and lowercased letters.</p>
*/
inline void SetPath(const Aws::String& value) { m_pathHasBeenSet = true; m_path = value; }
/**
* <p> The path for the user name. For more information about paths, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional.
* If it is not included, it defaults to a slash (/).</p> <p>This parameter allows
* (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a
* string of characters consisting of either a forward slash (/) by itself or a
* string that must begin and end with forward slashes. In addition, it can contain
* any ASCII character from the ! (<code>\u0021</code>) through the DEL character
* (<code>\u007F</code>), including most punctuation characters, digits, and upper
* and lowercased letters.</p>
*/
inline void SetPath(Aws::String&& value) { m_pathHasBeenSet = true; m_path = std::move(value); }
/**
* <p> The path for the user name. For more information about paths, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional.
* If it is not included, it defaults to a slash (/).</p> <p>This parameter allows
* (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a
* string of characters consisting of either a forward slash (/) by itself or a
* string that must begin and end with forward slashes. In addition, it can contain
* any ASCII character from the ! (<code>\u0021</code>) through the DEL character
* (<code>\u007F</code>), including most punctuation characters, digits, and upper
* and lowercased letters.</p>
*/
inline void SetPath(const char* value) { m_pathHasBeenSet = true; m_path.assign(value); }
/**
* <p> The path for the user name. For more information about paths, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional.
* If it is not included, it defaults to a slash (/).</p> <p>This parameter allows
* (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a
* string of characters consisting of either a forward slash (/) by itself or a
* string that must begin and end with forward slashes. In addition, it can contain
* any ASCII character from the ! (<code>\u0021</code>) through the DEL character
* (<code>\u007F</code>), including most punctuation characters, digits, and upper
* and lowercased letters.</p>
*/
inline CreateUserRequest& WithPath(const Aws::String& value) { SetPath(value); return *this;}
/**
* <p> The path for the user name. For more information about paths, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional.
* If it is not included, it defaults to a slash (/).</p> <p>This parameter allows
* (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a
* string of characters consisting of either a forward slash (/) by itself or a
* string that must begin and end with forward slashes. In addition, it can contain
* any ASCII character from the ! (<code>\u0021</code>) through the DEL character
* (<code>\u007F</code>), including most punctuation characters, digits, and upper
* and lowercased letters.</p>
*/
inline CreateUserRequest& WithPath(Aws::String&& value) { SetPath(std::move(value)); return *this;}
/**
* <p> The path for the user name. For more information about paths, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">IAM
* Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional.
* If it is not included, it defaults to a slash (/).</p> <p>This parameter allows
* (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a
* string of characters consisting of either a forward slash (/) by itself or a
* string that must begin and end with forward slashes. In addition, it can contain
* any ASCII character from the ! (<code>\u0021</code>) through the DEL character
* (<code>\u007F</code>), including most punctuation characters, digits, and upper
* and lowercased letters.</p>
*/
inline CreateUserRequest& WithPath(const char* value) { SetPath(value); return *this;}
/**
* <p>The name of the user to create.</p> <p>IAM user, group, role, and policy
* names must be unique within the account. Names are not distinguished by case.
* For example, you cannot create resources named both "MyResource" and
* "myresource".</p>
*/
inline const Aws::String& GetUserName() const{ return m_userName; }
/**
* <p>The name of the user to create.</p> <p>IAM user, group, role, and policy
* names must be unique within the account. Names are not distinguished by case.
* For example, you cannot create resources named both "MyResource" and
* "myresource".</p>
*/
inline bool UserNameHasBeenSet() const { return m_userNameHasBeenSet; }
/**
* <p>The name of the user to create.</p> <p>IAM user, group, role, and policy
* names must be unique within the account. Names are not distinguished by case.
* For example, you cannot create resources named both "MyResource" and
* "myresource".</p>
*/
inline void SetUserName(const Aws::String& value) { m_userNameHasBeenSet = true; m_userName = value; }
/**
* <p>The name of the user to create.</p> <p>IAM user, group, role, and policy
* names must be unique within the account. Names are not distinguished by case.
* For example, you cannot create resources named both "MyResource" and
* "myresource".</p>
*/
inline void SetUserName(Aws::String&& value) { m_userNameHasBeenSet = true; m_userName = std::move(value); }
/**
* <p>The name of the user to create.</p> <p>IAM user, group, role, and policy
* names must be unique within the account. Names are not distinguished by case.
* For example, you cannot create resources named both "MyResource" and
* "myresource".</p>
*/
inline void SetUserName(const char* value) { m_userNameHasBeenSet = true; m_userName.assign(value); }
/**
* <p>The name of the user to create.</p> <p>IAM user, group, role, and policy
* names must be unique within the account. Names are not distinguished by case.
* For example, you cannot create resources named both "MyResource" and
* "myresource".</p>
*/
inline CreateUserRequest& WithUserName(const Aws::String& value) { SetUserName(value); return *this;}
/**
* <p>The name of the user to create.</p> <p>IAM user, group, role, and policy
* names must be unique within the account. Names are not distinguished by case.
* For example, you cannot create resources named both "MyResource" and
* "myresource".</p>
*/
inline CreateUserRequest& WithUserName(Aws::String&& value) { SetUserName(std::move(value)); return *this;}
/**
* <p>The name of the user to create.</p> <p>IAM user, group, role, and policy
* names must be unique within the account. Names are not distinguished by case.
* For example, you cannot create resources named both "MyResource" and
* "myresource".</p>
*/
inline CreateUserRequest& WithUserName(const char* value) { SetUserName(value); return *this;}
/**
* <p>The ARN of the policy that is used to set the permissions boundary for the
* user.</p>
*/
inline const Aws::String& GetPermissionsBoundary() const{ return m_permissionsBoundary; }
/**
* <p>The ARN of the policy that is used to set the permissions boundary for the
* user.</p>
*/
inline bool PermissionsBoundaryHasBeenSet() const { return m_permissionsBoundaryHasBeenSet; }
/**
* <p>The ARN of the policy that is used to set the permissions boundary for the
* user.</p>
*/
inline void SetPermissionsBoundary(const Aws::String& value) { m_permissionsBoundaryHasBeenSet = true; m_permissionsBoundary = value; }
/**
* <p>The ARN of the policy that is used to set the permissions boundary for the
* user.</p>
*/
inline void SetPermissionsBoundary(Aws::String&& value) { m_permissionsBoundaryHasBeenSet = true; m_permissionsBoundary = std::move(value); }
/**
* <p>The ARN of the policy that is used to set the permissions boundary for the
* user.</p>
*/
inline void SetPermissionsBoundary(const char* value) { m_permissionsBoundaryHasBeenSet = true; m_permissionsBoundary.assign(value); }
/**
* <p>The ARN of the policy that is used to set the permissions boundary for the
* user.</p>
*/
inline CreateUserRequest& WithPermissionsBoundary(const Aws::String& value) { SetPermissionsBoundary(value); return *this;}
/**
* <p>The ARN of the policy that is used to set the permissions boundary for the
* user.</p>
*/
inline CreateUserRequest& WithPermissionsBoundary(Aws::String&& value) { SetPermissionsBoundary(std::move(value)); return *this;}
/**
* <p>The ARN of the policy that is used to set the permissions boundary for the
* user.</p>
*/
inline CreateUserRequest& WithPermissionsBoundary(const char* value) { SetPermissionsBoundary(value); return *this;}
/**
* <p>A list of tags that you want to attach to the newly created user. Each tag
* consists of a key name and an associated value. For more information about
* tagging, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM
* Identities</a> in the <i>IAM User Guide</i>.</p> <p>If any one of the
* tags is invalid or if you exceed the allowed number of tags per user, then the
* entire request fails and the user is not created.</p>
*/
inline const Aws::Vector<Tag>& GetTags() const{ return m_tags; }
/**
* <p>A list of tags that you want to attach to the newly created user. Each tag
* consists of a key name and an associated value. For more information about
* tagging, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM
* Identities</a> in the <i>IAM User Guide</i>.</p> <p>If any one of the
* tags is invalid or if you exceed the allowed number of tags per user, then the
* entire request fails and the user is not created.</p>
*/
inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
/**
* <p>A list of tags that you want to attach to the newly created user. Each tag
* consists of a key name and an associated value. For more information about
* tagging, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM
* Identities</a> in the <i>IAM User Guide</i>.</p> <p>If any one of the
* tags is invalid or if you exceed the allowed number of tags per user, then the
* entire request fails and the user is not created.</p>
*/
inline void SetTags(const Aws::Vector<Tag>& value) { m_tagsHasBeenSet = true; m_tags = value; }
/**
* <p>A list of tags that you want to attach to the newly created user. Each tag
* consists of a key name and an associated value. For more information about
* tagging, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM
* Identities</a> in the <i>IAM User Guide</i>.</p> <p>If any one of the
* tags is invalid or if you exceed the allowed number of tags per user, then the
* entire request fails and the user is not created.</p>
*/
inline void SetTags(Aws::Vector<Tag>&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); }
/**
* <p>A list of tags that you want to attach to the newly created user. Each tag
* consists of a key name and an associated value. For more information about
* tagging, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM
* Identities</a> in the <i>IAM User Guide</i>.</p> <p>If any one of the
* tags is invalid or if you exceed the allowed number of tags per user, then the
* entire request fails and the user is not created.</p>
*/
inline CreateUserRequest& WithTags(const Aws::Vector<Tag>& value) { SetTags(value); return *this;}
/**
* <p>A list of tags that you want to attach to the newly created user. Each tag
* consists of a key name and an associated value. For more information about
* tagging, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM
* Identities</a> in the <i>IAM User Guide</i>.</p> <p>If any one of the
* tags is invalid or if you exceed the allowed number of tags per user, then the
* entire request fails and the user is not created.</p>
*/
inline CreateUserRequest& WithTags(Aws::Vector<Tag>&& value) { SetTags(std::move(value)); return *this;}
/**
* <p>A list of tags that you want to attach to the newly created user. Each tag
* consists of a key name and an associated value. For more information about
* tagging, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM
* Identities</a> in the <i>IAM User Guide</i>.</p> <p>If any one of the
* tags is invalid or if you exceed the allowed number of tags per user, then the
* entire request fails and the user is not created.</p>
*/
inline CreateUserRequest& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; }
/**
* <p>A list of tags that you want to attach to the newly created user. Each tag
* consists of a key name and an associated value. For more information about
* tagging, see <a
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html">Tagging IAM
* Identities</a> in the <i>IAM User Guide</i>.</p> <p>If any one of the
* tags is invalid or if you exceed the allowed number of tags per user, then the
* entire request fails and the user is not created.</p>
*/
inline CreateUserRequest& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; }
private:
Aws::String m_path;
bool m_pathHasBeenSet;
Aws::String m_userName;
bool m_userNameHasBeenSet;
Aws::String m_permissionsBoundary;
bool m_permissionsBoundaryHasBeenSet;
Aws::Vector<Tag> m_tags;
bool m_tagsHasBeenSet;
};
} // namespace Model
} // namespace IAM
} // namespace Aws