aws-cdk-lib.aws_amazonmq.CfnBroker.UserProperty

interface UserProperty

LanguageType name
.NETAmazon.CDK.AWS.AmazonMQ.CfnBroker.UserProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsamazonmq#CfnBroker_UserProperty
Javasoftware.amazon.awscdk.services.amazonmq.CfnBroker.UserProperty
Pythonaws_cdk.aws_amazonmq.CfnBroker.UserProperty
TypeScript aws-cdk-lib » aws_amazonmq » CfnBroker » UserProperty

The list of broker users (persons or applications) who can access queues and topics.

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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_amazonmq as amazonmq } from 'aws-cdk-lib';
const userProperty: amazonmq.CfnBroker.UserProperty = {
  password: 'password',
  username: 'username',

  // the properties below are optional
  consoleAccess: false,
  groups: ['groups'],
};

Properties

NameTypeDescription
passwordstringThe password of the user.
usernamestringThe username of the broker user.
consoleAccess?boolean | IResolvableEnables access to the ActiveMQ web console for the ActiveMQ user.
groups?string[]The list of groups (20 maximum) to which the ActiveMQ user belongs.

password

Type: string

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


username

Type: string

The username of the broker user.

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.


consoleAccess?

Type: boolean | IResolvable (optional)

Enables access to the ActiveMQ web console for the ActiveMQ user.

Does not apply to RabbitMQ brokers.


groups?

Type: string[] (optional)

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.