software.amazon.awscdk.services.kendra

Interface CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

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

Provides the configuration information for the knowledge article types that Amazon Kendra indexes.

Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both

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.*;
 SalesforceKnowledgeArticleConfigurationProperty salesforceKnowledgeArticleConfigurationProperty = SalesforceKnowledgeArticleConfigurationProperty.builder()
         .includedStates(List.of("includedStates"))
         // the properties below are optional
         .customKnowledgeArticleTypeConfigurations(List.of(SalesforceCustomKnowledgeArticleTypeConfigurationProperty.builder()
                 .documentDataFieldName("documentDataFieldName")
                 .name("name")
                 // the properties below are optional
                 .documentTitleFieldName("documentTitleFieldName")
                 .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                         .dataSourceFieldName("dataSourceFieldName")
                         .indexFieldName("indexFieldName")
                         // the properties below are optional
                         .dateFieldFormat("dateFieldFormat")
                         .build()))
                 .build()))
         .standardKnowledgeArticleTypeConfiguration(SalesforceStandardKnowledgeArticleTypeConfigurationProperty.builder()
                 .documentDataFieldName("documentDataFieldName")
                 // the properties below are optional
                 .documentTitleFieldName("documentTitleFieldName")
                 .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                         .dataSourceFieldName("dataSourceFieldName")
                         .indexFieldName("indexFieldName")
                         // the properties below are optional
                         .dateFieldFormat("dateFieldFormat")
                         .build()))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty.Builder	builder()
default Object	getCustomKnowledgeArticleTypeConfigurations() Configuration information for custom Salesforce knowledge articles.
List<String>	getIncludedStates() Specifies the document states that should be included when Amazon Kendra indexes knowledge articles.
default Object	getStandardKnowledgeArticleTypeConfiguration() Configuration information for standard Salesforce knowledge articles.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getIncludedStates

@Stability(value=Stable)
 @NotNull
List<String> getIncludedStates()

Specifies the document states that should be included when Amazon Kendra indexes knowledge articles.

You must specify at least one state.

getCustomKnowledgeArticleTypeConfigurations

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

Configuration information for custom Salesforce knowledge articles.

getStandardKnowledgeArticleTypeConfiguration

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

Configuration information for standard Salesforce knowledge articles.

builder

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

Returns:

a CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty.Builder of CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty