Class: AWSCDK::Kendra::CfnDataSource::ServiceNowServiceCatalogConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
kendra/cfn_data_source.rb

Overview

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document_data_field_name:, crawl_attachments: nil, document_title_field_name: nil, exclude_attachment_file_patterns: nil, field_mappings: nil, include_attachment_file_patterns: nil) ⇒ ServiceNowServiceCatalogConfigurationProperty

Returns a new instance of ServiceNowServiceCatalogConfigurationProperty.

Parameters:

  • document_data_field_name (String) —

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

  • crawl_attachments (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    TRUE to index attachments to service catalog items.

  • document_title_field_name (String, nil) (defaults to: nil) —

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

  • exclude_attachment_file_patterns (Array<String>, nil) (defaults to: nil) —

    A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow.

  • field_mappings (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Kendra::CfnDataSource::DataSourceToIndexFieldMappingProperty>, nil) (defaults to: nil) —

    Maps attributes or field names of catalogs to Amazon Kendra index field names.

  • include_attachment_file_patterns (Array<String>, nil) (defaults to: nil) —

    A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow.



3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
 
# File 'kendra/cfn_data_source.rb', line 3379

def initialize(document_data_field_name:, crawl_attachments: nil, document_title_field_name: nil, exclude_attachment_file_patterns: nil, field_mappings: nil, include_attachment_file_patterns: nil)
  @document_data_field_name = document_data_field_name
  Jsii::Type.check_type(@document_data_field_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "documentDataFieldName")
  @crawl_attachments = crawl_attachments
  Jsii::Type.check_type(@crawl_attachments, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "crawlAttachments") unless @crawl_attachments.nil?
  @document_title_field_name = document_title_field_name
  Jsii::Type.check_type(@document_title_field_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "documentTitleFieldName") unless @document_title_field_name.nil?
  @exclude_attachment_file_patterns = exclude_attachment_file_patterns
  Jsii::Type.check_type(@exclude_attachment_file_patterns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "excludeAttachmentFilePatterns") unless @exclude_attachment_file_patterns.nil?
  @field_mappings = field_mappings
  Jsii::Type.check_type(@field_mappings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa2VuZHJhLkNmbkRhdGFTb3VyY2UuRGF0YVNvdXJjZVRvSW5kZXhGaWVsZE1hcHBpbmdQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "fieldMappings") unless @field_mappings.nil?
  @include_attachment_file_patterns = include_attachment_file_patterns
  Jsii::Type.check_type(@include_attachment_file_patterns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "includeAttachmentFilePatterns") unless @include_attachment_file_patterns.nil?
end

Instance Attribute Details

#crawl_attachments ⇒ Boolean, ... (readonly)

TRUE to index attachments to service catalog items.

Returns:

See Also:



3403
3404
3405
 
# File 'kendra/cfn_data_source.rb', line 3403

def crawl_attachments
  @crawl_attachments
end

#document_data_field_name ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



3398
3399
3400
 
# File 'kendra/cfn_data_source.rb', line 3398

def document_data_field_name
  @document_data_field_name
end

#document_title_field_name ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



3408
3409
3410
 
# File 'kendra/cfn_data_source.rb', line 3408

def document_title_field_name
  @document_title_field_name
end

#exclude_attachment_file_patterns ⇒ Array<String>? (readonly)

A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow.

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.

Returns:

  • (Array<String>, nil)

See Also:



3417
3418
3419
 
# File 'kendra/cfn_data_source.rb', line 3417

def exclude_attachment_file_patterns
  @exclude_attachment_file_patterns
end

#field_mappings ⇒ AWSCDK::IResolvable, ... (readonly)

Maps attributes or field names of catalogs to Amazon Kendra index field names.

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.

Returns:

See Also:



3424
3425
3426
 
# File 'kendra/cfn_data_source.rb', line 3424

def field_mappings
  @field_mappings
end

#include_attachment_file_patterns ⇒ Array<String>? (readonly)

A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow.

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.

Returns:

  • (Array<String>, nil)

See Also:



3433
3434
3435
 
# File 'kendra/cfn_data_source.rb', line 3433

def include_attachment_file_patterns
  @include_attachment_file_patterns
end

Class Method Details

.jsii_properties ⇒ Object 



3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
 
# File 'kendra/cfn_data_source.rb', line 3435

def self.jsii_properties
  {
    :document_data_field_name => "documentDataFieldName",
    :crawl_attachments => "crawlAttachments",
    :document_title_field_name => "documentTitleFieldName",
    :exclude_attachment_file_patterns => "excludeAttachmentFilePatterns",
    :field_mappings => "fieldMappings",
    :include_attachment_file_patterns => "includeAttachmentFilePatterns",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
 
# File 'kendra/cfn_data_source.rb', line 3446

def to_jsii
  result = {}
  result.merge!({
    "documentDataFieldName" => @document_data_field_name,
    "crawlAttachments" => @crawl_attachments,
    "documentTitleFieldName" => @document_title_field_name,
    "excludeAttachmentFilePatterns" => @exclude_attachment_file_patterns,
    "fieldMappings" => @field_mappings,
    "includeAttachmentFilePatterns" => @include_attachment_file_patterns,
  })
  result.compact
end