generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructs / s3vectors / IVectorIndex

Interface: IVectorIndex

Interface for S3 vector bucket resources

Extends

Properties

creationTime?

readonly optional creationTime: string

The timestamp when the vector index was created, in ISO 8601 format.

Attribute

encryptionKey?

readonly optional encryptionKey: IKey

Optional KMS encryption key associated with this vector index.

env

readonly env: ResourceEnvironment

The environment this resource belongs to.

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.

Inherited from

IResource.env

node

readonly node: Node

The tree node.

Inherited from

IResource.node

stack

readonly stack: Stack

The stack in which this resource is defined.

Inherited from

IResource.stack

vectorIndexArn

readonly vectorIndexArn: string

The ARN of the vector index

Attribute

vectorIndexName

readonly vectorIndexName: string

The name of the vector index

Attribute

Methods

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

IResource.applyRemovalPolicy

grant()

grant(grantee, …actions): Grant

Grants IAM actions to the IAM Principal

Parameters

grantee

IGrantable

actions

…string[]

Returns

Grant

This site is open source. Improve this page.