AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::QBusiness::Index

CfnIndex

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`](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BatchPutDocument.html) API or the [`CreateDataSource`](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html) API.

Import

import { CfnIndex } from 'aws-cdk-lib/aws-qbusiness';

Or use the module namespace:

import * as qbusiness from 'aws-cdk-lib/aws-qbusiness';
// qbusiness.CfnIndex

Properties

Configuration passed to the constructor as CfnIndexProps.

applicationIdRequired
string

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

displayNameRequired
string

The name of the index.

capacityConfigurationOptional
IResolvable | IndexCapacityConfigurationProperty

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

descriptionOptional
string

A description for the Amazon Q Business index.

documentAttributeConfigurationsOptional
IResolvable | IResolvable | DocumentAttributeConfigurationProperty[]

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](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes.html) .

tagsOptional
CfnTag[]

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: _ . : / = + -

typeOptional
string

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](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#index-tiers) .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::QBusiness::IndexView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-qbusiness
CFN TypeAWS::QBusiness::Index
Properties7

Related Constructs

Explore This Service

External Links