@Stability(value=Stable)
public static interface CfnBroker.UserProperty
extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.amazonmq.*;
UserProperty userProperty = UserProperty.builder()
.password("password")
.username("username")
// the properties below are optional
.consoleAccess(false)
.groups(List.of("groups"))
.build();
| Modifier and Type | Interface and Description |
|---|---|
static class |
CfnBroker.UserProperty.Builder
A builder for
CfnBroker.UserProperty |
static class |
CfnBroker.UserProperty.Jsii$Proxy
An implementation for
CfnBroker.UserProperty |
| Modifier and Type | Method and 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()
The password of the user.
|
String |
getUsername()
The username of the broker user.
|
@Stability(value=Stable) @NotNull String getPassword()
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 (,:=).
@Stability(value=Stable) @NotNull String getUsername()
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.
@Stability(value=Stable) @Nullable default Object getConsoleAccess()
Does not apply to RabbitMQ brokers.
@Stability(value=Stable) @Nullable default List<String> getGroups()
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.
@Stability(value=Stable) static CfnBroker.UserProperty.Builder builder()
CfnBroker.UserProperty.Builder of CfnBroker.UserPropertyCopyright © 2022. All rights reserved.