Class: AWSCDK::OpenSearchServerless::CfnIndex::IndexProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
open_search_serverless/cfn_index.rb

Overview

An OpenSearch Serverless index resource.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(knn: nil, knn_algo_param_ef_search: nil, refresh_interval: nil) ⇒ IndexProperty

Returns a new instance of IndexProperty.

Parameters:

  • knn (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Enable or disable k-nearest neighbor search capability.

  • knn_algo_param_ef_search (Numeric, nil) (defaults to: nil) —

    The size of the dynamic list for the nearest neighbors.

  • refresh_interval (String, nil) (defaults to: nil) —

    How often to perform a refresh operation.



543
544
545
546
547
548
549
550
 
# File 'open_search_serverless/cfn_index.rb', line 543

def initialize(knn: nil, knn_algo_param_ef_search: nil, refresh_interval: nil)
  @knn = knn
  Jsii::Type.check_type(@knn, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "knn") unless @knn.nil?
  @knn_algo_param_ef_search = knn_algo_param_ef_search
  Jsii::Type.check_type(@knn_algo_param_ef_search, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "knnAlgoParamEfSearch") unless @knn_algo_param_ef_search.nil?
  @refresh_interval = refresh_interval
  Jsii::Type.check_type(@refresh_interval, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "refreshInterval") unless @refresh_interval.nil?
end

Instance Attribute Details

#knn ⇒ Boolean, ... (readonly)

Enable or disable k-nearest neighbor search capability.

Returns:

See Also:



556
557
558
 
# File 'open_search_serverless/cfn_index.rb', line 556

def knn
  @knn
end

#knn_algo_param_ef_search ⇒ Numeric? (readonly)

The size of the dynamic list for the nearest neighbors.

Returns:

  • (Numeric, nil)

See Also:



561
562
563
 
# File 'open_search_serverless/cfn_index.rb', line 561

def knn_algo_param_ef_search
  @knn_algo_param_ef_search
end

#refresh_interval ⇒ String? (readonly)

How often to perform a refresh operation.

For example, 1s or 5s.

Returns:

  • (String, nil)

See Also:



568
569
570
 
# File 'open_search_serverless/cfn_index.rb', line 568

def refresh_interval
  @refresh_interval
end

Class Method Details

.jsii_properties ⇒ Object 



570
571
572
573
574
575
576
 
# File 'open_search_serverless/cfn_index.rb', line 570

def self.jsii_properties
  {
    :knn => "knn",
    :knn_algo_param_ef_search => "knnAlgoParamEfSearch",
    :refresh_interval => "refreshInterval",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



578
579
580
581
582
583
584
585
586
 
# File 'open_search_serverless/cfn_index.rb', line 578

def to_jsii
  result = {}
  result.merge!({
    "knn" => @knn,
    "knnAlgoParamEfSearch" => @knn_algo_param_ef_search,
    "refreshInterval" => @refresh_interval,
  })
  result.compact
end