interface ConfluenceAttachmentToIndexFieldMappingProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Kendra.CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty |
 Java | software.amazon.awscdk.services.kendra.CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty |
 Python | aws_cdk.aws_kendra.CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty |
 TypeScript | @aws-cdk/aws-kendra » CfnDataSource » ConfluenceAttachmentToIndexFieldMappingProperty |
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.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as kendra from '@aws-cdk/aws-kendra';
const confluenceAttachmentToIndexFieldMappingProperty: kendra.CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty = {
dataSourceFieldName: 'dataSourceFieldName',
indexFieldName: 'indexFieldName',
// the properties below are optional
dateFieldFormat: 'dateFieldFormat',
};
Properties
| Name | Type | Description |
|---|---|---|
| data | string | The name of the field in the data source. |
| index | string | The name of the index field to map to the Confluence data source field. |
| date | string | The format for date fields in the data source. |
dataSourceFieldName
Type:
string
The name of the field in the data source.
You must first create the index field using the UpdateIndex API.
indexFieldName
Type:
string
The name of the index field to map to the Confluence data source field.
The index field type must match the Confluence field type.
dateFieldFormat?
Type:
string
(optional)
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.