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

The details of the user account.

See Also:

AWS API * Reference

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

The unique identifier for the user.

*/ inline const Aws::String& GetUserId() const{ return m_userId; } /** *

The unique identifier for the user.

*/ inline bool UserIdHasBeenSet() const { return m_userIdHasBeenSet; } /** *

The unique identifier for the user.

*/ inline void SetUserId(const Aws::String& value) { m_userIdHasBeenSet = true; m_userId = value; } /** *

The unique identifier for the user.

*/ inline void SetUserId(Aws::String&& value) { m_userIdHasBeenSet = true; m_userId = std::move(value); } /** *

The unique identifier for the user.

*/ inline void SetUserId(const char* value) { m_userIdHasBeenSet = true; m_userId.assign(value); } /** *

The unique identifier for the user.

*/ inline User& WithUserId(const Aws::String& value) { SetUserId(value); return *this;} /** *

The unique identifier for the user.

*/ inline User& WithUserId(Aws::String&& value) { SetUserId(std::move(value)); return *this;} /** *

The unique identifier for the user.

*/ inline User& WithUserId(const char* value) { SetUserId(value); return *this;} /** *

The current status of the user account.

  • * CREATING – The user account creation is in progress.

  • *

    ENABLED – The user account is created and is currently * active.

  • DISABLED – The user account is currently * inactive.

*/ inline const UserStatus& GetStatus() const{ return m_status; } /** *

The current status of the user account.

  • * CREATING – The user account creation is in progress.

  • *

    ENABLED – The user account is created and is currently * active.

  • DISABLED – The user account is currently * inactive.

*/ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *

The current status of the user account.

  • * CREATING – The user account creation is in progress.

  • *

    ENABLED – The user account is created and is currently * active.

  • DISABLED – The user account is currently * inactive.

