AWS SDK for C++  1.9.67
AWS SDK for C++
Public Member Functions | List of all members
Aws::MQ::Model::User Class Reference

#include <User.h>

Public Member Functions

 User ()
 
 User (Aws::Utils::Json::JsonView jsonValue)
 
Useroperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
bool GetConsoleAccess () const
 
bool ConsoleAccessHasBeenSet () const
 
void SetConsoleAccess (bool value)
 
UserWithConsoleAccess (bool value)
 
const Aws::Vector< Aws::String > & GetGroups () const
 
bool GroupsHasBeenSet () const
 
void SetGroups (const Aws::Vector< Aws::String > &value)
 
void SetGroups (Aws::Vector< Aws::String > &&value)
 
UserWithGroups (const Aws::Vector< Aws::String > &value)
 
UserWithGroups (Aws::Vector< Aws::String > &&value)
 
UserAddGroups (const Aws::String &value)
 
UserAddGroups (Aws::String &&value)
 
UserAddGroups (const char *value)
 
const Aws::StringGetPassword () const
 
bool PasswordHasBeenSet () const
 
void SetPassword (const Aws::String &value)
 
void SetPassword (Aws::String &&value)
 
void SetPassword (const char *value)
 
UserWithPassword (const Aws::String &value)
 
UserWithPassword (Aws::String &&value)
 
UserWithPassword (const char *value)
 
const Aws::StringGetUsername () const
 
bool UsernameHasBeenSet () const
 
void SetUsername (const Aws::String &value)
 
void SetUsername (Aws::String &&value)
 
void SetUsername (const char *value)
 
UserWithUsername (const Aws::String &value)
 
UserWithUsername (Aws::String &&value)
 
UserWithUsername (const char *value)
 

Detailed Description

A user associated with the broker. For RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.

See Also:

AWS API Reference

Definition at line 35 of file User.h.

Constructor & Destructor Documentation

◆ User() [1/2]

Aws::MQ::Model::User::User ( )

◆ User() [2/2]

Aws::MQ::Model::User::User ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddGroups() [1/3]

User& Aws::MQ::Model::User::AddGroups ( Aws::String &&  value)
inline

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.

Definition at line 131 of file User.h.

◆ AddGroups() [2/3]

User& Aws::MQ::Model::User::AddGroups ( const Aws::String value)
inline

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.

Definition at line 123 of file User.h.

◆ AddGroups() [3/3]

User& Aws::MQ::Model::User::AddGroups ( const char *  value)
inline

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.

Definition at line 139 of file User.h.

◆ ConsoleAccessHasBeenSet()

bool Aws::MQ::Model::User::ConsoleAccessHasBeenSet ( ) const
inline

Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.

Definition at line 54 of file User.h.

◆ GetConsoleAccess()

bool Aws::MQ::Model::User::GetConsoleAccess ( ) const
inline

Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.

Definition at line 48 of file User.h.

◆ GetGroups()

const Aws::Vector<Aws::String>& Aws::MQ::Model::User::GetGroups ( ) const
inline

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.

Definition at line 75 of file User.h.

◆ GetPassword()

const Aws::String& Aws::MQ::Model::User::GetPassword ( ) const
inline

Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).

Definition at line 147 of file User.h.

◆ GetUsername()

const Aws::String& Aws::MQ::Model::User::GetUsername ( ) const
inline

important><title>Amazon MQ for ActiveMQ</title>

For ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

/important> <title>Amazon MQ for RabbitMQ</title>

For RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.

Definition at line 209 of file User.h.

◆ GroupsHasBeenSet()

bool Aws::MQ::Model::User::GroupsHasBeenSet ( ) const
inline

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.

Definition at line 83 of file User.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::MQ::Model::User::Jsonize ( ) const

◆ operator=()

User& Aws::MQ::Model::User::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PasswordHasBeenSet()

bool Aws::MQ::Model::User::PasswordHasBeenSet ( ) const
inline

Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).

Definition at line 154 of file User.h.

◆ SetConsoleAccess()

void Aws::MQ::Model::User::SetConsoleAccess ( bool  value)
inline

Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.

Definition at line 60 of file User.h.

