Interface CfnBroker.IUserProperty
The list of broker users (persons or applications) who can access queues and topics.
Namespace: Amazon.CDK.AWS.AmazonMQ
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IUserProperty
Syntax (vb)
Public Interface IUserProperty
Remarks
For Amazon MQ 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 via the RabbitMQ web console or by using the RabbitMQ management API.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AmazonMQ;
var userProperty = new UserProperty {
Password = "password",
Username = "username",
// the properties below are optional
ConsoleAccess = false,
Groups = new [] { "groups" },
ReplicationUser = false
};
Synopsis
Properties
ConsoleAccess | Enables access to the ActiveMQ web console for the ActiveMQ user. |
Groups | The list of groups (20 maximum) to which the ActiveMQ user belongs. |
Password | The password of the user. |
ReplicationUser | Defines if this user is intended for CRDR replication purposes. |
Username | The username of the broker user. |
Properties
ConsoleAccess
Enables access to the ActiveMQ web console for the ActiveMQ user.
virtual object ConsoleAccess { get; }
Property Value
System.Object
Remarks
Does not apply to RabbitMQ brokers.
Groups
The list of groups (20 maximum) to which the ActiveMQ user belongs.
virtual string[] Groups { get; }
Property Value
System.String[]
Remarks
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.
Password
The password of the user.
string Password { get; }
Property Value
System.String
Remarks
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 (,:=).
ReplicationUser
Defines if this user is intended for CRDR replication purposes.
virtual object ReplicationUser { get; }
Property Value
System.Object
Remarks
Username
The username of the broker user.
string Username { get; }
Property Value
System.String
Remarks
For Amazon MQ for ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). For Amazon MQ 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.
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other AWS services, including CloudWatch Logs . Broker usernames are not intended to be used for private or sensitive data.