latest--aws-kendra-datasource

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-kendra-datasource.json
Parent schema serverless-framework-configuration
Type: object

Kendra DataSource. Source:- https://docs.aws.amazon.com/kendra/latest/dg/hiw-data-source.html

Properties

Name string | Aws_CF_FunctionString required

Name of data source

IndexId string | Aws_CF_FunctionString required

ID of Index

Type string | Aws_CF_FunctionString required

Data source type

DataSourceConfiguration object
One of: variant, variant, variant, variant, variant, variant, variant, variant, variant, variant
10 nested properties
S3Configuration object

S3 data source configuration

6 nested properties
BucketName string | Aws_CF_FunctionString required
InclusionPrefixes string[]
maxItems=100
InclusionPatterns string[]
maxItems=100
ExclusionPatterns string[]
maxItems=100
DocumentsMetadataConfiguration object
1 nested properties
S3Prefix string | Aws_CF_FunctionString
AccessControlListConfiguration object
1 nested properties
KeyPath string | Aws_CF_FunctionString
SharePointConfiguration object

SharePoint configuration

12 nested properties
SharePointVersion string | Aws_CF_FunctionString required
Urls Url[] required
maxItems=100
SecretArn string | Aws_CF_FunctionString required
CrawlAttachments boolean
UseChangeLog boolean
InclusionPatterns string[]
maxItems=100
ExclusionPatterns string[]
maxItems=100
VpcConfiguration object
2 nested properties
SubnetIds string[] required
maxItems=6
SecurityGroupIds string[] required
maxItems=10
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
DocumentTitleFieldName string | Aws_CF_FunctionString
DisableLocalGroups boolean
SslCertificateS3Path object
2 nested properties
Bucket string | Aws_CF_FunctionString required
Key string | Aws_CF_FunctionString required
SalesforceConfiguration object
9 nested properties
ServerUrl string | Aws_CF_FunctionString required
SecretArn string | Aws_CF_FunctionString required
StandardObjectConfigurations SalesforceStandardObjectConfiguration[]
minItems=1maxItems=17
KnowledgeArticleConfiguration object
3 nested properties
IncludedStates SalesforceKnowledgeArticleState[] required
minItems=1maxItems=3
StandardKnowledgeArticleTypeConfiguration object
CustomKnowledgeArticleTypeConfigurations SalesforceCustomKnowledgeArticleTypeConfiguration[]
minItems=1maxItems=10
ChatterFeedConfiguration object
4 nested properties
DocumentDataFieldName string | Aws_CF_FunctionString required
DocumentTitleFieldName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
IncludeFilterTypes SalesforceChatterFeedIncludeFilterType[]
minItems=1maxItems=2
CrawlAttachments boolean
StandardObjectAttachmentConfiguration object
2 nested properties
DocumentTitleFieldName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
IncludeAttachmentFilePatterns string[]
maxItems=100
ExcludeAttachmentFilePatterns string[]
maxItems=100
OneDriveConfiguration object
7 nested properties
TenantDomain string | Aws_CF_FunctionString required
SecretArn string | Aws_CF_FunctionString required
OneDriveUsers object required
One of: variant, variant
2 nested properties
OneDriveUserList OneDriveUser[]
minItems=1maxItems=100
OneDriveUserS3Path object
InclusionPatterns string[]
maxItems=100
ExclusionPatterns string[]
maxItems=100
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
DisableLocalGroups boolean
ServiceNowConfiguration object
6 nested properties
HostUrl string | Aws_CF_FunctionString required
SecretArn string | Aws_CF_FunctionString required
ServiceNowBuildVersion string | Aws_CF_FunctionString required
AuthenticationType string | Aws_CF_FunctionString
KnowledgeArticleConfiguration object
7 nested properties
DocumentDataFieldName string | Aws_CF_FunctionString required
CrawlAttachments boolean
IncludeAttachmentFilePatterns string[]
maxItems=100
ExcludeAttachmentFilePatterns string[]
maxItems=100
DocumentTitleFieldName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
FilterQuery string | Aws_CF_FunctionString
ServiceCatalogConfiguration object
6 nested properties
DocumentDataFieldName string | Aws_CF_FunctionString required
CrawlAttachments boolean
IncludeAttachmentFilePatterns string[]
maxItems=100
ExcludeAttachmentFilePatterns string[]
maxItems=100
DocumentTitleFieldName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
DatabaseConfiguration object
6 nested properties
DatabaseEngineType string | Aws_CF_FunctionString required
ConnectionConfiguration object required
5 nested properties
DatabaseHost string | Aws_CF_FunctionString required
DatabasePort integer required
min=1max=65535
DatabaseName string | Aws_CF_FunctionString required
TableName string | Aws_CF_FunctionString required
SecretArn string | Aws_CF_FunctionString required
ColumnConfiguration object required
5 nested properties
DocumentIdColumnName string | Aws_CF_FunctionString required
DocumentDataColumnName string | Aws_CF_FunctionString required
ChangeDetectingColumns ColumnName[] required
minItems=1maxItems=5
DocumentTitleColumnName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
VpcConfiguration object
2 nested properties
SubnetIds string[] required
maxItems=6
SecurityGroupIds string[] required
maxItems=10
AclConfiguration object
1 nested properties
AllowedGroupsColumnName string | Aws_CF_FunctionString required
SqlConfiguration object
1 nested properties
QueryIdentifiersEnclosingOption string | Aws_CF_FunctionString
ConfluenceConfiguration object
10 nested properties
ServerUrl string | Aws_CF_FunctionString required
SecretArn string | Aws_CF_FunctionString required
Version string | Aws_CF_FunctionString required
SpaceConfiguration object
5 nested properties
CrawlPersonalSpaces boolean
CrawlArchivedSpaces boolean
IncludeSpaces ConfluenceSpaceIdentifier[]
minItems=1
ExcludeSpaces ConfluenceSpaceIdentifier[]
minItems=1
SpaceFieldMappings ConfluenceSpaceToIndexFieldMapping[]
minItems=1maxItems=4
PageConfiguration object
1 nested properties
PageFieldMappings ConfluencePageToIndexFieldMapping[]
minItems=1maxItems=12
BlogConfiguration object
1 nested properties
BlogFieldMappings ConfluenceBlogToIndexFieldMapping[]
minItems=1maxItems=9
AttachmentConfiguration object
2 nested properties
CrawlAttachments boolean
AttachmentFieldMappings ConfluenceAttachmentToIndexFieldMapping[]
minItems=1maxItems=11
VpcConfiguration object
2 nested properties
SubnetIds string[] required
maxItems=6
SecurityGroupIds string[] required
maxItems=10
InclusionPatterns string[]
maxItems=100
ExclusionPatterns string[]
maxItems=100
GoogleDriveConfiguration object
7 nested properties
SecretArn string | Aws_CF_FunctionString required
InclusionPatterns string[]
maxItems=100
ExclusionPatterns string[]
maxItems=100
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
ExcludeMimeTypes MimeType[]
minItems=0maxItems=30
ExcludeUserAccounts UserAccount[]
minItems=0maxItems=100
ExcludeSharedDrives SharedDriveId[]
minItems=0maxItems=100
WebCrawlerConfiguration object
9 nested properties
Urls object required
2 nested properties
SeedUrlConfiguration object
SiteMapsConfiguration object
CrawlDepth integer
min=1max=10
MaxLinksPerPage integer
min=1max=1000
MaxContentSizePerPageInMegaBytes number
min=0max=50
MaxUrlsPerMinuteCrawlRate integer
min=1max=300
UrlInclusionPatterns string[]
maxItems=100
UrlExclusionPatterns string[]
maxItems=100
ProxyConfiguration object
3 nested properties
Host string | Aws_CF_FunctionString required
Port integer required
min=1max=65535
Credentials string | Aws_CF_FunctionString
AuthenticationConfiguration object
1 nested properties
BasicAuthentication WebCrawlerBasicAuthentication[]
maxItems=10
WorkDocsConfiguration object
6 nested properties
OrganizationId string | Aws_CF_FunctionString required
CrawlComments boolean
UseChangeLog boolean
InclusionPatterns string[]
maxItems=100
ExclusionPatterns string[]
maxItems=100
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
Description string | Aws_CF_FunctionString

