Interface: IVectorKnowledgeBase

May 8, 2026 · View on GitHub

@cdklabs/generative-ai-cdk-constructs

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

Interface: IVectorKnowledgeBase

Represents a Knowledge Base, either created with CDK or imported.

Properties

description?

readonly optional description?: string

The description of the knowledge base.

env

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

Inherited from

IKnowledgeBase.env

instruction?

readonly optional instruction?: string

A narrative instruction of the knowledge base. A Bedrock Agent can use this instruction to determine if it should query this Knowledge Base.

Inherited from

IKnowledgeBase.instruction

knowledgeBaseArn

readonly knowledgeBaseArn: string

The ARN of the knowledge base.

Example

"arn:aws:bedrock:us-east-1:123456789012:knowledge-base/KB12345678"

Inherited from

IKnowledgeBase.knowledgeBaseArn

knowledgeBaseId

readonly knowledgeBaseId: string

The ID of the knowledge base.

Example

"KB12345678"

Inherited from

IKnowledgeBase.knowledgeBaseId

node

readonly node: Node

The tree node.

Inherited from

IKnowledgeBase.node

role

readonly role: IRole

The role associated with the knowledge base.

Inherited from

IKnowledgeBase.role

stack

readonly stack: Stack

The stack in which this resource is defined.

Inherited from

IKnowledgeBase.stack

type

readonly type: KnowledgeBaseType

The type of knowledge base.

Inherited from

IKnowledgeBase.type

vectorStoreType

readonly vectorStoreType: VectorStoreType

The storage type for the Vector Embeddings.

Methods

addConfluenceDataSource()

addConfluenceDataSource(props): ConfluenceDataSource

Add a Confluence data source to the knowledge base.

Parameters

props

ConfluenceDataSourceAssociationProps

Returns

ConfluenceDataSource

addCustomDataSource()

addCustomDataSource(props): CustomDataSource

Add a Custom data source to the knowledge base.

Parameters

props

CustomDataSourceAssociationProps

Returns

CustomDataSource

addS3DataSource()

addS3DataSource(props): S3DataSource

Add an S3 data source to the knowledge base.

Parameters

props

S3DataSourceAssociationProps

Returns

S3DataSource

addSalesforceDataSource()

addSalesforceDataSource(props): SalesforceDataSource

Add a Salesforce data source to the knowledge base.

Parameters

props

SalesforceDataSourceAssociationProps

Returns

SalesforceDataSource

addSharePointDataSource()

addSharePointDataSource(props): SharePointDataSource

Add a SharePoint data source to the knowledge base.

Parameters

props

SharePointDataSourceAssociationProps

Returns

SharePointDataSource

addWebCrawlerDataSource()

addWebCrawlerDataSource(props): WebCrawlerDataSource

Add a web crawler data source to the knowledge base.

Parameters

props

WebCrawlerDataSourceAssociationProps

Returns

WebCrawlerDataSource

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

grant(grantee, ...actions): Grant

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

grantQuery(grantee): Grant

Grant the given identity permissions to query the knowledge base.

grantRetrieve(grantee): Grant

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

grantRetrieveAndGenerate(grantee): Grant

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

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.