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

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

Overview

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.

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)


3110
3111
3112
3113
3114
3115
3116
3117
3118
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 3110

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


3110
3111
3112
3113
3114
3115
3116
3117
3118
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 3110

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


3110
3111
3112
3113
3114
3115
3116
3117
3118
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 3110

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

#replication_userBoolean

Defines if this user is intended for CRDR replication purposes.

Returns:

  • (Boolean)


3110
3111
3112
3113
3114
3115
3116
3117
3118
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 3110

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

#usernameString

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:

  • (String)


3110
3111
3112
3113
3114
3115
3116
3117
3118
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 3110

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