Class: Aws::Kendra::Types::Principal

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

Provides user and group information for [user context filtering].

[1]: docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access ⇒ String

Whether to allow or deny document access to the principal.

Returns:

  • (String) 


7745
7746
7747
7748
7749
7750
7751
7752
 
# File 'lib/aws-sdk-kendra/types.rb', line 7745

class Principal < Struct.new(
  :name,
  :type,
  :access,
  :data_source_id)
  SENSITIVE = []
  include Aws::Structure
end

#data_source_id ⇒ String

The identifier of the data source the principal should access documents from.

Returns:

  • (String) 


7745
7746
7747
7748
7749
7750
7751
7752
 
# File 'lib/aws-sdk-kendra/types.rb', line 7745

class Principal < Struct.new(
  :name,
  :type,
  :access,
  :data_source_id)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the user or group.

Returns:

  • (String) 


7745
7746
7747
7748
7749
7750
7751
7752
 
# File 'lib/aws-sdk-kendra/types.rb', line 7745

class Principal < Struct.new(
  :name,
  :type,
  :access,
  :data_source_id)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of principal.

Returns:

  • (String) 


7745
7746
7747
7748
7749
7750
7751
7752
 
# File 'lib/aws-sdk-kendra/types.rb', line 7745

class Principal < Struct.new(
  :name,
  :type,
  :access,
  :data_source_id)
  SENSITIVE = []
  include Aws::Structure
end