DataSourceConfigurationProperty Struct
Provides the configuration information for an Amazon Kendra data source.
| Source | |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
const dataSourceConfigurationProperty: kendra.CfnDataSource.DataSourceConfigurationProperty = {
confluenceConfiguration: {
secretArn: 'secretArn',
serverUrl: 'serverUrl',
version: 'version',
// the properties below are optional
attachmentConfiguration: {
attachmentFieldMappings: [{
dataSourceFieldName: 'dataSourceFieldName',
indexFieldName: 'indexFieldName',
// the properties below are optional
dateFieldFormat: 'dateFieldFormat',
}],
crawlAttachments: false,
},
blogConfiguration: {
blogFieldMappings: [{
dataSourceFieldName: 'dataSourceFieldName',
indexFieldName: 'indexFieldName',
// the properties below are optional
dateFieldFormat: 'dateFieldFormat',
}],
},
exclusionPatterns: ['exclusionPatterns'],
inclusionPatterns: ['inclusionPatterns'],
pageConfiguration: {
pageFieldMappings: [{
dataSourceFieldName: 'dataSourceFieldName',
indexFieldName: 'indexFieldName',
// the properties below are optional
dateFieldFormat: 'dateFieldFormat',
}],
},
spaceConfiguration: {
crawlArchivedSpaces: false,
crawlPersonalSpaces: false,
excludeSpaces: ['excludeSpaces'],
includeSpaces: ['includeSpaces'],
spaceFieldMappings: [{
dataSourceFieldName: 'dataSourceFieldName',
indexFieldName: 'indexFieldName',
// the properties below are optional
dateFieldFormat: 'dateFieldFormat',
}],
},
vpcConfiguration: {
securityGroupIds: ['securityGroupIds'],
subnetIds: ['subnetIds'],
},
},
databaseConfiguration: {
columnConfiguration: {
changeDetectingColumns: ['changeDetectingColumns'],
documentDataColumnName: 'documentDataColumnName',
documentIdColumnName: 'documentIdColumnName',
// the properties below are optional
documentTitleColumnName: 'documentTitleColumnName',
fieldMappings: [{
dataSourceFieldName: 'dataSourceFieldName',
indexFieldName: 'indexFieldName',
// the properties below are optional
dateFieldFormat: 'dateFieldFormat',
}],
},
connectionConfiguration: {
databaseHost: 'databaseHost',
databaseName: 'databaseName',
databasePort: 123,
secretArn: 'secretArn',
tableName: 'tableName',
},
databaseEngineType: 'databaseEngineType',
// the properties below are optional
aclConfiguration: {
allowedGroupsColumnName: 'allowedGroupsColumnName',
},
sqlConfiguration: {
queryIdentifiersEnclosingOption: 'queryIdentifiersEnclosingOption',
},
vpcConfiguration: {
securityGroupIds: ['securityGroupIds'],
subnetIds: ['subnetIds'],
},
},
googleDriveConfiguration: {
secretArn: 'secretArn',
// the properties below are optional
excludeMimeTypes: ['excludeMimeTypes'],
excludeSharedDrives: ['excludeSharedDrives'],
excludeUserAccounts: ['excludeUserAccounts'],
exclusionPatterns: ['exclusionPatterns'],
fieldMappings: [{
dataSourceFieldName: 'dataSourceFieldName',
indexFieldName: 'indexFieldName',
// the properties below are optional
dateFieldFormat: 'dateFieldFormat',
}],
inclusionPatterns: ['inclusionPatterns'],
},
oneDriveConfiguration: {
oneDriveUsers: {
oneDriveUserList: ['oneDriveUserList'],
oneDriveUserS3Path: {
bucket: 'bucket',
key: 'key',
},
},
secretArn: 'secretArn',
tenantDomain: 'tenantDomain',
// the properties below are optional
disableLocalGroups: false,
exclusionPatterns: ['exclusionPatterns'],
fieldMappings: [{
dataSourceFieldName: 'dataSourceFieldName',
indexFieldName: 'indexFieldName',
// the properties below are optional
dateFieldFormat: 'dateFieldFormat',
}],
inclusionPatterns: ['inclusionPatterns'],
},
s3Configuration: {
bucketName: 'bucketName',
// the properties below are optional
accessControlListConfiguration: {
keyPath: 'keyPath',
},
documentsMetadataConfiguration: {
s3Prefix: 's3Prefix',
},
exclusionPatterns: ['exclusionPatterns'],
inclusionPatterns: ['inclusionPatterns'],
inclusionPrefixes: ['inclusionPrefixes'],
},
salesforceConfiguration: {
secretArn: 'secretArn',
serverUrl: 'serverUrl',
// the properties below are optional
chatterFeedConfiguration: {
documentDataFieldName: 'documentDataFieldName',
// the properties below are optional
documentTitleFieldName: 'documentTitleFieldName',
fieldMappings: [{
dataSourceFieldName: 'dataSourceFieldName',
indexFieldName: 'indexFieldName',
// the properties below are optional
dateFieldFormat: 'dateFieldFormat',
}],
includeFilterTypes: ['includeFilterTypes'],
},
crawlAttachments: false,
excludeAttachmentFilePatterns: ['excludeAttachmentFilePatterns'],
includeAttachmentFilePatterns: ['includeAttachmentFilePatterns'],
knowledgeArticleConfiguration: {
includedStates: ['includedStates'],
// the properties below are optional
customKnowledgeArticleTypeConfigurations: [{
documentDataFieldName: 'documentDataFieldName',
name: 'name',
// the properties below are optional
documentTitleFieldName: 'documentTitleFieldName',
fieldMappings: [{
dataSourceFieldName: 'dataSourceFieldName',
indexFieldName: 'indexFieldName',
// the properties below are optional
dateFieldFormat: 'dateFieldFormat',
}],
}],
standardKnowledgeArticleTypeConfiguration: {
documentDataFieldName: 'documentDataFieldName',
// the properties below are optional
documentTitleFieldName: 'documentTitleFieldName',
fieldMappings: [{
dataSourceFieldName: 'dataSourceFieldName',
indexFieldName: 'indexFieldName',
// the properties below are optional
dateFieldFormat: 'dateFieldFormat',
}],
},
},
standardObjectAttachmentConfiguration: {
documentTitleFieldName: 'documentTitleFieldName',
fieldMappings: [{
dataSourceFieldName: 'dataSourceFieldName',
indexFieldName: 'indexFieldName',
// the properties below are optional
dateFieldFormat: 'dateFieldFormat',
}],
},
standardObjectConfigurations: [{
documentDataFieldName: 'documentDataFieldName',
name: 'name',
// the properties below are optional
documentTitleFieldName: 'documentTitleFieldName',
fieldMappings: [{
dataSourceFieldName: 'dataSourceFieldName',
indexFieldName: 'indexFieldName',
// the properties below are optional
dateFieldFormat: 'dateFieldFormat',
}],
}],
},
serviceNowConfiguration: {
hostUrl: 'hostUrl',
secretArn: 'secretArn',
serviceNowBuildVersion: 'serviceNowBuildVersion',
// the properties below are optional
authenticationType: 'authenticationType',
knowledgeArticleConfiguration: {
documentDataFieldName: 'documentDataFieldName',
// the properties below are optional
crawlAttachments: false,
documentTitleFieldName: 'documentTitleFieldName',
excludeAttachmentFilePatterns: ['excludeAttachmentFilePatterns'],
fieldMappings: [{
dataSourceFieldName: 'dataSourceFieldName',
indexFieldName: 'indexFieldName',
// the properties below are optional
dateFieldFormat: 'dateFieldFormat',
}],
filterQuery: 'filterQuery',
includeAttachmentFilePatterns: ['includeAttachmentFilePatterns'],
},
serviceCatalogConfiguration: {
documentDataFieldName: 'documentDataFieldName',
// the properties below are optional
crawlAttachments: false,
documentTitleFieldName: 'documentTitleFieldName',
excludeAttachmentFilePatterns: ['excludeAttachmentFilePatterns'],
fieldMappings: [{
dataSourceFieldName: 'dataSourceFieldName',
indexFieldName: 'indexFieldName',
// the properties below are optional
dateFieldFormat: 'dateFieldFormat',
}],
includeAttachmentFilePatterns: ['includeAttachmentFilePatterns'],
},
},
sharePointConfiguration: {
secretArn: 'secretArn',
sharePointVersion: 'sharePointVersion',
urls: ['urls'],
// the properties below are optional
crawlAttachments: false,
disableLocalGroups: false,
documentTitleFieldName: 'documentTitleFieldName',
exclusionPatterns: ['exclusionPatterns'],
fieldMappings: [{
dataSourceFieldName: 'dataSourceFieldName',
indexFieldName: 'indexFieldName',
// the properties below are optional
dateFieldFormat: 'dateFieldFormat',
}],
inclusionPatterns: ['inclusionPatterns'],
sslCertificateS3Path: {
bucket: 'bucket',
key: 'key',
},
useChangeLog: false,
vpcConfiguration: {
securityGroupIds: ['securityGroupIds'],
subnetIds: ['subnetIds'],
},
},
templateConfiguration: {
template: 'template',
},
webCrawlerConfiguration: {
urls: {
seedUrlConfiguration: {
seedUrls: ['seedUrls'],
// the properties below are optional
webCrawlerMode: 'webCrawlerMode',
},
siteMapsConfiguration: {
siteMaps: ['siteMaps'],
},
},
// the properties below are optional
authenticationConfiguration: {
basicAuthentication: [{
credentials: 'credentials',
host: 'host',
port: 123,
}],
},
crawlDepth: 123,
maxContentSizePerPageInMegaBytes: 123,
maxLinksPerPage: 123,
maxUrlsPerMinuteCrawlRate: 123,
proxyConfiguration: {
host: 'host',
port: 123,
// the properties below are optional
credentials: 'credentials',
},
urlExclusionPatterns: ['urlExclusionPatterns'],
urlInclusionPatterns: ['urlInclusionPatterns'],
},
workDocsConfiguration: {
organizationId: 'organizationId',
// the properties below are optional
crawlComments: false,
exclusionPatterns: ['exclusionPatterns'],
fieldMappings: [{
dataSourceFieldName: 'dataSourceFieldName',
indexFieldName: 'indexFieldName',
// the properties below are optional
dateFieldFormat: 'dateFieldFormat',
}],
inclusionPatterns: ['inclusionPatterns'],
useChangeLog: false,
},
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_kendra as kendra
data_source_configuration_property = kendra.CfnDataSource.DataSourceConfigurationProperty(
confluence_configuration=kendra.CfnDataSource.ConfluenceConfigurationProperty(
secret_arn="secretArn",
server_url="serverUrl",
version="version",
# the properties below are optional
attachment_configuration=kendra.CfnDataSource.ConfluenceAttachmentConfigurationProperty(
attachment_field_mappings=[kendra.CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty(
data_source_field_name="dataSourceFieldName",
index_field_name="indexFieldName",
# the properties below are optional
date_field_format="dateFieldFormat"
)],
crawl_attachments=False
),
blog_configuration=kendra.CfnDataSource.ConfluenceBlogConfigurationProperty(
blog_field_mappings=[kendra.CfnDataSource.ConfluenceBlogToIndexFieldMappingProperty(
data_source_field_name="dataSourceFieldName",
index_field_name="indexFieldName",
# the properties below are optional
date_field_format="dateFieldFormat"
)]
),
exclusion_patterns=["exclusionPatterns"],
inclusion_patterns=["inclusionPatterns"],
page_configuration=kendra.CfnDataSource.ConfluencePageConfigurationProperty(
page_field_mappings=[kendra.CfnDataSource.ConfluencePageToIndexFieldMappingProperty(
data_source_field_name="dataSourceFieldName",
index_field_name="indexFieldName",
# the properties below are optional
date_field_format="dateFieldFormat"
)]
),
space_configuration=kendra.CfnDataSource.ConfluenceSpaceConfigurationProperty(
crawl_archived_spaces=False,
crawl_personal_spaces=False,
exclude_spaces=["excludeSpaces"],
include_spaces=["includeSpaces"],
space_field_mappings=[kendra.CfnDataSource.ConfluenceSpaceToIndexFieldMappingProperty(
data_source_field_name="dataSourceFieldName",
index_field_name="indexFieldName",
# the properties below are optional
date_field_format="dateFieldFormat"
)]
),
vpc_configuration=kendra.CfnDataSource.DataSourceVpcConfigurationProperty(
security_group_ids=["securityGroupIds"],
subnet_ids=["subnetIds"]
)
),
database_configuration=kendra.CfnDataSource.DatabaseConfigurationProperty(
column_configuration=kendra.CfnDataSource.ColumnConfigurationProperty(
change_detecting_columns=["changeDetectingColumns"],
document_data_column_name="documentDataColumnName",
document_id_column_name="documentIdColumnName",
# the properties below are optional
document_title_column_name="documentTitleColumnName",
field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
data_source_field_name="dataSourceFieldName",
index_field_name="indexFieldName",
# the properties below are optional
date_field_format="dateFieldFormat"
)]
),
connection_configuration=kendra.CfnDataSource.ConnectionConfigurationProperty(
database_host="databaseHost",
database_name="databaseName",
database_port=123,
secret_arn="secretArn",
table_name="tableName"
),
database_engine_type="databaseEngineType",
# the properties below are optional
acl_configuration=kendra.CfnDataSource.AclConfigurationProperty(
allowed_groups_column_name="allowedGroupsColumnName"
),
sql_configuration=kendra.CfnDataSource.SqlConfigurationProperty(
query_identifiers_enclosing_option="queryIdentifiersEnclosingOption"
),
vpc_configuration=kendra.CfnDataSource.DataSourceVpcConfigurationProperty(
security_group_ids=["securityGroupIds"],
subnet_ids=["subnetIds"]
)
),
google_drive_configuration=kendra.CfnDataSource.GoogleDriveConfigurationProperty(
secret_arn="secretArn",
# the properties below are optional
exclude_mime_types=["excludeMimeTypes"],
exclude_shared_drives=["excludeSharedDrives"],
exclude_user_accounts=["excludeUserAccounts"],
exclusion_patterns=["exclusionPatterns"],
field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
data_source_field_name="dataSourceFieldName",
index_field_name="indexFieldName",
# the properties below are optional
date_field_format="dateFieldFormat"
)],
inclusion_patterns=["inclusionPatterns"]
),
one_drive_configuration=kendra.CfnDataSource.OneDriveConfigurationProperty(
one_drive_users=kendra.CfnDataSource.OneDriveUsersProperty(
one_drive_user_list=["oneDriveUserList"],
one_drive_user_s3_path=kendra.CfnDataSource.S3PathProperty(
bucket="bucket",
key="key"
)
),
secret_arn="secretArn",
tenant_domain="tenantDomain",
# the properties below are optional
disable_local_groups=False,
exclusion_patterns=["exclusionPatterns"],
field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
data_source_field_name="dataSourceFieldName",
index_field_name="indexFieldName",
# the properties below are optional
date_field_format="dateFieldFormat"
)],
inclusion_patterns=["inclusionPatterns"]
),
s3_configuration=kendra.CfnDataSource.S3DataSourceConfigurationProperty(
bucket_name="bucketName",
# the properties below are optional
access_control_list_configuration=kendra.CfnDataSource.AccessControlListConfigurationProperty(
key_path="keyPath"
),
documents_metadata_configuration=kendra.CfnDataSource.DocumentsMetadataConfigurationProperty(
s3_prefix="s3Prefix"
),
exclusion_patterns=["exclusionPatterns"],
inclusion_patterns=["inclusionPatterns"],
inclusion_prefixes=["inclusionPrefixes"]
),
salesforce_configuration=kendra.CfnDataSource.SalesforceConfigurationProperty(
secret_arn="secretArn",
server_url="serverUrl",
# the properties below are optional
chatter_feed_configuration=kendra.CfnDataSource.SalesforceChatterFeedConfigurationProperty(
document_data_field_name="documentDataFieldName",
# the properties below are optional
document_title_field_name="documentTitleFieldName",
field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
data_source_field_name="dataSourceFieldName",
index_field_name="indexFieldName",
# the properties below are optional
date_field_format="dateFieldFormat"
)],
include_filter_types=["includeFilterTypes"]
),
crawl_attachments=False,
exclude_attachment_file_patterns=["excludeAttachmentFilePatterns"],
include_attachment_file_patterns=["includeAttachmentFilePatterns"],
knowledge_article_configuration=kendra.CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty(
included_states=["includedStates"],
# the properties below are optional
custom_knowledge_article_type_configurations=[kendra.CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty(
document_data_field_name="documentDataFieldName",
name="name",
# the properties below are optional
document_title_field_name="documentTitleFieldName",
field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
data_source_field_name="dataSourceFieldName",
index_field_name="indexFieldName",
# the properties below are optional
date_field_format="dateFieldFormat"
)]
)],
standard_knowledge_article_type_configuration=kendra.CfnDataSource.SalesforceStandardKnowledgeArticleTypeConfigurationProperty(
document_data_field_name="documentDataFieldName",
# the properties below are optional
document_title_field_name="documentTitleFieldName",
field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
data_source_field_name="dataSourceFieldName",
index_field_name="indexFieldName",
# the properties below are optional
date_field_format="dateFieldFormat"
)]
)
),
standard_object_attachment_configuration=kendra.CfnDataSource.SalesforceStandardObjectAttachmentConfigurationProperty(
document_title_field_name="documentTitleFieldName",
field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
data_source_field_name="dataSourceFieldName",
index_field_name="indexFieldName",
# the properties below are optional
date_field_format="dateFieldFormat"
)]
),
standard_object_configurations=[kendra.CfnDataSource.SalesforceStandardObjectConfigurationProperty(
document_data_field_name="documentDataFieldName",
name="name",
# the properties below are optional
document_title_field_name="documentTitleFieldName",
field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
data_source_field_name="dataSourceFieldName",
index_field_name="indexFieldName",
# the properties below are optional
date_field_format="dateFieldFormat"
)]
)]
),
service_now_configuration=kendra.CfnDataSource.ServiceNowConfigurationProperty(
host_url="hostUrl",
secret_arn="secretArn",
service_now_build_version="serviceNowBuildVersion",
# the properties below are optional
authentication_type="authenticationType",
knowledge_article_configuration=kendra.CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty(
document_data_field_name="documentDataFieldName",
# the properties below are optional
crawl_attachments=False,
document_title_field_name="documentTitleFieldName",
exclude_attachment_file_patterns=["excludeAttachmentFilePatterns"],
field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
data_source_field_name="dataSourceFieldName",
index_field_name="indexFieldName",
# the properties below are optional
date_field_format="dateFieldFormat"
)],
filter_query="filterQuery",
include_attachment_file_patterns=["includeAttachmentFilePatterns"]
),
service_catalog_configuration=kendra.CfnDataSource.ServiceNowServiceCatalogConfigurationProperty(
document_data_field_name="documentDataFieldName",
# the properties below are optional
crawl_attachments=False,
document_title_field_name="documentTitleFieldName",
exclude_attachment_file_patterns=["excludeAttachmentFilePatterns"],
field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
data_source_field_name="dataSourceFieldName",
index_field_name="indexFieldName",
# the properties below are optional
date_field_format="dateFieldFormat"
)],
include_attachment_file_patterns=["includeAttachmentFilePatterns"]
)
),
share_point_configuration=kendra.CfnDataSource.SharePointConfigurationProperty(
secret_arn="secretArn",
share_point_version="sharePointVersion",
urls=["urls"],
# the properties below are optional
crawl_attachments=False,
disable_local_groups=False,
document_title_field_name="documentTitleFieldName",
exclusion_patterns=["exclusionPatterns"],
field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
data_source_field_name="dataSourceFieldName",
index_field_name="indexFieldName",
# the properties below are optional
date_field_format="dateFieldFormat"
)],
inclusion_patterns=["inclusionPatterns"],
ssl_certificate_s3_path=kendra.CfnDataSource.S3PathProperty(
bucket="bucket",
key="key"
),
use_change_log=False,
vpc_configuration=kendra.CfnDataSource.DataSourceVpcConfigurationProperty(
security_group_ids=["securityGroupIds"],
subnet_ids=["subnetIds"]
)
),
template_configuration=kendra.CfnDataSource.TemplateConfigurationProperty(
template="template"
),
web_crawler_configuration=kendra.CfnDataSource.WebCrawlerConfigurationProperty(
urls=kendra.CfnDataSource.WebCrawlerUrlsProperty(
seed_url_configuration=kendra.CfnDataSource.WebCrawlerSeedUrlConfigurationProperty(
seed_urls=["seedUrls"],
# the properties below are optional
web_crawler_mode="webCrawlerMode"
),
site_maps_configuration=kendra.CfnDataSource.WebCrawlerSiteMapsConfigurationProperty(
site_maps=["siteMaps"]
)
),
# the properties below are optional
authentication_configuration=kendra.CfnDataSource.WebCrawlerAuthenticationConfigurationProperty(
basic_authentication=[kendra.CfnDataSource.WebCrawlerBasicAuthenticationProperty(
credentials="credentials",
host="host",
port=123
)]
),
crawl_depth=123,
max_content_size_per_page_in_mega_bytes=123,
max_links_per_page=123,
max_urls_per_minute_crawl_rate=123,
proxy_configuration=kendra.CfnDataSource.ProxyConfigurationProperty(
host="host",
port=123,
# the properties below are optional
credentials="credentials"
),
url_exclusion_patterns=["urlExclusionPatterns"],
url_inclusion_patterns=["urlInclusionPatterns"]
),
work_docs_configuration=kendra.CfnDataSource.WorkDocsConfigurationProperty(
organization_id="organizationId",
# the properties below are optional
crawl_comments=False,
exclusion_patterns=["exclusionPatterns"],
field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
data_source_field_name="dataSourceFieldName",
index_field_name="indexFieldName",
# the properties below are optional
date_field_format="dateFieldFormat"
)],
inclusion_patterns=["inclusionPatterns"],
use_change_log=False
)
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;
var dataSourceConfigurationProperty = new DataSourceConfigurationProperty {
ConfluenceConfiguration = new ConfluenceConfigurationProperty {
SecretArn = "secretArn",
ServerUrl = "serverUrl",
Version = "version",
// the properties below are optional
AttachmentConfiguration = new ConfluenceAttachmentConfigurationProperty {
AttachmentFieldMappings = new [] { new ConfluenceAttachmentToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} },
CrawlAttachments = false
},
BlogConfiguration = new ConfluenceBlogConfigurationProperty {
BlogFieldMappings = new [] { new ConfluenceBlogToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} }
},
ExclusionPatterns = new [] { "exclusionPatterns" },
InclusionPatterns = new [] { "inclusionPatterns" },
PageConfiguration = new ConfluencePageConfigurationProperty {
PageFieldMappings = new [] { new ConfluencePageToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} }
},
SpaceConfiguration = new ConfluenceSpaceConfigurationProperty {
CrawlArchivedSpaces = false,
CrawlPersonalSpaces = false,
ExcludeSpaces = new [] { "excludeSpaces" },
IncludeSpaces = new [] { "includeSpaces" },
SpaceFieldMappings = new [] { new ConfluenceSpaceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} }
},
VpcConfiguration = new DataSourceVpcConfigurationProperty {
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" }
}
},
DatabaseConfiguration = new DatabaseConfigurationProperty {
ColumnConfiguration = new ColumnConfigurationProperty {
ChangeDetectingColumns = new [] { "changeDetectingColumns" },
DocumentDataColumnName = "documentDataColumnName",
DocumentIdColumnName = "documentIdColumnName",
// the properties below are optional
DocumentTitleColumnName = "documentTitleColumnName",
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} }
},
ConnectionConfiguration = new ConnectionConfigurationProperty {
DatabaseHost = "databaseHost",
DatabaseName = "databaseName",
DatabasePort = 123,
SecretArn = "secretArn",
TableName = "tableName"
},
DatabaseEngineType = "databaseEngineType",
// the properties below are optional
AclConfiguration = new AclConfigurationProperty {
AllowedGroupsColumnName = "allowedGroupsColumnName"
},
SqlConfiguration = new SqlConfigurationProperty {
QueryIdentifiersEnclosingOption = "queryIdentifiersEnclosingOption"
},
VpcConfiguration = new DataSourceVpcConfigurationProperty {
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" }
}
},
GoogleDriveConfiguration = new GoogleDriveConfigurationProperty {
SecretArn = "secretArn",
// the properties below are optional
ExcludeMimeTypes = new [] { "excludeMimeTypes" },
ExcludeSharedDrives = new [] { "excludeSharedDrives" },
ExcludeUserAccounts = new [] { "excludeUserAccounts" },
ExclusionPatterns = new [] { "exclusionPatterns" },
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} },
InclusionPatterns = new [] { "inclusionPatterns" }
},
OneDriveConfiguration = new OneDriveConfigurationProperty {
OneDriveUsers = new OneDriveUsersProperty {
OneDriveUserList = new [] { "oneDriveUserList" },
OneDriveUserS3Path = new S3PathProperty {
Bucket = "bucket",
Key = "key"
}
},
SecretArn = "secretArn",
TenantDomain = "tenantDomain",
// the properties below are optional
DisableLocalGroups = false,
ExclusionPatterns = new [] { "exclusionPatterns" },
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} },
InclusionPatterns = new [] { "inclusionPatterns" }
},
S3Configuration = new S3DataSourceConfigurationProperty {
BucketName = "bucketName",
// the properties below are optional
AccessControlListConfiguration = new AccessControlListConfigurationProperty {
KeyPath = "keyPath"
},
DocumentsMetadataConfiguration = new DocumentsMetadataConfigurationProperty {
S3Prefix = "s3Prefix"
},
ExclusionPatterns = new [] { "exclusionPatterns" },
InclusionPatterns = new [] { "inclusionPatterns" },
InclusionPrefixes = new [] { "inclusionPrefixes" }
},
SalesforceConfiguration = new SalesforceConfigurationProperty {
SecretArn = "secretArn",
ServerUrl = "serverUrl",
// the properties below are optional
ChatterFeedConfiguration = new SalesforceChatterFeedConfigurationProperty {
DocumentDataFieldName = "documentDataFieldName",
// the properties below are optional
DocumentTitleFieldName = "documentTitleFieldName",
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} },
IncludeFilterTypes = new [] { "includeFilterTypes" }
},
CrawlAttachments = false,
ExcludeAttachmentFilePatterns = new [] { "excludeAttachmentFilePatterns" },
IncludeAttachmentFilePatterns = new [] { "includeAttachmentFilePatterns" },
KnowledgeArticleConfiguration = new SalesforceKnowledgeArticleConfigurationProperty {
IncludedStates = new [] { "includedStates" },
// the properties below are optional
CustomKnowledgeArticleTypeConfigurations = new [] { new SalesforceCustomKnowledgeArticleTypeConfigurationProperty {
DocumentDataFieldName = "documentDataFieldName",
Name = "name",
// the properties below are optional
DocumentTitleFieldName = "documentTitleFieldName",
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} }
} },
StandardKnowledgeArticleTypeConfiguration = new SalesforceStandardKnowledgeArticleTypeConfigurationProperty {
DocumentDataFieldName = "documentDataFieldName",
// the properties below are optional
DocumentTitleFieldName = "documentTitleFieldName",
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} }
}
},
StandardObjectAttachmentConfiguration = new SalesforceStandardObjectAttachmentConfigurationProperty {
DocumentTitleFieldName = "documentTitleFieldName",
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} }
},
StandardObjectConfigurations = new [] { new SalesforceStandardObjectConfigurationProperty {
DocumentDataFieldName = "documentDataFieldName",
Name = "name",
// the properties below are optional
DocumentTitleFieldName = "documentTitleFieldName",
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} }
} }
},
ServiceNowConfiguration = new ServiceNowConfigurationProperty {
HostUrl = "hostUrl",
SecretArn = "secretArn",
ServiceNowBuildVersion = "serviceNowBuildVersion",
// the properties below are optional
AuthenticationType = "authenticationType",
KnowledgeArticleConfiguration = new ServiceNowKnowledgeArticleConfigurationProperty {
DocumentDataFieldName = "documentDataFieldName",
// the properties below are optional
CrawlAttachments = false,
DocumentTitleFieldName = "documentTitleFieldName",
ExcludeAttachmentFilePatterns = new [] { "excludeAttachmentFilePatterns" },
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} },
FilterQuery = "filterQuery",
IncludeAttachmentFilePatterns = new [] { "includeAttachmentFilePatterns" }
},
ServiceCatalogConfiguration = new ServiceNowServiceCatalogConfigurationProperty {
DocumentDataFieldName = "documentDataFieldName",
// the properties below are optional
CrawlAttachments = false,
DocumentTitleFieldName = "documentTitleFieldName",
ExcludeAttachmentFilePatterns = new [] { "excludeAttachmentFilePatterns" },
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} },
IncludeAttachmentFilePatterns = new [] { "includeAttachmentFilePatterns" }
}
},
SharePointConfiguration = new SharePointConfigurationProperty {
SecretArn = "secretArn",
SharePointVersion = "sharePointVersion",
Urls = new [] { "urls" },
// the properties below are optional
CrawlAttachments = false,
DisableLocalGroups = false,
DocumentTitleFieldName = "documentTitleFieldName",
ExclusionPatterns = new [] { "exclusionPatterns" },
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} },
InclusionPatterns = new [] { "inclusionPatterns" },
SslCertificateS3Path = new S3PathProperty {
Bucket = "bucket",
Key = "key"
},
UseChangeLog = false,
VpcConfiguration = new DataSourceVpcConfigurationProperty {
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" }
}
},
TemplateConfiguration = new TemplateConfigurationProperty {
Template = "template"
},
WebCrawlerConfiguration = new WebCrawlerConfigurationProperty {
Urls = new WebCrawlerUrlsProperty {
SeedUrlConfiguration = new WebCrawlerSeedUrlConfigurationProperty {
SeedUrls = new [] { "seedUrls" },
// the properties below are optional
WebCrawlerMode = "webCrawlerMode"
},
SiteMapsConfiguration = new WebCrawlerSiteMapsConfigurationProperty {
SiteMaps = new [] { "siteMaps" }
}
},
// the properties below are optional
AuthenticationConfiguration = new WebCrawlerAuthenticationConfigurationProperty {
BasicAuthentication = new [] { new WebCrawlerBasicAuthenticationProperty {
Credentials = "credentials",
Host = "host",
Port = 123
} }
},
CrawlDepth = 123,
MaxContentSizePerPageInMegaBytes = 123,
MaxLinksPerPage = 123,
MaxUrlsPerMinuteCrawlRate = 123,
ProxyConfiguration = new ProxyConfigurationProperty {
Host = "host",
Port = 123,
// the properties below are optional
Credentials = "credentials"
},
UrlExclusionPatterns = new [] { "urlExclusionPatterns" },
UrlInclusionPatterns = new [] { "urlInclusionPatterns" }
},
WorkDocsConfiguration = new WorkDocsConfigurationProperty {
OrganizationId = "organizationId",
// the properties below are optional
CrawlComments = false,
ExclusionPatterns = new [] { "exclusionPatterns" },
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} },
InclusionPatterns = new [] { "inclusionPatterns" },
UseChangeLog = false
}
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
dataSourceConfigurationProperty := &DataSourceConfigurationProperty{
ConfluenceConfiguration: &ConfluenceConfigurationProperty{
SecretArn: jsii.String("secretArn"),
ServerUrl: jsii.String("serverUrl"),
Version: jsii.String("version"),
// the properties below are optional
AttachmentConfiguration: &ConfluenceAttachmentConfigurationProperty{
AttachmentFieldMappings: []interface{}{
&ConfluenceAttachmentToIndexFieldMappingProperty{
DataSourceFieldName: jsii.String("dataSourceFieldName"),
IndexFieldName: jsii.String("indexFieldName"),
// the properties below are optional
DateFieldFormat: jsii.String("dateFieldFormat"),
},
},
CrawlAttachments: jsii.Boolean(false),
},
BlogConfiguration: &ConfluenceBlogConfigurationProperty{
BlogFieldMappings: []interface{}{
&ConfluenceBlogToIndexFieldMappingProperty{
DataSourceFieldName: jsii.String("dataSourceFieldName"),
IndexFieldName: jsii.String("indexFieldName"),
// the properties below are optional
DateFieldFormat: jsii.String("dateFieldFormat"),
},
},
},
ExclusionPatterns: []*string{
jsii.String("exclusionPatterns"),
},
InclusionPatterns: []*string{
jsii.String("inclusionPatterns"),
},
PageConfiguration: &ConfluencePageConfigurationProperty{
PageFieldMappings: []interface{}{
&ConfluencePageToIndexFieldMappingProperty{
DataSourceFieldName: jsii.String("dataSourceFieldName"),
IndexFieldName: jsii.String("indexFieldName"),
// the properties below are optional
DateFieldFormat: jsii.String("dateFieldFormat"),
},
},
},
SpaceConfiguration: &ConfluenceSpaceConfigurationProperty{
CrawlArchivedSpaces: jsii.Boolean(false),
CrawlPersonalSpaces: jsii.Boolean(false),
ExcludeSpaces: []*string{
jsii.String("excludeSpaces"),
},
IncludeSpaces: []*string{
jsii.String("includeSpaces"),
},
SpaceFieldMappings: []interface{}{
&ConfluenceSpaceToIndexFieldMappingProperty{
DataSourceFieldName: jsii.String("dataSourceFieldName"),
IndexFieldName: jsii.String("indexFieldName"),
// the properties below are optional
DateFieldFormat: jsii.String("dateFieldFormat"),
},
},
},
VpcConfiguration: &DataSourceVpcConfigurationProperty{
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
SubnetIds: []*string{
jsii.String("subnetIds"),
},
},
},
DatabaseConfiguration: &DatabaseConfigurationProperty{
ColumnConfiguration: &ColumnConfigurationProperty{
ChangeDetectingColumns: []*string{
jsii.String("changeDetectingColumns"),
},
DocumentDataColumnName: jsii.String("documentDataColumnName"),
DocumentIdColumnName: jsii.String("documentIdColumnName"),
// the properties below are optional
DocumentTitleColumnName: jsii.String("documentTitleColumnName"),
FieldMappings: []interface{}{
&DataSourceToIndexFieldMappingProperty{
DataSourceFieldName: jsii.String("dataSourceFieldName"),
IndexFieldName: jsii.String("indexFieldName"),
// the properties below are optional
DateFieldFormat: jsii.String("dateFieldFormat"),
},
},
},
ConnectionConfiguration: &ConnectionConfigurationProperty{
DatabaseHost: jsii.String("databaseHost"),
DatabaseName: jsii.String("databaseName"),
DatabasePort: jsii.Number(123),
SecretArn: jsii.String("secretArn"),
TableName: jsii.String("tableName"),
},
DatabaseEngineType: jsii.String("databaseEngineType"),
// the properties below are optional
AclConfiguration: &AclConfigurationProperty{
AllowedGroupsColumnName: jsii.String("allowedGroupsColumnName"),
},
SqlConfiguration: &SqlConfigurationProperty{
QueryIdentifiersEnclosingOption: jsii.String("queryIdentifiersEnclosingOption"),
},
VpcConfiguration: &DataSourceVpcConfigurationProperty{
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
SubnetIds: []*string{
jsii.String("subnetIds"),
},
},
},
GoogleDriveConfiguration: &GoogleDriveConfigurationProperty{
SecretArn: jsii.String("secretArn"),
// the properties below are optional
ExcludeMimeTypes: []*string{
jsii.String("excludeMimeTypes"),
},
ExcludeSharedDrives: []*string{
jsii.String("excludeSharedDrives"),
},
ExcludeUserAccounts: []*string{
jsii.String("excludeUserAccounts"),
},
ExclusionPatterns: []*string{
jsii.String("exclusionPatterns"),
},
FieldMappings: []interface{}{
&DataSourceToIndexFieldMappingProperty{
DataSourceFieldName: jsii.String("dataSourceFieldName"),
IndexFieldName: jsii.String("indexFieldName"),
// the properties below are optional
DateFieldFormat: jsii.String("dateFieldFormat"),
},
},
InclusionPatterns: []*string{
jsii.String("inclusionPatterns"),
},
},
OneDriveConfiguration: &OneDriveConfigurationProperty{
OneDriveUsers: &OneDriveUsersProperty{
OneDriveUserList: []*string{
jsii.String("oneDriveUserList"),
},
OneDriveUserS3Path: &S3PathProperty{
Bucket: jsii.String("bucket"),
Key: jsii.String("key"),
},
},
SecretArn: jsii.String("secretArn"),
TenantDomain: jsii.String("tenantDomain"),
// the properties below are optional
DisableLocalGroups: jsii.Boolean(false),
ExclusionPatterns: []*string{
jsii.String("exclusionPatterns"),
},
FieldMappings: []interface{}{
&DataSourceToIndexFieldMappingProperty{
DataSourceFieldName: jsii.String("dataSourceFieldName"),
IndexFieldName: jsii.String("indexFieldName"),
// the properties below are optional
DateFieldFormat: jsii.String("dateFieldFormat"),
},
},
InclusionPatterns: []*string{
jsii.String("inclusionPatterns"),
},
},
S3Configuration: &S3DataSourceConfigurationProperty{
BucketName: jsii.String("bucketName"),
// the properties below are optional
AccessControlListConfiguration: &AccessControlListConfigurationProperty{
KeyPath: jsii.String("keyPath"),
},
DocumentsMetadataConfiguration: &DocumentsMetadataConfigurationProperty{
S3Prefix: jsii.String("s3Prefix"),
},
ExclusionPatterns: []*string{
jsii.String("exclusionPatterns"),
},
InclusionPatterns: []*string{
jsii.String("inclusionPatterns"),
},
InclusionPrefixes: []*string{
jsii.String("inclusionPrefixes"),
},
},
SalesforceConfiguration: &SalesforceConfigurationProperty{
SecretArn: jsii.String("secretArn"),
ServerUrl: jsii.String("serverUrl"),
// the properties below are optional
ChatterFeedConfiguration: &SalesforceChatterFeedConfigurationProperty{
DocumentDataFieldName: jsii.String("documentDataFieldName"),
// the properties below are optional
DocumentTitleFieldName: jsii.String("documentTitleFieldName"),
FieldMappings: []interface{}{
&DataSourceToIndexFieldMappingProperty{
DataSourceFieldName: jsii.String("dataSourceFieldName"),
IndexFieldName: jsii.String("indexFieldName"),
// the properties below are optional
DateFieldFormat: jsii.String("dateFieldFormat"),
},
},
IncludeFilterTypes: []*string{
jsii.String("includeFilterTypes"),
},
},
CrawlAttachments: jsii.Boolean(false),
ExcludeAttachmentFilePatterns: []*string{
jsii.String("excludeAttachmentFilePatterns"),
},
IncludeAttachmentFilePatterns: []*string{
jsii.String("includeAttachmentFilePatterns"),
},
KnowledgeArticleConfiguration: &SalesforceKnowledgeArticleConfigurationProperty{
IncludedStates: []*string{
jsii.String("includedStates"),
},
// the properties below are optional
CustomKnowledgeArticleTypeConfigurations: []interface{}{
&SalesforceCustomKnowledgeArticleTypeConfigurationProperty{
DocumentDataFieldName: jsii.String("documentDataFieldName"),
Name: jsii.String("name"),
// the properties below are optional
DocumentTitleFieldName: jsii.String("documentTitleFieldName"),
FieldMappings: []interface{}{
&DataSourceToIndexFieldMappingProperty{
DataSourceFieldName: jsii.String("dataSourceFieldName"),
IndexFieldName: jsii.String("indexFieldName"),
// the properties below are optional
DateFieldFormat: jsii.String("dateFieldFormat"),
},
},
},
},
StandardKnowledgeArticleTypeConfiguration: &SalesforceStandardKnowledgeArticleTypeConfigurationProperty{
DocumentDataFieldName: jsii.String("documentDataFieldName"),
// the properties below are optional
DocumentTitleFieldName: jsii.String("documentTitleFieldName"),
FieldMappings: []interface{}{
&DataSourceToIndexFieldMappingProperty{
DataSourceFieldName: jsii.String("dataSourceFieldName"),
IndexFieldName: jsii.String("indexFieldName"),
// the properties below are optional
DateFieldFormat: jsii.String("dateFieldFormat"),
},
},
},
},
StandardObjectAttachmentConfiguration: &SalesforceStandardObjectAttachmentConfigurationProperty{
DocumentTitleFieldName: jsii.String("documentTitleFieldName"),
FieldMappings: []interface{}{
&DataSourceToIndexFieldMappingProperty{
DataSourceFieldName: jsii.String("dataSourceFieldName"),
IndexFieldName: jsii.String("indexFieldName"),
// the properties below are optional
DateFieldFormat: jsii.String("dateFieldFormat"),
},
},
},
StandardObjectConfigurations: []interface{}{
&SalesforceStandardObjectConfigurationProperty{
DocumentDataFieldName: jsii.String("documentDataFieldName"),
Name: jsii.String("name"),
// the properties below are optional
DocumentTitleFieldName: jsii.String("documentTitleFieldName"),
FieldMappings: []interface{}{
&DataSourceToIndexFieldMappingProperty{
DataSourceFieldName: jsii.String("dataSourceFieldName"),
IndexFieldName: jsii.String("indexFieldName"),
// the properties below are optional
DateFieldFormat: jsii.String("dateFieldFormat"),
},
},
},
},
},
ServiceNowConfiguration: &ServiceNowConfigurationProperty{
HostUrl: jsii.String("hostUrl"),
SecretArn: jsii.String("secretArn"),
ServiceNowBuildVersion: jsii.String("serviceNowBuildVersion"),
// the properties below are optional
AuthenticationType: jsii.String("authenticationType"),
KnowledgeArticleConfiguration: &ServiceNowKnowledgeArticleConfigurationProperty{
DocumentDataFieldName: jsii.String("documentDataFieldName"),
// the properties below are optional
CrawlAttachments: jsii.Boolean(false),
DocumentTitleFieldName: jsii.String("documentTitleFieldName"),
ExcludeAttachmentFilePatterns: []*string{
jsii.String("excludeAttachmentFilePatterns"),
},
FieldMappings: []interface{}{
&DataSourceToIndexFieldMappingProperty{
DataSourceFieldName: jsii.String("dataSourceFieldName"),
IndexFieldName: jsii.String("indexFieldName"),
// the properties below are optional
DateFieldFormat: jsii.String("dateFieldFormat"),
},
},
FilterQuery: jsii.String("filterQuery"),
IncludeAttachmentFilePatterns: []*string{
jsii.String("includeAttachmentFilePatterns"),
},
},
ServiceCatalogConfiguration: &ServiceNowServiceCatalogConfigurationProperty{
DocumentDataFieldName: jsii.String("documentDataFieldName"),
// the properties below are optional
CrawlAttachments: jsii.Boolean(false),
DocumentTitleFieldName: jsii.String("documentTitleFieldName"),
ExcludeAttachmentFilePatterns: []*string{
jsii.String("excludeAttachmentFilePatterns"),
},
FieldMappings: []interface{}{
&DataSourceToIndexFieldMappingProperty{
DataSourceFieldName: jsii.String("dataSourceFieldName"),
IndexFieldName: jsii.String("indexFieldName"),
// the properties below are optional
DateFieldFormat: jsii.String("dateFieldFormat"),
},
},
IncludeAttachmentFilePatterns: []*string{
jsii.String("includeAttachmentFilePatterns"),
},
},
},
SharePointConfiguration: &SharePointConfigurationProperty{
SecretArn: jsii.String("secretArn"),
SharePointVersion: jsii.String("sharePointVersion"),
Urls: []*string{
jsii.String("urls"),
},
// the properties below are optional
CrawlAttachments: jsii.Boolean(false),
DisableLocalGroups: jsii.Boolean(false),
DocumentTitleFieldName: jsii.String("documentTitleFieldName"),
ExclusionPatterns: []*string{
jsii.String("exclusionPatterns"),
},
FieldMappings: []interface{}{
&DataSourceToIndexFieldMappingProperty{
DataSourceFieldName: jsii.String("dataSourceFieldName"),
IndexFieldName: jsii.String("indexFieldName"),
// the properties below are optional
DateFieldFormat: jsii.String("dateFieldFormat"),
},
},
InclusionPatterns: []*string{
jsii.String("inclusionPatterns"),
},
SslCertificateS3Path: &S3PathProperty{
Bucket: jsii.String("bucket"),
Key: jsii.String("key"),
},
UseChangeLog: jsii.Boolean(false),
VpcConfiguration: &DataSourceVpcConfigurationProperty{
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
SubnetIds: []*string{
jsii.String("subnetIds"),
},
},
},
TemplateConfiguration: &TemplateConfigurationProperty{
Template: jsii.String("template"),
},
WebCrawlerConfiguration: &WebCrawlerConfigurationProperty{
Urls: &WebCrawlerUrlsProperty{
SeedUrlConfiguration: &WebCrawlerSeedUrlConfigurationProperty{
SeedUrls: []*string{
jsii.String("seedUrls"),
},
// the properties below are optional
WebCrawlerMode: jsii.String("webCrawlerMode"),
},
SiteMapsConfiguration: &WebCrawlerSiteMapsConfigurationProperty{
SiteMaps: []*string{
jsii.String("siteMaps"),
},
},
},
// the properties below are optional
AuthenticationConfiguration: &WebCrawlerAuthenticationConfigurationProperty{
BasicAuthentication: []interface{}{
&WebCrawlerBasicAuthenticationProperty{
Credentials: jsii.String("credentials"),
Host: jsii.String("host"),
Port: jsii.Number(123),
},
},
},
CrawlDepth: jsii.Number(123),
MaxContentSizePerPageInMegaBytes: jsii.Number(123),
MaxLinksPerPage: jsii.Number(123),
MaxUrlsPerMinuteCrawlRate: jsii.Number(123),
ProxyConfiguration: &ProxyConfigurationProperty{
Host: jsii.String("host"),
Port: jsii.Number(123),
// the properties below are optional
Credentials: jsii.String("credentials"),
},
UrlExclusionPatterns: []*string{
jsii.String("urlExclusionPatterns"),
},
UrlInclusionPatterns: []*string{
jsii.String("urlInclusionPatterns"),
},
},
WorkDocsConfiguration: &WorkDocsConfigurationProperty{
OrganizationId: jsii.String("organizationId"),
// the properties below are optional
CrawlComments: jsii.Boolean(false),
ExclusionPatterns: []*string{
jsii.String("exclusionPatterns"),
},
FieldMappings: []interface{}{
&DataSourceToIndexFieldMappingProperty{
DataSourceFieldName: jsii.String("dataSourceFieldName"),
IndexFieldName: jsii.String("indexFieldName"),
// the properties below are optional
DateFieldFormat: jsii.String("dateFieldFormat"),
},
},
InclusionPatterns: []*string{
jsii.String("inclusionPatterns"),
},
UseChangeLog: jsii.Boolean(false),
},
}
Properties
confluenceConfigurationoptionalIResolvable | CfnDataSource.confluence_configurationoptionaltyping.Union[IResolvable, ConfluenceConfigurationProperty]confluenceConfigurationoptionalIResolvableConfluenceConfigurationoptionalIResolvableConfluenceConfigurationoptionalinterface{} #Provides the configuration information to connect to Confluence as your data source.
databaseConfigurationoptionalIResolvable | CfnDataSource.database_configurationoptionaltyping.Union[IResolvable, DatabaseConfigurationProperty]databaseConfigurationoptionalIResolvableDatabaseConfigurationoptionalIResolvableDatabaseConfigurationoptionalinterface{} #Provides the configuration information to connect to a database as your data source.
googleDriveConfigurationoptionalIResolvable | CfnDataSource.google_drive_configurationoptionaltyping.Union[IResolvable, GoogleDriveConfigurationProperty]googleDriveConfigurationoptionalIResolvableGoogleDriveConfigurationoptionalIResolvableGoogleDriveConfigurationoptionalinterface{} #Provides the configuration information to connect to Google Drive as your data source.
oneDriveConfigurationoptionalIResolvable | CfnDataSource.one_drive_configurationoptionaltyping.Union[IResolvable, OneDriveConfigurationProperty]oneDriveConfigurationoptionalIResolvableOneDriveConfigurationoptionalIResolvableOneDriveConfigurationoptionalinterface{} #Provides the configuration information to connect to Microsoft OneDrive as your data source.
s3ConfigurationoptionalIResolvable | CfnDataSource.s3_configurationoptionaltyping.Union[IResolvable, S3DataSourceConfigurationProperty]s3ConfigurationoptionalIResolvableS3ConfigurationoptionalIResolvableS3Configurationoptionalinterface{} #Provides the configuration information to connect to an Amazon S3 bucket as your data source.
notes
Amazon Kendra now supports an upgraded Amazon S3 connector.
You must now use the TemplateConfiguration object instead of the
S3DataSourceConfigurationobject 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.
salesforceConfigurationoptionalIResolvable | CfnDataSource.salesforce_configurationoptionaltyping.Union[IResolvable, SalesforceConfigurationProperty]salesforceConfigurationoptionalIResolvableSalesforceConfigurationoptionalIResolvableSalesforceConfigurationoptionalinterface{} #Provides the configuration information to connect to Salesforce as your data source.
serviceNowConfigurationoptionalIResolvable | CfnDataSource.service_now_configurationoptionaltyping.Union[IResolvable, ServiceNowConfigurationProperty]serviceNowConfigurationoptionalIResolvableServiceNowConfigurationoptionalIResolvableServiceNowConfigurationoptionalinterface{} #Provides the configuration information to connect to ServiceNow as your data source.
templateConfigurationoptionalIResolvable | CfnDataSource.template_configurationoptionaltyping.Union[IResolvable, TemplateConfigurationProperty]templateConfigurationoptionalIResolvableTemplateConfigurationoptionalIResolvableTemplateConfigurationoptionalinterface{} #Provides a template for the configuration information to connect to your data source.
webCrawlerConfigurationoptionalIResolvable | CfnDataSource.web_crawler_configurationoptionaltyping.Union[IResolvable, WebCrawlerConfigurationProperty]webCrawlerConfigurationoptionalIResolvableWebCrawlerConfigurationoptionalIResolvableWebCrawlerConfigurationoptionalinterface{} #Provides the configuration information required for Amazon Kendra Web Crawler.
workDocsConfigurationoptionalIResolvable | CfnDataSource.work_docs_configurationoptionaltyping.Union[IResolvable, WorkDocsConfigurationProperty]workDocsConfigurationoptionalIResolvableWorkDocsConfigurationoptionalIResolvableWorkDocsConfigurationoptionalinterface{} #Provides the configuration information to connect to WorkDocs as your data source.