interface CfnIndexProps

Language	Type name
.NET	`Amazon.CDK.aws_qbusiness.CfnIndexProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsqbusiness#CfnIndexProps`
Java	`software.amazon.awscdk.services.qbusiness.CfnIndexProps`
Python	`aws_cdk.aws_qbusiness.CfnIndexProps`
TypeScript	`aws-cdk-lib` » `aws_qbusiness` » `CfnIndexProps`

Properties for defining a CfnIndex.

Example

// 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 cfnIndexProps: qbusiness.CfnIndexProps = {
  applicationId: 'applicationId',
  displayName: 'displayName',

  // the properties below are optional
  capacityConfiguration: {
    units: 123,
  },
  description: 'description',
  documentAttributeConfigurations: [{
    name: 'name',
    search: 'search',
    type: 'type',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  type: 'type',
};

Properties

Name	Type	Description
applicationId	`string`	The identifier of the Amazon Q Business application using the index.
displayName	`string`	The name of the index.
capacityConfiguration?	`IResolvable` `\|` `IndexCapacityConfigurationProperty`	The capacity units you want to provision for your index.
description?	`string`	A description for the Amazon Q Business index.
documentAttributeConfigurations?	`IResolvable` `\|` `IResolvable` `\|` `DocumentAttributeConfigurationProperty[]`	Configuration information for document attributes.
tags?	`CfnTag[]`	A list of key-value pairs that identify or categorize the index.
type?	`string`	The index type that's suitable for your needs.

applicationId

Type: string

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

displayName

Type: string

The name of the index.

capacityConfiguration?

Type: IResolvable | IndexCapacityConfigurationProperty (optional)

The capacity units you want to provision for your index.

You can add and remove capacity to fit your usage needs.

description?

Type: string (optional)

A description for the Amazon Q Business index.

documentAttributeConfigurations?

Type: IResolvable | IResolvable | DocumentAttributeConfigurationProperty[] (optional)

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 .

tags?

Type: CfnTag[] (optional)

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

type?

Type: string (optional)

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 .