s3vectors/aws.sdk.kotlin.services.s3vectors.model/CreateIndexRequest

CreateIndexRequest

class CreateIndexRequest

Types

object Companion

Properties

val dataType: DataType?

The data type of the vectors to be inserted into the vector index.

val dimension: Int?

The dimensions of the vectors to be inserted into the vector index.

val distanceMetric: DistanceMetric?

The distance metric to be used for similarity search.

encryptionConfiguration

val encryptionConfiguration: EncryptionConfiguration?

The encryption configuration for a vector index. By default, if you don't specify, all new vectors in the vector index will use the encryption configuration of the vector bucket.

val indexName: String?

The name of the vector index to create.

metadataConfiguration

val metadataConfiguration: MetadataConfiguration?

The metadata configuration for the vector index.

val tags: Map<String, String>?

An array of user-defined tags that you would like to apply to the vector index that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize, track costs, and control access to resources. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).

vectorBucketArn

val vectorBucketArn: String?

The Amazon Resource Name (ARN) of the vector bucket to create the vector index in.

vectorBucketName

val vectorBucketName: String?

The name of the vector bucket to create the vector index in.

Functions

inline fun copy(block: CreateIndexRequest.Builder.() -> Unit = {}): CreateIndexRequest

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String