@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:40.165Z") @Stability(value=Stable) public interface CfnDataSourceProps extends software.amazon.jsii.JsiiSerializable
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.*;
CfnDataSourceProps cfnDataSourceProps = CfnDataSourceProps.builder()
.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();
| Modifier and Type | Interface and Description |
|---|---|
static class |
CfnDataSourceProps.Builder
A builder for
CfnDataSourceProps |
static class |
CfnDataSourceProps.Jsii$Proxy
An implementation for
CfnDataSourceProps |
| Modifier and Type | Method and Description |
|---|---|
static CfnDataSourceProps.Builder |
builder() |
default Object |
getCustomDocumentEnrichmentConfiguration()
Configuration information for altering document metadata and content during the document ingestion process.
|
default Object |
getDataSourceConfiguration()
Configuration information for an Amazon Kendra data source.
|
default String |
getDescription()
A description of the data source.
|
String |
getIndexId()
The identifier of the index that should be associated with this data source.
|
String |
getName()
The name of the data source.
|
default String |
getRoleArn()
The Amazon Resource Name (ARN) of a role with permission to access the data source.
|
default String |
getSchedule()
Sets the frequency that Amazon Kendra checks the documents in your data source and updates the index.
|
default List<CfnTag> |
getTags()
An array of key-value pairs to apply to this resource.
|
String |
getType()
The type of the data source.
|
@Stability(value=Stable) @NotNull String getIndexId()
@Stability(value=Stable) @NotNull String getName()
@Stability(value=Stable) @NotNull String getType()
@Stability(value=Stable) @Nullable default Object getCustomDocumentEnrichmentConfiguration()
@Stability(value=Stable) @Nullable default Object getDataSourceConfiguration()
The contents of the configuration depend on the type of data source. You can only specify one type of data source in the configuration. Choose from one of the following data sources.
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.
@Stability(value=Stable) @Nullable default String getDescription()
@Stability(value=Stable) @Nullable default String getRoleArn()
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.
@Stability(value=Stable) @Nullable default String getSchedule()
If you don't set a schedule, Amazon Kendra doesn't periodically update the index.
@Stability(value=Stable) @Nullable default List<CfnTag> getTags()
For more information, see Tag .
@Stability(value=Stable) static CfnDataSourceProps.Builder builder()
CfnDataSourceProps.Builder of CfnDataSourcePropsCopyright © 2022. All rights reserved.