You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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",
  username: "__string",
}

An ActiveMQ user associated with the broker.

Instance Attribute Summary collapse

Instance Attribute Details

#console_accessBoolean

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

Returns:

  • (Boolean)


1731
1732
1733
1734
1735
1736
1737
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1731

class User < Struct.new(
  :console_access,
  :groups,
  :password,
  :username)
  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.

Returns:

  • (Array<String>)


1731
1732
1733
1734
1735
1736
1737
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1731

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

#passwordString

Required. The password of the ActiveMQ user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas.

Returns:

  • (String)


1731
1732
1733
1734
1735
1736
1737
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1731

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

#usernameString

Required. 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:

  • (String)


1731
1732
1733
1734
1735
1736
1737
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1731

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