Class CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty

Provides the configuration information for crawling knowledge articles in the ServiceNow site.

Inheritance

object

CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty

Implements

CfnDataSourcePropsMixin.IServiceNowKnowledgeArticleConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.Kendra.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty : CfnDataSourcePropsMixin.IServiceNowKnowledgeArticleConfigurationProperty

Syntax (vb)

Public Class CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty Implements CfnDataSourcePropsMixin.IServiceNowKnowledgeArticleConfigurationProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Kendra.Mixins;

             var serviceNowKnowledgeArticleConfigurationProperty = new ServiceNowKnowledgeArticleConfigurationProperty {
                 CrawlAttachments = false,
                 DocumentDataFieldName = "documentDataFieldName",
                 DocumentTitleFieldName = "documentTitleFieldName",
                 ExcludeAttachmentFilePatterns = new [] { "excludeAttachmentFilePatterns" },
                 FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                     DataSourceFieldName = "dataSourceFieldName",
                     DateFieldFormat = "dateFieldFormat",
                     IndexFieldName = "indexFieldName"
                 } },
                 FilterQuery = "filterQuery",
                 IncludeAttachmentFilePatterns = new [] { "includeAttachmentFilePatterns" }
             };

Synopsis

Constructors

ServiceNowKnowledgeArticleConfigurationProperty()

Provides the configuration information for crawling knowledge articles in the ServiceNow site.

Properties

CrawlAttachments	`TRUE` to index attachments to knowledge articles.
DocumentDataFieldName	The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
DocumentTitleFieldName	The name of the ServiceNow field that is mapped to the index document title field.
ExcludeAttachmentFilePatterns	A list of regular expression patterns applied to exclude certain knowledge article attachments.
FieldMappings	Maps attributes or field names of knoweldge articles to Amazon Kendra index field names.
FilterQuery	A query that selects the knowledge articles to index.
IncludeAttachmentFilePatterns	A list of regular expression patterns applied to include knowledge article attachments.

Constructors

ServiceNowKnowledgeArticleConfigurationProperty()

Provides the configuration information for crawling knowledge articles in the ServiceNow site.

public ServiceNowKnowledgeArticleConfigurationProperty()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Kendra.Mixins;

             var serviceNowKnowledgeArticleConfigurationProperty = new ServiceNowKnowledgeArticleConfigurationProperty {
                 CrawlAttachments = false,
                 DocumentDataFieldName = "documentDataFieldName",
                 DocumentTitleFieldName = "documentTitleFieldName",
                 ExcludeAttachmentFilePatterns = new [] { "excludeAttachmentFilePatterns" },
                 FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
                     DataSourceFieldName = "dataSourceFieldName",
                     DateFieldFormat = "dateFieldFormat",
                     IndexFieldName = "indexFieldName"
                 } },
                 FilterQuery = "filterQuery",
                 IncludeAttachmentFilePatterns = new [] { "includeAttachmentFilePatterns" }
             };

Properties

CrawlAttachments

TRUE to index attachments to knowledge articles.

public object? CrawlAttachments { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowknowledgearticleconfiguration.html#cfn-kendra-datasource-servicenowknowledgearticleconfiguration-crawlattachments

Type union: either bool or IResolvable

DocumentDataFieldName

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

public string? DocumentDataFieldName { get; set; }

Property Value

string

Remarks

DocumentTitleFieldName

The name of the ServiceNow field that is mapped to the index document title field.

public string? DocumentTitleFieldName { get; set; }

Property Value

string

Remarks

ExcludeAttachmentFilePatterns

A list of regular expression patterns applied to exclude certain knowledge article attachments.

public string[]? ExcludeAttachmentFilePatterns { get; set; }

Property Value

string[]

Remarks

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.

FieldMappings

Maps attributes or field names of knoweldge articles to Amazon Kendra index field names.

public object? FieldMappings { get; set; }

Property Value

object

Remarks

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.

Type union: either IResolvable or (either IResolvable or CfnDataSourcePropsMixin.IDataSourceToIndexFieldMappingProperty)[]

FilterQuery

A query that selects the knowledge articles to index.

public string? FilterQuery { get; set; }

Property Value

string

Remarks

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 .

IncludeAttachmentFilePatterns

A list of regular expression patterns applied to include knowledge article attachments.

public string[]? IncludeAttachmentFilePatterns { get; set; }

Property Value

string[]

Remarks

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.

Implements

CfnDataSourcePropsMixin.IServiceNowKnowledgeArticleConfigurationProperty