Class CfnDataSourcePropsMixin
java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.mixins.preview.core.Mixin
software.amazon.awscdk.mixins.preview.services.kendra.mixins.CfnDataSourcePropsMixin
- All Implemented Interfaces:
IMixin,software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
date="2025-12-18T18:20:27.443Z")
@Stability(Stable)
public class CfnDataSourcePropsMixin
extends Mixin
implements IMixin
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.
CreateDataSourcedoes not support connectors which require aTemplateConfigurationobject for connecting to Amazon Kendra .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.mixins.preview.mixins.*;
import software.amazon.awscdk.mixins.preview.services.kendra.mixins.*;
CfnDataSourcePropsMixin cfnDataSourcePropsMixin = CfnDataSourcePropsMixin.Builder.create(CfnDataSourceMixinProps.builder()
.customDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfigurationProperty.builder()
.inlineConfigurations(List.of(InlineCustomDocumentEnrichmentConfigurationProperty.builder()
.condition(DocumentAttributeConditionProperty.builder()
.conditionDocumentAttributeKey("conditionDocumentAttributeKey")
.conditionOnValue(DocumentAttributeValueProperty.builder()
.dateValue("dateValue")
.longValue(123)
.stringListValue(List.of("stringListValue"))
.stringValue("stringValue")
.build())
.operator("operator")
.build())
.documentContentDeletion(false)
.target(DocumentAttributeTargetProperty.builder()
.targetDocumentAttributeKey("targetDocumentAttributeKey")
.targetDocumentAttributeValue(DocumentAttributeValueProperty.builder()
.dateValue("dateValue")
.longValue(123)
.stringListValue(List.of("stringListValue"))
.stringValue("stringValue")
.build())
.targetDocumentAttributeValueDeletion(false)
.build())
.build()))
.postExtractionHookConfiguration(HookConfigurationProperty.builder()
.invocationCondition(DocumentAttributeConditionProperty.builder()
.conditionDocumentAttributeKey("conditionDocumentAttributeKey")
.conditionOnValue(DocumentAttributeValueProperty.builder()
.dateValue("dateValue")
.longValue(123)
.stringListValue(List.of("stringListValue"))
.stringValue("stringValue")
.build())
.operator("operator")
.build())
.lambdaArn("lambdaArn")
.s3Bucket("s3Bucket")
.build())
.preExtractionHookConfiguration(HookConfigurationProperty.builder()
.invocationCondition(DocumentAttributeConditionProperty.builder()
.conditionDocumentAttributeKey("conditionDocumentAttributeKey")
.conditionOnValue(DocumentAttributeValueProperty.builder()
.dateValue("dateValue")
.longValue(123)
.stringListValue(List.of("stringListValue"))
.stringValue("stringValue")
.build())
.operator("operator")
.build())
.lambdaArn("lambdaArn")
.s3Bucket("s3Bucket")
.build())
.roleArn("roleArn")
.build())
.dataSourceConfiguration(DataSourceConfigurationProperty.builder()
.confluenceConfiguration(ConfluenceConfigurationProperty.builder()
.attachmentConfiguration(ConfluenceAttachmentConfigurationProperty.builder()
.attachmentFieldMappings(List.of(ConfluenceAttachmentToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.dateFieldFormat("dateFieldFormat")
.indexFieldName("indexFieldName")
.build()))
.crawlAttachments(false)
.build())
.blogConfiguration(ConfluenceBlogConfigurationProperty.builder()
.blogFieldMappings(List.of(ConfluenceBlogToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.dateFieldFormat("dateFieldFormat")
.indexFieldName("indexFieldName")
.build()))
.build())
.exclusionPatterns(List.of("exclusionPatterns"))
.inclusionPatterns(List.of("inclusionPatterns"))
.pageConfiguration(ConfluencePageConfigurationProperty.builder()
.pageFieldMappings(List.of(ConfluencePageToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.dateFieldFormat("dateFieldFormat")
.indexFieldName("indexFieldName")
.build()))
.build())
.secretArn("secretArn")
.serverUrl("serverUrl")
.spaceConfiguration(ConfluenceSpaceConfigurationProperty.builder()
.crawlArchivedSpaces(false)
.crawlPersonalSpaces(false)
.excludeSpaces(List.of("excludeSpaces"))
.includeSpaces(List.of("includeSpaces"))
.spaceFieldMappings(List.of(ConfluenceSpaceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.dateFieldFormat("dateFieldFormat")
.indexFieldName("indexFieldName")
.build()))
.build())
.version("version")
.vpcConfiguration(DataSourceVpcConfigurationProperty.builder()
.securityGroupIds(List.of("securityGroupIds"))
.subnetIds(List.of("subnetIds"))
.build())
.build())
.databaseConfiguration(DatabaseConfigurationProperty.builder()
.aclConfiguration(AclConfigurationProperty.builder()
.allowedGroupsColumnName("allowedGroupsColumnName")
.build())
.columnConfiguration(ColumnConfigurationProperty.builder()
.changeDetectingColumns(List.of("changeDetectingColumns"))
.documentDataColumnName("documentDataColumnName")
.documentIdColumnName("documentIdColumnName")
.documentTitleColumnName("documentTitleColumnName")
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.dateFieldFormat("dateFieldFormat")
.indexFieldName("indexFieldName")
.build()))
.build())
.connectionConfiguration(ConnectionConfigurationProperty.builder()
.databaseHost("databaseHost")
.databaseName("databaseName")
.databasePort(123)
.secretArn("secretArn")
.tableName("tableName")
.build())
.databaseEngineType("databaseEngineType")
.sqlConfiguration(SqlConfigurationProperty.builder()
.queryIdentifiersEnclosingOption("queryIdentifiersEnclosingOption")
.build())
.vpcConfiguration(DataSourceVpcConfigurationProperty.builder()
.securityGroupIds(List.of("securityGroupIds"))
.subnetIds(List.of("subnetIds"))
.build())
.build())
.googleDriveConfiguration(GoogleDriveConfigurationProperty.builder()
.excludeMimeTypes(List.of("excludeMimeTypes"))
.excludeSharedDrives(List.of("excludeSharedDrives"))
.excludeUserAccounts(List.of("excludeUserAccounts"))
.exclusionPatterns(List.of("exclusionPatterns"))
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.dateFieldFormat("dateFieldFormat")
.indexFieldName("indexFieldName")
.build()))
.inclusionPatterns(List.of("inclusionPatterns"))
.secretArn("secretArn")
.build())
.oneDriveConfiguration(OneDriveConfigurationProperty.builder()
.disableLocalGroups(false)
.exclusionPatterns(List.of("exclusionPatterns"))
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.dateFieldFormat("dateFieldFormat")
.indexFieldName("indexFieldName")
.build()))
.inclusionPatterns(List.of("inclusionPatterns"))
.oneDriveUsers(OneDriveUsersProperty.builder()
.oneDriveUserList(List.of("oneDriveUserList"))
.oneDriveUserS3Path(S3PathProperty.builder()
.bucket("bucket")
.key("key")
.build())
.build())
.secretArn("secretArn")
.tenantDomain("tenantDomain")
.build())
.s3Configuration(S3DataSourceConfigurationProperty.builder()
.accessControlListConfiguration(AccessControlListConfigurationProperty.builder()
.keyPath("keyPath")
.build())
.bucketName("bucketName")
.documentsMetadataConfiguration(DocumentsMetadataConfigurationProperty.builder()
.s3Prefix("s3Prefix")
.build())
.exclusionPatterns(List.of("exclusionPatterns"))
.inclusionPatterns(List.of("inclusionPatterns"))
.inclusionPrefixes(List.of("inclusionPrefixes"))
.build())
.salesforceConfiguration(SalesforceConfigurationProperty.builder()
.chatterFeedConfiguration(SalesforceChatterFeedConfigurationProperty.builder()
.documentDataFieldName("documentDataFieldName")
.documentTitleFieldName("documentTitleFieldName")
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.dateFieldFormat("dateFieldFormat")
.indexFieldName("indexFieldName")
.build()))
.includeFilterTypes(List.of("includeFilterTypes"))
.build())
.crawlAttachments(false)
.excludeAttachmentFilePatterns(List.of("excludeAttachmentFilePatterns"))
.includeAttachmentFilePatterns(List.of("includeAttachmentFilePatterns"))
.knowledgeArticleConfiguration(SalesforceKnowledgeArticleConfigurationProperty.builder()
.customKnowledgeArticleTypeConfigurations(List.of(SalesforceCustomKnowledgeArticleTypeConfigurationProperty.builder()
.documentDataFieldName("documentDataFieldName")
.documentTitleFieldName("documentTitleFieldName")
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.dateFieldFormat("dateFieldFormat")
.indexFieldName("indexFieldName")
.build()))
.name("name")
.build()))
.includedStates(List.of("includedStates"))
.standardKnowledgeArticleTypeConfiguration(SalesforceStandardKnowledgeArticleTypeConfigurationProperty.builder()
.documentDataFieldName("documentDataFieldName")
.documentTitleFieldName("documentTitleFieldName")
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.dateFieldFormat("dateFieldFormat")
.indexFieldName("indexFieldName")
.build()))
.build())
.build())
.secretArn("secretArn")
.serverUrl("serverUrl")
.standardObjectAttachmentConfiguration(SalesforceStandardObjectAttachmentConfigurationProperty.builder()
.documentTitleFieldName("documentTitleFieldName")
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.dateFieldFormat("dateFieldFormat")
.indexFieldName("indexFieldName")
.build()))
.build())
.standardObjectConfigurations(List.of(SalesforceStandardObjectConfigurationProperty.builder()
.documentDataFieldName("documentDataFieldName")
.documentTitleFieldName("documentTitleFieldName")
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.dateFieldFormat("dateFieldFormat")
.indexFieldName("indexFieldName")
.build()))
.name("name")
.build()))
.build())
.serviceNowConfiguration(ServiceNowConfigurationProperty.builder()
.authenticationType("authenticationType")
.hostUrl("hostUrl")
.knowledgeArticleConfiguration(ServiceNowKnowledgeArticleConfigurationProperty.builder()
.crawlAttachments(false)
.documentDataFieldName("documentDataFieldName")
.documentTitleFieldName("documentTitleFieldName")
.excludeAttachmentFilePatterns(List.of("excludeAttachmentFilePatterns"))
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.dateFieldFormat("dateFieldFormat")
.indexFieldName("indexFieldName")
.build()))
.filterQuery("filterQuery")
.includeAttachmentFilePatterns(List.of("includeAttachmentFilePatterns"))
.build())
.secretArn("secretArn")
.serviceCatalogConfiguration(ServiceNowServiceCatalogConfigurationProperty.builder()
.crawlAttachments(false)
.documentDataFieldName("documentDataFieldName")
.documentTitleFieldName("documentTitleFieldName")
.excludeAttachmentFilePatterns(List.of("excludeAttachmentFilePatterns"))
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.dateFieldFormat("dateFieldFormat")
.indexFieldName("indexFieldName")
.build()))
.includeAttachmentFilePatterns(List.of("includeAttachmentFilePatterns"))
.build())
.serviceNowBuildVersion("serviceNowBuildVersion")
.build())
.sharePointConfiguration(SharePointConfigurationProperty.builder()
.crawlAttachments(false)
.disableLocalGroups(false)
.documentTitleFieldName("documentTitleFieldName")
.exclusionPatterns(List.of("exclusionPatterns"))
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.dateFieldFormat("dateFieldFormat")
.indexFieldName("indexFieldName")
.build()))
.inclusionPatterns(List.of("inclusionPatterns"))
.secretArn("secretArn")
.sharePointVersion("sharePointVersion")
.sslCertificateS3Path(S3PathProperty.builder()
.bucket("bucket")
.key("key")
.build())
.urls(List.of("urls"))
.useChangeLog(false)
.vpcConfiguration(DataSourceVpcConfigurationProperty.builder()
.securityGroupIds(List.of("securityGroupIds"))
.subnetIds(List.of("subnetIds"))
.build())
.build())
.templateConfiguration(TemplateConfigurationProperty.builder()
.template("template")
.build())
.webCrawlerConfiguration(WebCrawlerConfigurationProperty.builder()
.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()
.credentials("credentials")
.host("host")
.port(123)
.build())
.urlExclusionPatterns(List.of("urlExclusionPatterns"))
.urlInclusionPatterns(List.of("urlInclusionPatterns"))
.urls(WebCrawlerUrlsProperty.builder()
.seedUrlConfiguration(WebCrawlerSeedUrlConfigurationProperty.builder()
.seedUrls(List.of("seedUrls"))
.webCrawlerMode("webCrawlerMode")
.build())
.siteMapsConfiguration(WebCrawlerSiteMapsConfigurationProperty.builder()
.siteMaps(List.of("siteMaps"))
.build())
.build())
.build())
.workDocsConfiguration(WorkDocsConfigurationProperty.builder()
.crawlComments(false)
.exclusionPatterns(List.of("exclusionPatterns"))
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.dateFieldFormat("dateFieldFormat")
.indexFieldName("indexFieldName")
.build()))
.inclusionPatterns(List.of("inclusionPatterns"))
.organizationId("organizationId")
.useChangeLog(false)
.build())
.build())
.description("description")
.indexId("indexId")
.languageCode("languageCode")
.name("name")
.roleArn("roleArn")
.schedule("schedule")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.type("type")
.build())
.strategy(PropertyMergeStrategy.OVERRIDE)
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceSpecifies access control list files for the documents in a data source.static interfaceProvides information about the column that should be used for filtering the query response by groups.static final classA fluent builder forCfnDataSourcePropsMixin.static interfaceProvides information about how Amazon Kendra should use the columns of a database in an index.static interfaceConfiguration of attachment settings for the Confluence data source.static interfaceMaps attributes or field names of Confluence attachments to Amazon Kendra index field names.static interfaceConfiguration of blog settings for the Confluence data source.static interfaceMaps attributes or field names of Confluence blog to Amazon Kendra index field names.static interfaceProvides the configuration information to connect to Confluence as your data source.static interfaceConfiguration of the page settings for the Confluence data source.static interfaceMaps attributes or field names of Confluence pages to Amazon Kendra index field names.static interfaceConfiguration information for indexing Confluence spaces.static interfaceMaps attributes or field names of Confluence spaces to Amazon Kendra index field names.static interfaceProvides the configuration information that's required to connect to a database.static interfaceProvides the configuration information for altering document metadata and content during the document ingestion process.static interfaceProvides the configuration information to an Amazon Kendra supported database .static interfaceProvides the configuration information for an Amazon Kendra data source.static interfaceMaps a column or attribute in the data source to an index field.static interfaceProvides the configuration information to connect to an Amazon VPC.static interfaceThe condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra.static interfaceThe target document attribute or metadata field you want to alter when ingesting documents into Amazon Kendra.static interfaceThe value of a document attribute.static interfaceDocument metadata files that contain information such as the document access control information, source URI, document author, and custom attributes.static interfaceProvides the configuration information to connect to Google Drive as your data source.static interfaceProvides the configuration information for invoking a Lambda function in AWS Lambda to alter document metadata and content when ingesting documents into Amazon Kendra.static interfaceProvides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Kendra.static interfaceProvides the configuration information to connect to OneDrive as your data source.static interfaceUser accounts whose documents should be indexed.static interfaceProvides the configuration information for a web proxy to connect to website hosts.static interfaceProvides the configuration information to connect to an Amazon S3 bucket.static interfaceInformation required to find a specific file in an Amazon S3 bucket.static interfaceThe configuration information for syncing a Salesforce chatter feed.static interfaceProvides the configuration information to connect to Salesforce as your data source.static interfaceProvides the configuration information for indexing Salesforce custom articles.static interfaceProvides the configuration information for the knowledge article types that Amazon Kendra indexes.static interfaceProvides the configuration information for standard Salesforce knowledge articles.static interfaceProvides the configuration information for processing attachments to Salesforce standard objects.static interfaceSpecifies configuration information for indexing a single standard object.static interfaceProvides the configuration information to connect to ServiceNow as your data source.static interfaceProvides the configuration information for crawling knowledge articles in the ServiceNow site.static interfaceProvides the configuration information for crawling service catalog items in the ServiceNow site.static interfaceProvides the configuration information to connect to Microsoft SharePoint as your data source.static interfaceProvides information that configures Amazon Kendra to use a SQL database.static interfaceProvides a template for the configuration information to connect to your data source.static interfaceProvides the configuration information to connect to websites that require user authentication.static interfaceProvides the configuration information to connect to websites that require basic user authentication.static interfaceProvides the configuration information required for Amazon Kendra Web Crawler.static interfaceProvides the configuration information of the seed or starting point URLs to crawl.static interfaceProvides the configuration information of the sitemap URLs to crawl.static interfaceSpecifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.static interfaceProvides the configuration information to connect to WorkDocs as your data source.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.mixins.preview.core.IMixin
IMixin.Jsii$Default, IMixin.Jsii$Proxy -
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionCreate a mixin to apply properties toAWS::Kendra::DataSource.CfnDataSourcePropsMixin(CfnDataSourceMixinProps props, CfnPropertyMixinOptions options) Create a mixin to apply properties toAWS::Kendra::DataSource.protectedCfnDataSourcePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnDataSourcePropsMixin(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionsoftware.constructs.IConstructapplyTo(software.constructs.IConstruct construct) Apply the mixin properties to the construct.protected CfnDataSourceMixinPropsgetProps()protected PropertyMergeStrategysupports(software.constructs.IConstruct construct) Check if this mixin supports the given construct.Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_PROPERTY_KEYS
-
-
Constructor Details
-
CfnDataSourcePropsMixin
protected CfnDataSourcePropsMixin(software.amazon.jsii.JsiiObjectRef objRef) -
CfnDataSourcePropsMixin
protected CfnDataSourcePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnDataSourcePropsMixin
@Stability(Stable) public CfnDataSourcePropsMixin(@NotNull CfnDataSourceMixinProps props, @Nullable CfnPropertyMixinOptions options) Create a mixin to apply properties toAWS::Kendra::DataSource.- Parameters:
props- L1 properties to apply. This parameter is required.options- Mixin options.
-
CfnDataSourcePropsMixin
Create a mixin to apply properties toAWS::Kendra::DataSource.- Parameters:
props- L1 properties to apply. This parameter is required.
-
-
Method Details
-
applyTo
@Stability(Stable) @NotNull public software.constructs.IConstruct applyTo(@NotNull software.constructs.IConstruct construct) Apply the mixin properties to the construct. -
supports
@Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct) Check if this mixin supports the given construct. -
getProps
-
getStrategy
-