Package software.amazon.awscdk.services.kendra

Class CfnDataSource.WebCrawlerConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.kendra.CfnDataSource.WebCrawlerConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDataSource.WebCrawlerConfigurationProperty>

Enclosing interface:

CfnDataSource.WebCrawlerConfigurationProperty

@Stability(Stable)
public static final class CfnDataSource.WebCrawlerConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDataSource.WebCrawlerConfigurationProperty>

A builder for CfnDataSource.WebCrawlerConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDataSource.WebCrawlerConfigurationProperty.Builder	authenticationConfiguration(IResolvable authenticationConfiguration)	Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getAuthenticationConfiguration()
CfnDataSource.WebCrawlerConfigurationProperty.Builder	authenticationConfiguration(CfnDataSource.WebCrawlerAuthenticationConfigurationProperty authenticationConfiguration)	Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getAuthenticationConfiguration()
CfnDataSource.WebCrawlerConfigurationProperty	build()	Builds the configured instance.
CfnDataSource.WebCrawlerConfigurationProperty.Builder	crawlDepth(Number crawlDepth)	Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getCrawlDepth()
CfnDataSource.WebCrawlerConfigurationProperty.Builder	maxContentSizePerPageInMegaBytes(Number maxContentSizePerPageInMegaBytes)	Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getMaxContentSizePerPageInMegaBytes()
CfnDataSource.WebCrawlerConfigurationProperty.Builder	maxLinksPerPage(Number maxLinksPerPage)	Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getMaxLinksPerPage()
CfnDataSource.WebCrawlerConfigurationProperty.Builder	maxUrlsPerMinuteCrawlRate(Number maxUrlsPerMinuteCrawlRate)	Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getMaxUrlsPerMinuteCrawlRate()
CfnDataSource.WebCrawlerConfigurationProperty.Builder	proxyConfiguration(IResolvable proxyConfiguration)	Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getProxyConfiguration()
CfnDataSource.WebCrawlerConfigurationProperty.Builder	proxyConfiguration(CfnDataSource.ProxyConfigurationProperty proxyConfiguration)	Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getProxyConfiguration()
CfnDataSource.WebCrawlerConfigurationProperty.Builder	urlExclusionPatterns(List<String> urlExclusionPatterns)	Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getUrlExclusionPatterns()
CfnDataSource.WebCrawlerConfigurationProperty.Builder	urlInclusionPatterns(List<String> urlInclusionPatterns)	Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getUrlInclusionPatterns()
CfnDataSource.WebCrawlerConfigurationProperty.Builder	urls(IResolvable urls)	Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getUrls()
CfnDataSource.WebCrawlerConfigurationProperty.Builder	urls(CfnDataSource.WebCrawlerUrlsProperty urls)	Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getUrls()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

urls

@Stability(Stable)
public CfnDataSource.WebCrawlerConfigurationProperty.Builder urls(IResolvable urls)

Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getUrls()

Parameters:

urls - Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl. This parameter is required. 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.

Returns:

this

urls

@Stability(Stable)
public CfnDataSource.WebCrawlerConfigurationProperty.Builder urls(CfnDataSource.WebCrawlerUrlsProperty urls)

Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getUrls()

Parameters:

urls - Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl. This parameter is required. 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.

Returns:

this

authenticationConfiguration

@Stability(Stable)
public CfnDataSource.WebCrawlerConfigurationProperty.Builder authenticationConfiguration(IResolvable authenticationConfiguration)

Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getAuthenticationConfiguration()

Parameters:

authenticationConfiguration - 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.

Returns:

this

authenticationConfiguration

@Stability(Stable)
public CfnDataSource.WebCrawlerConfigurationProperty.Builder authenticationConfiguration(CfnDataSource.WebCrawlerAuthenticationConfigurationProperty authenticationConfiguration)

Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getAuthenticationConfiguration()

Parameters:

authenticationConfiguration - 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.

Returns:

this

crawlDepth

@Stability(Stable)
public CfnDataSource.WebCrawlerConfigurationProperty.Builder crawlDepth(Number crawlDepth)

Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getCrawlDepth()

Parameters:

crawlDepth - 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.

Returns:

this

maxContentSizePerPageInMegaBytes

@Stability(Stable)
public CfnDataSource.WebCrawlerConfigurationProperty.Builder maxContentSizePerPageInMegaBytes(Number maxContentSizePerPageInMegaBytes)

Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getMaxContentSizePerPageInMegaBytes()

Parameters:

maxContentSizePerPageInMegaBytes - 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.

Returns:

this

maxLinksPerPage

@Stability(Stable)
public CfnDataSource.WebCrawlerConfigurationProperty.Builder maxLinksPerPage(Number maxLinksPerPage)

Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getMaxLinksPerPage()

Parameters:

maxLinksPerPage - 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.

Returns:

this

maxUrlsPerMinuteCrawlRate

@Stability(Stable)
public CfnDataSource.WebCrawlerConfigurationProperty.Builder maxUrlsPerMinuteCrawlRate(Number maxUrlsPerMinuteCrawlRate)

Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getMaxUrlsPerMinuteCrawlRate()

Parameters:

maxUrlsPerMinuteCrawlRate - 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.

Returns:

this

proxyConfiguration

@Stability(Stable)
public CfnDataSource.WebCrawlerConfigurationProperty.Builder proxyConfiguration(IResolvable proxyConfiguration)

Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getProxyConfiguration()

Parameters:

proxyConfiguration - 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 .

Returns:

this

proxyConfiguration

@Stability(Stable)
public CfnDataSource.WebCrawlerConfigurationProperty.Builder proxyConfiguration(CfnDataSource.ProxyConfigurationProperty proxyConfiguration)

Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getProxyConfiguration()

Parameters:

proxyConfiguration - 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 .

Returns:

this

urlExclusionPatterns

@Stability(Stable)
public CfnDataSource.WebCrawlerConfigurationProperty.Builder urlExclusionPatterns(List<String> urlExclusionPatterns)

Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getUrlExclusionPatterns()

Parameters:

urlExclusionPatterns - 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.

Returns:

this

urlInclusionPatterns

@Stability(Stable)
public CfnDataSource.WebCrawlerConfigurationProperty.Builder urlInclusionPatterns(List<String> urlInclusionPatterns)

Sets the value of CfnDataSource.WebCrawlerConfigurationProperty.getUrlInclusionPatterns()

Parameters:

urlInclusionPatterns - 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.

Returns:

this

build

@Stability(Stable)
public CfnDataSource.WebCrawlerConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDataSource.WebCrawlerConfigurationProperty>

Returns:

a new instance of CfnDataSource.WebCrawlerConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided