CfnIndexMixinProps

class aws_cdk.mixins_preview.aws_opensearchserverless.mixins.CfnIndexMixinProps(*, collection_endpoint=None, index_name=None, mappings=None, settings=None)

Bases: object

Properties for CfnIndexPropsMixin.

Parameters:

• collection_endpoint (Optional[str]) – The endpoint for the collection.

• index_name (Optional[str]) – The name of the OpenSearch Serverless index.

• mappings (Union[IResolvable, MappingsProperty, Dict[str, Any], None]) – Index mappings for the OpenSearch Serverless index.

• settings (Union[IResolvable, IndexSettingsProperty, Dict[str, Any], None]) – Index settings for the OpenSearch Serverless index.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.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.mixins_preview.aws_opensearchserverless import mixins as opensearchserverless_mixins

# property_mapping_property_: opensearchserverless_mixins.CfnIndexPropsMixin.PropertyMappingProperty

cfn_index_mixin_props = opensearchserverless_mixins.CfnIndexMixinProps(
    collection_endpoint="collectionEndpoint",
    index_name="indexName",
    mappings=opensearchserverless_mixins.CfnIndexPropsMixin.MappingsProperty(
        properties={
            "properties_key": opensearchserverless_mixins.CfnIndexPropsMixin.PropertyMappingProperty(
                dimension=123,
                index=False,
                method=opensearchserverless_mixins.CfnIndexPropsMixin.MethodProperty(
                    engine="engine",
                    name="name",
                    parameters=opensearchserverless_mixins.CfnIndexPropsMixin.ParametersProperty(
                        ef_construction=123,
                        m=123
                    ),
                    space_type="spaceType"
                ),
                properties={
                    "properties_key": property_mapping_property_
                },
                type="type",
                value="value"
            )
        }
    ),
    settings=opensearchserverless_mixins.CfnIndexPropsMixin.IndexSettingsProperty(
        index=opensearchserverless_mixins.CfnIndexPropsMixin.IndexProperty(
            knn=False,
            knn_algo_param_ef_search=123,
            refresh_interval="refreshInterval"
        )
    )
)

Attributes

collection_endpoint

The endpoint for the collection.

See:

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

index_name

The name of the OpenSearch Serverless index.

See:

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

mappings

Index mappings for the OpenSearch Serverless index.

See:

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

settings

Index settings for the OpenSearch Serverless index.

See:

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