1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. s3vectors
  5. Index

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.38.0 published on Wednesday, Nov 5, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.s3vectors.Index

Start a Neo task
Explain and create an aws-native.s3vectors.Index resource
aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.38.0 published on Wednesday, Nov 5, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::S3Vectors::Index

    Create Index Resource

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

    Constructor syntax

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

@overload
def Index(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          data_type: Optional[IndexDataType] = None,
          dimension: Optional[int] = None,
          distance_metric: Optional[IndexDistanceMetric] = None,
          index_name: Optional[str] = None,
          metadata_configuration: Optional[IndexMetadataConfigurationArgs] = None,
          vector_bucket_arn: Optional[str] = None,
          vector_bucket_name: Optional[str] = None)
    func NewIndex(ctx *Context, name string, args IndexArgs, opts ...ResourceOption) (*Index, error)
    public Index(string name, IndexArgs args, CustomResourceOptions? opts = null)
    public Index(String name, IndexArgs args)
public Index(String name, IndexArgs args, CustomResourceOptions options)

    type: aws-native:s3vectors:Index
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 IndexArgs
    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 IndexArgs
    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 IndexArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IndexArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IndexArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Index 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 Index resource accepts the following input properties:

    DataType Pulumi.AwsNative.S3Vectors.IndexDataType
    The data type of the vectors to be inserted into the vector index. Currently, only float32 is supported, which represents 32-bit floating-point numbers.
    Dimension int

    The dimensions of the vectors to be inserted into the vector index. This value must be between 1 and 4096, inclusive. All vectors stored in the index must have the same number of dimensions.

    The dimension value affects the storage requirements and search performance. Higher dimensions require more storage space and may impact search latency.

    DistanceMetric Pulumi.AwsNative.S3Vectors.IndexDistanceMetric
    The distance metric to be used for similarity search. Valid values are:

    • cosine - Measures the cosine of the angle between two vectors.
    • euclidean - Measures the straight-line distance between two points in multi-dimensional space. Lower values indicate greater similarity.
    IndexName string

    The name of the vector index to create. The index name must be between 3 and 63 characters long and can contain only lowercase letters, numbers, hyphens (-), and dots (.). The index name must be unique within the vector bucket.

    If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the index name.

    If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.

    MetadataConfiguration Pulumi.AwsNative.S3Vectors.Inputs.IndexMetadataConfiguration
    The metadata configuration for the vector index.
    VectorBucketArn string
    The Amazon Resource Name (ARN) of the vector bucket that contains the vector index.
    VectorBucketName string
    The name of the vector bucket that contains the vector index.
    DataType IndexDataType
    The data type of the vectors to be inserted into the vector index. Currently, only float32 is supported, which represents 32-bit floating-point numbers.
    Dimension int

    The dimensions of the vectors to be inserted into the vector index. This value must be between 1 and 4096, inclusive. All vectors stored in the index must have the same number of dimensions.

    The dimension value affects the storage requirements and search performance. Higher dimensions require more storage space and may impact search latency.

    DistanceMetric IndexDistanceMetric
    The distance metric to be used for similarity search. Valid values are:

    • cosine - Measures the cosine of the angle between two vectors.
    • euclidean - Measures the straight-line distance between two points in multi-dimensional space. Lower values indicate greater similarity.
    IndexName string

    The name of the vector index to create. The index name must be between 3 and 63 characters long and can contain only lowercase letters, numbers, hyphens (-), and dots (.). The index name must be unique within the vector bucket.

    If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the index name.

    If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.

    MetadataConfiguration IndexMetadataConfigurationArgs
    The metadata configuration for the vector index.
    VectorBucketArn string
    The Amazon Resource Name (ARN) of the vector bucket that contains the vector index.
    VectorBucketName string
    The name of the vector bucket that contains the vector index.
    dataType IndexDataType
    The data type of the vectors to be inserted into the vector index. Currently, only float32 is supported, which represents 32-bit floating-point numbers.
    dimension Integer

    The dimensions of the vectors to be inserted into the vector index. This value must be between 1 and 4096, inclusive. All vectors stored in the index must have the same number of dimensions.

    The dimension value affects the storage requirements and search performance. Higher dimensions require more storage space and may impact search latency.

    distanceMetric IndexDistanceMetric
    The distance metric to be used for similarity search. Valid values are:

    • cosine - Measures the cosine of the angle between two vectors.
    • euclidean - Measures the straight-line distance between two points in multi-dimensional space. Lower values indicate greater similarity.
    indexName String

    The name of the vector index to create. The index name must be between 3 and 63 characters long and can contain only lowercase letters, numbers, hyphens (-), and dots (.). The index name must be unique within the vector bucket.

    If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the index name.

    If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.

    metadataConfiguration IndexMetadataConfiguration
    The metadata configuration for the vector index.
    vectorBucketArn String
    The Amazon Resource Name (ARN) of the vector bucket that contains the vector index.
    vectorBucketName String
    The name of the vector bucket that contains the vector index.
    dataType IndexDataType
    The data type of the vectors to be inserted into the vector index. Currently, only float32 is supported, which represents 32-bit floating-point numbers.
    dimension number

    The dimensions of the vectors to be inserted into the vector index. This value must be between 1 and 4096, inclusive. All vectors stored in the index must have the same number of dimensions.

    The dimension value affects the storage requirements and search performance. Higher dimensions require more storage space and may impact search latency.

    distanceMetric IndexDistanceMetric
    The distance metric to be used for similarity search. Valid values are:

    • cosine - Measures the cosine of the angle between two vectors.
    • euclidean - Measures the straight-line distance between two points in multi-dimensional space. Lower values indicate greater similarity.
    indexName string

    The name of the vector index to create. The index name must be between 3 and 63 characters long and can contain only lowercase letters, numbers, hyphens (-), and dots (.). The index name must be unique within the vector bucket.

    If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the index name.

    If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.

    metadataConfiguration IndexMetadataConfiguration
    The metadata configuration for the vector index.
    vectorBucketArn string
    The Amazon Resource Name (ARN) of the vector bucket that contains the vector index.
    vectorBucketName string
    The name of the vector bucket that contains the vector index.
    data_type IndexDataType
    The data type of the vectors to be inserted into the vector index. Currently, only float32 is supported, which represents 32-bit floating-point numbers.
    dimension int

    The dimensions of the vectors to be inserted into the vector index. This value must be between 1 and 4096, inclusive. All vectors stored in the index must have the same number of dimensions.

    The dimension value affects the storage requirements and search performance. Higher dimensions require more storage space and may impact search latency.

    distance_metric IndexDistanceMetric
    The distance metric to be used for similarity search. Valid values are:

    • cosine - Measures the cosine of the angle between two vectors.
    • euclidean - Measures the straight-line distance between two points in multi-dimensional space. Lower values indicate greater similarity.
    index_name str

    The name of the vector index to create. The index name must be between 3 and 63 characters long and can contain only lowercase letters, numbers, hyphens (-), and dots (.). The index name must be unique within the vector bucket.

    If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the index name.

    If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.

    metadata_configuration IndexMetadataConfigurationArgs
    The metadata configuration for the vector index.
    vector_bucket_arn str
    The Amazon Resource Name (ARN) of the vector bucket that contains the vector index.
    vector_bucket_name str
    The name of the vector bucket that contains the vector index.
    dataType "float32"
    The data type of the vectors to be inserted into the vector index. Currently, only float32 is supported, which represents 32-bit floating-point numbers.
    dimension Number

    The dimensions of the vectors to be inserted into the vector index. This value must be between 1 and 4096, inclusive. All vectors stored in the index must have the same number of dimensions.

    The dimension value affects the storage requirements and search performance. Higher dimensions require more storage space and may impact search latency.

    distanceMetric "cosine" | "euclidean"
    The distance metric to be used for similarity search. Valid values are:

    • cosine - Measures the cosine of the angle between two vectors.
    • euclidean - Measures the straight-line distance between two points in multi-dimensional space. Lower values indicate greater similarity.
    indexName String

    The name of the vector index to create. The index name must be between 3 and 63 characters long and can contain only lowercase letters, numbers, hyphens (-), and dots (.). The index name must be unique within the vector bucket.

    If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the index name.

    If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.

    metadataConfiguration Property Map
    The metadata configuration for the vector index.
    vectorBucketArn String
    The Amazon Resource Name (ARN) of the vector bucket that contains the vector index.
    vectorBucketName String
    The name of the vector bucket that contains the vector index.

    Outputs

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

    CreationTime string

    Returns the date and time when the vector index was created.

    Example: 2024-12-21T10:30:00Z

    Id string
    The provider-assigned unique ID for this managed resource.
    IndexArn string

    Returns the Amazon Resource Name (ARN) of the specified index.

    Example: arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index

    CreationTime string

    Returns the date and time when the vector index was created.

    Example: 2024-12-21T10:30:00Z

    Id string
    The provider-assigned unique ID for this managed resource.
    IndexArn string

    Returns the Amazon Resource Name (ARN) of the specified index.

    Example: arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index

    creationTime String

    Returns the date and time when the vector index was created.

    Example: 2024-12-21T10:30:00Z

    id String
    The provider-assigned unique ID for this managed resource.
    indexArn String

    Returns the Amazon Resource Name (ARN) of the specified index.

    Example: arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index

    creationTime string

    Returns the date and time when the vector index was created.

    Example: 2024-12-21T10:30:00Z

    id string
    The provider-assigned unique ID for this managed resource.
    indexArn string

    Returns the Amazon Resource Name (ARN) of the specified index.

    Example: arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index

    creation_time str

    Returns the date and time when the vector index was created.

    Example: 2024-12-21T10:30:00Z

    id str
    The provider-assigned unique ID for this managed resource.
    index_arn str

    Returns the Amazon Resource Name (ARN) of the specified index.

    Example: arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index

    creationTime String

    Returns the date and time when the vector index was created.

    Example: 2024-12-21T10:30:00Z

    id String
    The provider-assigned unique ID for this managed resource.
    indexArn String

    Returns the Amazon Resource Name (ARN) of the specified index.

    Example: arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index

    Supporting Types

    IndexDataType, IndexDataTypeArgs

    Float32
    float32
    IndexDataTypeFloat32
    float32
    Float32
    float32
    Float32
    float32
    FLOAT32
    float32
    "float32"
    float32

    IndexDistanceMetric, IndexDistanceMetricArgs

    Cosine
    cosine
    Euclidean
    euclidean
    IndexDistanceMetricCosine
    cosine
    IndexDistanceMetricEuclidean
    euclidean
    Cosine
    cosine
    Euclidean
    euclidean
    Cosine
    cosine
    Euclidean
    euclidean
    COSINE
    cosine
    EUCLIDEAN
    euclidean
    "cosine"
    cosine
    "euclidean"
    euclidean

    IndexMetadataConfiguration, IndexMetadataConfigurationArgs

    The metadata configuration for the vector index.
    NonFilterableMetadataKeys List<string>
    Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval. Unlike default metadata keys, these keys cannot be used as query filters. Non-filterable metadata keys can be retrieved but cannot be searched, queried, or filtered. You can access non-filterable metadata keys of your vectors after finding the vectors.
    NonFilterableMetadataKeys []string
    Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval. Unlike default metadata keys, these keys cannot be used as query filters. Non-filterable metadata keys can be retrieved but cannot be searched, queried, or filtered. You can access non-filterable metadata keys of your vectors after finding the vectors.
    nonFilterableMetadataKeys List<String>
    Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval. Unlike default metadata keys, these keys cannot be used as query filters. Non-filterable metadata keys can be retrieved but cannot be searched, queried, or filtered. You can access non-filterable metadata keys of your vectors after finding the vectors.
    nonFilterableMetadataKeys string[]
    Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval. Unlike default metadata keys, these keys cannot be used as query filters. Non-filterable metadata keys can be retrieved but cannot be searched, queried, or filtered. You can access non-filterable metadata keys of your vectors after finding the vectors.
    non_filterable_metadata_keys Sequence[str]
    Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval. Unlike default metadata keys, these keys cannot be used as query filters. Non-filterable metadata keys can be retrieved but cannot be searched, queried, or filtered. You can access non-filterable metadata keys of your vectors after finding the vectors.
    nonFilterableMetadataKeys List<String>
    Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval. Unlike default metadata keys, these keys cannot be used as query filters. Non-filterable metadata keys can be retrieved but cannot be searched, queried, or filtered. You can access non-filterable metadata keys of your vectors after finding the vectors.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.38.0 published on Wednesday, Nov 5, 2025 by Pulumi
    pulumi/pulumi-aws-native
      Meet Neo: Your AI Platform Teammate