generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructs

---

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

Interface: CommonKnowledgeBaseAttributes

Common properties for importing a knowledge base (of any type) created outside of this stack.

Extended by

• VectorKnowledgeBaseAttributes
• KendraKnowledgeBaseAttributes

Properties

description?

readonly optional description: string

The description of the knowledge base.

Default

- No description provided.

---

executionRoleArn

readonly executionRoleArn: string

The Service Execution Role associated with the knowledge base.

Example

"arn:aws:iam::123456789012:role/AmazonBedrockExecutionRoleForKnowledgeBaseawscdkbdgeBaseKB12345678"

---

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.

Default

- No description provided.

---

knowledgeBaseId

readonly knowledgeBaseId: string

The ID of the knowledge base.

Example

"KB12345678"

---

knowledgeBaseState?

readonly optional knowledgeBaseState: string

Specifies whether to use the knowledge base or not when sending an InvokeAgent request.

Default

- ENABLED

This site is open source. Improve this page.