software.amazon.awscdk.services.kendra

Interface CfnDataSource.WebCrawlerConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.WebCrawlerConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(value=Stable)
public static interface CfnDataSource.WebCrawlerConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Provides the configuration information required for Amazon Kendra Web Crawler.

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.*;
 WebCrawlerConfigurationProperty webCrawlerConfigurationProperty = WebCrawlerConfigurationProperty.builder()
         .urls(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())
         // the properties below are optional
         .authenticationConfiguration(WebCrawlerAuthenticationConfigurationProperty.builder()
                 .basicAuthentication(List.of(WebCrawlerBasicAuthenticationProperty.builder()
                         .credentials("credentials")
                         .host("host")
                         .port(123)
                         .build()))
                 .build())
         .crawlDepth(123)
         .maxContentSizePerPageInMegaBytes(123)
         .maxLinksPerPage(123)
         .maxUrlsPerMinuteCrawlRate(123)
         .proxyConfiguration(ProxyConfigurationProperty.builder()
                 .host("host")
                 .port(123)
                 // the properties below are optional
                 .credentials("credentials")
                 .build())
         .urlExclusionPatterns(List.of("urlExclusionPatterns"))
         .urlInclusionPatterns(List.of("urlInclusionPatterns"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.WebCrawlerConfigurationProperty.Builder	builder()
default Object	getAuthenticationConfiguration() Configuration information required to connect to websites using authentication.
default Number	getCrawlDepth() Specifies the number of levels in a website that you want to crawl.
default Number	getMaxContentSizePerPageInMegaBytes() The maximum size (in MB) of a webpage or attachment to crawl.
default Number	getMaxLinksPerPage() The maximum number of URLs on a webpage to include when crawling a website.
default Number	getMaxUrlsPerMinuteCrawlRate() The maximum number of URLs crawled per website host per minute.
default Object	getProxyConfiguration() Configuration information required to connect to your internal websites via a web proxy.
default List<String>	getUrlExclusionPatterns() A list of regular expression patterns to exclude certain URLs to crawl.
default List<String>	getUrlInclusionPatterns() A list of regular expression patterns to include certain URLs to crawl.
Object	getUrls() Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getUrls

@Stability(value=Stable)
 @NotNull
Object getUrls()

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 Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index.

getAuthenticationConfiguration

@Stability(value=Stable)
 @Nullable
default Object getAuthenticationConfiguration()

Configuration information required to connect to websites using authentication.

You can connect to websites using basic authentication of user name and password.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS. You use a secret in AWS Secrets Manager to store your authentication credentials.

getCrawlDepth

@Stability(value=Stable)
 @Nullable
default Number getCrawlDepth()

Specifies the number of levels in a website that you want to crawl.

The first level begins from the website seed or starting point URL. For example, if a website has 3 levels – index level (i.e. seed in this example), sections level, and subsections level – and you are only interested in crawling information up to the sections level (i.e. levels 0-1), you can set your depth to 1.

The default crawl depth is set to 2.

getMaxContentSizePerPageInMegaBytes

@Stability(value=Stable)
 @Nullable
default Number getMaxContentSizePerPageInMegaBytes()

The maximum size (in MB) of a webpage or attachment to crawl.

Files larger than this size (in MB) are skipped/not crawled.

The default maximum size of a webpage or attachment is set to 50 MB.

getMaxLinksPerPage

@Stability(value=Stable)
 @Nullable
default Number getMaxLinksPerPage()

The maximum number of URLs on a webpage to include when crawling a website. This number is per webpage.

As a website’s webpages are crawled, any URLs the webpages link to are also crawled. URLs on a webpage are crawled in order of appearance.

The default maximum links per page is 100.

getMaxUrlsPerMinuteCrawlRate

@Stability(value=Stable)
 @Nullable
default Number getMaxUrlsPerMinuteCrawlRate()

The maximum number of URLs crawled per website host per minute.

A minimum of one URL is required.

The default maximum number of URLs crawled per website host per minute is 300.

getProxyConfiguration

@Stability(value=Stable)
 @Nullable
default Object getProxyConfiguration()

Configuration information required to connect to your internal websites via a web proxy.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in AWS Secrets Manager .

getUrlExclusionPatterns

@Stability(value=Stable)
 @Nullable
default List<String> getUrlExclusionPatterns()

A list of regular expression patterns to exclude certain URLs to crawl.

URLs that match the patterns are excluded from the index. URLs that don't match the patterns are included in the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.

getUrlInclusionPatterns

@Stability(value=Stable)
 @Nullable
default List<String> getUrlInclusionPatterns()

A list of regular expression patterns to include certain URLs to crawl.

URLs that match the patterns are included in the index. URLs that don't match the patterns are excluded from the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.

builder

@Stability(value=Stable)
static CfnDataSource.WebCrawlerConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.WebCrawlerConfigurationProperty.Builder of CfnDataSource.WebCrawlerConfigurationProperty