Amazonka.Kendra.Types.GitHubConfiguration

Documentation

data GitHubConfiguration

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

See: newGitHubConfiguration smart constructor.

Constructors

GitHubConfiguration'

Fields

• exclusionFileNamePatterns :: Maybe [Text]

  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 :: Maybe [Text]

  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 :: Maybe [Text]

  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 :: Maybe (NonEmpty 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 :: Maybe 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 :: Maybe (NonEmpty 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 :: Maybe (NonEmpty 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 :: Maybe (NonEmpty 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 :: Maybe (NonEmpty 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 :: Maybe (NonEmpty 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 :: Maybe (NonEmpty 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 :: Maybe (NonEmpty 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 :: Maybe [Text]

  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 :: Maybe [Text]

  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 :: Maybe [Text]

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

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

• repositoryFilter :: Maybe [Text]

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

• saaSConfiguration :: Maybe SaaSConfiguration

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

• type' :: Maybe Type

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

• useChangeLog :: Maybe Bool

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

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

• secretArn :: Text

  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.

Instances

FromJSON GitHubConfiguration

Defined in Amazonka.Kendra.Types.GitHubConfiguration

Methods

parseJSON :: Value -> Parser GitHubConfiguration

parseJSONList :: Value -> Parser [GitHubConfiguration]

ToJSON GitHubConfiguration

Defined in Amazonka.Kendra.Types.GitHubConfiguration

Methods

toJSON :: GitHubConfiguration -> Value

toEncoding :: GitHubConfiguration -> Encoding

toJSONList :: [GitHubConfiguration] -> Value

toEncodingList :: [GitHubConfiguration] -> Encoding

Generic GitHubConfiguration

Defined in Amazonka.Kendra.Types.GitHubConfiguration

Associated Types

type Rep GitHubConfiguration :: Type -> Type

Methods

from :: GitHubConfiguration -> Rep GitHubConfiguration x

to :: Rep GitHubConfiguration x -> GitHubConfiguration

Read GitHubConfiguration

Defined in Amazonka.Kendra.Types.GitHubConfiguration

Methods

readsPrec :: Int -> ReadS GitHubConfiguration

readList :: ReadS [GitHubConfiguration]

readPrec :: ReadPrec GitHubConfiguration

readListPrec :: ReadPrec [GitHubConfiguration]

Show GitHubConfiguration

Defined in Amazonka.Kendra.Types.GitHubConfiguration

Methods

showsPrec :: Int -> GitHubConfiguration -> ShowS

show :: GitHubConfiguration -> String

showList :: [GitHubConfiguration] -> ShowS

NFData GitHubConfiguration

Defined in Amazonka.Kendra.Types.GitHubConfiguration

Methods

rnf :: GitHubConfiguration -> ()

Eq GitHubConfiguration

Defined in Amazonka.Kendra.Types.GitHubConfiguration

Methods

(==) :: GitHubConfiguration -> GitHubConfiguration -> Bool

(/=) :: GitHubConfiguration -> GitHubConfiguration -> Bool

Hashable GitHubConfiguration

Defined in Amazonka.Kendra.Types.GitHubConfiguration

Methods

hashWithSalt :: Int -> GitHubConfiguration -> Int

hash :: GitHubConfiguration -> Int

type Rep GitHubConfiguration

Defined in Amazonka.Kendra.Types.GitHubConfiguration

type Rep GitHubConfiguration = D1 ('MetaData "GitHubConfiguration" "Amazonka.Kendra.Types.GitHubConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GitHubConfiguration'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "exclusionFileNamePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "exclusionFileTypePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "exclusionFolderNamePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "gitHubCommitConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: S1 ('MetaSel ('Just "gitHubDocumentCrawlProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GitHubDocumentCrawlProperties))))) :*: ((S1 ('MetaSel ('Just "gitHubIssueAttachmentConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: (S1 ('MetaSel ('Just "gitHubIssueCommentConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: S1 ('MetaSel ('Just "gitHubIssueDocumentConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))))) :*: (S1 ('MetaSel ('Just "gitHubPullRequestCommentConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: (S1 ('MetaSel ('Just "gitHubPullRequestDocumentAttachmentConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: S1 ('MetaSel ('Just "gitHubPullRequestDocumentConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))))))) :*: (((S1 ('MetaSel ('Just "gitHubRepositoryConfigurationFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :*: S1 ('MetaSel ('Just "inclusionFileNamePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "inclusionFileTypePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "inclusionFolderNamePatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "onPremiseConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OnPremiseConfiguration))))) :*: ((S1 ('MetaSel ('Just "repositoryFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "saaSConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SaaSConfiguration)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Type)))) :*: (S1 ('MetaSel ('Just "useChangeLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)) :*: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newGitHubConfiguration

Arguments

:: Text

$sel:secretArn:GitHubConfiguration'

-> GitHubConfiguration

Create a value of GitHubConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:exclusionFileNamePatterns:GitHubConfiguration', gitHubConfiguration_exclusionFileNamePatterns - 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.

$sel:exclusionFileTypePatterns:GitHubConfiguration', gitHubConfiguration_exclusionFileTypePatterns - 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.

$sel:exclusionFolderNamePatterns:GitHubConfiguration', gitHubConfiguration_exclusionFolderNamePatterns - 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.

$sel:gitHubCommitConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubCommitConfigurationFieldMappings - 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.

$sel:gitHubDocumentCrawlProperties:GitHubConfiguration', gitHubConfiguration_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.

$sel:gitHubIssueAttachmentConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubIssueAttachmentConfigurationFieldMappings - 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.

$sel:gitHubIssueCommentConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubIssueCommentConfigurationFieldMappings - 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.

$sel:gitHubIssueDocumentConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubIssueDocumentConfigurationFieldMappings - 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.

$sel:gitHubPullRequestCommentConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubPullRequestCommentConfigurationFieldMappings - 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.

$sel:gitHubPullRequestDocumentAttachmentConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubPullRequestDocumentAttachmentConfigurationFieldMappings - 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.

$sel:gitHubPullRequestDocumentConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubPullRequestDocumentConfigurationFieldMappings - 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.

$sel:gitHubRepositoryConfigurationFieldMappings:GitHubConfiguration', gitHubConfiguration_gitHubRepositoryConfigurationFieldMappings - 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.

$sel:inclusionFileNamePatterns:GitHubConfiguration', gitHubConfiguration_inclusionFileNamePatterns - 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.

$sel:inclusionFileTypePatterns:GitHubConfiguration', gitHubConfiguration_inclusionFileTypePatterns - 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.

$sel:inclusionFolderNamePatterns:GitHubConfiguration', gitHubConfiguration_inclusionFolderNamePatterns - 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.

$sel:onPremiseConfiguration:GitHubConfiguration', gitHubConfiguration_onPremiseConfiguration - Configuration information to connect to GitHub Enterprise Server (on premises).

$sel:repositoryFilter:GitHubConfiguration', gitHubConfiguration_repositoryFilter - A list of names of the specific repositories you want to index.

$sel:saaSConfiguration:GitHubConfiguration', gitHubConfiguration_saaSConfiguration - Configuration information to connect to GitHub Enterprise Cloud (SaaS).

$sel:type':GitHubConfiguration', gitHubConfiguration_type - The type of GitHub service you want to connect to—GitHub Enterprise Cloud (SaaS) or GitHub Enterprise Server (on premises).

$sel:useChangeLog:GitHubConfiguration', gitHubConfiguration_useChangeLog - 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.

$sel:vpcConfiguration:GitHubConfiguration', gitHubConfiguration_vpcConfiguration - Configuration information of an Amazon Virtual Private Cloud to connect to your GitHub. For more information, see Configuring a VPC.

$sel:secretArn:GitHubConfiguration', gitHubConfiguration_secretArn - 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.

gitHubConfiguration_exclusionFileNamePatterns :: Lens' GitHubConfiguration (Maybe [Text])

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.

gitHubConfiguration_exclusionFileTypePatterns :: Lens' GitHubConfiguration (Maybe [Text])

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.

gitHubConfiguration_exclusionFolderNamePatterns :: Lens' GitHubConfiguration (Maybe [Text])

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.

gitHubConfiguration_gitHubCommitConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty 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.

gitHubConfiguration_gitHubDocumentCrawlProperties :: Lens' GitHubConfiguration (Maybe 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.

gitHubConfiguration_gitHubIssueAttachmentConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty 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.

gitHubConfiguration_gitHubIssueCommentConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty 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.

gitHubConfiguration_gitHubIssueDocumentConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty 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.

gitHubConfiguration_gitHubPullRequestCommentConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty 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.

gitHubConfiguration_gitHubPullRequestDocumentAttachmentConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty 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.

gitHubConfiguration_gitHubPullRequestDocumentConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty 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.

gitHubConfiguration_gitHubRepositoryConfigurationFieldMappings :: Lens' GitHubConfiguration (Maybe (NonEmpty 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.

gitHubConfiguration_inclusionFileNamePatterns :: Lens' GitHubConfiguration (Maybe [Text])

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.

gitHubConfiguration_inclusionFileTypePatterns :: Lens' GitHubConfiguration (Maybe [Text])

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.

gitHubConfiguration_inclusionFolderNamePatterns :: Lens' GitHubConfiguration (Maybe [Text])

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.

gitHubConfiguration_onPremiseConfiguration :: Lens' GitHubConfiguration (Maybe OnPremiseConfiguration)

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

gitHubConfiguration_repositoryFilter :: Lens' GitHubConfiguration (Maybe [Text])

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

gitHubConfiguration_saaSConfiguration :: Lens' GitHubConfiguration (Maybe SaaSConfiguration)

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

gitHubConfiguration_type :: Lens' GitHubConfiguration (Maybe Type)

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

gitHubConfiguration_useChangeLog :: Lens' GitHubConfiguration (Maybe Bool)

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.

gitHubConfiguration_vpcConfiguration :: Lens' GitHubConfiguration (Maybe DataSourceVpcConfiguration)

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

gitHubConfiguration_secretArn :: Lens' GitHubConfiguration Text

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.