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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#accessString

Whether to allow or deny document access to the principal.

Returns:

  • (String)


6542
6543
6544
6545
6546
6547
6548
6549
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6542

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

#data_source_idString

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

Returns:

  • (String)


6542
6543
6544
6545
6546
6547
6548
6549
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6542

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

#nameString

The name of the user or group.

Returns:

  • (String)


6542
6543
6544
6545
6546
6547
6548
6549
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6542

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

#typeString

The type of principal.

Returns:

  • (String)


6542
6543
6544
6545
6546
6547
6548
6549
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6542

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