Connecting Amazon Q Business to Confluence (Cloud) using the console - Amazon Q Business

Connecting Amazon Q Business to Confluence (Cloud) using the console

The following procedure outlines how to connect Amazon Q Business to Confluence (Cloud) using the AWS Management Console.

Connecting Amazon Q to Confluence (Cloud)

  1. Sign in to the AWS Management Console and open the Amazon Q console at https://console.aws.amazon.com/amazonq/business/.

  2. Complete the steps to create your Amazon Q application.

  3. Complete the steps for selecting an Amazon Q retriever.

  4. Then, from Data sources – Add an available data source to connect your Amazon Q application.

    You can add up to 5 data sources.

  5. Then, on the Confluence (Cloud) page, enter the following information:

  6. Name – Name your data source for easy tracking.

    Note: You can include hyphens (-) but not spaces. Maximum of 1,000 alphanumeric characters.

  7. In Source, enter the following information:

    1. In Source, for Hosting Method, choose Confluence Cloud.

    2. Confluence URL – Enter the Confluence host URLs. The format for the host URL that you enter is https://example.atlassian.net.

      Important

      If you change or update your Confluence (Cloud) data source URL, you also need to update your Secrets Manager secret to ensure a secure connection.

  8. Authorization – Amazon Q Business crawls ACL information by default to ensure responses are generated only from documents your end users have access to. See Authorization for more details.

  9. For Authentication – Choose between Basic authentication and Oauth 2.0 authentication, based on your use case.

  10. AWS Secrets Manager secret – Choose an existing secret or create a Secrets Manager secret to store your Confluence authentication credentials. If you choose to create a secret, an AWS Secrets Manager secret window opens. Enter the following information in the window:

    1. Secret name – A name for your secret.

    2. If using Basic Authentication – Enter the Secret name User name, and Password ( Confluence API token) that you generated and downloaded from your Confluence account.

      If using OAuth2.0 Authentication – Enter the Secret name, App key, App secret, Access token, and Refresh token that you created in your Confluence account.

    3. Choose Save and add secret.

  11. Configure VPC and security group – optional – Choose whether you want to use a VPC. If you do, enter the following information:

    1. Subnets – Select up to 6 repository subnets that define the subnets and IP ranges the repository instance uses in the selected VPC.

    2. VPC security groups – Choose up to 10 security groups that allow access to your data source. Ensure that the security group allows incoming traffic from Amazon EC2 instances and devices outside your VPC. For databases, security group instances are required.

    For more information, see VPC.

  12. Identity crawler – Amazon Q crawls identity information from your data source by default to ensure responses are generated only from documents end users have access to. For more information, see Identity crawler.

  13. IAM role – Choose an existing IAM role or create an IAM role to access your repository credentials and index content.

    For more information, see IAM role.

  14. In Sync scope, choose from the following options :

    1. In Sync scope, for sync contents, choose to sync from the following entity types: Pages, Page comments, Page attachments, Blogs, Blog comments, Blog attachments, Personal spaces Archived spaces, and Archived pages.

      Note

      Page comments and Page attachments can only be selected if you choose to sync Pages. Blog comments and Blog attachments can only be selected if you choose to sync Blogs.

      Important

      You can crawl Pages and Blogs from one of more specific Spaces. If you don't specify a Space key regex pattern in Additional configuration, all Pages and Blogs will be crawled by default. If no Space is specified in the filter, all spaces will be crawled.

    2. For Maximum single file size – Specify the file size limit in MBs that Amazon Q will crawl. Amazon Q will crawl only the files within the size limit you define. The default file size is 50MB. The maximum file size should be greater than 0MB and less than or equal to 50MB.

    3. In Additional configuration – optional, for Space and regex patterns, specify whether to include or exclude specific spaces, URLs, or file types in your index using the following:

      • Space key – For example, my-space-123. Select Add after entering each space key you want to add.

        Note

        If you don't specify a Space key regex pattern in Additional configuration, all Pages and Blogs will be crawled by default. If no Space is specified in the filter, all spaces will be crawled.

      • URL – For example, .*/MySite/MyDocuments/. Select Add after entering each URL you want to add.

      • File type – For example, .*\.pdf or .*\.txt. Select Add after entering each file type you want to add.

      • For Entity title regex patterns – Specify regular expression patterns to include or exclude certain Blogs, Pages, Comments, and Attachments by titles.

      Note

      If you want to crawl a specific page or subpage, you can use page title regex patterns to either include or exclude this page.

  15. For Sync mode, choose how you want to update your index when your data source content changes. When you sync your data source with Amazon Q for the first time, all content is synced by default.

    • Full sync – Sync all content regardless of the previous sync status.

    • New, modified, or deleted content sync – Sync only new, modified, and deleted documents.

  16. In Sync run schedule, for Frequency – Choose how often Amazon Q will sync with your data source. For more details, see Sync run schedule.

  17. Tags - optional – Add tags to search and filter your resources or track your AWS costs. See Tags for more details.

  18. Field mappings – A list of data source document attributes to map to your index fields. Add the fields from the Data source details page after you finish adding your data source. You can choose from two types of fields:

    1. Default – Automatically created by Amazon Q on your behalf based on common fields in your data source. You can't edit these.

    2. Custom – Automatically created by Amazon Q on your behalf based on common fields in your data source. You can edit these. You can also create and add new custom fields.

      Note

      Support for adding custom fields varies by connector. You won't see the Add field option if your connector doesn't support adding custom fields.

    For more information, see Field mappings.

  19. To finish connecting your data source to Amazon Q, select Add data source.

    You are taken to the Data source details, where you can view your data source configuration details.

  20. In Data source details, choose Sync now to allow Amazon Q to begin syncing (crawling and ingesting) data from your data source. When the sync job finishes, your data source is ready to use.

    Note

    You can also choose to view CloudWatch logs for your data source sync job by selecting View CloudWatch logs. If you get a Resource not found exception when you try to view your CloudWatch logs for a data source sync job in progress, it can be because the CloudWatch logs are not available yet. Wait for some time and check again.