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)


7436
7437
7438
7439
7440
7441
7442
7443
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7436

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)


7436
7437
7438
7439
7440
7441
7442
7443
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7436

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)


7436
7437
7438
7439
7440
7441
7442
7443
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7436

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

#typeString

The type of principal.

Returns:

  • (String)


7436
7437
7438
7439
7440
7441
7442
7443
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7436

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