CfnDataSource L1 construct
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
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 cfnDataSource = new kendra.CfnDataSource(this, 'MyCfnDataSource', {
indexId: 'indexId',
name: 'name',
type: 'type',
// the properties below are optional
customDocumentEnrichmentConfiguration: {
inlineConfigurations: [{
condition: {
conditionDocumentAttributeKey: 'conditionDocumentAttributeKey',
operator: 'operator',
// the properties below are optional
conditionOnValue: {
dateValue: 'dateValue',
longValue: 123,
stringListValue: ['stringListValue'],
stringValue: 'stringValue',
},
},
documentContentDeletion: false,
target: {
targetDocumentAttributeKey: 'targetDocumentAttributeKey',
// the properties below are optional
targetDocumentAttributeValue: {
dateValue: 'dateValue',
longValue: 123,
stringListValue: ['stringListValue'],
stringValue: 'stringValue',
},
targetDocumentAttributeValueDeletion: false,
},
}],
postExtractionHookConfiguration: {
lambdaArn: 'lambdaArn',
s3Bucket: 's3Bucket',
// the properties below are optional
invocationCondition: {
conditionDocumentAttributeKey: 'conditionDocumentAttributeKey',
operator: 'operator',
// the properties below are optional
conditionOnValue: {
dateValue: 'dateValue',
longValue: 123,
stringListValue: ['stringListValue'],
stringValue: 'stringValue',
},
},
},
preExtractionHookConfiguration: {
lambdaArn: 'lambdaArn',
s3Bucket: 's3Bucket',
// the properties below are optional
invocationCondition: {
conditionDocumentAttributeKey: 'conditionDocumentAttributeKey',
operator: 'operator',
// the properties below are optional
conditionOnValue: {
dateValue: 'dateValue',
longValue: 123,
stringListValue: ['stringListValue'],
stringValue: 'stringValue',
},
},
},
roleArn: 'roleArn',
},
dataSourceConfiguration: {
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,
},
},
description: 'description',
languageCode: 'languageCode',
roleArn: 'roleArn',
schedule: 'schedule',
tags: [{
key: 'key',
value: 'value',
}],
});
python
from aws_cdk import CfnTag
# 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
cfn_data_source = kendra.CfnDataSource(self, "MyCfnDataSource",
index_id="indexId",
name="name",
type="type",
# the properties below are optional
custom_document_enrichment_configuration=kendra.CfnDataSource.CustomDocumentEnrichmentConfigurationProperty(
inline_configurations=[kendra.CfnDataSource.InlineCustomDocumentEnrichmentConfigurationProperty(
condition=kendra.CfnDataSource.DocumentAttributeConditionProperty(
condition_document_attribute_key="conditionDocumentAttributeKey",
operator="operator",
# the properties below are optional
condition_on_value=kendra.CfnDataSource.DocumentAttributeValueProperty(
date_value="dateValue",
long_value=123,
string_list_value=["stringListValue"],
string_value="stringValue"
)
),
document_content_deletion=False,
target=kendra.CfnDataSource.DocumentAttributeTargetProperty(
target_document_attribute_key="targetDocumentAttributeKey",
# the properties below are optional
target_document_attribute_value=kendra.CfnDataSource.DocumentAttributeValueProperty(
date_value="dateValue",
long_value=123,
string_list_value=["stringListValue"],
string_value="stringValue"
),
target_document_attribute_value_deletion=False
)
)],
post_extraction_hook_configuration=kendra.CfnDataSource.HookConfigurationProperty(
lambda_arn="lambdaArn",
s3_bucket="s3Bucket",
# the properties below are optional
invocation_condition=kendra.CfnDataSource.DocumentAttributeConditionProperty(
condition_document_attribute_key="conditionDocumentAttributeKey",
operator="operator",
# the properties below are optional
condition_on_value=kendra.CfnDataSource.DocumentAttributeValueProperty(
date_value="dateValue",
long_value=123,
string_list_value=["stringListValue"],
string_value="stringValue"
)
)
),
pre_extraction_hook_configuration=kendra.CfnDataSource.HookConfigurationProperty(
lambda_arn="lambdaArn",
s3_bucket="s3Bucket",
# the properties below are optional
invocation_condition=kendra.CfnDataSource.DocumentAttributeConditionProperty(
condition_document_attribute_key="conditionDocumentAttributeKey",
operator="operator",
# the properties below are optional
condition_on_value=kendra.CfnDataSource.DocumentAttributeValueProperty(
date_value="dateValue",
long_value=123,
string_list_value=["stringListValue"],
string_value="stringValue"
)
)
),
role_arn="roleArn"
),
data_source_configuration=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
)
),
description="description",
language_code="languageCode",
role_arn="roleArn",
schedule="schedule",
tags=[CfnTag(
key="key",
value="value"
)]
)
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.*;
CfnDataSource cfnDataSource = CfnDataSource.Builder.create(this, "MyCfnDataSource")
.indexId("indexId")
.name("name")
.type("type")
// the properties below are optional
.customDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfigurationProperty.builder()
.inlineConfigurations(List.of(InlineCustomDocumentEnrichmentConfigurationProperty.builder()
.condition(DocumentAttributeConditionProperty.builder()
.conditionDocumentAttributeKey("conditionDocumentAttributeKey")
.operator("operator")
// the properties below are optional
.conditionOnValue(DocumentAttributeValueProperty.builder()
.dateValue("dateValue")
.longValue(123)
.stringListValue(List.of("stringListValue"))
.stringValue("stringValue")
.build())
.build())
.documentContentDeletion(false)
.target(DocumentAttributeTargetProperty.builder()
.targetDocumentAttributeKey("targetDocumentAttributeKey")
// the properties below are optional
.targetDocumentAttributeValue(DocumentAttributeValueProperty.builder()
.dateValue("dateValue")
.longValue(123)
.stringListValue(List.of("stringListValue"))
.stringValue("stringValue")
.build())
.targetDocumentAttributeValueDeletion(false)
.build())
.build()))
.postExtractionHookConfiguration(HookConfigurationProperty.builder()
.lambdaArn("lambdaArn")
.s3Bucket("s3Bucket")
// the properties below are optional
.invocationCondition(DocumentAttributeConditionProperty.builder()
.conditionDocumentAttributeKey("conditionDocumentAttributeKey")
.operator("operator")
// the properties below are optional
.conditionOnValue(DocumentAttributeValueProperty.builder()
.dateValue("dateValue")
.longValue(123)
.stringListValue(List.of("stringListValue"))
.stringValue("stringValue")
.build())
.build())
.build())
.preExtractionHookConfiguration(HookConfigurationProperty.builder()
.lambdaArn("lambdaArn")
.s3Bucket("s3Bucket")
// the properties below are optional
.invocationCondition(DocumentAttributeConditionProperty.builder()
.conditionDocumentAttributeKey("conditionDocumentAttributeKey")
.operator("operator")
// the properties below are optional
.conditionOnValue(DocumentAttributeValueProperty.builder()
.dateValue("dateValue")
.longValue(123)
.stringListValue(List.of("stringListValue"))
.stringValue("stringValue")
.build())
.build())
.build())
.roleArn("roleArn")
.build())
.dataSourceConfiguration(DataSourceConfigurationProperty.builder()
.confluenceConfiguration(ConfluenceConfigurationProperty.builder()
.secretArn("secretArn")
.serverUrl("serverUrl")
.version("version")
// the properties below are optional
.attachmentConfiguration(ConfluenceAttachmentConfigurationProperty.builder()
.attachmentFieldMappings(List.of(ConfluenceAttachmentToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.indexFieldName("indexFieldName")
// the properties below are optional
.dateFieldFormat("dateFieldFormat")
.build()))
.crawlAttachments(false)
.build())
.blogConfiguration(ConfluenceBlogConfigurationProperty.builder()
.blogFieldMappings(List.of(ConfluenceBlogToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.indexFieldName("indexFieldName")
// the properties below are optional
.dateFieldFormat("dateFieldFormat")
.build()))
.build())
.exclusionPatterns(List.of("exclusionPatterns"))
.inclusionPatterns(List.of("inclusionPatterns"))
.pageConfiguration(ConfluencePageConfigurationProperty.builder()
.pageFieldMappings(List.of(ConfluencePageToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.indexFieldName("indexFieldName")
// the properties below are optional
.dateFieldFormat("dateFieldFormat")
.build()))
.build())
.spaceConfiguration(ConfluenceSpaceConfigurationProperty.builder()
.crawlArchivedSpaces(false)
.crawlPersonalSpaces(false)
.excludeSpaces(List.of("excludeSpaces"))
.includeSpaces(List.of("includeSpaces"))
.spaceFieldMappings(List.of(ConfluenceSpaceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.indexFieldName("indexFieldName")
// the properties below are optional
.dateFieldFormat("dateFieldFormat")
.build()))
.build())
.vpcConfiguration(DataSourceVpcConfigurationProperty.builder()
.securityGroupIds(List.of("securityGroupIds"))
.subnetIds(List.of("subnetIds"))
.build())
.build())
.databaseConfiguration(DatabaseConfigurationProperty.builder()
.columnConfiguration(ColumnConfigurationProperty.builder()
.changeDetectingColumns(List.of("changeDetectingColumns"))
.documentDataColumnName("documentDataColumnName")
.documentIdColumnName("documentIdColumnName")
// the properties below are optional
.documentTitleColumnName("documentTitleColumnName")
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.indexFieldName("indexFieldName")
// the properties below are optional
.dateFieldFormat("dateFieldFormat")
.build()))
.build())
.connectionConfiguration(ConnectionConfigurationProperty.builder()
.databaseHost("databaseHost")
.databaseName("databaseName")
.databasePort(123)
.secretArn("secretArn")
.tableName("tableName")
.build())
.databaseEngineType("databaseEngineType")
// the properties below are optional
.aclConfiguration(AclConfigurationProperty.builder()
.allowedGroupsColumnName("allowedGroupsColumnName")
.build())
.sqlConfiguration(SqlConfigurationProperty.builder()
.queryIdentifiersEnclosingOption("queryIdentifiersEnclosingOption")
.build())
.vpcConfiguration(DataSourceVpcConfigurationProperty.builder()
.securityGroupIds(List.of("securityGroupIds"))
.subnetIds(List.of("subnetIds"))
.build())
.build())
.googleDriveConfiguration(GoogleDriveConfigurationProperty.builder()
.secretArn("secretArn")
// the properties below are optional
.excludeMimeTypes(List.of("excludeMimeTypes"))
.excludeSharedDrives(List.of("excludeSharedDrives"))
.excludeUserAccounts(List.of("excludeUserAccounts"))
.exclusionPatterns(List.of("exclusionPatterns"))
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.indexFieldName("indexFieldName")
// the properties below are optional
.dateFieldFormat("dateFieldFormat")
.build()))
.inclusionPatterns(List.of("inclusionPatterns"))
.build())
.oneDriveConfiguration(OneDriveConfigurationProperty.builder()
.oneDriveUsers(OneDriveUsersProperty.builder()
.oneDriveUserList(List.of("oneDriveUserList"))
.oneDriveUserS3Path(S3PathProperty.builder()
.bucket("bucket")
.key("key")
.build())
.build())
.secretArn("secretArn")
.tenantDomain("tenantDomain")
// the properties below are optional
.disableLocalGroups(false)
.exclusionPatterns(List.of("exclusionPatterns"))
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.indexFieldName("indexFieldName")
// the properties below are optional
.dateFieldFormat("dateFieldFormat")
.build()))
.inclusionPatterns(List.of("inclusionPatterns"))
.build())
.s3Configuration(S3DataSourceConfigurationProperty.builder()
.bucketName("bucketName")
// the properties below are optional
.accessControlListConfiguration(AccessControlListConfigurationProperty.builder()
.keyPath("keyPath")
.build())
.documentsMetadataConfiguration(DocumentsMetadataConfigurationProperty.builder()
.s3Prefix("s3Prefix")
.build())
.exclusionPatterns(List.of("exclusionPatterns"))
.inclusionPatterns(List.of("inclusionPatterns"))
.inclusionPrefixes(List.of("inclusionPrefixes"))
.build())
.salesforceConfiguration(SalesforceConfigurationProperty.builder()
.secretArn("secretArn")
.serverUrl("serverUrl")
// the properties below are optional
.chatterFeedConfiguration(SalesforceChatterFeedConfigurationProperty.builder()
.documentDataFieldName("documentDataFieldName")
// the properties below are optional
.documentTitleFieldName("documentTitleFieldName")
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.indexFieldName("indexFieldName")
// the properties below are optional
.dateFieldFormat("dateFieldFormat")
.build()))
.includeFilterTypes(List.of("includeFilterTypes"))
.build())
.crawlAttachments(false)
.excludeAttachmentFilePatterns(List.of("excludeAttachmentFilePatterns"))
.includeAttachmentFilePatterns(List.of("includeAttachmentFilePatterns"))
.knowledgeArticleConfiguration(SalesforceKnowledgeArticleConfigurationProperty.builder()
.includedStates(List.of("includedStates"))
// the properties below are optional
.customKnowledgeArticleTypeConfigurations(List.of(SalesforceCustomKnowledgeArticleTypeConfigurationProperty.builder()
.documentDataFieldName("documentDataFieldName")
.name("name")
// the properties below are optional
.documentTitleFieldName("documentTitleFieldName")
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.indexFieldName("indexFieldName")
// the properties below are optional
.dateFieldFormat("dateFieldFormat")
.build()))
.build()))
.standardKnowledgeArticleTypeConfiguration(SalesforceStandardKnowledgeArticleTypeConfigurationProperty.builder()
.documentDataFieldName("documentDataFieldName")
// the properties below are optional
.documentTitleFieldName("documentTitleFieldName")
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.indexFieldName("indexFieldName")
// the properties below are optional
.dateFieldFormat("dateFieldFormat")
.build()))
.build())
.build())
.standardObjectAttachmentConfiguration(SalesforceStandardObjectAttachmentConfigurationProperty.builder()
.documentTitleFieldName("documentTitleFieldName")
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.indexFieldName("indexFieldName")
// the properties below are optional
.dateFieldFormat("dateFieldFormat")
.build()))
.build())
.standardObjectConfigurations(List.of(SalesforceStandardObjectConfigurationProperty.builder()
.documentDataFieldName("documentDataFieldName")
.name("name")
// the properties below are optional
.documentTitleFieldName("documentTitleFieldName")
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.indexFieldName("indexFieldName")
// the properties below are optional
.dateFieldFormat("dateFieldFormat")
.build()))
.build()))
.build())
.serviceNowConfiguration(ServiceNowConfigurationProperty.builder()
.hostUrl("hostUrl")
.secretArn("secretArn")
.serviceNowBuildVersion("serviceNowBuildVersion")
// the properties below are optional
.authenticationType("authenticationType")
.knowledgeArticleConfiguration(ServiceNowKnowledgeArticleConfigurationProperty.builder()
.documentDataFieldName("documentDataFieldName")
// the properties below are optional
.crawlAttachments(false)
.documentTitleFieldName("documentTitleFieldName")
.excludeAttachmentFilePatterns(List.of("excludeAttachmentFilePatterns"))
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.indexFieldName("indexFieldName")
// the properties below are optional
.dateFieldFormat("dateFieldFormat")
.build()))
.filterQuery("filterQuery")
.includeAttachmentFilePatterns(List.of("includeAttachmentFilePatterns"))
.build())
.serviceCatalogConfiguration(ServiceNowServiceCatalogConfigurationProperty.builder()
.documentDataFieldName("documentDataFieldName")
// the properties below are optional
.crawlAttachments(false)
.documentTitleFieldName("documentTitleFieldName")
.excludeAttachmentFilePatterns(List.of("excludeAttachmentFilePatterns"))
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.indexFieldName("indexFieldName")
// the properties below are optional
.dateFieldFormat("dateFieldFormat")
.build()))
.includeAttachmentFilePatterns(List.of("includeAttachmentFilePatterns"))
.build())
.build())
.sharePointConfiguration(SharePointConfigurationProperty.builder()
.secretArn("secretArn")
.sharePointVersion("sharePointVersion")
.urls(List.of("urls"))
// the properties below are optional
.crawlAttachments(false)
.disableLocalGroups(false)
.documentTitleFieldName("documentTitleFieldName")
.exclusionPatterns(List.of("exclusionPatterns"))
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.indexFieldName("indexFieldName")
// the properties below are optional
.dateFieldFormat("dateFieldFormat")
.build()))
.inclusionPatterns(List.of("inclusionPatterns"))
.sslCertificateS3Path(S3PathProperty.builder()
.bucket("bucket")
.key("key")
.build())
.useChangeLog(false)
.vpcConfiguration(DataSourceVpcConfigurationProperty.builder()
.securityGroupIds(List.of("securityGroupIds"))
.subnetIds(List.of("subnetIds"))
.build())
.build())
.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())
.description("description")
.languageCode("languageCode")
.roleArn("roleArn")
.schedule("schedule")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.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 cfnDataSource = new CfnDataSource(this, "MyCfnDataSource", new CfnDataSourceProps {
IndexId = "indexId",
Name = "name",
Type = "type",
// the properties below are optional
CustomDocumentEnrichmentConfiguration = new CustomDocumentEnrichmentConfigurationProperty {
InlineConfigurations = new [] { new InlineCustomDocumentEnrichmentConfigurationProperty {
Condition = new DocumentAttributeConditionProperty {
ConditionDocumentAttributeKey = "conditionDocumentAttributeKey",
Operator = "operator",
// the properties below are optional
ConditionOnValue = new DocumentAttributeValueProperty {
DateValue = "dateValue",
LongValue = 123,
StringListValue = new [] { "stringListValue" },
StringValue = "stringValue"
}
},
DocumentContentDeletion = false,
Target = new DocumentAttributeTargetProperty {
TargetDocumentAttributeKey = "targetDocumentAttributeKey",
// the properties below are optional
TargetDocumentAttributeValue = new DocumentAttributeValueProperty {
DateValue = "dateValue",
LongValue = 123,
StringListValue = new [] { "stringListValue" },
StringValue = "stringValue"
},
TargetDocumentAttributeValueDeletion = false
}
} },
PostExtractionHookConfiguration = new HookConfigurationProperty {
LambdaArn = "lambdaArn",
S3Bucket = "s3Bucket",
// the properties below are optional
InvocationCondition = new DocumentAttributeConditionProperty {
ConditionDocumentAttributeKey = "conditionDocumentAttributeKey",
Operator = "operator",
// the properties below are optional
ConditionOnValue = new DocumentAttributeValueProperty {
DateValue = "dateValue",
LongValue = 123,
StringListValue = new [] { "stringListValue" },
StringValue = "stringValue"
}
}
},
PreExtractionHookConfiguration = new HookConfigurationProperty {
LambdaArn = "lambdaArn",
S3Bucket = "s3Bucket",
// the properties below are optional
InvocationCondition = new DocumentAttributeConditionProperty {
ConditionDocumentAttributeKey = "conditionDocumentAttributeKey",
Operator = "operator",
// the properties below are optional
ConditionOnValue = new DocumentAttributeValueProperty {
DateValue = "dateValue",
LongValue = 123,
StringListValue = new [] { "stringListValue" },
StringValue = "stringValue"
}
}
},
RoleArn = "roleArn"
},
DataSourceConfiguration = 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
}
},
Description = "description",
LanguageCode = "languageCode",
RoleArn = "roleArn",
Schedule = "schedule",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
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"
cfnDataSource := awscdk.Aws_kendra.NewCfnDataSource(this, jsii.String("MyCfnDataSource"), &CfnDataSourceProps{
IndexId: jsii.String("indexId"),
Name: jsii.String("name"),
Type: jsii.String("type"),
// the properties below are optional
CustomDocumentEnrichmentConfiguration: &CustomDocumentEnrichmentConfigurationProperty{
InlineConfigurations: []interface{}{
&InlineCustomDocumentEnrichmentConfigurationProperty{
Condition: &DocumentAttributeConditionProperty{
ConditionDocumentAttributeKey: jsii.String("conditionDocumentAttributeKey"),
Operator: jsii.String("operator"),
// the properties below are optional
ConditionOnValue: &DocumentAttributeValueProperty{
DateValue: jsii.String("dateValue"),
LongValue: jsii.Number(123),
StringListValue: []*string{
jsii.String("stringListValue"),
},
StringValue: jsii.String("stringValue"),
},
},
DocumentContentDeletion: jsii.Boolean(false),
Target: &DocumentAttributeTargetProperty{
TargetDocumentAttributeKey: jsii.String("targetDocumentAttributeKey"),
// the properties below are optional
TargetDocumentAttributeValue: &DocumentAttributeValueProperty{
DateValue: jsii.String("dateValue"),
LongValue: jsii.Number(123),
StringListValue: []*string{
jsii.String("stringListValue"),
},
StringValue: jsii.String("stringValue"),
},
TargetDocumentAttributeValueDeletion: jsii.Boolean(false),
},
},
},
PostExtractionHookConfiguration: &HookConfigurationProperty{
LambdaArn: jsii.String("lambdaArn"),
S3Bucket: jsii.String("s3Bucket"),
// the properties below are optional
InvocationCondition: &DocumentAttributeConditionProperty{
ConditionDocumentAttributeKey: jsii.String("conditionDocumentAttributeKey"),
Operator: jsii.String("operator"),
// the properties below are optional
ConditionOnValue: &DocumentAttributeValueProperty{
DateValue: jsii.String("dateValue"),
LongValue: jsii.Number(123),
StringListValue: []*string{
jsii.String("stringListValue"),
},
StringValue: jsii.String("stringValue"),
},
},
},
PreExtractionHookConfiguration: &HookConfigurationProperty{
LambdaArn: jsii.String("lambdaArn"),
S3Bucket: jsii.String("s3Bucket"),
// the properties below are optional
InvocationCondition: &DocumentAttributeConditionProperty{
ConditionDocumentAttributeKey: jsii.String("conditionDocumentAttributeKey"),
Operator: jsii.String("operator"),
// the properties below are optional
ConditionOnValue: &DocumentAttributeValueProperty{
DateValue: jsii.String("dateValue"),
LongValue: jsii.Number(123),
StringListValue: []*string{
jsii.String("stringListValue"),
},
StringValue: jsii.String("stringValue"),
},
},
},
RoleArn: jsii.String("roleArn"),
},
DataSourceConfiguration: &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),
},
},
Description: jsii.String("description"),
LanguageCode: jsii.String("languageCode"),
RoleArn: jsii.String("roleArn"),
Schedule: jsii.String("schedule"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
Initializer
ts
new CfnDataSource(scope: Construct, id: string, props: CfnDataSourceProps)
python
CfnDataSource(scope: Construct, id: str, props: CfnDataSourceProps)
java
new CfnDataSource(Construct scope, String id, CfnDataSourceProps props)
csharp
new CfnDataSource(Construct scope, string id, CfnDataSourceProps props)
go
NewCfnDataSource(Scope Construct, Id *string, Props CfnDataSourceProps)
Construct Props
customDocumentEnrichmentConfigurationoptionalIResolvable | CfnDataSource.CustomDocumentEnrichmentConfigurationPropertycustom_document_enrichment_configurationoptionaltyping.Union[IResolvable, CustomDocumentEnrichmentConfigurationProperty]customDocumentEnrichmentConfigurationoptionalIResolvableCustomDocumentEnrichmentConfigurationoptionalIResolvableCustomDocumentEnrichmentConfigurationoptionalinterface{}#Configuration information for altering document metadata and content during the document ingestion process.
dataSourceConfigurationoptionalIResolvable | CfnDataSource.DataSourceConfigurationPropertydata_source_configurationoptionaltyping.Union[IResolvable, DataSourceConfigurationProperty]dataSourceConfigurationoptionalIResolvableDataSourceConfigurationoptionalIResolvableDataSourceConfigurationoptionalinterface{}#Configuration information for an Amazon Kendra data source.
notes
The contents of the configuration depend on the type of data source. You can only specify one type of data source in the configuration.
You can't specify the Configuration parameter when the Type parameter is set to CUSTOM .
The Configuration parameter is required for all other data sources.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#A description for the data source connector.
indexIdstring | IIndexRefindex_idtyping.Union[str, IIndexRef]indexIdStringIndexIdstringIndexIdinterface{}required#The identifier of the index you want to use with the data source connector.
languageCodeoptionalstringlanguage_codeoptionalstrlanguageCodeoptionalStringLanguageCodeoptionalstringLanguageCodeoptional*string#The code for a language.
notes
This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English .
The name of the data source.
roleArnoptionalstring | IRoleRefrole_arnoptionaltyping.Union[str, IRoleRef]roleArnoptionalStringRoleArnoptionalstringRoleArnoptionalinterface{}#The Amazon Resource Name (ARN) of a role with permission to access the data source.
You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM .
The RoleArn parameter is required for all other data sources.
scheduleoptionalstringscheduleoptionalstrscheduleoptionalStringScheduleoptionalstringScheduleoptional*string#Sets the frequency that Amazon Kendra checks the documents in your data source and updates the index.
If you don't set a schedule, Amazon Kendra doesn't periodically update the index.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#An array of key-value pairs to apply to this resource.
For more information, see Tag .
The type of the data source.
Properties
The Amazon Resource Name (ARN) of the data source. For example:.
arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/data-source/b8cae438-6787-4091-8897-684a652bbb0a
The identifier for the data source. For example:.
b8cae438-6787-4091-8897-684a652bbb0a .
CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringstatic#The CloudFormation resource type name for this resource class.
cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptions#Options for this resource, such as condition, update policy etc.
cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string#AWS resource type.
creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string#customDocumentEnrichmentConfigurationmay be undefinedIResolvable | CfnDataSource.CustomDocumentEnrichmentConfigurationPropertycustom_document_enrichment_configurationmay be undefinedtyping.Union[IResolvable, CustomDocumentEnrichmentConfigurationProperty]customDocumentEnrichmentConfigurationmay be undefinedIResolvableCustomDocumentEnrichmentConfigurationmay be undefinedIResolvableCustomDocumentEnrichmentConfigurationmay be undefinedinterface{}#Configuration information for altering document metadata and content during the document ingestion process.
dataSourceConfigurationmay be undefinedIResolvable | CfnDataSource.DataSourceConfigurationPropertydata_source_configurationmay be undefinedtyping.Union[IResolvable, DataSourceConfigurationProperty]dataSourceConfigurationmay be undefinedIResolvableDataSourceConfigurationmay be undefinedIResolvableDataSourceConfigurationmay be undefinedinterface{}#Configuration information for an Amazon Kendra data source.
dataSourceRefDataSourceReferencedata_source_refDataSourceReferencedataSourceRefDataSourceReferenceDataSourceRefDataSourceReferenceDataSourceRefDataSourceReference#A reference to a DataSource resource.
descriptionmay be undefinedstringdescriptionmay be undefinedstrdescriptionmay be undefinedStringDescriptionmay be undefinedstringDescriptionmay be undefined*string#A description for the data source connector.
The identifier of the index you want to use with the data source connector.
languageCodemay be undefinedstringlanguage_codemay be undefinedstrlanguageCodemay be undefinedStringLanguageCodemay be undefinedstringLanguageCodemay be undefined*string#The code for a language.
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId).
The name of the data source.
Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).
roleArnmay be undefinedstringrole_arnmay be undefinedstrroleArnmay be undefinedStringRoleArnmay be undefinedstringRoleArnmay be undefined*string#The Amazon Resource Name (ARN) of a role with permission to access the data source.
schedulemay be undefinedstringschedulemay be undefinedstrschedulemay be undefinedStringSchedulemay be undefinedstringSchedulemay be undefined*string#Sets the frequency that Amazon Kendra checks the documents in your data source and updates the index.
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
Tag Manager which manages the tags for this resource.
tagsRawmay be undefinedCfnTag[]tags_rawmay be undefinedtyping.List[CfnTag]tagsRawmay be undefinedList<CfnTag>TagsRawmay be undefinedCfnTag[]TagsRawmay be undefined*[]CfnTag#An array of key-value pairs to apply to this resource.
The type of the data source.
Methods
addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#Syntactic sugar for `addOverride(path, undefined)`.
1 parameter
Parameters
pathpathpathpathPath— The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#Use `addResourceDependency` instead.
This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.
addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#Use `addResourceDependency` instead.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.
addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#Add a value to the CloudFormation Resource Metadata.
addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#Adds an override to the synthesized CloudFormation resource.
notes · 2 parameters
To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.
For example,
typescript
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
json
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.
Parameters
pathpathpathpathPath— - The path of the property, you can use dot notation to override values in complex types.valuevaluevaluevalueValue— - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#Adds an override that deletes the value of a property from the resource definition.
1 parameter
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
2 parameters
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path of the property.valuevaluevaluevalueValue— The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Sets the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
1 parameter
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#Sets the deletion policy of the resource based on the removal policy specified.
notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:
arnForDataSource(resource: IDataSourceRef): string@staticmethod def arn_for_data_source(resource: IDataSourceRef) -> strpublic static String arnForDataSource(IDataSourceRef resource)public static string ArnForDataSource(IDataSourceRef resource)func ArnForDataSource(Resource IDataSourceRef) *stringstatic#cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.
1 parameter
Parameters
attributeNameattribute_nameattributeNameattributeNameAttributeName— The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#Examines the CloudFormation resource and discloses attributes.
1 parameter
Parameters
inspectorinspectorinspectorinspectorInspector— tree inspector to collect and process attributes.
isCfnDataSource(x: any): boolean@staticmethod def is_cfn_data_source(x: Any) -> boolpublic static Boolean isCfnDataSource(Object x)public static bool IsCfnDataSource(object x)func IsCfnDataSource(X interface{}) *boolstatic#Checks whether the given object is a CfnDataSource.
isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.
returns
Returns: The construct as a stack element or undefined if it is not a stack element.
isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#Check whether the given object is a CfnResource.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#Retrieves an array of resources and stacks this resource depends on.
For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.
overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#Overrides the auto-generated logical ID with a specific ID.
1 parameter
Parameters
newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId— The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#Use `removeResourceDependency` instead
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#Replaces one dependency with another.
2 parameters
Parameters
targettargettargettargetTarget— The dependency to replace.newTargetnew_targetnewTargetnewTargetNewTarget— The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
returns
Returns: a string representation of this resource
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.