@cdklabs/generative-ai-cdk-constructs
@cdklabs/generative-ai-cdk-constructs / opensearchserverless / VectorCollection
Provides a vector search collection in Amazon OpenSearch Serverless.
VectorCollectionBasenew VectorCollection(
scope,id,props?):VectorCollection
Construct
string
VectorCollectionBase.constructor
readonlyaossPolicy:ManagedPolicy
VectorCollectionBase.aossPolicy
readonlycollectionArn:string
VectorCollectionBase.collectionArn
readonlycollectionEndpoint:string
readonlycollectionId:string
VectorCollectionBase.collectionId
readonlycollectionName:string
VectorCollectionBase.collectionName
readonlycollectionType:VectorCollectionType
VectorCollectionBase.collectionType
readonlydashboardEndpoint:string
readonlydataAccessPolicy:CfnAccessPolicy
VectorCollectionBase.dataAccessPolicy
readonlyenv:ResourceEnvironment
The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
VectorCollectionBase.env
readonlynode:Node
The tree node.
VectorCollectionBase.node
protectedreadonlyphysicalName:string
Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
This value will resolve to one of the following:
"my-awesome-bucket")undefined, when a name should be generated by CloudFormationVectorCollectionBase.physicalName
readonlystack:Stack
The stack in which this resource is defined.
VectorCollectionBase.stack
readonlystandbyReplicas:VectorCollectionStandbyReplicas
VectorCollectionBase.standbyReplicas
_enableCrossEnvironment():
void
Internal
Called when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.
void
VectorCollectionBase._enableCrossEnvironment
applyRemovalPolicy(
policy):void
Apply the given removal policy to this resource
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN).
RemovalPolicy
void
VectorCollectionBase.applyRemovalPolicy
protectedgeneratePhysicalName():string
string
VectorCollectionBase.generatePhysicalName
protectedgetResourceArnAttribute(arnAttr,arnComponents):string
Returns an environment-sensitive token that should be used for the
resource’s “ARN” attribute (e.g. bucket.bucketArn).
Normally, this token will resolve to arnAttr, but if the resource is
referenced across environments, arnComponents will be used to synthesize
a concrete ARN with the resource’s physical name. Make sure to reference
this.physicalName in arnComponents.
string
The CFN attribute which resolves to the ARN of the resource.
Commonly it will be called “Arn” (e.g. resource.attrArn), but sometimes
it’s the CFN resource’s ref.
ArnComponents
The format of the ARN of this resource. You must
reference this.physicalName somewhere within the ARN in order for
cross-environment references to work.
string
VectorCollectionBase.getResourceArnAttribute
protectedgetResourceNameAttribute(nameAttr):string
Returns an environment-sensitive token that should be used for the
resource’s “name” attribute (e.g. bucket.bucketName).
Normally, this token will resolve to nameAttr, but if the resource is
referenced across environments, it will be resolved to this.physicalName,
which will be a concrete name.
string
The CFN attribute which resolves to the resource’s name.
Commonly this is the resource’s ref.
string
VectorCollectionBase.getResourceNameAttribute
grantDataAccess(
grantee):void
Grants the specified role access to data in the collection.
IRole
The role to grant access to.
void
metric(
metricName,props?):Metric
Return the given named metric for this VectorCollection.
string
The name of the metric
MetricOptions
Properties for the metric
Metric
VectorCollectionBase.metric
metricIndexRequestCount(
props?):Metric
Metric for the number of index requests.
MetricOptions
Properties for the metric
Metric
VectorCollectionBase.metricIndexRequestCount
metricSearchLatency(
props?):Metric
Metric for the search latency.
MetricOptions
Properties for the metric
Metric
VectorCollectionBase.metricSearchLatency
metricSearchLatencyP90(
props?):Metric
Metric for the 90th percentile search latency.
MetricOptions
Properties for the metric
Metric
VectorCollectionBase.metricSearchLatencyP90
metricSearchRequestCount(
props?):Metric
Metric for the number of search requests.
MetricOptions
Properties for the metric
Metric
VectorCollectionBase.metricSearchRequestCount
toString():
string
Returns a string representation of this construct.
string
VectorCollectionBase.toString
staticfromCollectionAttributes(constructScope,constructId,attrs):IVectorCollection
Import an existing collection using its attributes.
Construct
The parent creating construct.
string
The construct’s name.
The collection attributes to use.
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.
any
Any object
x is Construct
true if x is an object created from a class which extends Construct.
VectorCollectionBase.isConstruct
staticisOwnedResource(construct):boolean
Returns true if the construct was created by CDK, and false otherwise
IConstruct
boolean
VectorCollectionBase.isOwnedResource
staticisResource(construct):construct is Resource
Check whether the given construct is a Resource
IConstruct
construct is Resource
VectorCollectionBase.isResource
staticmetricAll(metricName,props?):Metric
Return metrics for all vector collections.
string
MetricOptions
Metric
staticmetricAllIndexRequestCount(props?):Metric
Metric for the total number of index requests across all collections.
MetricOptions
Metric
staticmetricAllSearchLatency(props?):Metric
Metric for average search latency across all collections.
MetricOptions
Metric
staticmetricAllSearchRequestCount(props?):Metric
Metric for the total number of search requests across all collections.
MetricOptions
Metric