ServiceNowKnowledgeArticleConfigurationProperty Struct
Provides the configuration information for crawling knowledge articles in the ServiceNow site.
| Source | |
|---|---|
| Type last changed |
Example
// 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 serviceNowKnowledgeArticleConfigurationProperty: kendra.CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty = {
documentDataFieldName: 'documentDataFieldName',
// the properties below are optional
crawlAttachments: false,
documentTitleFieldName: 'documentTitleFieldName',
excludeAttachmentFilePatterns: ['excludeAttachmentFilePatterns'],
fieldMappings: [{
dataSourceFieldName: 'dataSourceFieldName',
indexFieldName: 'indexFieldName',
// the properties below are optional
dateFieldFormat: 'dateFieldFormat',
}],
filterQuery: 'filterQuery',
includeAttachmentFilePatterns: ['includeAttachmentFilePatterns'],
};
# 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
service_now_knowledge_article_configuration_property = kendra.CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty(
document_data_field_name="documentDataFieldName",
# the properties below are optional
crawl_attachments=False,
document_title_field_name="documentTitleFieldName",
exclude_attachment_file_patterns=["excludeAttachmentFilePatterns"],
field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
data_source_field_name="dataSourceFieldName",
index_field_name="indexFieldName",
# the properties below are optional
date_field_format="dateFieldFormat"
)],
filter_query="filterQuery",
include_attachment_file_patterns=["includeAttachmentFilePatterns"]
)
// 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.*;
ServiceNowKnowledgeArticleConfigurationProperty serviceNowKnowledgeArticleConfigurationProperty = ServiceNowKnowledgeArticleConfigurationProperty.builder()
.documentDataFieldName("documentDataFieldName")
// the properties below are optional
.crawlAttachments(false)
.documentTitleFieldName("documentTitleFieldName")
.excludeAttachmentFilePatterns(List.of("excludeAttachmentFilePatterns"))
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.indexFieldName("indexFieldName")
// the properties below are optional
.dateFieldFormat("dateFieldFormat")
.build()))
.filterQuery("filterQuery")
.includeAttachmentFilePatterns(List.of("includeAttachmentFilePatterns"))
.build();
// 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 serviceNowKnowledgeArticleConfigurationProperty = new ServiceNowKnowledgeArticleConfigurationProperty {
DocumentDataFieldName = "documentDataFieldName",
// the properties below are optional
CrawlAttachments = false,
DocumentTitleFieldName = "documentTitleFieldName",
ExcludeAttachmentFilePatterns = new [] { "excludeAttachmentFilePatterns" },
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} },
FilterQuery = "filterQuery",
IncludeAttachmentFilePatterns = new [] { "includeAttachmentFilePatterns" }
};
// 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"
serviceNowKnowledgeArticleConfigurationProperty := &ServiceNowKnowledgeArticleConfigurationProperty{
DocumentDataFieldName: jsii.String("documentDataFieldName"),
// the properties below are optional
CrawlAttachments: jsii.Boolean(false),
DocumentTitleFieldName: jsii.String("documentTitleFieldName"),
ExcludeAttachmentFilePatterns: []*string{
jsii.String("excludeAttachmentFilePatterns"),
},
FieldMappings: []interface{}{
&DataSourceToIndexFieldMappingProperty{
DataSourceFieldName: jsii.String("dataSourceFieldName"),
IndexFieldName: jsii.String("indexFieldName"),
// the properties below are optional
DateFieldFormat: jsii.String("dateFieldFormat"),
},
},
FilterQuery: jsii.String("filterQuery"),
IncludeAttachmentFilePatterns: []*string{
jsii.String("includeAttachmentFilePatterns"),
},
}
Properties
crawlAttachmentsoptionalboolean | IResolvablecrawl_attachmentsoptionaltyping.Union[bool, IResolvable]crawlAttachmentsoptionalBooleanCrawlAttachmentsoptionalboolCrawlAttachmentsoptionalinterface{} #documentDataFieldNamestringdocument_data_field_namestrdocumentDataFieldNameStringDocumentDataFieldNamestringDocumentDataFieldName*string required #documentTitleFieldNameoptionalstringdocument_title_field_nameoptionalstrdocumentTitleFieldNameoptionalStringDocumentTitleFieldNameoptionalstringDocumentTitleFieldNameoptional*string #excludeAttachmentFilePatternsoptionalstring[]exclude_attachment_file_patternsoptionaltyping.List[str]excludeAttachmentFilePatternsoptionalList<String>ExcludeAttachmentFilePatternsoptionalstring[]ExcludeAttachmentFilePatternsoptional*[]*string #notes
Attachments that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.
fieldMappingsoptionalIResolvable | IResolvable | CfnDataSource.field_mappingsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataSourceToIndexFieldMappingProperty]]]fieldMappingsoptionalIResolvableFieldMappingsoptionalIResolvableFieldMappingsoptionalinterface{} #notes
To create custom fields, use the UpdateIndex API before you map to ServiceNow fields. For more information, see Mapping data source fields . The ServiceNow data source field names must exist in your ServiceNow custom metadata.
filterQueryoptionalstringfilter_queryoptionalstrfilterQueryoptionalStringFilterQueryoptionalstringFilterQueryoptional*string #notes
The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.
The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query .
includeAttachmentFilePatternsoptionalstring[]include_attachment_file_patternsoptionaltyping.List[str]includeAttachmentFilePatternsoptionalList<String>IncludeAttachmentFilePatternsoptionalstring[]IncludeAttachmentFilePatternsoptional*[]*string #notes
Attachments that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.