Description of data source

Schedule string | Aws_CF_FunctionString

Schedule

RoleArn string | Aws_CF_FunctionString

Role ARN

Tags Tag[]

List of tags

maxItems=200
CustomDocumentEnrichmentConfiguration object
4 nested properties
InlineConfigurations InlineCustomDocumentEnrichmentConfiguration[]

List of InlineCustomDocumentEnrichmentConfigurations

maxItems=100
PreExtractionHookConfiguration object
3 nested properties
LambdaArn string | Aws_CF_FunctionString required
S3Bucket string | Aws_CF_FunctionString required
InvocationCondition object
3 nested properties
ConditionDocumentAttributeKey string | Aws_CF_FunctionString required
Operator string | Aws_CF_FunctionString required
ConditionOnValue object
PostExtractionHookConfiguration object
3 nested properties
LambdaArn string | Aws_CF_FunctionString required
S3Bucket string | Aws_CF_FunctionString required
InvocationCondition object
3 nested properties
ConditionDocumentAttributeKey string | Aws_CF_FunctionString required
Operator string | Aws_CF_FunctionString required
ConditionOnValue object
RoleArn string | Aws_CF_FunctionString

Role ARN

Definitions

IndexId string | Aws_CF_FunctionString

ID of Index

Tag object

A label for tagging Kendra resources

Key string | Aws_CF_FunctionString required

A string used to identify this tag

Value string | Aws_CF_FunctionString required

A string containing the value for the tag

TagList Tag[]

List of tags