*/ inline void SetStatus(const UserStatus& value) { m_statusHasBeenSet = true; m_status = value; } /** *

The current status of the user account.

  • * CREATING – The user account creation is in progress.

  • *

    ENABLED – The user account is created and is currently * active.

  • DISABLED – The user account is currently * inactive.

*/ inline void SetStatus(UserStatus&& value) { m_statusHasBeenSet = true; m_status = std::move(value); } /** *

The current status of the user account.

  • * CREATING – The user account creation is in progress.

  • *

    ENABLED – The user account is created and is currently * active.

  • DISABLED – The user account is currently * inactive.

*/ inline User& WithStatus(const UserStatus& value) { SetStatus(value); return *this;} /** *

The current status of the user account.

  • * CREATING – The user account creation is in progress.

  • *

    ENABLED – The user account is created and is currently * active.

  • DISABLED – The user account is currently * inactive.

*/ inline User& WithStatus(UserStatus&& value) { SetStatus(std::move(value)); return *this;} /** *

The first name of the user.

*/ inline const Aws::String& GetFirstName() const{ return m_firstName; } /** *

The first name of the user.

*/ inline bool FirstNameHasBeenSet() const { return m_firstNameHasBeenSet; } /** *

The first name of the user.

*/ inline void SetFirstName(const Aws::String& value) { m_firstNameHasBeenSet = true; m_firstName = value; } /** *

The first name of the user.

*/ inline void SetFirstName(Aws::String&& value) { m_firstNameHasBeenSet = true; m_firstName = std::move(value); } /** *

The first name of the user.

*/ inline void SetFirstName(const char* value) { m_firstNameHasBeenSet = true; m_firstName.assign(value); } /** *

The first name of the user.

*/ inline User& WithFirstName(const Aws::String& value) { SetFirstName(value); return *this;} /** *

The first name of the user.

*/ inline User& WithFirstName(Aws::String&& value) { SetFirstName(std::move(value)); return *this;} /** *

The first name of the user.

*/ inline User& WithFirstName(const char* value) { SetFirstName(value); return *this;} /** *

The last name of the user.

*/ inline const Aws::String& GetLastName() const{ return m_lastName; } /** *

The last name of the user.

*/ inline bool LastNameHasBeenSet() const { return m_lastNameHasBeenSet; } /** *

The last name of the user.

*/ inline void SetLastName(const Aws::String& value) { m_lastNameHasBeenSet = true; m_lastName = value; } /** *

The last name of the user.

*/ inline void SetLastName(Aws::String&& value) { m_lastNameHasBeenSet = true; m_lastName = std::move(value); } /** *

The last name of the user.

*/ inline void SetLastName(const char* value) { m_lastNameHasBeenSet = true; m_lastName.assign(value); } /** *

The last name of the user.

*/ inline User& WithLastName(const Aws::String& value) { SetLastName(value); return *this;} /** *

The last name of the user.

*/ inline User& WithLastName(Aws::String&& value) { SetLastName(std::move(value)); return *this;} /** *

The last name of the user.

*/ inline User& WithLastName(const char* value) { SetLastName(value); return *this;} /** *

The email address of the user. The email address serves as a uniquer * identifier for each user and cannot be changed after it's created.

*/ inline const Aws::String& GetEmailAddress() const{ return m_emailAddress; } /** *

The email address of the user. The email address serves as a uniquer * identifier for each user and cannot be changed after it's created.

*/ inline bool EmailAddressHasBeenSet() const { return m_emailAddressHasBeenSet; } /** *

The email address of the user. The email address serves as a uniquer * identifier for each user and cannot be changed after it's created.

*/ inline void SetEmailAddress(const Aws::String& value) { m_emailAddressHasBeenSet = true; m_emailAddress = value; } /** *

The email address of the user. The email address serves as a uniquer * identifier for each user and cannot be changed after it's created.

*/ inline void SetEmailAddress(Aws::String&& value) { m_emailAddressHasBeenSet = true; m_emailAddress = std::move(value); } /** *

The email address of the user. The email address serves as a uniquer * identifier for each user and cannot be changed after it's created.

*/ inline void SetEmailAddress(const char* value) { m_emailAddressHasBeenSet = true; m_emailAddress.assign(value); } /** *

The email address of the user. The email address serves as a uniquer * identifier for each user and cannot be changed after it's created.

*/ inline User& WithEmailAddress(const Aws::String& value) { SetEmailAddress(value); return *this;} /** *

The email address of the user. The email address serves as a uniquer * identifier for each user and cannot be changed after it's created.

*/ inline User& WithEmailAddress(Aws::String&& value) { SetEmailAddress(std::move(value)); return *this;} /** *

The email address of the user. The email address serves as a uniquer * identifier for each user and cannot be changed after it's created.

*/ inline User& WithEmailAddress(const char* value) { SetEmailAddress(value); return *this;} /** *

Indicates the type of user.

  • SUPER_USER – A * user with permission to all the functionality and data in FinSpace.

    • *

  • APP_USER – A user with specific permissions in FinSpace. * The users are assigned permissions by adding them to a permission group.

    *
*/ inline const UserType& GetType() const{ return m_type; } /** *

Indicates the type of user.

  • SUPER_USER – A * user with permission to all the functionality and data in FinSpace.

    • *

  • APP_USER – A user with specific permissions in FinSpace. * The users are assigned permissions by adding them to a permission group.

    *
*/ inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; } /** *

Indicates the type of user.

  • SUPER_USER – A * user with permission to all the functionality and data in FinSpace.

    • *

  • APP_USER – A user with specific permissions in FinSpace. * The users are assigned permissions by adding them to a permission group.

    *
*/ inline void SetType(const UserType& value) { m_typeHasBeenSet = true; m_type = value; } /** *

Indicates the type of user.

  • SUPER_USER – A * user with permission to all the functionality and data in FinSpace.

    • *

  • APP_USER – A user with specific permissions in FinSpace. * The users are assigned permissions by adding them to a permission group.

    *
*/ inline void SetType(UserType&& value) { m_typeHasBeenSet = true; m_type = std::move(value); } /** *

Indicates the type of user.

  • SUPER_USER – A * user with permission to all the functionality and data in FinSpace.

    • *

  • APP_USER – A user with specific permissions in FinSpace. * The users are assigned permissions by adding them to a permission group.

    *
*/ inline User& WithType(const UserType& value) { SetType(value); return *this;} /** *

Indicates the type of user.

  • SUPER_USER – A * user with permission to all the functionality and data in FinSpace.

    • *

  • APP_USER – A user with specific permissions in FinSpace. * The users are assigned permissions by adding them to a permission group.

    *
*/ inline User& WithType(UserType&& value) { SetType(std::move(value)); return *this;} /** *

Indicates whether the user can use the * GetProgrammaticAccessCredentials API to obtain credentials that can * then be used to access other FinSpace Data API operations.

  • * ENABLED – The user has permissions to use the APIs.

  • *

    DISABLED – The user does not have permissions to use any * APIs.

*/ inline const ApiAccess& GetApiAccess() const{ return m_apiAccess; } /** *

Indicates whether the user can use the * GetProgrammaticAccessCredentials API to obtain credentials that can * then be used to access other FinSpace Data API operations.

  • * ENABLED – The user has permissions to use the APIs.

  • *

    DISABLED – The user does not have permissions to use any * APIs.

*/ inline bool ApiAccessHasBeenSet() const { return m_apiAccessHasBeenSet; } /** *

Indicates whether the user can use the * GetProgrammaticAccessCredentials API to obtain credentials that can * then be used to access other FinSpace Data API operations.

  • * ENABLED – The user has permissions to use the APIs.

  • *

    DISABLED – The user does not have permissions to use any * APIs.

*/ inline void SetApiAccess(const ApiAccess& value) { m_apiAccessHasBeenSet = true; m_apiAccess = value; } /** *

Indicates whether the user can use the * GetProgrammaticAccessCredentials API to obtain credentials that can * then be used to access other FinSpace Data API operations.

  • * ENABLED – The user has permissions to use the APIs.

  • *

    DISABLED – The user does not have permissions to use any * APIs.

*/ inline void SetApiAccess(ApiAccess&& value) { m_apiAccessHasBeenSet = true; m_apiAccess = std::move(value); } /** *

Indicates whether the user can use the * GetProgrammaticAccessCredentials API to obtain credentials that can * then be used to access other FinSpace Data API operations.

  • * ENABLED – The user has permissions to use the APIs.

  • *

    DISABLED – The user does not have permissions to use any * APIs.

*/ inline User& WithApiAccess(const ApiAccess& value) { SetApiAccess(value); return *this;} /** *

Indicates whether the user can use the * GetProgrammaticAccessCredentials API to obtain credentials that can * then be used to access other FinSpace Data API operations.

  • * ENABLED – The user has permissions to use the APIs.

  • *

    DISABLED – The user does not have permissions to use any * APIs.

*/ inline User& WithApiAccess(ApiAccess&& value) { SetApiAccess(std::move(value)); return *this;} /** *

The ARN identifier of an AWS user or role that is allowed to call the * GetProgrammaticAccessCredentials API to obtain a credentials token * for a specific FinSpace user. This must be an IAM role within your FinSpace * account.

*/ inline const Aws::String& GetApiAccessPrincipalArn() const{ return m_apiAccessPrincipalArn; } /** *

The ARN identifier of an AWS user or role that is allowed to call the * GetProgrammaticAccessCredentials API to obtain a credentials token * for a specific FinSpace user. This must be an IAM role within your FinSpace * account.

*/ inline bool ApiAccessPrincipalArnHasBeenSet() const { return m_apiAccessPrincipalArnHasBeenSet; } /** *

The ARN identifier of an AWS user or role that is allowed to call the * GetProgrammaticAccessCredentials API to obtain a credentials token * for a specific FinSpace user. This must be an IAM role within your FinSpace * account.

*/ inline void SetApiAccessPrincipalArn(const Aws::String& value) { m_apiAccessPrincipalArnHasBeenSet = true; m_apiAccessPrincipalArn = value; } /** *

The ARN identifier of an AWS user or role that is allowed to call the * GetProgrammaticAccessCredentials API to obtain a credentials token * for a specific FinSpace user. This must be an IAM role within your FinSpace * account.

*/ inline void SetApiAccessPrincipalArn(Aws::String&& value) { m_apiAccessPrincipalArnHasBeenSet = true; m_apiAccessPrincipalArn = std::move(value); } /** *

The ARN identifier of an AWS user or role that is allowed to call the * GetProgrammaticAccessCredentials API to obtain a credentials token * for a specific FinSpace user. This must be an IAM role within your FinSpace * account.

*/ inline void SetApiAccessPrincipalArn(const char* value) { m_apiAccessPrincipalArnHasBeenSet = true; m_apiAccessPrincipalArn.assign(value); } /** *

The ARN identifier of an AWS user or role that is allowed to call the * GetProgrammaticAccessCredentials API to obtain a credentials token * for a specific FinSpace user. This must be an IAM role within your FinSpace * account.

*/ inline User& WithApiAccessPrincipalArn(const Aws::String& value) { SetApiAccessPrincipalArn(value); return *this;} /** *

The ARN identifier of an AWS user or role that is allowed to call the * GetProgrammaticAccessCredentials API to obtain a credentials token * for a specific FinSpace user. This must be an IAM role within your FinSpace * account.

*/ inline User& WithApiAccessPrincipalArn(Aws::String&& value) { SetApiAccessPrincipalArn(std::move(value)); return *this;} /** *

The ARN identifier of an AWS user or role that is allowed to call the * GetProgrammaticAccessCredentials API to obtain a credentials token * for a specific FinSpace user. This must be an IAM role within your FinSpace * account.

*/ inline User& WithApiAccessPrincipalArn(const char* value) { SetApiAccessPrincipalArn(value); return *this;} /** *

The timestamp at which the user account was created in FinSpace. The value is * determined as epoch time in milliseconds.

*/ inline long long GetCreateTime() const{ return m_createTime; } /** *

The timestamp at which the user account was created in FinSpace. The value is * determined as epoch time in milliseconds.

*/ inline bool CreateTimeHasBeenSet() const { return m_createTimeHasBeenSet; } /** *

The timestamp at which the user account was created in FinSpace. The value is * determined as epoch time in milliseconds.

*/ inline void SetCreateTime(long long value) { m_createTimeHasBeenSet = true; m_createTime = value; } /** *

The timestamp at which the user account was created in FinSpace. The value is * determined as epoch time in milliseconds.

*/ inline User& WithCreateTime(long long value) { SetCreateTime(value); return *this;} /** *

Describes the last time the user account was enabled. The value is * determined as epoch time in milliseconds.

*/ inline long long GetLastEnabledTime() const{ return m_lastEnabledTime; } /** *

Describes the last time the user account was enabled. The value is * determined as epoch time in milliseconds.

*/ inline bool LastEnabledTimeHasBeenSet() const { return m_lastEnabledTimeHasBeenSet; } /** *

Describes the last time the user account was enabled. The value is * determined as epoch time in milliseconds.

*/ inline void SetLastEnabledTime(long long value) { m_lastEnabledTimeHasBeenSet = true; m_lastEnabledTime = value; } /** *

Describes the last time the user account was enabled. The value is * determined as epoch time in milliseconds.

*/ inline User& WithLastEnabledTime(long long value) { SetLastEnabledTime(value); return *this;} /** *

Describes the last time the user account was disabled. The value is * determined as epoch time in milliseconds.

*/ inline long long GetLastDisabledTime() const{ return m_lastDisabledTime; } /** *

Describes the last time the user account was disabled. The value is * determined as epoch time in milliseconds.

*/ inline bool LastDisabledTimeHasBeenSet() const { return m_lastDisabledTimeHasBeenSet; } /** *

Describes the last time the user account was disabled. The value is * determined as epoch time in milliseconds.

*/ inline void SetLastDisabledTime(long long value) { m_lastDisabledTimeHasBeenSet = true; m_lastDisabledTime = value; } /** *

Describes the last time the user account was disabled. The value is * determined as epoch time in milliseconds.

*/ inline User& WithLastDisabledTime(long long value) { SetLastDisabledTime(value); return *this;} /** *

Describes the last time the user account was updated. The value is determined * as epoch time in milliseconds.

*/ inline long long GetLastModifiedTime() const{ return m_lastModifiedTime; } /** *

Describes the last time the user account was updated. The value is determined * as epoch time in milliseconds.

*/ inline bool LastModifiedTimeHasBeenSet() const { return m_lastModifiedTimeHasBeenSet; } /** *

Describes the last time the user account was updated. The value is determined * as epoch time in milliseconds.

*/ inline void SetLastModifiedTime(long long value) { m_lastModifiedTimeHasBeenSet = true; m_lastModifiedTime = value; } /** *

Describes the last time the user account was updated. The value is determined * as epoch time in milliseconds.

*/ inline User& WithLastModifiedTime(long long value) { SetLastModifiedTime(value); return *this;} /** *

Describes the last time that the user logged into their account. The value is * determined as epoch time in milliseconds.

*/ inline long long GetLastLoginTime() const{ return m_lastLoginTime; } /** *

Describes the last time that the user logged into their account. The value is * determined as epoch time in milliseconds.

*/ inline bool LastLoginTimeHasBeenSet() const { return m_lastLoginTimeHasBeenSet; } /** *

Describes the last time that the user logged into their account. The value is * determined as epoch time in milliseconds.

*/ inline void SetLastLoginTime(long long value) { m_lastLoginTimeHasBeenSet = true; m_lastLoginTime = value; } /** *

Describes the last time that the user logged into their account. The value is * determined as epoch time in milliseconds.

*/ inline User& WithLastLoginTime(long long value) { SetLastLoginTime(value); return *this;} private: Aws::String m_userId; bool m_userIdHasBeenSet = false; UserStatus m_status; bool m_statusHasBeenSet = false; Aws::String m_firstName; bool m_firstNameHasBeenSet = false; Aws::String m_lastName; bool m_lastNameHasBeenSet = false; Aws::String m_emailAddress; bool m_emailAddressHasBeenSet = false; UserType m_type; bool m_typeHasBeenSet = false; ApiAccess m_apiAccess; bool m_apiAccessHasBeenSet = false; Aws::String m_apiAccessPrincipalArn; bool m_apiAccessPrincipalArnHasBeenSet = false; long long m_createTime; bool m_createTimeHasBeenSet = false; long long m_lastEnabledTime; bool m_lastEnabledTimeHasBeenSet = false; long long m_lastDisabledTime; bool m_lastDisabledTimeHasBeenSet = false; long long m_lastModifiedTime; bool m_lastModifiedTimeHasBeenSet = false; long long m_lastLoginTime; bool m_lastLoginTimeHasBeenSet = false; }; } // namespace Model } // namespace FinSpaceData } // namespace Aws