CfnDataSource

class aws_cdk.aws_kendra.CfnDataSource(scope, id, *, 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: CfnResource

Creates a data source connector that you want to use with an Amazon Kendra index.

You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector. .. epigraph:

``CreateDataSource`` does *not* support connectors which `require a ``TemplateConfiguration`` object <https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html>`_ for connecting to Amazon Kendra .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html
CloudformationResource:: AWS::Kendra::DataSource
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 = kendra.CfnDataSource(self, "MyCfnDataSource",
    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"
    )]
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
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 .

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Kendra::DataSource'

attr_arn

.

arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/data-source/b8cae438-6787-4091-8897-684a652bbb0a

CloudformationAttribute:: Arn
Type:: The Amazon Resource Name (ARN) of the data source. For example

attr_id

.

b8cae438-6787-4091-8897-684a652bbb0a .

CloudformationAttribute:: Id
Type:: The identifier for the data source. For example

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

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

data_source_configuration: Configuration information for an Amazon Kendra data source.

description: A description for the data source connector.

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

language_code: The code for a language.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name: The name of the data source.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

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

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

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: Tag Manager which manages the tags for this resource.

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

type: The type of the data source.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

AccessControlListConfigurationProperty

class CfnDataSource.AccessControlListConfigurationProperty(*, key_path=None)

Bases: object

Specifies access control list files for the documents in a data source.

Parameters:: key_path (Optional[str]) – Path to the AWS S3 bucket that contains the access control list files.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-accesscontrollistconfiguration.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

access_control_list_configuration_property = kendra.CfnDataSource.AccessControlListConfigurationProperty(
    key_path="keyPath"
)

Attributes

key_path

Path to the AWS S3 bucket that contains the access control list files.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-accesscontrollistconfiguration.html#cfn-kendra-datasource-accesscontrollistconfiguration-keypath

AclConfigurationProperty

class CfnDataSource.AclConfigurationProperty(*, allowed_groups_column_name)

Bases: object

Provides information about the column that should be used for filtering the query response by groups.

Parameters:: allowed_groups_column_name (str) – A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query operation.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-aclconfiguration.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

acl_configuration_property = kendra.CfnDataSource.AclConfigurationProperty(
    allowed_groups_column_name="allowedGroupsColumnName"
)

Attributes

allowed_groups_column_name

A list of groups, separated by semi-colons, that filters a query response based on user context.

The document is only returned to users that are in one of the groups specified in the UserContext field of the Query operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-aclconfiguration.html#cfn-kendra-datasource-aclconfiguration-allowedgroupscolumnname

ColumnConfigurationProperty

class CfnDataSource.ColumnConfigurationProperty(*, change_detecting_columns, document_data_column_name, document_id_column_name, document_title_column_name=None, field_mappings=None)

Bases: object

Provides information about how Amazon Kendra should use the columns of a database in an index.

Parameters:

change_detecting_columns (Sequence[str]) – One to five columns that indicate when a document in the database has changed.
document_data_column_name (str) – The column that contains the contents of the document.
document_id_column_name (str) – The column that provides the document’s identifier.
document_title_column_name (Optional[str]) – The column that contains the title of the document.
field_mappings (Union[IResolvable, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty, Dict[str, Any]]], None]) – An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex operation.

See:

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

column_configuration_property = 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"
    )]
)

Attributes

change_detecting_columns

One to five columns that indicate when a document in the database has changed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-columnconfiguration.html#cfn-kendra-datasource-columnconfiguration-changedetectingcolumns

document_data_column_name

The column that contains the contents of the document.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-columnconfiguration.html#cfn-kendra-datasource-columnconfiguration-documentdatacolumnname

document_id_column_name

The column that provides the document’s identifier.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-columnconfiguration.html#cfn-kendra-datasource-columnconfiguration-documentidcolumnname

document_title_column_name

The column that contains the title of the document.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-columnconfiguration.html#cfn-kendra-datasource-columnconfiguration-documenttitlecolumnname

field_mappings

An array of objects that map database column names to the corresponding fields in an index.

You must first create the fields in the index using the UpdateIndex operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-columnconfiguration.html#cfn-kendra-datasource-columnconfiguration-fieldmappings

ConfluenceAttachmentConfigurationProperty

class CfnDataSource.ConfluenceAttachmentConfigurationProperty(*, attachment_field_mappings=None, crawl_attachments=None)

Bases: object

Configuration of attachment settings for the Confluence data source.

Attachment settings are optional, if you don’t specify settings attachments, Amazon Kendra won’t index them.

Parameters:

attachment_field_mappings (Union[IResolvable, Sequence[Union[IResolvable, ConfluenceAttachmentToIndexFieldMappingProperty, Dict[str, Any]]], None]) – Maps attributes or field names of Confluence attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields . The Confluence data source field names must exist in your Confluence custom metadata. If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.
crawl_attachments (Union[bool, IResolvable, None]) – TRUE to index attachments of pages and blogs in Confluence.

See:

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

confluence_attachment_configuration_property = 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
)

Attributes

attachment_field_mappings

Maps attributes or field names of Confluence attachments to Amazon Kendra index field names.

To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields . The Confluence data source field names must exist in your Confluence custom metadata.

If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceattachmentconfiguration.html#cfn-kendra-datasource-confluenceattachmentconfiguration-attachmentfieldmappings

crawl_attachments

TRUE to index attachments of pages and blogs in Confluence.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceattachmentconfiguration.html#cfn-kendra-datasource-confluenceattachmentconfiguration-crawlattachments

ConfluenceAttachmentToIndexFieldMappingProperty

class CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty(*, data_source_field_name, index_field_name, date_field_format=None)

Bases: object

Maps attributes or field names of Confluence attachments to Amazon Kendra index field names.

To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields . The Confuence data source field names must exist in your Confluence custom metadata.

Parameters:

data_source_field_name (str) – The name of the field in the data source. You must first create the index field using the UpdateIndex API.
index_field_name (str) – The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
date_field_format (Optional[str]) – The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

See:

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

confluence_attachment_to_index_field_mapping_property = kendra.CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty(
    data_source_field_name="dataSourceFieldName",
    index_field_name="indexFieldName",

    # the properties below are optional
    date_field_format="dateFieldFormat"
)

Attributes

data_source_field_name

The name of the field in the data source.

You must first create the index field using the UpdateIndex API.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceattachmenttoindexfieldmapping.html#cfn-kendra-datasource-confluenceattachmenttoindexfieldmapping-datasourcefieldname

date_field_format

The format for date fields in the data source.

If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceattachmenttoindexfieldmapping.html#cfn-kendra-datasource-confluenceattachmenttoindexfieldmapping-datefieldformat

index_field_name

The name of the index field to map to the Confluence data source field.

The index field type must match the Confluence field type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceattachmenttoindexfieldmapping.html#cfn-kendra-datasource-confluenceattachmenttoindexfieldmapping-indexfieldname

ConfluenceBlogConfigurationProperty

class CfnDataSource.ConfluenceBlogConfigurationProperty(*, blog_field_mappings=None)

Bases: object

Configuration of blog settings for the Confluence data source.

Blogs are always indexed unless filtered from the index by the ExclusionPatterns or InclusionPatterns fields in the ConfluenceConfiguration object.

Parameters:

blog_field_mappings (Union[IResolvable, Sequence[Union[IResolvable, ConfluenceBlogToIndexFieldMappingProperty, Dict[str, Any]]], None]) –

Maps attributes or field names of Confluence blogs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields . The Confluence data source field names must exist in your Confluence custom metadata. If you specify the BlogFieldMappings parameter, you must specify at least one field mapping.

See:

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

confluence_blog_configuration_property = 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"
    )]
)

Attributes

blog_field_mappings

Maps attributes or field names of Confluence blogs to Amazon Kendra index field names.

To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields . The Confluence data source field names must exist in your Confluence custom metadata.

If you specify the BlogFieldMappings parameter, you must specify at least one field mapping.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceblogconfiguration.html#cfn-kendra-datasource-confluenceblogconfiguration-blogfieldmappings

ConfluenceBlogToIndexFieldMappingProperty

class CfnDataSource.ConfluenceBlogToIndexFieldMappingProperty(*, data_source_field_name, index_field_name, date_field_format=None)

Bases: object

Maps attributes or field names of Confluence blog to Amazon Kendra index field names.

To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields . The Confluence data source field names must exist in your Confluence custom metadata.

Parameters:

data_source_field_name (str) – The name of the field in the data source.
index_field_name (str) – The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
date_field_format (Optional[str]) – The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

See:

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

confluence_blog_to_index_field_mapping_property = kendra.CfnDataSource.ConfluenceBlogToIndexFieldMappingProperty(
    data_source_field_name="dataSourceFieldName",
    index_field_name="indexFieldName",

    # the properties below are optional
    date_field_format="dateFieldFormat"
)

Attributes

data_source_field_name

The name of the field in the data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceblogtoindexfieldmapping.html#cfn-kendra-datasource-confluenceblogtoindexfieldmapping-datasourcefieldname

date_field_format

The format for date fields in the data source.

If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceblogtoindexfieldmapping.html#cfn-kendra-datasource-confluenceblogtoindexfieldmapping-datefieldformat

index_field_name

The name of the index field to map to the Confluence data source field.

The index field type must match the Confluence field type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceblogtoindexfieldmapping.html#cfn-kendra-datasource-confluenceblogtoindexfieldmapping-indexfieldname

ConfluenceConfigurationProperty

class CfnDataSource.ConfluenceConfigurationProperty(*, secret_arn, server_url, version, attachment_configuration=None, blog_configuration=None, exclusion_patterns=None, inclusion_patterns=None, page_configuration=None, space_configuration=None, vpc_configuration=None)

Bases: object

Provides the configuration information to connect to Confluence as your data source.

Parameters:

secret_arn (str) – The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password required to connect to the Confluence instance. If you use Confluence Cloud, you use a generated API token as the password. You can also provide authentication credentials in the form of a personal access token. For more information, see Using a Confluence data source .
server_url (str) – The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/ . You can also use an IP address, for example, https://192.168.1.113/ .
version (str) – The version or the type of Confluence installation to connect to.
attachment_configuration (Union[IResolvable, ConfluenceAttachmentConfigurationProperty, Dict[str, Any], None]) – Configuration information for indexing attachments to Confluence blogs and pages.
blog_configuration (Union[IResolvable, ConfluenceBlogConfigurationProperty, Dict[str, Any], None]) – Configuration information for indexing Confluence blogs.
exclusion_patterns (Optional[Sequence[str]]) – A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are excluded from the index. Content that doesn’t match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn’t included in the index.
inclusion_patterns (Optional[Sequence[str]]) – A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are included in the index. Content that doesn’t match the patterns is excluded from the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn’t included in the index.
page_configuration (Union[IResolvable, ConfluencePageConfigurationProperty, Dict[str, Any], None]) – Configuration information for indexing Confluence pages.
space_configuration (Union[IResolvable, ConfluenceSpaceConfigurationProperty, Dict[str, Any], None]) – Configuration information for indexing Confluence spaces.
vpc_configuration (Union[IResolvable, DataSourceVpcConfigurationProperty, Dict[str, Any], None]) – Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC .

See:

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

confluence_configuration_property = 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"]
    )
)

Attributes

attachment_configuration

Configuration information for indexing attachments to Confluence blogs and pages.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceconfiguration.html#cfn-kendra-datasource-confluenceconfiguration-attachmentconfiguration

blog_configuration

