kendra/aws.sdk.kotlin.services.kendra.model/GitHubConfiguration/Builder

Builder

Properties

var exclusionFileNamePatterns: List<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.

exclusionFileTypePatterns

var exclusionFileTypePatterns: List<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.

exclusionFolderNamePatterns

var exclusionFolderNamePatterns: List<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.

gitHubCommitConfigurationFieldMappings

var gitHubCommitConfigurationFieldMappings: List<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.

gitHubDocumentCrawlProperties

var gitHubDocumentCrawlProperties: 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.

gitHubIssueAttachmentConfigurationFieldMappings

var gitHubIssueAttachmentConfigurationFieldMappings: List<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.

gitHubIssueCommentConfigurationFieldMappings

var gitHubIssueCommentConfigurationFieldMappings: List<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.

gitHubIssueDocumentConfigurationFieldMappings

var gitHubIssueDocumentConfigurationFieldMappings: List<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.

gitHubPullRequestCommentConfigurationFieldMappings

var gitHubPullRequestCommentConfigurationFieldMappings: List<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.

gitHubPullRequestDocumentAttachmentConfigurationFieldMappings

var gitHubPullRequestDocumentAttachmentConfigurationFieldMappings: List<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.

gitHubPullRequestDocumentConfigurationFieldMappings

var gitHubPullRequestDocumentConfigurationFieldMappings: List<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.

gitHubRepositoryConfigurationFieldMappings

var gitHubRepositoryConfigurationFieldMappings: List<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.

inclusionFileNamePatterns

var inclusionFileNamePatterns: List<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.

inclusionFileTypePatterns

var inclusionFileTypePatterns: List<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.

inclusionFolderNamePatterns

var inclusionFolderNamePatterns: List<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.

onPremiseConfiguration

var onPremiseConfiguration: OnPremiseConfiguration?

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

repositoryFilter

var repositoryFilter: List<String>?

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

saaSConfiguration

var saaSConfiguration: SaaSConfiguration?

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

secretArn

var secretArn: 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:

type

var type: Type?

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

useChangeLog

var useChangeLog: 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.

vpcConfiguration

var vpcConfiguration: DataSourceVpcConfiguration?

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

Functions

gitHubDocumentCrawlProperties

fun gitHubDocumentCrawlProperties(block: GitHubDocumentCrawlProperties.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.kendra.model.GitHubDocumentCrawlProperties inside the given block

onPremiseConfiguration

fun onPremiseConfiguration(block: OnPremiseConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.kendra.model.OnPremiseConfiguration inside the given block

saaSConfiguration

fun saaSConfiguration(block: SaaSConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.kendra.model.SaaSConfiguration inside the given block

vpcConfiguration

fun vpcConfiguration(block: DataSourceVpcConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.kendra.model.DataSourceVpcConfiguration inside the given block