interface CfnCollectionIndexProps

Language	Type name
.NET	Amazon.CDK.AWS.OpenSearchServerless.CfnCollectionIndexProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsopensearchserverless#CfnCollectionIndexProps
Java	software.amazon.awscdk.services.opensearchserverless.CfnCollectionIndexProps
Python	aws_cdk.aws_opensearchserverless.CfnCollectionIndexProps
TypeScript	aws-cdk-lib » aws_opensearchserverless » CfnCollectionIndexProps

Properties for defining a CfnCollectionIndex.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collectionindex.html

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

Name	Type	Description
id	string	The identifier of the collection.
indexName	string	The name of the collection index.
indexSchema?	string	The Mappings for the collection index.

---

id

Type: string

The identifier of the collection.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collectionindex.html#cfn-opensearchserverless-collectionindex-id

---

indexName

Type: string

The name of the collection index.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collectionindex.html#cfn-opensearchserverless-collectionindex-indexname

---

indexSchema?

Type: string (optional)

The Mappings for the collection index.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collectionindex.html#cfn-opensearchserverless-collectionindex-indexschema