interface CfnIndexMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.QBusiness.Mixins.CfnIndexMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsqbusiness/mixins#CfnIndexMixinProps
Java	software.amazon.awscdk.mixins.preview.services.qbusiness.mixins.CfnIndexMixinProps
Python	aws_cdk.mixins_preview.aws_qbusiness.mixins.CfnIndexMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_qbusiness » mixins » CfnIndexMixinProps

Properties for CfnIndexPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as qbusiness_mixins } from '@aws-cdk/mixins-preview/aws-qbusiness';
const cfnIndexMixinProps: qbusiness_mixins.CfnIndexMixinProps = {
  applicationId: 'applicationId',
  capacityConfiguration: {
    units: 123,
  },
  description: 'description',
  displayName: 'displayName',
  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.
capacityConfiguration?	IResolvable | IndexCapacityConfigurationProperty	The capacity units you want to provision for your index.
description?	string	A description for the Amazon Q Business index.
displayName?	string	The name of the 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 (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-applicationid

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-capacityconfiguration

---

description?

Type: string (optional)

A description for the Amazon Q Business index.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-description

---

displayName?

Type: string (optional)

The name of the index.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-displayname

---

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-documentattributeconfigurations

---

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-tags

---

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-type