Query

aws::kendra-data-source

Creates a Data Source.

Example

aws::kendra-data-source data-source-example-s3
    name: "s3-ex"
    description: "s3-desc"
    index: $(aws::kendra-index index-example-enter)
    role: "arn:aws:iam::242040583208:role/service-role/AmazonKendra-s3"
    schedule: 'cron(0 11 * * ? *)'
    type: S3

    configuration
        s3-configuration
            bucket: "example-kendra"

            exclusion-patterns: [
                "example_pattern"
            ]

            inclusion-prefixes: [
                "example_pattern"
            ]
        end
    end

    tags: {
        "example-key": "example-value"
    }
end

Attributes

Attribute	Description
name	The name of the data source. (Required)
description	The description of the data source.
index	The index that should be associated with this data source. (Required)
role	The role with permission to access the data source. (Required)
schedule	The frequency that Amazon Kendra will check the documents in your repository and update the index. (Required)
type	The type of repository that contains the data source. Valid values are S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE or SERVICENOW. (Required)
configuration subresource	The data source connector configuration information required to access the repository. (Required) database-configuration subresource The information necessary to create a data source connector for a database. Cannot be set if any of one-drive-configuration, s3-configuration, salesforce-configuration, service-now-configuration or share-point-configuration is set. engine-type The type of database engine that runs the database. Valid values are RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL or RDS_POSTGRESQL. (Required) acl-configuration subresource The information about the database column that provides information for user context filtering. allowed-groups-column-name A list of groups, separated by semi-colons, that filters a query response based on user context. (Required) column-configuration subresource The information about where the index should get the document information from the database. (Required) document-data-column-name The column that contains the contents of the document. (Required) document-id-column-name The column that provides the document’s unique identifier. (Required) document-title-column-name The column that contains the title of the document. change-detecting-columns list The columns that indicate when a document in the database has changed. Maximum allowed items are 5. (Required) field-mapping list subresource The list of objects that map database column names to the corresponding fields in an index. data-source-field-name The name of the column or attribute in the data source. (Required) date-field-format The type of data stored in the column or attribute. index-field-name The name of the field in the index. (Required) connection-configuration subresource The information necessary to connect to a database. (Required) database-host The name of the host for the database. (Required) database-name The name of the database containing the document data. (Required) database-port The port that the database uses for connections. (Required) secret The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. (Required) table-name The name of the table that contains the document data. (Required) sql-configuration subresource The information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source. query-identifiers-enclosing-option Determines whether SQL identifiers for tables and column names are enclosed in double quotes (”) when making a database query. Valid values are DOUBLE_QUOTES or NONE. (Required) vpc-configuration subresource The value of the VpcConfiguration property for this object. subnets list The list of identifiers of subnets within your Amazon VPC. (Required) security-groups list The list of identifiers of security groups within your Amazon VPC. (Required) one-drive-configuration subresource The configuration for data sources that connect to Microsoft OneDrive. Cannot be set if any of database-configuration, s3-configuration, salesforce-configuration, service-now-configuration or share-point-configuration is set. exclusion-patterns list List of regular expression patterns to exclude. inclusion-patterns list List of regular expression patterns to include. secret The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive. (Required) tenant-domain Tha Azure Active Directory domain of the organization. (Required) field-mapping list subresource The list of objects that map Microsoft OneDrive fields to custom fields in the Amazon Kendra index. data-source-field-name The name of the column or attribute in the data source. (Required) date-field-format The type of data stored in the column or attribute. index-field-name The name of the field in the index. (Required) users subresource The list of user accounts whose documents should be indexed. (Required) user-list list The list of users whose documents should be indexed. Cannot be set if path is set. path subresource The S3 bucket location of a file containing a list of users whose documents should be indexed. Cannot be set if user-list is set. bucket The S3 bucket that contains the file. (Required) key The name of the file. s3-configuration subresource The information to create a data source connector for a document repository in an Amazon S3 bucket. Cannot be set if any of database-configuration, one-drive-configuration, salesforce-configuration, service-now-configuration or share-point-configuration is set. access-control-list-configuration subresource The path to the S3 bucket that contains the user context filtering files for the data source. key-path The path to the AWS S3 bucket that contains the ACL files. (Required) bucket The bucket that contains the documents. (Required) documents-metadata-configuration subresource The value of the DocumentsMetadataConfiguration property for this object. s3-prefix The prefix used to filter metadata configuration files in the AWS S3 bucket. (Required) exclusion-patterns list The list of glob patterns for documents that should not be indexed. inclusion-prefixes list The list of S3 prefixes for the documents that should be included in the index. salesforce-configuration subresource The configuration information for data sources that connect to a Salesforce site. Cannot be set if any of database-configuration, one-drive-configuration, s3-configuration, service-now-configuration or share-point-configuration is set. chatter-feed-configuration subresource The configuration information for Salesforce chatter feeds. document-data-field-name The name of the column in the Salesforce FeedItem table that contains the content to index. (Required) document-title-field-name The name of the column in the Salesforce FeedItem table that contains the title of the document. field-mapping list subresource The mapping from Salesforce chatter feed fields into Amazon Kendra index fields. data-source-field-name The name of the column or attribute in the data source. (Required) date-field-format The type of data stored in the column or attribute. index-field-name The name of the field in the index. (Required) include-filter-types list The filters for the documents in the feed based on status of the user. crawl-attachments Indicates whether Amazon Kendra should index attachments to Salesforce objects. exclude-attachment-file-patterns list The list of regular expression patterns to exclude. Can only be set if crawl-attachments is set. include-attachment-file-patterns list The list of regular expression patterns to include. Can only be set if crawl-attachments is set. knowledge-article-configuration subresource The configuration information for the knowlege article types that Amazon Kendra indexes. custom-type-configuration list subresource The list of configurations for custom Salesforce knowledge articles. Cannot be set if standard-type-configuration is set. document-data-field-name The name of the field in the custom knowledge article that contains the document data to index. (Required) document-title-field-name The name of the field in the custom knowledge article that contains the document title. field-mapping list subresource The list of objects that map fields in the custom knowledge article to fields in the Amazon Kendra index. data-source-field-name The name of the column or attribute in the data source. (Required) date-field-format The type of data stored in the column or attribute. index-field-name The name of the field in the index. (Required) name The name of the configuration. (Required) standard-type-configuration subresource The configuration for standard Salesforce knowledge articles. Cannot be set if custom-type-configuration is set. document-data-field-name The name of the field in the standard knowledge article that contains the document data to index. (Required) document-title-field-name The name of the field in the standard knowledge article that contains the document title. field-mapping list subresource The list of objects that map fields in the standard knowledge article to fields in the Amazon Kendra index. data-source-field-name The name of the column or attribute in the data source. (Required) date-field-format The type of data stored in the column or attribute. index-field-name The name of the field in the index. (Required) states list The document states that should be included when Amazon Kendra indexes knowledge articles. (Required) secret-arn The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to the Salesforce instance. (Required) server-url The instance URL for the Salesforce site that you want to index. (Required) object-attachment-configuration subresource The configuration information for processing attachments to Salesforce standard objects. Can only be set if crawl-attachments is set. document-title-field-name The name of the field in the custom knowledge article that contains the document title. (Required) field-mapping list subresource The list of objects that map fields in attachments to Amazon Kendra index fields. data-source-field-name The name of the column or attribute in the data source. (Required) date-field-format The type of data stored in the column or attribute. index-field-name The name of the field in the index. (Required) object-configuration list subresource The list of Salesforce standard objects that Amazon Kendra indexes. document-data-field-name The name of the field in the standard object configuration that contains the document data to index. (Required) document-title-field-name The name of the field in the standard object configuration that contains the document title. field-mapping list subresource The list of objects that map fields in the standard object configuration to fields in the Amazon Kendra index. data-source-field-name The name of the column or attribute in the data source. (Required) date-field-format The type of data stored in the column or attribute. index-field-name The name of the field in the index. (Required) name The name of the configuration. Valid values are ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK or USER. (Required) service-now-configuration subresource The configuration for data sources that connect to ServiceNow instances. Cannot be set if any of database-configuration, one-drive-configuration, s3-configuration, salesforce-configuration or share-point-configuration is set. host-url The ServiceNow instance that the data source connects to. (Required) secret-arn The Amazon Resource Name (ARN) of the AWS Secret Manager secret that contains the user name and password required to connect to the ServiceNow instance. (Required) version-type The identifier of the release that the ServiceNow host is running. Valid values are LONDON or OTHERS. knowledge-article-configuration subresource The configuration for crawling knowledge articles in the ServiceNow site. exclude-attachment-file-patterns list The list of regular expressions applied to exclude in the knowledge articles. Can only be set if crawl-attachments is set. include-attachment-file-patterns list The list of regular expressions applied to include in the knowledge articles. Can only be set if crawl-attachments is set. crawl-attachments Indicates whether Amazon Kendra should index attachments to knowledge articles. field-mapping list subresource The list of objects mapping between ServiceNow fields and Amazon Kendra index fields. data-source-field-name The name of the column or attribute in the data source. (Required) date-field-format The type of data stored in the column or attribute. index-field-name The name of the field in the index. (Required) document-data-field-name The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index. document-title-field-name The name of the ServiceNow field that is mapped to the index document title field. service-catalog-configuration subresource The configuration for crawling service catalogs in the ServiceNow site. exclude-attachment-file-patterns list The list of regular expressions applied to exclude in the service catalogs. Can only be set if crawl-attachments is set. include-attachment-file-patterns list The list of regular expressions applied to include in the service catalogs. Can only be set if crawl-attachments is set. crawl-attachments Indicates whether Amazon Kendra should index attachments to service catalogs. field-mapping list subresource The list of objects mapping between ServiceNow fields and Amazon Kendra index fields. data-source-field-name The name of the column or attribute in the data source. (Required) date-field-format The type of data stored in the column or attribute. index-field-name The name of the field in the index. (Required) document-data-field-name The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index. document-title-field-name The name of the ServiceNow field that is mapped to the index document title field. share-point-configuration subresource The information necessary to create a data source connector for a Microsoft SharePoint site. Cannot be set if any of database-configuration, one-drive-configuration, s3-configuration, salesforce-configuration or service-now-configuration is set. crawl-attachments Indicates whether Amazon Kendra should index attachments to SharePoint objects. document-title-field-name The Microsoft SharePoint attribute field that contains the title of the document. (Required) exclusion-patterns list A list of regular expression patterns to exclude. inclusion-patterns list A list of regular expression patterns to include. field-mapping list subresource A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. data-source-field-name The name of the column or attribute in the data source. (Required) date-field-format The type of data stored in the column or attribute. index-field-name The name of the field in the index. (Required) secret-arn The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. share-point-version The version of Microsoft SharePoint that you are using as a data source. Valid value is SHAREPOINT_ONLINE. Currently the only supported value is SHAREPOINT_ONLINE. urls list The URLs of the Microsoft SharePoint site that contains the documents that should be indexed. Max limit of 99. Maximum allowed items are 99. use-change-log Indicates whether to use the Microsoft SharePoint change log to determine the documents that need to be updated in the index. vpc-configuration subresource The value of the VpcConfiguration property for this object. subnets list The list of identifiers of subnets within your Amazon VPC. (Required) security-groups list The list of identifiers of security groups within your Amazon VPC. (Required)
tags map	The tags associated with the data source.

Outputs

Attribute	Description
id	The id of the data source.
arn	The ARN of the data source.