Class: Aws::Kendra::Types::GitHubConfiguration

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

Overview

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

<note markdown=“1”> Amazon Kendra now supports an upgraded GitHub connector.

You must now use the [TemplateConfiguration][1] object instead of the

‘GitHubConfiguration` object to configure your connector.

Connectors configured using the older console and API architecture

will continue to function as configured. However, you won’t be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.

We recommended migrating your connector workflow to the upgraded

version. Support for connectors configured using the older architecture is scheduled to end by June 2024.

</note>

[1]: docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#exclusion_file_name_patterns ⇒ Array<String>

A list of regular expression patterns to exclude certain file names in your GitHub repository or repositories. File names that match the patterns are excluded from the index. File names that don’t match the patterns are included in the index. If a file matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.

Returns:

  • (Array<String>) 


6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
 
# File 'lib/aws-sdk-kendra/types.rb', line 6145

class GitHubConfiguration < Struct.new(
  :saa_s_configuration,
  :on_premise_configuration,
  :type,
  :secret_arn,
  :use_change_log,
  :git_hub_document_crawl_properties,
  :repository_filter,
  :inclusion_folder_name_patterns,
  :inclusion_file_type_patterns,
  :inclusion_file_name_patterns,
  :exclusion_folder_name_patterns,
  :exclusion_file_type_patterns,
  :exclusion_file_name_patterns,
  :vpc_configuration,
  :git_hub_repository_configuration_field_mappings,
  :git_hub_commit_configuration_field_mappings,
  :git_hub_issue_document_configuration_field_mappings,
  :git_hub_issue_comment_configuration_field_mappings,
  :git_hub_issue_attachment_configuration_field_mappings,
  :git_hub_pull_request_comment_configuration_field_mappings,
  :git_hub_pull_request_document_configuration_field_mappings,
  :git_hub_pull_request_document_attachment_configuration_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#exclusion_file_type_patterns ⇒ Array<String>

A list of regular expression patterns to exclude certain file types in your GitHub repository or repositories. File types that match the patterns are excluded from the index. File types that don’t match the patterns are included in the index. If a file matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.

Returns:

  • (Array<String>) 


6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
 
# File 'lib/aws-sdk-kendra/types.rb', line 6145

class GitHubConfiguration < Struct.new(
  :saa_s_configuration,
  :on_premise_configuration,
  :type,
  :secret_arn,
  :use_change_log,
  :git_hub_document_crawl_properties,
  :repository_filter,
  :inclusion_folder_name_patterns,
  :inclusion_file_type_patterns,
  :inclusion_file_name_patterns,
  :exclusion_folder_name_patterns,
  :exclusion_file_type_patterns,
  :exclusion_file_name_patterns,
  :vpc_configuration,
  :git_hub_repository_configuration_field_mappings,
  :git_hub_commit_configuration_field_mappings,
  :git_hub_issue_document_configuration_field_mappings,
  :git_hub_issue_comment_configuration_field_mappings,
  :git_hub_issue_attachment_configuration_field_mappings,
  :git_hub_pull_request_comment_configuration_field_mappings,
  :git_hub_pull_request_document_configuration_field_mappings,
  :git_hub_pull_request_document_attachment_configuration_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#exclusion_folder_name_patterns ⇒ Array<String>

A list of regular expression patterns to exclude certain folder names in your GitHub repository or repositories. Folder names that match the patterns are excluded from the index. Folder names that don’t match the patterns are included in the index. If a folder matches both an exclusion and inclusion pattern, the exclusion pattern takes precedence and the folder isn’t included in the index.

Returns:

  • (Array<String>) 


6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
 
# File 'lib/aws-sdk-kendra/types.rb', line 6145

class GitHubConfiguration < Struct.new(
  :saa_s_configuration,
  :on_premise_configuration,
  :type,
  :secret_arn,
  :use_change_log,
  :git_hub_document_crawl_properties,
  :repository_filter,
  :inclusion_folder_name_patterns,
  :inclusion_file_type_patterns,
  :inclusion_file_name_patterns,
  :exclusion_folder_name_patterns,
  :exclusion_file_type_patterns,
  :exclusion_file_name_patterns,
  :vpc_configuration,
  :git_hub_repository_configuration_field_mappings,
  :git_hub_commit_configuration_field_mappings,
  :git_hub_issue_document_configuration_field_mappings,
  :git_hub_issue_comment_configuration_field_mappings,
  :git_hub_issue_attachment_configuration_field_mappings,
  :git_hub_pull_request_comment_configuration_field_mappings,
  :git_hub_pull_request_document_configuration_field_mappings,
  :git_hub_pull_request_document_attachment_configuration_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#git_hub_commit_configuration_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

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

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

Returns:



6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
 
# File 'lib/aws-sdk-kendra/types.rb', line 6145

class GitHubConfiguration < Struct.new(
  :saa_s_configuration,
  :on_premise_configuration,
  :type,
  :secret_arn,
  :use_change_log,
  :git_hub_document_crawl_properties,
  :repository_filter,
  :inclusion_folder_name_patterns,
  :inclusion_file_type_patterns,
  :inclusion_file_name_patterns,
  :exclusion_folder_name_patterns,
  :exclusion_file_type_patterns,
  :exclusion_file_name_patterns,
  :vpc_configuration,
  :git_hub_repository_configuration_field_mappings,
  :git_hub_commit_configuration_field_mappings,
  :git_hub_issue_document_configuration_field_mappings,
  :git_hub_issue_comment_configuration_field_mappings,
  :git_hub_issue_attachment_configuration_field_mappings,
  :git_hub_pull_request_comment_configuration_field_mappings,
  :git_hub_pull_request_document_configuration_field_mappings,
  :git_hub_pull_request_document_attachment_configuration_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#git_hub_document_crawl_properties ⇒ Types::GitHubDocumentCrawlProperties

Configuration information to include certain types of GitHub content. You can configure to index repository files only, or also include issues and pull requests, comments, and comment attachments.

Returns:



6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
 
# File 'lib/aws-sdk-kendra/types.rb', line 6145

class GitHubConfiguration < Struct.new(
  :saa_s_configuration,
  :on_premise_configuration,
  :type,
  :secret_arn,
  :use_change_log,
  :git_hub_document_crawl_properties,
  :repository_filter,
  :inclusion_folder_name_patterns,
  :inclusion_file_type_patterns,
  :inclusion_file_name_patterns,
  :exclusion_folder_name_patterns,
  :exclusion_file_type_patterns,
  :exclusion_file_name_patterns,
  :vpc_configuration,
  :git_hub_repository_configuration_field_mappings,
  :git_hub_commit_configuration_field_mappings,
  :git_hub_issue_document_configuration_field_mappings,
  :git_hub_issue_comment_configuration_field_mappings,
  :git_hub_issue_attachment_configuration_field_mappings,
  :git_hub_pull_request_comment_configuration_field_mappings,
  :git_hub_pull_request_document_configuration_field_mappings,
  :git_hub_pull_request_document_attachment_configuration_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#git_hub_issue_attachment_configuration_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

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

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

Returns:



6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
 
# File 'lib/aws-sdk-kendra/types.rb', line 6145

class GitHubConfiguration < Struct.new(
  :saa_s_configuration,
  :on_premise_configuration,
  :type,
  :secret_arn,
  :use_change_log,
  :git_hub_document_crawl_properties,
  :repository_filter,
  :inclusion_folder_name_patterns,
  :inclusion_file_type_patterns,
  :inclusion_file_name_patterns,
  :exclusion_folder_name_patterns,
  :exclusion_file_type_patterns,
  :exclusion_file_name_patterns,
  :vpc_configuration,
  :git_hub_repository_configuration_field_mappings,
  :git_hub_commit_configuration_field_mappings,
  :git_hub_issue_document_configuration_field_mappings,
  :git_hub_issue_comment_configuration_field_mappings,
  :git_hub_issue_attachment_configuration_field_mappings,
  :git_hub_pull_request_comment_configuration_field_mappings,
  :git_hub_pull_request_document_configuration_field_mappings,
  :git_hub_pull_request_document_attachment_configuration_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#git_hub_issue_comment_configuration_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

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

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

Returns:



6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
 
# File 'lib/aws-sdk-kendra/types.rb', line 6145

class GitHubConfiguration < Struct.new(
  :saa_s_configuration,
  :on_premise_configuration,
  :type,
  :secret_arn,
  :use_change_log,
  :git_hub_document_crawl_properties,
  :repository_filter,
  :inclusion_folder_name_patterns,
  :inclusion_file_type_patterns,
  :inclusion_file_name_patterns,
  :exclusion_folder_name_patterns,
  :exclusion_file_type_patterns,
  :exclusion_file_name_patterns,
  :vpc_configuration,
  :git_hub_repository_configuration_field_mappings,
  :git_hub_commit_configuration_field_mappings,
  :git_hub_issue_document_configuration_field_mappings,
  :git_hub_issue_comment_configuration_field_mappings,
  :git_hub_issue_attachment_configuration_field_mappings,
  :git_hub_pull_request_comment_configuration_field_mappings,
  :git_hub_pull_request_document_configuration_field_mappings,
  :git_hub_pull_request_document_attachment_configuration_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#git_hub_issue_document_configuration_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

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

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

Returns:



6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
 
# File 'lib/aws-sdk-kendra/types.rb', line 6145

class GitHubConfiguration < Struct.new(
  :saa_s_configuration,
  :on_premise_configuration,
  :type,
  :secret_arn,
  :use_change_log,
  :git_hub_document_crawl_properties,
  :repository_filter,
  :inclusion_folder_name_patterns,
  :inclusion_file_type_patterns,
  :inclusion_file_name_patterns,
  :exclusion_folder_name_patterns,
  :exclusion_file_type_patterns,
  :exclusion_file_name_patterns,
  :vpc_configuration,
  :git_hub_repository_configuration_field_mappings,
  :git_hub_commit_configuration_field_mappings,
  :git_hub_issue_document_configuration_field_mappings,
  :git_hub_issue_comment_configuration_field_mappings,
  :git_hub_issue_attachment_configuration_field_mappings,
  :git_hub_pull_request_comment_configuration_field_mappings,
  :git_hub_pull_request_document_configuration_field_mappings,
  :git_hub_pull_request_document_attachment_configuration_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#git_hub_pull_request_comment_configuration_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

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

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

Returns:



6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
 
# File 'lib/aws-sdk-kendra/types.rb', line 6145

class GitHubConfiguration < Struct.new(
  :saa_s_configuration,
  :on_premise_configuration,
  :type,
  :secret_arn,
  :use_change_log,
  :git_hub_document_crawl_properties,
  :repository_filter,
  :inclusion_folder_name_patterns,
  :inclusion_file_type_patterns,
  :inclusion_file_name_patterns,
  :exclusion_folder_name_patterns,
  :exclusion_file_type_patterns,
  :exclusion_file_name_patterns,
  :vpc_configuration,
  :git_hub_repository_configuration_field_mappings,
  :git_hub_commit_configuration_field_mappings,
  :git_hub_issue_document_configuration_field_mappings,
  :git_hub_issue_comment_configuration_field_mappings,
  :git_hub_issue_attachment_configuration_field_mappings,
  :git_hub_pull_request_comment_configuration_field_mappings,
  :git_hub_pull_request_document_configuration_field_mappings,
  :git_hub_pull_request_document_attachment_configuration_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#git_hub_pull_request_document_attachment_configuration_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

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

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

Returns:



6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
 
# File 'lib/aws-sdk-kendra/types.rb', line 6145

class GitHubConfiguration < Struct.new(
  :saa_s_configuration,
  :on_premise_configuration,
  :type,
  :secret_arn,
  :use_change_log,
  :git_hub_document_crawl_properties,
  :repository_filter,
  :inclusion_folder_name_patterns,
  :inclusion_file_type_patterns,
  :inclusion_file_name_patterns,
  :exclusion_folder_name_patterns,
  :exclusion_file_type_patterns,
  :exclusion_file_name_patterns,
  :vpc_configuration,
  :git_hub_repository_configuration_field_mappings,
  :git_hub_commit_configuration_field_mappings,
  :git_hub_issue_document_configuration_field_mappings,
  :git_hub_issue_comment_configuration_field_mappings,
  :git_hub_issue_attachment_configuration_field_mappings,
  :git_hub_pull_request_comment_configuration_field_mappings,
  :git_hub_pull_request_document_configuration_field_mappings,
  :git_hub_pull_request_document_attachment_configuration_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#git_hub_pull_request_document_configuration_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

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

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

Returns:



6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
 
# File 'lib/aws-sdk-kendra/types.rb', line 6145

class GitHubConfiguration < Struct.new(
  :saa_s_configuration,
  :on_premise_configuration,
  :type,
  :secret_arn,
  :use_change_log,
  :git_hub_document_crawl_properties,
  :repository_filter,
  :inclusion_folder_name_patterns,
  :inclusion_file_type_patterns,
  :inclusion_file_name_patterns,
  :exclusion_folder_name_patterns,
  :exclusion_file_type_patterns,
  :exclusion_file_name_patterns,
  :vpc_configuration,
  :git_hub_repository_configuration_field_mappings,
  :git_hub_commit_configuration_field_mappings,
  :git_hub_issue_document_configuration_field_mappings,
  :git_hub_issue_comment_configuration_field_mappings,
  :git_hub_issue_attachment_configuration_field_mappings,
  :git_hub_pull_request_comment_configuration_field_mappings,
  :git_hub_pull_request_document_configuration_field_mappings,
  :git_hub_pull_request_document_attachment_configuration_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#git_hub_repository_configuration_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

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

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

Returns:



6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
 
# File 'lib/aws-sdk-kendra/types.rb', line 6145

class GitHubConfiguration < Struct.new(
  :saa_s_configuration,
  :on_premise_configuration,
  :type,
  :secret_arn,
  :use_change_log,
  :git_hub_document_crawl_properties,
  :repository_filter,
  :inclusion_folder_name_patterns,
  :inclusion_file_type_patterns,
  :inclusion_file_name_patterns,
  :exclusion_folder_name_patterns,
  :exclusion_file_type_patterns,
  :exclusion_file_name_patterns,
  :vpc_configuration,
  :git_hub_repository_configuration_field_mappings,
  :git_hub_commit_configuration_field_mappings,
  :git_hub_issue_document_configuration_field_mappings,
  :git_hub_issue_comment_configuration_field_mappings,
  :git_hub_issue_attachment_configuration_field_mappings,
  :git_hub_pull_request_comment_configuration_field_mappings,
  :git_hub_pull_request_document_configuration_field_mappings,
  :git_hub_pull_request_document_attachment_configuration_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#inclusion_file_name_patterns ⇒ Array<String>

A list of regular expression patterns to include certain file names in your GitHub repository or repositories. File names that match the patterns are included in the index. File names that don’t match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.

Returns:

  • (Array<String>) 


6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
 
# File 'lib/aws-sdk-kendra/types.rb', line 6145

class GitHubConfiguration < Struct.new(
  :saa_s_configuration,
  :on_premise_configuration,
  :type,
  :secret_arn,
  :use_change_log,
  :git_hub_document_crawl_properties,
  :repository_filter,
  :inclusion_folder_name_patterns,
  :inclusion_file_type_patterns,
  :inclusion_file_name_patterns,
  :exclusion_folder_name_patterns,
  :exclusion_file_type_patterns,
  :exclusion_file_name_patterns,
  :vpc_configuration,
  :git_hub_repository_configuration_field_mappings,
  :git_hub_commit_configuration_field_mappings,
  :git_hub_issue_document_configuration_field_mappings,
  :git_hub_issue_comment_configuration_field_mappings,
  :git_hub_issue_attachment_configuration_field_mappings,
  :git_hub_pull_request_comment_configuration_field_mappings,
  :git_hub_pull_request_document_configuration_field_mappings,
  :git_hub_pull_request_document_attachment_configuration_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#inclusion_file_type_patterns ⇒ Array<String>

A list of regular expression patterns to include certain file types in your GitHub repository or repositories. File types that match the patterns are included in the index. File types that don’t match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.

Returns:

  • (Array<String>) 


6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
 
# File 'lib/aws-sdk-kendra/types.rb', line 6145

class GitHubConfiguration < Struct.new(
  :saa_s_configuration,
  :on_premise_configuration,
  :type,
  :secret_arn,
  :use_change_log,
  :git_hub_document_crawl_properties,
  :repository_filter,
  :inclusion_folder_name_patterns,
  :inclusion_file_type_patterns,
  :inclusion_file_name_patterns,
  :exclusion_folder_name_patterns,
  :exclusion_file_type_patterns,
  :exclusion_file_name_patterns,
  :vpc_configuration,
  :git_hub_repository_configuration_field_mappings,
  :git_hub_commit_configuration_field_mappings,
  :git_hub_issue_document_configuration_field_mappings,
  :git_hub_issue_comment_configuration_field_mappings,
  :git_hub_issue_attachment_configuration_field_mappings,
  :git_hub_pull_request_comment_configuration_field_mappings,
  :git_hub_pull_request_document_configuration_field_mappings,
  :git_hub_pull_request_document_attachment_configuration_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#inclusion_folder_name_patterns ⇒ Array<String>

A list of regular expression patterns to include certain folder names in your GitHub repository or repositories. Folder names that match the patterns are included in the index. Folder names that don’t match the patterns are excluded from the index. If a folder matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the folder isn’t included in the index.

Returns:

  • (Array<String>) 


6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
 
# File 'lib/aws-sdk-kendra/types.rb', line 6145

class GitHubConfiguration < Struct.new(
  :saa_s_configuration,
  :on_premise_configuration,
  :type,
  :secret_arn,
  :use_change_log,
  :git_hub_document_crawl_properties,
  :repository_filter,
  :inclusion_folder_name_patterns,
  :inclusion_file_type_patterns,
  :inclusion_file_name_patterns,
  :exclusion_folder_name_patterns,
  :exclusion_file_type_patterns,
  :exclusion_file_name_patterns,
  :vpc_configuration,
  :git_hub_repository_configuration_field_mappings,
  :git_hub_commit_configuration_field_mappings,
  :git_hub_issue_document_configuration_field_mappings,
  :git_hub_issue_comment_configuration_field_mappings,
  :git_hub_issue_attachment_configuration_field_mappings,
  :git_hub_pull_request_comment_configuration_field_mappings,
  :git_hub_pull_request_document_configuration_field_mappings,
  :git_hub_pull_request_document_attachment_configuration_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#on_premise_configuration ⇒ Types::OnPremiseConfiguration

Configuration information to connect to GitHub Enterprise Server (on premises).

Returns:



6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
 
# File 'lib/aws-sdk-kendra/types.rb', line 6145

class GitHubConfiguration < Struct.new(
  :saa_s_configuration,
  :on_premise_configuration,
  :type,
  :secret_arn,
  :use_change_log,
  :git_hub_document_crawl_properties,
  :repository_filter,
  :inclusion_folder_name_patterns,
  :inclusion_file_type_patterns,
  :inclusion_file_name_patterns,
  :exclusion_folder_name_patterns,
  :exclusion_file_type_patterns,
  :exclusion_file_name_patterns,
  :vpc_configuration,
  :git_hub_repository_configuration_field_mappings,
  :git_hub_commit_configuration_field_mappings,
  :git_hub_issue_document_configuration_field_mappings,
  :git_hub_issue_comment_configuration_field_mappings,
  :git_hub_issue_attachment_configuration_field_mappings,
  :git_hub_pull_request_comment_configuration_field_mappings,
  :git_hub_pull_request_document_configuration_field_mappings,
  :git_hub_pull_request_document_attachment_configuration_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#repository_filter ⇒ Array<String>

A list of names of the specific repositories you want to index.

Returns:

  • (Array<String>) 


6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
 
# File 'lib/aws-sdk-kendra/types.rb', line 6145

class GitHubConfiguration < Struct.new(
  :saa_s_configuration,
  :on_premise_configuration,
  :type,
  :secret_arn,
  :use_change_log,
  :git_hub_document_crawl_properties,
  :repository_filter,
  :inclusion_folder_name_patterns,
  :inclusion_file_type_patterns,
  :inclusion_file_name_patterns,
  :exclusion_folder_name_patterns,
  :exclusion_file_type_patterns,
  :exclusion_file_name_patterns,
  :vpc_configuration,
  :git_hub_repository_configuration_field_mappings,
  :git_hub_commit_configuration_field_mappings,
  :git_hub_issue_document_configuration_field_mappings,
  :git_hub_issue_comment_configuration_field_mappings,
  :git_hub_issue_attachment_configuration_field_mappings,
  :git_hub_pull_request_comment_configuration_field_mappings,
  :git_hub_pull_request_document_configuration_field_mappings,
  :git_hub_pull_request_document_attachment_configuration_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#saa_s_configuration ⇒ Types::SaaSConfiguration

Configuration information to connect to GitHub Enterprise Cloud (SaaS).

Returns:



6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
 
# File 'lib/aws-sdk-kendra/types.rb', line 6145

class GitHubConfiguration < Struct.new(
  :saa_s_configuration,
  :on_premise_configuration,
  :type,
  :secret_arn,
  :use_change_log,
  :git_hub_document_crawl_properties,
  :repository_filter,
  :inclusion_folder_name_patterns,
  :inclusion_file_type_patterns,
  :inclusion_file_name_patterns,
  :exclusion_folder_name_patterns,
  :exclusion_file_type_patterns,
  :exclusion_file_name_patterns,
  :vpc_configuration,
  :git_hub_repository_configuration_field_mappings,
  :git_hub_commit_configuration_field_mappings,
  :git_hub_issue_document_configuration_field_mappings,
  :git_hub_issue_comment_configuration_field_mappings,
  :git_hub_issue_attachment_configuration_field_mappings,
  :git_hub_pull_request_comment_configuration_field_mappings,
  :git_hub_pull_request_document_configuration_field_mappings,
  :git_hub_pull_request_document_attachment_configuration_field_mappings)
  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 GitHub. The secret must contain a JSON structure with the following keys:

  • personalToken—The access token created in GitHub. For more information on creating a token in GitHub, see [Using a GitHub data source].

^

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

Returns:

  • (String) 


6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
 
# File 'lib/aws-sdk-kendra/types.rb', line 6145

class GitHubConfiguration < Struct.new(
  :saa_s_configuration,
  :on_premise_configuration,
  :type,
  :secret_arn,
  :use_change_log,
  :git_hub_document_crawl_properties,
  :repository_filter,
  :inclusion_folder_name_patterns,
  :inclusion_file_type_patterns,
  :inclusion_file_name_patterns,
  :exclusion_folder_name_patterns,
  :exclusion_file_type_patterns,
  :exclusion_file_name_patterns,
  :vpc_configuration,
  :git_hub_repository_configuration_field_mappings,
  :git_hub_commit_configuration_field_mappings,
  :git_hub_issue_document_configuration_field_mappings,
  :git_hub_issue_comment_configuration_field_mappings,
  :git_hub_issue_attachment_configuration_field_mappings,
  :git_hub_pull_request_comment_configuration_field_mappings,
  :git_hub_pull_request_document_configuration_field_mappings,
  :git_hub_pull_request_document_attachment_configuration_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of GitHub service you want to connect to—GitHub Enterprise Cloud (SaaS) or GitHub Enterprise Server (on premises).

Returns:

  • (String) 


6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
 
# File 'lib/aws-sdk-kendra/types.rb', line 6145

class GitHubConfiguration < Struct.new(
  :saa_s_configuration,
  :on_premise_configuration,
  :type,
  :secret_arn,
  :use_change_log,
  :git_hub_document_crawl_properties,
  :repository_filter,
  :inclusion_folder_name_patterns,
  :inclusion_file_type_patterns,
  :inclusion_file_name_patterns,
  :exclusion_folder_name_patterns,
  :exclusion_file_type_patterns,
  :exclusion_file_name_patterns,
  :vpc_configuration,
  :git_hub_repository_configuration_field_mappings,
  :git_hub_commit_configuration_field_mappings,
  :git_hub_issue_document_configuration_field_mappings,
  :git_hub_issue_comment_configuration_field_mappings,
  :git_hub_issue_attachment_configuration_field_mappings,
  :git_hub_pull_request_comment_configuration_field_mappings,
  :git_hub_pull_request_document_configuration_field_mappings,
  :git_hub_pull_request_document_attachment_configuration_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#use_change_log ⇒ Boolean

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

Returns:

  • (Boolean) 


6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
 
# File 'lib/aws-sdk-kendra/types.rb', line 6145

class GitHubConfiguration < Struct.new(
  :saa_s_configuration,
  :on_premise_configuration,
  :type,
  :secret_arn,
  :use_change_log,
  :git_hub_document_crawl_properties,
  :repository_filter,
  :inclusion_folder_name_patterns,
  :inclusion_file_type_patterns,
  :inclusion_file_name_patterns,
  :exclusion_folder_name_patterns,
  :exclusion_file_type_patterns,
  :exclusion_file_name_patterns,
  :vpc_configuration,
  :git_hub_repository_configuration_field_mappings,
  :git_hub_commit_configuration_field_mappings,
  :git_hub_issue_document_configuration_field_mappings,
  :git_hub_issue_comment_configuration_field_mappings,
  :git_hub_issue_attachment_configuration_field_mappings,
  :git_hub_pull_request_comment_configuration_field_mappings,
  :git_hub_pull_request_document_configuration_field_mappings,
  :git_hub_pull_request_document_attachment_configuration_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configuration ⇒ Types::DataSourceVpcConfiguration

Configuration information of an Amazon Virtual Private Cloud to connect to your GitHub. For more information, see [Configuring a VPC].

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

Returns:



6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
 
# File 'lib/aws-sdk-kendra/types.rb', line 6145

class GitHubConfiguration < Struct.new(
  :saa_s_configuration,
  :on_premise_configuration,
  :type,
  :secret_arn,
  :use_change_log,
  :git_hub_document_crawl_properties,
  :repository_filter,
  :inclusion_folder_name_patterns,
  :inclusion_file_type_patterns,
  :inclusion_file_name_patterns,
  :exclusion_folder_name_patterns,
  :exclusion_file_type_patterns,
  :exclusion_file_name_patterns,
  :vpc_configuration,
  :git_hub_repository_configuration_field_mappings,
  :git_hub_commit_configuration_field_mappings,
  :git_hub_issue_document_configuration_field_mappings,
  :git_hub_issue_comment_configuration_field_mappings,
  :git_hub_issue_attachment_configuration_field_mappings,
  :git_hub_pull_request_comment_configuration_field_mappings,
  :git_hub_pull_request_document_configuration_field_mappings,
  :git_hub_pull_request_document_attachment_configuration_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end