CfnDataSourcePropsMixin

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

Bases: Mixin

Creates a data source connector for an Amazon Q Business application.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

See:

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

CloudformationResource:

AWS::QBusiness::DataSource

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# 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

# configuration: Any

cfn_data_source_props_mixin = qbusiness_mixins.CfnDataSourcePropsMixin(qbusiness_mixins.CfnDataSourceMixinProps(
    application_id="applicationId",
    configuration=configuration,
    description="description",
    display_name="displayName",
    document_enrichment_configuration=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentEnrichmentConfigurationProperty(
        inline_configurations=[qbusiness_mixins.CfnDataSourcePropsMixin.InlineDocumentEnrichmentConfigurationProperty(
            condition=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeConditionProperty(
                key="key",
                operator="operator",
                value=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeValueProperty(
                    date_value="dateValue",
                    long_value=123,
                    string_list_value=["stringListValue"],
                    string_value="stringValue"
                )
            ),
            document_content_operator="documentContentOperator",
            target=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeTargetProperty(
                attribute_value_operator="attributeValueOperator",
                key="key",
                value=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeValueProperty(
                    date_value="dateValue",
                    long_value=123,
                    string_list_value=["stringListValue"],
                    string_value="stringValue"
                )
            )
        )],
        post_extraction_hook_configuration=qbusiness_mixins.CfnDataSourcePropsMixin.HookConfigurationProperty(
            invocation_condition=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeConditionProperty(
                key="key",
                operator="operator",
                value=qbusiness_mixins.CfnDataSourcePropsMixin.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_mixins.CfnDataSourcePropsMixin.HookConfigurationProperty(
            invocation_condition=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeConditionProperty(
                key="key",
                operator="operator",
                value=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeValueProperty(
                    date_value="dateValue",
                    long_value=123,
                    string_list_value=["stringListValue"],
                    string_value="stringValue"
                )
            ),
            lambda_arn="lambdaArn",
            role_arn="roleArn",
            s3_bucket_name="s3BucketName"
        )
    ),
    index_id="indexId",
    media_extraction_configuration=qbusiness_mixins.CfnDataSourcePropsMixin.MediaExtractionConfigurationProperty(
        audio_extraction_configuration=qbusiness_mixins.CfnDataSourcePropsMixin.AudioExtractionConfigurationProperty(
            audio_extraction_status="audioExtractionStatus"
        ),
        image_extraction_configuration=qbusiness_mixins.CfnDataSourcePropsMixin.ImageExtractionConfigurationProperty(
            image_extraction_status="imageExtractionStatus"
        ),
        video_extraction_configuration=qbusiness_mixins.CfnDataSourcePropsMixin.VideoExtractionConfigurationProperty(
            video_extraction_status="videoExtractionStatus"
        )
    ),
    role_arn="roleArn",
    sync_schedule="syncSchedule",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_configuration=qbusiness_mixins.CfnDataSourcePropsMixin.DataSourceVpcConfigurationProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

  • props (Union[CfnDataSourceMixinProps, 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', 'description', 'displayName', 'documentEnrichmentConfiguration', 'indexId', 'mediaExtractionConfiguration', 'roleArn', 'syncSchedule', 'tags', 'vpcConfiguration']

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

AudioExtractionConfigurationProperty

class CfnDataSourcePropsMixin.AudioExtractionConfigurationProperty(*, audio_extraction_status=None)

Bases: object

Configuration settings for audio content extraction and processing.

Parameters:

audio_extraction_status (Optional[str]) – The status of audio extraction (ENABLED or DISABLED) for processing audio content from files.

See:

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

audio_extraction_configuration_property = qbusiness_mixins.CfnDataSourcePropsMixin.AudioExtractionConfigurationProperty(
    audio_extraction_status="audioExtractionStatus"
)

Attributes

audio_extraction_status

The status of audio extraction (ENABLED or DISABLED) for processing audio content from files.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-audioextractionconfiguration.html#cfn-qbusiness-datasource-audioextractionconfiguration-audioextractionstatus

DataSourceVpcConfigurationProperty

class CfnDataSourcePropsMixin.DataSourceVpcConfigurationProperty(*, security_group_ids=None, subnet_ids=None)

Bases: object

Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).

Parameters:

  • security_group_ids (Optional[Sequence[str]]) – A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.

  • subnet_ids (Optional[Sequence[str]]) – A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

See:

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

data_source_vpc_configuration_property = qbusiness_mixins.CfnDataSourcePropsMixin.DataSourceVpcConfigurationProperty(
    security_group_ids=["securityGroupIds"],
    subnet_ids=["subnetIds"]
)

Attributes

security_group_ids

A list of identifiers of security groups within your Amazon VPC.

The security groups should enable Amazon Q Business to connect to the data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-datasourcevpcconfiguration.html#cfn-qbusiness-datasource-datasourcevpcconfiguration-securitygroupids

subnet_ids

A list of identifiers for subnets within your Amazon VPC.

The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-datasourcevpcconfiguration.html#cfn-qbusiness-datasource-datasourcevpcconfiguration-subnetids

DocumentAttributeConditionProperty

class CfnDataSourcePropsMixin.DocumentAttributeConditionProperty(*, key=None, operator=None, value=None)

Bases: object

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business.

You use this with `DocumentAttributeTarget <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html>`_ to apply the condition.

For example, you can create the ‘Department’ target field and have it prefill department names associated with the documents based on information in the ‘Source_URI’ field. Set the condition that if the ‘Source_URI’ field contains ‘financial’ in its URI value, then prefill the target field ‘Department’ with the target value ‘Finance’ for the document.

Amazon Q Business can’t create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget . Amazon Q Business then will map your newly created metadata field to your index field.

Parameters:

  • key (Optional[str]) – The identifier of the document attribute used for the condition. For example, ‘Source_URI’ could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently doesn’t support _document_body as an attribute key used for the condition.

  • operator (Optional[str]) – The identifier of the document attribute used for the condition. For example, ‘Source_URI’ could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently does not support _document_body as an attribute key used for the condition.

  • value (Union[IResolvable, DocumentAttributeValueProperty, Dict[str, Any], None]) – The value of a document attribute. You can only provide one value for a document attribute.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributecondition.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_condition_property = qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeConditionProperty(
    key="key",
    operator="operator",
    value=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeValueProperty(
        date_value="dateValue",
        long_value=123,
        string_list_value=["stringListValue"],
        string_value="stringValue"
    )
)

Attributes

key

The identifier of the document attribute used for the condition.

For example, ‘Source_URI’ could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Q Business currently doesn’t support _document_body as an attribute key used for the condition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributecondition.html#cfn-qbusiness-datasource-documentattributecondition-key

operator

The identifier of the document attribute used for the condition.

For example, ‘Source_URI’ could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Q Business currently does not support _document_body as an attribute key used for the condition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributecondition.html#cfn-qbusiness-datasource-documentattributecondition-operator

value

The value of a document attribute.

You can only provide one value for a document attribute.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributecondition.html#cfn-qbusiness-datasource-documentattributecondition-value

DocumentAttributeTargetProperty

class CfnDataSourcePropsMixin.DocumentAttributeTargetProperty(*, attribute_value_operator=None, key=None, value=None)

Bases: object

The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.

For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called ‘Customer_ID’ by setting the target key as ‘Customer_ID’ and the deletion flag to TRUE . This removes all customer ID values in the field ‘Customer_ID’. This would scrub personally identifiable information from each document’s metadata.

Amazon Q Business can’t create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using `DocumentAttributeTarget <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html>`_ . Amazon Q Business will then map your newly created document attribute to your index field.

You can also use this with `DocumentAttributeCondition <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html>`_ .

Parameters:

  • attribute_value_operator (Optional[str]) – TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE .

  • key (Optional[str]) – The identifier of the target document attribute or metadata field. For example, ‘Department’ could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

  • value (Union[IResolvable, DocumentAttributeValueProperty, Dict[str, Any], None]) – The value of a document attribute. You can only provide one value for a document attribute.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributetarget.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_target_property = qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeTargetProperty(
    attribute_value_operator="attributeValueOperator",
    key="key",
    value=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeValueProperty(
        date_value="dateValue",
        long_value=123,
        string_list_value=["stringListValue"],
        string_value="stringValue"
    )
)

Attributes

attribute_value_operator

TRUE to delete the existing target value for your specified target attribute key.

You cannot create a target value and set this to TRUE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributetarget.html#cfn-qbusiness-datasource-documentattributetarget-attributevalueoperator

key

The identifier of the target document attribute or metadata field.

For example, ‘Department’ could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributetarget.html#cfn-qbusiness-datasource-documentattributetarget-key

value

The value of a document attribute.

You can only provide one value for a document attribute.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributetarget.html#cfn-qbusiness-datasource-documentattributetarget-value

DocumentAttributeValueProperty

class CfnDataSourcePropsMixin.DocumentAttributeValueProperty(*, date_value=None, long_value=None, string_list_value=None, string_value=None)

Bases: object

The value of a document attribute.

You can only provide one value for a document attribute.

Parameters:

  • date_value (Optional[str]) – A date expressed as an ISO 8601 string. It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

  • long_value (Union[int, float, None]) – A long integer value.

  • string_list_value (Optional[Sequence[str]]) – A list of strings.

  • string_value (Optional[str]) – A string.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributevalue.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_value_property = qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeValueProperty(
    date_value="dateValue",
    long_value=123,
    string_list_value=["stringListValue"],
    string_value="stringValue"
)

Attributes

date_value

A date expressed as an ISO 8601 string.

It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributevalue.html#cfn-qbusiness-datasource-documentattributevalue-datevalue

long_value

A long integer value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributevalue.html#cfn-qbusiness-datasource-documentattributevalue-longvalue

string_list_value

A list of strings.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributevalue.html#cfn-qbusiness-datasource-documentattributevalue-stringlistvalue

string_value

A string.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributevalue.html#cfn-qbusiness-datasource-documentattributevalue-stringvalue

DocumentEnrichmentConfigurationProperty

class CfnDataSourcePropsMixin.DocumentEnrichmentConfigurationProperty(*, inline_configurations=None, post_extraction_hook_configuration=None, pre_extraction_hook_configuration=None)

Bases: object

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

For more information, see Custom document enrichment .

Parameters:

  • inline_configurations (Union[IResolvable, Sequence[Union[IResolvable, InlineDocumentEnrichmentConfigurationProperty, Dict[str, Any]]], None]) – Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.

  • post_extraction_hook_configuration (Union[IResolvable, HookConfigurationProperty, Dict[str, Any], None]) – Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Using Lambda functions .

  • pre_extraction_hook_configuration (Union[IResolvable, HookConfigurationProperty, Dict[str, Any], None]) –

    Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Using Lambda functions .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentenrichmentconfiguration.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_enrichment_configuration_property = qbusiness_mixins.CfnDataSourcePropsMixin.DocumentEnrichmentConfigurationProperty(
    inline_configurations=[qbusiness_mixins.CfnDataSourcePropsMixin.InlineDocumentEnrichmentConfigurationProperty(
        condition=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeConditionProperty(
            key="key",
            operator="operator",
            value=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeValueProperty(
                date_value="dateValue",
                long_value=123,
                string_list_value=["stringListValue"],
                string_value="stringValue"
            )
        ),
        document_content_operator="documentContentOperator",
        target=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeTargetProperty(
            attribute_value_operator="attributeValueOperator",
            key="key",
            value=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeValueProperty(
                date_value="dateValue",
                long_value=123,
                string_list_value=["stringListValue"],
                string_value="stringValue"
            )
        )
    )],
    post_extraction_hook_configuration=qbusiness_mixins.CfnDataSourcePropsMixin.HookConfigurationProperty(
        invocation_condition=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeConditionProperty(
            key="key",
            operator="operator",
            value=qbusiness_mixins.CfnDataSourcePropsMixin.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_mixins.CfnDataSourcePropsMixin.HookConfigurationProperty(
        invocation_condition=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeConditionProperty(
            key="key",
            operator="operator",
            value=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeValueProperty(
                date_value="dateValue",
                long_value=123,
                string_list_value=["stringListValue"],
                string_value="stringValue"
            )
        ),
        lambda_arn="lambdaArn",
        role_arn="roleArn",
        s3_bucket_name="s3BucketName"
    )
)

Attributes

inline_configurations

Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.

See:

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

post_extraction_hook_configuration

Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted.

You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Using Lambda functions .

See:

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

pre_extraction_hook_configuration

Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text.

You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Using Lambda functions .

See:

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

HookConfigurationProperty

class CfnDataSourcePropsMixin.HookConfigurationProperty(*, invocation_condition=None, lambda_arn=None, role_arn=None, s3_bucket_name=None)

Bases: object

Provides the configuration information for invoking a Lambda function in AWS Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.

You can configure your Lambda function using the PreExtractionHookConfiguration parameter if you want to apply advanced alterations on the original or raw documents.

If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration .

You can only invoke one Lambda function. However, this function can invoke other functions it requires.

For more information, see Custom document enrichment .

Parameters:

  • invocation_condition (Union[IResolvable, DocumentAttributeConditionProperty, Dict[str, Any], None]) – The condition used for when a Lambda function should be invoked. For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

  • lambda_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Lambda function during ingestion. For more information, see Using Lambda functions for Amazon Q Business document enrichment .

  • role_arn (Optional[str]) – The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.

  • s3_bucket_name (Optional[str]) – Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions .

See:

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

hook_configuration_property = qbusiness_mixins.CfnDataSourcePropsMixin.HookConfigurationProperty(
    invocation_condition=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeConditionProperty(
        key="key",
        operator="operator",
        value=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeValueProperty(
            date_value="dateValue",
            long_value=123,
            string_list_value=["stringListValue"],
            string_value="stringValue"
        )
    ),
    lambda_arn="lambdaArn",
    role_arn="roleArn",
    s3_bucket_name="s3BucketName"
)

Attributes

invocation_condition

The condition used for when a Lambda function should be invoked.

For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-hookconfiguration.html#cfn-qbusiness-datasource-hookconfiguration-invocationcondition

lambda_arn

The Amazon Resource Name (ARN) of the Lambda function during ingestion.

For more information, see Using Lambda functions for Amazon Q Business document enrichment .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-hookconfiguration.html#cfn-qbusiness-datasource-hookconfiguration-lambdaarn

role_arn

The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.

See:

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

s3_bucket_name

Stores the original, raw documents or the structured, parsed documents before and after altering them.

For more information, see Data contracts for Lambda functions .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-hookconfiguration.html#cfn-qbusiness-datasource-hookconfiguration-s3bucketname

ImageExtractionConfigurationProperty

class CfnDataSourcePropsMixin.ImageExtractionConfigurationProperty(*, image_extraction_status=None)

Bases: object

The configuration for extracting semantic meaning from images in documents.

For more information, see Extracting semantic meaning from images and visuals .

Parameters:

image_extraction_status (Optional[str]) – Specify whether to extract semantic meaning from images and visuals from documents.

See:

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

image_extraction_configuration_property = qbusiness_mixins.CfnDataSourcePropsMixin.ImageExtractionConfigurationProperty(
    image_extraction_status="imageExtractionStatus"
)

Attributes

image_extraction_status

Specify whether to extract semantic meaning from images and visuals from documents.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-imageextractionconfiguration.html#cfn-qbusiness-datasource-imageextractionconfiguration-imageextractionstatus

InlineDocumentEnrichmentConfigurationProperty

class CfnDataSourcePropsMixin.InlineDocumentEnrichmentConfigurationProperty(*, condition=None, document_content_operator=None, target=None)

Bases: object

Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business.

To apply advanced logic, to go beyond what you can do with basic logic, see `HookConfiguration <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_HookConfiguration.html>`_ .

For more information, see Custom document enrichment .

Parameters:

  • condition (Union[IResolvable, DocumentAttributeConditionProperty, Dict[str, Any], None]) – Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business .

  • document_content_operator (Optional[str]) – TRUE to delete content if the condition used for the target attribute is met.

  • target (Union[IResolvable, DocumentAttributeTargetProperty, Dict[str, Any], None]) – Configuration of the target document attribute or metadata field when ingesting documents into Amazon Q Business . You can also include a value.

See:

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

inline_document_enrichment_configuration_property = qbusiness_mixins.CfnDataSourcePropsMixin.InlineDocumentEnrichmentConfigurationProperty(
    condition=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeConditionProperty(
        key="key",
        operator="operator",
        value=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeValueProperty(
            date_value="dateValue",
            long_value=123,
            string_list_value=["stringListValue"],
            string_value="stringValue"
        )
    ),
    document_content_operator="documentContentOperator",
    target=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeTargetProperty(
        attribute_value_operator="attributeValueOperator",
        key="key",
        value=qbusiness_mixins.CfnDataSourcePropsMixin.DocumentAttributeValueProperty(
            date_value="dateValue",
            long_value=123,
            string_list_value=["stringListValue"],
            string_value="stringValue"
        )
    )
)

Attributes

condition

Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-inlinedocumentenrichmentconfiguration.html#cfn-qbusiness-datasource-inlinedocumentenrichmentconfiguration-condition

document_content_operator

TRUE to delete content if the condition used for the target attribute is met.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-inlinedocumentenrichmentconfiguration.html#cfn-qbusiness-datasource-inlinedocumentenrichmentconfiguration-documentcontentoperator

target

Configuration of the target document attribute or metadata field when ingesting documents into Amazon Q Business .

You can also include a value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-inlinedocumentenrichmentconfiguration.html#cfn-qbusiness-datasource-inlinedocumentenrichmentconfiguration-target

MediaExtractionConfigurationProperty

class CfnDataSourcePropsMixin.MediaExtractionConfigurationProperty(*, audio_extraction_configuration=None, image_extraction_configuration=None, video_extraction_configuration=None)

Bases: object

The configuration for extracting information from media in documents.

Parameters:
See:

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

media_extraction_configuration_property = qbusiness_mixins.CfnDataSourcePropsMixin.MediaExtractionConfigurationProperty(
    audio_extraction_configuration=qbusiness_mixins.CfnDataSourcePropsMixin.AudioExtractionConfigurationProperty(
        audio_extraction_status="audioExtractionStatus"
    ),
    image_extraction_configuration=qbusiness_mixins.CfnDataSourcePropsMixin.ImageExtractionConfigurationProperty(
        image_extraction_status="imageExtractionStatus"
    ),
    video_extraction_configuration=qbusiness_mixins.CfnDataSourcePropsMixin.VideoExtractionConfigurationProperty(
        video_extraction_status="videoExtractionStatus"
    )
)

Attributes

audio_extraction_configuration

Configuration settings for extracting and processing audio content from media files.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-mediaextractionconfiguration.html#cfn-qbusiness-datasource-mediaextractionconfiguration-audioextractionconfiguration

image_extraction_configuration

The configuration for extracting semantic meaning from images in documents.

For more information, see Extracting semantic meaning from images and visuals .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-mediaextractionconfiguration.html#cfn-qbusiness-datasource-mediaextractionconfiguration-imageextractionconfiguration

video_extraction_configuration

Configuration settings for extracting and processing video content from media files.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-mediaextractionconfiguration.html#cfn-qbusiness-datasource-mediaextractionconfiguration-videoextractionconfiguration

VideoExtractionConfigurationProperty

class CfnDataSourcePropsMixin.VideoExtractionConfigurationProperty(*, video_extraction_status=None)

Bases: object

Configuration settings for video content extraction and processing.

Parameters:

video_extraction_status (Optional[str]) – The status of video extraction (ENABLED or DISABLED) for processing video content from files.

See:

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

video_extraction_configuration_property = qbusiness_mixins.CfnDataSourcePropsMixin.VideoExtractionConfigurationProperty(
    video_extraction_status="videoExtractionStatus"
)

Attributes

video_extraction_status

The status of video extraction (ENABLED or DISABLED) for processing video content from files.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-videoextractionconfiguration.html#cfn-qbusiness-datasource-videoextractionconfiguration-videoextractionstatus