Class: AWSCDK::Kendra::CfnDataSource::WebCrawlerURLsProperty

Inherits:

Jsii::Struct

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

Defined in:

kendra/cfn_data_source.rb

Overview

Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.

You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.

You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.

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-webcrawlerurls.html

Instance Attribute Summary

• #seed_url_configuration ⇒ AWSCDK::IResolvable, ... readonly

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

• #site_maps_configuration ⇒ AWSCDK::IResolvable, ... readonly

  Configuration of the sitemap URLs of the websites you want to crawl.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(seed_url_configuration: nil, site_maps_configuration: nil) ⇒ WebCrawlerURLsProperty constructor

  A new instance of WebCrawlerURLsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(seed_url_configuration: nil, site_maps_configuration: nil) ⇒ WebCrawlerURLsProperty

Returns a new instance of WebCrawlerURLsProperty.

Parameters:

• seed_url_configuration (AWSCDK::IResolvable, AWSCDK::Kendra::CfnDataSource::WebCrawlerSeedURLConfigurationProperty, nil) (defaults to: nil) —

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

• site_maps_configuration (AWSCDK::IResolvable, AWSCDK::Kendra::CfnDataSource::WebCrawlerSiteMapsConfigurationProperty, nil) (defaults to: nil) —

  Configuration of the sitemap URLs of the websites you want to crawl.

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

def initialize(seed_url_configuration: nil, site_maps_configuration: nil)
  @seed_url_configuration = seed_url_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::WebCrawlerSeedURLConfigurationProperty.new(**seed_url_configuration.transform_keys(&:to_sym)) : seed_url_configuration
  Jsii::Type.check_type(@seed_url_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5XZWJDcmF3bGVyU2VlZFVybENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "seedUrlConfiguration") unless @seed_url_configuration.nil?
  @site_maps_configuration = site_maps_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::WebCrawlerSiteMapsConfigurationProperty.new(**site_maps_configuration.transform_keys(&:to_sym)) : site_maps_configuration
  Jsii::Type.check_type(@site_maps_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5XZWJDcmF3bGVyU2l0ZU1hcHNDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "siteMapsConfiguration") unless @site_maps_configuration.nil?
end

Instance Attribute Details

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

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

You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the web pages link to.

You can list up to 100 seed URLs.

Returns:

• (AWSCDK::IResolvable, AWSCDK::Kendra::CfnDataSource::WebCrawlerSeedURLConfigurationProperty, nil)

See Also:

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

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

def seed_url_configuration
  @seed_url_configuration
end

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

Configuration of the sitemap URLs of the websites you want to crawl.

Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.

Returns:

• (AWSCDK::IResolvable, AWSCDK::Kendra::CfnDataSource::WebCrawlerSiteMapsConfigurationProperty, nil)

See Also:

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

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

def site_maps_configuration
  @site_maps_configuration
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :seed_url_configuration => "seedUrlConfiguration",
    :site_maps_configuration => "siteMapsConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "seedUrlConfiguration" => @seed_url_configuration,
    "siteMapsConfiguration" => @site_maps_configuration,
  })
  result.compact
end