Package software.amazon.awscdk.services.kendra

Class CfnDataSource.WebCrawlerConfigurationProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.kendra.CfnDataSource.WebCrawlerConfigurationProperty.Jsii$Proxy

All Implemented Interfaces:

CfnDataSource.WebCrawlerConfigurationProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnDataSource.WebCrawlerConfigurationProperty

@Stability(Stable)
@Internal
public static final class CfnDataSource.WebCrawlerConfigurationProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnDataSource.WebCrawlerConfigurationProperty

An implementation for CfnDataSource.WebCrawlerConfigurationProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.kendra.CfnDataSource.WebCrawlerConfigurationProperty

CfnDataSource.WebCrawlerConfigurationProperty.Builder, CfnDataSource.WebCrawlerConfigurationProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnDataSource.WebCrawlerConfigurationProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnDataSource.WebCrawlerConfigurationProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAuthenticationConfiguration()	Configuration information required to connect to websites using authentication.
final Number	getCrawlDepth()	The 'depth' or number of levels from the seed level to crawl.
final Number	getMaxContentSizePerPageInMegaBytes()	The maximum size (in MB) of a web page or attachment to crawl.
final Number	getMaxLinksPerPage()	The maximum number of URLs on a web page to include when crawling a website.
final Number	getMaxUrlsPerMinuteCrawlRate()	The maximum number of URLs crawled per website host per minute.
final Object	getProxyConfiguration()	Configuration information required to connect to your internal websites via a web proxy.
final List<String>	getUrlExclusionPatterns()	A list of regular expression patterns to exclude certain URLs to crawl.
final List<String>	getUrlInclusionPatterns()	A list of regular expression patterns to include certain URLs to crawl.
final Object	getUrls()	Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnDataSource.WebCrawlerConfigurationProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnDataSource.WebCrawlerConfigurationProperty.Builder.

Method Details

getUrls

public final Object getUrls()

Description copied from interface: CfnDataSource.WebCrawlerConfigurationProperty

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.

Specified by:

getUrls in interface CfnDataSource.WebCrawlerConfigurationProperty

getAuthenticationConfiguration

public final Object getAuthenticationConfiguration()

Description copied from interface: CfnDataSource.WebCrawlerConfigurationProperty

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.

Specified by:

getAuthenticationConfiguration in interface CfnDataSource.WebCrawlerConfigurationProperty

getCrawlDepth

public final Number getCrawlDepth()

Description copied from interface: CfnDataSource.WebCrawlerConfigurationProperty

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.

Specified by:

getCrawlDepth in interface CfnDataSource.WebCrawlerConfigurationProperty

getMaxContentSizePerPageInMegaBytes

public final Number getMaxContentSizePerPageInMegaBytes()

Description copied from interface: CfnDataSource.WebCrawlerConfigurationProperty

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.

Specified by:

getMaxContentSizePerPageInMegaBytes in interface CfnDataSource.WebCrawlerConfigurationProperty

getMaxLinksPerPage

public final Number getMaxLinksPerPage()

Description copied from interface: CfnDataSource.WebCrawlerConfigurationProperty

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.

Specified by:

getMaxLinksPerPage in interface CfnDataSource.WebCrawlerConfigurationProperty

getMaxUrlsPerMinuteCrawlRate

public final Number getMaxUrlsPerMinuteCrawlRate()

Description copied from interface: CfnDataSource.WebCrawlerConfigurationProperty

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.

Specified by:

getMaxUrlsPerMinuteCrawlRate in interface CfnDataSource.WebCrawlerConfigurationProperty

getProxyConfiguration

public final Object getProxyConfiguration()

Description copied from interface: CfnDataSource.WebCrawlerConfigurationProperty

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 .

Specified by:

getProxyConfiguration in interface CfnDataSource.WebCrawlerConfigurationProperty

getUrlExclusionPatterns

public final List<String> getUrlExclusionPatterns()

Description copied from interface: CfnDataSource.WebCrawlerConfigurationProperty

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.

Specified by:

getUrlExclusionPatterns in interface CfnDataSource.WebCrawlerConfigurationProperty

getUrlInclusionPatterns

public final List<String> getUrlInclusionPatterns()

Description copied from interface: CfnDataSource.WebCrawlerConfigurationProperty

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.

Specified by:

getUrlInclusionPatterns in interface CfnDataSource.WebCrawlerConfigurationProperty

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object