Class: VectorKnowledgeBase

May 8, 2026 · View on GitHub

@cdklabs/generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructs / bedrock / VectorKnowledgeBase

Class: VectorKnowledgeBase

Deploys a Bedrock Knowledge Base and configures a backend by OpenSearch Serverless, Pinecone, Redis Enterprise Cloud or Amazon Aurora PostgreSQL.

Constructors

Constructor

new VectorKnowledgeBase(scope, id, props): VectorKnowledgeBase

Parameters

Properties

description?

readonly optional description?: string

A description of the knowledge base.

instruction?

readonly optional instruction?: string

Instructions for agents based on the design and type of information of the Knowledge Base. This will impact how Agents interact with the Knowledge Base.

knowledgeBaseArn

readonly knowledgeBaseArn: string

The ARN of the knowledge base.

Overrides

VectorKnowledgeBaseBase.knowledgeBaseArn

knowledgeBaseId

readonly knowledgeBaseId: string

The ID of the knowledge base.

Overrides

VectorKnowledgeBaseBase.knowledgeBaseId

knowledgeBaseInstance

readonly knowledgeBaseInstance: CfnKnowledgeBase

Instance of knowledge base.

name

readonly name: string

The name of the knowledge base.

node

readonly node: Node

The tree node.

role

readonly role: IRole

The role the Knowledge Base uses to access the vector store and data source.

type

readonly type: KnowledgeBaseType = KnowledgeBaseType.VECTOR

The type of knowledge base.

vectorStore

readonly vectorStore: ExistingAmazonAuroraVectorStore | AmazonAuroraVectorStore | MongoDBAtlasVectorStore | VectorCollection | OpenSearchManagedClusterVectorStore | PineconeVectorStore | VectorIndex

The vector store for the knowledge base.

vectorStoreType

readonly vectorStoreType: VectorStoreType

The type of the knowledge base.

Overrides

VectorKnowledgeBaseBase.vectorStoreType

Accessors

env

Get Signature

get env(): ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns

ResourceEnvironment

The environment this resource belongs to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Inherited from

VectorKnowledgeBaseBase.env

physicalName

Get Signature

get protected physicalName(): string

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

a concrete value (e.g. "my-awesome-bucket")
undefined, when a name should be generated by CloudFormation
a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns

string

Inherited from

VectorKnowledgeBaseBase.physicalName

stack

Get Signature

get stack(): Stack

The stack in which this resource is defined.

Returns

Stack

The stack in which this resource is defined.

Inherited from

VectorKnowledgeBaseBase.stack

Methods

_enableCrossEnvironment()

_enableCrossEnvironment(): void

Internal

Called when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.

Returns

void

Inherited from

VectorKnowledgeBaseBase._enableCrossEnvironment

addConfluenceDataSource()

addConfluenceDataSource(props): ConfluenceDataSource

Add a Confluence data source to the knowledge base.

Parameters

addCustomDataSource()

addCustomDataSource(props): CustomDataSource

Add a Custom data source to the knowledge base.

Parameters

props

CustomDataSourceAssociationProps

Returns

CustomDataSource

Inherited from

VectorKnowledgeBaseBase.addCustomDataSource

addS3DataSource()

addS3DataSource(props): S3DataSource

Adds an S3 data source to the knowledge base.

Parameters

props

S3DataSourceAssociationProps

Returns

S3DataSource

Inherited from

VectorKnowledgeBaseBase.addS3DataSource

addSalesforceDataSource()

addSalesforceDataSource(props): SalesforceDataSource

Add a Salesforce data source to the knowledge base.

Parameters

props

SalesforceDataSourceAssociationProps

Returns

SalesforceDataSource

Inherited from

VectorKnowledgeBaseBase.addSalesforceDataSource

addSharePointDataSource()

addSharePointDataSource(props): SharePointDataSource

Add a SharePoint data source to the knowledge base.

Parameters

props

SharePointDataSourceAssociationProps

Returns

SharePointDataSource

Inherited from

VectorKnowledgeBaseBase.addSharePointDataSource

addWebCrawlerDataSource()

addWebCrawlerDataSource(props): WebCrawlerDataSource

Add a web crawler data source to the knowledge base.

Parameters

props

WebCrawlerDataSourceAssociationProps

Returns

WebCrawlerDataSource

Inherited from

VectorKnowledgeBaseBase.addWebCrawlerDataSource

applyRemovalPolicy()

applyRemovalPolicy(policy): void

Apply the given removal policy to this resource

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters

policy

RemovalPolicy

Returns

void

Inherited from

VectorKnowledgeBaseBase.applyRemovalPolicy

associateToAgent()

associateToAgent(agent): void

Associate knowledge base with an agent

Parameters

agent

Agent

Returns

void

generatePhysicalName()

protected generatePhysicalName(): string

Returns

string

Inherited from

VectorKnowledgeBaseBase.generatePhysicalName

getResourceArnAttribute()

protected getResourceArnAttribute(arnAttr, arnComponents): string

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arnAttr, but if the resource is referenced across environments, arnComponents will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arnComponents.

Parameters

arnAttr

string

The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes it's the CFN resource's ref.

arnComponents

ArnComponents

The format of the ARN of this resource. You must reference this.physicalName somewhere within the ARN in order for cross-environment references to work.

Returns

string

Inherited from

VectorKnowledgeBaseBase.getResourceArnAttribute

getResourceNameAttribute()

protected getResourceNameAttribute(nameAttr): string

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to nameAttr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters

nameAttr

string

The CFN attribute which resolves to the resource's name. Commonly this is the resource's ref.

Returns

string

Inherited from

VectorKnowledgeBaseBase.getResourceNameAttribute

grant()

grant(grantee, ...actions): Grant

Grant the given principal identity permissions to perform actions on this knowledge base.

Parameters

grantee

IGrantable

actions

...string[]

Returns

Grant

Inherited from

VectorKnowledgeBaseBase.grant

grantQuery()

grantQuery(grantee): Grant

Grant the given identity permissions to query the knowledge base. This contains:

Retrieve
RetrieveAndGenerate

Parameters

grantee

IGrantable

Returns

Grant

Inherited from

VectorKnowledgeBaseBase.grantQuery

grantRetrieve()

grantRetrieve(grantee): Grant

Grant the given identity permissions to retrieve content from the knowledge base.

Parameters

grantee

IGrantable

Returns

Grant

Inherited from

VectorKnowledgeBaseBase.grantRetrieve

grantRetrieveAndGenerate()

grantRetrieveAndGenerate(grantee): Grant

Grant the given identity permissions to retrieve content from the knowledge base.

Parameters

grantee

IGrantable

Returns

Grant

Inherited from

VectorKnowledgeBaseBase.grantRetrieveAndGenerate

toString()

toString(): string

Returns a string representation of this construct.

Returns

string

Inherited from

VectorKnowledgeBaseBase.toString

with()

with(...mixins): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters

mixins

...IMixin[]

The mixins to apply

Returns

IConstruct

This construct for chaining

Inherited from

VectorKnowledgeBaseBase.with

fromKnowledgeBaseAttributes()

static fromKnowledgeBaseAttributes(scope, id, attrs): IVectorKnowledgeBase

Parameters

scope

Construct

id

string

attrs

VectorKnowledgeBaseAttributes

Returns

IVectorKnowledgeBase

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.

static isOwnedResource(construct): boolean

Returns true if the construct was created by CDK, and false otherwise

static isResource(construct): construct is Resource

Check whether the given construct is a Resource