Connecting Amazon Q Business to PostgreSQL using the console - Amazon Q Business

Connecting Amazon Q Business to PostgreSQL using the console

The following procedure outlines how to connect Amazon Q Business to PostgreSQL using the AWS Management Console.

Connecting Amazon Q to PostgreSQL

  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 PostgreSQL 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. Host – Enter the database host URL.

    2. Port – Enter the database port, for example, 5432.

    3. Instance – Enter the database instance, for example postgres.

    4. Enable SSL certificate location – Choose to enter the Amazon S3 path to your SSL certificate file.

  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. In Authentication – Enter the following information for your AWS Secrets Manager secret.

    1. Secret name – A name for your secret.

    2. For Database username, and Password – Enter the authentication credential values you copied from your database.

    3. Choose Save.

  10. 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.

  11. 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.

  12. In Sync scope, enter the following information:

    • SQL query – Enter SQL query statements like SELECT and JOIN operations. SQL queries must be less than 1000 characters and not contain any semi-colons (;). Amazon Q will crawl all database content that matches your query.

    • Primary key column – Provide the primary key for the database table. This identifies the row in the table for which your SQL query is written. The connector uses the primary key column value to identify rows, detect changes, and crawl data.

    • Title column – Provide the name of the column in your database table that you want to designate as the column with document titles.

    • Body column – Provide the name of the column in your database table that you want to designate as the column with document body text.

      Your SQL query can include multiple columns in your table concatenated into a single body column with an assigned alias.

  13. In Additional configuration – optional – Configure the following settings:

    • Change-detecting columns – Enter the names of the columns that Amazon Q will use to detect content changes. Amazon Q will re-index content when there is a change in any of these columns.

    • Users' IDs column – Enter the name of the column which contains User IDs to be allowed access to content.

    • Groups column – Enter the name of the column that contains groups to be allowed access to content.

    • Source URLs column – Enter the name of the column which contains Source URLs to be indexed.

    • Time stamps column – Enter the name of the column which contains time stamps. Amazon Q uses time stamp information to detect changes in your content and sync only changed content.

    • Time zones column – Enter the name of the column which contains time zones for the content to be crawled.

    • Time stamps format – Enter the name of the column which contains time stamp formats to use to detect content changes and re-sync your content.

  14. In 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 or modified content sync – Sync only new and modified documents.

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

    For more details, see Sync mode.

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

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

  17. 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.

  18. 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.

  19. 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.