Skip to content
v2.278.0

ServiceNowServiceCatalogConfigurationProperty Struct ​

Provides the configuration information for crawling service catalog items in the ServiceNow site.

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 serviceNowServiceCatalogConfigurationProperty: kendra.CfnDataSource.ServiceNowServiceCatalogConfigurationProperty = {
  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',
  }],
  includeAttachmentFilePatterns: ['includeAttachmentFilePatterns'],
};
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

service_now_service_catalog_configuration_property = kendra.CfnDataSource.ServiceNowServiceCatalogConfigurationProperty(
    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"
    )],
    include_attachment_file_patterns=["includeAttachmentFilePatterns"]
)
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.*;

ServiceNowServiceCatalogConfigurationProperty serviceNowServiceCatalogConfigurationProperty = ServiceNowServiceCatalogConfigurationProperty.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()))
        .includeAttachmentFilePatterns(List.of("includeAttachmentFilePatterns"))
        .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 serviceNowServiceCatalogConfigurationProperty = new ServiceNowServiceCatalogConfigurationProperty {
    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"
    } },
    IncludeAttachmentFilePatterns = new [] { "includeAttachmentFilePatterns" }
};
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"

serviceNowServiceCatalogConfigurationProperty := &ServiceNowServiceCatalogConfigurationProperty{
	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"),
		},
	},
	IncludeAttachmentFilePatterns: []*string{
		jsii.String("includeAttachmentFilePatterns"),
	},
}

Properties ​

crawlAttachmentsoptionalboolean | IResolvablecrawl_attachmentsoptionaltyping.Union[bool, IResolvable]crawlAttachmentsoptionalBooleanCrawlAttachmentsoptionalboolCrawlAttachmentsoptionalinterface{} #
`TRUE` to index attachments to service catalog items.
documentDataFieldNamestringdocument_data_field_namestrdocumentDataFieldNameStringDocumentDataFieldNamestringDocumentDataFieldName*string required #
The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
documentTitleFieldNameoptionalstringdocument_title_field_nameoptionalstrdocumentTitleFieldNameoptionalStringDocumentTitleFieldNameoptionalstringDocumentTitleFieldNameoptional*string #
The name of the ServiceNow field that is mapped to the index document title field.
excludeAttachmentFilePatternsoptionalstring[]exclude_attachment_file_patternsoptionaltyping.List[str]excludeAttachmentFilePatternsoptionalList<String>ExcludeAttachmentFilePatternsoptionalstring[]ExcludeAttachmentFilePatternsoptional*[]*string #
A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow.
notes

Item 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.

The regex is applied to the file name of the attachment.

fieldMappingsoptionalIResolvable | IResolvable | CfnDataSource.DataSourceToIndexFieldMappingProperty[]field_mappingsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataSourceToIndexFieldMappingProperty]]]fieldMappingsoptionalIResolvableFieldMappingsoptionalIResolvableFieldMappingsoptionalinterface{} #
Maps attributes or field names of catalogs to Amazon Kendra index field names.
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.

includeAttachmentFilePatternsoptionalstring[]include_attachment_file_patternsoptionaltyping.List[str]includeAttachmentFilePatternsoptionalList<String>IncludeAttachmentFilePatternsoptionalstring[]IncludeAttachmentFilePatternsoptional*[]*string #
A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow.
notes

Item 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.

The regex is applied to the file name of the attachment.