AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Kendra::DataSource

CfnDataSource

Creates a data source connector that you want to use with an Amazon Kendra index. You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector. > `CreateDataSource` does *not* support connectors which [require a `TemplateConfiguration` object](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html) for connecting to Amazon Kendra .

Import

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

Or use the module namespace:

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

Properties

Configuration passed to the constructor as CfnDataSourceProps.

indexIdRequired
string | IIndexRef

The identifier of the index you want to use with the data source connector.

nameRequired
string

The name of the data source.

typeRequired
string

The type of the data source.

customDocumentEnrichmentConfigurationOptional
IResolvable | CustomDocumentEnrichmentConfigurationProperty

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

dataSourceConfigurationOptional
IResolvable | DataSourceConfigurationProperty

Configuration information for an Amazon Kendra data source. The contents of the configuration depend on the type of data source. You can only specify one type of data source in the configuration. You can't specify the `Configuration` parameter when the `Type` parameter is set to `CUSTOM` . The `Configuration` parameter is required for all other data sources.

descriptionOptional
string

A description for the data source connector.

languageCodeOptional
string

The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see [Adding documents in languages other than English](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html) .

roleArnOptional
string | IRoleRef

The Amazon Resource Name (ARN) of a role with permission to access the data source. You can't specify the `RoleArn` parameter when the `Type` parameter is set to `CUSTOM` . The `RoleArn` parameter is required for all other data sources.

scheduleOptional
string

Sets the frequency that Amazon Kendra checks the documents in your data source and updates the index. If you don't set a schedule, Amazon Kendra doesn't periodically update the index.

tagsOptional
CfnTag[]

An array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

CloudFormation Resource

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

AWS::Kendra::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-kendra
CFN TypeAWS::Kendra::DataSource
Properties10

Related Constructs

Explore This Service

External Links