Configuration information for indexing Confluence blogs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceconfiguration.html#cfn-kendra-datasource-confluenceconfiguration-blogconfiguration

exclusion_patterns

A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence.

Content that matches the patterns are excluded from the index. Content that doesn’t match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn’t included in the index.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceconfiguration.html#cfn-kendra-datasource-confluenceconfiguration-exclusionpatterns

inclusion_patterns

A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence.

Content that matches the patterns are included in the index. Content that doesn’t match the patterns is excluded from the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn’t included in the index.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceconfiguration.html#cfn-kendra-datasource-confluenceconfiguration-inclusionpatterns

page_configuration

Configuration information for indexing Confluence pages.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceconfiguration.html#cfn-kendra-datasource-confluenceconfiguration-pageconfiguration

secret_arn

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password required to connect to the Confluence instance.

If you use Confluence Cloud, you use a generated API token as the password.

You can also provide authentication credentials in the form of a personal access token. For more information, see Using a Confluence data source .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceconfiguration.html#cfn-kendra-datasource-confluenceconfiguration-secretarn

server_url

The URL of your Confluence instance.

Use the full URL of the server. For example, https://server.example.com:port/ . You can also use an IP address, for example, https://192.168.1.113/ .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceconfiguration.html#cfn-kendra-datasource-confluenceconfiguration-serverurl

space_configuration

Configuration information for indexing Confluence spaces.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceconfiguration.html#cfn-kendra-datasource-confluenceconfiguration-spaceconfiguration

version

The version or the type of Confluence installation to connect to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceconfiguration.html#cfn-kendra-datasource-confluenceconfiguration-version

vpc_configuration

Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence.

For more information, see Configuring a VPC .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceconfiguration.html#cfn-kendra-datasource-confluenceconfiguration-vpcconfiguration

ConfluencePageConfigurationProperty

class CfnDataSource.ConfluencePageConfigurationProperty(*, page_field_mappings=None)

Bases: object

Configuration of the page settings for the Confluence data source.

Parameters:

page_field_mappings (Union[IResolvable, Sequence[Union[IResolvable, ConfluencePageToIndexFieldMappingProperty, Dict[str, Any]]], None]) –

Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields . The Confluence data source field names must exist in your Confluence custom metadata. If you specify the PageFieldMappings parameter, you must specify at least one field mapping.

See:

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

confluence_page_configuration_property = 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"
    )]
)

Attributes

page_field_mappings

Maps attributes or field names of Confluence pages to Amazon Kendra index field names.

To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields . The Confluence data source field names must exist in your Confluence custom metadata.

If you specify the PageFieldMappings parameter, you must specify at least one field mapping.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencepageconfiguration.html#cfn-kendra-datasource-confluencepageconfiguration-pagefieldmappings

ConfluencePageToIndexFieldMappingProperty

class CfnDataSource.ConfluencePageToIndexFieldMappingProperty(*, data_source_field_name, index_field_name, date_field_format=None)

Bases: object

Maps attributes or field names of Confluence pages to Amazon Kendra index field names.

To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields . The Confluence data source field names must exist in your Confluence custom metadata.

Parameters:

data_source_field_name (str) – The name of the field in the data source.
index_field_name (str) – The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
date_field_format (Optional[str]) – The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

See:

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

confluence_page_to_index_field_mapping_property = kendra.CfnDataSource.ConfluencePageToIndexFieldMappingProperty(
    data_source_field_name="dataSourceFieldName",
    index_field_name="indexFieldName",

    # the properties below are optional
    date_field_format="dateFieldFormat"
)

Attributes

data_source_field_name

The name of the field in the data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencepagetoindexfieldmapping.html#cfn-kendra-datasource-confluencepagetoindexfieldmapping-datasourcefieldname

date_field_format

The format for date fields in the data source.

If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencepagetoindexfieldmapping.html#cfn-kendra-datasource-confluencepagetoindexfieldmapping-datefieldformat

index_field_name

The name of the index field to map to the Confluence data source field.

The index field type must match the Confluence field type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencepagetoindexfieldmapping.html#cfn-kendra-datasource-confluencepagetoindexfieldmapping-indexfieldname

ConfluenceSpaceConfigurationProperty

class CfnDataSource.ConfluenceSpaceConfigurationProperty(*, crawl_archived_spaces=None, crawl_personal_spaces=None, exclude_spaces=None, include_spaces=None, space_field_mappings=None)

Bases: object

Configuration information for indexing Confluence spaces.

Parameters:

crawl_archived_spaces (Union[bool, IResolvable, None]) – TRUE to index archived spaces.
crawl_personal_spaces (Union[bool, IResolvable, None]) – TRUE to index personal spaces. You can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context .
exclude_spaces (Optional[Sequence[str]]) – A list of space keys of Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the ExcludeSpaces and the IncludeSpaces list, the space is excluded.
include_spaces (Optional[Sequence[str]]) – A list of space keys for Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren’t in the list aren’t indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded.
space_field_mappings (Union[IResolvable, Sequence[Union[IResolvable, ConfluenceSpaceToIndexFieldMappingProperty, Dict[str, Any]]], None]) –
Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields . The Confluence data source field names must exist in your Confluence custom metadata. If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

See:

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

confluence_space_configuration_property = 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"
    )]
)

Attributes

crawl_archived_spaces

TRUE to index archived spaces.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencespaceconfiguration.html#cfn-kendra-datasource-confluencespaceconfiguration-crawlarchivedspaces

crawl_personal_spaces

TRUE to index personal spaces.

You can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencespaceconfiguration.html#cfn-kendra-datasource-confluencespaceconfiguration-crawlpersonalspaces

exclude_spaces

A list of space keys of Confluence spaces.

If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the ExcludeSpaces and the IncludeSpaces list, the space is excluded.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencespaceconfiguration.html#cfn-kendra-datasource-confluencespaceconfiguration-excludespaces

include_spaces

A list of space keys for Confluence spaces.

If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren’t in the list aren’t indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencespaceconfiguration.html#cfn-kendra-datasource-confluencespaceconfiguration-includespaces

space_field_mappings

Maps attributes or field names of Confluence spaces to Amazon Kendra index field names.

To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields . The Confluence data source field names must exist in your Confluence custom metadata.

If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencespaceconfiguration.html#cfn-kendra-datasource-confluencespaceconfiguration-spacefieldmappings

ConfluenceSpaceToIndexFieldMappingProperty

class CfnDataSource.ConfluenceSpaceToIndexFieldMappingProperty(*, data_source_field_name, index_field_name, date_field_format=None)

Bases: object

Maps attributes or field names of Confluence spaces to Amazon Kendra index field names.

To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields . The Confluence data source field names must exist in your Confluence custom metadata.

Parameters:

data_source_field_name (str) – The name of the field in the data source.
index_field_name (str) – The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
date_field_format (Optional[str]) – The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

See:

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

confluence_space_to_index_field_mapping_property = kendra.CfnDataSource.ConfluenceSpaceToIndexFieldMappingProperty(
    data_source_field_name="dataSourceFieldName",
    index_field_name="indexFieldName",

    # the properties below are optional
    date_field_format="dateFieldFormat"
)

Attributes

data_source_field_name

The name of the field in the data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencespacetoindexfieldmapping.html#cfn-kendra-datasource-confluencespacetoindexfieldmapping-datasourcefieldname

date_field_format

The format for date fields in the data source.

If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencespacetoindexfieldmapping.html#cfn-kendra-datasource-confluencespacetoindexfieldmapping-datefieldformat

index_field_name

The name of the index field to map to the Confluence data source field.

The index field type must match the Confluence field type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencespacetoindexfieldmapping.html#cfn-kendra-datasource-confluencespacetoindexfieldmapping-indexfieldname

ConnectionConfigurationProperty

class CfnDataSource.ConnectionConfigurationProperty(*, database_host, database_name, database_port, secret_arn, table_name)

Bases: object

Provides the configuration information that’s required to connect to a database.

Parameters:

database_host (str) – The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.
database_name (str) – The name of the database containing the document data.
database_port (Union[int, float]) – The port that the database uses for connections.
secret_arn (str) – The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that stores the credentials. The credentials should be a user-password pair. For more information, see Using a Database Data Source . For more information about AWS Secrets Manager , see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
table_name (str) – The name of the table that contains the document data.

See:

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

connection_configuration_property = kendra.CfnDataSource.ConnectionConfigurationProperty(
    database_host="databaseHost",
    database_name="databaseName",
    database_port=123,
    secret_arn="secretArn",
    table_name="tableName"
)

Attributes

database_host

The name of the host for the database.

Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-connectionconfiguration.html#cfn-kendra-datasource-connectionconfiguration-databasehost

database_name

The name of the database containing the document data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-connectionconfiguration.html#cfn-kendra-datasource-connectionconfiguration-databasename

database_port

The port that the database uses for connections.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-connectionconfiguration.html#cfn-kendra-datasource-connectionconfiguration-databaseport

secret_arn

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that stores the credentials.

The credentials should be a user-password pair. For more information, see Using a Database Data Source . For more information about AWS Secrets Manager , see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-connectionconfiguration.html#cfn-kendra-datasource-connectionconfiguration-secretarn

table_name

The name of the table that contains the document data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-connectionconfiguration.html#cfn-kendra-datasource-connectionconfiguration-tablename

CustomDocumentEnrichmentConfigurationProperty

class CfnDataSource.CustomDocumentEnrichmentConfigurationProperty(*, inline_configurations=None, post_extraction_hook_configuration=None, pre_extraction_hook_configuration=None, role_arn=None)

Bases: object

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

For more information, see Customizing document metadata during the ingestion process .

Parameters:

inline_configurations (Union[IResolvable, Sequence[Union[IResolvable, InlineCustomDocumentEnrichmentConfigurationProperty, Dict[str, Any]]], None]) – Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
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 Advanced data manipulation .
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 Advanced data manipulation .
role_arn (Optional[str]) – The Amazon Resource Name (ARN) of an IAM role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process. For more information, see an IAM roles for Amazon Kendra .

See:

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

custom_document_enrichment_configuration_property = 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"
)

Attributes

inline_configurations

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-customdocumentenrichmentconfiguration.html#cfn-kendra-datasource-customdocumentenrichmentconfiguration-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 Advanced data manipulation .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-customdocumentenrichmentconfiguration.html#cfn-kendra-datasource-customdocumentenrichmentconfiguration-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 Advanced data manipulation .

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

role_arn

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

For more information, see an IAM roles for Amazon Kendra .

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

DataSourceConfigurationProperty

class CfnDataSource.DataSourceConfigurationProperty(*, confluence_configuration=None, database_configuration=None, google_drive_configuration=None, one_drive_configuration=None, s3_configuration=None, salesforce_configuration=None, service_now_configuration=None, share_point_configuration=None, template_configuration=None, web_crawler_configuration=None, work_docs_configuration=None)

Bases: object

Provides the configuration information for an Amazon Kendra data source.

Parameters:

