Package software.amazon.awscdk.services.kendra

Interface CfnDataSource.ConfluencePageToIndexFieldMappingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.ConfluencePageToIndexFieldMappingProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(Stable)
public static interface CfnDataSource.ConfluencePageToIndexFieldMappingProperty
extends software.amazon.jsii.JsiiSerializable

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.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.ConfluencePageToIndexFieldMappingProperty.Builder	builder()
String	getDataSourceFieldName()	The name of the field in the data source.
default String	getDateFieldFormat()	The format for date fields in the data source.
String	getIndexFieldName()	The name of the index field to map to the Confluence data source field.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataSourceFieldName

@Stability(Stable)
@NotNull
String getDataSourceFieldName()

The name of the field in the data source.

getIndexFieldName

@Stability(Stable)
@NotNull
String getIndexFieldName()

The name of the index field to map to the Confluence data source field.

The index field type must match the Confluence field type.

getDateFieldFormat

@Stability(Stable)
@Nullable
default String getDateFieldFormat()

The format for date fields in the data source.

If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

builder

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

Returns:

a CfnDataSource.ConfluencePageToIndexFieldMappingProperty.Builder of CfnDataSource.ConfluencePageToIndexFieldMappingProperty