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

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

Overview

Provides user and group information for user context filtering.

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) 


7201
7202
7203
7204
7205
7206
7207
7208
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7201

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) 


7201
7202
7203
7204
7205
7206
7207
7208
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7201

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) 


7201
7202
7203
7204
7205
7206
7207
7208
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7201

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

#type ⇒ String

The type of principal.

Returns:

  • (String) 


7201
7202
7203
7204
7205
7206
7207
7208
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7201

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