software.amazon.awscdk.services.kendra

Interface CfnDataSource.ConfluenceBlogConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.ConfluenceBlogConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

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

Configuration of blog settings for the Confluence data source.

Blogs are always indexed unless filtered from the index by the ExclusionPatterns or InclusionPatterns fields in the ConfluenceConfiguration object.

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.*;
 ConfluenceBlogConfigurationProperty confluenceBlogConfigurationProperty = ConfluenceBlogConfigurationProperty.builder()
         .blogFieldMappings(List.of(ConfluenceBlogToIndexFieldMappingProperty.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.ConfluenceBlogConfigurationProperty.Builder A builder for CfnDataSource.ConfluenceBlogConfigurationProperty
static class	CfnDataSource.ConfluenceBlogConfigurationProperty.Jsii$Proxy An implementation for CfnDataSource.ConfluenceBlogConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.ConfluenceBlogConfigurationProperty.Builder	builder()
default Object	getBlogFieldMappings() Maps attributes or field names of Confluence blogs to Amazon Kendra index field names.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBlogFieldMappings

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

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

builder

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

Returns:

a CfnDataSource.ConfluenceBlogConfigurationProperty.Builder of CfnDataSource.ConfluenceBlogConfigurationProperty