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

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.getIndex

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

    Using getIndex

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getIndex(args: GetIndexArgs, opts?: InvokeOptions): Promise<GetIndexResult>
function getIndexOutput(args: GetIndexOutputArgs, opts?: InvokeOptions): Output<GetIndexResult>
    def get_index(collection_endpoint: Optional[str] = None,
              index_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetIndexResult
def get_index_output(collection_endpoint: Optional[pulumi.Input[str]] = None,
              index_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetIndexResult]
    func LookupIndex(ctx *Context, args *LookupIndexArgs, opts ...InvokeOption) (*LookupIndexResult, error)
func LookupIndexOutput(ctx *Context, args *LookupIndexOutputArgs, opts ...InvokeOption) LookupIndexResultOutput

    > Note: This function is named LookupIndex in the Go SDK.

    public static class GetIndex 
{
    public static Task<GetIndexResult> InvokeAsync(GetIndexArgs args, InvokeOptions? opts = null)
    public static Output<GetIndexResult> Invoke(GetIndexInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIndexResult> getIndex(GetIndexArgs args, InvokeOptions options)
public static Output<GetIndexResult> getIndex(GetIndexArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:opensearchserverless:getIndex
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CollectionEndpoint string
    The endpoint for the collection.
    IndexName string
    The name of the OpenSearch Serverless index.
    CollectionEndpoint string
    The endpoint for the collection.
    IndexName string
    The name of the OpenSearch Serverless index.
    collectionEndpoint String
    The endpoint for the collection.
    indexName String
    The name of the OpenSearch Serverless index.
    collectionEndpoint string
    The endpoint for the collection.
    indexName string
    The name of the OpenSearch Serverless index.
    collection_endpoint str
    The endpoint for the collection.
    index_name str
    The name of the OpenSearch Serverless index.
    collectionEndpoint String
    The endpoint for the collection.
    indexName String
    The name of the OpenSearch Serverless index.

    getIndex Result

    The following output properties are available:

    Mappings MappingsProperties
    Index Mappings
    Settings IndexSettings
    Index settings
    Uuid string
    The unique identifier for the index.
    mappings MappingsProperties
    Index Mappings
    settings IndexSettings
    Index settings
    uuid String
    The unique identifier for the index.
    mappings MappingsProperties
    Index Mappings
    settings IndexSettings
    Index settings
    uuid string
    The unique identifier for the index.
    mappings MappingsProperties
    Index Mappings
    settings IndexSettings
    Index settings
    uuid str
    The unique identifier for the index.
    mappings Property Map
    Index Mappings
    settings Property Map
    Index settings
    uuid String
    The unique identifier for the index.

    Supporting Types

    IndexPropertyMapping

    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

    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

    IndexPropertyMappingMethodPropertiesName

    IndexPropertyMappingMethodPropertiesParametersProperties

    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

    IndexPropertyMappingType

    IndexSettings

    IndexSettingsIndexProperties

    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

    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