AWS CDK Reference

Appearance

v2.273.0

CfnKnowledgeBasePropsMixin Mixin ​

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 .

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

See the Properties section below for descriptions of both the required and optional properties.

CloudFormation
AWS::Bedrock::KnowledgeBase
Source
Generated code
Type last changed
v2.269.0 · 16 Sep 2026

Initializer ​

ts
new CfnKnowledgeBasePropsMixin(props: CfnKnowledgeBaseMixinProps, options?: CfnPropertyMixinOptions)
python
CfnKnowledgeBasePropsMixin(props: CfnKnowledgeBaseMixinProps, options: typing.Optional[CfnPropertyMixinOptions] = None)
java
new CfnKnowledgeBasePropsMixin(CfnKnowledgeBaseMixinProps props, CfnPropertyMixinOptions options)
csharp
new CfnKnowledgeBasePropsMixin(CfnKnowledgeBaseMixinProps props, CfnPropertyMixinOptions? options = null)
go
NewCfnKnowledgeBasePropsMixin(Props CfnKnowledgeBaseMixinProps, Options CfnPropertyMixinOptions)

Methods ​

applyTo(construct: IConstruct): voiddef apply_to(self, construct: IConstruct) -> Nonepublic void applyTo(IConstruct construct)public void ApplyTo(IConstruct construct)func ApplyTo(Construct IConstruct)#
Apply the mixin properties to the construct.
isMixin(x: any): boolean@staticmethod def is_mixin(x: Any) -> boolpublic static Boolean isMixin(Object x)public static bool IsMixin(object x)func IsMixin(X interface{}) *boolstatic#
Checks if `x` is a Mixin.
1 parameter · returns

Parameters

  • xxxxX — Any object.

Returns: true if x is an object created from a class which extends Mixin.

supports(construct: IConstruct): booleandef supports(self, construct: IConstruct) -> boolpublic Boolean supports(IConstruct construct)public bool Supports(IConstruct construct)func Supports(Construct IConstruct) *bool#
Check if this mixin supports the given construct.