AWS::Kendra::DataSource - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Kendra::DataSource

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.

Important

CreateDataSource does not support connectors which require a TemplateConfiguration object for connecting to Amazon Kendra.

Syntax

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

JSON

{
  "Type" : "AWS::Kendra::DataSource",
  "Properties" : {
      "CustomDocumentEnrichmentConfiguration" : CustomDocumentEnrichmentConfiguration,
      "DataSourceConfiguration" : DataSourceConfiguration,
      "Description" : String,
      "IndexId" : String,
      "LanguageCode" : String,
      "Name" : String,
      "RoleArn" : String,
      "Schedule" : String,
      "Tags" : [ Tag, ... ],
      "Type" : String
    }
}

YAML

Type: AWS::Kendra::DataSource
Properties:
  CustomDocumentEnrichmentConfiguration: 
    CustomDocumentEnrichmentConfiguration
  DataSourceConfiguration: 
    DataSourceConfiguration
  Description: String
  IndexId: String
  LanguageCode: String
  Name: String
  RoleArn: String
  Schedule: String
  Tags: 
    - Tag
  Type: String

Properties

CustomDocumentEnrichmentConfiguration

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

Required: No

Type: CustomDocumentEnrichmentConfiguration

Update requires: No interruption

DataSourceConfiguration

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.

Required: No

Type: DataSourceConfiguration

Update requires: No interruption

Description

A description for the data source connector.

Required: No

Type: String

Minimum: 1

Maximum: 1000

Update requires: No interruption

IndexId

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

Required: Yes

Type: String

Minimum: 36

Maximum: 36

Update requires: Replacement

LanguageCode

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.

Required: No

Type: String

Pattern: [a-zA-Z-]*

Minimum: 2

Maximum: 10

Update requires: No interruption

Name

The name of the data source.

Required: Yes

Type: String

Minimum: 1

Maximum: 1000

Update requires: No interruption

RoleArn

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.

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: 1

Maximum: 1284

Update requires: No interruption

Schedule

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.

Required: No

Type: String

Maximum: 1000

Update requires: No interruption

Tags

An array of key-value pairs to apply to this resource

For more information, see Tag.

Required: No

Type: Array of Tag

Maximum: 200

Update requires: No interruption

Type

The type of the data source.

Required: Yes

Type: String

Allowed values: S3 | SHAREPOINT | SALESFORCE | ONEDRIVE | SERVICENOW | DATABASE | CUSTOM | CONFLUENCE | GOOGLEDRIVE | WEBCRAWLER | WORKDOCS | TEMPLATE

Update requires: Replacement

Return values

Ref

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

{ "Ref": "<data source ID>|<index ID>" }

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.

Arn

The Amazon Resource Name (ARN) of the data source. For example:

arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/data-source/b8cae438-6787-4091-8897-684a652bbb0a

Id

The identifier for the data source. For example:

b8cae438-6787-4091-8897-684a652bbb0a.