Class: AWSCDK::Kendra::CfnDataSource::WebCrawlerSeedURLConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Kendra::CfnDataSource::WebCrawlerSeedURLConfigurationProperty

Defined in:

kendra/cfn_data_source.rb

Overview

Provides the configuration information of the seed or starting point URLs to crawl.

When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.

See Also:

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

Instance Attribute Summary

• #seed_urls ⇒ Array<String> readonly

  The list of seed or starting point URLs of the websites you want to crawl.

• #web_crawler_mode ⇒ String^? readonly

  You can choose one of the following modes:.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(seed_urls:, web_crawler_mode: nil) ⇒ WebCrawlerSeedURLConfigurationProperty constructor

  A new instance of WebCrawlerSeedURLConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(seed_urls:, web_crawler_mode: nil) ⇒ WebCrawlerSeedURLConfigurationProperty

Returns a new instance of WebCrawlerSeedURLConfigurationProperty.

Parameters:

• seed_urls (Array<String>) —

  The list of seed or starting point URLs of the websites you want to crawl.

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

  You can choose one of the following modes:.

# File 'kendra/cfn_data_source.rb', line 3946

def initialize(seed_urls:, web_crawler_mode: nil)
  @seed_urls = seed_urls
  Jsii::Type.check_type(@seed_urls, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "seedUrls")
  @web_crawler_mode = web_crawler_mode
  Jsii::Type.check_type(@web_crawler_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "webCrawlerMode") unless @web_crawler_mode.nil?
end

Instance Attribute Details

#seed_urls ⇒ Array<String> (readonly)

The list of seed or starting point URLs of the websites you want to crawl.

The list can include a maximum of 100 seed URLs.

Returns:

• (Array<String>)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerseedurlconfiguration.html#cfn-kendra-datasource-webcrawlerseedurlconfiguration-seedurls

# File 'kendra/cfn_data_source.rb', line 3959

def seed_urls
  @seed_urls
end

#web_crawler_mode ⇒ String^? (readonly)

You can choose one of the following modes:.

• HOST_ONLY —crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.
• SUBDOMAINS —crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.
• EVERYTHING —crawl the website host names with subdomains and other domains that the web pages link to.

The default mode is set to HOST_ONLY .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerseedurlconfiguration.html#cfn-kendra-datasource-webcrawlerseedurlconfiguration-webcrawlermode

# File 'kendra/cfn_data_source.rb', line 3970

def web_crawler_mode
  @web_crawler_mode
end

Class Method Details

.jsii_properties ⇒ Object

# File 'kendra/cfn_data_source.rb', line 3972

def self.jsii_properties
  {
    :seed_urls => "seedUrls",
    :web_crawler_mode => "webCrawlerMode",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'kendra/cfn_data_source.rb', line 3979

def to_jsii
  result = {}
  result.merge!({
    "seedUrls" => @seed_urls,
    "webCrawlerMode" => @web_crawler_mode,
  })
  result.compact
end