DataSourceInclusionsExclusionsStrings string[]
S3Path object
Bucket string | Aws_CF_FunctionString required
Key string | Aws_CF_FunctionString required
S3BucketName string | Aws_CF_FunctionString
S3ObjectKey string | Aws_CF_FunctionString
DocumentsMetadataConfiguration object
S3Prefix string | Aws_CF_FunctionString
AccessControlListConfiguration object
KeyPath string | Aws_CF_FunctionString
S3DataSourceConfiguration object

S3 data source configuration

BucketName string | Aws_CF_FunctionString required
InclusionPrefixes string[]
maxItems=100
InclusionPatterns string[]
maxItems=100
ExclusionPatterns string[]
maxItems=100
DocumentsMetadataConfiguration object
1 nested properties
S3Prefix string | Aws_CF_FunctionString
AccessControlListConfiguration object
1 nested properties
KeyPath string | Aws_CF_FunctionString
Url string | Aws_CF_FunctionString
SecretArn string | Aws_CF_FunctionString
DataSourceVpcConfiguration object
SubnetIds string[] required
maxItems=6
SecurityGroupIds string[] required
maxItems=10
DataSourceFieldName string | Aws_CF_FunctionString
DataSourceToIndexFieldMapping object
DataSourceFieldName string | Aws_CF_FunctionString required
IndexFieldName string | Aws_CF_FunctionString required
DateFieldFormat string | Aws_CF_FunctionString
DateFieldFormat string | Aws_CF_FunctionString
IndexFieldName string | Aws_CF_FunctionString
DataSourceToIndexFieldMappingList DataSourceToIndexFieldMapping[]
DisableLocalGroups boolean
SharePointConfiguration object

SharePoint configuration

