aws-cdk-lib.aws_kendra.CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty

interface ConfluenceAttachmentToIndexFieldMappingProperty

LanguageType name
.NETAmazon.CDK.AWS.Kendra.CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awskendra#CfnDataSource_ConfluenceAttachmentToIndexFieldMappingProperty
Javasoftware.amazon.awscdk.services.kendra.CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty
Pythonaws_cdk.aws_kendra.CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty
TypeScript aws-cdk-lib » 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 { aws_kendra as kendra } from 'aws-cdk-lib';
const confluenceAttachmentToIndexFieldMappingProperty: kendra.CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty = {
  dataSourceFieldName: 'dataSourceFieldName',
  indexFieldName: 'indexFieldName',

  // the properties below are optional
  dateFieldFormat: 'dateFieldFormat',
};

Properties

NameTypeDescription
dataSourceFieldNamestringThe name of the field in the data source.
indexFieldNamestringThe name of the index field to map to the Confluence data source field.
dateFieldFormat?stringThe 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.