AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::QBusiness::DataSource

CfnDataSource

Creates a data source connector for an Amazon Q Business application. `CreateDataSource` is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

Import

import { CfnDataSource } from 'aws-cdk-lib/aws-qbusiness';

Or use the module namespace:

import * as qbusiness from 'aws-cdk-lib/aws-qbusiness';
// qbusiness.CfnDataSource

Properties

Configuration passed to the constructor as CfnDataSourceProps.

applicationIdRequired
string

The identifier of the Amazon Q Business application the data source will be attached to.

configurationRequired
any

Use this property to specify a JSON or YAML schema with configuration properties specific to your data source connector to connect your data source repository to Amazon Q Business . You must use the JSON or YAML schema provided by Amazon Q . The following links have the configuration properties and schemas for AWS CloudFormation for the following connectors: - [Amazon Simple Storage Service](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/s3-cfn.html) - [Amazon Q Web Crawler](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/web-crawler-cfn.html) Similarly, you can find configuration templates and properties for your specific data source using the following steps: - Navigate to the [Supported connectors](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html) page in the Amazon Q Business User Guide, and select the data source connector of your choice. - Then, from that specific data source connector's page, choose the topic containing *Using CloudFormation* to find the schemas for your data source connector, including configuration parameter descriptions and examples.

displayNameRequired
string

The name of the Amazon Q Business data source.

indexIdRequired
string

The identifier of the index the data source is attached to.

descriptionOptional
string

A description for the data source connector.

documentEnrichmentConfigurationOptional
IResolvable | DocumentEnrichmentConfigurationProperty

Provides the configuration information for altering document metadata and content during the document ingestion process. For more information, see [Custom document enrichment](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html) .

mediaExtractionConfigurationOptional
IResolvable | MediaExtractionConfigurationProperty

The configuration for extracting information from media in documents.

roleArnOptional
string

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. This field is required for all connector types except custom connectors, where it is optional.

syncScheduleOptional
string

Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index. Specify a `cron-` format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the `Schedule` parameter when the `Type` parameter is set to `CUSTOM` . If you do, you receive a `ValidationException` exception.

tagsOptional
CfnTag[]

A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -

vpcConfigurationOptional
IResolvable | DataSourceVpcConfigurationProperty

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see [Using Amazon VPC with Amazon Q Business connectors](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connector-vpc.html) .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::QBusiness::DataSourceView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-qbusiness
CFN TypeAWS::QBusiness::DataSource
Properties11

Related Constructs

Explore This Service

External Links