AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Bedrock::KnowledgeBase

CfnKnowledgeBase

Specifies a knowledge base as a resource in a top-level template. Minimally, you must specify the following properties:. - Name – Specify a name for the knowledge base. - RoleArn – Specify the Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base. For more information, see [Create a service role for Knowledge base for Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-permissions.html) . - KnowledgeBaseConfiguration – Specify the embeddings configuration of the knowledge base. The following sub-properties are required: - Type – Specify the value `VECTOR` . - StorageConfiguration – Specify information about the vector store in which the data source is stored. The following sub-properties are required: - Type – Specify the vector store service that you are using. > Redis Enterprise Cloud vector stores are currently unsupported in CloudFormation . For more information about using knowledge bases in Amazon Bedrock , see [Knowledge base for Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base.html) . See the *Properties* section below for descriptions of both the required and optional properties.

Import

import { CfnKnowledgeBase } from 'aws-cdk-lib/aws-bedrock';

Or use the module namespace:

import * as bedrock from 'aws-cdk-lib/aws-bedrock';
// bedrock.CfnKnowledgeBase

Properties

Configuration passed to the constructor as CfnKnowledgeBaseProps.

knowledgeBaseConfigurationRequired
IResolvable | KnowledgeBaseConfigurationProperty

Contains details about the embeddings configuration of the knowledge base.

nameRequired
string

The name of the knowledge base.

roleArnRequired
string

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

descriptionOptional
string

The description of the knowledge base associated with the inline agent.

storageConfigurationOptional
IResolvable | StorageConfigurationProperty

Contains details about the storage configuration of the knowledge base.

tagsOptional
{ [key: string]: string }

Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:. - [Tag naming limits and requirements](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions) - [Tagging best practices](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices)

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Bedrock::KnowledgeBaseView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-bedrock
CFN TypeAWS::Bedrock::KnowledgeBase
Properties6

Related Constructs

Explore This Service

External Links