@cdklabs/generative-ai-cdk-constructs • Docs
@cdklabs/generative-ai-cdk-constructs / opensearchserverless / VectorCollection
Deploys an OpenSearch Serverless Collection to be used as a vector store.
It includes all policies.
Constructnew VectorCollection(
scope,id,props?):VectorCollection
• scope: Construct
• id: string
• props?: VectorCollectionProps
Construct.constructor
aossPolicy:
ManagedPolicy
An IAM policy that allows API access to the collection.
collectionArn:
string
The ARN of the collection.
collectionId:
string
The ID of the collection.
collectionName:
string
The name of the collection.
dataAccessPolicy:
CfnAccessPolicy
An OpenSearch Access Policy that allows access to the index.
readonlynode:Node
The tree node.
Construct.node
standbyReplicas:
VectorCollectionStandbyReplicas
Indicates whether to use standby replicas for the collection.
grantDataAccess(
grantee):void
Grants the specified role access to data in the collection.
• grantee: IRole
The role to grant access to.
void
toString():
string
Returns a string representation of this construct.
string
Construct.toString
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.
• x: any
Any object
x is Construct
true if x is an object created from a class which extends Construct.
Construct.isConstruct