Interface CfnDataSource.WebCrawlerConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDataSource.WebCrawlerConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnDataSource
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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnDataSource.WebCrawlerConfigurationPropertystatic final classAn implementation forCfnDataSource.WebCrawlerConfigurationProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectConfiguration information required to connect to websites using authentication.default NumberThe 'depth' or number of levels from the seed level to crawl.default NumberThe maximum size (in MB) of a web page or attachment to crawl.default NumberThe maximum number of URLs on a web page to include when crawling a website.default NumberThe maximum number of URLs crawled per website host per minute.default ObjectConfiguration information required to connect to your internal websites via a web proxy.A list of regular expression patterns to exclude certain URLs to crawl.A list of regular expression patterns to include certain URLs to crawl.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 Details
-
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.
- See Also:
-
getAuthenticationConfiguration
Configuration information required to connect to websites using authentication.You can connect to websites using basic authentication of user name and password. You use a secret in AWS Secrets Manager to store your authentication credentials.
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.
- See Also:
-
getCrawlDepth
The 'depth' or number of levels from the seed level to crawl.For example, the seed URL page is depth 1 and any hyperlinks on this page that are also crawled are depth 2.
- See Also:
-
getMaxContentSizePerPageInMegaBytes
The maximum size (in MB) of a web page or attachment to crawl.Files larger than this size (in MB) are skipped/not crawled.
The default maximum size of a web page or attachment is set to 50 MB.
- See Also:
-
getMaxLinksPerPage
The maximum number of URLs on a web page to include when crawling a website.This number is per web page.
As a website’s web pages are crawled, any URLs the web pages link to are also crawled. URLs on a web page are crawled in order of appearance.
The default maximum links per page is 100.
- See Also:
-
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.
- See Also:
-
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 .
- See Also:
-
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.
- See Also:
-
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.
- See Also:
-
builder
-