Interface CfnKnowledgeBase.StorageConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnKnowledgeBase.StorageConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnKnowledgeBase
@Stability(Stable)
public static interface CfnKnowledgeBase.StorageConfigurationProperty
extends software.amazon.jsii.JsiiSerializable
Contains the storage configuration of the knowledge base.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.bedrock.*;
StorageConfigurationProperty storageConfigurationProperty = StorageConfigurationProperty.builder()
.type("type")
// the properties below are optional
.mongoDbAtlasConfiguration(MongoDbAtlasConfigurationProperty.builder()
.collectionName("collectionName")
.credentialsSecretArn("credentialsSecretArn")
.databaseName("databaseName")
.endpoint("endpoint")
.fieldMapping(MongoDbAtlasFieldMappingProperty.builder()
.metadataField("metadataField")
.textField("textField")
.vectorField("vectorField")
.build())
.vectorIndexName("vectorIndexName")
// the properties below are optional
.endpointServiceName("endpointServiceName")
.textIndexName("textIndexName")
.build())
.neptuneAnalyticsConfiguration(NeptuneAnalyticsConfigurationProperty.builder()
.fieldMapping(NeptuneAnalyticsFieldMappingProperty.builder()
.metadataField("metadataField")
.textField("textField")
.build())
.graphArn("graphArn")
.build())
.opensearchManagedClusterConfiguration(OpenSearchManagedClusterConfigurationProperty.builder()
.domainArn("domainArn")
.domainEndpoint("domainEndpoint")
.fieldMapping(OpenSearchManagedClusterFieldMappingProperty.builder()
.metadataField("metadataField")
.textField("textField")
.vectorField("vectorField")
.build())
.vectorIndexName("vectorIndexName")
.build())
.opensearchServerlessConfiguration(OpenSearchServerlessConfigurationProperty.builder()
.collectionArn("collectionArn")
.fieldMapping(OpenSearchServerlessFieldMappingProperty.builder()
.metadataField("metadataField")
.textField("textField")
.vectorField("vectorField")
.build())
.vectorIndexName("vectorIndexName")
.build())
.pineconeConfiguration(PineconeConfigurationProperty.builder()
.connectionString("connectionString")
.credentialsSecretArn("credentialsSecretArn")
.fieldMapping(PineconeFieldMappingProperty.builder()
.metadataField("metadataField")
.textField("textField")
.build())
// the properties below are optional
.namespace("namespace")
.build())
.rdsConfiguration(RdsConfigurationProperty.builder()
.credentialsSecretArn("credentialsSecretArn")
.databaseName("databaseName")
.fieldMapping(RdsFieldMappingProperty.builder()
.metadataField("metadataField")
.primaryKeyField("primaryKeyField")
.textField("textField")
.vectorField("vectorField")
// the properties below are optional
.customMetadataField("customMetadataField")
.build())
.resourceArn("resourceArn")
.tableName("tableName")
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnKnowledgeBase.StorageConfigurationPropertystatic final classAn implementation forCfnKnowledgeBase.StorageConfigurationProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectContains the storage configuration of the knowledge base in MongoDB Atlas.default ObjectContains details about the Neptune Analytics configuration of the knowledge base in Amazon Neptune.default ObjectContains details about the storage configuration of the knowledge base in OpenSearch Managed Cluster.default ObjectContains the storage configuration of the knowledge base in Amazon OpenSearch Service.default ObjectContains the storage configuration of the knowledge base in Pinecone.default ObjectContains details about the storage configuration of the knowledge base in Amazon RDS.getType()The vector store service in which the knowledge base is stored.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getType
The vector store service in which the knowledge base is stored.- See Also:
-
getMongoDbAtlasConfiguration
Contains the storage configuration of the knowledge base in MongoDB Atlas.- See Also:
-
getNeptuneAnalyticsConfiguration
Contains details about the Neptune Analytics configuration of the knowledge base in Amazon Neptune.For more information, see Create a vector index in Amazon Neptune Analytics. .
- See Also:
-
getOpensearchManagedClusterConfiguration
Contains details about the storage configuration of the knowledge base in OpenSearch Managed Cluster.For more information, see Create a vector index in Amazon OpenSearch Service .
- See Also:
-
getOpensearchServerlessConfiguration
Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.- See Also:
-
getPineconeConfiguration
Contains the storage configuration of the knowledge base in Pinecone.- See Also:
-
getRdsConfiguration
Contains details about the storage configuration of the knowledge base in Amazon RDS.For more information, see Create a vector index in Amazon RDS .
- See Also:
-
builder
-