Before you begin, make sure that you have completed the following prerequisites.
In Jira, make sure you have:
-
Created Jira API token authentication credentials that include a Jira ID (email ID with domain) and a Jira credential (Jira API token). See the Atlassian documentation for information about managing API tokens
. -
Noted the Jira account URL from your Jira account settings. For example,
https://company.atlassian.net/
. -
Noted your Jira project key ID from your Jira project settings if you want to crawl only specific Jira projects.
-
If you want to have Amazon Q automatically rotate your secret, ensure that your IAM role includes the
secretsmanager:PutSecretValue
andsecretsmanager:UpdateSecret
permissions.
In your AWS account, make sure you have:
-
Created a Amazon Q Business application.
-
Created an IAM role for your data source and, if using the Amazon Q API, noted the ARN of the IAM role.
-
Stored your Jira authentication credentials in an AWS Secrets Manager secret and, if using the Amazon Q API, noted the ARN of the secret.
Note
If you’re a console user, you can create the IAM role and Secrets Manager secret as part of configuring your Amazon Q application on the console.
For a list of things to consider while configuring your data source, see Data source connector configuration best practices.
Note
For more information on connecting Jira to Amazon Q Business,
see Improve the productivity of your customer support and project management teams
using Amazon Q Business and Atlassian Jira