Package com.pulumi.aws.s3

Class VectorsIndex

  • public class VectorsIndex
extends com.pulumi.resources.CustomResource
    Resource for managing an Amazon S3 Vectors Index. ## Example Usage ### Basic Usage 
     
 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());
 
     }
 }
    ## 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 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> creationTime()  
      com.pulumi.core.Output<java.lang.String> dataType()  
      com.pulumi.core.Output<java.lang.Integer> dimension()  
      com.pulumi.core.Output<java.lang.String> distanceMetric()  
      com.pulumi.core.Output<java.util.List<VectorsIndexEncryptionConfiguration>> encryptionConfigurations()  
      static VectorsIndex get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, VectorsIndexState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> indexArn()  
      com.pulumi.core.Output<java.lang.String> indexName()  
      com.pulumi.core.Output<java.util.Optional<VectorsIndexMetadataConfiguration>> metadataConfiguration()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> vectorBucketName()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • VectorsIndex

        public VectorsIndex​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • VectorsIndex

        public VectorsIndex​(java.lang.String name,
                    VectorsIndexArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • VectorsIndex

        public VectorsIndex​(java.lang.String name,
                    VectorsIndexArgs args,
                    @Nullable
                    com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • creationTime

        public com.pulumi.core.Output<java.lang.String> creationTime()
        Returns:
        Date and time when the vector index was created.

      • dataType

        public com.pulumi.core.Output<java.lang.String> dataType()
        Returns:
        Data type of the vectors to be inserted into the vector index. Valid values: `float32`.

      • dimension

        public com.pulumi.core.Output<java.lang.Integer> dimension()
        Returns:
        Dimensions of the vectors to be inserted into the vector index.

      • distanceMetric

        public com.pulumi.core.Output<java.lang.String> distanceMetric()
        Returns:
        Distance metric to be used for similarity search. Valid values: `cosine`, `euclidean`.

      • encryptionConfigurations

        public com.pulumi.core.Output<java.util.List<VectorsIndexEncryptionConfiguration>> encryptionConfigurations()
        Returns:
        Block for encryption configuration for the vector index. See `encryptionConfiguration` Block below.

      • indexArn

        public com.pulumi.core.Output<java.lang.String> indexArn()
        Returns:
        ARN of the vector index.

      • indexName

        public com.pulumi.core.Output<java.lang.String> indexName()
        Returns:
        Name of the vector index.

      • metadataConfiguration

        public com.pulumi.core.Output<java.util.Optional<VectorsIndexMetadataConfiguration>> metadataConfiguration()
        Returns:
        Block for metadata configuration for the vector index. See `metadataConfiguration` Block below.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        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.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • vectorBucketName

        public com.pulumi.core.Output<java.lang.String> vectorBucketName()
        Returns:
        Name of the vector bucket for the vector index. The following arguments are optional:

      • get

        public static VectorsIndex get​(java.lang.String name,
                               com.pulumi.core.Output<java.lang.String> id,
                               @Nullable
                               VectorsIndexState state,
                               @Nullable
                               com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.