SalesforceStandardKnowledgeArticleTypeConfigurationProperty Struct
Provides the configuration information for standard Salesforce knowledge articles.
| Source | |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
const salesforceStandardKnowledgeArticleTypeConfigurationProperty: kendra.CfnDataSource.SalesforceStandardKnowledgeArticleTypeConfigurationProperty = {
documentDataFieldName: 'documentDataFieldName',
// the properties below are optional
documentTitleFieldName: 'documentTitleFieldName',
fieldMappings: [{
dataSourceFieldName: 'dataSourceFieldName',
indexFieldName: 'indexFieldName',
// the properties below are optional
dateFieldFormat: 'dateFieldFormat',
}],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_kendra as kendra
salesforce_standard_knowledge_article_type_configuration_property = kendra.CfnDataSource.SalesforceStandardKnowledgeArticleTypeConfigurationProperty(
document_data_field_name="documentDataFieldName",
# the properties below are optional
document_title_field_name="documentTitleFieldName",
field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
data_source_field_name="dataSourceFieldName",
index_field_name="indexFieldName",
# the properties below are optional
date_field_format="dateFieldFormat"
)]
)
java
// 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.*;
SalesforceStandardKnowledgeArticleTypeConfigurationProperty salesforceStandardKnowledgeArticleTypeConfigurationProperty = 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;
var salesforceStandardKnowledgeArticleTypeConfigurationProperty = new SalesforceStandardKnowledgeArticleTypeConfigurationProperty {
DocumentDataFieldName = "documentDataFieldName",
// the properties below are optional
DocumentTitleFieldName = "documentTitleFieldName",
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
salesforceStandardKnowledgeArticleTypeConfigurationProperty := &SalesforceStandardKnowledgeArticleTypeConfigurationProperty{
DocumentDataFieldName: jsii.String("documentDataFieldName"),
// the properties below are optional
DocumentTitleFieldName: jsii.String("documentTitleFieldName"),
FieldMappings: []interface{}{
&DataSourceToIndexFieldMappingProperty{
DataSourceFieldName: jsii.String("dataSourceFieldName"),
IndexFieldName: jsii.String("indexFieldName"),
// the properties below are optional
DateFieldFormat: jsii.String("dateFieldFormat"),
},
},
}
Properties
documentDataFieldNamestringdocument_data_field_namestrdocumentDataFieldNameStringDocumentDataFieldNamestringDocumentDataFieldName*string required #The name of the field that contains the document data to index.
documentTitleFieldNameoptionalstringdocument_title_field_nameoptionalstrdocumentTitleFieldNameoptionalStringDocumentTitleFieldNameoptionalstringDocumentTitleFieldNameoptional*string #The name of the field that contains the document title.
fieldMappingsoptionalIResolvable | IResolvable | CfnDataSource.field_mappingsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataSourceToIndexFieldMappingProperty]]]fieldMappingsoptionalIResolvableFieldMappingsoptionalIResolvableFieldMappingsoptionalinterface{} #Maps attributes or field names of the knowledge article to Amazon Kendra index field names.
notes
To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields . The Salesforce data source field names must exist in your Salesforce custom metadata.