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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceattachmentconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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()	TRUE to index attachments of pages and blogs in Confluence.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAttachmentFieldMappings

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceattachmentconfiguration.html#cfn-kendra-datasource-confluenceattachmentconfiguration-attachmentfieldmappings

getCrawlAttachments

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

TRUE to index attachments of pages and blogs in Confluence.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceattachmentconfiguration.html#cfn-kendra-datasource-confluenceattachmentconfiguration-crawlattachments

builder

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

Returns:

a CfnDataSource.ConfluenceAttachmentConfigurationProperty.Builder of CfnDataSource.ConfluenceAttachmentConfigurationProperty