Skip to content
v2.276.0

ConfluenceAttachmentConfigurationProperty Struct ​

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 ​

ts
// 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,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_kendra as kendra

confluence_attachment_configuration_property = kendra.CfnDataSource.ConfluenceAttachmentConfigurationProperty(
    attachment_field_mappings=[kendra.CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty(
        data_source_field_name="dataSourceFieldName",
        index_field_name="indexFieldName",

        # the properties below are optional
        date_field_format="dateFieldFormat"
    )],
    crawl_attachments=False
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.kendra.*;

ConfluenceAttachmentConfigurationProperty confluenceAttachmentConfigurationProperty = ConfluenceAttachmentConfigurationProperty.builder()
        .attachmentFieldMappings(List.of(ConfluenceAttachmentToIndexFieldMappingProperty.builder()
                .dataSourceFieldName("dataSourceFieldName")
                .indexFieldName("indexFieldName")

                // the properties below are optional
                .dateFieldFormat("dateFieldFormat")
                .build()))
        .crawlAttachments(false)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;

var confluenceAttachmentConfigurationProperty = new ConfluenceAttachmentConfigurationProperty {
    AttachmentFieldMappings = new [] { new ConfluenceAttachmentToIndexFieldMappingProperty {
        DataSourceFieldName = "dataSourceFieldName",
        IndexFieldName = "indexFieldName",

        // the properties below are optional
        DateFieldFormat = "dateFieldFormat"
    } },
    CrawlAttachments = false
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

confluenceAttachmentConfigurationProperty := &ConfluenceAttachmentConfigurationProperty{
	AttachmentFieldMappings: []interface{}{
		&ConfluenceAttachmentToIndexFieldMappingProperty{
			DataSourceFieldName: jsii.String("dataSourceFieldName"),
			IndexFieldName: jsii.String("indexFieldName"),

			// the properties below are optional
			DateFieldFormat: jsii.String("dateFieldFormat"),
		},
	},
	CrawlAttachments: jsii.Boolean(false),
}

Properties ​

attachmentFieldMappingsoptionalIResolvable | IResolvable | CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty[]attachment_field_mappingsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ConfluenceAttachmentToIndexFieldMappingProperty]]]attachmentFieldMappingsoptionalIResolvableAttachmentFieldMappingsoptionalIResolvableAttachmentFieldMappingsoptionalinterface{}#
Maps attributes or field names of Confluence attachments to Amazon Kendra index field names.
notes

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.

crawlAttachmentsoptionalboolean | IResolvablecrawl_attachmentsoptionaltyping.Union[bool, IResolvable]crawlAttachmentsoptionalBooleanCrawlAttachmentsoptionalboolCrawlAttachmentsoptionalinterface{}#
`TRUE` to index attachments of pages and blogs in Confluence.