software.amazon.awscdk.services.kendra

Interface CfnDataSource.ConfluencePageConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.ConfluencePageConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

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

Configuration of the page settings for the Confluence data source.

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.*;
 ConfluencePageConfigurationProperty confluencePageConfigurationProperty = ConfluencePageConfigurationProperty.builder()
         .pageFieldMappings(List.of(ConfluencePageToIndexFieldMappingProperty.builder()
                 .dataSourceFieldName("dataSourceFieldName")
                 .indexFieldName("indexFieldName")
                 // the properties below are optional
                 .dateFieldFormat("dateFieldFormat")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.ConfluencePageConfigurationProperty.Builder	builder()
default Object	getPageFieldMappings() >Maps attributes or field names of Confluence pages to Amazon Kendra index field names.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPageFieldMappings

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

>Maps attributes or field names of Confluence pages 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 PageFieldMappings parameter, you must specify at least one field mapping.

builder

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

Returns:

a CfnDataSource.ConfluencePageConfigurationProperty.Builder of CfnDataSource.ConfluencePageConfigurationProperty