@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
215 lines (214 loc) • 8.28 kB
TypeScript
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
*
* Using `pulumi import`, import S3 Vectors Index using the `index_arn`. 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<pulumi.ID>, 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<string>;
/**
* Data type of the vectors to be inserted into the vector index. Valid values: `float32`.
*/
readonly dataType: pulumi.Output<string>;
/**
* Dimensions of the vectors to be inserted into the vector index.
*/
readonly dimension: pulumi.Output<number>;
/**
* Distance metric to be used for similarity search. Valid values: `cosine`, `euclidean`.
*/
readonly distanceMetric: pulumi.Output<string>;
/**
* Block for encryption configuration for the vector index. See `encyptionConfiguration` block below.
*/
readonly encryptionConfigurations: pulumi.Output<outputs.s3.VectorsIndexEncryptionConfiguration[]>;
/**
* ARN of the vector index.
*/
readonly indexArn: pulumi.Output<string>;
/**
* Name of the vector index.
*/
readonly indexName: pulumi.Output<string>;
/**
* Block for metadata configuration for the vector index. See `metadataConfiguration` block below.
*/
readonly metadataConfiguration: pulumi.Output<outputs.s3.VectorsIndexMetadataConfiguration | undefined>;
/**
* 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<string>;
/**
* 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>;
/**
* A 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<string>;
/**
* 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<string>;
/**
* Data type of the vectors to be inserted into the vector index. Valid values: `float32`.
*/
dataType?: pulumi.Input<string>;
/**
* Dimensions of the vectors to be inserted into the vector index.
*/
dimension?: pulumi.Input<number>;
/**
* Distance metric to be used for similarity search. Valid values: `cosine`, `euclidean`.
*/
distanceMetric?: pulumi.Input<string>;
/**
* Block for encryption configuration for the vector index. See `encyptionConfiguration` block below.
*/
encryptionConfigurations?: pulumi.Input<pulumi.Input<inputs.s3.VectorsIndexEncryptionConfiguration>[]>;
/**
* ARN of the vector index.
*/
indexArn?: pulumi.Input<string>;
/**
* Name of the vector index.
*/
indexName?: pulumi.Input<string>;
/**
* Block for metadata configuration for the vector index. See `metadataConfiguration` block below.
*/
metadataConfiguration?: pulumi.Input<inputs.s3.VectorsIndexMetadataConfiguration>;
/**
* 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<string>;
/**
* 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<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Name of the vector bucket for the vector index.
*
* The following arguments are optional:
*/
vectorBucketName?: pulumi.Input<string>;
}
/**
* 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<string>;
/**
* Dimensions of the vectors to be inserted into the vector index.
*/
dimension: pulumi.Input<number>;
/**
* Distance metric to be used for similarity search. Valid values: `cosine`, `euclidean`.
*/
distanceMetric: pulumi.Input<string>;
/**
* Block for encryption configuration for the vector index. See `encyptionConfiguration` block below.
*/
encryptionConfigurations?: pulumi.Input<pulumi.Input<inputs.s3.VectorsIndexEncryptionConfiguration>[]>;
/**
* Name of the vector index.
*/
indexName: pulumi.Input<string>;
/**
* Block for metadata configuration for the vector index. See `metadataConfiguration` block below.
*/
metadataConfiguration?: pulumi.Input<inputs.s3.VectorsIndexMetadataConfiguration>;
/**
* 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<string>;
/**
* 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<string>;
}>;
/**
* Name of the vector bucket for the vector index.
*
* The following arguments are optional:
*/
vectorBucketName: pulumi.Input<string>;
}