aws-cdk-lib.aws_kendra

AWS::Kendra Construct Library

This module is part of the AWS Cloud Development Kit project.

import * as kendra from 'aws-cdk-lib/aws-kendra';

import aws_cdk.aws_kendra as kendra

import software.amazon.awscdk.services.kendra.*;

using Amazon.CDK.AWS.Kendra;

import kendra "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

• Search Construct Hub for Kendra construct libraries
• Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::Kendra resources directly.

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.)

Types

Name	Kind	Summary
CfnDataSource	Construct (L1)	Creates a data source connector that you want to use with an Amazon Kendra index.
CfnFaq	Construct (L1)	Creates an new set of frequently asked question (FAQ) questions and answers.
CfnFeaturedResultsSet	Construct (L1)	Resource Type definition for AWS::Kendra::FeaturedResultsSet.
CfnIndex	Construct (L1)	Creates an Amazon Kendra index.
CfnQuerySuggestionsBlockList	Construct (L1)	A block list used for query suggestions for an Amazon Kendra index.
CfnThesaurus	Construct (L1)	A thesaurus for an Amazon Kendra index.
CfnDataSource.AccessControlListConfigurationProperty	Struct	Specifies access control list files for the documents in a data source.
CfnDataSource.AclConfigurationProperty	Struct	Provides information about the column that should be used for filtering the query response by groups.
CfnDataSource.ColumnConfigurationProperty	Struct	Provides information about how Amazon Kendra should use the columns of a database in an index.
CfnDataSource.ConfluenceAttachmentConfigurationProperty	Struct	Configuration of attachment settings for the Confluence data source.
CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty	Struct	Maps attributes or field names of Confluence attachments to Amazon Kendra index field names.
CfnDataSource.ConfluenceBlogConfigurationProperty	Struct	Configuration of blog settings for the Confluence data source.
CfnDataSource.ConfluenceBlogToIndexFieldMappingProperty	Struct	Maps attributes or field names of Confluence blog to Amazon Kendra index field names.
CfnDataSource.ConfluenceConfigurationProperty	Struct	Provides the configuration information to connect to Confluence as your data source.
CfnDataSource.ConfluencePageConfigurationProperty	Struct	Configuration of the page settings for the Confluence data source.
CfnDataSource.ConfluencePageToIndexFieldMappingProperty	Struct	Maps attributes or field names of Confluence pages to Amazon Kendra index field names.
CfnDataSource.ConfluenceSpaceConfigurationProperty	Struct	Configuration information for indexing Confluence spaces.
CfnDataSource.ConfluenceSpaceToIndexFieldMappingProperty	Struct	Maps attributes or field names of Confluence spaces to Amazon Kendra index field names.
CfnDataSource.ConnectionConfigurationProperty	Struct	Provides the configuration information that's required to connect to a database.
CfnDataSource.CustomDocumentEnrichmentConfigurationProperty	Struct	Provides the configuration information for altering document metadata and content during the document ingestion process.
CfnDataSource.DatabaseConfigurationProperty	Struct	Provides the configuration information to an Amazon Kendra supported database .
CfnDataSource.DataSourceConfigurationProperty	Struct	Provides the configuration information for an Amazon Kendra data source.
CfnDataSource.DataSourceToIndexFieldMappingProperty	Struct	Maps a column or attribute in the data source to an index field.
CfnDataSource.DataSourceVpcConfigurationProperty	Struct	Provides the configuration information to connect to an Amazon VPC.
CfnDataSource.DocumentAttributeConditionProperty	Struct	The condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra.
CfnDataSource.DocumentAttributeTargetProperty	Struct	The target document attribute or metadata field you want to alter when ingesting documents into Amazon Kendra.
CfnDataSource.DocumentAttributeValueProperty	Struct	The value of a document attribute.
CfnDataSource.DocumentsMetadataConfigurationProperty	Struct	Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes.
CfnDataSource.GoogleDriveConfigurationProperty	Struct	Provides the configuration information to connect to Google Drive as your data source.
CfnDataSource.HookConfigurationProperty	Struct	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	Struct	Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Kendra.
CfnDataSource.OneDriveConfigurationProperty	Struct	Provides the configuration information to connect to OneDrive as your data source.
CfnDataSource.OneDriveUsersProperty	Struct	User accounts whose documents should be indexed.
CfnDataSource.ProxyConfigurationProperty	Struct	Provides the configuration information for a web proxy to connect to website hosts.
CfnDataSource.S3DataSourceConfigurationProperty	Struct	Provides the configuration information to connect to an Amazon S3 bucket.
CfnDataSource.S3PathProperty	Struct	Information required to find a specific file in an Amazon S3 bucket.
CfnDataSource.SalesforceChatterFeedConfigurationProperty	Struct	The configuration information for syncing a Salesforce chatter feed.
CfnDataSource.SalesforceConfigurationProperty	Struct	Provides the configuration information to connect to Salesforce as your data source.
CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty	Struct	Provides the configuration information for indexing Salesforce custom articles.
CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty	Struct	Provides the configuration information for the knowledge article types that Amazon Kendra indexes.
CfnDataSource.SalesforceStandardKnowledgeArticleTypeConfigurationProperty	Struct	Provides the configuration information for standard Salesforce knowledge articles.
CfnDataSource.SalesforceStandardObjectAttachmentConfigurationProperty	Struct	Provides the configuration information for processing attachments to Salesforce standard objects.
CfnDataSource.SalesforceStandardObjectConfigurationProperty	Struct	Specifies configuration information for indexing a single standard object.
CfnDataSource.ServiceNowConfigurationProperty	Struct	Provides the configuration information to connect to ServiceNow as your data source.
CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty	Struct	Provides the configuration information for crawling knowledge articles in the ServiceNow site.
CfnDataSource.ServiceNowServiceCatalogConfigurationProperty	Struct	Provides the configuration information for crawling service catalog items in the ServiceNow site.
CfnDataSource.SharePointConfigurationProperty	Struct	Provides the configuration information to connect to Microsoft SharePoint as your data source.
CfnDataSource.SqlConfigurationProperty	Struct	Provides information that configures Amazon Kendra to use a SQL database.
CfnDataSource.TemplateConfigurationProperty	Struct	Provides a template for the configuration information to connect to your data source.
CfnDataSource.WebCrawlerAuthenticationConfigurationProperty	Struct	Provides the configuration information to connect to websites that require user authentication.
CfnDataSource.WebCrawlerBasicAuthenticationProperty	Struct	Provides the configuration information to connect to websites that require basic user authentication.
CfnDataSource.WebCrawlerConfigurationProperty	Struct	Provides the configuration information required for Amazon Kendra Web Crawler.
CfnDataSource.WebCrawlerSeedUrlConfigurationProperty	Struct	Provides the configuration information of the seed or starting point URLs to crawl.
CfnDataSource.WebCrawlerSiteMapsConfigurationProperty	Struct	Provides the configuration information of the sitemap URLs to crawl.
CfnDataSource.WebCrawlerUrlsProperty	Struct	Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.
CfnDataSource.WorkDocsConfigurationProperty	Struct	Provides the configuration information to connect to WorkDocs as your data source.
CfnDataSourceProps	Struct	Properties for defining a CfnDataSource.
CfnFaq.S3PathProperty	Struct	Information required to find a specific file in an Amazon S3 bucket.
CfnFaqProps	Struct	Properties for defining a CfnFaq.
CfnFeaturedResultsSet.FeaturedDocumentProperty	Struct	A featured document.
CfnFeaturedResultsSetProps	Struct	Properties for defining a CfnFeaturedResultsSet.
CfnIndex.CapacityUnitsConfigurationProperty	Struct	Specifies additional capacity units configured for your Enterprise Edition index.
CfnIndex.DocumentMetadataConfigurationProperty	Struct	Specifies the properties, such as relevance tuning and searchability, of an index field.
CfnIndex.JsonTokenTypeConfigurationProperty	Struct	Provides the configuration information for the JSON token type.
CfnIndex.JwtTokenTypeConfigurationProperty	Struct	Provides the configuration information for the JWT token type.
CfnIndex.RelevanceProperty	Struct	Provides information for tuning the relevance of a field in a search.
CfnIndex.SearchProperty	Struct	Provides information about how a custom index field is used during a search.
CfnIndex.ServerSideEncryptionConfigurationProperty	Struct	Provides the identifier of the AWS KMS customer master key (CMK) used to encrypt data indexed by Amazon Kendra.
CfnIndex.UserTokenConfigurationProperty	Struct	Provides the configuration information for a token.
CfnIndex.ValueImportanceItemProperty	Struct	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	Struct	Properties for defining a CfnIndex.
CfnQuerySuggestionsBlockList.S3PathProperty	Struct	Information required to find a specific file in an Amazon S3 bucket.
CfnQuerySuggestionsBlockListProps	Struct	Properties for defining a CfnQuerySuggestionsBlockList.
CfnThesaurus.S3PathProperty	Struct	Information required to find a specific file in an Amazon S3 bucket.
CfnThesaurusProps	Struct	Properties for defining a CfnThesaurus.