CfnCollectionIndexMixinProps

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

Bases: object

Properties for CfnCollectionIndexPropsMixin.

Parameters:

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

  • index_name (Optional[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.cfn_property_mixins import aws_opensearchserverless as opensearchserverless

cfn_collection_index_mixin_props = opensearchserverless.CfnCollectionIndexMixinProps(
    id="id",
    index_name="indexName",
    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