software.amazon.awssdk.services.mq.model

Class CreateUserRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.mq.model.MqRequest

software.amazon.awssdk.services.mq.model.CreateUserRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateUserRequest
extends MqRequest
implements ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

Creates a new ActiveMQ user.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateUserRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	brokerId() The unique ID that Amazon MQ generates for the broker.
static CreateUserRequest.Builder	builder()
Boolean	consoleAccess() Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
List<String>	groups() The list of groups (20 maximum) to which the ActiveMQ user belongs.
int	hashCode()
String	password() Required.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateUserRequest.Builder>	serializableBuilderClass()
CreateUserRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	username() The username of the ActiveMQ user.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

brokerId

public String brokerId()

The unique ID that Amazon MQ generates for the broker.

Returns:

The unique ID that Amazon MQ generates for the broker.

consoleAccess

public Boolean consoleAccess()

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

Returns:

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

groups

public List<String> 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

password

public String 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.

Returns:

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.

username

public String username()

The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

Returns:

The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

toBuilder

public CreateUserRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

Specified by:

toBuilder in class MqRequest

Returns:

a builder for type T

builder

public static CreateUserRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateUserRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.