> **Experimental**
>
> `@aws-cdk/aws-bedrock-alpha` is an [**experimental**](https://docs.aws.amazon.com/cdk/api/stability.html) (alpha) package: its API may change in any release, without a major version bump.
# KnowledgeBaseOpenSearchServerlessStorage

Stores a knowledge base's vectors in an existing Amazon OpenSearch Serverless vector index.

Sets `StorageConfiguration` to `OPENSEARCH_SERVERLESS` with the given
collection, index and field mapping. Grants the role referenced by the knowledge
base's `roleArn` `aoss:APIAccessAll` on the collection and makes the knowledge
base depend on that policy.

The index must already exist and the collection's data access policy must
allow the service role to describe, read and write it; neither is created here.

Extends: [Mixin](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.Mixin.html) › KnowledgeBaseOpenSearchServerlessStorage
Implements: [IMixin](https://docs.aws.amazon.com/cdk/api/v2/docs/constructs.IMixin.html)

- Stability: [Experimental](https://docs.aws.amazon.com/cdk/api/stability.html)
- Source: [`bedrock/mixins/knowledge-base.ts`](https://github.com/aws/aws-cdk/blob/v2.278.0/packages/@aws-cdk/aws-bedrock-alpha/bedrock/mixins/knowledge-base.ts#L64)
- Type last changed: v2.274.0-alpha.0 · 21 Oct 2026

## Example

TypeScript:

```ts
declare const collection: opensearchserverless.ICollectionRef;
declare const role: iam.Role;

new aws_bedrock_cfn.CfnKnowledgeBase(this, 'KnowledgeBase', {
  name: 'product-documentation',
  roleArn: role.roleArn,
  knowledgeBaseConfiguration: {
    type: 'VECTOR',
    vectorKnowledgeBaseConfiguration: {
      embeddingModelArn: bedrock.BedrockFoundationModel.TITAN_EMBED_TEXT_V2_1024.modelArn,
    },
  },
}).with(new bedrock.mixins.KnowledgeBaseOpenSearchServerlessStorage({
  collection,
  vectorIndexName: 'bedrock-knowledge-base-default-index',
  vectorField: 'bedrock-knowledge-base-default-vector',
  textField: 'AMAZON_BEDROCK_TEXT_CHUNK',
  metadataField: 'AMAZON_BEDROCK_METADATA',
}));
```

Python:

```python
# collection: opensearchserverless.ICollectionRef
# role: iam.Role

aws_bedrock_cfn.CfnKnowledgeBase(self, "KnowledgeBase",
    name="product-documentation",
    role_arn=role.role_arn,
    knowledge_base_configuration=aws_bedrock_cfn.CfnKnowledgeBase.KnowledgeBaseConfigurationProperty(
        type="VECTOR",
        vector_knowledge_base_configuration=aws_bedrock_cfn.CfnKnowledgeBase.VectorKnowledgeBaseConfigurationProperty(
            embedding_model_arn=bedrock.BedrockFoundationModel.TITAN_EMBED_TEXT_V2_1024.model_arn
        )
    )
).with(bedrock.mixins.KnowledgeBaseOpenSearchServerlessStorage(
    collection=collection,
    vector_index_name="bedrock-knowledge-base-default-index",
    vector_field="bedrock-knowledge-base-default-vector",
    text_field="AMAZON_BEDROCK_TEXT_CHUNK",
    metadata_field="AMAZON_BEDROCK_METADATA"
))
```

Java:

```java
ICollectionRef collection;
Role role;

CfnKnowledgeBase.Builder.create(this, "KnowledgeBase")
        .name("product-documentation")
        .roleArn(role.roleArn)
        .knowledgeBaseConfiguration(KnowledgeBaseConfigurationProperty.builder()
                .type("VECTOR")
                .vectorKnowledgeBaseConfiguration(VectorKnowledgeBaseConfigurationProperty.builder()
                        .embeddingModelArn(bedrock.BedrockFoundationModel.TITAN_EMBED_TEXT_V2_1024.modelArn)
                        .build())
                .build())
        .build().with(KnowledgeBaseOpenSearchServerlessStorage.Builder.create()
        .collection(collection)
        .vectorIndexName("bedrock-knowledge-base-default-index")
        .vectorField("bedrock-knowledge-base-default-vector")
        .textField("AMAZON_BEDROCK_TEXT_CHUNK")
        .metadataField("AMAZON_BEDROCK_METADATA")
        .build());
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Alpha
ICollectionRef collection;
Role role;

new CfnKnowledgeBase(this, "KnowledgeBase", new CfnKnowledgeBaseProps {
    Name = "product-documentation",
    RoleArn = role.RoleArn,
    KnowledgeBaseConfiguration = new KnowledgeBaseConfigurationProperty {
        Type = "VECTOR",
        VectorKnowledgeBaseConfiguration = new VectorKnowledgeBaseConfigurationProperty {
            EmbeddingModelArn = BedrockFoundationModel.TITAN_EMBED_TEXT_V2_1024.ModelArn
        }
    }
}).With(new Mixins.KnowledgeBaseOpenSearchServerlessStorage(new KnowledgeBaseOpenSearchServerlessStorageProps {
    Collection = collection,
    VectorIndexName = "bedrock-knowledge-base-default-index",
    VectorField = "bedrock-knowledge-base-default-vector",
    TextField = "AMAZON_BEDROCK_TEXT_CHUNK",
    MetadataField = "AMAZON_BEDROCK_METADATA"
}));
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awsbedrockalpha/v2
var collection ICollectionRef
var role Role

awscdk.Aws_bedrock.NewCfnKnowledgeBase(this, jsii.String("KnowledgeBase"), &CfnKnowledgeBaseProps{
	Name: jsii.String("product-documentation"),
	RoleArn: role.roleArn,
	KnowledgeBaseConfiguration: &KnowledgeBaseConfigurationProperty{
		Type: jsii.String("VECTOR"),
		VectorKnowledgeBaseConfiguration: &VectorKnowledgeBaseConfigurationProperty{
			EmbeddingModelArn: bedrock.BedrockFoundationModel_TITAN_EMBED_TEXT_V2_1024().ModelArn,
		},
	},
}).With(mixins.NewKnowledgeBaseOpenSearchServerlessStorage(&KnowledgeBaseOpenSearchServerlessStorageProps{
	Collection: Collection,
	VectorIndexName: jsii.String("bedrock-knowledge-base-default-index"),
	VectorField: jsii.String("bedrock-knowledge-base-default-vector"),
	TextField: jsii.String("AMAZON_BEDROCK_TEXT_CHUNK"),
	MetadataField: jsii.String("AMAZON_BEDROCK_METADATA"),
}))
```

## Initializer

TypeScript:

```ts
new KnowledgeBaseOpenSearchServerlessStorage(props: KnowledgeBaseOpenSearchServerlessStorageProps)
```

Python:

```python
KnowledgeBaseOpenSearchServerlessStorage(props: KnowledgeBaseOpenSearchServerlessStorageProps)
```

Java:

```java
new KnowledgeBaseOpenSearchServerlessStorage(KnowledgeBaseOpenSearchServerlessStorageProps props)
```

C# / .NET:

```csharp
new KnowledgeBaseOpenSearchServerlessStorage(KnowledgeBaseOpenSearchServerlessStorageProps props)
```

Golang:

```go
NewKnowledgeBaseOpenSearchServerlessStorage(Props KnowledgeBaseOpenSearchServerlessStorageProps)
```

## Methods

- `applyTo(construct: IConstruct): void` — Applies the mixin functionality to the target construct.

- `isMixin(x: any): boolean` (static) — Checks if `x` is a Mixin.

  **Parameters**

  - `x` — Any object.

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

- `supports(construct: IConstruct): boolean` — Determines whether this mixin can be applied to the given construct.