confluence_configuration (Union[IResolvable, ConfluenceConfigurationProperty, Dict[str, Any], None]) – Provides the configuration information to connect to Confluence as your data source.
database_configuration (Union[IResolvable, DatabaseConfigurationProperty, Dict[str, Any], None]) – Provides the configuration information to connect to a database as your data source.
google_drive_configuration (Union[IResolvable, GoogleDriveConfigurationProperty, Dict[str, Any], None]) – Provides the configuration information to connect to Google Drive as your data source.
one_drive_configuration (Union[IResolvable, OneDriveConfigurationProperty, Dict[str, Any], None]) – Provides the configuration information to connect to Microsoft OneDrive as your data source.
s3_configuration (Union[IResolvable, S3DataSourceConfigurationProperty, Dict[str, Any], None]) – Provides the configuration information to connect to an Amazon S3 bucket as your data source. .. epigraph:: Amazon Kendra now supports an upgraded Amazon S3 connector. You must now use the TemplateConfiguration object instead of the S3DataSourceConfiguration object to configure your connector. Connectors configured using the older console and API architecture will continue to function as configured. However, you won’t be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector. We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.
salesforce_configuration (Union[IResolvable, SalesforceConfigurationProperty, Dict[str, Any], None]) – Provides the configuration information to connect to Salesforce as your data source.
service_now_configuration (Union[IResolvable, ServiceNowConfigurationProperty, Dict[str, Any], None]) – Provides the configuration information to connect to ServiceNow as your data source.
share_point_configuration (Union[IResolvable, SharePointConfigurationProperty, Dict[str, Any], None]) – Provides the configuration information to connect to Microsoft SharePoint as your data source.
template_configuration (Union[IResolvable, TemplateConfigurationProperty, Dict[str, Any], None]) –
web_crawler_configuration (Union[IResolvable, WebCrawlerConfigurationProperty, Dict[str, Any], None]) – Provides the configuration information required for Amazon Kendra Web Crawler.
work_docs_configuration (Union[IResolvable, WorkDocsConfigurationProperty, Dict[str, Any], None]) – Provides the configuration information to connect to Amazon WorkDocs as your data source.

See:

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

data_source_configuration_property = 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
    )
)

Attributes

confluence_configuration

Provides the configuration information to connect to Confluence as your data source.

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

database_configuration

Provides the configuration information to connect to a database as your data source.

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

google_drive_configuration

Provides the configuration information to connect to Google Drive as your data source.

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

one_drive_configuration

Provides the configuration information to connect to Microsoft OneDrive as your data source.

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

s3_configuration

Provides the configuration information to connect to an Amazon S3 bucket as your data source.

Amazon Kendra now supports an upgraded Amazon S3 connector.

You must now use the TemplateConfiguration object instead of the S3DataSourceConfiguration object to configure your connector.

Connectors configured using the older console and API architecture will continue to function as configured. However, you won’t be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.

We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.

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

salesforce_configuration

Provides the configuration information to connect to Salesforce as your data source.

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

service_now_configuration

Provides the configuration information to connect to ServiceNow as your data source.

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

share_point_configuration

Provides the configuration information to connect to Microsoft SharePoint as your data source.

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

template_configuration

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

Type:: see

web_crawler_configuration

Provides the configuration information required for Amazon Kendra Web Crawler.

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

work_docs_configuration

Provides the configuration information to connect to Amazon WorkDocs as your data source.

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

DataSourceToIndexFieldMappingProperty

class CfnDataSource.DataSourceToIndexFieldMappingProperty(*, data_source_field_name, index_field_name, date_field_format=None)

Bases: object

Maps a column or attribute in the data source to an index field.

You must first create the fields in the index using the UpdateIndex operation.

Parameters:

data_source_field_name (str) – The name of the field in the data source. You must first create the index field using the UpdateIndex API.
index_field_name (str) – The name of the index field to map to the data source field. The index field type must match the data source field type.
date_field_format (Optional[str]) – The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown.

See:

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

data_source_to_index_field_mapping_property = kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
    data_source_field_name="dataSourceFieldName",
    index_field_name="indexFieldName",

    # the properties below are optional
    date_field_format="dateFieldFormat"
)

Attributes

data_source_field_name

The name of the field in the data source.

You must first create the index field using the UpdateIndex API.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcetoindexfieldmapping.html#cfn-kendra-datasource-datasourcetoindexfieldmapping-datasourcefieldname

date_field_format

The format for date fields in the data source.

If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcetoindexfieldmapping.html#cfn-kendra-datasource-datasourcetoindexfieldmapping-datefieldformat

index_field_name

The name of the index field to map to the data source field.

The index field type must match the data source field type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcetoindexfieldmapping.html#cfn-kendra-datasource-datasourcetoindexfieldmapping-indexfieldname

DataSourceVpcConfigurationProperty

class CfnDataSource.DataSourceVpcConfigurationProperty(*, security_group_ids, subnet_ids)

Bases: object

Provides the configuration information to connect to an Amazon VPC.

Parameters:

security_group_ids (Sequence[str]) – A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.
subnet_ids (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-kendra-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 import aws_kendra as kendra

data_source_vpc_configuration_property = kendra.CfnDataSource.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 Kendra to connect to the data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcevpcconfiguration.html#cfn-kendra-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-kendra-datasource-datasourcevpcconfiguration.html#cfn-kendra-datasource-datasourcevpcconfiguration-subnetids

DatabaseConfigurationProperty

class CfnDataSource.DatabaseConfigurationProperty(*, column_configuration, connection_configuration, database_engine_type, acl_configuration=None, sql_configuration=None, vpc_configuration=None)

Bases: object

Provides the configuration information to an Amazon Kendra supported database .

Parameters:

column_configuration (Union[IResolvable, ColumnConfigurationProperty, Dict[str, Any]]) – Information about where the index should get the document information from the database.
connection_configuration (Union[IResolvable, ConnectionConfigurationProperty, Dict[str, Any]]) – Configuration information that’s required to connect to a database.
database_engine_type (str) – The type of database engine that runs the database.
acl_configuration (Union[IResolvable, AclConfigurationProperty, Dict[str, Any], None]) – Information about the database column that provides information for user context filtering.
sql_configuration (Union[IResolvable, SqlConfigurationProperty, Dict[str, Any], None]) – Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
vpc_configuration (Union[IResolvable, DataSourceVpcConfigurationProperty, Dict[str, Any], None]) – Provides information for connecting to an Amazon VPC.

See:

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

database_configuration_property = 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"]
    )
)

Attributes

acl_configuration

Information about the database column that provides information for user context filtering.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html#cfn-kendra-datasource-databaseconfiguration-aclconfiguration

column_configuration

Information about where the index should get the document information from the database.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html#cfn-kendra-datasource-databaseconfiguration-columnconfiguration

connection_configuration

Configuration information that’s required to connect to a database.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html#cfn-kendra-datasource-databaseconfiguration-connectionconfiguration

database_engine_type

The type of database engine that runs the database.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html#cfn-kendra-datasource-databaseconfiguration-databaseenginetype

sql_configuration

Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html#cfn-kendra-datasource-databaseconfiguration-sqlconfiguration

vpc_configuration

Provides information for connecting to an Amazon VPC.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html#cfn-kendra-datasource-databaseconfiguration-vpcconfiguration

DocumentAttributeConditionProperty

class CfnDataSource.DocumentAttributeConditionProperty(*, condition_document_attribute_key, operator, condition_on_value=None)

Bases: object

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

You use this with DocumentAttributeTarget 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 Kendra cannot 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 Kendra then will map your newly created metadata field to your index field.

Parameters:

condition_document_attribute_key (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 Kendra currently does not support _document_body as an attribute key used for the condition.
operator (str) – The condition operator. For example, you can use ‘Contains’ to partially match a string.
condition_on_value (Union[IResolvable, DocumentAttributeValueProperty, Dict[str, Any], None]) – The value used by the operator. For example, you can specify the value ‘financial’ for strings in the ‘Source_URI’ field that partially match or contain this value.

See:

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

document_attribute_condition_property = 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"
    )
)

Attributes

condition_document_attribute_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 Kendra 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-kendra-datasource-documentattributecondition.html#cfn-kendra-datasource-documentattributecondition-conditiondocumentattributekey

condition_on_value

The value used by the operator.

For example, you can specify the value ‘financial’ for strings in the ‘Source_URI’ field that partially match or contain this value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributecondition.html#cfn-kendra-datasource-documentattributecondition-conditiononvalue

operator

The condition operator.

For example, you can use ‘Contains’ to partially match a string.

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

DocumentAttributeTargetProperty

class CfnDataSource.DocumentAttributeTargetProperty(*, target_document_attribute_key, target_document_attribute_value=None, target_document_attribute_value_deletion=None)

Bases: object

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

For example, you can delete customer identification numbers associated with the documents, stored in the document metadata field called ‘Customer_ID’. You set 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 Kendra cannot 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 Kendra then will map your newly created metadata field to your index field.

You can also use this with DocumentAttributeCondition .

Parameters:

target_document_attribute_key (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.
target_document_attribute_value (Union[IResolvable, DocumentAttributeValueProperty, Dict[str, Any], None]) – The target value you want to create for the target attribute. For example, ‘Finance’ could be the target value for the target attribute key ‘Department’.
target_document_attribute_value_deletion (Union[bool, IResolvable, None]) – TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE . To create a target value ( TargetDocumentAttributeValue ), set this to FALSE .

See:

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

document_attribute_target_property = 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
)

Attributes

target_document_attribute_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-kendra-datasource-documentattributetarget.html#cfn-kendra-datasource-documentattributetarget-targetdocumentattributekey

target_document_attribute_value

The target value you want to create for the target attribute.

For example, ‘Finance’ could be the target value for the target attribute key ‘Department’.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributetarget.html#cfn-kendra-datasource-documentattributetarget-targetdocumentattributevalue

target_document_attribute_value_deletion

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

You cannot create a target value and set this to TRUE . To create a target value ( TargetDocumentAttributeValue ), set this to FALSE .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributetarget.html#cfn-kendra-datasource-documentattributetarget-targetdocumentattributevaluedeletion

DocumentAttributeValueProperty

class CfnDataSource.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 is 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. The default maximum length or number of strings is 10.
string_value (Optional[str]) – A string, such as “department”.

See:

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

document_attribute_value_property = kendra.CfnDataSource.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 is 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-kendra-datasource-documentattributevalue.html#cfn-kendra-datasource-documentattributevalue-datevalue

long_value

A long integer value.

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

string_list_value

A list of strings.

The default maximum length or number of strings is 10.

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

string_value

A string, such as “department”.

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

DocumentsMetadataConfigurationProperty

class CfnDataSource.DocumentsMetadataConfigurationProperty(*, s3_prefix=None)

Bases: object

Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes.

Each metadata file contains metadata about a single document.

Parameters:: s3_prefix (Optional[str]) – A prefix used to filter metadata configuration files in the AWS S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix to include only the desired metadata files.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentsmetadataconfiguration.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

documents_metadata_configuration_property = kendra.CfnDataSource.DocumentsMetadataConfigurationProperty(
    s3_prefix="s3Prefix"
)

Attributes

s3_prefix

A prefix used to filter metadata configuration files in the AWS S3 bucket.

The S3 bucket might contain multiple metadata files. Use S3Prefix to include only the desired metadata files.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentsmetadataconfiguration.html#cfn-kendra-datasource-documentsmetadataconfiguration-s3prefix

GoogleDriveConfigurationProperty

class CfnDataSource.GoogleDriveConfigurationProperty(*, secret_arn, exclude_mime_types=None, exclude_shared_drives=None, exclude_user_accounts=None, exclusion_patterns=None, field_mappings=None, inclusion_patterns=None)

Bases: object

Provides the configuration information to connect to Google Drive as your data source.

Parameters:

