Class: Aws::MQ::Types::User

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb

Overview

Note:

When making an API call, you may pass User data as a hash:

{
  console_access: false,
  groups: ["__string"],
  password: "__string", # required
  username: "__string", # required
}

A user associated with the broker. 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#console_accessBoolean

Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.

Returns:

  • (Boolean)


3150
3151
3152
3153
3154
3155
3156
3157
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 3150

class User < Struct.new(
  :console_access,
  :groups,
  :password,
  :username)
  SENSITIVE = []
  include Aws::Structure
end

#groupsArray<String>

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:

  • (Array<String>)


3150
3151
3152
3153
3154
3155
3156
3157
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 3150

class User < Struct.new(
  :console_access,
  :groups,
  :password,
  :username)
  SENSITIVE = []
  include Aws::Structure
end

#passwordString

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:

  • (String)


3150
3151
3152
3153
3154
3155
3156
3157
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 3150

class User < Struct.new(
  :console_access,
  :groups,
  :password,
  :username)
  SENSITIVE = []
  include Aws::Structure
end

#usernameString

important>Amazon MQ for ActiveMQ

For ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

/important> Amazon MQ for RabbitMQ

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.

Returns:

  • (String)


3150
3151
3152
3153
3154
3155
3156
3157
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 3150

class User < Struct.new(
  :console_access,
  :groups,
  :password,
  :username)
  SENSITIVE = []
  include Aws::Structure
end