Class: Aws::Kendra::Types::HierarchicalPrincipal

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::HierarchicalPrincipal

Defined in:

gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

Note:

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

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

Information to define the hierarchy for which documents users should have access to.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #principal_list ⇒ Array<Types::Principal>

  A list of [principal][1] lists that define the hierarchy for which documents users should have access to.

Instance Attribute Details

#principal_list ⇒ Array<Types::Principal>

A list of principal lists that define the hierarchy for which documents users should have access to. Each hierarchical list specifies which user or group has allow or deny access for each document.

Returns:

• (Array<Types::Principal>)

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

class HierarchicalPrincipal < Struct.new(
  :principal_list)
  SENSITIVE = []
  include Aws::Structure
end