Package software.amazon.awscdk.services.wisdom

Interface CfnKnowledgeBase.WebCrawlerConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKnowledgeBase.WebCrawlerConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnKnowledgeBase

@Stability(Stable)
public static interface CfnKnowledgeBase.WebCrawlerConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The configuration details for the web data source.

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.wisdom.*;
 WebCrawlerConfigurationProperty webCrawlerConfigurationProperty = WebCrawlerConfigurationProperty.builder()
         .urlConfiguration(UrlConfigurationProperty.builder()
                 .seedUrls(List.of(SeedUrlProperty.builder()
                         .url("url")
                         .build()))
                 .build())
         // the properties below are optional
         .crawlerLimits(CrawlerLimitsProperty.builder()
                 .rateLimit(123)
                 .build())
         .exclusionFilters(List.of("exclusionFilters"))
         .inclusionFilters(List.of("inclusionFilters"))
         .scope("scope")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-webcrawlerconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnKnowledgeBase.WebCrawlerConfigurationProperty.Builder	builder()
default Object	getCrawlerLimits()	The configuration of crawl limits for the web URLs.
default List<String>	getExclusionFilters()	A list of one or more exclusion regular expression patterns to exclude certain URLs.
default List<String>	getInclusionFilters()	A list of one or more inclusion regular expression patterns to include certain URLs.
default String	getScope()	The scope of what is crawled for your URLs.
Object	getUrlConfiguration()	The configuration of the URL/URLs for the web content that you want to crawl.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getUrlConfiguration

@Stability(Stable)
@NotNull
Object getUrlConfiguration()

The configuration of the URL/URLs for the web content that you want to crawl.

You should be authorized to crawl the URLs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-webcrawlerconfiguration.html#cfn-wisdom-knowledgebase-webcrawlerconfiguration-urlconfiguration

getCrawlerLimits

@Stability(Stable)
@Nullable
default Object getCrawlerLimits()

The configuration of crawl limits for the web URLs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-webcrawlerconfiguration.html#cfn-wisdom-knowledgebase-webcrawlerconfiguration-crawlerlimits

getExclusionFilters

@Stability(Stable)
@Nullable
default List<String> getExclusionFilters()

A list of one or more exclusion regular expression patterns to exclude certain URLs.

If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-webcrawlerconfiguration.html#cfn-wisdom-knowledgebase-webcrawlerconfiguration-exclusionfilters

getInclusionFilters

@Stability(Stable)
@Nullable
default List<String> getInclusionFilters()

A list of one or more inclusion regular expression patterns to include certain URLs.

If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-webcrawlerconfiguration.html#cfn-wisdom-knowledgebase-webcrawlerconfiguration-inclusionfilters

getScope

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

The scope of what is crawled for your URLs.

You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL https://docs.aws.amazon.com/bedrock/latest/userguide/ and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain aws.amazon.com can also include sub domain docs.aws.amazon.com .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-webcrawlerconfiguration.html#cfn-wisdom-knowledgebase-webcrawlerconfiguration-scope

builder

@Stability(Stable)
static CfnKnowledgeBase.WebCrawlerConfigurationProperty.Builder builder()

Returns:

a CfnKnowledgeBase.WebCrawlerConfigurationProperty.Builder of CfnKnowledgeBase.WebCrawlerConfigurationProperty