1. Packages
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. opensearchserverless
  6. getCollectionIndex

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

Viewing docs for AWS Cloud Control v1.68.0
published on Monday, Jun 1, 2026 by Pulumi
aws-native logo

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

Viewing docs for AWS Cloud Control v1.68.0
published on Monday, Jun 1, 2026 by Pulumi

    Resource schema for AWS::OpenSearchServerless::CollectionIndex

    Using getCollectionIndex

    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 getCollectionIndex(args: GetCollectionIndexArgs, opts?: InvokeOptions): Promise<GetCollectionIndexResult>
    function getCollectionIndexOutput(args: GetCollectionIndexOutputArgs, opts?: InvokeOptions): Output<GetCollectionIndexResult>
    def get_collection_index(id: Optional[str] = None,
                             index_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetCollectionIndexResult
    def get_collection_index_output(id: pulumi.Input[Optional[str]] = None,
                             index_name: pulumi.Input[Optional[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetCollectionIndexResult]
    func LookupCollectionIndex(ctx *Context, args *LookupCollectionIndexArgs, opts ...InvokeOption) (*LookupCollectionIndexResult, error)
    func LookupCollectionIndexOutput(ctx *Context, args *LookupCollectionIndexOutputArgs, opts ...InvokeOption) LookupCollectionIndexResultOutput

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

    public static class GetCollectionIndex 
    {
        public static Task<GetCollectionIndexResult> InvokeAsync(GetCollectionIndexArgs args, InvokeOptions? opts = null)
        public static Output<GetCollectionIndexResult> Invoke(GetCollectionIndexInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCollectionIndexResult> getCollectionIndex(GetCollectionIndexArgs args, InvokeOptions options)
    public static Output<GetCollectionIndexResult> getCollectionIndex(GetCollectionIndexArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aws-native:opensearchserverless:getCollectionIndex
      arguments:
        # arguments dictionary
    data "aws-native_opensearchserverless_getcollectionindex" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    The identifier of the collection
    IndexName string
    The name of the collection index
    Id string
    The identifier of the collection
    IndexName string
    The name of the collection index
    id string
    The identifier of the collection
    index_name string
    The name of the collection index
    id String
    The identifier of the collection
    indexName String
    The name of the collection index
    id string
    The identifier of the collection
    indexName string
    The name of the collection index
    id str
    The identifier of the collection
    index_name str
    The name of the collection index
    id String
    The identifier of the collection
    indexName String
    The name of the collection index

    getCollectionIndex Result

    The following output properties are available:

    IndexSchema string
    The Mappings for the collection index
    IndexSchema string
    The Mappings for the collection index
    index_schema string
    The Mappings for the collection index
    indexSchema String
    The Mappings for the collection index
    indexSchema string
    The Mappings for the collection index
    index_schema str
    The Mappings for the collection index
    indexSchema String
    The Mappings for the collection index

    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.

    Viewing docs for AWS Cloud Control v1.68.0
    published on Monday, Jun 1, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial