AWS::QBusiness::Index

Creates an Amazon Q Business index.

To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.

Syntax

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

JSON

{
  "Type" : "AWS::QBusiness::Index",
  "Properties" : {
      "ApplicationId" : String,
      "CapacityConfiguration" : IndexCapacityConfiguration,
      "Description" : String,
      "DisplayName" : String,
      "DocumentAttributeConfigurations" : [ DocumentAttributeConfiguration, ... ],
      "Tags" : [ Tag, ... ],
      "Type" : String
    }
}

YAML

Type: AWS::QBusiness::Index
Properties:
  ApplicationId: String
  CapacityConfiguration: 
    IndexCapacityConfiguration
  Description: String
  DisplayName: String
  DocumentAttributeConfigurations: 
    - DocumentAttributeConfiguration
  Tags: 
    - Tag
  Type: String

Properties

ApplicationId

The identifier of the Amazon Q Business application using the index.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$

Minimum: 36

Maximum: 36

Update requires: Replacement

CapacityConfiguration

The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

Required: No

Type: IndexCapacityConfiguration

Update requires: No interruption

Description

A description for the Amazon Q Business index.

Required: No

Type: String

Pattern: ^[\s\S]*$

Minimum: 0

Maximum: 1000

Update requires: No interruption

DisplayName

The name of the index.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 1000

Update requires: No interruption

DocumentAttributeConfigurations

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.

Required: No

Type: Array of DocumentAttributeConfiguration

Minimum: 1

Maximum: 500

Update requires: No interruption

Tags

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

Type

The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers.

Required: No

Type: String

Allowed values: ENTERPRISE | STARTER

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the application ID and index ID. For example:

{"Ref": "ApplicationId|IndexId"}

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreatedAt

The Unix timestamp when the index was created.

IndexArn

The Amazon Resource Name (ARN) of an Amazon Q Business index.

IndexId

The identifier for the index.

Status

The current status of the index. When the status is ACTIVE, the index is ready.

UpdatedAt

The Unix timestamp when the index was last updated.