CfnCollectionIndexProps

class aws_cdk.aws_opensearchserverless.CfnCollectionIndexProps(*, id, index_name, index_schema=None)

Bases: object

Properties for defining a CfnCollectionIndex.

Parameters:

  • id (str) – The identifier of the collection.

  • index_name (str) – The name of the collection index.

  • index_schema (Optional[str]) – The Mappings for the collection index.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_opensearchserverless as opensearchserverless

cfn_collection_index_props = opensearchserverless.CfnCollectionIndexProps(
    id="id",
    index_name="indexName",

    # the properties below are optional
    index_schema="indexSchema"
)

Attributes

id

The identifier of the collection.

See:

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

index_name

The name of the collection index.

See:

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

index_schema

The Mappings for the collection index.

See:

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