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

Inherits:

Struct

• Object
• Struct
• Aws::MQ::Types::DescribeUserOutput

Defined in:

gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb

Overview

Returns information about an ActiveMQ user.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #broker_id ⇒ String

  Required.

• #console_access ⇒ Boolean

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

• #groups ⇒ Array<String>

  The list of groups (20 maximum) to which the ActiveMQ user belongs.

• #pending ⇒ Types::UserPendingChanges

  The status of the changes pending for the ActiveMQ user.

• #replication_user ⇒ Boolean

  Describes whether the user is intended for data replication.

• #username ⇒ String

  Required.

Instance Attribute Details

#broker_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1714

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

#console_access ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1714

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

#groups ⇒ Array<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>)

# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1714

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

#pending ⇒ Types::UserPendingChanges

The status of the changes pending for the ActiveMQ user.

Returns:

• (Types::UserPendingChanges)

# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1714

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

#replication_user ⇒ Boolean

Describes whether the user is intended for data replication

Returns:

• (Boolean)

# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1714

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

#username ⇒ String

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)

# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1714

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