User (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.mq.model.User

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class User
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A user associated with the broker. 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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

User()

Constructors
Constructor and Description
`User()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`User`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getConsoleAccess()` Enables access to the ActiveMQ Web Console for the ActiveMQ user.
`List<String>`	`getGroups()` The list of groups (20 maximum) to which the ActiveMQ user belongs.
`String`	`getPassword()` Required.
`Boolean`	`getReplicationUser()` Defines if this user is intended for CRDR replication purposes.
`String`	`getUsername()` The username of the broker user.
`int`	`hashCode()`
`Boolean`	`isConsoleAccess()` Enables access to the ActiveMQ Web Console for the ActiveMQ user.
`Boolean`	`isReplicationUser()` Defines if this user is intended for CRDR replication purposes.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setConsoleAccess(Boolean consoleAccess)` Enables access to the ActiveMQ Web Console for the ActiveMQ user.
`void`	`setGroups(Collection<String> groups)` The list of groups (20 maximum) to which the ActiveMQ user belongs.
`void`	`setPassword(String password)` Required.
`void`	`setReplicationUser(Boolean replicationUser)` Defines if this user is intended for CRDR replication purposes.
`void`	`setUsername(String username)` The username of the broker user.
`String`	`toString()` Returns a string representation of this object.
`User`	`withConsoleAccess(Boolean consoleAccess)` Enables access to the ActiveMQ Web Console for the ActiveMQ user.
`User`	`withGroups(Collection<String> groups)` The list of groups (20 maximum) to which the ActiveMQ user belongs.
`User`	`withGroups(String... groups)` The list of groups (20 maximum) to which the ActiveMQ user belongs.
`User`	`withPassword(String password)` Required.
`User`	`withReplicationUser(Boolean replicationUser)` Defines if this user is intended for CRDR replication purposes.
`User`	`withUsername(String username)` The username of the broker user.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - User
```
public User()
```
- Method Detail
  - setConsoleAccess
```
public void setConsoleAccess(Boolean consoleAccess)
```
    Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.
    
    Parameters:
    
    consoleAccess - Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.
  - getConsoleAccess
```
public Boolean getConsoleAccess()
```
    Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.
    
    Returns:
    
    Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.
  - withConsoleAccess
```
public User withConsoleAccess(Boolean consoleAccess)
```
    Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.
    
    Parameters:
    
    consoleAccess - Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isConsoleAccess
```
public Boolean isConsoleAccess()
```
    Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.
    
    Returns:
    
    Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.
  - getGroups
```
public 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.
    
    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. Does not apply to RabbitMQ brokers.
  - setGroups
```
public void setGroups(Collection<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. Does not apply to RabbitMQ brokers.
    
    Parameters:
    
    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. Does not apply to RabbitMQ brokers.
  - withGroups
```
public User withGroups(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. Does not apply to RabbitMQ brokers.
    
    NOTE: This method appends the values to the existing list (if any). Use setGroups(java.util.Collection) or withGroups(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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. Does not apply to RabbitMQ brokers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withGroups
```
public User withGroups(Collection<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. Does not apply to RabbitMQ brokers.
    
    Parameters:
    
    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. Does not apply to RabbitMQ brokers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPassword
```
public void setPassword(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, colons, or equal signs (,:=).
    
    Parameters:
    
    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, colons, or equal signs (,:=).
  - getPassword
```
public 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 (,:=).
    
    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, colons, or equal signs (,:=).
  - withPassword
```
public User withPassword(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, colons, or equal signs (,:=).
    
    Parameters:
    
    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, colons, or equal signs (,:=).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUsername
```
public void setUsername(String username)
```
    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.
    - para>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 Amazon Web Services services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.
    Parameters:
    username - 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.
    
    para>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 Amazon Web Services services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.
  - getUsername
```
public 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.
    - para>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 Amazon Web Services services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.
    Returns:
    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.
    
    para>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 Amazon Web Services services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.
  - withUsername
```
public User withUsername(String username)
```
    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.
    - para>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 Amazon Web Services services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.
    Parameters:
    username - 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.
    
    para>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 Amazon Web Services services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReplicationUser
```
public void setReplicationUser(Boolean replicationUser)
```
    Defines if this user is intended for CRDR replication purposes.
    
    Parameters:
    
    replicationUser - Defines if this user is intended for CRDR replication purposes.
  - getReplicationUser
```
public Boolean getReplicationUser()
```
    Defines if this user is intended for CRDR replication purposes.
    
    Returns:
    
    Defines if this user is intended for CRDR replication purposes.
  - withReplicationUser
```
public User withReplicationUser(Boolean replicationUser)
```
    Defines if this user is intended for CRDR replication purposes.
    
    Parameters:
    
    replicationUser - Defines if this user is intended for CRDR replication purposes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isReplicationUser
```
public Boolean isReplicationUser()
```
    Defines if this user is intended for CRDR replication purposes.
    
    Returns:
    
    Defines if this user is intended for CRDR replication purposes.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public User clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class User

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

User

Method Detail

setConsoleAccess

getConsoleAccess

withConsoleAccess

isConsoleAccess

getGroups

setGroups

withGroups

withGroups

setPassword

getPassword

withPassword

setUsername

getUsername

withUsername

setReplicationUser

getReplicationUser

withReplicationUser

isReplicationUser

toString

equals

hashCode

clone

marshall