CfnRetrieverProps

class aws_cdk.aws_qbusiness.CfnRetrieverProps(*, application_id, configuration, display_name, type, role_arn=None, tags=None)

Bases: object

Properties for defining a CfnRetriever.

Parameters:

application_id (str) – The identifier of the Amazon Q Business application using the retriever.
configuration (Union[IResolvable, RetrieverConfigurationProperty, Dict[str, Any]]) – Provides information on how the retriever used for your Amazon Q Business application is configured.
display_name (str) – The name of your retriever.
type (str) – The type of your retriever.
role_arn (Optional[str]) – The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. 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-retriever.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_retriever_props = qbusiness.CfnRetrieverProps(
    application_id="applicationId",
    configuration=qbusiness.CfnRetriever.RetrieverConfigurationProperty(
        kendra_index_configuration=qbusiness.CfnRetriever.KendraIndexConfigurationProperty(
            index_id="indexId"
        ),
        native_index_configuration=qbusiness.CfnRetriever.NativeIndexConfigurationProperty(
            index_id="indexId"
        )
    ),
    display_name="displayName",
    type="type",

    # the properties below are optional
    role_arn="roleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

application_id

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

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

configuration

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

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

display_name

The name of your retriever.

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

role_arn

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

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

tags

A list of key-value pairs that identify or categorize the retriever.

You can also use tags to help control access to the retriever. 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-retriever.html#cfn-qbusiness-retriever-tags

:: .

type

The type of your retriever.

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