◆ SetGroups() [1/2]

void Aws::MQ::Model::User::SetGroups ( Aws::Vector< Aws::String > &&  value)
inline

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.

Definition at line 99 of file User.h.

◆ SetGroups() [2/2]

void Aws::MQ::Model::User::SetGroups ( const Aws::Vector< Aws::String > &  value)
inline

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.

Definition at line 91 of file User.h.

◆ SetPassword() [1/3]

void Aws::MQ::Model::User::SetPassword ( Aws::String &&  value)
inline

Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).

Definition at line 168 of file User.h.

◆ SetPassword() [2/3]

void Aws::MQ::Model::User::SetPassword ( const Aws::String value)
inline

Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).

Definition at line 161 of file User.h.

◆ SetPassword() [3/3]

void Aws::MQ::Model::User::SetPassword ( const char *  value)
inline

Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).

Definition at line 175 of file User.h.

◆ SetUsername() [1/3]

void Aws::MQ::Model::User::SetUsername ( Aws::String &&  value)
inline

important><title>Amazon MQ for ActiveMQ</title>

For ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

/important> <title>Amazon MQ for RabbitMQ</title>

For RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.

Definition at line 245 of file User.h.

◆ SetUsername() [2/3]

void Aws::MQ::Model::User::SetUsername ( const Aws::String value)
inline

important><title>Amazon MQ for ActiveMQ</title>

For ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

/important> <title>Amazon MQ for RabbitMQ</title>

For RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.

Definition at line 233 of file User.h.

◆ SetUsername() [3/3]

void Aws::MQ::Model::User::SetUsername ( const char *  value)
inline

important><title>Amazon MQ for ActiveMQ</title>

For ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

/important> <title>Amazon MQ for RabbitMQ</title>

For RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.

Definition at line 257 of file User.h.

◆ UsernameHasBeenSet()

bool Aws::MQ::Model::User::UsernameHasBeenSet ( ) const
inline

important><title>Amazon MQ for ActiveMQ</title>

For ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

/important> <title>Amazon MQ for RabbitMQ</title>

For RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.

Definition at line 221 of file User.h.

◆ WithConsoleAccess()

User& Aws::MQ::Model::User::WithConsoleAccess ( bool  value)
inline

Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.

Definition at line 66 of file User.h.

◆ WithGroups() [1/2]

User& Aws::MQ::Model::User::WithGroups ( Aws::Vector< Aws::String > &&  value)
inline

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.

Definition at line 115 of file User.h.

◆ WithGroups() [2/2]

User& Aws::MQ::Model::User::WithGroups ( const Aws::Vector< Aws::String > &  value)
inline

The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.

Definition at line 107 of file User.h.

◆ WithPassword() [1/3]

User& Aws::MQ::Model::User::WithPassword ( Aws::String &&  value)
inline

Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).

Definition at line 189 of file User.h.

◆ WithPassword() [2/3]

User& Aws::MQ::Model::User::WithPassword ( const Aws::String value)
inline

Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).

Definition at line 182 of file User.h.

◆ WithPassword() [3/3]

User& Aws::MQ::Model::User::WithPassword ( const char *  value)
inline

Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).

Definition at line 196 of file User.h.

◆ WithUsername() [1/3]

User& Aws::MQ::Model::User::WithUsername ( Aws::String &&  value)
inline

important><title>Amazon MQ for ActiveMQ</title>

For ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

/important> <title>Amazon MQ for RabbitMQ</title>

For RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.

Definition at line 281 of file User.h.

◆ WithUsername() [2/3]

User& Aws::MQ::Model::User::WithUsername ( const Aws::String value)
inline

important><title>Amazon MQ for ActiveMQ</title>

For ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

/important> <title>Amazon MQ for RabbitMQ</title>

For RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.

Definition at line 269 of file User.h.

◆ WithUsername() [3/3]

User& Aws::MQ::Model::User::WithUsername ( const char *  value)
inline

important><title>Amazon MQ for ActiveMQ</title>

For ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

/important> <title>Amazon MQ for RabbitMQ</title>

For RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.

Definition at line 293 of file User.h.


The documentation for this class was generated from the following file: