Package software.amazon.awscdk.cfnpropertymixins.services.kendra

Interface CfnDataSourcePropsMixin.SalesforceKnowledgeArticleConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSourcePropsMixin.SalesforceKnowledgeArticleConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSourcePropsMixin

@Stability(Stable)
public static interface CfnDataSourcePropsMixin.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.cfnpropertymixins.services.kendra.*;
 SalesforceKnowledgeArticleConfigurationProperty salesforceKnowledgeArticleConfigurationProperty = SalesforceKnowledgeArticleConfigurationProperty.builder()
         .customKnowledgeArticleTypeConfigurations(List.of(SalesforceCustomKnowledgeArticleTypeConfigurationProperty.builder()
                 .documentDataFieldName("documentDataFieldName")
                 .documentTitleFieldName("documentTitleFieldName")
                 .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                         .dataSourceFieldName("dataSourceFieldName")
                         .dateFieldFormat("dateFieldFormat")
                         .indexFieldName("indexFieldName")
                         .build()))
                 .name("name")
                 .build()))
         .includedStates(List.of("includedStates"))
         .standardKnowledgeArticleTypeConfiguration(SalesforceStandardKnowledgeArticleTypeConfigurationProperty.builder()
                 .documentDataFieldName("documentDataFieldName")
                 .documentTitleFieldName("documentTitleFieldName")
                 .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                         .dataSourceFieldName("dataSourceFieldName")
                         .dateFieldFormat("dateFieldFormat")
                         .indexFieldName("indexFieldName")
                         .build()))
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceknowledgearticleconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSourcePropsMixin.SalesforceKnowledgeArticleConfigurationProperty.Builder	builder()
default Object	getCustomKnowledgeArticleTypeConfigurations()	Configuration information for custom Salesforce knowledge articles.
default 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 Details

getCustomKnowledgeArticleTypeConfigurations

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

Configuration information for custom Salesforce knowledge articles.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataSourcePropsMixin.SalesforceCustomKnowledgeArticleTypeConfigurationProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceknowledgearticleconfiguration.html#cfn-kendra-datasource-salesforceknowledgearticleconfiguration-customknowledgearticletypeconfigurations

getIncludedStates

@Stability(Stable)
@Nullable
default List<String> getIncludedStates()

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

You must specify at least one state.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceknowledgearticleconfiguration.html#cfn-kendra-datasource-salesforceknowledgearticleconfiguration-includedstates

getStandardKnowledgeArticleTypeConfiguration

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

Configuration information for standard Salesforce knowledge articles.

Returns union: either IResolvable or CfnDataSourcePropsMixin.SalesforceStandardKnowledgeArticleTypeConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceknowledgearticleconfiguration.html#cfn-kendra-datasource-salesforceknowledgearticleconfiguration-standardknowledgearticletypeconfiguration

builder

@Stability(Stable)
static CfnDataSourcePropsMixin.SalesforceKnowledgeArticleConfigurationProperty.Builder builder()

Returns:

a CfnDataSourcePropsMixin.SalesforceKnowledgeArticleConfigurationProperty.Builder of CfnDataSourcePropsMixin.SalesforceKnowledgeArticleConfigurationProperty