aws-cdk-lib.aws_opensearchserverless.CfnCollectionIndexProps

CfnCollectionIndexProps Struct

Properties for defining a CfnCollectionIndex.

CfnCollectionIndexProps

used as props by

• CfnCollectionIndex

Source

Generated code

Type last changed

v2.258.0 · 4 Jun 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_opensearchserverless as opensearchserverless } from 'aws-cdk-lib';
const cfnCollectionIndexProps: opensearchserverless.CfnCollectionIndexProps = {
  id: 'id',
  indexName: 'indexName',

  // the properties below are optional
  indexSchema: 'indexSchema',
};

Properties

idstringidstridStringIdstringId*stringrequired#

The identifier of the collection.

indexNamestringindex_namestrindexNameStringIndexNamestringIndexName*stringrequired#

The name of the collection index.

indexSchema?optionalstringindex_schema?optionalstrindexSchema?optionalStringIndexSchema?optionalstringIndexSchema?optional*string#

The Mappings for the collection index.