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

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() `CfnDataSource.WebCrawlerConfigurationProperty.AuthenticationConfiguration`.
default Number	getCrawlDepth() `CfnDataSource.WebCrawlerConfigurationProperty.CrawlDepth`.
default Number	getMaxContentSizePerPageInMegaBytes() `CfnDataSource.WebCrawlerConfigurationProperty.MaxContentSizePerPageInMegaBytes`.
default Number	getMaxLinksPerPage() `CfnDataSource.WebCrawlerConfigurationProperty.MaxLinksPerPage`.
default Number	getMaxUrlsPerMinuteCrawlRate() `CfnDataSource.WebCrawlerConfigurationProperty.MaxUrlsPerMinuteCrawlRate`.
default Object	getProxyConfiguration() `CfnDataSource.WebCrawlerConfigurationProperty.ProxyConfiguration`.
default List<String>	getUrlExclusionPatterns() `CfnDataSource.WebCrawlerConfigurationProperty.UrlExclusionPatterns`.
default List<String>	getUrlInclusionPatterns() `CfnDataSource.WebCrawlerConfigurationProperty.UrlInclusionPatterns`.
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 the 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()

`CfnDataSource.WebCrawlerConfigurationProperty.AuthenticationConfiguration`.

getCrawlDepth

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

`CfnDataSource.WebCrawlerConfigurationProperty.CrawlDepth`.

getMaxContentSizePerPageInMegaBytes

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

`CfnDataSource.WebCrawlerConfigurationProperty.MaxContentSizePerPageInMegaBytes`.

getMaxLinksPerPage

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

`CfnDataSource.WebCrawlerConfigurationProperty.MaxLinksPerPage`.

getMaxUrlsPerMinuteCrawlRate

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

`CfnDataSource.WebCrawlerConfigurationProperty.MaxUrlsPerMinuteCrawlRate`.

getProxyConfiguration

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

`CfnDataSource.WebCrawlerConfigurationProperty.ProxyConfiguration`.

getUrlExclusionPatterns

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

`CfnDataSource.WebCrawlerConfigurationProperty.UrlExclusionPatterns`.

getUrlInclusionPatterns

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

`CfnDataSource.WebCrawlerConfigurationProperty.UrlInclusionPatterns`.

builder

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

Returns:

a CfnDataSource.WebCrawlerConfigurationProperty.Builder of CfnDataSource.WebCrawlerConfigurationProperty