Package software.amazon.awscdk.cfnpropertymixins.services.opensearchserverless

Interface CfnIndexMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIndexMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-07-22T17:37:45.333Z")
@Stability(Stable)
public interface CfnIndexMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnIndexPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.opensearchserverless.*;
 PropertyMappingProperty propertyMappingProperty_;
 CfnIndexMixinProps cfnIndexMixinProps = CfnIndexMixinProps.builder()
         .collectionEndpoint("collectionEndpoint")
         .indexName("indexName")
         .mappings(MappingsProperty.builder()
                 .properties(Map.of(
                         "propertiesKey", PropertyMappingProperty.builder()
                                 .analyzer("analyzer")
                                 .compressionLevel("compressionLevel")
                                 .dimension(123)
                                 .index(false)
                                 .method(MethodProperty.builder()
                                         .engine("engine")
                                         .name("name")
                                         .parameters(ParametersProperty.builder()
                                                 .efConstruction(123)
                                                 .m(123)
                                                 .build())
                                         .spaceType("spaceType")
                                         .build())
                                 .properties(Map.of(
                                         "propertiesKey", propertyMappingProperty_))
                                 .spaceType("spaceType")
                                 .type("type")
                                 .value("value")
                                 .build()))
                 .build())
         .settings(IndexSettingsProperty.builder()
                 .analysis(AnalysisProperty.builder()
                         .analyzer(Map.of(
                                 "analyzerKey", AnalyzerItemsProperty.builder()
                                         .charFilter(List.of("charFilter"))
                                         .filter(List.of("filter"))
                                         .tokenizer("tokenizer")
                                         .type("type")
                                         .build()))
                         .build())
                 .index(IndexProperty.builder()
                         .knn(false)
                         .knnAlgoParamEfSearch(123)
                         .refreshInterval("refreshInterval")
                         .build())
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnIndexMixinProps.Builder	A builder for CfnIndexMixinProps
static final class	CfnIndexMixinProps.Jsii$Proxy	An implementation for CfnIndexMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnIndexMixinProps.Builder	builder()
default String	getCollectionEndpoint()	The endpoint for the collection.
default String	getIndexName()	The name of the OpenSearch Serverless index.
default Object	getMappings()	Index mappings for the OpenSearch Serverless index.
default Object	getSettings()	Index settings for the OpenSearch Serverless index.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCollectionEndpoint

@Stability(Stable)
@Nullable
default String getCollectionEndpoint()

The endpoint for the collection.

See Also:

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

getIndexName

@Stability(Stable)
@Nullable
default String getIndexName()

The name of the OpenSearch Serverless index.

See Also:

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

getMappings

@Stability(Stable)
@Nullable
default Object getMappings()

Index mappings for the OpenSearch Serverless index.

Returns union: either IResolvable or CfnIndexPropsMixin.MappingsProperty

See Also:

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

getSettings

@Stability(Stable)
@Nullable
default Object getSettings()

Index settings for the OpenSearch Serverless index.

Returns union: either IResolvable or CfnIndexPropsMixin.IndexSettingsProperty

See Also:

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

builder

@Stability(Stable)
static CfnIndexMixinProps.Builder builder()

Returns:

a CfnIndexMixinProps.Builder of CfnIndexMixinProps