aws-cdk-lib.aws_kendra.CfnDataSource.ConfluenceAttachmentConfigurationProperty

interface ConfluenceAttachmentConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.Kendra.CfnDataSource.ConfluenceAttachmentConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awskendra#CfnDataSource_ConfluenceAttachmentConfigurationProperty
Javasoftware.amazon.awscdk.services.kendra.CfnDataSource.ConfluenceAttachmentConfigurationProperty
Pythonaws_cdk.aws_kendra.CfnDataSource.ConfluenceAttachmentConfigurationProperty
TypeScript aws-cdk-lib » aws_kendra » CfnDataSource » ConfluenceAttachmentConfigurationProperty

Configuration of attachment settings for the Confluence data source.

Attachment settings are optional, if you don't specify settings attachments, Amazon Kendra won't index them.

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 confluenceAttachmentConfigurationProperty: kendra.CfnDataSource.ConfluenceAttachmentConfigurationProperty = {
  attachmentFieldMappings: [{
    dataSourceFieldName: 'dataSourceFieldName',
    indexFieldName: 'indexFieldName',

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

Properties

NameTypeDescription
attachmentFieldMappings?IResolvable | IResolvable | ConfluenceAttachmentToIndexFieldMappingProperty[]Maps attributes or field names of Confluence attachments to Amazon Kendra index field names.
crawlAttachments?boolean | IResolvableTRUE to index attachments of pages and blogs in Confluence.

attachmentFieldMappings?

Type: IResolvable | IResolvable | ConfluenceAttachmentToIndexFieldMappingProperty[] (optional)

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 Confluence data source field names must exist in your Confluence custom metadata.

If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.


crawlAttachments?

Type: boolean | IResolvable (optional)

TRUE to index attachments of pages and blogs in Confluence.