import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; import * as enums from "../types/enums"; /** * Definition of AWS::QBusiness::Index Resource Type */ export declare class Index extends pulumi.CustomResource { /** * Get an existing Index resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, opts?: pulumi.CustomResourceOptions): Index; /** * Returns true if the given object is an instance of Index. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Index; /** * The identifier of the Amazon Q Business application using the index. */ readonly applicationId: pulumi.Output; /** * The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs. */ readonly capacityConfiguration: pulumi.Output; /** * The Unix timestamp when the index was created. */ readonly createdAt: pulumi.Output; /** * A description for the Amazon Q Business index. */ readonly description: pulumi.Output; /** * The name of the index. */ readonly displayName: pulumi.Output; /** * 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) . */ readonly documentAttributeConfigurations: pulumi.Output; /** * The Amazon Resource Name (ARN) of an Amazon Q Business index. */ readonly indexArn: pulumi.Output; /** * The identifier for the index. */ readonly indexId: pulumi.Output; readonly indexStatistics: pulumi.Output; /** * The current status of the index. When the status is `ACTIVE` , the index is ready. */ readonly status: pulumi.Output; /** * 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: _ . : / = + - @. */ readonly tags: pulumi.Output; /** * 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) . */ readonly type: pulumi.Output; /** * The Unix timestamp when the index was last updated. */ readonly updatedAt: pulumi.Output; /** * Create a Index resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: IndexArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a Index resource. */ export interface IndexArgs { /** * The identifier of the Amazon Q Business application using the index. */ applicationId: pulumi.Input; /** * The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs. */ capacityConfiguration?: pulumi.Input; /** * A description for the Amazon Q Business index. */ description?: pulumi.Input; /** * The name of the index. */ displayName: pulumi.Input; /** * 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) . */ documentAttributeConfigurations?: pulumi.Input[]>; /** * 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: _ . : / = + - @. */ tags?: pulumi.Input[]>; /** * 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) . */ type?: pulumi.Input; }