Package software.amazon.awscdk.services.opensearchserverless

Class CfnIndex

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.opensearchserverless.CfnIndex
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IIndexRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:25.242Z") @Stability(Stable) public class CfnIndex extends CfnResource implements IInspectable, IIndexRef
An OpenSearch Serverless index resource.

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_;
 CfnIndex cfnIndex = CfnIndex.Builder.create(this, "MyCfnIndex")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnIndex

      protected CfnIndex(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnIndex

      protected CfnIndex(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnIndex

      @Stability(Stable) public CfnIndex(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIndexProps props)
      Create a new AWS::OpenSearchServerless::Index.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnIndex

      @Stability(Stable) @NotNull public static Boolean isCfnIndex(@NotNull Object x)
      Checks whether the given object is a CfnIndex.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrUuid

      @Stability(Stable) @NotNull public String getAttrUuid()
      The unique identifier for the index.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getIndexRef

      @Stability(Stable) @NotNull public IndexReference getIndexRef()
      A reference to a Index resource.
      Specified by:
      getIndexRef in interface IIndexRef

    • getCollectionEndpoint

      @Stability(Stable) @NotNull public String getCollectionEndpoint()
      The endpoint for the collection.

    • setCollectionEndpoint

      @Stability(Stable) public void setCollectionEndpoint(@NotNull String value)
      The endpoint for the collection.

    • getIndexName

      @Stability(Stable) @NotNull public String getIndexName()
      The name of the OpenSearch Serverless index.

    • setIndexName

      @Stability(Stable) public void setIndexName(@NotNull String value)
      The name of the OpenSearch Serverless index.

    • getMappings

      @Stability(Stable) @Nullable public Object getMappings()
      Index mappings for the OpenSearch Serverless index.

      Returns union: either IResolvable or CfnIndex.MappingsProperty

    • setMappings

      @Stability(Stable) public void setMappings(@Nullable IResolvable value)
      Index mappings for the OpenSearch Serverless index.

    • setMappings

      @Stability(Stable) public void setMappings(@Nullable CfnIndex.MappingsProperty value)
      Index mappings for the OpenSearch Serverless index.

    • getSettings

      @Stability(Stable) @Nullable public Object getSettings()
      Index settings for the OpenSearch Serverless index.

      Returns union: either IResolvable or CfnIndex.IndexSettingsProperty

    • setSettings

      @Stability(Stable) public void setSettings(@Nullable IResolvable value)
      Index settings for the OpenSearch Serverless index.

    • setSettings

      @Stability(Stable) public void setSettings(@Nullable CfnIndex.IndexSettingsProperty value)
      Index settings for the OpenSearch Serverless index.