AWS::QBusiness::Index DocumentAttributeConfiguration - AWS CloudFormation
SyntaxProperties

AWS::QBusiness::Index DocumentAttributeConfiguration

Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.

For more information, see Understanding document attributes.

Syntax

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

JSON

{
  "Name" : String,
  "Search" : String,
  "Type" : String
}

YAML

  Name: String
  Search: String
  Type: String

Properties

Name

The name of the document attribute.

Required: No

Type: String

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

Minimum: 1

Maximum: 30

Update requires: No interruption

Information about whether the document attribute can be used by an end user to search for information on their web experience.

Required: No

Type: String

Allowed values: ENABLED | DISABLED

Update requires: No interruption

Type

The type of document attribute.

Required: No

Type: String

Allowed values: STRING | STRING_LIST | NUMBER | DATE

Update requires: No interruption