Package software.amazon.awscdk.cfnpropertymixins.services.bedrock

Interface CfnKnowledgeBasePropsMixin.MongoDbAtlasConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKnowledgeBasePropsMixin.MongoDbAtlasConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnKnowledgeBasePropsMixin

@Stability(Stable)
public static interface CfnKnowledgeBasePropsMixin.MongoDbAtlasConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.bedrock.*;
 MongoDbAtlasConfigurationProperty mongoDbAtlasConfigurationProperty = MongoDbAtlasConfigurationProperty.builder()
         .collectionName("collectionName")
         .credentialsSecretArn("credentialsSecretArn")
         .databaseName("databaseName")
         .endpoint("endpoint")
         .endpointServiceName("endpointServiceName")
         .fieldMapping(MongoDbAtlasFieldMappingProperty.builder()
                 .metadataField("metadataField")
                 .textField("textField")
                 .vectorField("vectorField")
                 .build())
         .textIndexName("textIndexName")
         .vectorIndexName("vectorIndexName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnKnowledgeBasePropsMixin.MongoDbAtlasConfigurationProperty.Builder	A builder for CfnKnowledgeBasePropsMixin.MongoDbAtlasConfigurationProperty
static final class	CfnKnowledgeBasePropsMixin.MongoDbAtlasConfigurationProperty.Jsii$Proxy	An implementation for CfnKnowledgeBasePropsMixin.MongoDbAtlasConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnKnowledgeBasePropsMixin.MongoDbAtlasConfigurationProperty.Builder	builder()
default String	getCollectionName()	The collection name of the knowledge base in MongoDB Atlas.
default String	getCredentialsSecretArn()	The Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
default String	getDatabaseName()	The database name in your MongoDB Atlas cluster for your knowledge base.
default String	getEndpoint()	The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
default String	getEndpointServiceName()	The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
default Object	getFieldMapping()	Contains the names of the fields to which to map information about the vector store.
default String	getTextIndexName()	The name of the text search index in the MongoDB collection.
default String	getVectorIndexName()	The name of the MongoDB Atlas vector search index.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCollectionName

@Stability(Stable)
@Nullable
default String getCollectionName()

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

getCredentialsSecretArn

@Stability(Stable)
@Nullable
default String getCredentialsSecretArn()

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

getDatabaseName

@Stability(Stable)
@Nullable
default String getDatabaseName()

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

getEndpoint

@Stability(Stable)
@Nullable
default String getEndpoint()

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

getEndpointServiceName

@Stability(Stable)
@Nullable
default String getEndpointServiceName()

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

getFieldMapping

@Stability(Stable)
@Nullable
default Object getFieldMapping()

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

Returns union: either IResolvable or CfnKnowledgeBasePropsMixin.MongoDbAtlasFieldMappingProperty

See Also:

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

getTextIndexName

@Stability(Stable)
@Nullable
default String getTextIndexName()

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

getVectorIndexName

@Stability(Stable)
@Nullable
default String getVectorIndexName()

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

builder

@Stability(Stable)
static CfnKnowledgeBasePropsMixin.MongoDbAtlasConfigurationProperty.Builder builder()

Returns:

a CfnKnowledgeBasePropsMixin.MongoDbAtlasConfigurationProperty.Builder of CfnKnowledgeBasePropsMixin.MongoDbAtlasConfigurationProperty