import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; import * as enums from "../types/enums"; /** * Resource Type definition for AWS::S3Vectors::Index */ export declare class Index extends pulumi.CustomResource { /** * Get an existing Index resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, opts?: pulumi.CustomResourceOptions): Index; /** * Returns true if the given object is an instance of Index. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Index; /** * Returns the date and time when the vector index was created. * * Example: `2024-12-21T10:30:00Z` */ readonly creationTime: pulumi.Output; /** * The data type of the vectors to be inserted into the vector index. Currently, only `float32` is supported, which represents 32-bit floating-point numbers. */ readonly dataType: pulumi.Output; /** * The dimensions of the vectors to be inserted into the vector index. This value must be between 1 and 4096, inclusive. All vectors stored in the index must have the same number of dimensions. * * The dimension value affects the storage requirements and search performance. Higher dimensions require more storage space and may impact search latency. */ readonly dimension: pulumi.Output; /** * The distance metric to be used for similarity search. Valid values are: * * - `cosine` - Measures the cosine of the angle between two vectors. * - `euclidean` - Measures the straight-line distance between two points in multi-dimensional space. Lower values indicate greater similarity. */ readonly distanceMetric: pulumi.Output; /** * 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. */ readonly encryptionConfiguration: pulumi.Output; /** * Returns the Amazon Resource Name (ARN) of the specified index. * * Example: `arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index` */ readonly indexArn: pulumi.Output; /** * The name of the vector index to create. The index name must be between 3 and 63 characters long and can contain only lowercase letters, numbers, hyphens (-), and dots (.). The index name must be unique within the vector bucket. * * If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the index name. * * > If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name. */ readonly indexName: pulumi.Output; /** * The metadata configuration for the vector index. */ readonly metadataConfiguration: pulumi.Output; /** * User tags (key-value pairs) to associate with the index. */ readonly tags: pulumi.Output; /** * The Amazon Resource Name (ARN) of the vector bucket that contains the vector index. */ readonly vectorBucketArn: pulumi.Output; /** * The name of the vector bucket that contains the vector index. */ readonly vectorBucketName: pulumi.Output; /** * Create a Index resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: IndexArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a Index resource. */ export interface IndexArgs { /** * The data type of the vectors to be inserted into the vector index. Currently, only `float32` is supported, which represents 32-bit floating-point numbers. */ dataType: pulumi.Input; /** * The dimensions of the vectors to be inserted into the vector index. This value must be between 1 and 4096, inclusive. All vectors stored in the index must have the same number of dimensions. * * The dimension value affects the storage requirements and search performance. Higher dimensions require more storage space and may impact search latency. */ dimension: pulumi.Input; /** * The distance metric to be used for similarity search. Valid values are: * * - `cosine` - Measures the cosine of the angle between two vectors. * - `euclidean` - Measures the straight-line distance between two points in multi-dimensional space. Lower values indicate greater similarity. */ distanceMetric: pulumi.Input; /** * 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. */ encryptionConfiguration?: pulumi.Input; /** * The name of the vector index to create. The index name must be between 3 and 63 characters long and can contain only lowercase letters, numbers, hyphens (-), and dots (.). The index name must be unique within the vector bucket. * * If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the index name. * * > If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name. */ indexName?: pulumi.Input; /** * The metadata configuration for the vector index. */ metadataConfiguration?: pulumi.Input; /** * User tags (key-value pairs) to associate with the index. */ tags?: pulumi.Input[]>; /** * The Amazon Resource Name (ARN) of the vector bucket that contains the vector index. */ vectorBucketArn?: pulumi.Input; /** * The name of the vector bucket that contains the vector index. */ vectorBucketName?: pulumi.Input; }