secret_arn (str) – The Amazon Resource Name (ARN) of a AWS Secrets Manager secret that contains the credentials required to connect to Google Drive. For more information, see Using a Google Workspace Drive data source .
exclude_mime_types (Optional[Sequence[str]]) –
A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded. For a list of MIME types, see Using a Google Workspace Drive data source .
exclude_shared_drives (Optional[Sequence[str]]) – A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.
exclude_user_accounts (Optional[Sequence[str]]) – A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.
exclusion_patterns (Optional[Sequence[str]]) – A list of regular expression patterns to exclude certain items in your Google Drive, including shared drives and users’ My Drives. Items that match the patterns are excluded from the index. Items that don’t match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn’t included in the index.
field_mappings (Union[IResolvable, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty, Dict[str, Any]]], None]) –
Maps Google Drive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Google Drive fields. For more information, see Mapping data source fields . The Google Drive data source field names must exist in your Google Drive custom metadata.
inclusion_patterns (Optional[Sequence[str]]) – A list of regular expression patterns to include certain items in your Google Drive, including shared drives and users’ My Drives. Items that match the patterns are included in the index. Items that don’t match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn’t included in the index.

See:

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

google_drive_configuration_property = 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"]
)

Attributes

exclude_mime_types

A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.

For a list of MIME types, see Using a Google Workspace Drive data source .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-googledriveconfiguration.html#cfn-kendra-datasource-googledriveconfiguration-excludemimetypes

exclude_shared_drives

A list of identifiers or shared drives to exclude from the index.

All files and folders stored on the shared drive are excluded.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-googledriveconfiguration.html#cfn-kendra-datasource-googledriveconfiguration-excludeshareddrives

exclude_user_accounts

A list of email addresses of the users.

Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-googledriveconfiguration.html#cfn-kendra-datasource-googledriveconfiguration-excludeuseraccounts

exclusion_patterns

A list of regular expression patterns to exclude certain items in your Google Drive, including shared drives and users’ My Drives.

Items that match the patterns are excluded from the index. Items that don’t match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn’t included in the index.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-googledriveconfiguration.html#cfn-kendra-datasource-googledriveconfiguration-exclusionpatterns

field_mappings

Maps Google Drive data source attributes or field names to Amazon Kendra index field names.

To create custom fields, use the UpdateIndex API before you map to Google Drive fields. For more information, see Mapping data source fields . The Google Drive data source field names must exist in your Google Drive custom metadata.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-googledriveconfiguration.html#cfn-kendra-datasource-googledriveconfiguration-fieldmappings

inclusion_patterns

A list of regular expression patterns to include certain items in your Google Drive, including shared drives and users’ My Drives.

Items that match the patterns are included in the index. Items that don’t match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn’t included in the index.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-googledriveconfiguration.html#cfn-kendra-datasource-googledriveconfiguration-inclusionpatterns

secret_arn

The Amazon Resource Name (ARN) of a AWS Secrets Manager secret that contains the credentials required to connect to Google Drive.

For more information, see Using a Google Workspace Drive data source .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-googledriveconfiguration.html#cfn-kendra-datasource-googledriveconfiguration-secretarn

HookConfigurationProperty

class CfnDataSource.HookConfigurationProperty(*, lambda_arn, s3_bucket, invocation_condition=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 Kendra.

You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Kendra 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 Customizing document metadata during the ingestion process .

Parameters:

lambda_arn (str) –
The Amazon Resource Name (ARN) of an IAM role with permission to run a Lambda function during ingestion. For more information, see an IAM roles for Amazon Kendra .
s3_bucket (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 .
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 Kendra should invoke a function that inserts the current date-time.

See:

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

hook_configuration_property = 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"
        )
    )
)

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 Kendra should invoke a function that inserts the current date-time.

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

lambda_arn

The Amazon Resource Name (ARN) of an IAM role with permission to run a Lambda function during ingestion.

For more information, see an IAM roles for Amazon Kendra .

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

s3_bucket

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-kendra-datasource-hookconfiguration.html#cfn-kendra-datasource-hookconfiguration-s3bucket

InlineCustomDocumentEnrichmentConfigurationProperty

class CfnDataSource.InlineCustomDocumentEnrichmentConfigurationProperty(*, condition=None, document_content_deletion=None, target=None)

Bases: object

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

To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration .

For more information, see Customizing document metadata during the ingestion process .

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 Kendra.
document_content_deletion (Union[bool, IResolvable, None]) – 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 Kendra. You can also include a value.

See:

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

inline_custom_document_enrichment_configuration_property = 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
    )
)

Attributes

condition

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-inlinecustomdocumentenrichmentconfiguration.html#cfn-kendra-datasource-inlinecustomdocumentenrichmentconfiguration-condition

document_content_deletion

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-kendra-datasource-inlinecustomdocumentenrichmentconfiguration.html#cfn-kendra-datasource-inlinecustomdocumentenrichmentconfiguration-documentcontentdeletion

target

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

You can also include a value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-inlinecustomdocumentenrichmentconfiguration.html#cfn-kendra-datasource-inlinecustomdocumentenrichmentconfiguration-target

OneDriveConfigurationProperty

class CfnDataSource.OneDriveConfigurationProperty(*, one_drive_users, secret_arn, tenant_domain, disable_local_groups=None, exclusion_patterns=None, field_mappings=None, inclusion_patterns=None)

Bases: object

Provides the configuration information to connect to OneDrive as your data source.

Parameters:

one_drive_users (Union[IResolvable, OneDriveUsersProperty, Dict[str, Any]]) – A list of user accounts whose documents should be indexed.
secret_arn (str) – The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive. The user name should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.
tenant_domain (str) – The Azure Active Directory domain of the organization.
disable_local_groups (Union[bool, IResolvable, None]) – TRUE to disable local groups information.
exclusion_patterns (Optional[Sequence[str]]) – A list of regular expression patterns to exclude certain documents in your OneDrive. Documents that match the patterns are excluded from the index. Documents that don’t match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn’t included in the index. The pattern is applied to the file name.
field_mappings (Union[IResolvable, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty, Dict[str, Any]]], None]) –
A list of DataSourceToIndexFieldMapping objects that map OneDrive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to OneDrive fields. For more information, see Mapping data source fields . The OneDrive data source field names must exist in your OneDrive custom metadata.
inclusion_patterns (Optional[Sequence[str]]) – A list of regular expression patterns to include certain documents in your OneDrive. Documents that match the patterns are included in the index. Documents that don’t match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn’t included in the index. The pattern is applied to the file name.

See:

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

one_drive_configuration_property = 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"]
)

Attributes

disable_local_groups

TRUE to disable local groups information.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-onedriveconfiguration.html#cfn-kendra-datasource-onedriveconfiguration-disablelocalgroups

exclusion_patterns

A list of regular expression patterns to exclude certain documents in your OneDrive.

Documents that match the patterns are excluded from the index. Documents that don’t match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn’t included in the index.

The pattern is applied to the file name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-onedriveconfiguration.html#cfn-kendra-datasource-onedriveconfiguration-exclusionpatterns

field_mappings

A list of DataSourceToIndexFieldMapping objects that map OneDrive data source attributes or field names to Amazon Kendra index field names.

To create custom fields, use the UpdateIndex API before you map to OneDrive fields. For more information, see Mapping data source fields . The OneDrive data source field names must exist in your OneDrive custom metadata.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-onedriveconfiguration.html#cfn-kendra-datasource-onedriveconfiguration-fieldmappings

inclusion_patterns

A list of regular expression patterns to include certain documents in your OneDrive.

Documents that match the patterns are included in the index. Documents that don’t match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn’t included in the index.

The pattern is applied to the file name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-onedriveconfiguration.html#cfn-kendra-datasource-onedriveconfiguration-inclusionpatterns

one_drive_users

A list of user accounts whose documents should be indexed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-onedriveconfiguration.html#cfn-kendra-datasource-onedriveconfiguration-onedriveusers

secret_arn

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive.

The user name should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-onedriveconfiguration.html#cfn-kendra-datasource-onedriveconfiguration-secretarn

tenant_domain

The Azure Active Directory domain of the organization.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-onedriveconfiguration.html#cfn-kendra-datasource-onedriveconfiguration-tenantdomain

OneDriveUsersProperty

class CfnDataSource.OneDriveUsersProperty(*, one_drive_user_list=None, one_drive_user_s3_path=None)

Bases: object

User accounts whose documents should be indexed.

Parameters:

one_drive_user_list (Optional[Sequence[str]]) – A list of users whose documents should be indexed. Specify the user names in email format, for example, username@tenantdomain . If you need to index the documents of more than 10 users, use the OneDriveUserS3Path field to specify the location of a file containing a list of users.
one_drive_user_s3_path (Union[IResolvable, S3PathProperty, Dict[str, Any], None]) – The S3 bucket location of a file containing a list of users whose documents should be indexed.

See:

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

one_drive_users_property = kendra.CfnDataSource.OneDriveUsersProperty(
    one_drive_user_list=["oneDriveUserList"],
    one_drive_user_s3_path=kendra.CfnDataSource.S3PathProperty(
        bucket="bucket",
        key="key"
    )
)

Attributes

one_drive_user_list

A list of users whose documents should be indexed.

Specify the user names in email format, for example, username@tenantdomain . If you need to index the documents of more than 10 users, use the OneDriveUserS3Path field to specify the location of a file containing a list of users.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-onedriveusers.html#cfn-kendra-datasource-onedriveusers-onedriveuserlist

one_drive_user_s3_path

The S3 bucket location of a file containing a list of users whose documents should be indexed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-onedriveusers.html#cfn-kendra-datasource-onedriveusers-onedriveusers3path

ProxyConfigurationProperty

class CfnDataSource.ProxyConfigurationProperty(*, host, port, credentials=None)

Bases: object

Provides the configuration information for a web proxy to connect to website hosts.

Parameters:

host (str) – The name of the website host you want to connect to via a web proxy server. For example, the host name of https://a.example.com/page1.html is “a.example.com”.
port (Union[int, float]) – The port number of the website host you want to connect to via a web proxy server. For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
credentials (Optional[str]) – The Amazon Resource Name (ARN) of an AWS Secrets Manager secret. You create a secret to store your credentials in AWS Secrets Manager The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.

See:

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

proxy_configuration_property = kendra.CfnDataSource.ProxyConfigurationProperty(
    host="host",
    port=123,

    # the properties below are optional
    credentials="credentials"
)

Attributes

credentials

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret.

You create a secret to store your credentials in AWS Secrets Manager

The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-proxyconfiguration.html#cfn-kendra-datasource-proxyconfiguration-credentials

host

The name of the website host you want to connect to via a web proxy server.

For example, the host name of https://a.example.com/page1.html is “a.example.com”.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-proxyconfiguration.html#cfn-kendra-datasource-proxyconfiguration-host

port

The port number of the website host you want to connect to via a web proxy server.

For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-proxyconfiguration.html#cfn-kendra-datasource-proxyconfiguration-port

S3DataSourceConfigurationProperty

class CfnDataSource.S3DataSourceConfigurationProperty(*, bucket_name, access_control_list_configuration=None, documents_metadata_configuration=None, exclusion_patterns=None, inclusion_patterns=None, inclusion_prefixes=None)

Bases: object

Provides the configuration information to connect to an Amazon S3 bucket.

Amazon Kendra now supports an upgraded Amazon S3 connector.

You must now use the TemplateConfiguration object instead of the S3DataSourceConfiguration object to configure your connector.

Connectors configured using the older console and API architecture will continue to function as configured. However, you won’t be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.

We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.

Parameters:

