interface StorageConfigurationProperty
| Language | Type name |
|---|---|
.NET | Amazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins.CfnKnowledgeBasePropsMixin.StorageConfigurationProperty |
Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsbedrock/mixins#CfnKnowledgeBasePropsMixin_StorageConfigurationProperty |
Java | software.amazon.awscdk.mixins.preview.services.bedrock.mixins.CfnKnowledgeBasePropsMixin.StorageConfigurationProperty |
Python | aws_cdk.mixins_preview.aws_bedrock.mixins.CfnKnowledgeBasePropsMixin.StorageConfigurationProperty |
TypeScript | @aws-cdk/mixins-preview » aws_bedrock » mixins » CfnKnowledgeBasePropsMixin » StorageConfigurationProperty |
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 { mixins as bedrock_mixins } from '@aws-cdk/mixins-preview/aws-bedrock';
const storageConfigurationProperty: bedrock_mixins.CfnKnowledgeBasePropsMixin.StorageConfigurationProperty = {
mongoDbAtlasConfiguration: {
collectionName: 'collectionName',
credentialsSecretArn: 'credentialsSecretArn',
databaseName: 'databaseName',
endpoint: 'endpoint',
endpointServiceName: 'endpointServiceName',
fieldMapping: {
metadataField: 'metadataField',
textField: 'textField',
vectorField: 'vectorField',
},
textIndexName: 'textIndexName',
vectorIndexName: 'vectorIndexName',
},
neptuneAnalyticsConfiguration: {
fieldMapping: {
metadataField: 'metadataField',
textField: 'textField',
},
graphArn: 'graphArn',
},
opensearchManagedClusterConfiguration: {
domainArn: 'domainArn',
domainEndpoint: 'domainEndpoint',
fieldMapping: {
metadataField: 'metadataField',
textField: 'textField',
vectorField: 'vectorField',
},
vectorIndexName: 'vectorIndexName',
},
opensearchServerlessConfiguration: {
collectionArn: 'collectionArn',
fieldMapping: {
metadataField: 'metadataField',
textField: 'textField',
vectorField: 'vectorField',
},
vectorIndexName: 'vectorIndexName',
},
pineconeConfiguration: {
connectionString: 'connectionString',
credentialsSecretArn: 'credentialsSecretArn',
fieldMapping: {
metadataField: 'metadataField',
textField: 'textField',
},
namespace: 'namespace',
},
rdsConfiguration: {
credentialsSecretArn: 'credentialsSecretArn',
databaseName: 'databaseName',
fieldMapping: {
customMetadataField: 'customMetadataField',
metadataField: 'metadataField',
primaryKeyField: 'primaryKeyField',
textField: 'textField',
vectorField: 'vectorField',
},
resourceArn: 'resourceArn',
tableName: 'tableName',
},
s3VectorsConfiguration: {
indexArn: 'indexArn',
indexName: 'indexName',
vectorBucketArn: 'vectorBucketArn',
},
type: 'type',
};
Properties
| Name | Type | Description |
|---|---|---|
| mongo | IResolvable | Mongo | Contains the storage configuration of the knowledge base in MongoDB Atlas. |
| neptune | IResolvable | Neptune | Contains details about the Neptune Analytics configuration of the knowledge base in Amazon Neptune. |
| opensearch | IResolvable | Open | Contains details about the storage configuration of the knowledge base in OpenSearch Managed Cluster. |
| opensearch | IResolvable | Open | Contains the storage configuration of the knowledge base in Amazon OpenSearch Service. |
| pinecone | IResolvable | Pinecone | Contains the storage configuration of the knowledge base in Pinecone. |
| rds | IResolvable | Rds | Contains details about the storage configuration of the knowledge base in Amazon RDS. |
| s3 | IResolvable | S3 | The configuration settings for storing knowledge base data using S3 vectors. |
| type? | string | The vector store service in which the knowledge base is stored. |
mongoDbAtlasConfiguration?
Type:
IResolvable | Mongo
(optional)
Contains the storage configuration of the knowledge base in MongoDB Atlas.
neptuneAnalyticsConfiguration?
Type:
IResolvable | Neptune
(optional)
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. .
opensearchManagedClusterConfiguration?
Type:
IResolvable | Open
(optional)
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 .
opensearchServerlessConfiguration?
Type:
IResolvable | Open
(optional)
Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
pineconeConfiguration?
Type:
IResolvable | Pinecone
(optional)
Contains the storage configuration of the knowledge base in Pinecone.
rdsConfiguration?
Type:
IResolvable | Rds
(optional)
Contains details about the storage configuration of the knowledge base in Amazon RDS.
For more information, see Create a vector index in Amazon RDS .
s3VectorsConfiguration?
Type:
IResolvable | S3
(optional)
The configuration settings for storing knowledge base data using S3 vectors.
This includes vector index information and S3 bucket details for vector storage.
type?
Type:
string
(optional)
The vector store service in which the knowledge base is stored.

.NET
Go
Java
Python
TypeScript