generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructs

---

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

Interface: IKnowledgeBase

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

Extends

• IResource

Extended by

• IVectorKnowledgeBase
• IKendraKnowledgeBase
• IGraphKnowledgeBase

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 by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Inherited from

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

---

knowledgeBaseArn

readonly knowledgeBaseArn: string

The ARN of the knowledge base.

Example

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

---

knowledgeBaseId

readonly knowledgeBaseId: string

The ID of the knowledge base.

Example

"KB12345678"

---

node

readonly node: Node

The tree node.

Inherited from

IResource.node

---

role

readonly role: IRole

The role associated with the knowledge base.

---

stack

readonly stack: Stack

The stack in which this resource is defined.

Inherited from

IResource.stack

---

type

readonly type: KnowledgeBaseType

The type of knowledge base.

Methods

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

IResource.applyRemovalPolicy

---

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

---

grantQuery()

grantQuery(grantee): Grant

Grant the given identity permissions to query the knowledge base.

Parameters

grantee

IGrantable

Returns

Grant

This site is open source. Improve this page.