Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.MQ.Types.User

Description

Synopsis

data User = User' {
- groups :: Maybe [Text]
- consoleAccess :: Maybe Bool
- username :: Text
- password :: Text
}
newUser :: Text -> Text -> User
user_groups :: Lens' User (Maybe [Text])
user_consoleAccess :: Lens' User (Maybe Bool)
user_username :: Lens' User Text
user_password :: Lens' User Text

Documentation

data User Source #

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: newUser smart constructor.

Constructors

User'

Fields

groups :: Maybe [Text]
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.
consoleAccess :: Maybe Bool
Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.
username :: Text
important>
Amazon MQ for ActiveMQ
For ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
/important>
Amazon MQ for RabbitMQ
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.
password :: Text
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 (,:=).

Instances

Instances details

Eq User Source #
Instance details Defined in Amazonka.MQ.Types.User Methods (==) :: User -> User -> Bool # (/=) :: User -> User -> Bool #
Read User Source #
Instance details Defined in Amazonka.MQ.Types.User Methods readsPrec :: Int -> ReadS User # readList :: ReadS [User] # readPrec :: ReadPrec User # readListPrec :: ReadPrec [User] #
Show User Source #
Instance details Defined in Amazonka.MQ.Types.User Methods showsPrec :: Int -> User -> ShowS # show :: User -> String # showList :: [User] -> ShowS #
Generic User Source #
Instance details Defined in Amazonka.MQ.Types.User Associated Types type Rep User :: Type -> Type # Methods from :: User -> Rep User x # to :: Rep User x -> User #
NFData User Source #
Instance details Defined in Amazonka.MQ.Types.User Methods rnf :: User -> () #
Hashable User Source #
Instance details Defined in Amazonka.MQ.Types.User Methods hashWithSalt :: Int -> User -> Int # hash :: User -> Int #
ToJSON User Source #
Instance details Defined in Amazonka.MQ.Types.User Methods toJSON :: User -> Value # toEncoding :: User -> Encoding # toJSONList :: [User] -> Value # toEncodingList :: [User] -> Encoding #
type Rep User Source #
Instance details Defined in Amazonka.MQ.Types.User type Rep User = D1 ('MetaData "User" "Amazonka.MQ.Types.User" "libZSservicesZSamazonka-mqZSamazonka-mq" 'False) (C1 ('MetaCons "User'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "groups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "consoleAccess") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUser Source #

Arguments

:: Text	`$sel:username:User'`
-> Text	`$sel:password:User'`
-> User

Create a value of User with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:groups:User', user_groups - 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.

$sel:consoleAccess:User', user_consoleAccess - Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.

$sel:username:User', user_username - important>

Amazon MQ for ActiveMQ

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

/important>

Amazon MQ for RabbitMQ

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.

$sel:password:User', user_password - 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 (,:=).

user_groups :: Lens' User (Maybe [Text]) Source #

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.

user_consoleAccess :: Lens' User (Maybe Bool) Source #

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

user_username :: Lens' User Text Source #

important>

Amazon MQ for ActiveMQ

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

/important>

Amazon MQ for RabbitMQ

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.

user_password :: Lens' User Text Source #

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 (,:=).