AWS::Bedrock::KnowledgeBase MongoDbAtlasConfiguration

Contains details about the storage configuration of the knowledge base in MongoDB Atlas.

Syntax

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

JSON

{
  "CollectionName" : String,
  "CredentialsSecretArn" : String,
  "DatabaseName" : String,
  "Endpoint" : String,
  "EndpointServiceName" : String,
  "FieldMapping" : MongoDbAtlasFieldMapping,
  "VectorIndexName" : String
}

YAML

  CollectionName: String
  CredentialsSecretArn: String
  DatabaseName: String
  Endpoint: String
  EndpointServiceName: String
  FieldMapping: 
    MongoDbAtlasFieldMapping
  VectorIndexName: String

Properties

CollectionName

The collection name of the knowledge base in MongoDB Atlas.

Required: Yes

Type: String

Pattern: ^.*$

Maximum: 63

Update requires: Replacement

CredentialsSecretArn

The Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that contains user credentials for your MongoDB Atlas cluster.

Required: Yes

Type: String

Pattern: ^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$

Update requires: Replacement

DatabaseName

The database name in your MongoDB Atlas cluster for your knowledge base.

Required: Yes

Type: String

Pattern: ^.*$

Maximum: 63

Update requires: Replacement

Endpoint

The endpoint URL of your MongoDB Atlas cluster for your knowledge base.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+\.mongodb\.net$

Maximum: 2048

Update requires: Replacement

EndpointServiceName

The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.

Required: No

Type: String

Pattern: ^(?:arn:aws(?:-us-gov|-cn|-iso|-iso-[a-z])*:.+:.*:\d+:.+/.+$|[a-zA-Z0-9*]+[a-zA-Z0-9._-]*)$

Maximum: 255

Update requires: Replacement

FieldMapping

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

Required: Yes

Type: MongoDbAtlasFieldMapping

Update requires: Replacement

VectorIndexName

The name of the MongoDB Atlas vector search index.

Required: Yes

Type: String

Pattern: ^.*$

Maximum: 2048

Update requires: Replacement