# DocumentAttributeConditionProperty

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

You use this with [`DocumentAttributeTarget`](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html) 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 Q Business can't 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 Q Business then will map your newly created metadata field to your index field.

- Source: Generated code
- Type last changed: v2.140.0 · 2 May 2024

## Example

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

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

## Properties

- `key`: string (required) — 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 Q Business currently doesn't support `_document_body` as an attribute key used for the condition.

- `operator`: string (required) — 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 Q Business currently does not support `_document_body` as an attribute key used for the condition.

- `value`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDataSource.DocumentAttributeValueProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_qbusiness.CfnDataSource.DocumentAttributeValueProperty.html) — The value of a document attribute.

  You can only provide one value for a document attribute.