Package software.amazon.awscdk.services.opensearchserverless

Interface CfnIndex.IndexProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIndex.IndexProperty.Jsii$Proxy

Enclosing class:

CfnIndex

@Stability(Stable)
public static interface CfnIndex.IndexProperty
extends software.amazon.jsii.JsiiSerializable

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.*;
 IndexProperty indexProperty = IndexProperty.builder()
         .knn(false)
         .knnAlgoParamEfSearch(123)
         .refreshInterval("refreshInterval")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnIndex.IndexProperty.Builder	builder()
default Object	getKnn()	Enable or disable k-nearest neighbor search capability.
default Number	getKnnAlgoParamEfSearch()	The size of the dynamic list for the nearest neighbors.
default String	getRefreshInterval()	How often to perform a refresh operation.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getKnn

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

Enable or disable k-nearest neighbor search capability.

Returns union: either Boolean or IResolvable

See Also:

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

getKnnAlgoParamEfSearch

@Stability(Stable)
@Nullable
default Number getKnnAlgoParamEfSearch()

The size of the dynamic list for the nearest neighbors.

See Also:

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

getRefreshInterval

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

How often to perform a refresh operation.

For example, 1s or 5s.

See Also:

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

builder

@Stability(Stable)
static CfnIndex.IndexProperty.Builder builder()

Returns:

a CfnIndex.IndexProperty.Builder of CfnIndex.IndexProperty