AWS::Bedrock::KnowledgeBase OpenSearchServerlessConfiguration

Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see Create a vector index in Amazon OpenSearch Service.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "CollectionArn" : String,
  "FieldMapping" : OpenSearchServerlessFieldMapping,
  "VectorIndexName" : String
}

YAML

  CollectionArn: String
  FieldMapping: 
    OpenSearchServerlessFieldMapping
  VectorIndexName: String

Properties

CollectionArn

The Amazon Resource Name (ARN) of the OpenSearch Service vector store.

Required: Yes

Type: String

Pattern: ^arn:aws:aoss:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:collection/[a-z0-9-]{3,32}$

Maximum: 2048

Update requires: Replacement

FieldMapping

Contains the names of the fields to which to map information about the vector store.

Required: Yes

Type: OpenSearchServerlessFieldMapping

Update requires: Replacement

VectorIndexName

The name of the vector store.

Required: Yes

Type: String

Pattern: ^.*$

Maximum: 2048

Update requires: Replacement