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

Class: Aws::MQ::Types::DescribeUserOutput

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

Overview

Returns information about an ActiveMQ user.

Instance Attribute Summary collapse

Instance Attribute Details

#broker_idString

Required. The unique ID that Amazon MQ generates for the broker.

Returns:

  • (String)


1032
1033
1034
1035
1036
1037
1038
1039
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1032

class DescribeUserOutput < Struct.new(
  :broker_id,
  :console_access,
  :groups,
  :pending,
  :username)
  include Aws::Structure
end

#console_accessBoolean

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

Returns:

  • (Boolean)


1032
1033
1034
1035
1036
1037
1038
1039
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1032

class DescribeUserOutput < Struct.new(
  :broker_id,
  :console_access,
  :groups,
  :pending,
  :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>)


1032
1033
1034
1035
1036
1037
1038
1039
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1032

class DescribeUserOutput < Struct.new(
  :broker_id,
  :console_access,
  :groups,
  :pending,
  :username)
  include Aws::Structure
end

#pendingTypes::UserPendingChanges

The status of the changes pending for the ActiveMQ user.



1032
1033
1034
1035
1036
1037
1038
1039
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1032

class DescribeUserOutput < Struct.new(
  :broker_id,
  :console_access,
  :groups,
  :pending,
  :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)


1032
1033
1034
1035
1036
1037
1038
1039
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1032

class DescribeUserOutput < Struct.new(
  :broker_id,
  :console_access,
  :groups,
  :pending,
  :username)
  include Aws::Structure
end