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.
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
, "Name" :String
, "RoleArn" :String
, "Schedule" :String
, "Tags" :[ Tag, ... ]
, "Type" :String
} }
YAML
Type: AWS::Kendra::DataSource Properties: CustomDocumentEnrichmentConfiguration:
CustomDocumentEnrichmentConfiguration
DataSourceConfiguration:DataSourceConfiguration
Description:String
IndexId: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 theType
parameter is set toCUSTOM
.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
Update requires: No interruption
IndexId
-
The identifier of the index you want to use with the data source connector.
Required: Yes
Type: String
Update requires: No interruption
Name
-
The name of the data source.
Required: Yes
Type: String
Minimum:
1
Maximum:
1000
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_-]*
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 theType
parameter is set toCUSTOM
.The
RoleArn
parameter is required for all other data sources.Required: No
Type: String
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
Update requires: No interruption
Tags
-
An array of key-value pairs to apply to this resource
For more information, see Tag.
Required: No
Type: List of Tag
Update requires: No interruption
Type
-
The type of the data source.
Required: Yes
Type: String
Allowed values:
ALFRESCO | BOX | CONFLUENCE | CUSTOM | DATABASE | FSX | GITHUB | GOOGLEDRIVE | JIRA | ONEDRIVE | QUIP | S3 | SALESFORCE | SERVICENOW | SHAREPOINT | SLACK | TEMPLATE | WEBCRAWLER | WORKDOCS
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.