SharePointVersion string | Aws_CF_FunctionString required
Urls Url[] required
maxItems=100
SecretArn string | Aws_CF_FunctionString required
CrawlAttachments boolean
UseChangeLog boolean
InclusionPatterns string[]
maxItems=100
ExclusionPatterns string[]
maxItems=100
VpcConfiguration object
2 nested properties
SubnetIds string[] required
maxItems=6
SecurityGroupIds string[] required
maxItems=10
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
DocumentTitleFieldName string | Aws_CF_FunctionString
DisableLocalGroups boolean
SslCertificateS3Path object
2 nested properties
Bucket string | Aws_CF_FunctionString required
Key string | Aws_CF_FunctionString required
SalesforceConfiguration object
ServerUrl string | Aws_CF_FunctionString required
SecretArn string | Aws_CF_FunctionString required
StandardObjectConfigurations SalesforceStandardObjectConfiguration[]
minItems=1maxItems=17
KnowledgeArticleConfiguration object
3 nested properties
IncludedStates SalesforceKnowledgeArticleState[] required
minItems=1maxItems=3
StandardKnowledgeArticleTypeConfiguration object
3 nested properties
DocumentDataFieldName string | Aws_CF_FunctionString required
DocumentTitleFieldName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
CustomKnowledgeArticleTypeConfigurations SalesforceCustomKnowledgeArticleTypeConfiguration[]
minItems=1maxItems=10
ChatterFeedConfiguration object
4 nested properties
DocumentDataFieldName string | Aws_CF_FunctionString required
DocumentTitleFieldName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
IncludeFilterTypes SalesforceChatterFeedIncludeFilterType[]
minItems=1maxItems=2
CrawlAttachments boolean
StandardObjectAttachmentConfiguration object
2 nested properties
DocumentTitleFieldName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
IncludeAttachmentFilePatterns string[]
maxItems=100
ExcludeAttachmentFilePatterns string[]
maxItems=100
SalesforceStandardObjectConfigurationList SalesforceStandardObjectConfiguration[]
SalesforceStandardObjectConfiguration object
Name string | Aws_CF_FunctionString required
DocumentDataFieldName string | Aws_CF_FunctionString required
DocumentTitleFieldName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
SalesforceStandardObjectName string | Aws_CF_FunctionString
SalesforceKnowledgeArticleConfiguration object
IncludedStates SalesforceKnowledgeArticleState[] required
minItems=1maxItems=3
StandardKnowledgeArticleTypeConfiguration object
3 nested properties
DocumentDataFieldName string | Aws_CF_FunctionString required
DocumentTitleFieldName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
CustomKnowledgeArticleTypeConfigurations SalesforceCustomKnowledgeArticleTypeConfiguration[]
minItems=1maxItems=10
SalesforceKnowledgeArticleStateList SalesforceKnowledgeArticleState[]
SalesforceKnowledgeArticleState string | Aws_CF_FunctionString
SalesforceStandardKnowledgeArticleTypeConfiguration object
DocumentDataFieldName string | Aws_CF_FunctionString required
DocumentTitleFieldName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
SalesforceCustomKnowledgeArticleTypeConfigurationList SalesforceCustomKnowledgeArticleTypeConfiguration[]
SalesforceCustomKnowledgeArticleTypeConfiguration object
Name string | Aws_CF_FunctionString required
DocumentDataFieldName string | Aws_CF_FunctionString required
DocumentTitleFieldName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
SalesforceCustomKnowledgeArticleTypeName string | Aws_CF_FunctionString
SalesforceChatterFeedConfiguration object
DocumentDataFieldName string | Aws_CF_FunctionString required
DocumentTitleFieldName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
IncludeFilterTypes SalesforceChatterFeedIncludeFilterType[]
minItems=1maxItems=2
SalesforceChatterFeedIncludeFilterTypes SalesforceChatterFeedIncludeFilterType[]
SalesforceChatterFeedIncludeFilterType string | Aws_CF_FunctionString
SalesforceStandardObjectAttachmentConfiguration object
DocumentTitleFieldName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
DatabaseConfiguration object
DatabaseEngineType string | Aws_CF_FunctionString required
ConnectionConfiguration object required
5 nested properties
DatabaseHost string | Aws_CF_FunctionString required
DatabasePort integer required
min=1max=65535
DatabaseName string | Aws_CF_FunctionString required
TableName string | Aws_CF_FunctionString required
SecretArn string | Aws_CF_FunctionString required
ColumnConfiguration object required
5 nested properties
DocumentIdColumnName string | Aws_CF_FunctionString required
DocumentDataColumnName string | Aws_CF_FunctionString required
ChangeDetectingColumns ColumnName[] required
minItems=1maxItems=5
DocumentTitleColumnName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
VpcConfiguration object
2 nested properties
SubnetIds string[] required
maxItems=6
SecurityGroupIds string[] required
maxItems=10
AclConfiguration object
1 nested properties
AllowedGroupsColumnName string | Aws_CF_FunctionString required
SqlConfiguration object
1 nested properties
QueryIdentifiersEnclosingOption string | Aws_CF_FunctionString
DatabaseEngineType string | Aws_CF_FunctionString
ConnectionConfiguration object
DatabaseHost string | Aws_CF_FunctionString required
DatabasePort integer required
min=1max=65535
DatabaseName string | Aws_CF_FunctionString required
TableName string | Aws_CF_FunctionString required
SecretArn string | Aws_CF_FunctionString required
DatabaseHost string | Aws_CF_FunctionString
DatabasePort integer
DatabaseName string | Aws_CF_FunctionString
TableName string | Aws_CF_FunctionString
ColumnConfiguration object
DocumentIdColumnName string | Aws_CF_FunctionString required
DocumentDataColumnName string | Aws_CF_FunctionString required
ChangeDetectingColumns ColumnName[] required
minItems=1maxItems=5
DocumentTitleColumnName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
ChangeDetectingColumns ColumnName[]
ColumnName string | Aws_CF_FunctionString
SqlConfiguration object
QueryIdentifiersEnclosingOption string | Aws_CF_FunctionString
QueryIdentifiersEnclosingOption string | Aws_CF_FunctionString
AclConfiguration object
AllowedGroupsColumnName string | Aws_CF_FunctionString required
OneDriveConfiguration object
TenantDomain string | Aws_CF_FunctionString required
SecretArn string | Aws_CF_FunctionString required
OneDriveUsers object required
One of: variant, variant
2 nested properties
OneDriveUserList OneDriveUser[]
minItems=1maxItems=100
OneDriveUserS3Path object
2 nested properties
Bucket string | Aws_CF_FunctionString required
Key string | Aws_CF_FunctionString required
InclusionPatterns string[]
maxItems=100
ExclusionPatterns string[]
maxItems=100
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
DisableLocalGroups boolean
TenantDomain string | Aws_CF_FunctionString
OneDriveUsers object
OneDriveUserList OneDriveUser[]
minItems=1maxItems=100
OneDriveUserS3Path object
2 nested properties
Bucket string | Aws_CF_FunctionString required
Key string | Aws_CF_FunctionString required
OneDriveUserList OneDriveUser[]
OneDriveUser string | Aws_CF_FunctionString
ServiceNowConfiguration object
HostUrl string | Aws_CF_FunctionString required
SecretArn string | Aws_CF_FunctionString required
ServiceNowBuildVersion string | Aws_CF_FunctionString required
AuthenticationType string | Aws_CF_FunctionString
KnowledgeArticleConfiguration object
7 nested properties
DocumentDataFieldName string | Aws_CF_FunctionString required
CrawlAttachments boolean
IncludeAttachmentFilePatterns string[]
maxItems=100
ExcludeAttachmentFilePatterns string[]
maxItems=100
DocumentTitleFieldName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
FilterQuery string | Aws_CF_FunctionString
ServiceCatalogConfiguration object
6 nested properties
DocumentDataFieldName string | Aws_CF_FunctionString required
CrawlAttachments boolean
IncludeAttachmentFilePatterns string[]
maxItems=100
ExcludeAttachmentFilePatterns string[]
maxItems=100
DocumentTitleFieldName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
ServiceNowBuildVersionType string | Aws_CF_FunctionString
ServiceNowAuthenticationType string | Aws_CF_FunctionString
ServiceNowServiceCatalogConfiguration object
DocumentDataFieldName string | Aws_CF_FunctionString required
CrawlAttachments boolean
IncludeAttachmentFilePatterns string[]
maxItems=100
ExcludeAttachmentFilePatterns string[]
maxItems=100
DocumentTitleFieldName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
ServiceNowHostUrl string | Aws_CF_FunctionString
ServiceNowKnowledgeArticleConfiguration object
DocumentDataFieldName string | Aws_CF_FunctionString required
CrawlAttachments boolean
IncludeAttachmentFilePatterns string[]
maxItems=100
ExcludeAttachmentFilePatterns string[]
maxItems=100
DocumentTitleFieldName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
FilterQuery string | Aws_CF_FunctionString
ServiceNowKnowledgeArticleFilterQuery string | Aws_CF_FunctionString
ConfluenceConfiguration object
ServerUrl string | Aws_CF_FunctionString required
SecretArn string | Aws_CF_FunctionString required
Version string | Aws_CF_FunctionString required
SpaceConfiguration object
5 nested properties
CrawlPersonalSpaces boolean
CrawlArchivedSpaces boolean
IncludeSpaces ConfluenceSpaceIdentifier[]
minItems=1
ExcludeSpaces ConfluenceSpaceIdentifier[]
minItems=1
SpaceFieldMappings ConfluenceSpaceToIndexFieldMapping[]
minItems=1maxItems=4
PageConfiguration object
1 nested properties
PageFieldMappings ConfluencePageToIndexFieldMapping[]
minItems=1maxItems=12
BlogConfiguration object
1 nested properties
BlogFieldMappings ConfluenceBlogToIndexFieldMapping[]
minItems=1maxItems=9
AttachmentConfiguration object
2 nested properties
CrawlAttachments boolean
AttachmentFieldMappings ConfluenceAttachmentToIndexFieldMapping[]
minItems=1maxItems=11
VpcConfiguration object
2 nested properties
SubnetIds string[] required
maxItems=6
SecurityGroupIds string[] required
maxItems=10
InclusionPatterns string[]
maxItems=100
ExclusionPatterns string[]
maxItems=100
ConfluenceVersion string | Aws_CF_FunctionString
ConfluenceSpaceConfiguration object
CrawlPersonalSpaces boolean
CrawlArchivedSpaces boolean
IncludeSpaces ConfluenceSpaceIdentifier[]
minItems=1
ExcludeSpaces ConfluenceSpaceIdentifier[]
minItems=1
SpaceFieldMappings ConfluenceSpaceToIndexFieldMapping[]
minItems=1maxItems=4
ConfluenceSpaceFieldMappingsList ConfluenceSpaceToIndexFieldMapping[]
ConfluenceSpaceToIndexFieldMapping object
DataSourceFieldName string | Aws_CF_FunctionString required
IndexFieldName string | Aws_CF_FunctionString required
DateFieldFormat string | Aws_CF_FunctionString
ConfluenceSpaceFieldName string | Aws_CF_FunctionString
ConfluenceSpaceList ConfluenceSpaceIdentifier[]
ConfluenceSpaceIdentifier string | Aws_CF_FunctionString
ConfluencePageConfiguration object
PageFieldMappings ConfluencePageToIndexFieldMapping[]
minItems=1maxItems=12
ConfluencePageFieldMappingsList ConfluencePageToIndexFieldMapping[]
ConfluencePageToIndexFieldMapping object
DataSourceFieldName string | Aws_CF_FunctionString required
IndexFieldName string | Aws_CF_FunctionString required
DateFieldFormat string | Aws_CF_FunctionString
ConfluencePageFieldName string | Aws_CF_FunctionString
ConfluenceBlogConfiguration object
BlogFieldMappings ConfluenceBlogToIndexFieldMapping[]
minItems=1maxItems=9
ConfluenceBlogFieldMappingsList ConfluenceBlogToIndexFieldMapping[]
ConfluenceBlogToIndexFieldMapping object
DataSourceFieldName string | Aws_CF_FunctionString required
IndexFieldName string | Aws_CF_FunctionString required
DateFieldFormat string | Aws_CF_FunctionString
ConfluenceBlogFieldName string | Aws_CF_FunctionString
ConfluenceAttachmentConfiguration object
CrawlAttachments boolean
AttachmentFieldMappings ConfluenceAttachmentToIndexFieldMapping[]
minItems=1maxItems=11
ConfluenceAttachmentFieldMappingsList ConfluenceAttachmentToIndexFieldMapping[]
ConfluenceAttachmentToIndexFieldMapping object
DataSourceFieldName string | Aws_CF_FunctionString required
IndexFieldName string | Aws_CF_FunctionString required
DateFieldFormat string | Aws_CF_FunctionString
GoogleDriveConfiguration object
SecretArn string | Aws_CF_FunctionString required
InclusionPatterns string[]
maxItems=100
ExclusionPatterns string[]
maxItems=100
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
ExcludeMimeTypes MimeType[]
minItems=0maxItems=30
ExcludeUserAccounts UserAccount[]
minItems=0maxItems=100
ExcludeSharedDrives SharedDriveId[]
minItems=0maxItems=100
ExcludeMimeTypesList MimeType[]
MimeType string | Aws_CF_FunctionString
ExcludeUserAccountsList UserAccount[]
UserAccount string | Aws_CF_FunctionString
ExcludeSharedDrivesList SharedDriveId[]
SharedDriveId string | Aws_CF_FunctionString
ConfluenceAttachmentFieldName string | Aws_CF_FunctionString
WebCrawlerSiteMap string | Aws_CF_FunctionString
WebCrawlerSiteMaps WebCrawlerSiteMap[]
WebCrawlerSiteMapsConfiguration object
SiteMaps WebCrawlerSiteMap[] required
minItems=0maxItems=3
WebCrawlerSeedUrl string | Aws_CF_FunctionString
WebCrawlerSeedUrlList WebCrawlerSeedUrl[]
WebCrawlerSeedUrlConfiguration object
SeedUrls WebCrawlerSeedUrl[] required
minItems=0maxItems=100
WebCrawlerMode string | Aws_CF_FunctionString
WebCrawlerUrls object
SeedUrlConfiguration object
2 nested properties
SeedUrls WebCrawlerSeedUrl[] required
minItems=0maxItems=100
WebCrawlerMode string | Aws_CF_FunctionString
SiteMapsConfiguration object
1 nested properties
SiteMaps WebCrawlerSiteMap[] required
minItems=0maxItems=3
ProxyConfiguration object
Host string | Aws_CF_FunctionString required
Port integer required
min=1max=65535
Credentials string | Aws_CF_FunctionString
WebCrawlerBasicAuthentication object
Host string | Aws_CF_FunctionString required
Port integer required
min=1max=65535
Credentials string | Aws_CF_FunctionString required
WebCrawlerBasicAuthenticationList WebCrawlerBasicAuthentication[]
WebCrawlerAuthenticationConfiguration object
BasicAuthentication WebCrawlerBasicAuthentication[]
maxItems=10
WebCrawlerConfiguration object
Urls object required
2 nested properties
SeedUrlConfiguration object
2 nested properties
SeedUrls WebCrawlerSeedUrl[] required
minItems=0maxItems=100
WebCrawlerMode string | Aws_CF_FunctionString
SiteMapsConfiguration object
1 nested properties
SiteMaps WebCrawlerSiteMap[] required
minItems=0maxItems=3
CrawlDepth integer
min=1max=10
MaxLinksPerPage integer
min=1max=1000
MaxContentSizePerPageInMegaBytes number
min=0max=50
MaxUrlsPerMinuteCrawlRate integer
min=1max=300
UrlInclusionPatterns string[]
maxItems=100
UrlExclusionPatterns string[]
maxItems=100
ProxyConfiguration object
3 nested properties
Host string | Aws_CF_FunctionString required
Port integer required
min=1max=65535
Credentials string | Aws_CF_FunctionString
AuthenticationConfiguration object
1 nested properties
BasicAuthentication WebCrawlerBasicAuthentication[]
maxItems=10
WorkDocsConfiguration object
OrganizationId string | Aws_CF_FunctionString required
CrawlComments boolean
UseChangeLog boolean
InclusionPatterns string[]
maxItems=100
ExclusionPatterns string[]
maxItems=100
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
DataSourceConfiguration object
S3Configuration object

