Class: AWSCDK::Kendra::CfnIndex::ValueImportanceItemProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Kendra::CfnIndex::ValueImportanceItemProperty

Defined in:

kendra/cfn_index.rb

Overview

Specifies a key-value pair of the search boost value for a document when the key is part of the metadata of a document.

See Also:

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

Instance Attribute Summary

• #key ⇒ String^? readonly

  The document metadata value used for the search boost.

• #value ⇒ Numeric^? readonly

  The boost value for a document when the key is part of the metadata of a document.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(key: nil, value: nil) ⇒ ValueImportanceItemProperty constructor

  A new instance of ValueImportanceItemProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(key: nil, value: nil) ⇒ ValueImportanceItemProperty

Returns a new instance of ValueImportanceItemProperty.

Parameters:

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

  The document metadata value used for the search boost.

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

  The boost value for a document when the key is part of the metadata of a document.

# File 'kendra/cfn_index.rb', line 1173

def initialize(key: nil, value: nil)
  @key = key
  Jsii::Type.check_type(@key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key") unless @key.nil?
  @value = value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "value") unless @value.nil?
end

Instance Attribute Details

#key ⇒ String^? (readonly)

The document metadata value used for the search boost.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-valueimportanceitem.html#cfn-kendra-index-valueimportanceitem-key

# File 'kendra/cfn_index.rb', line 1184

def key
  @key
end

#value ⇒ Numeric^? (readonly)

The boost value for a document when the key is part of the metadata of a document.

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-valueimportanceitem.html#cfn-kendra-index-valueimportanceitem-value

# File 'kendra/cfn_index.rb', line 1189

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object

# File 'kendra/cfn_index.rb', line 1191

def self.jsii_properties
  {
    :key => "key",
    :value => "value",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'kendra/cfn_index.rb', line 1198

def to_jsii
  result = {}
  result.merge!({
    "key" => @key,
    "value" => @value,
  })
  result.compact
end