1. Packages
  2. AWS
  3. API Docs
  4. s3
  5. VectorsIndex
AWS v7.14.0 published on Thursday, Dec 11, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.s3.VectorsIndex

aws logo
AWS v7.14.0 published on Thursday, Dec 11, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    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")

    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
	})
}

    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 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.List;
import java.util.ArrayList;
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

    Create VectorsIndex Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VectorsIndex(name: string, args: VectorsIndexArgs, opts?: CustomResourceOptions);
    @overload
def VectorsIndex(resource_name: str,
                 args: VectorsIndexArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def VectorsIndex(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 data_type: Optional[str] = None,
                 dimension: Optional[int] = None,
                 distance_metric: Optional[str] = None,
                 index_name: Optional[str] = None,
                 vector_bucket_name: Optional[str] = None,
                 encryption_configurations: Optional[Sequence[VectorsIndexEncryptionConfigurationArgs]] = None,
                 metadata_configuration: Optional[VectorsIndexMetadataConfigurationArgs] = None,
                 region: Optional[str] = None,
                 tags: Optional[Mapping[str, str]] = None)
    func NewVectorsIndex(ctx *Context, name string, args VectorsIndexArgs, opts ...ResourceOption) (*VectorsIndex, error)
    public VectorsIndex(string name, VectorsIndexArgs args, CustomResourceOptions? opts = null)
    public VectorsIndex(String name, VectorsIndexArgs args)
public VectorsIndex(String name, VectorsIndexArgs args, CustomResourceOptions options)

    type: aws:s3:VectorsIndex
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VectorsIndexArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VectorsIndexArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VectorsIndexArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VectorsIndexArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VectorsIndexArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var vectorsIndexResource = new Aws.S3.VectorsIndex("vectorsIndexResource", new()
{
    DataType = "string",
    Dimension = 0,
    DistanceMetric = "string",
    IndexName = "string",
    VectorBucketName = "string",
    EncryptionConfigurations = new[]
    {
        new Aws.S3.Inputs.VectorsIndexEncryptionConfigurationArgs
        {
            KmsKeyArn = "string",
            SseType = "string",
        },
    },
    MetadataConfiguration = new Aws.S3.Inputs.VectorsIndexMetadataConfigurationArgs
    {
        NonFilterableMetadataKeys = new[]
        {
            "string",
        },
    },
    Region = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := s3.NewVectorsIndex(ctx, "vectorsIndexResource", &s3.VectorsIndexArgs{
	DataType:         pulumi.String("string"),
	Dimension:        pulumi.Int(0),
	DistanceMetric:   pulumi.String("string"),
	IndexName:        pulumi.String("string"),
	VectorBucketName: pulumi.String("string"),
	EncryptionConfigurations: s3.VectorsIndexEncryptionConfigurationArray{
		&s3.VectorsIndexEncryptionConfigurationArgs{
			KmsKeyArn: pulumi.String("string"),
			SseType:   pulumi.String("string"),
		},
	},
	MetadataConfiguration: &s3.VectorsIndexMetadataConfigurationArgs{
		NonFilterableMetadataKeys: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Region: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var vectorsIndexResource = new VectorsIndex("vectorsIndexResource", VectorsIndexArgs.builder()
    .dataType("string")
    .dimension(0)
    .distanceMetric("string")
    .indexName("string")
    .vectorBucketName("string")
    .encryptionConfigurations(VectorsIndexEncryptionConfigurationArgs.builder()
        .kmsKeyArn("string")
        .sseType("string")
        .build())
    .metadataConfiguration(VectorsIndexMetadataConfigurationArgs.builder()
        .nonFilterableMetadataKeys("string")
        .build())
    .region("string")
    .tags(Map.of("string", "string"))
    .build());

    vectors_index_resource = aws.s3.VectorsIndex("vectorsIndexResource",
    data_type="string",
    dimension=0,
    distance_metric="string",
    index_name="string",
    vector_bucket_name="string",
    encryption_configurations=[{
        "kms_key_arn": "string",
        "sse_type": "string",
    }],
    metadata_configuration={
        "non_filterable_metadata_keys": ["string"],
    },
    region="string",
    tags={
        "string": "string",
    })

    const vectorsIndexResource = new aws.s3.VectorsIndex("vectorsIndexResource", {
    dataType: "string",
    dimension: 0,
    distanceMetric: "string",
    indexName: "string",
    vectorBucketName: "string",
    encryptionConfigurations: [{
        kmsKeyArn: "string",
        sseType: "string",
    }],
    metadataConfiguration: {
        nonFilterableMetadataKeys: ["string"],
    },
    region: "string",
    tags: {
        string: "string",
    },
});

    type: aws:s3:VectorsIndex
properties:
    dataType: string
    dimension: 0
    distanceMetric: string
    encryptionConfigurations:
        - kmsKeyArn: string
          sseType: string
    indexName: string
    metadataConfiguration:
        nonFilterableMetadataKeys:
            - string
    region: string
    tags:
        string: string
    vectorBucketName: string

    VectorsIndex Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The VectorsIndex resource accepts the following input properties:

    DataType string
    Data type of the vectors to be inserted into the vector index. Valid values: float32.
    Dimension int
    Dimensions of the vectors to be inserted into the vector index.
    DistanceMetric string
    Distance metric to be used for similarity search. Valid values: cosine, euclidean.
    IndexName string
    Name of the vector index.
    VectorBucketName string

    Name of the vector bucket for the vector index.

    The following arguments are optional:

    EncryptionConfigurations List<VectorsIndexEncryptionConfiguration>
    Block for encryption configuration for the vector index. See encyption_configuration block below.
    MetadataConfiguration VectorsIndexMetadataConfiguration
    Block for metadata configuration for the vector index. See metadata_configuration block below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    DataType string
    Data type of the vectors to be inserted into the vector index. Valid values: float32.
    Dimension int
    Dimensions of the vectors to be inserted into the vector index.
    DistanceMetric string
    Distance metric to be used for similarity search. Valid values: cosine, euclidean.
    IndexName string
    Name of the vector index.
    VectorBucketName string

    Name of the vector bucket for the vector index.

    The following arguments are optional:

    EncryptionConfigurations []VectorsIndexEncryptionConfigurationArgs
    Block for encryption configuration for the vector index. See encyption_configuration block below.
    MetadataConfiguration VectorsIndexMetadataConfigurationArgs
    Block for metadata configuration for the vector index. See metadata_configuration block below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    dataType String
    Data type of the vectors to be inserted into the vector index. Valid values: float32.
    dimension Integer
    Dimensions of the vectors to be inserted into the vector index.
    distanceMetric String
    Distance metric to be used for similarity search. Valid values: cosine, euclidean.
    indexName String
    Name of the vector index.
    vectorBucketName String

    Name of the vector bucket for the vector index.

    The following arguments are optional:

    encryptionConfigurations List<VectorsIndexEncryptionConfiguration>
    Block for encryption configuration for the vector index. See encyption_configuration block below.
    metadataConfiguration VectorsIndexMetadataConfiguration
    Block for metadata configuration for the vector index. See metadata_configuration block below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    dataType string
    Data type of the vectors to be inserted into the vector index. Valid values: float32.
    dimension number
    Dimensions of the vectors to be inserted into the vector index.
    distanceMetric string
    Distance metric to be used for similarity search. Valid values: cosine, euclidean.
    indexName string
    Name of the vector index.
    vectorBucketName string

    Name of the vector bucket for the vector index.

    The following arguments are optional:

    encryptionConfigurations VectorsIndexEncryptionConfiguration[]
    Block for encryption configuration for the vector index. See encyption_configuration block below.
    metadataConfiguration VectorsIndexMetadataConfiguration
    Block for metadata configuration for the vector index. See metadata_configuration block below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    data_type str
    Data type of the vectors to be inserted into the vector index. Valid values: float32.
    dimension int
    Dimensions of the vectors to be inserted into the vector index.
    distance_metric str
    Distance metric to be used for similarity search. Valid values: cosine, euclidean.
    index_name str
    Name of the vector index.
    vector_bucket_name str

    Name of the vector bucket for the vector index.

    The following arguments are optional:

    encryption_configurations Sequence[VectorsIndexEncryptionConfigurationArgs]
    Block for encryption configuration for the vector index. See encyption_configuration block below.
    metadata_configuration VectorsIndexMetadataConfigurationArgs
    Block for metadata configuration for the vector index. See metadata_configuration block below.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    dataType String
    Data type of the vectors to be inserted into the vector index. Valid values: float32.
    dimension Number
    Dimensions of the vectors to be inserted into the vector index.
    distanceMetric String
    Distance metric to be used for similarity search. Valid values: cosine, euclidean.
    indexName String
    Name of the vector index.
    vectorBucketName String

    Name of the vector bucket for the vector index.

    The following arguments are optional:

    encryptionConfigurations List<Property Map>
    Block for encryption configuration for the vector index. See encyption_configuration block below.
    metadataConfiguration Property Map
    Block for metadata configuration for the vector index. See metadata_configuration block below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VectorsIndex resource produces the following output properties:

    CreationTime string
    Date and time when the vector index was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    IndexArn string
    ARN of the vector index.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    CreationTime string
    Date and time when the vector index was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    IndexArn string
    ARN of the vector index.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    creationTime String
    Date and time when the vector index was created.
    id String
    The provider-assigned unique ID for this managed resource.
    indexArn String
    ARN of the vector index.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    creationTime string
    Date and time when the vector index was created.
    id string
    The provider-assigned unique ID for this managed resource.
    indexArn string
    ARN of the vector index.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    creation_time str
    Date and time when the vector index was created.
    id str
    The provider-assigned unique ID for this managed resource.
    index_arn str
    ARN of the vector index.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    creationTime String
    Date and time when the vector index was created.
    id String
    The provider-assigned unique ID for this managed resource.
    indexArn String
    ARN of the vector index.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Look up Existing VectorsIndex Resource

    Get an existing VectorsIndex resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: VectorsIndexState, opts?: CustomResourceOptions): VectorsIndex
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        creation_time: Optional[str] = None,
        data_type: Optional[str] = None,
        dimension: Optional[int] = None,
        distance_metric: Optional[str] = None,
        encryption_configurations: Optional[Sequence[VectorsIndexEncryptionConfigurationArgs]] = None,
        index_arn: Optional[str] = None,
        index_name: Optional[str] = None,
        metadata_configuration: Optional[VectorsIndexMetadataConfigurationArgs] = None,
        region: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vector_bucket_name: Optional[str] = None) -> VectorsIndex
    func GetVectorsIndex(ctx *Context, name string, id IDInput, state *VectorsIndexState, opts ...ResourceOption) (*VectorsIndex, error)
    public static VectorsIndex Get(string name, Input<string> id, VectorsIndexState? state, CustomResourceOptions? opts = null)
    public static VectorsIndex get(String name, Output<String> id, VectorsIndexState state, CustomResourceOptions options)
    resources:  _:    type: aws:s3:VectorsIndex    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreationTime string
    Date and time when the vector index was created.
    DataType string
    Data type of the vectors to be inserted into the vector index. Valid values: float32.
    Dimension int
    Dimensions of the vectors to be inserted into the vector index.
    DistanceMetric string
    Distance metric to be used for similarity search. Valid values: cosine, euclidean.
    EncryptionConfigurations List<VectorsIndexEncryptionConfiguration>
    Block for encryption configuration for the vector index. See encyption_configuration block below.
    IndexArn string
    ARN of the vector index.
    IndexName string
    Name of the vector index.
    MetadataConfiguration VectorsIndexMetadataConfiguration
    Block for metadata configuration for the vector index. See metadata_configuration block below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    VectorBucketName string

    Name of the vector bucket for the vector index.

    The following arguments are optional:

    CreationTime string
    Date and time when the vector index was created.
    DataType string
    Data type of the vectors to be inserted into the vector index. Valid values: float32.
    Dimension int
    Dimensions of the vectors to be inserted into the vector index.
    DistanceMetric string
    Distance metric to be used for similarity search. Valid values: cosine, euclidean.
    EncryptionConfigurations []VectorsIndexEncryptionConfigurationArgs
    Block for encryption configuration for the vector index. See encyption_configuration block below.
    IndexArn string
    ARN of the vector index.
    IndexName string
    Name of the vector index.
    MetadataConfiguration VectorsIndexMetadataConfigurationArgs
    Block for metadata configuration for the vector index. See metadata_configuration block below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    VectorBucketName string

    Name of the vector bucket for the vector index.

    The following arguments are optional:

    creationTime String
    Date and time when the vector index was created.
    dataType String
    Data type of the vectors to be inserted into the vector index. Valid values: float32.
    dimension Integer
    Dimensions of the vectors to be inserted into the vector index.
    distanceMetric String
    Distance metric to be used for similarity search. Valid values: cosine, euclidean.
    encryptionConfigurations List<VectorsIndexEncryptionConfiguration>
    Block for encryption configuration for the vector index. See encyption_configuration block below.
    indexArn String
    ARN of the vector index.
    indexName String
    Name of the vector index.
    metadataConfiguration VectorsIndexMetadataConfiguration
    Block for metadata configuration for the vector index. See metadata_configuration block below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    vectorBucketName String

    Name of the vector bucket for the vector index.

    The following arguments are optional:

    creationTime string
    Date and time when the vector index was created.
    dataType string
    Data type of the vectors to be inserted into the vector index. Valid values: float32.
    dimension number
    Dimensions of the vectors to be inserted into the vector index.
    distanceMetric string
    Distance metric to be used for similarity search. Valid values: cosine, euclidean.
    encryptionConfigurations VectorsIndexEncryptionConfiguration[]
    Block for encryption configuration for the vector index. See encyption_configuration block below.
    indexArn string
    ARN of the vector index.
    indexName string
    Name of the vector index.
    metadataConfiguration VectorsIndexMetadataConfiguration
    Block for metadata configuration for the vector index. See metadata_configuration block below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    vectorBucketName string

    Name of the vector bucket for the vector index.

    The following arguments are optional:

    creation_time str
    Date and time when the vector index was created.
    data_type str
    Data type of the vectors to be inserted into the vector index. Valid values: float32.
    dimension int
    Dimensions of the vectors to be inserted into the vector index.
    distance_metric str
    Distance metric to be used for similarity search. Valid values: cosine, euclidean.
    encryption_configurations Sequence[VectorsIndexEncryptionConfigurationArgs]
    Block for encryption configuration for the vector index. See encyption_configuration block below.
    index_arn str
    ARN of the vector index.
    index_name str
    Name of the vector index.
    metadata_configuration VectorsIndexMetadataConfigurationArgs
    Block for metadata configuration for the vector index. See metadata_configuration block below.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    vector_bucket_name str

    Name of the vector bucket for the vector index.

    The following arguments are optional:

    creationTime String
    Date and time when the vector index was created.
    dataType String
    Data type of the vectors to be inserted into the vector index. Valid values: float32.
    dimension Number
    Dimensions of the vectors to be inserted into the vector index.
    distanceMetric String
    Distance metric to be used for similarity search. Valid values: cosine, euclidean.
    encryptionConfigurations List<Property Map>
    Block for encryption configuration for the vector index. See encyption_configuration block below.
    indexArn String
    ARN of the vector index.
    indexName String
    Name of the vector index.
    metadataConfiguration Property Map
    Block for metadata configuration for the vector index. See metadata_configuration block below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    vectorBucketName String

    Name of the vector bucket for the vector index.

    The following arguments are optional:

    Supporting Types

    VectorsIndexEncryptionConfiguration, VectorsIndexEncryptionConfigurationArgs

    KmsKeyArn string
    SseType string
    Type of encryption to use. Valid values: AES256, aws:kms. Defaults to AES256.
    KmsKeyArn string
    SseType string
    Type of encryption to use. Valid values: AES256, aws:kms. Defaults to AES256.
    kmsKeyArn String
    sseType String
    Type of encryption to use. Valid values: AES256, aws:kms. Defaults to AES256.
    kmsKeyArn string
    sseType string
    Type of encryption to use. Valid values: AES256, aws:kms. Defaults to AES256.
    kms_key_arn str
    sse_type str
    Type of encryption to use. Valid values: AES256, aws:kms. Defaults to AES256.
    kmsKeyArn String
    sseType String
    Type of encryption to use. Valid values: AES256, aws:kms. Defaults to AES256.

    VectorsIndexMetadataConfiguration, VectorsIndexMetadataConfigurationArgs

    NonFilterableMetadataKeys List<string>
    List of non-filterable metadata keys.
    NonFilterableMetadataKeys []string
    List of non-filterable metadata keys.
    nonFilterableMetadataKeys List<String>
    List of non-filterable metadata keys.
    nonFilterableMetadataKeys string[]
    List of non-filterable metadata keys.
    non_filterable_metadata_keys Sequence[str]
    List of non-filterable metadata keys.
    nonFilterableMetadataKeys List<String>
    List of non-filterable metadata keys.

    Import

    Using pulumi import, import S3 Vectors Index using the index_arn. For example:

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v7.14.0 published on Thursday, Dec 11, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws
      Meet Neo: Your AI Platform Teammate