software.amazon.awscdk.services.kendra

Interface CfnDataSource.ConfluenceAttachmentConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.ConfluenceAttachmentConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(value=Stable)
public static interface CfnDataSource.ConfluenceAttachmentConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDataSource.ConfluenceAttachmentConfigurationProperty.Builder A builder for CfnDataSource.ConfluenceAttachmentConfigurationProperty
static class	CfnDataSource.ConfluenceAttachmentConfigurationProperty.Jsii$Proxy An implementation for CfnDataSource.ConfluenceAttachmentConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.ConfluenceAttachmentConfigurationProperty.Builder	builder()
default Object	getAttachmentFieldMappings() Maps attributes or field names of Confluence attachments to Amazon Kendra index field names.
default Object	getCrawlAttachments() Indicates whether Amazon Kendra indexes attachments to the pages and blogs in the Confluence data source.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAttachmentFieldMappings

@Stability(value=Stable)
 @Nullable
default Object getAttachmentFieldMappings()

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.

getCrawlAttachments

@Stability(value=Stable)
 @Nullable
default Object getCrawlAttachments()

Indicates whether Amazon Kendra indexes attachments to the pages and blogs in the Confluence data source.

builder

@Stability(value=Stable)
static CfnDataSource.ConfluenceAttachmentConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.ConfluenceAttachmentConfigurationProperty.Builder of CfnDataSource.ConfluenceAttachmentConfigurationProperty