Package software.amazon.awscdk.services.amazonmq

Interface CfnBroker.UserProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBroker.UserProperty.Jsii$Proxy

Enclosing class:

CfnBroker

@Stability(Stable)
public static interface CfnBroker.UserProperty
extends software.amazon.jsii.JsiiSerializable

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 by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.

When OAuth 2.0 is enabled, the broker accepts one or no users.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.amazonmq.*;
 UserProperty userProperty = UserProperty.builder()
         .password("password")
         .username("username")
         // the properties below are optional
         .consoleAccess(false)
         .groups(List.of("groups"))
         .replicationUser(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBroker.UserProperty.Builder	A builder for CfnBroker.UserProperty
static final class	CfnBroker.UserProperty.Jsii$Proxy	An implementation for CfnBroker.UserProperty

Method Summary

Modifier and Type	Method	Description
static CfnBroker.UserProperty.Builder	builder()
default Object	getConsoleAccess()	Enables access to the ActiveMQ Web Console for the ActiveMQ user.
default List<String>	getGroups()	The list of groups (20 maximum) to which the ActiveMQ user belongs.
String	getPassword()	Required.
default Object	getReplicationUser()	Defines if this user is intended for CRDR replication purposes.
String	getUsername()	The username of the broker user.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPassword

@Stability(Stable)
@NotNull
String getPassword()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-password

getUsername

@Stability(Stable)
@NotNull
String getUsername()

The username of the broker user. The following restrictions apply to broker usernames:.

• For Amazon MQ for ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
• 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-username

getConsoleAccess

@Stability(Stable)
@Nullable
default Object getConsoleAccess()

Enables access to the ActiveMQ Web Console for the ActiveMQ user.

Does not apply to RabbitMQ brokers.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-consoleaccess

getGroups

@Stability(Stable)
@Nullable
default List<String> getGroups()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-groups

getReplicationUser

@Stability(Stable)
@Nullable
default Object getReplicationUser()

Defines if this user is intended for CRDR replication purposes.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-replicationuser

builder

@Stability(Stable)
static CfnBroker.UserProperty.Builder builder()

Returns:

a CfnBroker.UserProperty.Builder of CfnBroker.UserProperty