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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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
}

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)

4331
4332
4333
4334
4335
4336
4337
# File 'lib/aws-sdk-kendra/types.rb', line 4331

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

#nameString

The name of the user or group.

Returns:

  • (String)

4331
4332
4333
4334
4335
4336
4337
# File 'lib/aws-sdk-kendra/types.rb', line 4331

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

#typeString

The type of principal.

Returns:

  • (String)

4331
4332
4333
4334
4335
4336
4337
# File 'lib/aws-sdk-kendra/types.rb', line 4331

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