Class: VectorIndex

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns

ResourceEnvironment

The environment this resource belongs to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Inherited from

VectorIndexBase.env

physicalName

Get Signature

get protected physicalName(): 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:

a concrete value (e.g. "my-awesome-bucket")
undefined, when a name should be generated by CloudFormation
a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns

string

Inherited from

VectorIndexBase.physicalName

stack

Get Signature

get stack(): Stack

The stack in which this resource is defined.

Returns

Stack

The stack in which this resource is defined.

Inherited from

VectorIndexBase.stack

Methods

_enableCrossEnvironment()

_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.

Returns

void

Inherited from

VectorIndexBase._enableCrossEnvironment

applyRemovalPolicy()

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).

Parameters

policy

RemovalPolicy

Returns

void

Inherited from

VectorIndexBase.applyRemovalPolicy

generatePhysicalName()

protected generatePhysicalName(): string

Returns

string

Inherited from

VectorIndexBase.generatePhysicalName

getResourceArnAttribute()

protected getResourceArnAttribute(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.

Parameters

arnAttr

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

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.

Returns

string

Inherited from

VectorIndexBase.getResourceArnAttribute

getResourceNameAttribute()

protected getResourceNameAttribute(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.

Parameters

nameAttr

string

The CFN attribute which resolves to the resource's name. Commonly this is the resource's ref.

Returns

string

Inherited from

VectorIndexBase.getResourceNameAttribute

grant()

grant(grantee, ...actions): Grant

Grants IAM actions to the IAM Principal

Parameters

grantee

IGrantable

The IAM principal to grant permissions to

actions

...string[]

The actions to grant

Returns

Grant

An IAM Grant object representing the granted permissions

Inherited from

VectorIndexBase.grant

toString()

toString(): string

Returns a string representation of this construct.

Returns

string

Inherited from

VectorIndexBase.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

VectorIndexBase.with

fromVectorIndexArn()

static fromVectorIndexArn(scope, id, vectorIndexArn): IVectorIndex

Creates a VectorIndex construct that represents an external vector index by ARN.

Parameters

scope

Construct

The parent creating construct (usually this).

id

string

The construct's name.

vectorIndexArn

string

The ARN of the vector index.

Returns

IVectorIndex

A VectorIndex construct.

fromVectorIndexAttributes()

static fromVectorIndexAttributes(scope, id, attrs): IVectorIndex

Parameters

scope

Construct

id

string

attrs

VectorIndexAttributes

Returns

IVectorIndex

fromVectorIndexName()

static fromVectorIndexName(scope, id, vectorBucketName, vectorIndexName): IVectorIndex

Creates a VectorIndex construct that represents an external vector index by name. Note: This method requires the bucket name because the ARN format includes both bucket and index.

Parameters

scope

Construct

The parent creating construct (usually this).

id

string

The construct's name.

vectorBucketName

string

The name of the vector bucket containing the index.

vectorIndexName

string

The name of the vector index.

Returns

IVectorIndex

A VectorIndex construct.

isConstruct()

static isConstruct(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.

static isOwnedResource(construct): boolean

Returns true if the construct was created by CDK, and false otherwise

static isResource(construct): construct is Resource

Check whether the given construct is a Resource