interface MongoDbAtlasConfigurationProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins.CfnKnowledgeBasePropsMixin.MongoDbAtlasConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsbedrock/mixins#CfnKnowledgeBasePropsMixin_MongoDbAtlasConfigurationProperty
Java	software.amazon.awscdk.mixins.preview.services.bedrock.mixins.CfnKnowledgeBasePropsMixin.MongoDbAtlasConfigurationProperty
Python	aws_cdk.mixins_preview.aws_bedrock.mixins.CfnKnowledgeBasePropsMixin.MongoDbAtlasConfigurationProperty
TypeScript	@aws-cdk/mixins-preview » aws_bedrock » mixins » CfnKnowledgeBasePropsMixin » MongoDbAtlasConfigurationProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasconfiguration.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as bedrock_mixins } from '@aws-cdk/mixins-preview/aws-bedrock';
const mongoDbAtlasConfigurationProperty: bedrock_mixins.CfnKnowledgeBasePropsMixin.MongoDbAtlasConfigurationProperty = {
  collectionName: 'collectionName',
  credentialsSecretArn: 'credentialsSecretArn',
  databaseName: 'databaseName',
  endpoint: 'endpoint',
  endpointServiceName: 'endpointServiceName',
  fieldMapping: {
    metadataField: 'metadataField',
    textField: 'textField',
    vectorField: 'vectorField',
  },
  textIndexName: 'textIndexName',
  vectorIndexName: 'vectorIndexName',
};

Properties

Name	Type	Description
collectionName?	string	The collection name of the knowledge base in MongoDB Atlas.
credentialsSecretArn?	string	The Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
databaseName?	string	The database name in your MongoDB Atlas cluster for your knowledge base.
endpoint?	string	The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
endpointServiceName?	string	The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
fieldMapping?	IResolvable | MongoDbAtlasFieldMappingProperty	Contains the names of the fields to which to map information about the vector store.
textIndexName?	string	The name of the text search index in the MongoDB collection.
vectorIndexName?	string	The name of the MongoDB Atlas vector search index.

---

collectionName?

Type: string (optional)

The collection name of the knowledge base in MongoDB Atlas.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasconfiguration.html#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-collectionname

---

credentialsSecretArn?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasconfiguration.html#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-credentialssecretarn

---

databaseName?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasconfiguration.html#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-databasename

---

endpoint?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasconfiguration.html#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-endpoint

---

endpointServiceName?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasconfiguration.html#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-endpointservicename

---

fieldMapping?

Type: IResolvable | MongoDbAtlasFieldMappingProperty (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasconfiguration.html#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-fieldmapping

---

textIndexName?

Type: string (optional)

The name of the text search index in the MongoDB collection.

This is required for using the hybrid search feature.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasconfiguration.html#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-textindexname

---

vectorIndexName?

Type: string (optional)

The name of the MongoDB Atlas vector search index.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-mongodbatlasconfiguration.html#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-vectorindexname