GitHub (Cloud) connector overview - Amazon Q Business

GitHub (Cloud) connector overview

The following table gives an overview of the Amazon Q Business GitHub (Cloud) connector and its supported features.

Category Feature Support
Security Authentication type Personal token, OAuth token
Authentication credentials

  • GitHub (Cloud) token
Access Control List (ACL) crawling Yes. For more information, see ACL crawling.
Identity crawling Yes
VPC Yes
Crawl features Entities Yes. The following entities are supported:

  • Repository

  • Repository Commit

  • Issue Document

  • Issue Comment

  • Issue Attachment

  • Pull Request Comment

  • Pull request Document

  • Pull Request Attachment

See What is a document? for more details on what each connector crawls as a document.
Field mappings Yes. Supports default and custom field mappings. For more information, see Field mappings.
Filters Yes. The following filters are supported:

  • Include select repositories

  • Include content by specific entities.

  • Include specific branched by name

  • Include/exclude content by file name, file type, and file path
Sync mode Supports full and incremental sync.
File types Supports all files supported by Amazon Q.