Package software.amazon.awscdk.services.kendra

Interface CfnDataSource.WebCrawlerUrlsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.WebCrawlerUrlsProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(Stable)
public static interface CfnDataSource.WebCrawlerUrlsProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // 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.*;
 WebCrawlerUrlsProperty webCrawlerUrlsProperty = WebCrawlerUrlsProperty.builder()
         .seedUrlConfiguration(WebCrawlerSeedUrlConfigurationProperty.builder()
                 .seedUrls(List.of("seedUrls"))
                 // the properties below are optional
                 .webCrawlerMode("webCrawlerMode")
                 .build())
         .siteMapsConfiguration(WebCrawlerSiteMapsConfigurationProperty.builder()
                 .siteMaps(List.of("siteMaps"))
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataSource.WebCrawlerUrlsProperty.Builder	A builder for CfnDataSource.WebCrawlerUrlsProperty
static final class	CfnDataSource.WebCrawlerUrlsProperty.Jsii$Proxy	An implementation for CfnDataSource.WebCrawlerUrlsProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.WebCrawlerUrlsProperty.Builder	builder()
default Object	getSeedUrlConfiguration()	Configuration of the seed or starting point URLs of the websites you want to crawl.
default Object	getSiteMapsConfiguration()	Configuration of the sitemap URLs of the websites you want to crawl.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSeedUrlConfiguration

@Stability(Stable)
@Nullable
default Object getSeedUrlConfiguration()

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.

See Also:

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

getSiteMapsConfiguration

@Stability(Stable)
@Nullable
default Object getSiteMapsConfiguration()

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.

See Also:

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

builder

@Stability(Stable)
static CfnDataSource.WebCrawlerUrlsProperty.Builder builder()

Returns:

a CfnDataSource.WebCrawlerUrlsProperty.Builder of CfnDataSource.WebCrawlerUrlsProperty