S3 data source configuration

6 nested properties
BucketName string | Aws_CF_FunctionString required
InclusionPrefixes string[]
maxItems=100
InclusionPatterns string[]
maxItems=100
ExclusionPatterns string[]
maxItems=100
DocumentsMetadataConfiguration object
1 nested properties
S3Prefix string | Aws_CF_FunctionString
AccessControlListConfiguration object
1 nested properties
KeyPath string | Aws_CF_FunctionString
SharePointConfiguration object

SharePoint configuration

12 nested properties
SharePointVersion string | Aws_CF_FunctionString required
Urls Url[] required
maxItems=100
SecretArn string | Aws_CF_FunctionString required
CrawlAttachments boolean
UseChangeLog boolean
InclusionPatterns string[]
maxItems=100
ExclusionPatterns string[]
maxItems=100
VpcConfiguration object
2 nested properties
SubnetIds string[] required
maxItems=6
SecurityGroupIds string[] required
maxItems=10
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
DocumentTitleFieldName string | Aws_CF_FunctionString
DisableLocalGroups boolean
SslCertificateS3Path object
2 nested properties
Bucket string | Aws_CF_FunctionString required
Key string | Aws_CF_FunctionString required
SalesforceConfiguration object
9 nested properties
ServerUrl string | Aws_CF_FunctionString required
SecretArn string | Aws_CF_FunctionString required
StandardObjectConfigurations SalesforceStandardObjectConfiguration[]
minItems=1maxItems=17
KnowledgeArticleConfiguration object
3 nested properties
IncludedStates SalesforceKnowledgeArticleState[] required
minItems=1maxItems=3
StandardKnowledgeArticleTypeConfiguration object
CustomKnowledgeArticleTypeConfigurations SalesforceCustomKnowledgeArticleTypeConfiguration[]
minItems=1maxItems=10
ChatterFeedConfiguration object
4 nested properties
DocumentDataFieldName string | Aws_CF_FunctionString required
DocumentTitleFieldName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
IncludeFilterTypes SalesforceChatterFeedIncludeFilterType[]
minItems=1maxItems=2
CrawlAttachments boolean
StandardObjectAttachmentConfiguration object
2 nested properties
DocumentTitleFieldName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
IncludeAttachmentFilePatterns string[]
maxItems=100
ExcludeAttachmentFilePatterns string[]
maxItems=100
OneDriveConfiguration object
7 nested properties
TenantDomain string | Aws_CF_FunctionString required
SecretArn string | Aws_CF_FunctionString required
OneDriveUsers object required
One of: variant, variant
2 nested properties
OneDriveUserList OneDriveUser[]
minItems=1maxItems=100
OneDriveUserS3Path object
InclusionPatterns string[]
maxItems=100
ExclusionPatterns string[]
maxItems=100
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
DisableLocalGroups boolean
ServiceNowConfiguration object
6 nested properties
HostUrl string | Aws_CF_FunctionString required
SecretArn string | Aws_CF_FunctionString required
ServiceNowBuildVersion string | Aws_CF_FunctionString required
AuthenticationType string | Aws_CF_FunctionString
KnowledgeArticleConfiguration object
7 nested properties
DocumentDataFieldName string | Aws_CF_FunctionString required
CrawlAttachments boolean
IncludeAttachmentFilePatterns string[]
maxItems=100
ExcludeAttachmentFilePatterns string[]
maxItems=100
DocumentTitleFieldName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
FilterQuery string | Aws_CF_FunctionString
ServiceCatalogConfiguration object
6 nested properties
DocumentDataFieldName string | Aws_CF_FunctionString required
CrawlAttachments boolean
IncludeAttachmentFilePatterns string[]
maxItems=100
ExcludeAttachmentFilePatterns string[]
maxItems=100
DocumentTitleFieldName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
DatabaseConfiguration object
6 nested properties
DatabaseEngineType string | Aws_CF_FunctionString required
ConnectionConfiguration object required
5 nested properties
DatabaseHost string | Aws_CF_FunctionString required
DatabasePort integer required
min=1max=65535
DatabaseName string | Aws_CF_FunctionString required
TableName string | Aws_CF_FunctionString required
SecretArn string | Aws_CF_FunctionString required
ColumnConfiguration object required
5 nested properties
DocumentIdColumnName string | Aws_CF_FunctionString required
DocumentDataColumnName string | Aws_CF_FunctionString required
ChangeDetectingColumns ColumnName[] required
minItems=1maxItems=5
DocumentTitleColumnName string | Aws_CF_FunctionString
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
VpcConfiguration object
2 nested properties
SubnetIds string[] required
maxItems=6
SecurityGroupIds string[] required
maxItems=10
AclConfiguration object
1 nested properties
AllowedGroupsColumnName string | Aws_CF_FunctionString required
SqlConfiguration object
1 nested properties
QueryIdentifiersEnclosingOption string | Aws_CF_FunctionString
ConfluenceConfiguration object
10 nested properties
ServerUrl string | Aws_CF_FunctionString required
SecretArn string | Aws_CF_FunctionString required
Version string | Aws_CF_FunctionString required
SpaceConfiguration object
5 nested properties
CrawlPersonalSpaces boolean
CrawlArchivedSpaces boolean
IncludeSpaces ConfluenceSpaceIdentifier[]
minItems=1
ExcludeSpaces ConfluenceSpaceIdentifier[]
minItems=1
SpaceFieldMappings ConfluenceSpaceToIndexFieldMapping[]
minItems=1maxItems=4
PageConfiguration object
1 nested properties
PageFieldMappings ConfluencePageToIndexFieldMapping[]
minItems=1maxItems=12
BlogConfiguration object
1 nested properties
BlogFieldMappings ConfluenceBlogToIndexFieldMapping[]
minItems=1maxItems=9
AttachmentConfiguration object
2 nested properties
CrawlAttachments boolean
AttachmentFieldMappings ConfluenceAttachmentToIndexFieldMapping[]
minItems=1maxItems=11
VpcConfiguration object
2 nested properties
SubnetIds string[] required
maxItems=6
SecurityGroupIds string[] required
maxItems=10
InclusionPatterns string[]
maxItems=100
ExclusionPatterns string[]
maxItems=100
GoogleDriveConfiguration object
7 nested properties
SecretArn string | Aws_CF_FunctionString required
InclusionPatterns string[]
maxItems=100
ExclusionPatterns string[]
maxItems=100
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
ExcludeMimeTypes MimeType[]
minItems=0maxItems=30
ExcludeUserAccounts UserAccount[]
minItems=0maxItems=100
ExcludeSharedDrives SharedDriveId[]
minItems=0maxItems=100
WebCrawlerConfiguration object
9 nested properties
Urls object required
2 nested properties
SeedUrlConfiguration object
SiteMapsConfiguration object
CrawlDepth integer
min=1max=10
MaxLinksPerPage integer
min=1max=1000
MaxContentSizePerPageInMegaBytes number
min=0max=50
MaxUrlsPerMinuteCrawlRate integer
min=1max=300
UrlInclusionPatterns string[]
maxItems=100
UrlExclusionPatterns string[]
maxItems=100
ProxyConfiguration object
3 nested properties
Host string | Aws_CF_FunctionString required
Port integer required
min=1max=65535
Credentials string | Aws_CF_FunctionString
AuthenticationConfiguration object
1 nested properties
BasicAuthentication WebCrawlerBasicAuthentication[]
maxItems=10
WorkDocsConfiguration object
6 nested properties
OrganizationId string | Aws_CF_FunctionString required
CrawlComments boolean
UseChangeLog boolean
InclusionPatterns string[]
maxItems=100
ExclusionPatterns string[]
maxItems=100
FieldMappings DataSourceToIndexFieldMapping[]
maxItems=100
Name string | Aws_CF_FunctionString

