VectorsIndex class

Resource for managing an Amazon S3 Vectors Index.

Example Usage

Basic Usage

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 pulumi
import pulumi_aws as aws

example = aws.s3.VectorsIndex("example",
    index_name="example-index",
    vector_bucket_name=example_aws_s3vectors_vector_bucket["vectorBucketName"],
    data_type="float32",
    dimension=2,
    distance_metric="euclidean")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.S3.VectorsIndex("example", new()
    {
        IndexName = "example-index",
        VectorBucketName = exampleAwsS3vectorsVectorBucket.VectorBucketName,
        DataType = "float32",
        Dimension = 2,
        DistanceMetric = "euclidean",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := s3.NewVectorsIndex(ctx, "example", &s3.VectorsIndexArgs{
			IndexName:        pulumi.String("example-index"),
			VectorBucketName: pulumi.Any(exampleAwsS3vectorsVectorBucket.VectorBucketName),
			DataType:         pulumi.String("float32"),
			Dimension:        pulumi.Int(2),
			DistanceMetric:   pulumi.String("euclidean"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_s3_vectorsindex" "example" {
  index_name         = "example-index"
  vector_bucket_name = exampleAwsS3vectorsVectorBucket.vectorBucketName
  data_type          = "float32"
  dimension          = 2
  distance_metric    = "euclidean"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.VectorsIndex;
import com.pulumi.aws.s3.VectorsIndexArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new VectorsIndex("example", VectorsIndexArgs.builder()
            .indexName("example-index")
            .vectorBucketName(exampleAwsS3vectorsVectorBucket.vectorBucketName())
            .dataType("float32")
            .dimension(2)
            .distanceMetric("euclidean")
            .build());

    }
}
resources:
  example:
    type: aws:s3:VectorsIndex
    properties:
      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:

$ pulumi import aws:s3/vectorsIndex:VectorsIndex example arn:aws:s3vectors:us-west-2:123456789012:bucket/example-bucket/index/example-index

Constructors

VectorsIndex(String name, {VectorsIndexArgs? args, CustomResourceOptions? options})
Creates a new VectorsIndex. name The Pulumi resource name. args Arguments used to configure this VectorsIndex. The set of arguments for VectorsIndex. options Resource options controlling this resource's behavior.
VectorsIndex.reference(String urn)
Creates a typed reference to an existing VectorsIndex resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
creationTime ↔ Output<String>
Date and time when the vector index was created.
latefinal
dataType ↔ Output<String>
Data type of the vectors to be inserted into the vector index. Valid values: float32.
latefinal
dimension ↔ Output<int>
Dimensions of the vectors to be inserted into the vector index.
latefinal
distanceMetric ↔ Output<String>
Distance metric to be used for similarity search. Valid values: cosine, euclidean.
latefinal
encryptionConfigurations ↔ Output<List<VectorsIndexEncryptionConfiguration>>
Block for encryption configuration for the vector index. See encryptionConfiguration Block below.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
indexArn ↔ Output<String>
ARN of the vector index.
latefinal
indexName ↔ Output<String>
Name of the vector index.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
metadataConfiguration ↔ Output<VectorsIndexMetadataConfiguration?>
Block for metadata configuration for the vector index. See metadataConfiguration Block below.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, 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.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
vectorBucketName ↔ Output<String>
Name of the vector bucket for the vector index.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {VectorsIndexState? state, CustomResourceOptions? options}) → VectorsIndex
Gets an existing VectorsIndex resource's state with the given name and id.