import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Resource for managing an Amazon S3 Vectors Index. * * ## Example Usage * * ### Basic Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = new aws.s3.VectorsIndex("example", { * indexName: "example-index", * vectorBucketName: exampleAwsS3vectorsVectorBucket.vectorBucketName, * dataType: "float32", * dimension: 2, * distanceMetric: "euclidean", * }); * ``` * * ## Import * * ### Identity Schema * * #### Required * * * `indexArn` (String) ARN of the S3 Vectors Index. * * Using `pulumi import`, import S3 Vectors Index using the `indexArn`. For example: * * ```sh * $ pulumi import aws:s3/vectorsIndex:VectorsIndex example arn:aws:s3vectors:us-west-2:123456789012:bucket/example-bucket/index/example-index * ``` */ export declare class VectorsIndex extends pulumi.CustomResource { /** * Get an existing VectorsIndex 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 state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: VectorsIndexState, opts?: pulumi.CustomResourceOptions): VectorsIndex; /** * Returns true if the given object is an instance of VectorsIndex. 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 VectorsIndex; /** * Date and time when the vector index was created. */ readonly creationTime: pulumi.Output; /** * Data type of the vectors to be inserted into the vector index. Valid values: `float32`. */ readonly dataType: pulumi.Output; /** * Dimensions of the vectors to be inserted into the vector index. */ readonly dimension: pulumi.Output; /** * Distance metric to be used for similarity search. Valid values: `cosine`, `euclidean`. */ readonly distanceMetric: pulumi.Output; /** * Block for encryption configuration for the vector index. See `encryptionConfiguration` Block below. */ readonly encryptionConfigurations: pulumi.Output; /** * ARN of the vector index. */ readonly indexArn: pulumi.Output; /** * Name of the vector index. */ readonly indexName: pulumi.Output; /** * Block for metadata configuration for the vector index. See `metadataConfiguration` Block below. */ readonly metadataConfiguration: pulumi.Output; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ readonly region: pulumi.Output; /** * Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ readonly tagsAll: pulumi.Output<{ [key: string]: string; }>; /** * Name of the vector bucket for the vector index. * * The following arguments are optional: */ readonly vectorBucketName: pulumi.Output; /** * Create a VectorsIndex 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: VectorsIndexArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering VectorsIndex resources. */ export interface VectorsIndexState { /** * Date and time when the vector index was created. */ creationTime?: pulumi.Input; /** * Data type of the vectors to be inserted into the vector index. Valid values: `float32`. */ dataType?: pulumi.Input; /** * Dimensions of the vectors to be inserted into the vector index. */ dimension?: pulumi.Input; /** * Distance metric to be used for similarity search. Valid values: `cosine`, `euclidean`. */ distanceMetric?: pulumi.Input; /** * Block for encryption configuration for the vector index. See `encryptionConfiguration` Block below. */ encryptionConfigurations?: pulumi.Input[] | undefined>; /** * ARN of the vector index. */ indexArn?: pulumi.Input; /** * Name of the vector index. */ indexName?: pulumi.Input; /** * Block for metadata configuration for the vector index. See `metadataConfiguration` Block below. */ metadataConfiguration?: pulumi.Input; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input; /** * Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ tagsAll?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Name of the vector bucket for the vector index. * * The following arguments are optional: */ vectorBucketName?: pulumi.Input; } /** * The set of arguments for constructing a VectorsIndex resource. */ export interface VectorsIndexArgs { /** * Data type of the vectors to be inserted into the vector index. Valid values: `float32`. */ dataType: pulumi.Input; /** * Dimensions of the vectors to be inserted into the vector index. */ dimension: pulumi.Input; /** * Distance metric to be used for similarity search. Valid values: `cosine`, `euclidean`. */ distanceMetric: pulumi.Input; /** * Block for encryption configuration for the vector index. See `encryptionConfiguration` Block below. */ encryptionConfigurations?: pulumi.Input[] | undefined>; /** * Name of the vector index. */ indexName: pulumi.Input; /** * Block for metadata configuration for the vector index. See `metadataConfiguration` Block below. */ metadataConfiguration?: pulumi.Input; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input; /** * Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Name of the vector bucket for the vector index. * * The following arguments are optional: */ vectorBucketName: pulumi.Input; } //# sourceMappingURL=vectorsIndex.d.ts.map