CfnDataSourceMixinProps

class aws_cdk.mixins_preview.aws_kendra.mixins.CfnDataSourceMixinProps(*, custom_document_enrichment_configuration=None, data_source_configuration=None, description=None, index_id=None, language_code=None, name=None, role_arn=None, schedule=None, tags=None, type=None)

Bases: object

Properties for CfnDataSourcePropsMixin.

Parameters:

custom_document_enrichment_configuration (Union[IResolvable, CustomDocumentEnrichmentConfigurationProperty, Dict[str, Any], None]) – Configuration information for altering document metadata and content during the document ingestion process.
data_source_configuration (Union[IResolvable, DataSourceConfigurationProperty, Dict[str, Any], None]) – Configuration information for an Amazon Kendra data source. The contents of the configuration depend on the type of data source. You can only specify one type of data source in the configuration. You can’t specify the Configuration parameter when the Type parameter is set to CUSTOM . The Configuration parameter is required for all other data sources.
description (Optional[str]) – A description for the data source connector.
index_id (Optional[str]) – The identifier of the index you want to use with the data source connector.
language_code (Optional[str]) – The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English .
name (Optional[str]) – The name of the data source.
role_arn (Optional[str]) – The Amazon Resource Name (ARN) of a role with permission to access the data source. You can’t specify the RoleArn parameter when the Type parameter is set to CUSTOM . The RoleArn parameter is required for all other data sources.
schedule (Optional[str]) – Sets the frequency that Amazon Kendra checks the documents in your data source and updates the index. If you don’t set a schedule, Amazon Kendra doesn’t periodically update the index.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .
type (Optional[str]) – The type of the data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-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.mixins_preview.aws_kendra import mixins as kendra_mixins

