CfnDataSourceProps

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

Bases: object

Properties for defining a CfnDataSource.

Parameters:

index_id (str) – The identifier of the index you want to use with the data source connector.
name (str) – The name of the data source.
type (str) – The type of the data source.
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.
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 .
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 .

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 import aws_kendra as kendra

cfn_data_source_props = kendra.CfnDataSourceProps(
    index_id="indexId",
    name="name",
    type="type",

    # the properties below are optional
    custom_document_enrichment_configuration=kendra.CfnDataSource.CustomDocumentEnrichmentConfigurationProperty(
        inline_configurations=[kendra.CfnDataSource.InlineCustomDocumentEnrichmentConfigurationProperty(
            condition=kendra.CfnDataSource.DocumentAttributeConditionProperty(
                condition_document_attribute_key="conditionDocumentAttributeKey",
                operator="operator",

                # the properties below are optional
                condition_on_value=kendra.CfnDataSource.DocumentAttributeValueProperty(
                    date_value="dateValue",
                    long_value=123,
                    string_list_value=["stringListValue"],
                    string_value="stringValue"
                )
            ),
            document_content_deletion=False,
            target=kendra.CfnDataSource.DocumentAttributeTargetProperty(
                target_document_attribute_key="targetDocumentAttributeKey",

                # the properties below are optional
                target_document_attribute_value=kendra.CfnDataSource.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.CfnDataSource.HookConfigurationProperty(
            lambda_arn="lambdaArn",
            s3_bucket="s3Bucket",

            # the properties below are optional
            invocation_condition=kendra.CfnDataSource.DocumentAttributeConditionProperty(
                condition_document_attribute_key="conditionDocumentAttributeKey",
                operator="operator",

                # the properties below are optional
                condition_on_value=kendra.CfnDataSource.DocumentAttributeValueProperty(
                    date_value="dateValue",
                    long_value=123,
                    string_list_value=["stringListValue"],
                    string_value="stringValue"
                )
            )
        ),
        pre_extraction_hook_configuration=kendra.CfnDataSource.HookConfigurationProperty(
            lambda_arn="lambdaArn",
            s3_bucket="s3Bucket",

            # the properties below are optional
            invocation_condition=kendra.CfnDataSource.DocumentAttributeConditionProperty(
                condition_document_attribute_key="conditionDocumentAttributeKey",
                operator="operator",

                # the properties below are optional
                condition_on_value=kendra.CfnDataSource.DocumentAttributeValueProperty(
                    date_value="dateValue",
                    long_value=123,
                    string_list_value=["stringListValue"],
                    string_value="stringValue"
                )
            )
        ),
        role_arn="roleArn"
    ),
    data_source_configuration=kendra.CfnDataSource.DataSourceConfigurationProperty(
        confluence_configuration=kendra.CfnDataSource.ConfluenceConfigurationProperty(
            secret_arn="secretArn",
            server_url="serverUrl",
            version="version",

            # the properties below are optional
            attachment_configuration=kendra.CfnDataSource.ConfluenceAttachmentConfigurationProperty(
                attachment_field_mappings=[kendra.CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty(
                    data_source_field_name="dataSourceFieldName",
                    index_field_name="indexFieldName",

                    # the properties below are optional
                    date_field_format="dateFieldFormat"
                )],
                crawl_attachments=False
            ),
            blog_configuration=kendra.CfnDataSource.ConfluenceBlogConfigurationProperty(
                blog_field_mappings=[kendra.CfnDataSource.ConfluenceBlogToIndexFieldMappingProperty(
                    data_source_field_name="dataSourceFieldName",
                    index_field_name="indexFieldName",

                    # the properties below are optional
                    date_field_format="dateFieldFormat"
                )]
            ),
            exclusion_patterns=["exclusionPatterns"],
            inclusion_patterns=["inclusionPatterns"],
            page_configuration=kendra.CfnDataSource.ConfluencePageConfigurationProperty(
                page_field_mappings=[kendra.CfnDataSource.ConfluencePageToIndexFieldMappingProperty(
                    data_source_field_name="dataSourceFieldName",
                    index_field_name="indexFieldName",

                    # the properties below are optional
                    date_field_format="dateFieldFormat"
                )]
            ),
            space_configuration=kendra.CfnDataSource.ConfluenceSpaceConfigurationProperty(
                crawl_archived_spaces=False,
                crawl_personal_spaces=False,
                exclude_spaces=["excludeSpaces"],
                include_spaces=["includeSpaces"],
                space_field_mappings=[kendra.CfnDataSource.ConfluenceSpaceToIndexFieldMappingProperty(
                    data_source_field_name="dataSourceFieldName",
                    index_field_name="indexFieldName",

                    # the properties below are optional
                    date_field_format="dateFieldFormat"
                )]
            ),
            vpc_configuration=kendra.CfnDataSource.DataSourceVpcConfigurationProperty(
                security_group_ids=["securityGroupIds"],
                subnet_ids=["subnetIds"]
            )
        ),
        database_configuration=kendra.CfnDataSource.DatabaseConfigurationProperty(
            column_configuration=kendra.CfnDataSource.ColumnConfigurationProperty(
                change_detecting_columns=["changeDetectingColumns"],
                document_data_column_name="documentDataColumnName",
                document_id_column_name="documentIdColumnName",

                # the properties below are optional
                document_title_column_name="documentTitleColumnName",
                field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
                    data_source_field_name="dataSourceFieldName",
                    index_field_name="indexFieldName",

                    # the properties below are optional
                    date_field_format="dateFieldFormat"
                )]
            ),
            connection_configuration=kendra.CfnDataSource.ConnectionConfigurationProperty(
                database_host="databaseHost",
                database_name="databaseName",
                database_port=123,
                secret_arn="secretArn",
                table_name="tableName"
            ),
            database_engine_type="databaseEngineType",

            # the properties below are optional
            acl_configuration=kendra.CfnDataSource.AclConfigurationProperty(
                allowed_groups_column_name="allowedGroupsColumnName"
            ),
            sql_configuration=kendra.CfnDataSource.SqlConfigurationProperty(
                query_identifiers_enclosing_option="queryIdentifiersEnclosingOption"
            ),
            vpc_configuration=kendra.CfnDataSource.DataSourceVpcConfigurationProperty(
                security_group_ids=["securityGroupIds"],
                subnet_ids=["subnetIds"]
            )
        ),
        google_drive_configuration=kendra.CfnDataSource.GoogleDriveConfigurationProperty(
            secret_arn="secretArn",

            # the properties below are optional
            exclude_mime_types=["excludeMimeTypes"],
            exclude_shared_drives=["excludeSharedDrives"],
            exclude_user_accounts=["excludeUserAccounts"],
            exclusion_patterns=["exclusionPatterns"],
            field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
                data_source_field_name="dataSourceFieldName",
                index_field_name="indexFieldName",

                # the properties below are optional
                date_field_format="dateFieldFormat"
            )],
            inclusion_patterns=["inclusionPatterns"]
        ),
        one_drive_configuration=kendra.CfnDataSource.OneDriveConfigurationProperty(
            one_drive_users=kendra.CfnDataSource.OneDriveUsersProperty(
                one_drive_user_list=["oneDriveUserList"],
                one_drive_user_s3_path=kendra.CfnDataSource.S3PathProperty(
                    bucket="bucket",
                    key="key"
                )
            ),
            secret_arn="secretArn",
            tenant_domain="tenantDomain",

            # the properties below are optional
            disable_local_groups=False,
            exclusion_patterns=["exclusionPatterns"],
            field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
                data_source_field_name="dataSourceFieldName",
                index_field_name="indexFieldName",

                # the properties below are optional
                date_field_format="dateFieldFormat"
            )],
            inclusion_patterns=["inclusionPatterns"]
        ),
        s3_configuration=kendra.CfnDataSource.S3DataSourceConfigurationProperty(
            bucket_name="bucketName",

            # the properties below are optional
            access_control_list_configuration=kendra.CfnDataSource.AccessControlListConfigurationProperty(
                key_path="keyPath"
            ),
            documents_metadata_configuration=kendra.CfnDataSource.DocumentsMetadataConfigurationProperty(
                s3_prefix="s3Prefix"
            ),
            exclusion_patterns=["exclusionPatterns"],
            inclusion_patterns=["inclusionPatterns"],
            inclusion_prefixes=["inclusionPrefixes"]
        ),
        salesforce_configuration=kendra.CfnDataSource.SalesforceConfigurationProperty(
            secret_arn="secretArn",
            server_url="serverUrl",

            # the properties below are optional
            chatter_feed_configuration=kendra.CfnDataSource.SalesforceChatterFeedConfigurationProperty(
                document_data_field_name="documentDataFieldName",

                # the properties below are optional
                document_title_field_name="documentTitleFieldName",
                field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
                    data_source_field_name="dataSourceFieldName",
                    index_field_name="indexFieldName",

                    # the properties below are optional
                    date_field_format="dateFieldFormat"
                )],
                include_filter_types=["includeFilterTypes"]
            ),
            crawl_attachments=False,
            exclude_attachment_file_patterns=["excludeAttachmentFilePatterns"],
            include_attachment_file_patterns=["includeAttachmentFilePatterns"],
            knowledge_article_configuration=kendra.CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty(
                included_states=["includedStates"],

                # the properties below are optional
                custom_knowledge_article_type_configurations=[kendra.CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty(
                    document_data_field_name="documentDataFieldName",
                    name="name",

                    # the properties below are optional
                    document_title_field_name="documentTitleFieldName",
                    field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
                        data_source_field_name="dataSourceFieldName",
                        index_field_name="indexFieldName",

                        # the properties below are optional
                        date_field_format="dateFieldFormat"
                    )]
                )],
                standard_knowledge_article_type_configuration=kendra.CfnDataSource.SalesforceStandardKnowledgeArticleTypeConfigurationProperty(
                    document_data_field_name="documentDataFieldName",

                    # the properties below are optional
                    document_title_field_name="documentTitleFieldName",
                    field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
                        data_source_field_name="dataSourceFieldName",
                        index_field_name="indexFieldName",

                        # the properties below are optional
                        date_field_format="dateFieldFormat"
                    )]
                )
            ),
            standard_object_attachment_configuration=kendra.CfnDataSource.SalesforceStandardObjectAttachmentConfigurationProperty(
                document_title_field_name="documentTitleFieldName",
                field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
                    data_source_field_name="dataSourceFieldName",
                    index_field_name="indexFieldName",

                    # the properties below are optional
                    date_field_format="dateFieldFormat"
                )]
            ),
            standard_object_configurations=[kendra.CfnDataSource.SalesforceStandardObjectConfigurationProperty(
                document_data_field_name="documentDataFieldName",
                name="name",

                # the properties below are optional
                document_title_field_name="documentTitleFieldName",
                field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
                    data_source_field_name="dataSourceFieldName",
                    index_field_name="indexFieldName",

                    # the properties below are optional
                    date_field_format="dateFieldFormat"
                )]
            )]
        ),
        service_now_configuration=kendra.CfnDataSource.ServiceNowConfigurationProperty(
            host_url="hostUrl",
            secret_arn="secretArn",
            service_now_build_version="serviceNowBuildVersion",

            # the properties below are optional
            authentication_type="authenticationType",
            knowledge_article_configuration=kendra.CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty(
                document_data_field_name="documentDataFieldName",

                # the properties below are optional
                crawl_attachments=False,
                document_title_field_name="documentTitleFieldName",
                exclude_attachment_file_patterns=["excludeAttachmentFilePatterns"],
                field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
                    data_source_field_name="dataSourceFieldName",
                    index_field_name="indexFieldName",

                    # the properties below are optional
                    date_field_format="dateFieldFormat"
                )],
                filter_query="filterQuery",
                include_attachment_file_patterns=["includeAttachmentFilePatterns"]
            ),
            service_catalog_configuration=kendra.CfnDataSource.ServiceNowServiceCatalogConfigurationProperty(
                document_data_field_name="documentDataFieldName",

                # the properties below are optional
                crawl_attachments=False,
                document_title_field_name="documentTitleFieldName",
                exclude_attachment_file_patterns=["excludeAttachmentFilePatterns"],
                field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
                    data_source_field_name="dataSourceFieldName",
                    index_field_name="indexFieldName",

                    # the properties below are optional
                    date_field_format="dateFieldFormat"
                )],
                include_attachment_file_patterns=["includeAttachmentFilePatterns"]
            )
        ),
        share_point_configuration=kendra.CfnDataSource.SharePointConfigurationProperty(
            secret_arn="secretArn",
            share_point_version="sharePointVersion",
            urls=["urls"],

            # the properties below are optional
            crawl_attachments=False,
            disable_local_groups=False,
            document_title_field_name="documentTitleFieldName",
            exclusion_patterns=["exclusionPatterns"],
            field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
                data_source_field_name="dataSourceFieldName",
                index_field_name="indexFieldName",

                # the properties below are optional
                date_field_format="dateFieldFormat"
            )],
            inclusion_patterns=["inclusionPatterns"],
            ssl_certificate_s3_path=kendra.CfnDataSource.S3PathProperty(
                bucket="bucket",
                key="key"
            ),
            use_change_log=False,
            vpc_configuration=kendra.CfnDataSource.DataSourceVpcConfigurationProperty(
                security_group_ids=["securityGroupIds"],
                subnet_ids=["subnetIds"]
            )
        ),
        template_configuration=kendra.CfnDataSource.TemplateConfigurationProperty(
            template="template"
        ),
        web_crawler_configuration=kendra.CfnDataSource.WebCrawlerConfigurationProperty(
            urls=kendra.CfnDataSource.WebCrawlerUrlsProperty(
                seed_url_configuration=kendra.CfnDataSource.WebCrawlerSeedUrlConfigurationProperty(
                    seed_urls=["seedUrls"],

                    # the properties below are optional
                    web_crawler_mode="webCrawlerMode"
                ),
                site_maps_configuration=kendra.CfnDataSource.WebCrawlerSiteMapsConfigurationProperty(
                    site_maps=["siteMaps"]
                )
            ),

            # the properties below are optional
            authentication_configuration=kendra.CfnDataSource.WebCrawlerAuthenticationConfigurationProperty(
                basic_authentication=[kendra.CfnDataSource.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.CfnDataSource.ProxyConfigurationProperty(
                host="host",
                port=123,

                # the properties below are optional
                credentials="credentials"
            ),
            url_exclusion_patterns=["urlExclusionPatterns"],
            url_inclusion_patterns=["urlInclusionPatterns"]
        ),
        work_docs_configuration=kendra.CfnDataSource.WorkDocsConfigurationProperty(
            organization_id="organizationId",

            # the properties below are optional
            crawl_comments=False,
            exclusion_patterns=["exclusionPatterns"],
            field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
                data_source_field_name="dataSourceFieldName",
                index_field_name="indexFieldName",

                # the properties below are optional
                date_field_format="dateFieldFormat"
            )],
            inclusion_patterns=["inclusionPatterns"],
            use_change_log=False
        )
    ),
    description="description",
    language_code="languageCode",
    role_arn="roleArn",
    schedule="schedule",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

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