Name of data source

Type string | Aws_CF_FunctionString

Data source type

Description string | Aws_CF_FunctionString

Description of data source

RoleArn string | Aws_CF_FunctionString

Role ARN

Schedule string | Aws_CF_FunctionString

Schedule

Id string | Aws_CF_FunctionString

ID of data source

Arn string | Aws_CF_FunctionString
CustomDocumentEnrichmentConfiguration object
InlineConfigurations InlineCustomDocumentEnrichmentConfiguration[]

List of InlineCustomDocumentEnrichmentConfigurations

maxItems=100
PreExtractionHookConfiguration object
3 nested properties
LambdaArn string | Aws_CF_FunctionString required
S3Bucket string | Aws_CF_FunctionString required
InvocationCondition object
3 nested properties
ConditionDocumentAttributeKey string | Aws_CF_FunctionString required
Operator string | Aws_CF_FunctionString required
ConditionOnValue object
PostExtractionHookConfiguration object
3 nested properties
LambdaArn string | Aws_CF_FunctionString required
S3Bucket string | Aws_CF_FunctionString required
InvocationCondition object
3 nested properties
ConditionDocumentAttributeKey string | Aws_CF_FunctionString required
Operator string | Aws_CF_FunctionString required
ConditionOnValue object
RoleArn string | Aws_CF_FunctionString

