AWS::Kendra::DataSource ConfluenceAttachmentToIndexFieldMapping - AWS CloudFormation
SyntaxProperties

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 ConfluenceAttachmentToIndexFieldMapping

Maps attributes or field names of Confluence attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confuence data source field names must exist in your Confluence custom metadata.

Syntax

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

JSON

{
  "DataSourceFieldName" : String,
  "DateFieldFormat" : String,
  "IndexFieldName" : String
}

YAML

  DataSourceFieldName: String
  DateFieldFormat: String
  IndexFieldName: String

Properties

DataSourceFieldName

The name of the field in the data source.

You must first create the index field using the UpdateIndex API.

Required: Yes

Type: String

Allowed values: AUTHOR | CONTENT_TYPE | CREATED_DATE | DISPLAY_URL | FILE_SIZE | ITEM_TYPE | PARENT_ID | SPACE_KEY | SPACE_NAME | URL | VERSION

Update requires: No interruption

DateFieldFormat

The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

Required: No

Type: String

Minimum: 4

Maximum: 40

Update requires: No interruption

IndexFieldName

The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

Required: Yes

Type: String

Minimum: 1

Maximum: 30

Update requires: No interruption