Namespace Amazon.CDK.AWS.Kendra
AWS::Kendra Construct Library
---
AWS CDK v1 has reached End-of-Support on 2023-06-01.
This package is no longer being updated, and users should migrate to AWS CDK v2.
For more information on how to migrate, see the Migrating to AWS CDK v2 guide.
This module is part of the AWS Cloud Development Kit project.
using Amazon.CDK.AWS.Kendra;There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:
There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.
For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::Kendra.
(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)
Classes
| CfnDataSource | A CloudFormation |
| CfnDataSource.AccessControlListConfigurationProperty | Specifies access control list files for the documents in a data source. |
| CfnDataSource.AclConfigurationProperty | Provides information about the column that should be used for filtering the query response by groups. |
| CfnDataSource.ColumnConfigurationProperty | Provides information about how Amazon Kendra should use the columns of a database in an index. |
| CfnDataSource.ConfluenceAttachmentConfigurationProperty | Configuration of attachment settings for the Confluence data source. |
| CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty | Maps attributes or field names of Confluence attachments to Amazon Kendra index field names. |
| CfnDataSource.ConfluenceBlogConfigurationProperty | Configuration of blog settings for the Confluence data source. |
| CfnDataSource.ConfluenceBlogToIndexFieldMappingProperty | Maps attributes or field names of Confluence blog to Amazon Kendra index field names. |
| CfnDataSource.ConfluenceConfigurationProperty | Provides the configuration information to connect to Confluence as your data source. |
| CfnDataSource.ConfluencePageConfigurationProperty | Configuration of the page settings for the Confluence data source. |
| CfnDataSource.ConfluencePageToIndexFieldMappingProperty | Maps attributes or field names of Confluence pages to Amazon Kendra index field names. |
| CfnDataSource.ConfluenceSpaceConfigurationProperty | Configuration information for indexing Confluence spaces. |
| CfnDataSource.ConfluenceSpaceToIndexFieldMappingProperty | Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. |
| CfnDataSource.ConnectionConfigurationProperty | Provides the configuration information that's required to connect to a database. |
| CfnDataSource.CustomDocumentEnrichmentConfigurationProperty | Provides the configuration information for altering document metadata and content during the document ingestion process. |
| CfnDataSource.DatabaseConfigurationProperty | Provides the configuration information to connect to a index. |
| CfnDataSource.DataSourceConfigurationProperty | Provides the configuration information for an Amazon Kendra data source. |
| CfnDataSource.DataSourceToIndexFieldMappingProperty | Maps a column or attribute in the data source to an index field. |
| CfnDataSource.DataSourceVpcConfigurationProperty | Provides the configuration information to connect to an Amazon VPC. |
| CfnDataSource.DocumentAttributeConditionProperty | The condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra. |
| CfnDataSource.DocumentAttributeTargetProperty | The target document attribute or metadata field you want to alter when ingesting documents into Amazon Kendra. |
| CfnDataSource.DocumentAttributeValueProperty | The value of a document attribute. |
| CfnDataSource.DocumentsMetadataConfigurationProperty | Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. |
| CfnDataSource.GoogleDriveConfigurationProperty | Provides the configuration information to connect to Google Drive as your data source. |
| CfnDataSource.HookConfigurationProperty | Provides the configuration information for invoking a Lambda function in AWS Lambda to alter document metadata and content when ingesting documents into Amazon Kendra. |
| CfnDataSource.InlineCustomDocumentEnrichmentConfigurationProperty | Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Kendra. |
| CfnDataSource.OneDriveConfigurationProperty | Provides the configuration information to connect to OneDrive as your data source. |
| CfnDataSource.OneDriveUsersProperty | User accounts whose documents should be indexed. |
| CfnDataSource.ProxyConfigurationProperty | Provides the configuration information for a web proxy to connect to website hosts. |
| CfnDataSource.S3DataSourceConfigurationProperty | Provides the configuration information to connect to an Amazon S3 bucket. |
| CfnDataSource.S3PathProperty | Information required to find a specific file in an Amazon S3 bucket. |
| CfnDataSource.SalesforceChatterFeedConfigurationProperty | The configuration information for syncing a Salesforce chatter feed. |
| CfnDataSource.SalesforceConfigurationProperty | Provides the configuration information to connect to Salesforce as your data source. |
| CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty | Provides the configuration information for indexing Salesforce custom articles. |
| CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty | Provides the configuration information for the knowledge article types that Amazon Kendra indexes. |
| CfnDataSource.SalesforceStandardKnowledgeArticleTypeConfigurationProperty | Provides the configuration information for standard Salesforce knowledge articles. |
| CfnDataSource.SalesforceStandardObjectAttachmentConfigurationProperty | Provides the configuration information for processing attachments to Salesforce standard objects. |
| CfnDataSource.SalesforceStandardObjectConfigurationProperty | Specifies configuration information for indexing a single standard object. |
| CfnDataSource.ServiceNowConfigurationProperty | Provides the configuration information to connect to ServiceNow as your data source. |
| CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty | Provides the configuration information for crawling knowledge articles in the ServiceNow site. |
| CfnDataSource.ServiceNowServiceCatalogConfigurationProperty | Provides the configuration information for crawling service catalog items in the ServiceNow site. |
| CfnDataSource.SharePointConfigurationProperty | Provides the configuration information to connect to Microsoft SharePoint as your data source. |
| CfnDataSource.SqlConfigurationProperty | Provides information that configures Amazon Kendra to use a SQL database. |
| CfnDataSource.WebCrawlerAuthenticationConfigurationProperty | Provides the configuration information to connect to websites that require user authentication. |
| CfnDataSource.WebCrawlerBasicAuthenticationProperty | Provides the configuration information to connect to websites that require basic user authentication. |
| CfnDataSource.WebCrawlerConfigurationProperty | Provides the configuration information required for Amazon Kendra Web Crawler. |
| CfnDataSource.WebCrawlerSeedUrlConfigurationProperty | Provides the configuration information of the seed or starting point URLs to crawl. |
| CfnDataSource.WebCrawlerSiteMapsConfigurationProperty | Provides the configuration information of the sitemap URLs to crawl. |
| CfnDataSource.WebCrawlerUrlsProperty | Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl. |
| CfnDataSource.WorkDocsConfigurationProperty | Provides the configuration information to connect to Amazon WorkDocs as your data source. |
| CfnDataSourceProps | Properties for defining a |
| CfnFaq | A CloudFormation |
| CfnFaq.S3PathProperty | Information required to find a specific file in an Amazon S3 bucket. |
| CfnFaqProps | Properties for defining a |
| CfnIndex | A CloudFormation |
| CfnIndex.CapacityUnitsConfigurationProperty | Specifies additional capacity units configured for your Enterprise Edition index. |
| CfnIndex.DocumentMetadataConfigurationProperty | Specifies the properties, such as relevance tuning and searchability, of an index field. |
| CfnIndex.JsonTokenTypeConfigurationProperty | Provides the configuration information for the JSON token type. |
| CfnIndex.JwtTokenTypeConfigurationProperty | Provides the configuration information for the JWT token type. |
| CfnIndex.RelevanceProperty | Provides information for tuning the relevance of a field in a search. |
| CfnIndex.SearchProperty | Provides information about how a custom index field is used during a search. |
| CfnIndex.ServerSideEncryptionConfigurationProperty | Provides the identifier of the AWS KMS customer master key (CMK) used to encrypt data indexed by Amazon Kendra. |
| CfnIndex.UserTokenConfigurationProperty | Provides the configuration information for a token. |
| CfnIndex.ValueImportanceItemProperty | Specifies a key-value pair of the search boost value for a document when the key is part of the metadata of a document. |
| CfnIndexProps | Properties for defining a |
Interfaces
| CfnDataSource.IAccessControlListConfigurationProperty | Specifies access control list files for the documents in a data source. |
| CfnDataSource.IAclConfigurationProperty | Provides information about the column that should be used for filtering the query response by groups. |
| CfnDataSource.IColumnConfigurationProperty | Provides information about how Amazon Kendra should use the columns of a database in an index. |
| CfnDataSource.IConfluenceAttachmentConfigurationProperty | Configuration of attachment settings for the Confluence data source. |
| CfnDataSource.IConfluenceAttachmentToIndexFieldMappingProperty | Maps attributes or field names of Confluence attachments to Amazon Kendra index field names. |
| CfnDataSource.IConfluenceBlogConfigurationProperty | Configuration of blog settings for the Confluence data source. |
| CfnDataSource.IConfluenceBlogToIndexFieldMappingProperty | Maps attributes or field names of Confluence blog to Amazon Kendra index field names. |
| CfnDataSource.IConfluenceConfigurationProperty | Provides the configuration information to connect to Confluence as your data source. |
| CfnDataSource.IConfluencePageConfigurationProperty | Configuration of the page settings for the Confluence data source. |
| CfnDataSource.IConfluencePageToIndexFieldMappingProperty | Maps attributes or field names of Confluence pages to Amazon Kendra index field names. |
| CfnDataSource.IConfluenceSpaceConfigurationProperty | Configuration information for indexing Confluence spaces. |
| CfnDataSource.IConfluenceSpaceToIndexFieldMappingProperty | Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. |
| CfnDataSource.IConnectionConfigurationProperty | Provides the configuration information that's required to connect to a database. |
| CfnDataSource.ICustomDocumentEnrichmentConfigurationProperty | Provides the configuration information for altering document metadata and content during the document ingestion process. |
| CfnDataSource.IDatabaseConfigurationProperty | Provides the configuration information to connect to a index. |
| CfnDataSource.IDataSourceConfigurationProperty | Provides the configuration information for an Amazon Kendra data source. |
| CfnDataSource.IDataSourceToIndexFieldMappingProperty | Maps a column or attribute in the data source to an index field. |
| CfnDataSource.IDataSourceVpcConfigurationProperty | Provides the configuration information to connect to an Amazon VPC. |
| CfnDataSource.IDocumentAttributeConditionProperty | The condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra. |
| CfnDataSource.IDocumentAttributeTargetProperty | The target document attribute or metadata field you want to alter when ingesting documents into Amazon Kendra. |
| CfnDataSource.IDocumentAttributeValueProperty | The value of a document attribute. |
| CfnDataSource.IDocumentsMetadataConfigurationProperty | Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. |
| CfnDataSource.IGoogleDriveConfigurationProperty | Provides the configuration information to connect to Google Drive as your data source. |
| CfnDataSource.IHookConfigurationProperty | Provides the configuration information for invoking a Lambda function in AWS Lambda to alter document metadata and content when ingesting documents into Amazon Kendra. |
| CfnDataSource.IInlineCustomDocumentEnrichmentConfigurationProperty | Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Kendra. |
| CfnDataSource.IOneDriveConfigurationProperty | Provides the configuration information to connect to OneDrive as your data source. |
| CfnDataSource.IOneDriveUsersProperty | User accounts whose documents should be indexed. |
| CfnDataSource.IProxyConfigurationProperty | Provides the configuration information for a web proxy to connect to website hosts. |
| CfnDataSource.IS3DataSourceConfigurationProperty | Provides the configuration information to connect to an Amazon S3 bucket. |
| CfnDataSource.IS3PathProperty | Information required to find a specific file in an Amazon S3 bucket. |
| CfnDataSource.ISalesforceChatterFeedConfigurationProperty | The configuration information for syncing a Salesforce chatter feed. |
| CfnDataSource.ISalesforceConfigurationProperty | Provides the configuration information to connect to Salesforce as your data source. |
| CfnDataSource.ISalesforceCustomKnowledgeArticleTypeConfigurationProperty | Provides the configuration information for indexing Salesforce custom articles. |
| CfnDataSource.ISalesforceKnowledgeArticleConfigurationProperty | Provides the configuration information for the knowledge article types that Amazon Kendra indexes. |
| CfnDataSource.ISalesforceStandardKnowledgeArticleTypeConfigurationProperty | Provides the configuration information for standard Salesforce knowledge articles. |
| CfnDataSource.ISalesforceStandardObjectAttachmentConfigurationProperty | Provides the configuration information for processing attachments to Salesforce standard objects. |
| CfnDataSource.ISalesforceStandardObjectConfigurationProperty | Specifies configuration information for indexing a single standard object. |
| CfnDataSource.IServiceNowConfigurationProperty | Provides the configuration information to connect to ServiceNow as your data source. |
| CfnDataSource.IServiceNowKnowledgeArticleConfigurationProperty | Provides the configuration information for crawling knowledge articles in the ServiceNow site. |
| CfnDataSource.IServiceNowServiceCatalogConfigurationProperty | Provides the configuration information for crawling service catalog items in the ServiceNow site. |
| CfnDataSource.ISharePointConfigurationProperty | Provides the configuration information to connect to Microsoft SharePoint as your data source. |
| CfnDataSource.ISqlConfigurationProperty | Provides information that configures Amazon Kendra to use a SQL database. |
| CfnDataSource.IWebCrawlerAuthenticationConfigurationProperty | Provides the configuration information to connect to websites that require user authentication. |
| CfnDataSource.IWebCrawlerBasicAuthenticationProperty | Provides the configuration information to connect to websites that require basic user authentication. |
| CfnDataSource.IWebCrawlerConfigurationProperty | Provides the configuration information required for Amazon Kendra Web Crawler. |
| CfnDataSource.IWebCrawlerSeedUrlConfigurationProperty | Provides the configuration information of the seed or starting point URLs to crawl. |
| CfnDataSource.IWebCrawlerSiteMapsConfigurationProperty | Provides the configuration information of the sitemap URLs to crawl. |
| CfnDataSource.IWebCrawlerUrlsProperty | Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl. |
| CfnDataSource.IWorkDocsConfigurationProperty | Provides the configuration information to connect to Amazon WorkDocs as your data source. |
| CfnFaq.IS3PathProperty | Information required to find a specific file in an Amazon S3 bucket. |
| CfnIndex.ICapacityUnitsConfigurationProperty | Specifies additional capacity units configured for your Enterprise Edition index. |
| CfnIndex.IDocumentMetadataConfigurationProperty | Specifies the properties, such as relevance tuning and searchability, of an index field. |
| CfnIndex.IJsonTokenTypeConfigurationProperty | Provides the configuration information for the JSON token type. |
| CfnIndex.IJwtTokenTypeConfigurationProperty | Provides the configuration information for the JWT token type. |
| CfnIndex.IRelevanceProperty | Provides information for tuning the relevance of a field in a search. |
| CfnIndex.ISearchProperty | Provides information about how a custom index field is used during a search. |
| CfnIndex.IServerSideEncryptionConfigurationProperty | Provides the identifier of the AWS KMS customer master key (CMK) used to encrypt data indexed by Amazon Kendra. |
| CfnIndex.IUserTokenConfigurationProperty | Provides the configuration information for a token. |
| CfnIndex.IValueImportanceItemProperty | Specifies a key-value pair of the search boost value for a document when the key is part of the metadata of a document. |
| ICfnDataSourceProps | Properties for defining a |
| ICfnFaqProps | Properties for defining a |
| ICfnIndexProps | Properties for defining a |