Class: Aws::Kendra::Types::BoxConfiguration

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

Overview

Provides the configuration information to connect to Box as your data source.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#comment_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

A list of ‘DataSourceToIndexFieldMapping` objects that map attributes or field names of Box comments to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Box fields. For more information, see [Mapping data source fields]. The Box field names must exist in your Box custom metadata.

[1]: docs.aws.amazon.com/kendra/latest/dg/field-mapping.html

Returns:



1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/aws-sdk-kendra/types.rb', line 1102

class BoxConfiguration < Struct.new(
  :enterprise_id,
  :secret_arn,
  :use_change_log,
  :crawl_comments,
  :crawl_tasks,
  :crawl_web_links,
  :file_field_mappings,
  :task_field_mappings,
  :comment_field_mappings,
  :web_link_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#crawl_comments ⇒ Boolean

‘TRUE` to index comments.

Returns:

  • (Boolean) 


1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/aws-sdk-kendra/types.rb', line 1102

class BoxConfiguration < Struct.new(
  :enterprise_id,
  :secret_arn,
  :use_change_log,
  :crawl_comments,
  :crawl_tasks,
  :crawl_web_links,
  :file_field_mappings,
  :task_field_mappings,
  :comment_field_mappings,
  :web_link_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#crawl_tasks ⇒ Boolean

‘TRUE` to index the contents of tasks.

Returns:

  • (Boolean) 


1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/aws-sdk-kendra/types.rb', line 1102

class BoxConfiguration < Struct.new(
  :enterprise_id,
  :secret_arn,
  :use_change_log,
  :crawl_comments,
  :crawl_tasks,
  :crawl_web_links,
  :file_field_mappings,
  :task_field_mappings,
  :comment_field_mappings,
  :web_link_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#crawl_web_links ⇒ Boolean

‘TRUE` to index web links.

Returns:

  • (Boolean) 


1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/aws-sdk-kendra/types.rb', line 1102

class BoxConfiguration < Struct.new(
  :enterprise_id,
  :secret_arn,
  :use_change_log,
  :crawl_comments,
  :crawl_tasks,
  :crawl_web_links,
  :file_field_mappings,
  :task_field_mappings,
  :comment_field_mappings,
  :web_link_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#enterprise_id ⇒ String

The identifier of the Box Enterprise platform. You can find the enterprise ID in the Box Developer Console settings or when you create an app in Box and download your authentication credentials. For example, 801234567.

Returns:

  • (String) 


1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/aws-sdk-kendra/types.rb', line 1102

class BoxConfiguration < Struct.new(
  :enterprise_id,
  :secret_arn,
  :use_change_log,
  :crawl_comments,
  :crawl_tasks,
  :crawl_web_links,
  :file_field_mappings,
  :task_field_mappings,
  :comment_field_mappings,
  :web_link_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#exclusion_patterns ⇒ Array<String>

A list of regular expression patterns to exclude certain files and folders from your Box platform. Files and folders that match the patterns are excluded from the index.Files and folders that don’t match the patterns are included in the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn’t included in the index.

Returns:

  • (Array<String>) 


1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/aws-sdk-kendra/types.rb', line 1102

class BoxConfiguration < Struct.new(
  :enterprise_id,
  :secret_arn,
  :use_change_log,
  :crawl_comments,
  :crawl_tasks,
  :crawl_web_links,
  :file_field_mappings,
  :task_field_mappings,
  :comment_field_mappings,
  :web_link_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#file_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

A list of ‘DataSourceToIndexFieldMapping` objects that map attributes or field names of Box files to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Box fields. For more information, see [Mapping data source fields]. The Box field names must exist in your Box custom metadata.

[1]: docs.aws.amazon.com/kendra/latest/dg/field-mapping.html

Returns:



1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/aws-sdk-kendra/types.rb', line 1102

class BoxConfiguration < Struct.new(
  :enterprise_id,
  :secret_arn,
  :use_change_log,
  :crawl_comments,
  :crawl_tasks,
  :crawl_web_links,
  :file_field_mappings,
  :task_field_mappings,
  :comment_field_mappings,
  :web_link_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#inclusion_patterns ⇒ Array<String>

A list of regular expression patterns to include certain files and folders in your Box platform. Files and folders that match the patterns are included in the index. Files and folders that don’t match the patterns are excluded from the index. If a file or folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file or folder isn’t included in the index.

Returns:

  • (Array<String>) 


1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/aws-sdk-kendra/types.rb', line 1102

class BoxConfiguration < Struct.new(
  :enterprise_id,
  :secret_arn,
  :use_change_log,
  :crawl_comments,
  :crawl_tasks,
  :crawl_web_links,
  :file_field_mappings,
  :task_field_mappings,
  :comment_field_mappings,
  :web_link_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arn ⇒ String

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Box platform. The secret must contain a JSON structure with the following keys:

  • clientID—The identifier of the client OAuth 2.0 authentication application created in Box.

  • clientSecret—A set of characters known only to the OAuth 2.0 authentication application created in Box.

  • publicKeyId—The identifier of the public key contained within an identity certificate.

  • privateKey—A set of characters that make up an encryption key.

  • passphrase—A set of characters that act like a password.

You create an application in Box to generate the keys or credentials required for the secret. For more information, see [Using a Box data source].

[1]: docs.aws.amazon.com/kendra/latest/dg/data-source-box.html

Returns:

  • (String) 


1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/aws-sdk-kendra/types.rb', line 1102

class BoxConfiguration < Struct.new(
  :enterprise_id,
  :secret_arn,
  :use_change_log,
  :crawl_comments,
  :crawl_tasks,
  :crawl_web_links,
  :file_field_mappings,
  :task_field_mappings,
  :comment_field_mappings,
  :web_link_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#task_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

A list of ‘DataSourceToIndexFieldMapping` objects that map attributes or field names of Box tasks to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Box fields. For more information, see [Mapping data source fields]. The Box field names must exist in your Box custom metadata.

[1]: docs.aws.amazon.com/kendra/latest/dg/field-mapping.html

Returns:



1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/aws-sdk-kendra/types.rb', line 1102

class BoxConfiguration < Struct.new(
  :enterprise_id,
  :secret_arn,
  :use_change_log,
  :crawl_comments,
  :crawl_tasks,
  :crawl_web_links,
  :file_field_mappings,
  :task_field_mappings,
  :comment_field_mappings,
  :web_link_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#use_change_log ⇒ Boolean

‘TRUE` to use the Slack change log to determine which documents require updating in the index. Depending on the data source change log’s size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents.

Returns:

  • (Boolean) 


1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/aws-sdk-kendra/types.rb', line 1102

class BoxConfiguration < Struct.new(
  :enterprise_id,
  :secret_arn,
  :use_change_log,
  :crawl_comments,
  :crawl_tasks,
  :crawl_web_links,
  :file_field_mappings,
  :task_field_mappings,
  :comment_field_mappings,
  :web_link_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configuration ⇒ Types::DataSourceVpcConfiguration

Configuration information for an Amazon VPC to connect to your Box. For more information, see [Configuring a VPC].

[1]: docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html

Returns:



1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/aws-sdk-kendra/types.rb', line 1102

class BoxConfiguration < Struct.new(
  :enterprise_id,
  :secret_arn,
  :use_change_log,
  :crawl_comments,
  :crawl_tasks,
  :crawl_web_links,
  :file_field_mappings,
  :task_field_mappings,
  :comment_field_mappings,
  :web_link_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#web_link_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

A list of ‘DataSourceToIndexFieldMapping` objects that map attributes or field names of Box web links to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Box fields. For more information, see [Mapping data source fields]. The Box field names must exist in your Box custom metadata.

[1]: docs.aws.amazon.com/kendra/latest/dg/field-mapping.html

Returns:



1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/aws-sdk-kendra/types.rb', line 1102

class BoxConfiguration < Struct.new(
  :enterprise_id,
  :secret_arn,
  :use_change_log,
  :crawl_comments,
  :crawl_tasks,
  :crawl_web_links,
  :file_field_mappings,
  :task_field_mappings,
  :comment_field_mappings,
  :web_link_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end