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

Specifies 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() Defines how page metadata fields should be mapped to index fields.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPageFieldMappings

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

Defines how page metadata fields should be mapped to index fields.

Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

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