CfnIndexPropsMixin

class aws_cdk.mixins_preview.aws_qbusiness.mixins.CfnIndexPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates an Amazon Q Business index.

To determine if index creation has completed, check the Status field returned from a call to DescribeIndex . The Status field is set to ACTIVE when the index is ready to use.

Once the index is active, you can index your documents using the `BatchPutDocument <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BatchPutDocument.html>`_ API or the `CreateDataSource <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html>`_ API.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html
CloudformationResource:: AWS::QBusiness::Index
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_qbusiness import mixins as qbusiness_mixins

cfn_index_props_mixin = qbusiness_mixins.CfnIndexPropsMixin(qbusiness_mixins.CfnIndexMixinProps(
    application_id="applicationId",
    capacity_configuration=qbusiness_mixins.CfnIndexPropsMixin.IndexCapacityConfigurationProperty(
        units=123
    ),
    description="description",
    display_name="displayName",
    document_attribute_configurations=[qbusiness_mixins.CfnIndexPropsMixin.DocumentAttributeConfigurationProperty(
        name="name",
        search="search",
        type="type"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    type="type"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::QBusiness::Index.

Parameters:

props (Union[CfnIndexMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['applicationId', 'capacityConfiguration', 'description', 'displayName', 'documentAttributeConfigurations', 'tags', 'type']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

DocumentAttributeConfigurationProperty

class CfnIndexPropsMixin.DocumentAttributeConfigurationProperty(*, name=None, search=None, type=None)

Bases: object

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 .

Parameters:

name (Optional[str]) – The name of the document attribute.
search (Optional[str]) – Information about whether the document attribute can be used by an end user to search for information on their web experience.
type (Optional[str]) – The type of document attribute.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-documentattributeconfiguration.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.mixins_preview.aws_qbusiness import mixins as qbusiness_mixins

document_attribute_configuration_property = qbusiness_mixins.CfnIndexPropsMixin.DocumentAttributeConfigurationProperty(
    name="name",
    search="search",
    type="type"
)

Attributes

name

The name of the document attribute.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-documentattributeconfiguration.html#cfn-qbusiness-index-documentattributeconfiguration-name

search

Information about whether the document attribute can be used by an end user to search for information on their web experience.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-documentattributeconfiguration.html#cfn-qbusiness-index-documentattributeconfiguration-search

type

The type of document attribute.

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

IndexCapacityConfigurationProperty

class CfnIndexPropsMixin.IndexCapacityConfigurationProperty(*, units=None)

Bases: object

Provides information about index capacity configuration.

Parameters:: units (Union[int, float, None]) – The number of storage units configured for an Amazon Q Business index.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-indexcapacityconfiguration.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.mixins_preview.aws_qbusiness import mixins as qbusiness_mixins

index_capacity_configuration_property = qbusiness_mixins.CfnIndexPropsMixin.IndexCapacityConfigurationProperty(
    units=123
)

Attributes

units

The number of storage units configured for an Amazon Q Business index.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-indexcapacityconfiguration.html#cfn-qbusiness-index-indexcapacityconfiguration-units

IndexStatisticsProperty

class CfnIndexPropsMixin.IndexStatisticsProperty(*, text_document_statistics=None)

Bases: object

Provides information about the number of documents in an index.

Parameters:: text_document_statistics (Union[IResolvable, TextDocumentStatisticsProperty, Dict[str, Any], None]) – The number of documents indexed.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-indexstatistics.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.mixins_preview.aws_qbusiness import mixins as qbusiness_mixins

index_statistics_property = qbusiness_mixins.CfnIndexPropsMixin.IndexStatisticsProperty(
    text_document_statistics=qbusiness_mixins.CfnIndexPropsMixin.TextDocumentStatisticsProperty(
        indexed_text_bytes=123,
        indexed_text_document_count=123
    )
)

Attributes

text_document_statistics

The number of documents indexed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-indexstatistics.html#cfn-qbusiness-index-indexstatistics-textdocumentstatistics

TextDocumentStatisticsProperty

class CfnIndexPropsMixin.TextDocumentStatisticsProperty(*, indexed_text_bytes=None, indexed_text_document_count=None)

Bases: object

Provides information about text documents in an index.

Parameters:

indexed_text_bytes (Union[int, float, None]) – The total size, in bytes, of the indexed documents.
indexed_text_document_count (Union[int, float, None]) – The number of text documents indexed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-textdocumentstatistics.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.mixins_preview.aws_qbusiness import mixins as qbusiness_mixins

text_document_statistics_property = qbusiness_mixins.CfnIndexPropsMixin.TextDocumentStatisticsProperty(
    indexed_text_bytes=123,
    indexed_text_document_count=123
)

Attributes

indexed_text_bytes

The total size, in bytes, of the indexed documents.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-textdocumentstatistics.html#cfn-qbusiness-index-textdocumentstatistics-indexedtextbytes

indexed_text_document_count

The number of text documents indexed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-textdocumentstatistics.html#cfn-qbusiness-index-textdocumentstatistics-indexedtextdocumentcount