Class: AWSCDK::Kendra::CfnIndex::DocumentMetadataConfigurationProperty

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

Overview

Specifies the properties, such as relevance tuning and searchability, of an index field.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, type:, relevance: nil, search: nil) ⇒ DocumentMetadataConfigurationProperty

Returns a new instance of DocumentMetadataConfigurationProperty.

Parameters:



730
731
732
733
734
735
736
737
738
739
 
# File 'kendra/cfn_index.rb', line 730

def initialize(name:, type:, relevance: nil, search: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @relevance = relevance.is_a?(Hash) ? ::AWSCDK::Kendra::CfnIndex::RelevanceProperty.new(**relevance.transform_keys(&:to_sym)) : relevance
  Jsii::Type.check_type(@relevance, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuSW5kZXguUmVsZXZhbmNlUHJvcGVydHkifV19fQ==")), "relevance") unless @relevance.nil?
  @search = search.is_a?(Hash) ? ::AWSCDK::Kendra::CfnIndex::SearchProperty.new(**search.transform_keys(&:to_sym)) : search
  Jsii::Type.check_type(@search, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuSW5kZXguU2VhcmNoUHJvcGVydHkifV19fQ==")), "search") unless @search.nil?
end

Instance Attribute Details

#name ⇒ String (readonly)

The name of the index field.

Returns:

  • (String)

See Also:



745
746
747
 
# File 'kendra/cfn_index.rb', line 745

def name
  @name
end

#relevance ⇒ AWSCDK::IResolvable, ... (readonly)

Provides tuning parameters to determine how the field affects the search results.

Returns:

See Also:



755
756
757
 
# File 'kendra/cfn_index.rb', line 755

def relevance
  @relevance
end

#search ⇒ AWSCDK::IResolvable, ... (readonly)

Provides information about how the field is used during a search.

Returns:

See Also:



760
761
762
 
# File 'kendra/cfn_index.rb', line 760

def search
  @search
end

#type ⇒ String (readonly)

The data type of the index field.

Returns:

  • (String)

See Also:



750
751
752
 
# File 'kendra/cfn_index.rb', line 750

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



762
763
764
765
766
767
768
769
 
# File 'kendra/cfn_index.rb', line 762

def self.jsii_properties
  {
    :name => "name",
    :type => "type",
    :relevance => "relevance",
    :search => "search",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



771
772
773
774
775
776
777
778
779
780
 
# File 'kendra/cfn_index.rb', line 771

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "type" => @type,
    "relevance" => @relevance,
    "search" => @search,
  })
  result.compact
end