Role ARN

InlineConfigurations InlineCustomDocumentEnrichmentConfiguration[]

List of InlineCustomDocumentEnrichmentConfigurations

InlineCustomDocumentEnrichmentConfiguration object
Condition object
3 nested properties
ConditionDocumentAttributeKey string | Aws_CF_FunctionString required
Operator string | Aws_CF_FunctionString required
ConditionOnValue object
4 nested properties
StringValue string | Aws_CF_FunctionString
StringListValue string[]
LongValue integer
format=int64
DateValue string | Aws_CF_FunctionString
Target object
3 nested properties
TargetDocumentAttributeKey string | Aws_CF_FunctionString required
TargetDocumentAttributeValueDeletion boolean
TargetDocumentAttributeValue object
4 nested properties
StringValue string | Aws_CF_FunctionString
StringListValue string[]
LongValue integer
format=int64
DateValue string | Aws_CF_FunctionString
DocumentContentDeletion boolean
DocumentAttributeCondition object
ConditionDocumentAttributeKey string | Aws_CF_FunctionString required
Operator string | Aws_CF_FunctionString required
ConditionOnValue object
4 nested properties
StringValue string | Aws_CF_FunctionString
StringListValue string[]
LongValue integer
format=int64
DateValue string | Aws_CF_FunctionString
DocumentAttributeTarget object
TargetDocumentAttributeKey string | Aws_CF_FunctionString required
TargetDocumentAttributeValueDeletion boolean
TargetDocumentAttributeValue object
4 nested properties
StringValue string | Aws_CF_FunctionString
StringListValue string[]
LongValue integer
format=int64
DateValue string | Aws_CF_FunctionString
ConditionOperator string | Aws_CF_FunctionString
DocumentAttributeKey string | Aws_CF_FunctionString
DocumentAttributeValue object
StringValue string | Aws_CF_FunctionString
StringListValue string[]
LongValue integer
format=int64
DateValue string | Aws_CF_FunctionString
Long integer
Timestamp string | Aws_CF_FunctionString
HookConfiguration object
LambdaArn string | Aws_CF_FunctionString required
S3Bucket string | Aws_CF_FunctionString required
InvocationCondition object
3 nested properties
ConditionDocumentAttributeKey string | Aws_CF_FunctionString required
Operator string | Aws_CF_FunctionString required
ConditionOnValue object
4 nested properties
StringValue string | Aws_CF_FunctionString
StringListValue string[]
LongValue integer
format=int64
DateValue string | Aws_CF_FunctionString
LambdaArn string | Aws_CF_FunctionString