> **Experimental** > > `@aws-cdk/aws-bedrock-alpha` is an [**experimental**](/stability) (alpha) package: its API may change in any release, without a major version bump. # KnowledgeBase An Amazon Bedrock knowledge base. Extends: Construct › Resource › KnowledgeBaseBase › KnowledgeBase Implements: IKnowledgeBase, IResource, IGrantable, IEnvironmentAware, IKnowledgeBaseRef, IConstruct, IDependable - Stability: [Experimental](/cdk/api/stability.html) - CloudFormation: [`AWS::Bedrock::KnowledgeBase`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-bedrock-knowledgebase.html) - L1 type: [`CfnKnowledgeBase`](/cdk/api/v2/docs/aws-cdk-lib.aws_bedrock.CfnKnowledgeBase.html) - Source: [`bedrock/knowledge-bases/knowledge-base.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0-alpha.0/packages/@aws-cdk/aws-bedrock-alpha/bedrock/knowledge-bases/knowledge-base.ts#L169) - Type last changed: v2.274.0-alpha.0 · 21 Oct 2026 ## Example ```ts declare const collection: opensearchserverless.ICollectionRef; const knowledgeBase = new bedrock.KnowledgeBase(this, 'KnowledgeBase', { type: bedrock.KnowledgeBaseType.vector({ embeddingsModel: bedrock.BedrockFoundationModel.TITAN_EMBED_TEXT_V2_1024, vectorStore: bedrock.VectorStore.openSearchServerless({ collection, vectorIndexName: 'bedrock-knowledge-base-default-index', vectorField: 'bedrock-knowledge-base-default-vector', textField: 'AMAZON_BEDROCK_TEXT_CHUNK', metadataField: 'AMAZON_BEDROCK_METADATA', }), }), }); ``` ## Initializer ```ts new KnowledgeBase(scope: Construct, id: string, props: KnowledgeBaseProps) ``` ## Construct Props - `description`: string — A description of the knowledge base. **Default:** no description Must be 1-200 characters. - `knowledgeBaseName`: string — The name of the knowledge base. **Default:** a unique name is generated Must be 1-100 characters of letters, digits, hyphens and underscores, and must not contain consecutive hyphens or underscores. - `role`: any — The service role that Amazon Bedrock assumes to operate the knowledge base. **Default:** a new role is created, trusted by `bedrock.amazonaws.com` and scoped to knowledge bases in this account The permissions the knowledge base needs to reach its data store and models are granted to this role. - `tags`: { [key: string]: string } — Tags to apply to the knowledge base. **Default:** no tags - `type`: [KnowledgeBaseType](/cdk/api/v2/docs/@aws-cdk_aws-bedrock-alpha.KnowledgeBaseType.html) (required) — The type of the knowledge base and its type-specific configuration. ## Properties - `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) (required) — 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. - `grantPrincipal`: [IPrincipal](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IPrincipal.html) (required) — The principal to grant permissions to. - `grants`: [KnowledgeBaseGrants](/cdk/api/v2/docs/@aws-cdk_aws-bedrock-alpha.KnowledgeBaseGrants.html) (required) — Grant permissions on this knowledge base to IAM principals. - `knowledgeBaseArn`: string (required) — The ARN of the knowledge base. - `knowledgeBaseId`: string (required) — The unique identifier of the knowledge base. - `knowledgeBaseRef`: [KnowledgeBaseReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_bedrock.KnowledgeBaseReference.html) (required) — A reference to a KnowledgeBase resource. - `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node. - `PROPERTY_INJECTION_ID`: string (required) (static) — Uniquely identifies this class. - `reflections`: [KnowledgeBaseReflection](/cdk/api/v2/docs/@aws-cdk_aws-bedrock-alpha.KnowledgeBaseReflection.html) (required) — Resolves the underlying `CfnKnowledgeBase` from the construct tree. - `role`: [IRoleRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_iam.IRoleRef.html) — The service role that Amazon Bedrock assumes to operate the knowledge base. Always defined for knowledge bases created with this construct. - `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this resource is defined. ## Methods - `addToRolePolicy(statement: PolicyStatement): void` — Adds a statement to the IAM policy of the knowledge base service role. For a referenced knowledge base whose role was not provided, the statement cannot be applied; a warning is emitted with the statement to add to the role manually. - `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource. When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default. **Parameters** - `strength` — - The reference strength to use for this resource. - `applyRemovalPolicy(policy: RemovalPolicy): 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`). - `fromKnowledgeBaseArn(scope: Construct, id: string, knowledgeBaseArn: string): IKnowledgeBase` (static) — Reference an existing knowledge base by ARN. - `fromKnowledgeBaseAttributes(scope: Construct, id: string, attrs: KnowledgeBaseAttributes): IKnowledgeBase` (static) — Reference an existing knowledge base by its attributes. - `fromKnowledgeBaseId(scope: Construct, id: string, knowledgeBaseId: string): IKnowledgeBase` (static) — Reference an existing knowledge base by ID. The knowledge base is assumed to be in the same account and region as the scope. - `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. **Parameters** - `x` — Any object. **Returns:** true if `x` is an object created from a class which extends `Construct`. - `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise. - `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource. - `toString(): string` — Returns a string representation of this construct. - `with(...mixins: IMixin[]): 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. Use multiple `with()` calls if subsequent mixins should apply to added constructs.