interface DocumentAttributeConditionProperty

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.Kendra.Mixins.CfnDataSourcePropsMixin.DocumentAttributeConditionProperty`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awskendra/mixins#CfnDataSourcePropsMixin_DocumentAttributeConditionProperty`
Java	`software.amazon.awscdk.mixins.preview.services.kendra.mixins.CfnDataSourcePropsMixin.DocumentAttributeConditionProperty`
Python	`aws_cdk.mixins_preview.aws_kendra.mixins.CfnDataSourcePropsMixin.DocumentAttributeConditionProperty`
TypeScript	`@aws-cdk/mixins-preview` » `aws_kendra` » `mixins` » `CfnDataSourcePropsMixin` » `DocumentAttributeConditionProperty`

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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as kendra_mixins } from '@aws-cdk/mixins-preview/aws-kendra';
const documentAttributeConditionProperty: kendra_mixins.CfnDataSourcePropsMixin.DocumentAttributeConditionProperty = {
  conditionDocumentAttributeKey: 'conditionDocumentAttributeKey',
  conditionOnValue: {
    dateValue: 'dateValue',
    longValue: 123,
    stringListValue: ['stringListValue'],
    stringValue: 'stringValue',
  },
  operator: 'operator',
};

Properties

Name	Type	Description
conditionDocumentAttributeKey?	`string`	The identifier of the document attribute used for the condition.
conditionOnValue?	`IResolvable` `\|` `DocumentAttributeValueProperty`	The value used by the operator.
operator?	`string`	The condition operator.

conditionDocumentAttributeKey?

Type: string (optional)

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.

conditionOnValue?

Type: IResolvable | DocumentAttributeValueProperty (optional)

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.

operator?

Type: string (optional)

The condition operator.

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

AWS CDK