Package software.amazon.awscdk.services.opensearchserverless

Interface CfnIndexProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnIndexProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-20T23:37:25.856Z") @Stability(Stable) public interface CfnIndexProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnIndex.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.opensearchserverless.*;
 PropertyMappingProperty propertyMappingProperty_;
 CfnIndexProps cfnIndexProps = CfnIndexProps.builder()
         .collectionEndpoint("collectionEndpoint")
         .indexName("indexName")
         // the properties below are optional
         .mappings(MappingsProperty.builder()
                 .properties(Map.of(
                         "propertiesKey", PropertyMappingProperty.builder()
                                 .type("type")
                                 // the properties below are optional
                                 .dimension(123)
                                 .index(false)
                                 .method(MethodProperty.builder()
                                         .name("name")
                                         // the properties below are optional
                                         .engine("engine")
                                         .parameters(ParametersProperty.builder()
                                                 .efConstruction(123)
                                                 .m(123)
                                                 .build())
                                         .spaceType("spaceType")
                                         .build())
                                 .properties(Map.of(
                                         "propertiesKey", propertyMappingProperty_))
                                 .value("value")
                                 .build()))
                 .build())
         .settings(IndexSettingsProperty.builder()
                 .index(IndexProperty.builder()
                         .knn(false)
                         .knnAlgoParamEfSearch(123)
                         .refreshInterval("refreshInterval")
                         .build())
                 .build())
         .build();

See Also: