pulumi-aws-native-kotlin/com.pulumi.awsnative.qbusiness.kotlin/IndexArgs

IndexArgs

data class IndexArgs(val applicationId: Output<String>? = null, val capacityConfiguration: Output<IndexCapacityConfigurationArgs>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val documentAttributeConfigurations: Output<List<IndexDocumentAttributeConfigurationArgs>>? = null, val tags: Output<List<TagArgs>>? = null, val type: Output<IndexType>? = null) : ConvertibleToJava<IndexArgs>

Definition of AWS::QBusiness::Index Resource Type

Constructors

Link copied to clipboard
constructor(applicationId: Output<String>? = null, capacityConfiguration: Output<IndexCapacityConfigurationArgs>? = null, description: Output<String>? = null, displayName: Output<String>? = null, documentAttributeConfigurations: Output<List<IndexDocumentAttributeConfigurationArgs>>? = null, tags: Output<List<TagArgs>>? = null, type: Output<IndexType>? = null)

Properties

Link copied to clipboard
val applicationId: Output<String>? = null

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

Link copied to clipboard
val capacityConfiguration: Output<IndexCapacityConfigurationArgs>? = null

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

Link copied to clipboard
val description: Output<String>? = null

A description for the Amazon Q Business index.

Link copied to clipboard
val displayName: Output<String>? = null

The name of the index.

Link copied to clipboard
val documentAttributeConfigurations: Output<List<IndexDocumentAttributeConfigurationArgs>>? = null

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 .

Link copied to clipboard
val tags: Output<List<TagArgs>>? = null

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

Link copied to clipboard
val type: Output<IndexType>? = null

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 .

Functions

Link copied to clipboard
open override fun toJava(): IndexArgs