Class: Aws::CloudWatchOmni::Types::PrincipalSearchResult

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchOmni::Types::PrincipalSearchResult

Defined in:

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

Overview

A user or group matched by SearchPrincipals.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  An optional description of the principal.

• #display_name ⇒ String

  The display name of the principal.

• #principal_id ⇒ String

  The unique ID of the principal.

• #principal_type ⇒ String

  Whether the principal is a user or a group.

• #user_name ⇒ String

  The user name of the principal.

Instance Attribute Details

#description ⇒ String

An optional description of the principal.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 4131

class PrincipalSearchResult < Struct.new(
  :principal_id,
  :principal_type,
  :display_name,
  :user_name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

The display name of the principal.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 4131

class PrincipalSearchResult < Struct.new(
  :principal_id,
  :principal_type,
  :display_name,
  :user_name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#principal_id ⇒ String

The unique ID of the principal.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 4131

class PrincipalSearchResult < Struct.new(
  :principal_id,
  :principal_type,
  :display_name,
  :user_name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#principal_type ⇒ String

Whether the principal is a user or a group.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 4131

class PrincipalSearchResult < Struct.new(
  :principal_id,
  :principal_type,
  :display_name,
  :user_name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#user_name ⇒ String

The user name of the principal. Present for users only.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 4131

class PrincipalSearchResult < Struct.new(
  :principal_id,
  :principal_type,
  :display_name,
  :user_name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end