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

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

    Create CollectionIndex Resource

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

    Constructor syntax

    new CollectionIndex(name: string, args: CollectionIndexArgs, opts?: CustomResourceOptions);
    @overload
    def CollectionIndex(resource_name: str,
                        args: CollectionIndexArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def CollectionIndex(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        aws_id: Optional[str] = None,
                        index_name: Optional[str] = None,
                        index_schema: Optional[str] = None)
    func NewCollectionIndex(ctx *Context, name string, args CollectionIndexArgs, opts ...ResourceOption) (*CollectionIndex, error)
    public CollectionIndex(string name, CollectionIndexArgs args, CustomResourceOptions? opts = null)
    public CollectionIndex(String name, CollectionIndexArgs args)
    public CollectionIndex(String name, CollectionIndexArgs args, CustomResourceOptions options)
    
    type: aws-native:opensearchserverless:CollectionIndex
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_opensearchserverless_collectionindex" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args CollectionIndexArgs
    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 CollectionIndexArgs
    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 CollectionIndexArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CollectionIndexArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CollectionIndexArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    AwsId string
    The identifier of the collection
    IndexName string
    The name of the collection index
    IndexSchema string
    The Mappings for the collection index
    AwsId string
    The identifier of the collection
    IndexName string
    The name of the collection index
    IndexSchema string
    The Mappings for the collection index
    aws_id string
    The identifier of the collection
    index_name string
    The name of the collection index
    index_schema string
    The Mappings for the collection index
    awsId String
    The identifier of the collection
    indexName String
    The name of the collection index
    indexSchema String
    The Mappings for the collection index
    awsId string
    The identifier of the collection
    indexName string
    The name of the collection index
    indexSchema string
    The Mappings for the collection index
    aws_id str
    The identifier of the collection
    index_name str
    The name of the collection index
    index_schema str
    The Mappings for the collection index
    awsId String
    The identifier of the collection
    indexName String
    The name of the collection index
    indexSchema String
    The Mappings for the collection index

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    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