Package software.amazon.awscdk.services.kendra

Interface CfnDataSource.WebCrawlerSeedUrlConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.WebCrawlerSeedUrlConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(Stable)
public static interface CfnDataSource.WebCrawlerSeedUrlConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Provides the configuration information of the seed or starting point URLs to crawl.

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.

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.*;
 WebCrawlerSeedUrlConfigurationProperty webCrawlerSeedUrlConfigurationProperty = WebCrawlerSeedUrlConfigurationProperty.builder()
         .seedUrls(List.of("seedUrls"))
         // the properties below are optional
         .webCrawlerMode("webCrawlerMode")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerseedurlconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.WebCrawlerSeedUrlConfigurationProperty.Builder	builder()
List<String>	getSeedUrls()	The list of seed or starting point URLs of the websites you want to crawl.
default String	getWebCrawlerMode()	You can choose one of the following modes:.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSeedUrls

@Stability(Stable)
@NotNull
List<String> getSeedUrls()

The list of seed or starting point URLs of the websites you want to crawl.

The list can include a maximum of 100 seed URLs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerseedurlconfiguration.html#cfn-kendra-datasource-webcrawlerseedurlconfiguration-seedurls

getWebCrawlerMode

@Stability(Stable)
@Nullable
default String getWebCrawlerMode()

You can choose one of the following modes:.

• HOST_ONLY —crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.
• SUBDOMAINS —crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.
• EVERYTHING —crawl the website host names with subdomains and other domains that the web pages link to.

The default mode is set to HOST_ONLY .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerseedurlconfiguration.html#cfn-kendra-datasource-webcrawlerseedurlconfiguration-webcrawlermode

builder

@Stability(Stable)
static CfnDataSource.WebCrawlerSeedUrlConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.WebCrawlerSeedUrlConfigurationProperty.Builder of CfnDataSource.WebCrawlerSeedUrlConfigurationProperty