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

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

Overview

Note:

When making an API call, you may pass Principal data as a hash:

{
  name: "PrincipalName", # required
  type: "USER", # required, accepts USER, GROUP
  access: "ALLOW", # required, accepts ALLOW, DENY
  data_source_id: "DataSourceId",
}

Provides user and group information for document access filtering.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#accessString

Whether to allow or deny access to the principal.

Returns:

  • (String)


7479
7480
7481
7482
7483
7484
7485
7486
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7479

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)


7479
7480
7481
7482
7483
7484
7485
7486
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7479

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)


7479
7480
7481
7482
7483
7484
7485
7486
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7479

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

#typeString

The type of principal.

Returns:

  • (String)


7479
7480
7481
7482
7483
7484
7485
7486
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7479

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