Package software.amazon.awscdk.services.kendra

Class CfnDataSource

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.kendra.CfnDataSource

All Implemented Interfaces:

IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:58.090Z")
@Stability(Stable)
public class CfnDataSource
extends CfnResource
implements IInspectable

A CloudFormation AWS::Kendra::DataSource.

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kendra.*;
 CfnDataSource cfnDataSource = CfnDataSource.Builder.create(this, "MyCfnDataSource")
         .indexId("indexId")
         .name("name")
         .type("type")
         // the properties below are optional
         .customDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfigurationProperty.builder()
                 .inlineConfigurations(List.of(InlineCustomDocumentEnrichmentConfigurationProperty.builder()
                         .condition(DocumentAttributeConditionProperty.builder()
                                 .conditionDocumentAttributeKey("conditionDocumentAttributeKey")
                                 .operator("operator")
                                 // the properties below are optional
                                 .conditionOnValue(DocumentAttributeValueProperty.builder()
                                         .dateValue("dateValue")
                                         .longValue(123)
                                         .stringListValue(List.of("stringListValue"))
                                         .stringValue("stringValue")
                                         .build())
                                 .build())
                         .documentContentDeletion(false)
                         .target(DocumentAttributeTargetProperty.builder()
                                 .targetDocumentAttributeKey("targetDocumentAttributeKey")
                                 // the properties below are optional
                                 .targetDocumentAttributeValue(DocumentAttributeValueProperty.builder()
                                         .dateValue("dateValue")
                                         .longValue(123)
                                         .stringListValue(List.of("stringListValue"))
                                         .stringValue("stringValue")
                                         .build())
                                 .targetDocumentAttributeValueDeletion(false)
                                 .build())
                         .build()))
                 .postExtractionHookConfiguration(HookConfigurationProperty.builder()
                         .lambdaArn("lambdaArn")
                         .s3Bucket("s3Bucket")
                         // the properties below are optional
                         .invocationCondition(DocumentAttributeConditionProperty.builder()
                                 .conditionDocumentAttributeKey("conditionDocumentAttributeKey")
                                 .operator("operator")
                                 // the properties below are optional
                                 .conditionOnValue(DocumentAttributeValueProperty.builder()
                                         .dateValue("dateValue")
                                         .longValue(123)
                                         .stringListValue(List.of("stringListValue"))
                                         .stringValue("stringValue")
                                         .build())
                                 .build())
                         .build())
                 .preExtractionHookConfiguration(HookConfigurationProperty.builder()
                         .lambdaArn("lambdaArn")
                         .s3Bucket("s3Bucket")
                         // the properties below are optional
                         .invocationCondition(DocumentAttributeConditionProperty.builder()
                                 .conditionDocumentAttributeKey("conditionDocumentAttributeKey")
                                 .operator("operator")
                                 // the properties below are optional
                                 .conditionOnValue(DocumentAttributeValueProperty.builder()
                                         .dateValue("dateValue")
                                         .longValue(123)
                                         .stringListValue(List.of("stringListValue"))
                                         .stringValue("stringValue")
                                         .build())
                                 .build())
                         .build())
                 .roleArn("roleArn")
                 .build())
         .dataSourceConfiguration(DataSourceConfigurationProperty.builder()
                 .confluenceConfiguration(ConfluenceConfigurationProperty.builder()
                         .secretArn("secretArn")
                         .serverUrl("serverUrl")
                         .version("version")
                         // the properties below are optional
                         .attachmentConfiguration(ConfluenceAttachmentConfigurationProperty.builder()
                                 .attachmentFieldMappings(List.of(ConfluenceAttachmentToIndexFieldMappingProperty.builder()
                                         .dataSourceFieldName("dataSourceFieldName")
                                         .indexFieldName("indexFieldName")
                                         // the properties below are optional
                                         .dateFieldFormat("dateFieldFormat")
                                         .build()))
                                 .crawlAttachments(false)
                                 .build())
                         .blogConfiguration(ConfluenceBlogConfigurationProperty.builder()
                                 .blogFieldMappings(List.of(ConfluenceBlogToIndexFieldMappingProperty.builder()
                                         .dataSourceFieldName("dataSourceFieldName")
                                         .indexFieldName("indexFieldName")
                                         // the properties below are optional
                                         .dateFieldFormat("dateFieldFormat")
                                         .build()))
                                 .build())
                         .exclusionPatterns(List.of("exclusionPatterns"))
                         .inclusionPatterns(List.of("inclusionPatterns"))
                         .pageConfiguration(ConfluencePageConfigurationProperty.builder()
                                 .pageFieldMappings(List.of(ConfluencePageToIndexFieldMappingProperty.builder()
                                         .dataSourceFieldName("dataSourceFieldName")
                                         .indexFieldName("indexFieldName")
                                         // the properties below are optional
                                         .dateFieldFormat("dateFieldFormat")
                                         .build()))
                                 .build())
                         .spaceConfiguration(ConfluenceSpaceConfigurationProperty.builder()
                                 .crawlArchivedSpaces(false)
                                 .crawlPersonalSpaces(false)
                                 .excludeSpaces(List.of("excludeSpaces"))
                                 .includeSpaces(List.of("includeSpaces"))
                                 .spaceFieldMappings(List.of(ConfluenceSpaceToIndexFieldMappingProperty.builder()
                                         .dataSourceFieldName("dataSourceFieldName")
                                         .indexFieldName("indexFieldName")
                                         // the properties below are optional
                                         .dateFieldFormat("dateFieldFormat")
                                         .build()))
                                 .build())
                         .vpcConfiguration(DataSourceVpcConfigurationProperty.builder()
                                 .securityGroupIds(List.of("securityGroupIds"))
                                 .subnetIds(List.of("subnetIds"))
                                 .build())
                         .build())
                 .databaseConfiguration(DatabaseConfigurationProperty.builder()
                         .columnConfiguration(ColumnConfigurationProperty.builder()
                                 .changeDetectingColumns(List.of("changeDetectingColumns"))
                                 .documentDataColumnName("documentDataColumnName")
                                 .documentIdColumnName("documentIdColumnName")
                                 // the properties below are optional
                                 .documentTitleColumnName("documentTitleColumnName")
                                 .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                                         .dataSourceFieldName("dataSourceFieldName")
                                         .indexFieldName("indexFieldName")
                                         // the properties below are optional
                                         .dateFieldFormat("dateFieldFormat")
                                         .build()))
                                 .build())
                         .connectionConfiguration(ConnectionConfigurationProperty.builder()
                                 .databaseHost("databaseHost")
                                 .databaseName("databaseName")
                                 .databasePort(123)
                                 .secretArn("secretArn")
                                 .tableName("tableName")
                                 .build())
                         .databaseEngineType("databaseEngineType")
                         // the properties below are optional
                         .aclConfiguration(AclConfigurationProperty.builder()
                                 .allowedGroupsColumnName("allowedGroupsColumnName")
                                 .build())
                         .sqlConfiguration(SqlConfigurationProperty.builder()
                                 .queryIdentifiersEnclosingOption("queryIdentifiersEnclosingOption")
                                 .build())
                         .vpcConfiguration(DataSourceVpcConfigurationProperty.builder()
                                 .securityGroupIds(List.of("securityGroupIds"))
                                 .subnetIds(List.of("subnetIds"))
                                 .build())
                         .build())
                 .googleDriveConfiguration(GoogleDriveConfigurationProperty.builder()
                         .secretArn("secretArn")
                         // the properties below are optional
                         .excludeMimeTypes(List.of("excludeMimeTypes"))
                         .excludeSharedDrives(List.of("excludeSharedDrives"))
                         .excludeUserAccounts(List.of("excludeUserAccounts"))
                         .exclusionPatterns(List.of("exclusionPatterns"))
                         .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                                 .dataSourceFieldName("dataSourceFieldName")
                                 .indexFieldName("indexFieldName")
                                 // the properties below are optional
                                 .dateFieldFormat("dateFieldFormat")
                                 .build()))
                         .inclusionPatterns(List.of("inclusionPatterns"))
                         .build())
                 .oneDriveConfiguration(OneDriveConfigurationProperty.builder()
                         .oneDriveUsers(OneDriveUsersProperty.builder()
                                 .oneDriveUserList(List.of("oneDriveUserList"))
                                 .oneDriveUserS3Path(S3PathProperty.builder()
                                         .bucket("bucket")
                                         .key("key")
                                         .build())
                                 .build())
                         .secretArn("secretArn")
                         .tenantDomain("tenantDomain")
                         // the properties below are optional
                         .disableLocalGroups(false)
                         .exclusionPatterns(List.of("exclusionPatterns"))
                         .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                                 .dataSourceFieldName("dataSourceFieldName")
                                 .indexFieldName("indexFieldName")
                                 // the properties below are optional
                                 .dateFieldFormat("dateFieldFormat")
                                 .build()))
                         .inclusionPatterns(List.of("inclusionPatterns"))
                         .build())
                 .s3Configuration(S3DataSourceConfigurationProperty.builder()
                         .bucketName("bucketName")
                         // the properties below are optional
                         .accessControlListConfiguration(AccessControlListConfigurationProperty.builder()
                                 .keyPath("keyPath")
                                 .build())
                         .documentsMetadataConfiguration(DocumentsMetadataConfigurationProperty.builder()
                                 .s3Prefix("s3Prefix")
                                 .build())
                         .exclusionPatterns(List.of("exclusionPatterns"))
                         .inclusionPatterns(List.of("inclusionPatterns"))
                         .inclusionPrefixes(List.of("inclusionPrefixes"))
                         .build())
                 .salesforceConfiguration(SalesforceConfigurationProperty.builder()
                         .secretArn("secretArn")
                         .serverUrl("serverUrl")
                         // the properties below are optional
                         .chatterFeedConfiguration(SalesforceChatterFeedConfigurationProperty.builder()
                                 .documentDataFieldName("documentDataFieldName")
                                 // the properties below are optional
                                 .documentTitleFieldName("documentTitleFieldName")
                                 .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                                         .dataSourceFieldName("dataSourceFieldName")
                                         .indexFieldName("indexFieldName")
                                         // the properties below are optional
                                         .dateFieldFormat("dateFieldFormat")
                                         .build()))
                                 .includeFilterTypes(List.of("includeFilterTypes"))
                                 .build())
                         .crawlAttachments(false)
                         .excludeAttachmentFilePatterns(List.of("excludeAttachmentFilePatterns"))
                         .includeAttachmentFilePatterns(List.of("includeAttachmentFilePatterns"))
                         .knowledgeArticleConfiguration(SalesforceKnowledgeArticleConfigurationProperty.builder()
                                 .includedStates(List.of("includedStates"))
                                 // the properties below are optional
                                 .customKnowledgeArticleTypeConfigurations(List.of(SalesforceCustomKnowledgeArticleTypeConfigurationProperty.builder()
                                         .documentDataFieldName("documentDataFieldName")
                                         .name("name")
                                         // the properties below are optional
                                         .documentTitleFieldName("documentTitleFieldName")
                                         .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                                                 .dataSourceFieldName("dataSourceFieldName")
                                                 .indexFieldName("indexFieldName")
                                                 // the properties below are optional
                                                 .dateFieldFormat("dateFieldFormat")
                                                 .build()))
                                         .build()))
                                 .standardKnowledgeArticleTypeConfiguration(SalesforceStandardKnowledgeArticleTypeConfigurationProperty.builder()
                                         .documentDataFieldName("documentDataFieldName")
                                         // the properties below are optional
                                         .documentTitleFieldName("documentTitleFieldName")
                                         .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                                                 .dataSourceFieldName("dataSourceFieldName")
                                                 .indexFieldName("indexFieldName")
                                                 // the properties below are optional
                                                 .dateFieldFormat("dateFieldFormat")
                                                 .build()))
                                         .build())
                                 .build())
                         .standardObjectAttachmentConfiguration(SalesforceStandardObjectAttachmentConfigurationProperty.builder()
                                 .documentTitleFieldName("documentTitleFieldName")
                                 .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                                         .dataSourceFieldName("dataSourceFieldName")
                                         .indexFieldName("indexFieldName")
                                         // the properties below are optional
                                         .dateFieldFormat("dateFieldFormat")
                                         .build()))
                                 .build())
                         .standardObjectConfigurations(List.of(SalesforceStandardObjectConfigurationProperty.builder()
                                 .documentDataFieldName("documentDataFieldName")
                                 .name("name")
                                 // the properties below are optional
                                 .documentTitleFieldName("documentTitleFieldName")
                                 .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                                         .dataSourceFieldName("dataSourceFieldName")
                                         .indexFieldName("indexFieldName")
                                         // the properties below are optional
                                         .dateFieldFormat("dateFieldFormat")
                                         .build()))
                                 .build()))
                         .build())
                 .serviceNowConfiguration(ServiceNowConfigurationProperty.builder()
                         .hostUrl("hostUrl")
                         .secretArn("secretArn")
                         .serviceNowBuildVersion("serviceNowBuildVersion")
                         // the properties below are optional
                         .authenticationType("authenticationType")
                         .knowledgeArticleConfiguration(ServiceNowKnowledgeArticleConfigurationProperty.builder()
                                 .documentDataFieldName("documentDataFieldName")
                                 // the properties below are optional
                                 .crawlAttachments(false)
                                 .documentTitleFieldName("documentTitleFieldName")
                                 .excludeAttachmentFilePatterns(List.of("excludeAttachmentFilePatterns"))
                                 .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                                         .dataSourceFieldName("dataSourceFieldName")
                                         .indexFieldName("indexFieldName")
                                         // the properties below are optional
                                         .dateFieldFormat("dateFieldFormat")
                                         .build()))
                                 .filterQuery("filterQuery")
                                 .includeAttachmentFilePatterns(List.of("includeAttachmentFilePatterns"))
                                 .build())
                         .serviceCatalogConfiguration(ServiceNowServiceCatalogConfigurationProperty.builder()
                                 .documentDataFieldName("documentDataFieldName")
                                 // the properties below are optional
                                 .crawlAttachments(false)
                                 .documentTitleFieldName("documentTitleFieldName")
                                 .excludeAttachmentFilePatterns(List.of("excludeAttachmentFilePatterns"))
                                 .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                                         .dataSourceFieldName("dataSourceFieldName")
                                         .indexFieldName("indexFieldName")
                                         // the properties below are optional
                                         .dateFieldFormat("dateFieldFormat")
                                         .build()))
                                 .includeAttachmentFilePatterns(List.of("includeAttachmentFilePatterns"))
                                 .build())
                         .build())
                 .sharePointConfiguration(SharePointConfigurationProperty.builder()
                         .secretArn("secretArn")
                         .sharePointVersion("sharePointVersion")
                         .urls(List.of("urls"))
                         // the properties below are optional
                         .crawlAttachments(false)
                         .disableLocalGroups(false)
                         .documentTitleFieldName("documentTitleFieldName")
                         .exclusionPatterns(List.of("exclusionPatterns"))
                         .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                                 .dataSourceFieldName("dataSourceFieldName")
                                 .indexFieldName("indexFieldName")
                                 // the properties below are optional
                                 .dateFieldFormat("dateFieldFormat")
                                 .build()))
                         .inclusionPatterns(List.of("inclusionPatterns"))
                         .sslCertificateS3Path(S3PathProperty.builder()
                                 .bucket("bucket")
                                 .key("key")
                                 .build())
                         .useChangeLog(false)
                         .vpcConfiguration(DataSourceVpcConfigurationProperty.builder()
                                 .securityGroupIds(List.of("securityGroupIds"))
                                 .subnetIds(List.of("subnetIds"))
                                 .build())
                         .build())
                 .webCrawlerConfiguration(WebCrawlerConfigurationProperty.builder()
                         .urls(WebCrawlerUrlsProperty.builder()
                                 .seedUrlConfiguration(WebCrawlerSeedUrlConfigurationProperty.builder()
                                         .seedUrls(List.of("seedUrls"))
                                         // the properties below are optional
                                         .webCrawlerMode("webCrawlerMode")
                                         .build())
                                 .siteMapsConfiguration(WebCrawlerSiteMapsConfigurationProperty.builder()
                                         .siteMaps(List.of("siteMaps"))
                                         .build())
                                 .build())
                         // the properties below are optional
                         .authenticationConfiguration(WebCrawlerAuthenticationConfigurationProperty.builder()
                                 .basicAuthentication(List.of(WebCrawlerBasicAuthenticationProperty.builder()
                                         .credentials("credentials")
                                         .host("host")
                                         .port(123)
                                         .build()))
                                 .build())
                         .crawlDepth(123)
                         .maxContentSizePerPageInMegaBytes(123)
                         .maxLinksPerPage(123)
                         .maxUrlsPerMinuteCrawlRate(123)
                         .proxyConfiguration(ProxyConfigurationProperty.builder()
                                 .host("host")
                                 .port(123)
                                 // the properties below are optional
                                 .credentials("credentials")
                                 .build())
                         .urlExclusionPatterns(List.of("urlExclusionPatterns"))
                         .urlInclusionPatterns(List.of("urlInclusionPatterns"))
                         .build())
                 .workDocsConfiguration(WorkDocsConfigurationProperty.builder()
                         .organizationId("organizationId")
                         // the properties below are optional
                         .crawlComments(false)
                         .exclusionPatterns(List.of("exclusionPatterns"))
                         .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                                 .dataSourceFieldName("dataSourceFieldName")
                                 .indexFieldName("indexFieldName")
                                 // the properties below are optional
                                 .dateFieldFormat("dateFieldFormat")
                                 .build()))
                         .inclusionPatterns(List.of("inclusionPatterns"))
                         .useChangeLog(false)
                         .build())
                 .build())
         .description("description")
         .roleArn("roleArn")
         .schedule("schedule")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnDataSource.AccessControlListConfigurationProperty	Specifies access control list files for the documents in a data source.
