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

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::Principal

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #access ⇒ String

  Whether to allow or deny access to the principal.

• #name ⇒ String

  The name of the user or group.

• #type ⇒ String

  The type of principal.

Instance Attribute Details

#access ⇒ String

Whether to allow or deny access to the principal.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 4331

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

#name ⇒ String

The name of the user or group.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 4331

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

#type ⇒ String

The type of principal.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 4331

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