Class: Aws::Kendra::Types::CreateAccessControlConfigurationRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_control_list ⇒ Array<Types::Principal>

Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Returns:



1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
 
# File 'lib/aws-sdk-kendra/types.rb', line 1914

class CreateAccessControlConfigurationRequest < Struct.new(
  :index_id,
  :name,
  :description,
  :access_control_list,
  :hierarchical_access_control_list,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A token that you provide to identify the request to create an access control configuration. Multiple calls to the ‘CreateAccessControlConfiguration` API with the same client token will create only one access control configuration.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
 
# File 'lib/aws-sdk-kendra/types.rb', line 1914

class CreateAccessControlConfigurationRequest < Struct.new(
  :index_id,
  :name,
  :description,
  :access_control_list,
  :hierarchical_access_control_list,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description for the access control configuration.

Returns:

  • (String) 


1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
 
# File 'lib/aws-sdk-kendra/types.rb', line 1914

class CreateAccessControlConfigurationRequest < Struct.new(
  :index_id,
  :name,
  :description,
  :access_control_list,
  :hierarchical_access_control_list,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#hierarchical_access_control_list ⇒ Array<Types::HierarchicalPrincipal>

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

[1]: docs.aws.amazon.com/kendra/latest/dg/API_Principal.html

Returns:



1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
 
# File 'lib/aws-sdk-kendra/types.rb', line 1914

class CreateAccessControlConfigurationRequest < Struct.new(
  :index_id,
  :name,
  :description,
  :access_control_list,
  :hierarchical_access_control_list,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#index_id ⇒ String

The identifier of the index to create an access control configuration for your documents.

Returns:

  • (String) 


1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
 
# File 'lib/aws-sdk-kendra/types.rb', line 1914

class CreateAccessControlConfigurationRequest < Struct.new(
  :index_id,
  :name,
  :description,
  :access_control_list,
  :hierarchical_access_control_list,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A name for the access control configuration.

Returns:

  • (String) 


1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
 
# File 'lib/aws-sdk-kendra/types.rb', line 1914

class CreateAccessControlConfigurationRequest < Struct.new(
  :index_id,
  :name,
  :description,
  :access_control_list,
  :hierarchical_access_control_list,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end