bucket_name (str) – The name of the bucket that contains the documents.
access_control_list_configuration (Union[IResolvable, AccessControlListConfigurationProperty, Dict[str, Any], None]) – Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources .
documents_metadata_configuration (Union[IResolvable, DocumentsMetadataConfigurationProperty, Dict[str, Any], None]) – Specifies document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.
exclusion_patterns (Optional[Sequence[str]]) – A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to exclude from your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include: - - /myapp/config/** —All files inside config directory. - * /*.png* —All .png files in all directories. - * /.{png, ico, md} —All .png, .ico or .md files in all directories. - - /myapp/src/** /.ts —All .ts files inside src directory (and all its subdirectories). - * /!(*.module).ts* —All .ts files but not .module.ts - **.png , *.jpg* —All PNG and JPEG image files in a directory (files with the extensions .png and .jpg). - **internal —All files in a directory that contain ‘internal’ in the file name, such as ‘internal’, ‘internal_only’, ‘company_internal’. - * /*internal —All internal-related files in a directory and its subdirectories. For more examples, see Use of Exclude and Include Filters in the AWS CLI Command Reference.
inclusion_patterns (Optional[Sequence[str]]) –
A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to include in your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include: - - /myapp/config/** —All files inside config directory. - * /*.png* —All .png files in all directories. - * /.{png, ico, md} —All .png, .ico or .md files in all directories. - - /myapp/src/** /.ts —All .ts files inside src directory (and all its subdirectories). - * /!(*.module).ts* —All .ts files but not .module.ts - **.png , *.jpg* —All PNG and JPEG image files in a directory (files with the extensions .png and .jpg). - **internal —All files in a directory that contain ‘internal’ in the file name, such as ‘internal’, ‘internal_only’, ‘company_internal’. - * /*internal —All internal-related files in a directory and its subdirectories. For more examples, see Use of Exclude and Include Filters in the AWS CLI Command Reference.
inclusion_prefixes (Optional[Sequence[str]]) – A list of S3 prefixes for the documents that should be included in the index.

See:

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

s3_data_source_configuration_property = 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"]
)

Attributes

access_control_list_configuration

Provides the path to the S3 bucket that contains the user context filtering files for the data source.

For the format of the file, see Access control for S3 data sources .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3datasourceconfiguration.html#cfn-kendra-datasource-s3datasourceconfiguration-accesscontrollistconfiguration

bucket_name

The name of the bucket that contains the documents.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3datasourceconfiguration.html#cfn-kendra-datasource-s3datasourceconfiguration-bucketname

documents_metadata_configuration

Specifies document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes.

Each metadata file contains metadata about a single document.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3datasourceconfiguration.html#cfn-kendra-datasource-s3datasourceconfiguration-documentsmetadataconfiguration

exclusion_patterns

A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to exclude from your index.

If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:

- /myapp/config/** —All files inside config directory.
*** /.png —All .png files in all directories.
*** /.{png, ico, md} —All .png, .ico or .md files in all directories.
- /myapp/src/** /.ts —All .ts files inside src directory (and all its subdirectories).
*** /!(.module).ts —All .ts files but not .module.ts
**.png , .jpg —All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
internal —All files in a directory that contain ‘internal’ in the file name, such as ‘internal’, ‘internal_only’, ‘company_internal’.
* /*internal —All internal-related files in a directory and its subdirectories.

For more examples, see Use of Exclude and Include Filters in the AWS CLI Command Reference.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3datasourceconfiguration.html#cfn-kendra-datasource-s3datasourceconfiguration-exclusionpatterns

inclusion_patterns

A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to include in your index.

If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:

- /myapp/config/** —All files inside config directory.
*** /.png —All .png files in all directories.
*** /.{png, ico, md} —All .png, .ico or .md files in all directories.
- /myapp/src/** /.ts —All .ts files inside src directory (and all its subdirectories).
*** /!(.module).ts —All .ts files but not .module.ts
**.png , .jpg —All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
internal —All files in a directory that contain ‘internal’ in the file name, such as ‘internal’, ‘internal_only’, ‘company_internal’.
* /*internal —All internal-related files in a directory and its subdirectories.

For more examples, see Use of Exclude and Include Filters in the AWS CLI Command Reference.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3datasourceconfiguration.html#cfn-kendra-datasource-s3datasourceconfiguration-inclusionpatterns

inclusion_prefixes

A list of S3 prefixes for the documents that should be included in the index.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3datasourceconfiguration.html#cfn-kendra-datasource-s3datasourceconfiguration-inclusionprefixes

S3PathProperty

class CfnDataSource.S3PathProperty(*, bucket, key)

Bases: object

Information required to find a specific file in an Amazon S3 bucket.

Parameters:

bucket (str) – The name of the S3 bucket that contains the file.
key (str) – The name of the file.

See:

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

s3_path_property = kendra.CfnDataSource.S3PathProperty(
    bucket="bucket",
    key="key"
)

Attributes

bucket

The name of the S3 bucket that contains the file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3path.html#cfn-kendra-datasource-s3path-bucket

key

The name of the file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3path.html#cfn-kendra-datasource-s3path-key

SalesforceChatterFeedConfigurationProperty

class CfnDataSource.SalesforceChatterFeedConfigurationProperty(*, document_data_field_name, document_title_field_name=None, field_mappings=None, include_filter_types=None)

Bases: object

The configuration information for syncing a Salesforce chatter feed.

The contents of the object comes from the Salesforce FeedItem table.

Parameters:

document_data_field_name (str) – The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the Body column.
document_title_field_name (Optional[str]) – The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the Title column.
field_mappings (Union[IResolvable, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty, Dict[str, Any]]], None]) – Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
include_filter_types (Optional[Sequence[str]]) – Filters the documents in the feed based on status of the user. When you specify ACTIVE_USERS only documents from users who have an active account are indexed. When you specify STANDARD_USER only documents for Salesforce standard users are documented. You can specify both.

See:

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

salesforce_chatter_feed_configuration_property = 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"]
)

Attributes

document_data_field_name

The name of the column in the Salesforce FeedItem table that contains the content to index.

Typically this is the Body column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcechatterfeedconfiguration.html#cfn-kendra-datasource-salesforcechatterfeedconfiguration-documentdatafieldname

document_title_field_name

The name of the column in the Salesforce FeedItem table that contains the title of the document.

This is typically the Title column.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcechatterfeedconfiguration.html#cfn-kendra-datasource-salesforcechatterfeedconfiguration-documenttitlefieldname

field_mappings

Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcechatterfeedconfiguration.html#cfn-kendra-datasource-salesforcechatterfeedconfiguration-fieldmappings

include_filter_types

Filters the documents in the feed based on status of the user.

When you specify ACTIVE_USERS only documents from users who have an active account are indexed. When you specify STANDARD_USER only documents for Salesforce standard users are documented. You can specify both.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcechatterfeedconfiguration.html#cfn-kendra-datasource-salesforcechatterfeedconfiguration-includefiltertypes

SalesforceConfigurationProperty

class CfnDataSource.SalesforceConfigurationProperty(*, secret_arn, server_url, chatter_feed_configuration=None, crawl_attachments=None, exclude_attachment_file_patterns=None, include_attachment_file_patterns=None, knowledge_article_configuration=None, standard_object_attachment_configuration=None, standard_object_configurations=None)

Bases: object

Provides the configuration information to connect to Salesforce as your data source.

Parameters:

secret_arn (str) – The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys: - authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token. - consumerKey - The application public key generated when you created your Salesforce application. - consumerSecret - The application private key generated when you created your Salesforce application. - password - The password associated with the user logging in to the Salesforce instance. - securityToken - The token associated with the user logging in to the Salesforce instance. - username - The user name of the user logging in to the Salesforce instance.
server_url (str) – The instance URL for the Salesforce site that you want to index.
chatter_feed_configuration (Union[IResolvable, SalesforceChatterFeedConfigurationProperty, Dict[str, Any], None]) – Configuration information for Salesforce chatter feeds.
crawl_attachments (Union[bool, IResolvable, None]) – Indicates whether Amazon Kendra should index attachments to Salesforce objects.
exclude_attachment_file_patterns (Optional[Sequence[str]]) – A list of regular expression patterns to exclude certain documents in your Salesforce. Documents that match the patterns are excluded from the index. Documents that don’t match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn’t included in the index. The pattern is applied to the name of the attached file.
include_attachment_file_patterns (Optional[Sequence[str]]) – A list of regular expression patterns to include certain documents in your Salesforce. Documents that match the patterns are included in the index. Documents that don’t match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn’t included in the index. The pattern is applied to the name of the attached file.
knowledge_article_configuration (Union[IResolvable, SalesforceKnowledgeArticleConfigurationProperty, Dict[str, Any], None]) – Configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.
standard_object_attachment_configuration (Union[IResolvable, SalesforceStandardObjectAttachmentConfigurationProperty, Dict[str, Any], None]) – Configuration information for processing attachments to Salesforce standard objects.
standard_object_configurations (Union[IResolvable, Sequence[Union[IResolvable, SalesforceStandardObjectConfigurationProperty, Dict[str, Any]]], None]) – Configuration of the Salesforce standard objects that Amazon Kendra indexes.

See:

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

salesforce_configuration_property = 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"
        )]
    )]
)

Attributes

chatter_feed_configuration

Configuration information for Salesforce chatter feeds.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-chatterfeedconfiguration

crawl_attachments

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-crawlattachments

exclude_attachment_file_patterns

A list of regular expression patterns to exclude certain documents in your Salesforce.

Documents that match the patterns are excluded from the index. Documents that don’t match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn’t included in the index.

The pattern is applied to the name of the attached file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-excludeattachmentfilepatterns

include_attachment_file_patterns

A list of regular expression patterns to include certain documents in your Salesforce.

Documents that match the patterns are included in the index. Documents that don’t match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn’t included in the index.

The pattern is applied to the name of the attached file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-includeattachmentfilepatterns

knowledge_article_configuration

Configuration information for the knowledge article types that Amazon Kendra indexes.

Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-knowledgearticleconfiguration

secret_arn

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance.

The secret must contain a JSON structure with the following keys:

authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
consumerKey - The application public key generated when you created your Salesforce application.
consumerSecret - The application private key generated when you created your Salesforce application.
password - The password associated with the user logging in to the Salesforce instance.
securityToken - The token associated with the user logging in to the Salesforce instance.
username - The user name of the user logging in to the Salesforce instance.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-secretarn

server_url

The instance URL for the Salesforce site that you want to index.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-serverurl

standard_object_attachment_configuration

Configuration information for processing attachments to Salesforce standard objects.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-standardobjectattachmentconfiguration

standard_object_configurations

Configuration of the Salesforce standard objects that Amazon Kendra indexes.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-standardobjectconfigurations

SalesforceCustomKnowledgeArticleTypeConfigurationProperty

class CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty(*, document_data_field_name, name, document_title_field_name=None, field_mappings=None)

Bases: object

Provides the configuration information for indexing Salesforce custom articles.

Parameters:

document_data_field_name (str) – The name of the field in the custom knowledge article that contains the document data to index.
name (str) – The name of the configuration.
document_title_field_name (Optional[str]) – The name of the field in the custom knowledge article that contains the document title.
field_mappings (Union[IResolvable, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty, Dict[str, Any]]], None]) –
Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields . The Salesforce data source field names must exist in your Salesforce custom metadata.

See:

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

salesforce_custom_knowledge_article_type_configuration_property = 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"
    )]
)

Attributes

document_data_field_name

The name of the field in the custom knowledge article that contains the document data to index.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcecustomknowledgearticletypeconfiguration.html#cfn-kendra-datasource-salesforcecustomknowledgearticletypeconfiguration-documentdatafieldname

document_title_field_name

The name of the field in the custom knowledge article that contains the document title.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcecustomknowledgearticletypeconfiguration.html#cfn-kendra-datasource-salesforcecustomknowledgearticletypeconfiguration-documenttitlefieldname

field_mappings

Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names.

To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields . The Salesforce data source field names must exist in your Salesforce custom metadata.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcecustomknowledgearticletypeconfiguration.html#cfn-kendra-datasource-salesforcecustomknowledgearticletypeconfiguration-fieldmappings

name

The name of the configuration.

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

SalesforceKnowledgeArticleConfigurationProperty

class CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty(*, included_states, custom_knowledge_article_type_configurations=None, standard_knowledge_article_type_configuration=None)

Bases: object

Provides the configuration information for the knowledge article types that Amazon Kendra indexes.

Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both

Parameters:

included_states (Sequence[str]) – Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.
custom_knowledge_article_type_configurations (Union[IResolvable, Sequence[Union[IResolvable, SalesforceCustomKnowledgeArticleTypeConfigurationProperty, Dict[str, Any]]], None]) – Configuration information for custom Salesforce knowledge articles.
standard_knowledge_article_type_configuration (Union[IResolvable, SalesforceStandardKnowledgeArticleTypeConfigurationProperty, Dict[str, Any], None]) – Configuration information for standard Salesforce knowledge articles.

See:

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

salesforce_knowledge_article_configuration_property = 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"
        )]
    )
)

Attributes

custom_knowledge_article_type_configurations

Configuration information for custom Salesforce knowledge articles.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceknowledgearticleconfiguration.html#cfn-kendra-datasource-salesforceknowledgearticleconfiguration-customknowledgearticletypeconfigurations

included_states

Specifies the document states that should be included when Amazon Kendra indexes knowledge articles.

You must specify at least one state.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceknowledgearticleconfiguration.html#cfn-kendra-datasource-salesforceknowledgearticleconfiguration-includedstates

standard_knowledge_article_type_configuration

Configuration information for standard Salesforce knowledge articles.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceknowledgearticleconfiguration.html#cfn-kendra-datasource-salesforceknowledgearticleconfiguration-standardknowledgearticletypeconfiguration

SalesforceStandardKnowledgeArticleTypeConfigurationProperty

class CfnDataSource.SalesforceStandardKnowledgeArticleTypeConfigurationProperty(*, document_data_field_name, document_title_field_name=None, field_mappings=None)

Bases: object

Provides the configuration information for standard Salesforce knowledge articles.

Parameters:

document_data_field_name (str) – The name of the field that contains the document data to index.
document_title_field_name (Optional[str]) – The name of the field that contains the document title.
field_mappings (Union[IResolvable, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty, Dict[str, Any]]], None]) –
Maps attributes or field names of the knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields . The Salesforce data source field names must exist in your Salesforce custom metadata.

See:

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

salesforce_standard_knowledge_article_type_configuration_property = 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"
    )]
)

Attributes

document_data_field_name

The name of the field that contains the document data to index.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardknowledgearticletypeconfiguration.html#cfn-kendra-datasource-salesforcestandardknowledgearticletypeconfiguration-documentdatafieldname

document_title_field_name

The name of the field that contains the document title.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardknowledgearticletypeconfiguration.html#cfn-kendra-datasource-salesforcestandardknowledgearticletypeconfiguration-documenttitlefieldname

field_mappings

Maps attributes or field names of the knowledge article to Amazon Kendra index field names.

To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields . The Salesforce data source field names must exist in your Salesforce custom metadata.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardknowledgearticletypeconfiguration.html#cfn-kendra-datasource-salesforcestandardknowledgearticletypeconfiguration-fieldmappings

SalesforceStandardObjectAttachmentConfigurationProperty

class CfnDataSource.SalesforceStandardObjectAttachmentConfigurationProperty(*, document_title_field_name=None, field_mappings=None)

Bases: object

Provides the configuration information for processing attachments to Salesforce standard objects.

Parameters:

document_title_field_name (Optional[str]) – The name of the field used for the document title.
field_mappings (Union[IResolvable, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty, Dict[str, Any]]], None]) – One or more objects that map fields in attachments to Amazon Kendra index fields.

See:

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

salesforce_standard_object_attachment_configuration_property = 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"
    )]
)

Attributes

document_title_field_name

The name of the field used for the document title.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardobjectattachmentconfiguration.html#cfn-kendra-datasource-salesforcestandardobjectattachmentconfiguration-documenttitlefieldname

field_mappings

One or more objects that map fields in attachments to Amazon Kendra index fields.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardobjectattachmentconfiguration.html#cfn-kendra-datasource-salesforcestandardobjectattachmentconfiguration-fieldmappings

SalesforceStandardObjectConfigurationProperty

class CfnDataSource.SalesforceStandardObjectConfigurationProperty(*, document_data_field_name, name, document_title_field_name=None, field_mappings=None)

Bases: object

Specifies configuration information for indexing a single standard object.

Parameters:

document_data_field_name (str) – The name of the field in the standard object table that contains the document contents.
name (str) – The name of the standard object.
document_title_field_name (Optional[str]) – The name of the field in the standard object table that contains the document title.
field_mappings (Union[IResolvable, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty, Dict[str, Any]]], None]) –
Maps attributes or field names of the standard object to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields . The Salesforce data source field names must exist in your Salesforce custom metadata.

See:

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

salesforce_standard_object_configuration_property = 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"
    )]
)

Attributes

document_data_field_name

The name of the field in the standard object table that contains the document contents.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardobjectconfiguration.html#cfn-kendra-datasource-salesforcestandardobjectconfiguration-documentdatafieldname

document_title_field_name

The name of the field in the standard object table that contains the document title.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardobjectconfiguration.html#cfn-kendra-datasource-salesforcestandardobjectconfiguration-documenttitlefieldname

field_mappings

Maps attributes or field names of the standard object to Amazon Kendra index field names.

To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields . The Salesforce data source field names must exist in your Salesforce custom metadata.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardobjectconfiguration.html#cfn-kendra-datasource-salesforcestandardobjectconfiguration-fieldmappings

name

The name of the standard object.

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

ServiceNowConfigurationProperty

class CfnDataSource.ServiceNowConfigurationProperty(*, host_url, secret_arn, service_now_build_version, authentication_type=None, knowledge_article_configuration=None, service_catalog_configuration=None)

Bases: object

Provides the configuration information to connect to ServiceNow as your data source.

Parameters:

host_url (str) – The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
secret_arn (str) – The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance. You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Using a ServiceNow data source .
service_now_build_version (str) – The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS .
authentication_type (Optional[str]) –
The type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC , Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the SecretArn field. If you choose OAUTH2 , Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password. When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source .
knowledge_article_configuration (Union[IResolvable, ServiceNowKnowledgeArticleConfigurationProperty, Dict[str, Any], None]) – Configuration information for crawling knowledge articles in the ServiceNow site.
service_catalog_configuration (Union[IResolvable, ServiceNowServiceCatalogConfigurationProperty, Dict[str, Any], None]) – Configuration information for crawling service catalogs in the ServiceNow site.

See:

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

service_now_configuration_property = 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"]
    )
)

Attributes

authentication_type

The type of authentication used to connect to the ServiceNow instance.

If you choose HTTP_BASIC , Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the SecretArn field. If you choose OAUTH2 , Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password.

When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowconfiguration.html#cfn-kendra-datasource-servicenowconfiguration-authenticationtype

host_url

The ServiceNow instance that the data source connects to.

The host endpoint should look like the following: {instance}.service-now.com.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowconfiguration.html#cfn-kendra-datasource-servicenowconfiguration-hosturl

knowledge_article_configuration

Configuration information for crawling knowledge articles in the ServiceNow site.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowconfiguration.html#cfn-kendra-datasource-servicenowconfiguration-knowledgearticleconfiguration

secret_arn

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance.

You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Using a ServiceNow data source .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowconfiguration.html#cfn-kendra-datasource-servicenowconfiguration-secretarn

service_catalog_configuration

Configuration information for crawling service catalogs in the ServiceNow site.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowconfiguration.html#cfn-kendra-datasource-servicenowconfiguration-servicecatalogconfiguration

service_now_build_version

The identifier of the release that the ServiceNow host is running.

If the host is not running the LONDON release, use OTHERS .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowconfiguration.html#cfn-kendra-datasource-servicenowconfiguration-servicenowbuildversion

ServiceNowKnowledgeArticleConfigurationProperty

class CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty(*, document_data_field_name, crawl_attachments=None, document_title_field_name=None, exclude_attachment_file_patterns=None, field_mappings=None, filter_query=None, include_attachment_file_patterns=None)

Bases: object

Provides the configuration information for crawling knowledge articles in the ServiceNow site.

Parameters:

document_data_field_name (str) – The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
crawl_attachments (Union[bool, IResolvable, None]) – TRUE to index attachments to knowledge articles.
document_title_field_name (Optional[str]) – The name of the ServiceNow field that is mapped to the index document title field.
exclude_attachment_file_patterns (Optional[Sequence[str]]) – A list of regular expression patterns applied to exclude certain knowledge article attachments. Attachments that match the patterns are excluded from the index. Items that don’t match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn’t included in the index.
field_mappings (Union[IResolvable, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty, Dict[str, Any]]], None]) –
Maps attributes or field names of knoweldge articles to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to ServiceNow fields. For more information, see Mapping data source fields . The ServiceNow data source field names must exist in your ServiceNow custom metadata.
filter_query (Optional[str]) – A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private. The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query .
include_attachment_file_patterns (Optional[Sequence[str]]) – A list of regular expression patterns applied to include knowledge article attachments. Attachments that match the patterns are included in the index. Items that don’t match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn’t included in the index.

See:

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

service_now_knowledge_article_configuration_property = 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"]
)

Attributes

crawl_attachments

TRUE to index attachments to knowledge articles.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowknowledgearticleconfiguration.html#cfn-kendra-datasource-servicenowknowledgearticleconfiguration-crawlattachments

document_data_field_name

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowknowledgearticleconfiguration.html#cfn-kendra-datasource-servicenowknowledgearticleconfiguration-documentdatafieldname

document_title_field_name

The name of the ServiceNow field that is mapped to the index document title field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowknowledgearticleconfiguration.html#cfn-kendra-datasource-servicenowknowledgearticleconfiguration-documenttitlefieldname

exclude_attachment_file_patterns

A list of regular expression patterns applied to exclude certain knowledge article attachments.

Attachments that match the patterns are excluded from the index. Items that don’t match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn’t included in the index.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowknowledgearticleconfiguration.html#cfn-kendra-datasource-servicenowknowledgearticleconfiguration-excludeattachmentfilepatterns

field_mappings

Maps attributes or field names of knoweldge articles to Amazon Kendra index field names.

To create custom fields, use the UpdateIndex API before you map to ServiceNow fields. For more information, see Mapping data source fields . The ServiceNow data source field names must exist in your ServiceNow custom metadata.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowknowledgearticleconfiguration.html#cfn-kendra-datasource-servicenowknowledgearticleconfiguration-fieldmappings

filter_query

A query that selects the knowledge articles to index.

The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.

The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowknowledgearticleconfiguration.html#cfn-kendra-datasource-servicenowknowledgearticleconfiguration-filterquery

include_attachment_file_patterns

A list of regular expression patterns applied to include knowledge article attachments.

Attachments that match the patterns are included in the index. Items that don’t match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn’t included in the index.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowknowledgearticleconfiguration.html#cfn-kendra-datasource-servicenowknowledgearticleconfiguration-includeattachmentfilepatterns

ServiceNowServiceCatalogConfigurationProperty

class CfnDataSource.ServiceNowServiceCatalogConfigurationProperty(*, document_data_field_name, crawl_attachments=None, document_title_field_name=None, exclude_attachment_file_patterns=None, field_mappings=None, include_attachment_file_patterns=None)

Bases: object

Provides the configuration information for crawling service catalog items in the ServiceNow site.

Parameters:

document_data_field_name (str) – The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
crawl_attachments (Union[bool, IResolvable, None]) – TRUE to index attachments to service catalog items.
document_title_field_name (Optional[str]) – The name of the ServiceNow field that is mapped to the index document title field.
exclude_attachment_file_patterns (Optional[Sequence[str]]) – A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow. Item that match the patterns are excluded from the index. Items that don’t match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn’t included in the index. The regex is applied to the file name of the attachment.
field_mappings (Union[IResolvable, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty, Dict[str, Any]]], None]) –
Maps attributes or field names of catalogs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to ServiceNow fields. For more information, see Mapping data source fields . The ServiceNow data source field names must exist in your ServiceNow custom metadata.
include_attachment_file_patterns (Optional[Sequence[str]]) – A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow. Item that match the patterns are included in the index. Items that don’t match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn’t included in the index. The regex is applied to the file name of the attachment.

See:

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

service_now_service_catalog_configuration_property = 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"]
)

Attributes

crawl_attachments

TRUE to index attachments to service catalog items.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowservicecatalogconfiguration.html#cfn-kendra-datasource-servicenowservicecatalogconfiguration-crawlattachments

document_data_field_name

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowservicecatalogconfiguration.html#cfn-kendra-datasource-servicenowservicecatalogconfiguration-documentdatafieldname

document_title_field_name

The name of the ServiceNow field that is mapped to the index document title field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowservicecatalogconfiguration.html#cfn-kendra-datasource-servicenowservicecatalogconfiguration-documenttitlefieldname

exclude_attachment_file_patterns

A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow.

Item that match the patterns are excluded from the index. Items that don’t match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn’t included in the index.

The regex is applied to the file name of the attachment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowservicecatalogconfiguration.html#cfn-kendra-datasource-servicenowservicecatalogconfiguration-excludeattachmentfilepatterns

field_mappings

Maps attributes or field names of catalogs to Amazon Kendra index field names.

To create custom fields, use the UpdateIndex API before you map to ServiceNow fields. For more information, see Mapping data source fields . The ServiceNow data source field names must exist in your ServiceNow custom metadata.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowservicecatalogconfiguration.html#cfn-kendra-datasource-servicenowservicecatalogconfiguration-fieldmappings

include_attachment_file_patterns

A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow.

Item that match the patterns are included in the index. Items that don’t match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn’t included in the index.

The regex is applied to the file name of the attachment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowservicecatalogconfiguration.html#cfn-kendra-datasource-servicenowservicecatalogconfiguration-includeattachmentfilepatterns

SharePointConfigurationProperty

class CfnDataSource.SharePointConfigurationProperty(*, secret_arn, share_point_version, urls, crawl_attachments=None, disable_local_groups=None, document_title_field_name=None, exclusion_patterns=None, field_mappings=None, inclusion_patterns=None, ssl_certificate_s3_path=None, use_change_log=None, vpc_configuration=None)

Bases: object

Provides the configuration information to connect to Microsoft SharePoint as your data source.

Parameters:

secret_arn (str) – The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. For more information, see Microsoft SharePoint .
share_point_version (str) – The version of Microsoft SharePoint that you use.
urls (Sequence[str]) – The Microsoft SharePoint site URLs for the documents you want to index.
crawl_attachments (Union[bool, IResolvable, None]) – TRUE to index document attachments.
disable_local_groups (Union[bool, IResolvable, None]) – TRUE to disable local groups information.
document_title_field_name (Optional[str]) – The Microsoft SharePoint attribute field that contains the title of the document.
exclusion_patterns (Optional[Sequence[str]]) – A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don’t match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index. The regex is applied to the display URL of the SharePoint document.
field_mappings (Union[IResolvable, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty, Dict[str, Any]]], None]) –
A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes or fields to Amazon Kendra index fields. You must first create the index fields using the UpdateIndex operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields .
inclusion_patterns (Optional[Sequence[str]]) – A list of regular expression patterns to include certain documents in your SharePoint. Documents that match the patterns are included in the index. Documents that don’t match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn’t included in the index. The regex applies to the display URL of the SharePoint document.
ssl_certificate_s3_path (Union[IResolvable, S3PathProperty, Dict[str, Any], None]) – Information required to find a specific file in an Amazon S3 bucket.
use_change_log (Union[bool, IResolvable, None]) – TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log’s size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.
vpc_configuration (Union[IResolvable, DataSourceVpcConfigurationProperty, Dict[str, Any], None]) – Provides information for connecting to an Amazon VPC.

See:

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

share_point_configuration_property = 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"]
    )
)

Attributes

crawl_attachments

TRUE to index document attachments.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-crawlattachments

disable_local_groups

TRUE to disable local groups information.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-disablelocalgroups

document_title_field_name

The Microsoft SharePoint attribute field that contains the title of the document.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-documenttitlefieldname

exclusion_patterns

A list of regular expression patterns.

Documents that match the patterns are excluded from the index. Documents that don’t match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-exclusionpatterns

field_mappings

A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes or fields to Amazon Kendra index fields.

You must first create the index fields using the UpdateIndex operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-fieldmappings

inclusion_patterns

A list of regular expression patterns to include certain documents in your SharePoint.

Documents that match the patterns are included in the index. Documents that don’t match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn’t included in the index.

The regex applies to the display URL of the SharePoint document.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-inclusionpatterns

secret_arn

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance.

For more information, see Microsoft SharePoint .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-secretarn

share_point_version

The version of Microsoft SharePoint that you use.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-sharepointversion

ssl_certificate_s3_path

Information required to find a specific file in an Amazon S3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-sslcertificates3path

urls

The Microsoft SharePoint site URLs for the documents you want to index.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-urls

use_change_log

TRUE to use the SharePoint change log to determine which documents require updating in the index.

Depending on the change log’s size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-usechangelog

vpc_configuration

Provides information for connecting to an Amazon VPC.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-vpcconfiguration

SqlConfigurationProperty

class CfnDataSource.SqlConfigurationProperty(*, query_identifiers_enclosing_option=None)

Bases: object

Provides information that configures Amazon Kendra to use a SQL database.

Parameters:: query_identifiers_enclosing_option (Optional[str]) – Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (”) when making a database query. You can set the value to DOUBLE_QUOTES or NONE . By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes. PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character’s case. For MySQL databases, you must enable the ansi_quotes option when you set this field to DOUBLE_QUOTES .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sqlconfiguration.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

sql_configuration_property = kendra.CfnDataSource.SqlConfigurationProperty(
    query_identifiers_enclosing_option="queryIdentifiersEnclosingOption"
)

Attributes

query_identifiers_enclosing_option

Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (”) when making a database query.

You can set the value to DOUBLE_QUOTES or NONE .

By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.

PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character’s case.

For MySQL databases, you must enable the ansi_quotes option when you set this field to DOUBLE_QUOTES .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sqlconfiguration.html#cfn-kendra-datasource-sqlconfiguration-queryidentifiersenclosingoption

TemplateConfigurationProperty

class CfnDataSource.TemplateConfigurationProperty(*, template)

Bases: object

Parameters:: template (str) –
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-templateconfiguration.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

template_configuration_property = kendra.CfnDataSource.TemplateConfigurationProperty(
    template="template"
)

Attributes

template

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-templateconfiguration.html#cfn-kendra-datasource-templateconfiguration-template

Type:: see

WebCrawlerAuthenticationConfigurationProperty

class CfnDataSource.WebCrawlerAuthenticationConfigurationProperty(*, basic_authentication=None)

Bases: object

Provides the configuration information to connect to websites that require user authentication.

Parameters:: basic_authentication (Union[IResolvable, Sequence[Union[IResolvable, WebCrawlerBasicAuthenticationProperty, Dict[str, Any]]], None]) – The list of configuration information that’s required to connect to and crawl a website host using basic authentication credentials. The list includes the name and port number of the website host.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerauthenticationconfiguration.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

web_crawler_authentication_configuration_property = kendra.CfnDataSource.WebCrawlerAuthenticationConfigurationProperty(
    basic_authentication=[kendra.CfnDataSource.WebCrawlerBasicAuthenticationProperty(
        credentials="credentials",
        host="host",
        port=123
    )]
)

Attributes

basic_authentication

The list of configuration information that’s required to connect to and crawl a website host using basic authentication credentials.

The list includes the name and port number of the website host.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerauthenticationconfiguration.html#cfn-kendra-datasource-webcrawlerauthenticationconfiguration-basicauthentication

WebCrawlerBasicAuthenticationProperty

class CfnDataSource.WebCrawlerBasicAuthenticationProperty(*, credentials, host, port)

Bases: object

Provides the configuration information to connect to websites that require basic user authentication.

Parameters:

credentials (str) –
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret. You create a secret to store your credentials in AWS Secrets Manager You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.
host (str) – The name of the website host you want to connect to using authentication credentials. For example, the host name of https://a.example.com/page1.html is “a.example.com”.
port (Union[int, float]) – The port number of the website host you want to connect to using authentication credentials. For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

See:

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

web_crawler_basic_authentication_property = kendra.CfnDataSource.WebCrawlerBasicAuthenticationProperty(
    credentials="credentials",
    host="host",
    port=123
)

Attributes

credentials

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret.

You create a secret to store your credentials in AWS Secrets Manager

You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerbasicauthentication.html#cfn-kendra-datasource-webcrawlerbasicauthentication-credentials

host

The name of the website host you want to connect to using authentication credentials.

For example, the host name of https://a.example.com/page1.html is “a.example.com”.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerbasicauthentication.html#cfn-kendra-datasource-webcrawlerbasicauthentication-host

port

The port number of the website host you want to connect to using authentication credentials.

For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerbasicauthentication.html#cfn-kendra-datasource-webcrawlerbasicauthentication-port

WebCrawlerConfigurationProperty

class CfnDataSource.WebCrawlerConfigurationProperty(*, urls, authentication_configuration=None, crawl_depth=None, max_content_size_per_page_in_mega_bytes=None, max_links_per_page=None, max_urls_per_minute_crawl_rate=None, proxy_configuration=None, url_exclusion_patterns=None, url_inclusion_patterns=None)

Bases: object

Provides the configuration information required for Amazon Kendra Web Crawler.

Parameters:

urls (Union[IResolvable, WebCrawlerUrlsProperty, Dict[str, Any]]) – Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl. You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs. You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling. When selecting websites to index, you must adhere to the `Amazon Acceptable Use Policy <https://docs.aws.amazon.com/aup/>`_ and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index.
authentication_configuration (Union[IResolvable, WebCrawlerAuthenticationConfigurationProperty, Dict[str, Any], None]) –
Configuration information required to connect to websites using authentication. You can connect to websites using basic authentication of user name and password. You use a secret in AWS Secrets Manager to store your authentication credentials. You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is “a.example.com” and the port is 443, the standard port for HTTPS.
crawl_depth (Union[int, float, None]) – The ‘depth’ or number of levels from the seed level to crawl. For example, the seed URL page is depth 1 and any hyperlinks on this page that are also crawled are depth 2.
max_content_size_per_page_in_mega_bytes (Union[int, float, None]) – The maximum size (in MB) of a web page or attachment to crawl. Files larger than this size (in MB) are skipped/not crawled. The default maximum size of a web page or attachment is set to 50 MB.
max_links_per_page (Union[int, float, None]) – The maximum number of URLs on a web page to include when crawling a website. This number is per web page. As a website’s web pages are crawled, any URLs the web pages link to are also crawled. URLs on a web page are crawled in order of appearance. The default maximum links per page is 100.
max_urls_per_minute_crawl_rate (Union[int, float, None]) – The maximum number of URLs crawled per website host per minute. A minimum of one URL is required. The default maximum number of URLs crawled per website host per minute is 300.
proxy_configuration (Union[IResolvable, ProxyConfigurationProperty, Dict[str, Any], None]) –
Configuration information required to connect to your internal websites via a web proxy. You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is “a.example.com” and the port is 443, the standard port for HTTPS. Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in AWS Secrets Manager .
url_exclusion_patterns (Optional[Sequence[str]]) – A list of regular expression patterns to exclude certain URLs to crawl. URLs that match the patterns are excluded from the index. URLs that don’t match the patterns are included in the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn’t included in the index.
url_inclusion_patterns (Optional[Sequence[str]]) – A list of regular expression patterns to include certain URLs to crawl. URLs that match the patterns are included in the index. URLs that don’t match the patterns are excluded from the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn’t included in the index.

See:

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

web_crawler_configuration_property = 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"]
)

Attributes

authentication_configuration

Configuration information required to connect to websites using authentication.

You can connect to websites using basic authentication of user name and password. You use a secret in AWS Secrets Manager to store your authentication credentials.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is “a.example.com” and the port is 443, the standard port for HTTPS.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerconfiguration.html#cfn-kendra-datasource-webcrawlerconfiguration-authenticationconfiguration

crawl_depth

The ‘depth’ or number of levels from the seed level to crawl.

For example, the seed URL page is depth 1 and any hyperlinks on this page that are also crawled are depth 2.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerconfiguration.html#cfn-kendra-datasource-webcrawlerconfiguration-crawldepth

max_content_size_per_page_in_mega_bytes

The maximum size (in MB) of a web page or attachment to crawl.

Files larger than this size (in MB) are skipped/not crawled.

The default maximum size of a web page or attachment is set to 50 MB.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerconfiguration.html#cfn-kendra-datasource-webcrawlerconfiguration-maxcontentsizeperpageinmegabytes

max_links_per_page

The maximum number of URLs on a web page to include when crawling a website.

This number is per web page.

As a website’s web pages are crawled, any URLs the web pages link to are also crawled. URLs on a web page are crawled in order of appearance.

The default maximum links per page is 100.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerconfiguration.html#cfn-kendra-datasource-webcrawlerconfiguration-maxlinksperpage

max_urls_per_minute_crawl_rate

The maximum number of URLs crawled per website host per minute.

A minimum of one URL is required.

The default maximum number of URLs crawled per website host per minute is 300.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerconfiguration.html#cfn-kendra-datasource-webcrawlerconfiguration-maxurlsperminutecrawlrate

proxy_configuration

Configuration information required to connect to your internal websites via a web proxy.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is “a.example.com” and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in AWS Secrets Manager .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerconfiguration.html#cfn-kendra-datasource-webcrawlerconfiguration-proxyconfiguration

url_exclusion_patterns

A list of regular expression patterns to exclude certain URLs to crawl.

URLs that match the patterns are excluded from the index. URLs that don’t match the patterns are included in the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn’t included in the index.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerconfiguration.html#cfn-kendra-datasource-webcrawlerconfiguration-urlexclusionpatterns

url_inclusion_patterns

A list of regular expression patterns to include certain URLs to crawl.

URLs that match the patterns are included in the index. URLs that don’t match the patterns are excluded from the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn’t included in the index.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerconfiguration.html#cfn-kendra-datasource-webcrawlerconfiguration-urlinclusionpatterns

urls

Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.

You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.

You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.

When selecting websites to index, you must adhere to the `Amazon Acceptable Use Policy <https://docs.aws.amazon.com/aup/>`_ and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerconfiguration.html#cfn-kendra-datasource-webcrawlerconfiguration-urls

WebCrawlerSeedUrlConfigurationProperty

class CfnDataSource.WebCrawlerSeedUrlConfigurationProperty(*, seed_urls, web_crawler_mode=None)

Bases: object

Provides the configuration information of the seed or starting point URLs to crawl.

When selecting websites to index, you must adhere to the `Amazon Acceptable Use Policy <https://docs.aws.amazon.com/aup/>`_ and all other Amazon terms. Remember that you must only use the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.

Parameters:

seed_urls (Sequence[str]) – The list of seed or starting point URLs of the websites you want to crawl. The list can include a maximum of 100 seed URLs.
web_crawler_mode (Optional[str]) – You can choose one of the following modes:. - HOST_ONLY —crawl only the website host names. For example, if the seed URL is “abc.example.com”, then only URLs with host name “abc.example.com” are crawled. - SUBDOMAINS —crawl the website host names with subdomains. For example, if the seed URL is “abc.example.com”, then “a.abc.example.com” and “b.abc.example.com” are also crawled. - EVERYTHING —crawl the website host names with subdomains and other domains that the web pages link to. The default mode is set to HOST_ONLY .

See:

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

web_crawler_seed_url_configuration_property = kendra.CfnDataSource.WebCrawlerSeedUrlConfigurationProperty(
    seed_urls=["seedUrls"],

    # the properties below are optional
    web_crawler_mode="webCrawlerMode"
)

Attributes

seed_urls

The list of seed or starting point URLs of the websites you want to crawl.

The list can include a maximum of 100 seed URLs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerseedurlconfiguration.html#cfn-kendra-datasource-webcrawlerseedurlconfiguration-seedurls

web_crawler_mode

.

HOST_ONLY —crawl only the website host names. For example, if the seed URL is “abc.example.com”, then only URLs with host name “abc.example.com” are crawled.
SUBDOMAINS —crawl the website host names with subdomains. For example, if the seed URL is “abc.example.com”, then “a.abc.example.com” and “b.abc.example.com” are also crawled.
EVERYTHING —crawl the website host names with subdomains and other domains that the web pages link to.

The default mode is set to HOST_ONLY .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerseedurlconfiguration.html#cfn-kendra-datasource-webcrawlerseedurlconfiguration-webcrawlermode
Type:: You can choose one of the following modes

WebCrawlerSiteMapsConfigurationProperty

class CfnDataSource.WebCrawlerSiteMapsConfigurationProperty(*, site_maps)

Bases: object

Provides the configuration information of the sitemap URLs to crawl.

When selecting websites to index, you must adhere to the `Amazon Acceptable Use Policy <https://docs.aws.amazon.com/aup/>`_ and all other Amazon terms. Remember that you must only use the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.

Parameters:: site_maps (Sequence[str]) – The list of sitemap URLs of the websites you want to crawl. The list can include a maximum of three sitemap URLs.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlersitemapsconfiguration.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

web_crawler_site_maps_configuration_property = kendra.CfnDataSource.WebCrawlerSiteMapsConfigurationProperty(
    site_maps=["siteMaps"]
)

Attributes

site_maps

The list of sitemap URLs of the websites you want to crawl.

The list can include a maximum of three sitemap URLs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlersitemapsconfiguration.html#cfn-kendra-datasource-webcrawlersitemapsconfiguration-sitemaps

WebCrawlerUrlsProperty

class CfnDataSource.WebCrawlerUrlsProperty(*, seed_url_configuration=None, site_maps_configuration=None)

Bases: object

Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.

You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.

You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.

When selecting websites to index, you must adhere to the `Amazon Acceptable Use Policy <https://docs.aws.amazon.com/aup/>`_ and all other Amazon terms. Remember that you must only use the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.

Parameters:

seed_url_configuration (Union[IResolvable, WebCrawlerSeedUrlConfigurationProperty, Dict[str, Any], None]) – Configuration of the seed or starting point URLs of the websites you want to crawl. You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the web pages link to. You can list up to 100 seed URLs.
site_maps_configuration (Union[IResolvable, WebCrawlerSiteMapsConfigurationProperty, Dict[str, Any], None]) – Configuration of the sitemap URLs of the websites you want to crawl. Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.

See:

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

web_crawler_urls_property = 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"]
    )
)

Attributes

seed_url_configuration

Configuration of the seed or starting point URLs of the websites you want to crawl.

You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the web pages link to.

You can list up to 100 seed URLs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerurls.html#cfn-kendra-datasource-webcrawlerurls-seedurlconfiguration

site_maps_configuration

Configuration of the sitemap URLs of the websites you want to crawl.

Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerurls.html#cfn-kendra-datasource-webcrawlerurls-sitemapsconfiguration

WorkDocsConfigurationProperty

class CfnDataSource.WorkDocsConfigurationProperty(*, organization_id, crawl_comments=None, exclusion_patterns=None, field_mappings=None, inclusion_patterns=None, use_change_log=None)

Bases: object

Provides the configuration information to connect to Amazon WorkDocs as your data source.

Amazon WorkDocs connector is available in Oregon, North Virginia, Sydney, Singapore and Ireland regions.

Parameters:

organization_id (str) – The identifier of the directory corresponding to your Amazon WorkDocs site repository. You can find the organization ID in the AWS Directory Service by going to Active Directory , then Directories . Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the AWS Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.
crawl_comments (Union[bool, IResolvable, None]) – TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on. The default is set to FALSE .
exclusion_patterns (Optional[Sequence[str]]) – A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.
field_mappings (Union[IResolvable, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty, Dict[str, Any]]], None]) –
A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields . The Amazon WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.
inclusion_patterns (Optional[Sequence[str]]) – A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don’t match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.
use_change_log (Union[bool, IResolvable, None]) – TRUE to use the Amazon WorkDocs change log to determine which documents require updating in the index. Depending on the change log’s size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Amazon WorkDocs.

See:

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

work_docs_configuration_property = 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
)

Attributes

crawl_comments

TRUE to include comments on documents in your index.

Including comments in your index means each comment is a document that can be searched on.

The default is set to FALSE .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-workdocsconfiguration.html#cfn-kendra-datasource-workdocsconfiguration-crawlcomments

exclusion_patterns

A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository.

Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-workdocsconfiguration.html#cfn-kendra-datasource-workdocsconfiguration-exclusionpatterns

field_mappings

A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names.

To create custom fields, use the UpdateIndex API before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields . The Amazon WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-workdocsconfiguration.html#cfn-kendra-datasource-workdocsconfiguration-fieldmappings

inclusion_patterns

A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository.

Files that match the patterns are included in the index. Files that don’t match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-workdocsconfiguration.html#cfn-kendra-datasource-workdocsconfiguration-inclusionpatterns

organization_id

The identifier of the directory corresponding to your Amazon WorkDocs site repository.

You can find the organization ID in the AWS Directory Service by going to Active Directory , then Directories . Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the AWS Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-workdocsconfiguration.html#cfn-kendra-datasource-workdocsconfiguration-organizationid

use_change_log

TRUE to use the Amazon WorkDocs change log to determine which documents require updating in the index.

Depending on the change log’s size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Amazon WorkDocs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-workdocsconfiguration.html#cfn-kendra-datasource-workdocsconfiguration-usechangelog