MongoDbAtlasConfiguration
Contains details about the storage configuration of the knowledge base in MongoDB Atlas.
Contents
- collectionName
-
The collection name of the knowledge base in MongoDB Atlas.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern:
^.*$Required: Yes
- 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.
Type: String
Pattern:
^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$Required: Yes
- databaseName
-
The database name in your MongoDB Atlas cluster for your knowledge base.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern:
^.*$Required: Yes
- endpoint
-
The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
^.*$Required: Yes
- fieldMapping
-
Contains the names of the fields to which to map information about the vector store.
Type: MongoDbAtlasFieldMapping object
Required: Yes
- vectorIndexName
-
The name of the MongoDB Atlas vector search index.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
^.*$Required: Yes
- endpointServiceName
-
The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^(?:arn:aws(?:-us-gov|-cn|-iso|-iso-[a-z])*:.+:.*:\d+:.+/.+$|[a-zA-Z0-9*]+[a-zA-Z0-9._-]*)$Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
