AWS::Kendra::DataSource - AWS CloudFormation

AWS::Kendra::DataSource

Specifies a data source that you use to with an Amazon Kendra index.

You specify a name, connector type and description for your data source.

Syntax

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

JSON

{ "Type" : "AWS::Kendra::DataSource", "Properties" : { "DataSourceConfiguration" : DataSourceConfiguration, "Description" : String, "IndexId" : String, "Name" : String, "RoleArn" : String, "Schedule" : String, "Tags" : TagList, "Type" : String } }

YAML

Type: AWS::Kendra::DataSource Properties: DataSourceConfiguration: DataSourceConfiguration Description: String IndexId: String Name: String RoleArn: String Schedule: String Tags: TagList Type: String

Properties

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. Choose from one of the following data sources.

  • Amazon S3

  • Confluence

  • Custom

  • Database

  • Microsoft OneDrive

  • Microsoft SharePoint

  • Salesforce

  • ServiceNow

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 of the data source.

Required: No

Type: String

Update requires: No interruption

IndexId

The identifier of the index that should be associated with this data source.

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 the Type parameter is set to CUSTOM.

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

Update requires: No interruption

Type

The type of the data source.

Required: Yes

Type: String

Allowed values: CONFLUENCE | CUSTOM | DATABASE | ONEDRIVE | S3 | SALESFORCE | SERVICENOW | SHAREPOINT

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.