@cdklabs/generative-ai-cdk-constructs • Docs
@cdklabs/generative-ai-cdk-constructs / amazonaurora / ExistingAmazonAuroraVectorStoreProps
Properties for an existing Aurora Vector Store.
You database must have TCP/IP port that the
database will use for application connections
set up for 5432
.
readonly
auroraSecurityGroupId:string
The id of the security group associated with the RDS Aurora instance. This security group allows access to the Aurora Vector Store from Lambda’s custom resource running pgVector SQL commands.
readonly
clusterIdentifier:string
The unique cluster identifier of your Aurora RDS cluster.
readonly
databaseName:string
The name of the database for the Aurora Vector Store.
readonly
embeddingsModelVectorDimension:number
The embeddings model dimension used for the Aurora Vector Store. The vector dimensions of the model must match the dimensions used in the KnowledgeBase construct.
BaseAuroraVectorStoreProps
.embeddingsModelVectorDimension
readonly
optional
metadataField:string
The field name for the metadata column in the Aurora Vector Store.
BaseAuroraVectorStoreProps
.metadataField
readonly
optional
primaryKeyField:string
The primary key field for the Aurora Vector Store table.
BaseAuroraVectorStoreProps
.primaryKeyField
readonly
optional
schemaName:string
The schema name for the Aurora Vector Store.
BaseAuroraVectorStoreProps
.schemaName
readonly
secret:ISecret
The secret containing the database credentials.
The secret must contain host
, port
, username
,
password
and dbname
values.
readonly
optional
tableName:string
The name of the table for the Aurora Vector Store.
BaseAuroraVectorStoreProps
.tableName
readonly
optional
textField:string
The field name for the text column in the Aurora Vector Store.
BaseAuroraVectorStoreProps
.textField
readonly
optional
vectorField:string
The field name for the vector column in the Aurora Vector Store.
BaseAuroraVectorStoreProps
.vectorField
readonly
vpc:IVpc
The VPC in which the existing Aurora Vector Store is located.