CfnRetrieverPropsMixin

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

Bases: Mixin

Adds a retriever to your Amazon Q Business application.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html
CloudformationResource:: AWS::QBusiness::Retriever
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_retriever_props_mixin = qbusiness_mixins.CfnRetrieverPropsMixin(qbusiness_mixins.CfnRetrieverMixinProps(
    application_id="applicationId",
    configuration=qbusiness_mixins.CfnRetrieverPropsMixin.RetrieverConfigurationProperty(
        kendra_index_configuration=qbusiness_mixins.CfnRetrieverPropsMixin.KendraIndexConfigurationProperty(
            index_id="indexId"
        ),
        native_index_configuration=qbusiness_mixins.CfnRetrieverPropsMixin.NativeIndexConfigurationProperty(
            index_id="indexId"
        )
    ),
    display_name="displayName",
    role_arn="roleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    type="type"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnRetrieverMixinProps, 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', 'configuration', 'displayName', 'roleArn', '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

KendraIndexConfigurationProperty

class CfnRetrieverPropsMixin.KendraIndexConfigurationProperty(*, index_id=None)

Bases: object

Stores an Amazon Kendra index as a retriever.

Parameters:: index_id (Optional[str]) – The identifier of the Amazon Kendra index.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-retriever-kendraindexconfiguration.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

kendra_index_configuration_property = qbusiness_mixins.CfnRetrieverPropsMixin.KendraIndexConfigurationProperty(
    index_id="indexId"
)

Attributes

index_id

The identifier of the Amazon Kendra index.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-retriever-kendraindexconfiguration.html#cfn-qbusiness-retriever-kendraindexconfiguration-indexid

NativeIndexConfigurationProperty

class CfnRetrieverPropsMixin.NativeIndexConfigurationProperty(*, index_id=None)

Bases: object

Configuration information for an Amazon Q Business index.

Parameters:: index_id (Optional[str]) – The identifier for the Amazon Q Business index.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-retriever-nativeindexconfiguration.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

native_index_configuration_property = qbusiness_mixins.CfnRetrieverPropsMixin.NativeIndexConfigurationProperty(
    index_id="indexId"
)

Attributes

index_id

The identifier for the Amazon Q Business index.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-retriever-nativeindexconfiguration.html#cfn-qbusiness-retriever-nativeindexconfiguration-indexid

RetrieverConfigurationProperty

class CfnRetrieverPropsMixin.RetrieverConfigurationProperty(*, kendra_index_configuration=None, native_index_configuration=None)

Bases: object

Provides information on how the retriever used for your Amazon Q Business application is configured.

Parameters:

kendra_index_configuration (Union[IResolvable, KendraIndexConfigurationProperty, Dict[str, Any], None]) – Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.
native_index_configuration (Union[IResolvable, NativeIndexConfigurationProperty, Dict[str, Any], None]) – Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-retriever-retrieverconfiguration.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

retriever_configuration_property = qbusiness_mixins.CfnRetrieverPropsMixin.RetrieverConfigurationProperty(
    kendra_index_configuration=qbusiness_mixins.CfnRetrieverPropsMixin.KendraIndexConfigurationProperty(
        index_id="indexId"
    ),
    native_index_configuration=qbusiness_mixins.CfnRetrieverPropsMixin.NativeIndexConfigurationProperty(
        index_id="indexId"
    )
)

Attributes

kendra_index_configuration

Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-retriever-retrieverconfiguration.html#cfn-qbusiness-retriever-retrieverconfiguration-kendraindexconfiguration

native_index_configuration

Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-retriever-retrieverconfiguration.html#cfn-qbusiness-retriever-retrieverconfiguration-nativeindexconfiguration