AWS::QBusiness::DataSource DocumentAttributeCondition - AWS CloudFormation
SyntaxProperties

AWS::QBusiness::DataSource DocumentAttributeCondition

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. 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 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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Key" : String,
  "Operator" : String,
  "Value" : DocumentAttributeValue
}

YAML

  Key: String
  Operator: String
  Value: 
    DocumentAttributeValue

Properties

Key

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.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_][a-zA-Z0-9_-]*$

Minimum: 1

Maximum: 200

Update requires: No interruption

Operator

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.

Required: Yes

Type: String

Allowed values: GREATER_THAN | GREATER_THAN_OR_EQUALS | LESS_THAN | LESS_THAN_OR_EQUALS | EQUALS | NOT_EQUALS | CONTAINS | NOT_CONTAINS | EXISTS | NOT_EXISTS | BEGINS_WITH

Update requires: No interruption

Value

The value of a document attribute. You can only provide one value for a document attribute.

Required: No

Type: DocumentAttributeValue

Update requires: No interruption