Class: AWSCDK::Kendra::CfnDataSource::DocumentAttributeConditionProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Kendra::CfnDataSource::DocumentAttributeConditionProperty

Defined in:

kendra/cfn_data_source.rb

Overview

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra.

You use this with DocumentAttributeTarget to apply the condition .

For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.

Amazon Kendra cannot create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget . Amazon Kendra then will map your newly created metadata field to your index field.

See Also:

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

Instance Attribute Summary

• #condition_document_attribute_key ⇒ String readonly

  The identifier of the document attribute used for the condition.

• #condition_on_value ⇒ AWSCDK::IResolvable, ... readonly

  The value used by the operator.

• #operator ⇒ String readonly

  The condition operator.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(condition_document_attribute_key:, operator:, condition_on_value: nil) ⇒ DocumentAttributeConditionProperty constructor

  A new instance of DocumentAttributeConditionProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(condition_document_attribute_key:, operator:, condition_on_value: nil) ⇒ DocumentAttributeConditionProperty

Returns a new instance of DocumentAttributeConditionProperty.

Parameters:

• condition_document_attribute_key (String) —

  The identifier of the document attribute used for the condition.

• operator (String) —

  The condition operator.

• condition_on_value (AWSCDK::IResolvable, AWSCDK::Kendra::CfnDataSource::DocumentAttributeValueProperty, nil) (defaults to: nil) —

  The value used by the operator.

# File 'kendra/cfn_data_source.rb', line 1864

def initialize(condition_document_attribute_key:, operator:, condition_on_value: nil)
  @condition_document_attribute_key = condition_document_attribute_key
  Jsii::Type.check_type(@condition_document_attribute_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "conditionDocumentAttributeKey")
  @operator = operator
  Jsii::Type.check_type(@operator, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "operator")
  @condition_on_value = condition_on_value.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::DocumentAttributeValueProperty.new(**condition_on_value.transform_keys(&:to_sym)) : condition_on_value
  Jsii::Type.check_type(@condition_on_value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5Eb2N1bWVudEF0dHJpYnV0ZVZhbHVlUHJvcGVydHkifV19fQ==")), "conditionOnValue") unless @condition_on_value.nil?
end

Instance Attribute Details

#condition_document_attribute_key ⇒ String (readonly)

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributecondition.html#cfn-kendra-datasource-documentattributecondition-conditiondocumentattributekey

# File 'kendra/cfn_data_source.rb', line 1881

def condition_document_attribute_key
  @condition_document_attribute_key
end

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

The value used by the operator.

For example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value.

Returns:

• (AWSCDK::IResolvable, AWSCDK::Kendra::CfnDataSource::DocumentAttributeValueProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributecondition.html#cfn-kendra-datasource-documentattributecondition-conditiononvalue

# File 'kendra/cfn_data_source.rb', line 1895

def condition_on_value
  @condition_on_value
end

#operator ⇒ String (readonly)

The condition operator.

For example, you can use 'Contains' to partially match a string.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributecondition.html#cfn-kendra-datasource-documentattributecondition-operator

# File 'kendra/cfn_data_source.rb', line 1888

def operator
  @operator
end

Class Method Details

.jsii_properties ⇒ Object

# File 'kendra/cfn_data_source.rb', line 1897

def self.jsii_properties
  {
    :condition_document_attribute_key => "conditionDocumentAttributeKey",
    :operator => "operator",
    :condition_on_value => "conditionOnValue",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'kendra/cfn_data_source.rb', line 1905

def to_jsii
  result = {}
  result.merge!({
    "conditionDocumentAttributeKey" => @condition_document_attribute_key,
    "operator" => @operator,
    "conditionOnValue" => @condition_on_value,
  })
  result.compact
end