Package software.amazon.awscdk.services.bedrock

Class CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.bedrock.CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnKnowledgeBase.MongoDbAtlasConfigurationProperty>

Enclosing interface:

CfnKnowledgeBase.MongoDbAtlasConfigurationProperty

@Stability(Stable)
public static final class CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnKnowledgeBase.MongoDbAtlasConfigurationProperty>

A builder for CfnKnowledgeBase.MongoDbAtlasConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnKnowledgeBase.MongoDbAtlasConfigurationProperty	build()	Builds the configured instance.
CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.Builder	collectionName(String collectionName)	Sets the value of CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.getCollectionName()
CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.Builder	credentialsSecretArn(String credentialsSecretArn)	Sets the value of CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.getCredentialsSecretArn()
CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.Builder	databaseName(String databaseName)	Sets the value of CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.getDatabaseName()
CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.Builder	endpoint(String endpoint)	Sets the value of CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.getEndpoint()
CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.Builder	endpointServiceName(String endpointServiceName)	Sets the value of CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.getEndpointServiceName()
CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.Builder	fieldMapping(IResolvable fieldMapping)	Sets the value of CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.getFieldMapping()
CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.Builder	fieldMapping(CfnKnowledgeBase.MongoDbAtlasFieldMappingProperty fieldMapping)	Sets the value of CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.getFieldMapping()
CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.Builder	textIndexName(String textIndexName)	Sets the value of CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.getTextIndexName()
CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.Builder	vectorIndexName(String vectorIndexName)	Sets the value of CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.getVectorIndexName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

collectionName

@Stability(Stable)
public CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.Builder collectionName(String collectionName)

Sets the value of CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.getCollectionName()

Parameters:

collectionName - The collection name of the knowledge base in MongoDB Atlas. This parameter is required.

Returns:

this

credentialsSecretArn

@Stability(Stable)
public CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.Builder credentialsSecretArn(String credentialsSecretArn)

Sets the value of CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.getCredentialsSecretArn()

Parameters:

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. This parameter is required.

Returns:

this

databaseName

@Stability(Stable)
public CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.Builder databaseName(String databaseName)

Sets the value of CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.getDatabaseName()

Parameters:

databaseName - The database name in your MongoDB Atlas cluster for your knowledge base. This parameter is required.

Returns:

this

endpoint

@Stability(Stable)
public CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.Builder endpoint(String endpoint)

Sets the value of CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.getEndpoint()

Parameters:

endpoint - The endpoint URL of your MongoDB Atlas cluster for your knowledge base. This parameter is required.

Returns:

this

fieldMapping

@Stability(Stable)
public CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.Builder fieldMapping(IResolvable fieldMapping)

Sets the value of CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.getFieldMapping()

Parameters:

fieldMapping - Contains the names of the fields to which to map information about the vector store. This parameter is required.

Returns:

this

fieldMapping

@Stability(Stable)
public CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.Builder fieldMapping(CfnKnowledgeBase.MongoDbAtlasFieldMappingProperty fieldMapping)

Sets the value of CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.getFieldMapping()

Parameters:

fieldMapping - Contains the names of the fields to which to map information about the vector store. This parameter is required.

Returns:

this

vectorIndexName

@Stability(Stable)
public CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.Builder vectorIndexName(String vectorIndexName)

Sets the value of CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.getVectorIndexName()

Parameters:

vectorIndexName - The name of the MongoDB Atlas vector search index. This parameter is required.

Returns:

this

endpointServiceName

@Stability(Stable)
public CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.Builder endpointServiceName(String endpointServiceName)

Sets the value of CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.getEndpointServiceName()

Parameters:

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

Returns:

this

textIndexName

@Stability(Stable)
public CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.Builder textIndexName(String textIndexName)

Sets the value of CfnKnowledgeBase.MongoDbAtlasConfigurationProperty.getTextIndexName()

Parameters:

textIndexName - The name of the text search index in the MongoDB collection. This is required for using the hybrid search feature.

Returns:

this

build

@Stability(Stable)
public CfnKnowledgeBase.MongoDbAtlasConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnKnowledgeBase.MongoDbAtlasConfigurationProperty>

Returns:

a new instance of CfnKnowledgeBase.MongoDbAtlasConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided