Package software.amazon.awscdk.services.kendra

Interface CfnDataSource.DataSourceConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.DataSourceConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(Stable)
public static interface CfnDataSource.DataSourceConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Provides the configuration information for an Amazon Kendra data source.

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.*;
 DataSourceConfigurationProperty dataSourceConfigurationProperty = 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())
         .templateConfiguration(TemplateConfigurationProperty.builder()
                 .template("template")
                 .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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataSource.DataSourceConfigurationProperty.Builder	A builder for CfnDataSource.DataSourceConfigurationProperty
static final class	CfnDataSource.DataSourceConfigurationProperty.Jsii$Proxy	An implementation for CfnDataSource.DataSourceConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.DataSourceConfigurationProperty.Builder	builder()
default Object	getConfluenceConfiguration()	Provides the configuration information to connect to Confluence as your data source.
default Object	getDatabaseConfiguration()	Provides the configuration information to connect to a database as your data source.
default Object	getGoogleDriveConfiguration()	Provides the configuration information to connect to Google Drive as your data source.
default Object	getOneDriveConfiguration()	Provides the configuration information to connect to Microsoft OneDrive as your data source.
default Object	getS3Configuration()	Provides the configuration information to connect to an Amazon S3 bucket as your data source.
default Object	getSalesforceConfiguration()	Provides the configuration information to connect to Salesforce as your data source.
default Object	getServiceNowConfiguration()	Provides the configuration information to connect to ServiceNow as your data source.
default Object	getSharePointConfiguration()	Provides the configuration information to connect to Microsoft SharePoint as your data source.
default Object	getTemplateConfiguration()	Provides a template for the configuration information to connect to your data source.
default Object	getWebCrawlerConfiguration()	Provides the configuration information required for Amazon Kendra Web Crawler.
default Object	getWorkDocsConfiguration()	Provides the configuration information to connect to WorkDocs as your data source.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConfluenceConfiguration

@Stability(Stable)
@Nullable
default Object getConfluenceConfiguration()

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

Returns union: either IResolvable or CfnDataSource.ConfluenceConfigurationProperty

See Also:

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

getDatabaseConfiguration

@Stability(Stable)
@Nullable
default Object getDatabaseConfiguration()

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

Returns union: either IResolvable or CfnDataSource.DatabaseConfigurationProperty

See Also:

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

getGoogleDriveConfiguration

@Stability(Stable)
@Nullable
default Object getGoogleDriveConfiguration()

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

Returns union: either IResolvable or CfnDataSource.GoogleDriveConfigurationProperty

See Also:

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

getOneDriveConfiguration

@Stability(Stable)
@Nullable
default Object getOneDriveConfiguration()

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

Returns union: either IResolvable or CfnDataSource.OneDriveConfigurationProperty

See Also:

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

getS3Configuration

@Stability(Stable)
@Nullable
default Object getS3Configuration()

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.

Returns union: either IResolvable or CfnDataSource.S3DataSourceConfigurationProperty

See Also:

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

getSalesforceConfiguration

@Stability(Stable)
@Nullable
default Object getSalesforceConfiguration()

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

Returns union: either IResolvable or CfnDataSource.SalesforceConfigurationProperty

See Also:

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

getServiceNowConfiguration

@Stability(Stable)
@Nullable
default Object getServiceNowConfiguration()

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

Returns union: either IResolvable or CfnDataSource.ServiceNowConfigurationProperty

See Also:

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

getSharePointConfiguration

@Stability(Stable)
@Nullable
default Object getSharePointConfiguration()

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

Returns union: either IResolvable or CfnDataSource.SharePointConfigurationProperty

See Also:

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

getTemplateConfiguration

@Stability(Stable)
@Nullable
default Object getTemplateConfiguration()

Provides a template for the configuration information to connect to your data source.

Returns union: either IResolvable or CfnDataSource.TemplateConfigurationProperty

See Also:

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

getWebCrawlerConfiguration

@Stability(Stable)
@Nullable
default Object getWebCrawlerConfiguration()

Provides the configuration information required for Amazon Kendra Web Crawler.

Returns union: either IResolvable or CfnDataSource.WebCrawlerConfigurationProperty

See Also:

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

getWorkDocsConfiguration

@Stability(Stable)
@Nullable
default Object getWorkDocsConfiguration()

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

Returns union: either IResolvable or CfnDataSource.WorkDocsConfigurationProperty

See Also:

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

builder

@Stability(Stable)
static CfnDataSource.DataSourceConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.DataSourceConfigurationProperty.Builder of CfnDataSource.DataSourceConfigurationProperty