aws-cdk-lib.aws_kendra.CfnDataSource.DocumentAttributeConditionProperty

DocumentAttributeConditionProperty Struct

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.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
const documentAttributeConditionProperty: kendra.CfnDataSource.DocumentAttributeConditionProperty = {
  conditionDocumentAttributeKey: 'conditionDocumentAttributeKey',
  operator: 'operator',

  // the properties below are optional
  conditionOnValue: {
    dateValue: 'dateValue',
    longValue: 123,
    stringListValue: ['stringListValue'],
    stringValue: 'stringValue',
  },
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_kendra as kendra

document_attribute_condition_property = kendra.CfnDataSource.DocumentAttributeConditionProperty(
    condition_document_attribute_key="conditionDocumentAttributeKey",
    operator="operator",

    # the properties below are optional
    condition_on_value=kendra.CfnDataSource.DocumentAttributeValueProperty(
        date_value="dateValue",
        long_value=123,
        string_list_value=["stringListValue"],
        string_value="stringValue"
    )
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.kendra.*;

DocumentAttributeConditionProperty documentAttributeConditionProperty = DocumentAttributeConditionProperty.builder()
        .conditionDocumentAttributeKey("conditionDocumentAttributeKey")
        .operator("operator")

        // the properties below are optional
        .conditionOnValue(DocumentAttributeValueProperty.builder()
                .dateValue("dateValue")
                .longValue(123)
                .stringListValue(List.of("stringListValue"))
                .stringValue("stringValue")
                .build())
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;

var documentAttributeConditionProperty = new DocumentAttributeConditionProperty {
    ConditionDocumentAttributeKey = "conditionDocumentAttributeKey",
    Operator = "operator",

    // the properties below are optional
    ConditionOnValue = new DocumentAttributeValueProperty {
        DateValue = "dateValue",
        LongValue = 123,
        StringListValue = new [] { "stringListValue" },
        StringValue = "stringValue"
    }
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

documentAttributeConditionProperty := &DocumentAttributeConditionProperty{
	ConditionDocumentAttributeKey: jsii.String("conditionDocumentAttributeKey"),
	Operator: jsii.String("operator"),

	// the properties below are optional
	ConditionOnValue: &DocumentAttributeValueProperty{
		DateValue: jsii.String("dateValue"),
		LongValue: jsii.Number(123),
		StringListValue: []*string{
			jsii.String("stringListValue"),
		},
		StringValue: jsii.String("stringValue"),
	},
}

Properties

conditionDocumentAttributeKeystringcondition_document_attribute_keystrconditionDocumentAttributeKeyStringConditionDocumentAttributeKeystringConditionDocumentAttributeKey*stringrequired#

The identifier of the document attribute used for the condition.

notes

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.

conditionOnValue?optionalIResolvable | CfnDataSource.DocumentAttributeValuePropertycondition_on_value?optionaltyping.Union[IResolvable, DocumentAttributeValueProperty]conditionOnValue?optionalIResolvableConditionOnValue?optionalIResolvableConditionOnValue?optionalinterface{}#

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.

operatorstringoperatorstroperatorStringOperatorstringOperator*stringrequired#

The condition operator.

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