cfn_data_source_mixin_props = kendra_mixins.CfnDataSourceMixinProps(
    custom_document_enrichment_configuration=kendra_mixins.CfnDataSourcePropsMixin.CustomDocumentEnrichmentConfigurationProperty(
        inline_configurations=[kendra_mixins.CfnDataSourcePropsMixin.InlineCustomDocumentEnrichmentConfigurationProperty(
            condition=kendra_mixins.CfnDataSourcePropsMixin.DocumentAttributeConditionProperty(
                condition_document_attribute_key="conditionDocumentAttributeKey",
                condition_on_value=kendra_mixins.CfnDataSourcePropsMixin.DocumentAttributeValueProperty(
                    date_value="dateValue",
                    long_value=123,
                    string_list_value=["stringListValue"],
                    string_value="stringValue"
                ),
                operator="operator"
            ),
            document_content_deletion=False,
            target=kendra_mixins.CfnDataSourcePropsMixin.DocumentAttributeTargetProperty(
                target_document_attribute_key="targetDocumentAttributeKey",
                target_document_attribute_value=kendra_mixins.CfnDataSourcePropsMixin.DocumentAttributeValueProperty(
                    date_value="dateValue",
                    long_value=123,
                    string_list_value=["stringListValue"],
                    string_value="stringValue"
                ),
                target_document_attribute_value_deletion=False
            )
        )],
        post_extraction_hook_configuration=kendra_mixins.CfnDataSourcePropsMixin.HookConfigurationProperty(
            invocation_condition=kendra_mixins.CfnDataSourcePropsMixin.DocumentAttributeConditionProperty(
                condition_document_attribute_key="conditionDocumentAttributeKey",
                condition_on_value=kendra_mixins.CfnDataSourcePropsMixin.DocumentAttributeValueProperty(
                    date_value="dateValue",
                    long_value=123,
                    string_list_value=["stringListValue"],
                    string_value="stringValue"
                ),
                operator="operator"
            ),
            lambda_arn="lambdaArn",
            s3_bucket="s3Bucket"
        ),
        pre_extraction_hook_configuration=kendra_mixins.CfnDataSourcePropsMixin.HookConfigurationProperty(
            invocation_condition=kendra_mixins.CfnDataSourcePropsMixin.DocumentAttributeConditionProperty(
                condition_document_attribute_key="conditionDocumentAttributeKey",
                condition_on_value=kendra_mixins.CfnDataSourcePropsMixin.DocumentAttributeValueProperty(
                    date_value="dateValue",
                    long_value=123,
                    string_list_value=["stringListValue"],
                    string_value="stringValue"
                ),
                operator="operator"
            ),
            lambda_arn="lambdaArn",
            s3_bucket="s3Bucket"
        ),
        role_arn="roleArn"
    ),
    data_source_configuration=kendra_mixins.CfnDataSourcePropsMixin.DataSourceConfigurationProperty(
        confluence_configuration=kendra_mixins.CfnDataSourcePropsMixin.ConfluenceConfigurationProperty(
            attachment_configuration=kendra_mixins.CfnDataSourcePropsMixin.ConfluenceAttachmentConfigurationProperty(
                attachment_field_mappings=[kendra_mixins.CfnDataSourcePropsMixin.ConfluenceAttachmentToIndexFieldMappingProperty(
                    data_source_field_name="dataSourceFieldName",
                    date_field_format="dateFieldFormat",
                    index_field_name="indexFieldName"
                )],
                crawl_attachments=False
            ),
            blog_configuration=kendra_mixins.CfnDataSourcePropsMixin.ConfluenceBlogConfigurationProperty(
                blog_field_mappings=[kendra_mixins.CfnDataSourcePropsMixin.ConfluenceBlogToIndexFieldMappingProperty(
                    data_source_field_name="dataSourceFieldName",
                    date_field_format="dateFieldFormat",
                    index_field_name="indexFieldName"
                )]
            ),
            exclusion_patterns=["exclusionPatterns"],
            inclusion_patterns=["inclusionPatterns"],
            page_configuration=kendra_mixins.CfnDataSourcePropsMixin.ConfluencePageConfigurationProperty(
                page_field_mappings=[kendra_mixins.CfnDataSourcePropsMixin.ConfluencePageToIndexFieldMappingProperty(
                    data_source_field_name="dataSourceFieldName",
                    date_field_format="dateFieldFormat",
                    index_field_name="indexFieldName"
                )]
            ),
            secret_arn="secretArn",
            server_url="serverUrl",
            space_configuration=kendra_mixins.CfnDataSourcePropsMixin.ConfluenceSpaceConfigurationProperty(
                crawl_archived_spaces=False,
                crawl_personal_spaces=False,
                exclude_spaces=["excludeSpaces"],
                include_spaces=["includeSpaces"],
                space_field_mappings=[kendra_mixins.CfnDataSourcePropsMixin.ConfluenceSpaceToIndexFieldMappingProperty(
                    data_source_field_name="dataSourceFieldName",
                    date_field_format="dateFieldFormat",
                    index_field_name="indexFieldName"
                )]
            ),
            version="version",
            vpc_configuration=kendra_mixins.CfnDataSourcePropsMixin.DataSourceVpcConfigurationProperty(
                security_group_ids=["securityGroupIds"],
                subnet_ids=["subnetIds"]
            )
        ),
        database_configuration=kendra_mixins.CfnDataSourcePropsMixin.DatabaseConfigurationProperty(
            acl_configuration=kendra_mixins.CfnDataSourcePropsMixin.AclConfigurationProperty(
                allowed_groups_column_name="allowedGroupsColumnName"
            ),
            column_configuration=kendra_mixins.CfnDataSourcePropsMixin.ColumnConfigurationProperty(
                change_detecting_columns=["changeDetectingColumns"],
                document_data_column_name="documentDataColumnName",
                document_id_column_name="documentIdColumnName",
                document_title_column_name="documentTitleColumnName",
                field_mappings=[kendra_mixins.CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty(
                    data_source_field_name="dataSourceFieldName",
                    date_field_format="dateFieldFormat",
                    index_field_name="indexFieldName"
                )]
            ),
            connection_configuration=kendra_mixins.CfnDataSourcePropsMixin.ConnectionConfigurationProperty(
                database_host="databaseHost",
                database_name="databaseName",
                database_port=123,
                secret_arn="secretArn",
                table_name="tableName"
            ),
            database_engine_type="databaseEngineType",
            sql_configuration=kendra_mixins.CfnDataSourcePropsMixin.SqlConfigurationProperty(
                query_identifiers_enclosing_option="queryIdentifiersEnclosingOption"
            ),
            vpc_configuration=kendra_mixins.CfnDataSourcePropsMixin.DataSourceVpcConfigurationProperty(
                security_group_ids=["securityGroupIds"],
                subnet_ids=["subnetIds"]
            )
        ),
        google_drive_configuration=kendra_mixins.CfnDataSourcePropsMixin.GoogleDriveConfigurationProperty(
            exclude_mime_types=["excludeMimeTypes"],
            exclude_shared_drives=["excludeSharedDrives"],
            exclude_user_accounts=["excludeUserAccounts"],
            exclusion_patterns=["exclusionPatterns"],
            field_mappings=[kendra_mixins.CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty(
                data_source_field_name="dataSourceFieldName",
                date_field_format="dateFieldFormat",
                index_field_name="indexFieldName"
            )],
            inclusion_patterns=["inclusionPatterns"],
            secret_arn="secretArn"
        ),
        one_drive_configuration=kendra_mixins.CfnDataSourcePropsMixin.OneDriveConfigurationProperty(
            disable_local_groups=False,
            exclusion_patterns=["exclusionPatterns"],
            field_mappings=[kendra_mixins.CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty(
                data_source_field_name="dataSourceFieldName",
                date_field_format="dateFieldFormat",
                index_field_name="indexFieldName"
            )],
            inclusion_patterns=["inclusionPatterns"],
            one_drive_users=kendra_mixins.CfnDataSourcePropsMixin.OneDriveUsersProperty(
                one_drive_user_list=["oneDriveUserList"],
                one_drive_user_s3_path=kendra_mixins.CfnDataSourcePropsMixin.S3PathProperty(
                    bucket="bucket",
                    key="key"
                )
            ),
            secret_arn="secretArn",
            tenant_domain="tenantDomain"
        ),
        s3_configuration=kendra_mixins.CfnDataSourcePropsMixin.S3DataSourceConfigurationProperty(
            access_control_list_configuration=kendra_mixins.CfnDataSourcePropsMixin.AccessControlListConfigurationProperty(
                key_path="keyPath"
            ),
            bucket_name="bucketName",
            documents_metadata_configuration=kendra_mixins.CfnDataSourcePropsMixin.DocumentsMetadataConfigurationProperty(
                s3_prefix="s3Prefix"
            ),
            exclusion_patterns=["exclusionPatterns"],
            inclusion_patterns=["inclusionPatterns"],
            inclusion_prefixes=["inclusionPrefixes"]
        ),
        salesforce_configuration=kendra_mixins.CfnDataSourcePropsMixin.SalesforceConfigurationProperty(
            chatter_feed_configuration=kendra_mixins.CfnDataSourcePropsMixin.SalesforceChatterFeedConfigurationProperty(
                document_data_field_name="documentDataFieldName",
                document_title_field_name="documentTitleFieldName",
                field_mappings=[kendra_mixins.CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty(
                    data_source_field_name="dataSourceFieldName",
                    date_field_format="dateFieldFormat",
                    index_field_name="indexFieldName"
                )],
                include_filter_types=["includeFilterTypes"]
            ),
            crawl_attachments=False,
            exclude_attachment_file_patterns=["excludeAttachmentFilePatterns"],
            include_attachment_file_patterns=["includeAttachmentFilePatterns"],
            knowledge_article_configuration=kendra_mixins.CfnDataSourcePropsMixin.SalesforceKnowledgeArticleConfigurationProperty(
                custom_knowledge_article_type_configurations=[kendra_mixins.CfnDataSourcePropsMixin.SalesforceCustomKnowledgeArticleTypeConfigurationProperty(
                    document_data_field_name="documentDataFieldName",
                    document_title_field_name="documentTitleFieldName",
                    field_mappings=[kendra_mixins.CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty(
                        data_source_field_name="dataSourceFieldName",
                        date_field_format="dateFieldFormat",
                        index_field_name="indexFieldName"
                    )],
                    name="name"
                )],
                included_states=["includedStates"],
                standard_knowledge_article_type_configuration=kendra_mixins.CfnDataSourcePropsMixin.SalesforceStandardKnowledgeArticleTypeConfigurationProperty(
                    document_data_field_name="documentDataFieldName",
                    document_title_field_name="documentTitleFieldName",
                    field_mappings=[kendra_mixins.CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty(
                        data_source_field_name="dataSourceFieldName",
                        date_field_format="dateFieldFormat",
                        index_field_name="indexFieldName"
                    )]
                )
            ),
            secret_arn="secretArn",
            server_url="serverUrl",
            standard_object_attachment_configuration=kendra_mixins.CfnDataSourcePropsMixin.SalesforceStandardObjectAttachmentConfigurationProperty(
                document_title_field_name="documentTitleFieldName",
                field_mappings=[kendra_mixins.CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty(
                    data_source_field_name="dataSourceFieldName",
                    date_field_format="dateFieldFormat",
                    index_field_name="indexFieldName"
                )]
            ),
            standard_object_configurations=[kendra_mixins.CfnDataSourcePropsMixin.SalesforceStandardObjectConfigurationProperty(
                document_data_field_name="documentDataFieldName",
                document_title_field_name="documentTitleFieldName",
                field_mappings=[kendra_mixins.CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty(
                    data_source_field_name="dataSourceFieldName",
                    date_field_format="dateFieldFormat",
                    index_field_name="indexFieldName"
                )],
                name="name"
            )]
        ),
        service_now_configuration=kendra_mixins.CfnDataSourcePropsMixin.ServiceNowConfigurationProperty(
            authentication_type="authenticationType",
            host_url="hostUrl",
            knowledge_article_configuration=kendra_mixins.CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty(
                crawl_attachments=False,
                document_data_field_name="documentDataFieldName",
                document_title_field_name="documentTitleFieldName",
                exclude_attachment_file_patterns=["excludeAttachmentFilePatterns"],
                field_mappings=[kendra_mixins.CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty(
                    data_source_field_name="dataSourceFieldName",
                    date_field_format="dateFieldFormat",
                    index_field_name="indexFieldName"
                )],
                filter_query="filterQuery",
                include_attachment_file_patterns=["includeAttachmentFilePatterns"]
            ),
            secret_arn="secretArn",
            service_catalog_configuration=kendra_mixins.CfnDataSourcePropsMixin.ServiceNowServiceCatalogConfigurationProperty(
                crawl_attachments=False,
                document_data_field_name="documentDataFieldName",
                document_title_field_name="documentTitleFieldName",
                exclude_attachment_file_patterns=["excludeAttachmentFilePatterns"],
                field_mappings=[kendra_mixins.CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty(
                    data_source_field_name="dataSourceFieldName",
                    date_field_format="dateFieldFormat",
                    index_field_name="indexFieldName"
                )],
                include_attachment_file_patterns=["includeAttachmentFilePatterns"]
            ),
            service_now_build_version="serviceNowBuildVersion"
        ),
        share_point_configuration=kendra_mixins.CfnDataSourcePropsMixin.SharePointConfigurationProperty(
            crawl_attachments=False,
            disable_local_groups=False,
            document_title_field_name="documentTitleFieldName",
            exclusion_patterns=["exclusionPatterns"],
            field_mappings=[kendra_mixins.CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty(
                data_source_field_name="dataSourceFieldName",
                date_field_format="dateFieldFormat",
                index_field_name="indexFieldName"
            )],
            inclusion_patterns=["inclusionPatterns"],
            secret_arn="secretArn",
            share_point_version="sharePointVersion",
            ssl_certificate_s3_path=kendra_mixins.CfnDataSourcePropsMixin.S3PathProperty(
                bucket="bucket",
                key="key"
            ),
            urls=["urls"],
            use_change_log=False,
            vpc_configuration=kendra_mixins.CfnDataSourcePropsMixin.DataSourceVpcConfigurationProperty(
                security_group_ids=["securityGroupIds"],
                subnet_ids=["subnetIds"]
            )
        ),
        template_configuration=kendra_mixins.CfnDataSourcePropsMixin.TemplateConfigurationProperty(
            template="template"
        ),
        web_crawler_configuration=kendra_mixins.CfnDataSourcePropsMixin.WebCrawlerConfigurationProperty(
            authentication_configuration=kendra_mixins.CfnDataSourcePropsMixin.WebCrawlerAuthenticationConfigurationProperty(
                basic_authentication=[kendra_mixins.CfnDataSourcePropsMixin.WebCrawlerBasicAuthenticationProperty(
                    credentials="credentials",
                    host="host",
                    port=123
                )]
            ),
            crawl_depth=123,
            max_content_size_per_page_in_mega_bytes=123,
            max_links_per_page=123,
            max_urls_per_minute_crawl_rate=123,
            proxy_configuration=kendra_mixins.CfnDataSourcePropsMixin.ProxyConfigurationProperty(
                credentials="credentials",
                host="host",
                port=123
            ),
            url_exclusion_patterns=["urlExclusionPatterns"],
            url_inclusion_patterns=["urlInclusionPatterns"],
            urls=kendra_mixins.CfnDataSourcePropsMixin.WebCrawlerUrlsProperty(
                seed_url_configuration=kendra_mixins.CfnDataSourcePropsMixin.WebCrawlerSeedUrlConfigurationProperty(
                    seed_urls=["seedUrls"],
                    web_crawler_mode="webCrawlerMode"
                ),
                site_maps_configuration=kendra_mixins.CfnDataSourcePropsMixin.WebCrawlerSiteMapsConfigurationProperty(
                    site_maps=["siteMaps"]
                )
            )
        ),
        work_docs_configuration=kendra_mixins.CfnDataSourcePropsMixin.WorkDocsConfigurationProperty(
            crawl_comments=False,
            exclusion_patterns=["exclusionPatterns"],
            field_mappings=[kendra_mixins.CfnDataSourcePropsMixin.DataSourceToIndexFieldMappingProperty(
                data_source_field_name="dataSourceFieldName",
                date_field_format="dateFieldFormat",
                index_field_name="indexFieldName"
            )],
            inclusion_patterns=["inclusionPatterns"],
            organization_id="organizationId",
            use_change_log=False
        )
    ),
    description="description",
    index_id="indexId",
    language_code="languageCode",
    name="name",
    role_arn="roleArn",
    schedule="schedule",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    type="type"
)

Attributes

custom_document_enrichment_configuration

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

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

data_source_configuration

Configuration information for an Amazon Kendra data source.

The contents of the configuration depend on the type of data source. You can only specify one type of data source in the configuration.

You can’t specify the Configuration parameter when the Type parameter is set to CUSTOM .

The Configuration parameter is required for all other data sources.

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

description

A description for the data source connector.

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

index_id

The identifier of the index you want to use with the data source connector.

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

language_code

The code for a language.

This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English .

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

name

The name of the data source.

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

role_arn

The Amazon Resource Name (ARN) of a role with permission to access the data source.

You can’t specify the RoleArn parameter when the Type parameter is set to CUSTOM .

The RoleArn parameter is required for all other data sources.

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

schedule

Sets the frequency that Amazon Kendra checks the documents in your data source and updates the index.

If you don’t set a schedule, Amazon Kendra doesn’t periodically update the index.

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

tags

An array of key-value pairs to apply to this resource.

For more information, see Tag .

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

type

The type of the data source.

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