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

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

Overview

Note:

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

{
  saa_s_configuration: {
    organization_name: "OrganizationName", # required
    host_url: "Url", # required
  },
  on_premise_configuration: {
    host_url: "Url", # required
    organization_name: "OrganizationName", # required
    ssl_certificate_s3_path: { # required
      bucket: "S3BucketName", # required
      key: "S3ObjectKey", # required
    },
  },
  type: "SAAS", # accepts SAAS, ON_PREMISE
  secret_arn: "SecretArn", # required
  use_change_log: false,
  git_hub_document_crawl_properties: {
    crawl_repository_documents: false,
    crawl_issue: false,
    crawl_issue_comment: false,
    crawl_issue_comment_attachment: false,
    crawl_pull_request: false,
    crawl_pull_request_comment: false,
    crawl_pull_request_comment_attachment: false,
  },
  repository_filter: ["RepositoryName"],
  inclusion_folder_name_patterns: ["String"],
  inclusion_file_type_patterns: ["String"],
  inclusion_file_name_patterns: ["String"],
  exclusion_folder_name_patterns: ["String"],
  exclusion_file_type_patterns: ["String"],
  exclusion_file_name_patterns: ["String"],
  vpc_configuration: {
    subnet_ids: ["SubnetId"], # required
    security_group_ids: ["VpcSecurityGroupId"], # required
  },
  git_hub_repository_configuration_field_mappings: [
    {
      data_source_field_name: "DataSourceFieldName", # required
      date_field_format: "DataSourceDateFieldFormat",
      index_field_name: "IndexFieldName", # required
    },
  ],
  git_hub_commit_configuration_field_mappings: [
    {
      data_source_field_name: "DataSourceFieldName", # required
      date_field_format: "DataSourceDateFieldFormat",
      index_field_name: "IndexFieldName", # required
    },
  ],
  git_hub_issue_document_configuration_field_mappings: [
    {
      data_source_field_name: "DataSourceFieldName", # required
      date_field_format: "DataSourceDateFieldFormat",
      index_field_name: "IndexFieldName", # required
    },
  ],
  git_hub_issue_comment_configuration_field_mappings: [
    {
      data_source_field_name: "DataSourceFieldName", # required
      date_field_format: "DataSourceDateFieldFormat",
      index_field_name: "IndexFieldName", # required
    },
  ],
  git_hub_issue_attachment_configuration_field_mappings: [
    {
      data_source_field_name: "DataSourceFieldName", # required
      date_field_format: "DataSourceDateFieldFormat",
      index_field_name: "IndexFieldName", # required
    },
  ],
  git_hub_pull_request_comment_configuration_field_mappings: [
    {
      data_source_field_name: "DataSourceFieldName", # required
      date_field_format: "DataSourceDateFieldFormat",
      index_field_name: "IndexFieldName", # required
    },
  ],
  git_hub_pull_request_document_configuration_field_mappings: [
    {
      data_source_field_name: "DataSourceFieldName", # required
      date_field_format: "DataSourceDateFieldFormat",
      index_field_name: "IndexFieldName", # required
    },
  ],
  git_hub_pull_request_document_attachment_configuration_field_mappings: [
    {
      data_source_field_name: "DataSourceFieldName", # required
      date_field_format: "DataSourceDateFieldFormat",
      index_field_name: "IndexFieldName", # required
    },
  ],
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#exclusion_file_name_patternsArray<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>)


7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7940

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_patternsArray<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>)


7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7940

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_patternsArray<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>)


7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7940

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_mappingsArray<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.



7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7940

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_propertiesTypes::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.



7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7940

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_mappingsArray<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.



7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7940

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_mappingsArray<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.



7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7940

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_mappingsArray<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.



7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7940

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_mappingsArray<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.



7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7940

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_mappingsArray<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.



7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7940

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_mappingsArray<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.



7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7940

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_mappingsArray<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.



7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7940

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_patternsArray<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>)


7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7940

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_patternsArray<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>)


7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7940

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_patternsArray<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>)


7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7940

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_configurationTypes::OnPremiseConfiguration

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



7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7940

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_filterArray<String>

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

Returns:

  • (Array<String>)


7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7940

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_configurationTypes::SaaSConfiguration

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



7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7940

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_arnString

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:

^

Returns:

  • (String)


7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7940

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

#typeString

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

Returns:

  • (String)


7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7940

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_logBoolean

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)


7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7940

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_configurationTypes::DataSourceVpcConfiguration

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



7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7940

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