CfnIndexProps

class aws_cdk.aws_qbusiness.CfnIndexProps(*, application_id, display_name, capacity_configuration=None, description=None, document_attribute_configurations=None, tags=None, type=None)

Bases: object

Properties for defining a CfnIndex.

Parameters:

application_id (str) – The identifier of the Amazon Q Business application using the index.
display_name (str) – The name of the index.
capacity_configuration (Union[IResolvable, IndexCapacityConfigurationProperty, Dict[str, Any], None]) – The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
description (Optional[str]) – A description for the Amazon Q Business index.
document_attribute_configurations (Union[IResolvable, Sequence[Union[IResolvable, DocumentAttributeConfigurationProperty, Dict[str, Any]]], None]) – 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 (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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 (Optional[str]) – 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:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_qbusiness as qbusiness

cfn_index_props = qbusiness.CfnIndexProps(
    application_id="applicationId",
    display_name="displayName",

    # the properties below are optional
    capacity_configuration=qbusiness.CfnIndex.IndexCapacityConfigurationProperty(
        units=123
    ),
    description="description",
    document_attribute_configurations=[qbusiness.CfnIndex.DocumentAttributeConfigurationProperty(
        name="name",
        search="search",
        type="type"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    type="type"
)

Attributes

application_id

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

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

capacity_configuration

The capacity units you want to provision for your index.

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

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

description

A description for the Amazon Q Business index.

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

display_name

The name of the index.

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

document_attribute_configurations

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-documentattributeconfigurations

tags

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-tags

:: .

type

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-type