AWS::QBusiness::DataSource

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::QBusiness::DataSource",
  "Properties" : {
      "ApplicationId" : String,
      "Configuration" : ,
      "Description" : String,
      "DisplayName" : String,
      "DocumentEnrichmentConfiguration" : DocumentEnrichmentConfiguration,
      "IndexId" : String,
      "MediaExtractionConfiguration" : MediaExtractionConfiguration,
      "RoleArn" : String,
      "SyncSchedule" : String,
      "Tags" : [ Tag, ... ],
      "VpcConfiguration" : DataSourceVpcConfiguration
    }
}

YAML

Type: AWS::QBusiness::DataSource
Properties:
  ApplicationId: String
  Configuration: 
    
  Description: String
  DisplayName: String
  DocumentEnrichmentConfiguration: 
    DocumentEnrichmentConfiguration
  IndexId: String
  MediaExtractionConfiguration: 
    MediaExtractionConfiguration
  RoleArn: String
  SyncSchedule: String
  Tags: 
    - Tag
  VpcConfiguration: 
    DataSourceVpcConfiguration

Properties

ApplicationId

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

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$

Minimum: 36

Maximum: 36

Update requires: Replacement

Configuration

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

• Amazon Q Web Crawler

Similarly, you can find configuration templates and properties for your specific data source using the following steps:

1. Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source connector of your choice.

2. Then, from that specific data source connector's page, choose the topic containing Using AWS CloudFormation to find the schemas for your data source connector, including configuration parameter descriptions and examples.

Required: Yes

Type:

Update requires: No interruption

Description

A description for the data source connector.

Required: No

Type: String

Pattern: ^[\s\S]*$

Minimum: 0

Maximum: 1000

Update requires: No interruption

DisplayName

The name of the Amazon Q Business data source.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$

Minimum: 1

Maximum: 1000

Update requires: No interruption

DocumentEnrichmentConfiguration

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Custom document enrichment.

Required: No

Type: DocumentEnrichmentConfiguration

Update requires: No interruption

IndexId

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

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$

Minimum: 36

Maximum: 36

Update requires: Replacement

MediaExtractionConfiguration

The configuration for extracting information from media in documents.

Required: No

Type: MediaExtractionConfiguration

Update requires: No interruption

RoleArn

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

Required: No

Type: String

Pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$

Minimum: 0

Maximum: 1284

Update requires: No interruption

SyncSchedule

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.

Required: No

Type: String

Pattern: ^[\s\S]*$

Maximum: 998

Update requires: No interruption

Tags

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: _ . : / = + - @.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

VpcConfiguration

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.

Required: No

Type: DataSourceVpcConfiguration

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the application ID, data source ID, and index ID. For example:

{"Ref": "ApplicationId|DataSourceId|IndexId"}

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreatedAt

The Unix timestamp when the Amazon Q Business data source was created.

DataSourceArn

The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.

DataSourceId

The identifier of the Amazon Q Business data source.

Status

The status of the Amazon Q Business data source.

Type

The type of the Amazon Q Business data source.

UpdatedAt

The Unix timestamp when the Amazon Q Business data source was last updated.