Class: ExistingAmazonAuroraVectorStore
May 8, 2026 ยท View on GitHub
@cdklabs/generative-ai-cdk-constructs
@cdklabs/generative-ai-cdk-constructs / amazonaurora / ExistingAmazonAuroraVectorStore
Class: ExistingAmazonAuroraVectorStore
Extends
BaseAmazonAuroraVectorStore
Constructors
Constructor
new ExistingAmazonAuroraVectorStore(
scope,id,props):ExistingAmazonAuroraVectorStore
Parameters
scope
Construct
id
string
props
ExistingAmazonAuroraVectorStoreProps
Returns
ExistingAmazonAuroraVectorStore
Overrides
BaseAmazonAuroraVectorStore.constructor
Properties
credentialsSecretArn
readonlycredentialsSecretArn:string
The Secret ARN of your Amazon Aurora DB cluster.
databaseName
readonlydatabaseName:string
The name of the database for the Aurora Vector Store.
Inherited from
BaseAmazonAuroraVectorStore.databaseName
embeddingsModelVectorDimension
readonlyembeddingsModelVectorDimension: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.
Inherited from
BaseAmazonAuroraVectorStore.embeddingsModelVectorDimension
metadataField
readonlymetadataField:string
The field name for the metadata column in the Aurora Vector Store.
Inherited from
BaseAmazonAuroraVectorStore.metadataField
node
readonlynode:Node
The tree node.
Inherited from
BaseAmazonAuroraVectorStore.node
primaryKeyField
readonlyprimaryKeyField:string
The primary key field for the Aurora Vector Store table.
Inherited from
BaseAmazonAuroraVectorStore.primaryKeyField
resourceArn
readonlyresourceArn:string
The ARN of your Amazon Aurora DB cluster.
schemaName
readonlyschemaName:string
The schema name for the Aurora Vector Store.
Inherited from
BaseAmazonAuroraVectorStore.schemaName
tableName
readonlytableName:string
The name of the table for the Aurora Vector Store.
Inherited from
BaseAmazonAuroraVectorStore.tableName
textField
readonlytextField:string
The field name for the text column in the Aurora Vector Store.
Inherited from
BaseAmazonAuroraVectorStore.textField
vectorField
readonlyvectorField:string
The field name for the vector column in the Aurora Vector Store.
Inherited from
BaseAmazonAuroraVectorStore.vectorField
vpc
readonlyvpc:IVpc
The VPC of your Amazon Aurora DB cluster.
Methods
addIngressRuleToAuroraSecurityGroup()
protectedaddIngressRuleToAuroraSecurityGroup(lambdaSecurityGroup,auroraSecurityGroup):void
Parameters
lambdaSecurityGroup
ISecurityGroup
auroraSecurityGroup
ISecurityGroup
Returns
void
Inherited from
BaseAmazonAuroraVectorStore.addIngressRuleToAuroraSecurityGroup
createAuroraPgCRPolicy()
protectedcreateAuroraPgCRPolicy(clusterIdentifier):ManagedPolicy
Parameters
clusterIdentifier
string
Returns
ManagedPolicy
Inherited from
BaseAmazonAuroraVectorStore.createAuroraPgCRPolicy
createLambdaSecurityGroup()
protectedcreateLambdaSecurityGroup(vpc):SecurityGroup
Parameters
vpc
IVpc
Returns
SecurityGroup
Inherited from
BaseAmazonAuroraVectorStore.createLambdaSecurityGroup
generateResourceArn()
protectedgenerateResourceArn(clusterIdentifier):string
Parameters
clusterIdentifier
string
Returns
string
Inherited from
BaseAmazonAuroraVectorStore.generateResourceArn
setupCustomResource()
protectedsetupCustomResource(databaseClusterResources,lambdaSecurityGroup,auroraPgCRPolicy):CustomResource
Parameters
databaseClusterResources
lambdaSecurityGroup
SecurityGroup
auroraPgCRPolicy
ManagedPolicy
Returns
CustomResource
Inherited from
BaseAmazonAuroraVectorStore.setupCustomResource
setupDatabaseClusterResources()
protectedsetupDatabaseClusterResources(vpc,secret,clusterIdentifier,auroraSecurityGroup):DatabaseClusterResources
Parameters
vpc
IVpc
secret
ISecret
clusterIdentifier
string
auroraSecurityGroup
ISecurityGroup
Returns
Inherited from
BaseAmazonAuroraVectorStore.setupDatabaseClusterResources
toString()
toString():
string
Returns a string representation of this construct.
Returns
string
Inherited from
BaseAmazonAuroraVectorStore.toString
with()
with(...
mixins):IConstruct
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
Parameters
mixins
...IMixin[]
The mixins to apply
Returns
IConstruct
This construct for chaining
Inherited from
BaseAmazonAuroraVectorStore.with
isConstruct()
staticisConstruct(x):x is Construct
Checks if x is a construct.
Use this method instead of instanceof to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct in each copy of the constructs library
is seen as a different class, and an instance of one class will not test as
instanceof the other class. npm install will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof will behave
unpredictably. It is safest to avoid using instanceof, and using
this type-testing method instead.
Parameters
x
any
Any object
Returns
x is Construct
true if x is an object created from a class which extends Construct.
Inherited from
BaseAmazonAuroraVectorStore.isConstruct