Using a Jira data source - Amazon Kendra

Using a Jira data source

You can use your Jira documents as a data source for Amazon Kendra. To use Jira in the console, go to the Amazon Kendra console, select your index and then select Data sources from the navigation menu to add Jira.

When you connect to Jira to index your documents, you specify the Jira account URL. You can find your Jira account URL in the URL of your profile page for Jira desktop. For example, You can specify what type of content to crawl in your Jira index. You can specify from the following types of content: statuses, additional elements, issue types, change logs, and regex patterns. You can specify regular expression patterns to include or exclude attached files in your Jira data source.

Create an index before you create the Jira data source. For more information, see Creating an index. You provide the ID of the index when you create the data source.

To connect to Jira, you specify the connection and other information in the console or by using the JiraConfiguration object. You provide the Jira account URL of the Jira desktop that you want to index.

Before you can index your documents and messages from your Jira data source, you must specify which Jira Project IDs to crawl. If you leave a Jira account URL, the content is still searchable in Amazon Kendra, just as it's still searchable in Jira.

You also must provide the Amazon Resource Name (ARN) of an IAM role that gives permission to access your Jira data source. You provide the ARN of an IAM role using the CreateDataSource API. For more information on permissions, see IAM roles for Jira data sources.

Amazon Kendra requires authentication credentials to access your Jira data source. You store your Jira credentials in an Secrets Manager secret. The credentials are your Jira ID and Jira password. If you are using the Amazon Kendra console to create your data source, you can create the secret while creating the data source. You can also use an existing Secrets Manager secret. If you are using the API to create your data source, you must provide the Amazon Resource Name (ARN) of an existing secret.

The credentials are stored as a JSON string in the Secrets Manager secret.

{ "jira-id": "jira-id", "jiraCredential": "jiraCredential" }

Amazon Kendra crawls user information from Jira projects. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. For more information, see User context filtering for Jira projects.

You also can add the following optional information:

  • Whether Amazon Kendra should use the Jira change log mechanism to determine if content needs to be updated in the index. Use the change log if you don't want Amazon Kendra to scan all of the documents. If your change log is large, it may take Amazon Kendra less time to scan the documents in the Jira data source than to process the change log. If you are syncing your Jira data source with your index for the first time, all documents are scanned.

  • Change log updates your index only if new Jira content was added since the last time you synced your data.

  • Inclusion or exclusion pattern: If you specify an inclusion pattern, any attached file name or type that does not match the pattern is not indexed. If you specify an inclusion and exclusion pattern, files that match the exclusion pattern are not indexed even if they match the inclusion pattern.

  • Field mappings that map your Jira fields to Amazon Kendra index fields. For more information, see Mapping data source fields.