Class: AWSCDK::Wisdom::CfnKnowledgeBase::WebCrawlerConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
wisdom/cfn_knowledge_base.rb

Overview

The configuration details for the web data source.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(url_configuration:, crawler_limits: nil, exclusion_filters: nil, inclusion_filters: nil, scope: nil) ⇒ WebCrawlerConfigurationProperty

Returns a new instance of WebCrawlerConfigurationProperty.

Parameters:



1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'wisdom/cfn_knowledge_base.rb', line 1381

def initialize(url_configuration:, crawler_limits: nil, exclusion_filters: nil, inclusion_filters: nil, scope: nil)
  @url_configuration = url_configuration.is_a?(Hash) ? ::AWSCDK::Wisdom::CfnKnowledgeBase::URLConfigurationProperty.new(**url_configuration.transform_keys(&:to_sym)) : url_configuration
  Jsii::Type.check_type(@url_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193aXNkb20uQ2ZuS25vd2xlZGdlQmFzZS5VcmxDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "urlConfiguration")
  @crawler_limits = crawler_limits.is_a?(Hash) ? ::AWSCDK::Wisdom::CfnKnowledgeBase::CrawlerLimitsProperty.new(**crawler_limits.transform_keys(&:to_sym)) : crawler_limits
  Jsii::Type.check_type(@crawler_limits, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193aXNkb20uQ2ZuS25vd2xlZGdlQmFzZS5DcmF3bGVyTGltaXRzUHJvcGVydHkifV19fQ==")), "crawlerLimits") unless @crawler_limits.nil?
  @exclusion_filters = exclusion_filters
  Jsii::Type.check_type(@exclusion_filters, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "exclusionFilters") unless @exclusion_filters.nil?
  @inclusion_filters = inclusion_filters
  Jsii::Type.check_type(@inclusion_filters, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "inclusionFilters") unless @inclusion_filters.nil?
  @scope = scope
  Jsii::Type.check_type(@scope, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scope") unless @scope.nil?
end

Instance Attribute Details

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

The configuration of crawl limits for the web URLs.

Returns:

See Also:



1405
1406
1407
 
# File 'wisdom/cfn_knowledge_base.rb', line 1405

def crawler_limits
  @crawler_limits
end

#exclusion_filters ⇒ Array<String>? (readonly)

A list of one or more exclusion regular expression patterns to exclude certain URLs.

If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.

Returns:

  • (Array<String>, nil)

See Also:



1412
1413
1414
 
# File 'wisdom/cfn_knowledge_base.rb', line 1412

def exclusion_filters
  @exclusion_filters
end

#inclusion_filters ⇒ Array<String>? (readonly)

A list of one or more inclusion regular expression patterns to include certain URLs.

If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.

Returns:

  • (Array<String>, nil)

See Also:



1419
1420
1421
 
# File 'wisdom/cfn_knowledge_base.rb', line 1419

def inclusion_filters
  @inclusion_filters
end

#scope ⇒ String? (readonly)

The scope of what is crawled for your URLs.

You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL https://docs.aws.amazon.com/bedrock/latest/userguide/ and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain aws.amazon.com can also include sub domain docs.aws.amazon.com .

Returns:

  • (String, nil)

See Also:



1426
1427
1428
 
# File 'wisdom/cfn_knowledge_base.rb', line 1426

def scope
  @scope
end

#url_configuration ⇒ AWSCDK::IResolvable, AWSCDK::Wisdom::CfnKnowledgeBase::URLConfigurationProperty (readonly)

The configuration of the URL/URLs for the web content that you want to crawl.

You should be authorized to crawl the URLs.

Returns:

See Also:



1400
1401
1402
 
# File 'wisdom/cfn_knowledge_base.rb', line 1400

def url_configuration
  @url_configuration
end

Class Method Details

.jsii_properties ⇒ Object 



1428
1429
1430
1431
1432
1433
1434
1435
1436
 
# File 'wisdom/cfn_knowledge_base.rb', line 1428

def self.jsii_properties
  {
    :url_configuration => "urlConfiguration",
    :crawler_limits => "crawlerLimits",
    :exclusion_filters => "exclusionFilters",
    :inclusion_filters => "inclusionFilters",
    :scope => "scope",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
 
# File 'wisdom/cfn_knowledge_base.rb', line 1438

def to_jsii
  result = {}
  result.merge!({
    "urlConfiguration" => @url_configuration,
    "crawlerLimits" => @crawler_limits,
    "exclusionFilters" => @exclusion_filters,
    "inclusionFilters" => @inclusion_filters,
    "scope" => @scope,
  })
  result.compact
end