Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. opensearchserverless
  5. Index

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.opensearchserverless.Index

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    An OpenSearch Serverless index resource

    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,
          collection_endpoint: Optional[str] = None,
          index_name: Optional[str] = None,
          mappings: Optional[MappingsPropertiesArgs] = None,
          settings: Optional[IndexSettingsArgs] = 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:opensearchserverless: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:

    CollectionEndpoint string
    The endpoint for the collection.
    IndexName string
    The name of the OpenSearch Serverless index.
    Mappings Pulumi.AwsNative.OpenSearchServerless.Inputs.MappingsProperties
    Index Mappings
    Settings Pulumi.AwsNative.OpenSearchServerless.Inputs.IndexSettings
    Index settings
    CollectionEndpoint string
    The endpoint for the collection.
    IndexName string
    The name of the OpenSearch Serverless index.
    Mappings MappingsPropertiesArgs
    Index Mappings
    Settings IndexSettingsArgs
    Index settings
    collectionEndpoint String
    The endpoint for the collection.
    indexName String
    The name of the OpenSearch Serverless index.
    mappings MappingsProperties
    Index Mappings
    settings IndexSettings
    Index settings
    collectionEndpoint string
    The endpoint for the collection.
    indexName string
    The name of the OpenSearch Serverless index.
    mappings MappingsProperties
    Index Mappings
    settings IndexSettings
    Index settings
    collection_endpoint str
    The endpoint for the collection.
    index_name str
    The name of the OpenSearch Serverless index.
    mappings MappingsPropertiesArgs
    Index Mappings
    settings IndexSettingsArgs
    Index settings
    collectionEndpoint String
    The endpoint for the collection.
    indexName String
    The name of the OpenSearch Serverless index.
    mappings Property Map
    Index Mappings
    settings Property Map
    Index settings

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Uuid string
    The unique identifier for the index.
    Id string
    The provider-assigned unique ID for this managed resource.
    Uuid string
    The unique identifier for the index.
    id String
    The provider-assigned unique ID for this managed resource.
    uuid String
    The unique identifier for the index.
    id string
    The provider-assigned unique ID for this managed resource.
    uuid string
    The unique identifier for the index.
    id str
    The provider-assigned unique ID for this managed resource.
    uuid str
    The unique identifier for the index.
    id String
    The provider-assigned unique ID for this managed resource.
    uuid String
    The unique identifier for the index.

    Supporting Types

    IndexPropertyMapping, IndexPropertyMappingArgs

    Type Pulumi.AwsNative.OpenSearchServerless.IndexPropertyMappingType
    The field data type. Must be a valid OpenSearch field type.
    Dimension int
    Dimension size for vector fields, defines the number of dimensions in the vector
    Index bool
    Whether a field should be indexed
    Method Pulumi.AwsNative.OpenSearchServerless.Inputs.IndexPropertyMappingMethodProperties
    Configuration for k-NN search method
    Properties Dictionary<string, Pulumi.AwsNative.OpenSearchServerless.Inputs.IndexPropertyMapping>
    Nested fields within an object or nested field type
    Value string
    Default value for the field when not specified in a document
    Type IndexPropertyMappingType
    The field data type. Must be a valid OpenSearch field type.
    Dimension int
    Dimension size for vector fields, defines the number of dimensions in the vector
    Index bool
    Whether a field should be indexed
    Method IndexPropertyMappingMethodProperties
    Configuration for k-NN search method
    Properties map[string]IndexPropertyMapping
    Nested fields within an object or nested field type
    Value string
    Default value for the field when not specified in a document
    type IndexPropertyMappingType
    The field data type. Must be a valid OpenSearch field type.
    dimension Integer
    Dimension size for vector fields, defines the number of dimensions in the vector
    index Boolean
    Whether a field should be indexed
    method IndexPropertyMappingMethodProperties
    Configuration for k-NN search method
    properties Map<String,IndexPropertyMapping>
    Nested fields within an object or nested field type
    value String
    Default value for the field when not specified in a document
    type IndexPropertyMappingType
    The field data type. Must be a valid OpenSearch field type.
    dimension number
    Dimension size for vector fields, defines the number of dimensions in the vector
    index boolean
    Whether a field should be indexed
    method IndexPropertyMappingMethodProperties
    Configuration for k-NN search method
    properties {[key: string]: IndexPropertyMapping}
    Nested fields within an object or nested field type
    value string
    Default value for the field when not specified in a document
    type IndexPropertyMappingType
    The field data type. Must be a valid OpenSearch field type.
    dimension int
    Dimension size for vector fields, defines the number of dimensions in the vector
    index bool
    Whether a field should be indexed
    method IndexPropertyMappingMethodProperties
    Configuration for k-NN search method
    properties Mapping[str, IndexPropertyMapping]
    Nested fields within an object or nested field type
    value str
    Default value for the field when not specified in a document
    type "text" | "knn_vector"
    The field data type. Must be a valid OpenSearch field type.
    dimension Number
    Dimension size for vector fields, defines the number of dimensions in the vector
    index Boolean
    Whether a field should be indexed
    method Property Map
    Configuration for k-NN search method
    properties Map<Property Map>
    Nested fields within an object or nested field type
    value String
    Default value for the field when not specified in a document

    IndexPropertyMappingMethodProperties, IndexPropertyMappingMethodPropertiesArgs

    Engine IndexPropertyMappingMethodPropertiesEngine
    The k-NN search engine to use
    Name IndexPropertyMappingMethodPropertiesName
    The algorithm name for k-NN search
    Parameters IndexPropertyMappingMethodPropertiesParametersProperties
    Additional parameters for the k-NN algorithm
    SpaceType IndexPropertyMappingMethodPropertiesSpaceType
    The distance function used for k-NN search
    engine IndexPropertyMappingMethodPropertiesEngine
    The k-NN search engine to use
    name IndexPropertyMappingMethodPropertiesName
    The algorithm name for k-NN search
    parameters IndexPropertyMappingMethodPropertiesParametersProperties
    Additional parameters for the k-NN algorithm
    spaceType IndexPropertyMappingMethodPropertiesSpaceType
    The distance function used for k-NN search
    engine IndexPropertyMappingMethodPropertiesEngine
    The k-NN search engine to use
    name IndexPropertyMappingMethodPropertiesName
    The algorithm name for k-NN search
    parameters IndexPropertyMappingMethodPropertiesParametersProperties
    Additional parameters for the k-NN algorithm
    spaceType IndexPropertyMappingMethodPropertiesSpaceType
    The distance function used for k-NN search
    engine IndexPropertyMappingMethodPropertiesEngine
    The k-NN search engine to use
    name IndexPropertyMappingMethodPropertiesName
    The algorithm name for k-NN search
    parameters IndexPropertyMappingMethodPropertiesParametersProperties
    Additional parameters for the k-NN algorithm
    space_type IndexPropertyMappingMethodPropertiesSpaceType
    The distance function used for k-NN search
    engine "nmslib" | "faiss" | "lucene"
    The k-NN search engine to use
    name "hnsw" | "ivf"
    The algorithm name for k-NN search
    parameters Property Map
    Additional parameters for the k-NN algorithm
    spaceType "l2" | "l1" | "linf" | "cosinesimil" | "innerproduct" | "hamming"
    The distance function used for k-NN search

    IndexPropertyMappingMethodPropertiesEngine, IndexPropertyMappingMethodPropertiesEngineArgs

    Nmslib
    nmslib
    Faiss
    faiss
    Lucene
    lucene
    IndexPropertyMappingMethodPropertiesEngineNmslib
    nmslib
    IndexPropertyMappingMethodPropertiesEngineFaiss
    faiss
    IndexPropertyMappingMethodPropertiesEngineLucene
    lucene
    Nmslib
    nmslib
    Faiss
    faiss
    Lucene
    lucene
    Nmslib
    nmslib
    Faiss
    faiss
    Lucene
    lucene
    NMSLIB
    nmslib
    FAISS
    faiss
    LUCENE
    lucene
    "nmslib"
    nmslib
    "faiss"
    faiss
    "lucene"
    lucene

    IndexPropertyMappingMethodPropertiesName, IndexPropertyMappingMethodPropertiesNameArgs

    Hnsw
    hnsw
    Ivf
    ivf
    IndexPropertyMappingMethodPropertiesNameHnsw
    hnsw
    IndexPropertyMappingMethodPropertiesNameIvf
    ivf
    Hnsw
    hnsw
    Ivf
    ivf
    Hnsw
    hnsw
    Ivf
    ivf
    HNSW
    hnsw
    IVF
    ivf
    "hnsw"
    hnsw
    "ivf"
    ivf

    IndexPropertyMappingMethodPropertiesParametersProperties, IndexPropertyMappingMethodPropertiesParametersPropertiesArgs

    EfConstruction int
    The size of the dynamic list used during k-NN graph creation
    M int
    Number of neighbors to consider during k-NN search
    EfConstruction int
    The size of the dynamic list used during k-NN graph creation
    M int
    Number of neighbors to consider during k-NN search
    efConstruction Integer
    The size of the dynamic list used during k-NN graph creation
    m Integer
    Number of neighbors to consider during k-NN search
    efConstruction number
    The size of the dynamic list used during k-NN graph creation
    m number
    Number of neighbors to consider during k-NN search
    ef_construction int
    The size of the dynamic list used during k-NN graph creation
    m int
    Number of neighbors to consider during k-NN search
    efConstruction Number
    The size of the dynamic list used during k-NN graph creation
    m Number
    Number of neighbors to consider during k-NN search

    IndexPropertyMappingMethodPropertiesSpaceType, IndexPropertyMappingMethodPropertiesSpaceTypeArgs

    L2
    l2
    L1
    l1
    Linf
    linf
    Cosinesimil
    cosinesimil
    Innerproduct
    innerproduct
    Hamming
    hamming
    IndexPropertyMappingMethodPropertiesSpaceTypeL2
    l2
    IndexPropertyMappingMethodPropertiesSpaceTypeL1
    l1
    IndexPropertyMappingMethodPropertiesSpaceTypeLinf
    linf
    IndexPropertyMappingMethodPropertiesSpaceTypeCosinesimil
    cosinesimil
    IndexPropertyMappingMethodPropertiesSpaceTypeInnerproduct
    innerproduct
    IndexPropertyMappingMethodPropertiesSpaceTypeHamming
    hamming
    L2
    l2
    L1
    l1
    Linf
    linf
    Cosinesimil
    cosinesimil
    Innerproduct
    innerproduct
    Hamming
    hamming
    L2
    l2
    L1
    l1
    Linf
    linf
    Cosinesimil
    cosinesimil
    Innerproduct
    innerproduct
    Hamming
    hamming
    L2
    l2
    L1
    l1
    LINF
    linf
    COSINESIMIL
    cosinesimil
    INNERPRODUCT
    innerproduct
    HAMMING
    hamming
    "l2"
    l2
    "l1"
    l1
    "linf"
    linf
    "cosinesimil"
    cosinesimil
    "innerproduct"
    innerproduct
    "hamming"
    hamming

    IndexPropertyMappingType, IndexPropertyMappingTypeArgs

    Text
    text
    KnnVector
    knn_vector
    IndexPropertyMappingTypeText
    text
    IndexPropertyMappingTypeKnnVector
    knn_vector
    Text
    text
    KnnVector
    knn_vector
    Text
    text
    KnnVector
    knn_vector
    TEXT
    text
    KNN_VECTOR
    knn_vector
    "text"
    text
    "knn_vector"
    knn_vector

    IndexSettings, IndexSettingsArgs

    IndexSettingsIndexProperties, IndexSettingsIndexPropertiesArgs

    Knn bool
    Enable/disable k-nearest neighbor search capability
    KnnAlgoParamEfSearch int
    Size of the dynamic list for the nearest neighbors
    RefreshInterval string
    How often to perform refresh operation (e.g. '1s', '5s')
    Knn bool
    Enable/disable k-nearest neighbor search capability
    KnnAlgoParamEfSearch int
    Size of the dynamic list for the nearest neighbors
    RefreshInterval string
    How often to perform refresh operation (e.g. '1s', '5s')
    knn Boolean
    Enable/disable k-nearest neighbor search capability
    knnAlgoParamEfSearch Integer
    Size of the dynamic list for the nearest neighbors
    refreshInterval String
    How often to perform refresh operation (e.g. '1s', '5s')
    knn boolean
    Enable/disable k-nearest neighbor search capability
    knnAlgoParamEfSearch number
    Size of the dynamic list for the nearest neighbors
    refreshInterval string
    How often to perform refresh operation (e.g. '1s', '5s')
    knn bool
    Enable/disable k-nearest neighbor search capability
    knn_algo_param_ef_search int
    Size of the dynamic list for the nearest neighbors
    refresh_interval str
    How often to perform refresh operation (e.g. '1s', '5s')
    knn Boolean
    Enable/disable k-nearest neighbor search capability
    knnAlgoParamEfSearch Number
    Size of the dynamic list for the nearest neighbors
    refreshInterval String
    How often to perform refresh operation (e.g. '1s', '5s')

    MappingsProperties, MappingsPropertiesArgs

    Properties Dictionary<string, Pulumi.AwsNative.OpenSearchServerless.Inputs.IndexPropertyMapping>
    Defines the fields within the mapping, including their types and configurations
    Properties map[string]IndexPropertyMapping
    Defines the fields within the mapping, including their types and configurations
    properties Map<String,IndexPropertyMapping>
    Defines the fields within the mapping, including their types and configurations
    properties {[key: string]: IndexPropertyMapping}
    Defines the fields within the mapping, including their types and configurations
    properties Mapping[str, IndexPropertyMapping]
    Defines the fields within the mapping, including their types and configurations
    properties Map<Property Map>
    Defines the fields within the mapping, including their types and configurations

    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.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native