static interface	CfnDataSource.AclConfigurationProperty	Provides information about the column that should be used for filtering the query response by groups.
static final class	CfnDataSource.Builder	A fluent builder for CfnDataSource.
static interface	CfnDataSource.ColumnConfigurationProperty	Provides information about how Amazon Kendra should use the columns of a database in an index.
static interface	CfnDataSource.ConfluenceAttachmentConfigurationProperty	Configuration of attachment settings for the Confluence data source.
static interface	CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty	Maps attributes or field names of Confluence attachments to Amazon Kendra index field names.
static interface	CfnDataSource.ConfluenceBlogConfigurationProperty	Configuration of blog settings for the Confluence data source.
static interface	CfnDataSource.ConfluenceBlogToIndexFieldMappingProperty	Maps attributes or field names of Confluence blog to Amazon Kendra index field names.
static interface	CfnDataSource.ConfluenceConfigurationProperty	Provides the configuration information to connect to Confluence as your data source.
static interface	CfnDataSource.ConfluencePageConfigurationProperty	Configuration of the page settings for the Confluence data source.
static interface	CfnDataSource.ConfluencePageToIndexFieldMappingProperty	Maps attributes or field names of Confluence pages to Amazon Kendra index field names.
static interface	CfnDataSource.ConfluenceSpaceConfigurationProperty	Configuration information for indexing Confluence spaces.
static interface	CfnDataSource.ConfluenceSpaceToIndexFieldMappingProperty	Maps attributes or field names of Confluence spaces to Amazon Kendra index field names.
static interface	CfnDataSource.ConnectionConfigurationProperty	Provides the configuration information that's required to connect to a database.
static interface	CfnDataSource.CustomDocumentEnrichmentConfigurationProperty	Provides the configuration information for altering document metadata and content during the document ingestion process.
static interface	CfnDataSource.DatabaseConfigurationProperty	Provides the configuration information to connect to a index.
static interface	CfnDataSource.DataSourceConfigurationProperty	Provides the configuration information for an Amazon Kendra data source.
static interface	CfnDataSource.DataSourceToIndexFieldMappingProperty	Maps a column or attribute in the data source to an index field.
static interface	CfnDataSource.DataSourceVpcConfigurationProperty	Provides the configuration information to connect to an Amazon VPC.
static interface	CfnDataSource.DocumentAttributeConditionProperty	The condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra.
static interface	CfnDataSource.DocumentAttributeTargetProperty	The target document attribute or metadata field you want to alter when ingesting documents into Amazon Kendra.
static interface	CfnDataSource.DocumentAttributeValueProperty	The value of a document attribute.
static interface	CfnDataSource.DocumentsMetadataConfigurationProperty	Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes.
static interface	CfnDataSource.GoogleDriveConfigurationProperty	Provides the configuration information to connect to Google Drive as your data source.
static interface	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.
static interface	CfnDataSource.InlineCustomDocumentEnrichmentConfigurationProperty	Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Kendra.
static interface	CfnDataSource.OneDriveConfigurationProperty	Provides the configuration information to connect to OneDrive as your data source.
static interface	CfnDataSource.OneDriveUsersProperty	User accounts whose documents should be indexed.
static interface	CfnDataSource.ProxyConfigurationProperty	Provides the configuration information for a web proxy to connect to website hosts.
static interface	CfnDataSource.S3DataSourceConfigurationProperty	Provides the configuration information to connect to an Amazon S3 bucket.
static interface	CfnDataSource.S3PathProperty	Information required to find a specific file in an Amazon S3 bucket.
static interface	CfnDataSource.SalesforceChatterFeedConfigurationProperty	The configuration information for syncing a Salesforce chatter feed.
static interface	CfnDataSource.SalesforceConfigurationProperty	Provides the configuration information to connect to Salesforce as your data source.
static interface	CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty	Provides the configuration information for indexing Salesforce custom articles.
static interface	CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty	Provides the configuration information for the knowledge article types that Amazon Kendra indexes.
static interface	CfnDataSource.SalesforceStandardKnowledgeArticleTypeConfigurationProperty	Provides the configuration information for standard Salesforce knowledge articles.
static interface	CfnDataSource.SalesforceStandardObjectAttachmentConfigurationProperty	Provides the configuration information for processing attachments to Salesforce standard objects.
static interface	CfnDataSource.SalesforceStandardObjectConfigurationProperty	Specifies configuration information for indexing a single standard object.
static interface	CfnDataSource.ServiceNowConfigurationProperty	Provides the configuration information to connect to ServiceNow as your data source.
static interface	CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty	Provides the configuration information for crawling knowledge articles in the ServiceNow site.
static interface	CfnDataSource.ServiceNowServiceCatalogConfigurationProperty	Provides the configuration information for crawling service catalog items in the ServiceNow site.
static interface	CfnDataSource.SharePointConfigurationProperty	Provides the configuration information to connect to Microsoft SharePoint as your data source.
static interface	CfnDataSource.SqlConfigurationProperty	Provides information that configures Amazon Kendra to use a SQL database.
static interface	CfnDataSource.WebCrawlerAuthenticationConfigurationProperty	Provides the configuration information to connect to websites that require user authentication.
static interface	CfnDataSource.WebCrawlerBasicAuthenticationProperty	Provides the configuration information to connect to websites that require basic user authentication.
static interface	CfnDataSource.WebCrawlerConfigurationProperty	Provides the configuration information required for Amazon Kendra Web Crawler.
static interface	CfnDataSource.WebCrawlerSeedUrlConfigurationProperty	Provides the configuration information of the seed or starting point URLs to crawl.
static interface	CfnDataSource.WebCrawlerSiteMapsConfigurationProperty	Provides the configuration information of the sitemap URLs to crawl.
static interface	CfnDataSource.WebCrawlerUrlsProperty	Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.
static interface	CfnDataSource.WorkDocsConfigurationProperty	Provides the configuration information to connect to Amazon WorkDocs as your data source.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnDataSource(Construct scope, String id, CfnDataSourceProps props)	Create a new AWS::Kendra::DataSource.
protected	CfnDataSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDataSource(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The Amazon Resource Name (ARN) of the data source.
String	getAttrId()	The identifier for the data source.
protected Map<String,Object>	getCfnProperties()
Object	getCustomDocumentEnrichmentConfiguration()	Configuration information for altering document metadata and content during the document ingestion process.
Object	getDataSourceConfiguration()	Configuration information for an Amazon Kendra data source.
String	getDescription()	A description for the data source connector.
String	getIndexId()	The identifier of the index you want to use with the data source connector.
String	getName()	The name of the data source.
String	getRoleArn()	The Amazon Resource Name (ARN) of a role with permission to access the data source.
String	getSchedule()	Sets the frequency that Amazon Kendra checks the documents in your data source and updates the index.
TagManager	getTags()	An array of key-value pairs to apply to this resource.
String	getType()	The type of the data source.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCustomDocumentEnrichmentConfiguration(IResolvable value)	Configuration information for altering document metadata and content during the document ingestion process.
void	setCustomDocumentEnrichmentConfiguration(CfnDataSource.CustomDocumentEnrichmentConfigurationProperty value)	Configuration information for altering document metadata and content during the document ingestion process.
void	setDataSourceConfiguration(IResolvable value)	Configuration information for an Amazon Kendra data source.
void	setDataSourceConfiguration(CfnDataSource.DataSourceConfigurationProperty value)	Configuration information for an Amazon Kendra data source.
void	setDescription(String value)	A description for the data source connector.
void	setIndexId(String value)	The identifier of the index you want to use with the data source connector.
void	setName(String value)	The name of the data source.
void	setRoleArn(String value)	The Amazon Resource Name (ARN) of a role with permission to access the data source.
void	setSchedule(String value)	Sets the frequency that Amazon Kendra checks the documents in your data source and updates the index.
void	setType(String value)	The type of the data source.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnDataSource

protected CfnDataSource(software.amazon.jsii.JsiiObjectRef objRef)

CfnDataSource

protected CfnDataSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDataSource

@Stability(Stable)
public CfnDataSource(@NotNull
 Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnDataSourceProps props)

Create a new AWS::Kendra::DataSource.

Parameters:

scope -

• scope in which this resource is defined.

This parameter is required.

id -

• scoped id of the resource.

This parameter is required.

props -

• resource properties.

This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector -

• tree inspector to collect and process attributes.

This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

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

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

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

The identifier for the data source. For example:.

b8cae438-6787-4091-8897-684a652bbb0a .

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

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

For more information, see Tag .

getIndexId

@Stability(Stable)
@NotNull
public String getIndexId()

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

setIndexId

@Stability(Stable)
public void setIndexId(@NotNull
 String value)

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

getName

@Stability(Stable)
@NotNull
public String getName()

The name of the data source.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name of the data source.

getType

@Stability(Stable)
@NotNull
public String getType()

The type of the data source.

setType

@Stability(Stable)
public void setType(@NotNull
 String value)

The type of the data source.

getCustomDocumentEnrichmentConfiguration

@Stability(Stable)
@Nullable
public Object getCustomDocumentEnrichmentConfiguration()

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

setCustomDocumentEnrichmentConfiguration

@Stability(Stable)
public void setCustomDocumentEnrichmentConfiguration(@Nullable
 CfnDataSource.CustomDocumentEnrichmentConfigurationProperty value)

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

setCustomDocumentEnrichmentConfiguration

@Stability(Stable)
public void setCustomDocumentEnrichmentConfiguration(@Nullable
 IResolvable value)

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

getDataSourceConfiguration

@Stability(Stable)
@Nullable
public Object getDataSourceConfiguration()

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.

setDataSourceConfiguration

@Stability(Stable)
public void setDataSourceConfiguration(@Nullable
 IResolvable value)

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.

setDataSourceConfiguration

@Stability(Stable)
public void setDataSourceConfiguration(@Nullable
 CfnDataSource.DataSourceConfigurationProperty value)

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.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

A description for the data source connector.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

A description for the data source connector.

getRoleArn

@Stability(Stable)
@Nullable
public String getRoleArn()

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.

setRoleArn

@Stability(Stable)
public void setRoleArn(@Nullable
 String value)

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.

getSchedule

@Stability(Stable)
@Nullable
public String getSchedule()

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.

setSchedule

@Stability(Stable)
public void setSchedule(@Nullable
 String value)

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.