Prerequisites

Before you begin, make sure that you have completed the following prerequisites.

In Confluence Server/Data Center, make sure you have:

• Copied your Confluence instance URL. For example: https://example.confluence.com. You need your Confluence instance URL to connect to Amazon Q.

• Configured basic authentication credentials containing a username (email ID used to log into Confluence) and password (Confluence Server/Data Center password) to allow Amazon Q to connect to your Confluence Server/Data Center instance. For information about how to create a Confluence API token, see Manage API tokens for your Atlassian account on the Atlassian website.

• Optional: Configured OAuth 2.0 credentials containing a Confluence app key, Confluence app secret, Confluence access token, and Confluence refresh token to allow Amazon Q to connect to your Confluence instance. If your access token expires, you can either use the refresh token to regenerate your access token and refresh token pair. Or, you can repeat the authorization process.

• Optional: Configured a Personal Access Token (PAT) containing a Confluence token to allow Amazon Q to connect to your Confluence Server/Data Center instance. For information about how to create a PAT token, see Using Personal Access Tokens on the Atlassian website.

In your AWS account, make sure you have:

• Created an IAM role for your data source and, if using the Amazon Q API, noted the ARN of the IAM role.

• Stored your Confluence (Server/Data Center) 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.