CfnDataSourceProps

class aws_cdk.aws_qbusiness.CfnDataSourceProps(*, application_id, configuration, display_name, index_id, description=None, document_enrichment_configuration=None, role_arn=None, sync_schedule=None, tags=None, vpc_configuration=None)

Bases: object

Properties for defining a CfnDataSource.

Parameters:

application_id (str) – The identifier of the Amazon Q Business application the data source will be attached to.
configuration (Any) – Use this property to specify a JSON or YAML schema with configuration properties specific to your data source connector to connect your data source repository to Amazon Q Business . You must use the JSON or YAML schema provided by Amazon Q . The following links have the configuration properties and schemas for AWS CloudFormation for the following connectors: - Amazon Simple Storage Service - Amazon Q Web Crawler Similarly, you can find configuration templates and properties for your specific data source using the following steps: - Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source connector of your choice. - Then, from that specific data source connector’s page, choose the topic containing Using AWS CloudFormation to find the schemas for your data source connector, including configuration parameter descriptions and examples.
display_name (str) – The name of the Amazon Q Business data source.
index_id (str) – The identifier of the index the data source is attached to.
description (Optional[str]) – A description for the data source connector.
document_enrichment_configuration (Union[IResolvable, DocumentEnrichmentConfigurationProperty, Dict[str, Any], None]) – Provides the configuration information for altering document metadata and content during the document ingestion process. For more information, see Custom document enrichment .
role_arn (Optional[str]) – The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
sync_schedule (Optional[str]) – Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don’t set a schedule, Amazon Q Business won’t periodically update the index. Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand. You can’t specify the Schedule parameter when the Type parameter is set to CUSTOM . If you do, you receive a ValidationException exception.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
vpc_configuration (Union[IResolvable, DataSourceVpcConfigurationProperty, Dict[str, Any], None]) – Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors .

See:

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

# configuration: Any

cfn_data_source_props = qbusiness.CfnDataSourceProps(
    application_id="applicationId",
    configuration=configuration,
    display_name="displayName",
    index_id="indexId",

    # the properties below are optional
    description="description",
    document_enrichment_configuration=qbusiness.CfnDataSource.DocumentEnrichmentConfigurationProperty(
        inline_configurations=[qbusiness.CfnDataSource.InlineDocumentEnrichmentConfigurationProperty(
            condition=qbusiness.CfnDataSource.DocumentAttributeConditionProperty(
                key="key",
                operator="operator",

                # the properties below are optional
                value=qbusiness.CfnDataSource.DocumentAttributeValueProperty(
                    date_value="dateValue",
                    long_value=123,
                    string_list_value=["stringListValue"],
                    string_value="stringValue"
                )
            ),
            document_content_operator="documentContentOperator",
            target=qbusiness.CfnDataSource.DocumentAttributeTargetProperty(
                key="key",

                # the properties below are optional
                attribute_value_operator="attributeValueOperator",
                value=qbusiness.CfnDataSource.DocumentAttributeValueProperty(
                    date_value="dateValue",
                    long_value=123,
                    string_list_value=["stringListValue"],
                    string_value="stringValue"
                )
            )
        )],
        post_extraction_hook_configuration=qbusiness.CfnDataSource.HookConfigurationProperty(
            invocation_condition=qbusiness.CfnDataSource.DocumentAttributeConditionProperty(
                key="key",
                operator="operator",

                # the properties below are optional
                value=qbusiness.CfnDataSource.DocumentAttributeValueProperty(
                    date_value="dateValue",
                    long_value=123,
                    string_list_value=["stringListValue"],
                    string_value="stringValue"
                )
            ),
            lambda_arn="lambdaArn",
            role_arn="roleArn",
            s3_bucket_name="s3BucketName"
        ),
        pre_extraction_hook_configuration=qbusiness.CfnDataSource.HookConfigurationProperty(
            invocation_condition=qbusiness.CfnDataSource.DocumentAttributeConditionProperty(
                key="key",
                operator="operator",

                # the properties below are optional
                value=qbusiness.CfnDataSource.DocumentAttributeValueProperty(
                    date_value="dateValue",
                    long_value=123,
                    string_list_value=["stringListValue"],
                    string_value="stringValue"
                )
            ),
            lambda_arn="lambdaArn",
            role_arn="roleArn",
            s3_bucket_name="s3BucketName"
        )
    ),
    role_arn="roleArn",
    sync_schedule="syncSchedule",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_configuration=qbusiness.CfnDataSource.DataSourceVpcConfigurationProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    )
)

Attributes

application_id

The identifier of the Amazon Q Business application the data source will be attached to.

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

configuration

Use this property to specify a JSON or YAML schema with configuration properties specific to your data source connector to connect your data source repository to Amazon Q Business .

You must use the JSON or YAML schema provided by Amazon Q .

The following links have the configuration properties and schemas for AWS CloudFormation for the following connectors:

Similarly, you can find configuration templates and properties for your specific data source using the following steps:

Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source connector of your choice.
Then, from that specific data source connector’s page, choose the topic containing Using AWS CloudFormation to find the schemas for your data source connector, including configuration parameter descriptions and examples.

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

description

A description for the data source connector.

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

display_name

The name of the Amazon Q Business data source.

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

document_enrichment_configuration

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Custom document enrichment .

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

index_id

The identifier of the index the data source is attached to.

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

role_arn

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

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

sync_schedule

Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index.

If you don’t set a schedule, Amazon Q Business won’t periodically update the index.

Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand. You can’t specify the Schedule parameter when the Type parameter is set to CUSTOM . If you do, you receive a ValidationException exception.

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

tags

A list of key-value pairs that identify or categorize the data source connector.

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

:: .

vpc_configuration

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.

For more information, see Using Amazon VPC with Amazon Q Business connectors .

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