generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructs • Docs

---

@cdklabs/generative-ai-cdk-constructs / WebCrawler

Class: WebCrawler

Extends

• BaseClass

Constructors

new WebCrawler()

new WebCrawler(scope, id, props): WebCrawler

Constructs a new instance of the WebCrawler class.

Parameters

• scope: Construct

represents the scope for all the resources.

• id: string

this is a a scope-unique id.

• props: WebCrawlerProps

user provided props for the construct.

Returns

WebCrawler

Since

0.0.0

Deprecated

This construct is deprecated and will be removed in a future major version. It will not receive security updates.

Overrides

BaseClass.constructor

Properties

constructUsageMetric

readonly constructUsageMetric: "uksb-1tupboc45" = 'uksb-1tupboc45'

construct usage metric , added in template description

Inherited from

BaseClass.constructUsageMetric

---

dataBucket

readonly dataBucket: IBucket

Returns the instance of S3 bucket used by the construct

---

enablexray

enablexray: boolean = true

enable disable xray tracing

Default

- True

Inherited from

BaseClass.enablexray

---

fieldLogLevel

fieldLogLevel: FieldLogLevel = appsync.FieldLogLevel.ALL

Default log config for all constructs

Inherited from

BaseClass.fieldLogLevel

---

jobQueue

readonly jobQueue: IJobQueue

Returns the instance of JobQueue used by the construct

---

jobsTable

readonly jobsTable: ITable

Returns the instance of Jobs DynamoDB table

---

lambdaCrawler

readonly lambdaCrawler: undefined | IFunction

Lambda crawler

---

lambdaCrawlerApiSchemaPath

readonly lambdaCrawlerApiSchemaPath: string

Lambda crawler API schema path

---

lambdaTracing

lambdaTracing: Tracing = lambda.Tracing.ACTIVE

enable disable lambda tracing

Default

- Active

Inherited from

BaseClass.lambdaTracing

---

node

readonly node: Node

The tree node.

Inherited from

BaseClass.node

---

retention

retention: RetentionDays = logs.RetentionDays.TEN_YEARS

Default log retention config for all constructs

Inherited from

BaseClass.retention

---

snsTopic

readonly snsTopic: ITopic

Returns the instance of SNS Topic used by the construct

---

stage

stage: string

Value will be appended to resources name.

Default

- _dev

Inherited from

BaseClass.stage

---

targetsTable

readonly targetsTable: ITable

Returns the instance of Targets DynamoDB table

---

vpc

readonly vpc: IVpc

Returns the instance of ec2.IVpc used by the construct

---

webCrawlerJobDefinition

readonly webCrawlerJobDefinition: IJobDefinition

Returns the instance of JobDefinition used by the construct

---

usageMetricMap

protected static usageMetricMap: Record<string, number>

Record<string, number> , maps construct name with number of deployments

Inherited from

BaseClass.usageMetricMap

Methods

addObservabilityToConstruct()

protected addObservabilityToConstruct(props): void

Parameters

• props: BaseClassProps

Returns

void

Inherited from

BaseClass.addObservabilityToConstruct

---

toString()

toString(): string

Returns a string representation of this construct.

Returns

string

Inherited from

BaseClass.toString

---

updateConstructUsageMetricCode()

protected updateConstructUsageMetricCode(props, scope, lambdaFunctions): void

Parameters

• props: BaseClassProps

• scope: Construct

• lambdaFunctions: DockerImageFunction[]

Returns

void

Inherited from

BaseClass.updateConstructUsageMetricCode

---

updateEnvSuffix()

protected updateEnvSuffix(props): void

Parameters

• props: BaseClassProps

Returns

void

Inherited from

BaseClass.updateEnvSuffix

---

isConstruct()

static isConstruct(x): x is Construct

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

• x: any

Any object

Returns

x is Construct

true if x is an object created from a class which extends Construct.

Inherited from

BaseClass.isConstruct

This site is open source. Improve this page.