AWS Cloud Control v1.26.0, Mar 12 25

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

pulumi/pulumi-aws-native

aws-native.kendra.getDataSource

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

pulumi/pulumi-aws-native

Using getDataSource

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDataSource(args: GetDataSourceArgs, opts?: InvokeOptions): Promise<GetDataSourceResult>
function getDataSourceOutput(args: GetDataSourceOutputArgs, opts?: InvokeOptions): Output<GetDataSourceResult>

def get_data_source(id: Optional[str] = None,
                    index_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetDataSourceResult
def get_data_source_output(id: Optional[pulumi.Input[str]] = None,
                    index_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetDataSourceResult]

func LookupDataSource(ctx *Context, args *LookupDataSourceArgs, opts ...InvokeOption) (*LookupDataSourceResult, error)
func LookupDataSourceOutput(ctx *Context, args *LookupDataSourceOutputArgs, opts ...InvokeOption) LookupDataSourceResultOutput

> Note: This function is named LookupDataSource in the Go SDK.

public static class GetDataSource 
{
    public static Task<GetDataSourceResult> InvokeAsync(GetDataSourceArgs args, InvokeOptions? opts = null)
    public static Output<GetDataSourceResult> Invoke(GetDataSourceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDataSourceResult> getDataSource(GetDataSourceArgs args, InvokeOptions options)
public static Output<GetDataSourceResult> getDataSource(GetDataSourceArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:kendra:getDataSource
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string

The identifier for the data source. For example:

b8cae438-6787-4091-8897-684a652bbb0a .

IndexId string

The identifier of the index you want to use with the data source connector.

Id string

The identifier for the data source. For example:

b8cae438-6787-4091-8897-684a652bbb0a .

IndexId string

The identifier of the index you want to use with the data source connector.

id String

The identifier for the data source. For example:

b8cae438-6787-4091-8897-684a652bbb0a .

indexId String

The identifier of the index you want to use with the data source connector.

id string

The identifier for the data source. For example:

b8cae438-6787-4091-8897-684a652bbb0a .

indexId string

The identifier of the index you want to use with the data source connector.

id str

The identifier for the data source. For example:

b8cae438-6787-4091-8897-684a652bbb0a .

index_id str

The identifier of the index you want to use with the data source connector.

id String

The identifier for the data source. For example:

b8cae438-6787-4091-8897-684a652bbb0a .

indexId String

The identifier of the index you want to use with the data source connector.

getDataSource Result

The following output properties are available:

Arn string

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

CustomDocumentEnrichmentConfiguration Pulumi.AwsNative.Kendra.Outputs.DataSourceCustomDocumentEnrichmentConfiguration

Configuration information for altering document metadata and content during the document ingestion process.

DataSourceConfiguration Pulumi.AwsNative.Kendra.Outputs.DataSourceConfiguration

Configuration information for an Amazon Kendra data source. 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.

Description string

A description for the data source connector.

Id string

The identifier for the data source. For example:

b8cae438-6787-4091-8897-684a652bbb0a .

IndexId string

The identifier of the index you want to use with the data source connector.

LanguageCode string

The code for a language. 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 .

Name string

The name of the data source.

RoleArn string

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.

Schedule 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.

Tags List<Pulumi.AwsNative.Outputs.Tag>

Tags for labeling the data source

Arn string

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

CustomDocumentEnrichmentConfiguration DataSourceCustomDocumentEnrichmentConfiguration

Configuration information for altering document metadata and content during the document ingestion process.

DataSourceConfiguration DataSourceConfiguration

Configuration information for an Amazon Kendra data source. 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.

Description string

A description for the data source connector.

Id string

The identifier for the data source. For example:

b8cae438-6787-4091-8897-684a652bbb0a .

IndexId string

The identifier of the index you want to use with the data source connector.

LanguageCode string

Name string

The name of the data source.

RoleArn string

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.

Schedule 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.

Tags Tag

Tags for labeling the data source

arn String

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

customDocumentEnrichmentConfiguration DataSourceCustomDocumentEnrichmentConfiguration

Configuration information for altering document metadata and content during the document ingestion process.

dataSourceConfiguration DataSourceConfiguration

Configuration information for an Amazon Kendra data source. 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.

description String

A description for the data source connector.

id String

The identifier for the data source. For example:

b8cae438-6787-4091-8897-684a652bbb0a .

indexId String

The identifier of the index you want to use with the data source connector.

languageCode String

name String

The name of the data source.

roleArn String

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.

schedule 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.

tags List<Tag>

Tags for labeling the data source

arn string

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

customDocumentEnrichmentConfiguration DataSourceCustomDocumentEnrichmentConfiguration

Configuration information for altering document metadata and content during the document ingestion process.

dataSourceConfiguration DataSourceConfiguration

Configuration information for an Amazon Kendra data source. 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.

description string

A description for the data source connector.

id string

The identifier for the data source. For example:

b8cae438-6787-4091-8897-684a652bbb0a .

indexId string

The identifier of the index you want to use with the data source connector.

languageCode string

name string

The name of the data source.

roleArn string

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.

schedule 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.

tags Tag[]

Tags for labeling the data source

arn str

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

custom_document_enrichment_configuration DataSourceCustomDocumentEnrichmentConfiguration

Configuration information for altering document metadata and content during the document ingestion process.

data_source_configuration DataSourceConfiguration

Configuration information for an Amazon Kendra data source. 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.

description str

A description for the data source connector.

id str

The identifier for the data source. For example:

b8cae438-6787-4091-8897-684a652bbb0a .

index_id str

The identifier of the index you want to use with the data source connector.

language_code str

name str

The name of the data source.

role_arn str

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.

schedule str

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.

tags Sequence[root_Tag]

Tags for labeling the data source

arn String

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

customDocumentEnrichmentConfiguration Property Map

Configuration information for altering document metadata and content during the document ingestion process.

dataSourceConfiguration Property Map

Configuration information for an Amazon Kendra data source. 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.

description String

A description for the data source connector.

id String

The identifier for the data source. For example:

b8cae438-6787-4091-8897-684a652bbb0a .

indexId String

The identifier of the index you want to use with the data source connector.

languageCode String

name String

The name of the data source.

roleArn String

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.

schedule 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.

tags List<Property Map>

Tags for labeling the data source

Supporting Types

DataSourceAccessControlListConfiguration

KeyPath string: Path to the AWS S3 bucket that contains the access control list files.

KeyPath string: Path to the AWS S3 bucket that contains the access control list files.

keyPath String: Path to the AWS S3 bucket that contains the access control list files.

keyPath string: Path to the AWS S3 bucket that contains the access control list files.

key_path str: Path to the AWS S3 bucket that contains the access control list files.

keyPath String: Path to the AWS S3 bucket that contains the access control list files.

DataSourceAclConfiguration

AllowedGroupsColumnName string: A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query operation.

AllowedGroupsColumnName string: A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query operation.

allowedGroupsColumnName String: A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query operation.

allowedGroupsColumnName string: A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query operation.

allowed_groups_column_name str: A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query operation.

allowedGroupsColumnName String: A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext field of the Query operation.

DataSourceColumnConfiguration

ChangeDetectingColumns List<string>: One to five columns that indicate when a document in the database has changed.
DocumentDataColumnName string: The column that contains the contents of the document.
DocumentIdColumnName string: The column that provides the document's identifier.
DocumentTitleColumnName string: The column that contains the title of the document.
FieldMappings List<Pulumi.AwsNative.Kendra.Inputs.DataSourceToIndexFieldMapping>: An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex operation.

ChangeDetectingColumns []string: One to five columns that indicate when a document in the database has changed.
DocumentDataColumnName string: The column that contains the contents of the document.
DocumentIdColumnName string: The column that provides the document's identifier.
DocumentTitleColumnName string: The column that contains the title of the document.
FieldMappings []DataSourceToIndexFieldMapping: An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex operation.

changeDetectingColumns List<String>: One to five columns that indicate when a document in the database has changed.
documentDataColumnName String: The column that contains the contents of the document.
documentIdColumnName String: The column that provides the document's identifier.
documentTitleColumnName String: The column that contains the title of the document.
fieldMappings List<DataSourceToIndexFieldMapping>: An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex operation.

changeDetectingColumns string[]: One to five columns that indicate when a document in the database has changed.
documentDataColumnName string: The column that contains the contents of the document.
documentIdColumnName string: The column that provides the document's identifier.
documentTitleColumnName string: The column that contains the title of the document.
fieldMappings DataSourceToIndexFieldMapping[]: An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex operation.

change_detecting_columns Sequence[str]: One to five columns that indicate when a document in the database has changed.
document_data_column_name str: The column that contains the contents of the document.
document_id_column_name str: The column that provides the document's identifier.
document_title_column_name str: The column that contains the title of the document.
field_mappings Sequence[DataSourceToIndexFieldMapping]: An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex operation.

changeDetectingColumns List<String>: One to five columns that indicate when a document in the database has changed.
documentDataColumnName String: The column that contains the contents of the document.
documentIdColumnName String: The column that provides the document's identifier.
documentTitleColumnName String: The column that contains the title of the document.
fieldMappings List<Property Map>: An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex operation.

DataSourceConditionOperator

DataSourceConfiguration

ConfluenceConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceConfluenceConfiguration: Provides the configuration information to connect to Confluence as your data source.
DatabaseConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceDatabaseConfiguration: Provides the configuration information to connect to a database as your data source.
GoogleDriveConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceGoogleDriveConfiguration: Provides the configuration information to connect to Google Drive as your data source.
OneDriveConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceOneDriveConfiguration: Provides the configuration information to connect to Microsoft OneDrive as your data source.
S3Configuration Pulumi.AwsNative.Kendra.Inputs.DataSourceS3DataSourceConfiguration: Provides the configuration information to connect to an Amazon S3 bucket as your data source.
Amazon Kendra now supports an upgraded Amazon S3 connector.
You must now use the TemplateConfiguration object instead of the S3DataSourceConfiguration object to configure your connector.
Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.
We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.
SalesforceConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceSalesforceConfiguration: Provides the configuration information to connect to Salesforce as your data source.
ServiceNowConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceServiceNowConfiguration: Provides the configuration information to connect to ServiceNow as your data source.
SharePointConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceSharePointConfiguration: Provides the configuration information to connect to Microsoft SharePoint as your data source.
WebCrawlerConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceWebCrawlerConfiguration: Provides the configuration information required for Amazon Kendra Web Crawler.
WorkDocsConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceWorkDocsConfiguration: Provides the configuration information to connect to Amazon WorkDocs as your data source.

ConfluenceConfiguration DataSourceConfluenceConfiguration: Provides the configuration information to connect to Confluence as your data source.
DatabaseConfiguration DataSourceDatabaseConfiguration: Provides the configuration information to connect to a database as your data source.
GoogleDriveConfiguration DataSourceGoogleDriveConfiguration: Provides the configuration information to connect to Google Drive as your data source.
OneDriveConfiguration DataSourceOneDriveConfiguration: Provides the configuration information to connect to Microsoft OneDrive as your data source.
S3Configuration DataSourceS3DataSourceConfiguration: Provides the configuration information to connect to an Amazon S3 bucket as your data source.
Amazon Kendra now supports an upgraded Amazon S3 connector.
You must now use the TemplateConfiguration object instead of the S3DataSourceConfiguration object to configure your connector.
Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.
We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.
SalesforceConfiguration DataSourceSalesforceConfiguration: Provides the configuration information to connect to Salesforce as your data source.
ServiceNowConfiguration DataSourceServiceNowConfiguration: Provides the configuration information to connect to ServiceNow as your data source.
SharePointConfiguration DataSourceSharePointConfiguration: Provides the configuration information to connect to Microsoft SharePoint as your data source.
WebCrawlerConfiguration DataSourceWebCrawlerConfiguration: Provides the configuration information required for Amazon Kendra Web Crawler.
WorkDocsConfiguration DataSourceWorkDocsConfiguration: Provides the configuration information to connect to Amazon WorkDocs as your data source.

confluenceConfiguration DataSourceConfluenceConfiguration: Provides the configuration information to connect to Confluence as your data source.
databaseConfiguration DataSourceDatabaseConfiguration: Provides the configuration information to connect to a database as your data source.
googleDriveConfiguration DataSourceGoogleDriveConfiguration: Provides the configuration information to connect to Google Drive as your data source.
oneDriveConfiguration DataSourceOneDriveConfiguration: Provides the configuration information to connect to Microsoft OneDrive as your data source.
s3Configuration DataSourceS3DataSourceConfiguration: Provides the configuration information to connect to an Amazon S3 bucket as your data source.
Amazon Kendra now supports an upgraded Amazon S3 connector.
You must now use the TemplateConfiguration object instead of the S3DataSourceConfiguration object to configure your connector.
Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.
We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.
salesforceConfiguration DataSourceSalesforceConfiguration: Provides the configuration information to connect to Salesforce as your data source.
serviceNowConfiguration DataSourceServiceNowConfiguration: Provides the configuration information to connect to ServiceNow as your data source.
sharePointConfiguration DataSourceSharePointConfiguration: Provides the configuration information to connect to Microsoft SharePoint as your data source.
webCrawlerConfiguration DataSourceWebCrawlerConfiguration: Provides the configuration information required for Amazon Kendra Web Crawler.
workDocsConfiguration DataSourceWorkDocsConfiguration: Provides the configuration information to connect to Amazon WorkDocs as your data source.

confluenceConfiguration DataSourceConfluenceConfiguration: Provides the configuration information to connect to Confluence as your data source.
databaseConfiguration DataSourceDatabaseConfiguration: Provides the configuration information to connect to a database as your data source.
googleDriveConfiguration DataSourceGoogleDriveConfiguration: Provides the configuration information to connect to Google Drive as your data source.
oneDriveConfiguration DataSourceOneDriveConfiguration: Provides the configuration information to connect to Microsoft OneDrive as your data source.
s3Configuration DataSourceS3DataSourceConfiguration: Provides the configuration information to connect to an Amazon S3 bucket as your data source.
Amazon Kendra now supports an upgraded Amazon S3 connector.
You must now use the TemplateConfiguration object instead of the S3DataSourceConfiguration object to configure your connector.
Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.
We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.
salesforceConfiguration DataSourceSalesforceConfiguration: Provides the configuration information to connect to Salesforce as your data source.
serviceNowConfiguration DataSourceServiceNowConfiguration: Provides the configuration information to connect to ServiceNow as your data source.
sharePointConfiguration DataSourceSharePointConfiguration: Provides the configuration information to connect to Microsoft SharePoint as your data source.
webCrawlerConfiguration DataSourceWebCrawlerConfiguration: Provides the configuration information required for Amazon Kendra Web Crawler.
workDocsConfiguration DataSourceWorkDocsConfiguration: Provides the configuration information to connect to Amazon WorkDocs as your data source.

confluence_configuration DataSourceConfluenceConfiguration: Provides the configuration information to connect to Confluence as your data source.
database_configuration DataSourceDatabaseConfiguration: Provides the configuration information to connect to a database as your data source.
google_drive_configuration DataSourceGoogleDriveConfiguration: Provides the configuration information to connect to Google Drive as your data source.
one_drive_configuration DataSourceOneDriveConfiguration: Provides the configuration information to connect to Microsoft OneDrive as your data source.
s3_configuration DataSourceS3DataSourceConfiguration: Provides the configuration information to connect to an Amazon S3 bucket as your data source.
Amazon Kendra now supports an upgraded Amazon S3 connector.
You must now use the TemplateConfiguration object instead of the S3DataSourceConfiguration object to configure your connector.
Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.
We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.
salesforce_configuration DataSourceSalesforceConfiguration: Provides the configuration information to connect to Salesforce as your data source.
service_now_configuration DataSourceServiceNowConfiguration: Provides the configuration information to connect to ServiceNow as your data source.
share_point_configuration DataSourceSharePointConfiguration: Provides the configuration information to connect to Microsoft SharePoint as your data source.
web_crawler_configuration DataSourceWebCrawlerConfiguration: Provides the configuration information required for Amazon Kendra Web Crawler.
work_docs_configuration DataSourceWorkDocsConfiguration: Provides the configuration information to connect to Amazon WorkDocs as your data source.

confluenceConfiguration Property Map: Provides the configuration information to connect to Confluence as your data source.
databaseConfiguration Property Map: Provides the configuration information to connect to a database as your data source.
googleDriveConfiguration Property Map: Provides the configuration information to connect to Google Drive as your data source.
oneDriveConfiguration Property Map: Provides the configuration information to connect to Microsoft OneDrive as your data source.
s3Configuration Property Map: Provides the configuration information to connect to an Amazon S3 bucket as your data source.
Amazon Kendra now supports an upgraded Amazon S3 connector.
You must now use the TemplateConfiguration object instead of the S3DataSourceConfiguration object to configure your connector.
Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.
We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.
salesforceConfiguration Property Map: Provides the configuration information to connect to Salesforce as your data source.
serviceNowConfiguration Property Map: Provides the configuration information to connect to ServiceNow as your data source.
sharePointConfiguration Property Map: Provides the configuration information to connect to Microsoft SharePoint as your data source.
webCrawlerConfiguration Property Map: Provides the configuration information required for Amazon Kendra Web Crawler.
workDocsConfiguration Property Map: Provides the configuration information to connect to Amazon WorkDocs as your data source.

DataSourceConfluenceAttachmentConfiguration

AttachmentFieldMappings List<Pulumi.AwsNative.Kendra.Inputs.DataSourceConfluenceAttachmentToIndexFieldMapping>

Maps attributes or field names of Confluence attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields . The Confluence data source field names must exist in your Confluence custom metadata.

If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.

CrawlAttachments bool

TRUE to index attachments of pages and blogs in Confluence.

AttachmentFieldMappings []DataSourceConfluenceAttachmentToIndexFieldMapping

If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.

CrawlAttachments bool

TRUE to index attachments of pages and blogs in Confluence.

attachmentFieldMappings List<DataSourceConfluenceAttachmentToIndexFieldMapping>

If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.

crawlAttachments Boolean

TRUE to index attachments of pages and blogs in Confluence.

attachmentFieldMappings DataSourceConfluenceAttachmentToIndexFieldMapping[]

If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.

crawlAttachments boolean

TRUE to index attachments of pages and blogs in Confluence.

attachment_field_mappings Sequence[DataSourceConfluenceAttachmentToIndexFieldMapping]

If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.

crawl_attachments bool

TRUE to index attachments of pages and blogs in Confluence.

attachmentFieldMappings List<Property Map>

If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.

crawlAttachments Boolean

TRUE to index attachments of pages and blogs in Confluence.

DataSourceConfluenceAttachmentFieldName

DataSourceConfluenceAttachmentToIndexFieldMapping

DataSourceFieldName Pulumi.AwsNative.Kendra.DataSourceConfluenceAttachmentFieldName
IndexFieldName string
DateFieldFormat string

DataSourceFieldName DataSourceConfluenceAttachmentFieldName
IndexFieldName string
DateFieldFormat string

dataSourceFieldName DataSourceConfluenceAttachmentFieldName
indexFieldName String
dateFieldFormat String

dataSourceFieldName DataSourceConfluenceAttachmentFieldName
indexFieldName string
dateFieldFormat string

data_source_field_name DataSourceConfluenceAttachmentFieldName
index_field_name str
date_field_format str

dataSourceFieldName "AUTHOR" | "CONTENT_TYPE" | "CREATED_DATE" | "DISPLAY_URL" | "FILE_SIZE" | "ITEM_TYPE" | "PARENT_ID" | "SPACE_KEY" | "SPACE_NAME" | "URL" | "VERSION"
indexFieldName String
dateFieldFormat String

DataSourceConfluenceBlogConfiguration

BlogFieldMappings List<Pulumi.AwsNative.Kendra.Inputs.DataSourceConfluenceBlogToIndexFieldMapping>

Maps attributes or field names of Confluence blogs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields . The Confluence data source field names must exist in your Confluence custom metadata.

If you specify the BlogFieldMappings parameter, you must specify at least one field mapping.

BlogFieldMappings []DataSourceConfluenceBlogToIndexFieldMapping

If you specify the BlogFieldMappings parameter, you must specify at least one field mapping.

blogFieldMappings List<DataSourceConfluenceBlogToIndexFieldMapping>

If you specify the BlogFieldMappings parameter, you must specify at least one field mapping.

blogFieldMappings DataSourceConfluenceBlogToIndexFieldMapping[]

If you specify the BlogFieldMappings parameter, you must specify at least one field mapping.

blog_field_mappings Sequence[DataSourceConfluenceBlogToIndexFieldMapping]

If you specify the BlogFieldMappings parameter, you must specify at least one field mapping.

blogFieldMappings List<Property Map>

If you specify the BlogFieldMappings parameter, you must specify at least one field mapping.

DataSourceConfluenceBlogFieldName

DataSourceConfluenceBlogToIndexFieldMapping

DataSourceFieldName Pulumi.AwsNative.Kendra.DataSourceConfluenceBlogFieldName
IndexFieldName string
DateFieldFormat string

DataSourceFieldName DataSourceConfluenceBlogFieldName
IndexFieldName string
DateFieldFormat string

dataSourceFieldName DataSourceConfluenceBlogFieldName
indexFieldName String
dateFieldFormat String

dataSourceFieldName DataSourceConfluenceBlogFieldName
indexFieldName string
dateFieldFormat string

data_source_field_name DataSourceConfluenceBlogFieldName
index_field_name str
date_field_format str

dataSourceFieldName "AUTHOR" | "DISPLAY_URL" | "ITEM_TYPE" | "LABELS" | "PUBLISH_DATE" | "SPACE_KEY" | "SPACE_NAME" | "URL" | "VERSION"
indexFieldName String
dateFieldFormat String

DataSourceConfluenceConfiguration

SecretArn string

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password required to connect to the Confluence instance. If you use Confluence Cloud, you use a generated API token as the password.

You can also provide authentication credentials in the form of a personal access token. For more information, see Using a Confluence data source .

ServerUrl string

The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/ . You can also use an IP address, for example, https://192.168.1.113/ .

Version Pulumi.AwsNative.Kendra.DataSourceConfluenceVersion

The version or the type of Confluence installation to connect to.

AttachmentConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceConfluenceAttachmentConfiguration

Configuration information for indexing attachments to Confluence blogs and pages.

BlogConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceConfluenceBlogConfiguration

Configuration information for indexing Confluence blogs.

ExclusionPatterns List<string>

A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

InclusionPatterns List<string>

A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are included in the index. Content that doesn't match the patterns is excluded from the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

PageConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceConfluencePageConfiguration

Configuration information for indexing Confluence pages.

SpaceConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceConfluenceSpaceConfiguration

Configuration information for indexing Confluence spaces.

VpcConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceVpcConfiguration

Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC .

SecretArn string

You can also provide authentication credentials in the form of a personal access token. For more information, see Using a Confluence data source .

ServerUrl string

The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/ . You can also use an IP address, for example, https://192.168.1.113/ .

Version DataSourceConfluenceVersion

The version or the type of Confluence installation to connect to.

AttachmentConfiguration DataSourceConfluenceAttachmentConfiguration

Configuration information for indexing attachments to Confluence blogs and pages.

BlogConfiguration DataSourceConfluenceBlogConfiguration

Configuration information for indexing Confluence blogs.

ExclusionPatterns []string

InclusionPatterns []string

PageConfiguration DataSourceConfluencePageConfiguration

Configuration information for indexing Confluence pages.

SpaceConfiguration DataSourceConfluenceSpaceConfiguration

Configuration information for indexing Confluence spaces.

VpcConfiguration DataSourceVpcConfiguration

Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC .

secretArn String

You can also provide authentication credentials in the form of a personal access token. For more information, see Using a Confluence data source .

serverUrl String

The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/ . You can also use an IP address, for example, https://192.168.1.113/ .

version DataSourceConfluenceVersion

The version or the type of Confluence installation to connect to.

attachmentConfiguration DataSourceConfluenceAttachmentConfiguration

Configuration information for indexing attachments to Confluence blogs and pages.

blogConfiguration DataSourceConfluenceBlogConfiguration

Configuration information for indexing Confluence blogs.

exclusionPatterns List<String>

inclusionPatterns List<String>

pageConfiguration DataSourceConfluencePageConfiguration

Configuration information for indexing Confluence pages.

spaceConfiguration DataSourceConfluenceSpaceConfiguration

Configuration information for indexing Confluence spaces.

vpcConfiguration DataSourceVpcConfiguration

Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC .

secretArn string

You can also provide authentication credentials in the form of a personal access token. For more information, see Using a Confluence data source .

serverUrl string

The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/ . You can also use an IP address, for example, https://192.168.1.113/ .

version DataSourceConfluenceVersion

The version or the type of Confluence installation to connect to.

attachmentConfiguration DataSourceConfluenceAttachmentConfiguration

Configuration information for indexing attachments to Confluence blogs and pages.

blogConfiguration DataSourceConfluenceBlogConfiguration

Configuration information for indexing Confluence blogs.

exclusionPatterns string[]

inclusionPatterns string[]

pageConfiguration DataSourceConfluencePageConfiguration

Configuration information for indexing Confluence pages.

spaceConfiguration DataSourceConfluenceSpaceConfiguration

Configuration information for indexing Confluence spaces.

vpcConfiguration DataSourceVpcConfiguration

Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC .

secret_arn str

You can also provide authentication credentials in the form of a personal access token. For more information, see Using a Confluence data source .

server_url str

The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/ . You can also use an IP address, for example, https://192.168.1.113/ .

version DataSourceConfluenceVersion

The version or the type of Confluence installation to connect to.

attachment_configuration DataSourceConfluenceAttachmentConfiguration

Configuration information for indexing attachments to Confluence blogs and pages.

blog_configuration DataSourceConfluenceBlogConfiguration

Configuration information for indexing Confluence blogs.

exclusion_patterns Sequence[str]

inclusion_patterns Sequence[str]

page_configuration DataSourceConfluencePageConfiguration

Configuration information for indexing Confluence pages.

space_configuration DataSourceConfluenceSpaceConfiguration

Configuration information for indexing Confluence spaces.

vpc_configuration DataSourceVpcConfiguration

Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC .

secretArn String

You can also provide authentication credentials in the form of a personal access token. For more information, see Using a Confluence data source .

serverUrl String

The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/ . You can also use an IP address, for example, https://192.168.1.113/ .

version "CLOUD" | "SERVER"

The version or the type of Confluence installation to connect to.

attachmentConfiguration Property Map

Configuration information for indexing attachments to Confluence blogs and pages.

blogConfiguration Property Map

Configuration information for indexing Confluence blogs.

exclusionPatterns List<String>

inclusionPatterns List<String>

pageConfiguration Property Map

Configuration information for indexing Confluence pages.

spaceConfiguration Property Map

Configuration information for indexing Confluence spaces.

vpcConfiguration Property Map

Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC .

DataSourceConfluencePageConfiguration

PageFieldMappings List<Pulumi.AwsNative.Kendra.Inputs.DataSourceConfluencePageToIndexFieldMapping>

Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields . The Confluence data source field names must exist in your Confluence custom metadata.

If you specify the PageFieldMappings parameter, you must specify at least one field mapping.

PageFieldMappings []DataSourceConfluencePageToIndexFieldMapping

If you specify the PageFieldMappings parameter, you must specify at least one field mapping.

pageFieldMappings List<DataSourceConfluencePageToIndexFieldMapping>

If you specify the PageFieldMappings parameter, you must specify at least one field mapping.

pageFieldMappings DataSourceConfluencePageToIndexFieldMapping[]

If you specify the PageFieldMappings parameter, you must specify at least one field mapping.

page_field_mappings Sequence[DataSourceConfluencePageToIndexFieldMapping]

If you specify the PageFieldMappings parameter, you must specify at least one field mapping.

pageFieldMappings List<Property Map>

If you specify the PageFieldMappings parameter, you must specify at least one field mapping.

DataSourceConfluencePageFieldName

DataSourceConfluencePageToIndexFieldMapping

DataSourceFieldName Pulumi.AwsNative.Kendra.DataSourceConfluencePageFieldName
IndexFieldName string
DateFieldFormat string

DataSourceFieldName DataSourceConfluencePageFieldName
IndexFieldName string
DateFieldFormat string

dataSourceFieldName DataSourceConfluencePageFieldName
indexFieldName String
dateFieldFormat String

dataSourceFieldName DataSourceConfluencePageFieldName
indexFieldName string
dateFieldFormat string

data_source_field_name DataSourceConfluencePageFieldName
index_field_name str
date_field_format str

dataSourceFieldName "AUTHOR" | "CONTENT_STATUS" | "CREATED_DATE" | "DISPLAY_URL" | "ITEM_TYPE" | "LABELS" | "MODIFIED_DATE" | "PARENT_ID" | "SPACE_KEY" | "SPACE_NAME" | "URL" | "VERSION"
indexFieldName String
dateFieldFormat String

DataSourceConfluenceSpaceConfiguration

CrawlArchivedSpaces bool

TRUE to index archived spaces.

CrawlPersonalSpaces bool

TRUE to index personal spaces. You can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context .

ExcludeSpaces List<string>

A list of space keys of Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the ExcludeSpaces and the IncludeSpaces list, the space is excluded.

IncludeSpaces List<string>

A list of space keys for Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded.

SpaceFieldMappings List<Pulumi.AwsNative.Kendra.Inputs.DataSourceConfluenceSpaceToIndexFieldMapping>

Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields . The Confluence data source field names must exist in your Confluence custom metadata.

If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

CrawlArchivedSpaces bool

TRUE to index archived spaces.

CrawlPersonalSpaces bool

ExcludeSpaces []string

IncludeSpaces []string

SpaceFieldMappings []DataSourceConfluenceSpaceToIndexFieldMapping

If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

crawlArchivedSpaces Boolean

TRUE to index archived spaces.

crawlPersonalSpaces Boolean

excludeSpaces List<String>

includeSpaces List<String>

spaceFieldMappings List<DataSourceConfluenceSpaceToIndexFieldMapping>

If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

crawlArchivedSpaces boolean

TRUE to index archived spaces.

crawlPersonalSpaces boolean

excludeSpaces string[]

includeSpaces string[]

spaceFieldMappings DataSourceConfluenceSpaceToIndexFieldMapping[]

If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

crawl_archived_spaces bool

TRUE to index archived spaces.

crawl_personal_spaces bool

exclude_spaces Sequence[str]

include_spaces Sequence[str]

space_field_mappings Sequence[DataSourceConfluenceSpaceToIndexFieldMapping]

If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

crawlArchivedSpaces Boolean

TRUE to index archived spaces.

crawlPersonalSpaces Boolean

excludeSpaces List<String>

includeSpaces List<String>

spaceFieldMappings List<Property Map>

If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.

DataSourceConfluenceSpaceFieldName

DataSourceConfluenceSpaceToIndexFieldMapping

DataSourceFieldName Pulumi.AwsNative.Kendra.DataSourceConfluenceSpaceFieldName
IndexFieldName string
DateFieldFormat string

DataSourceFieldName DataSourceConfluenceSpaceFieldName
IndexFieldName string
DateFieldFormat string

dataSourceFieldName DataSourceConfluenceSpaceFieldName
indexFieldName String
dateFieldFormat String

dataSourceFieldName DataSourceConfluenceSpaceFieldName
indexFieldName string
dateFieldFormat string

data_source_field_name DataSourceConfluenceSpaceFieldName
index_field_name str
date_field_format str

dataSourceFieldName "DISPLAY_URL" | "ITEM_TYPE" | "SPACE_KEY" | "URL"
indexFieldName String
dateFieldFormat String

DataSourceConfluenceVersion

DataSourceConnectionConfiguration

DatabaseHost string: The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.
DatabaseName string: The name of the database containing the document data.
DatabasePort int: The port that the database uses for connections.
SecretArn string: The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that stores the credentials. The credentials should be a user-password pair. For more information, see Using a Database Data Source . For more information about AWS Secrets Manager , see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
TableName string: The name of the table that contains the document data.

DatabaseHost string: The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.
DatabaseName string: The name of the database containing the document data.
DatabasePort int: The port that the database uses for connections.
SecretArn string: The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that stores the credentials. The credentials should be a user-password pair. For more information, see Using a Database Data Source . For more information about AWS Secrets Manager , see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
TableName string: The name of the table that contains the document data.

databaseHost String: The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.
databaseName String: The name of the database containing the document data.
databasePort Integer: The port that the database uses for connections.
secretArn String: The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that stores the credentials. The credentials should be a user-password pair. For more information, see Using a Database Data Source . For more information about AWS Secrets Manager , see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
tableName String: The name of the table that contains the document data.

databaseHost string: The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.
databaseName string: The name of the database containing the document data.
databasePort number: The port that the database uses for connections.
secretArn string: The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that stores the credentials. The credentials should be a user-password pair. For more information, see Using a Database Data Source . For more information about AWS Secrets Manager , see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
tableName string: The name of the table that contains the document data.

database_host str: The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.
database_name str: The name of the database containing the document data.
database_port int: The port that the database uses for connections.
secret_arn str: The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that stores the credentials. The credentials should be a user-password pair. For more information, see Using a Database Data Source . For more information about AWS Secrets Manager , see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
table_name str: The name of the table that contains the document data.

databaseHost String: The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.
databaseName String: The name of the database containing the document data.
databasePort Number: The port that the database uses for connections.
secretArn String: The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that stores the credentials. The credentials should be a user-password pair. For more information, see Using a Database Data Source . For more information about AWS Secrets Manager , see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
tableName String: The name of the table that contains the document data.

DataSourceCustomDocumentEnrichmentConfiguration

InlineConfigurations List<Pulumi.AwsNative.Kendra.Inputs.DataSourceInlineCustomDocumentEnrichmentConfiguration>: Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
PostExtractionHookConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceHookConfiguration: Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation .
PreExtractionHookConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceHookConfiguration: Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation .
RoleArn string: The Amazon Resource Name (ARN) of an IAM role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process. For more information, see an IAM roles for Amazon Kendra .

InlineConfigurations []DataSourceInlineCustomDocumentEnrichmentConfiguration: Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
PostExtractionHookConfiguration DataSourceHookConfiguration: Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation .
PreExtractionHookConfiguration DataSourceHookConfiguration: Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation .
RoleArn string: The Amazon Resource Name (ARN) of an IAM role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process. For more information, see an IAM roles for Amazon Kendra .

inlineConfigurations List<DataSourceInlineCustomDocumentEnrichmentConfiguration>: Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
postExtractionHookConfiguration DataSourceHookConfiguration: Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation .
preExtractionHookConfiguration DataSourceHookConfiguration: Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation .
roleArn String: The Amazon Resource Name (ARN) of an IAM role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process. For more information, see an IAM roles for Amazon Kendra .

inlineConfigurations DataSourceInlineCustomDocumentEnrichmentConfiguration[]: Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
postExtractionHookConfiguration DataSourceHookConfiguration: Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation .
preExtractionHookConfiguration DataSourceHookConfiguration: Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation .
roleArn string: The Amazon Resource Name (ARN) of an IAM role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process. For more information, see an IAM roles for Amazon Kendra .

inline_configurations Sequence[DataSourceInlineCustomDocumentEnrichmentConfiguration]: Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
post_extraction_hook_configuration DataSourceHookConfiguration: Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation .
pre_extraction_hook_configuration DataSourceHookConfiguration: Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation .
role_arn str: The Amazon Resource Name (ARN) of an IAM role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process. For more information, see an IAM roles for Amazon Kendra .

inlineConfigurations List<Property Map>: Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
postExtractionHookConfiguration Property Map: Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation .
preExtractionHookConfiguration Property Map: Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation .
roleArn String: The Amazon Resource Name (ARN) of an IAM role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process. For more information, see an IAM roles for Amazon Kendra .

DataSourceDatabaseConfiguration

ColumnConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceColumnConfiguration: Information about where the index should get the document information from the database.
ConnectionConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceConnectionConfiguration: Configuration information that's required to connect to a database.
DatabaseEngineType Pulumi.AwsNative.Kendra.DataSourceDatabaseEngineType: The type of database engine that runs the database.
AclConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceAclConfiguration: Information about the database column that provides information for user context filtering.
SqlConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceSqlConfiguration: Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
VpcConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceVpcConfiguration: Provides information for connecting to an Amazon VPC.

ColumnConfiguration DataSourceColumnConfiguration: Information about where the index should get the document information from the database.
ConnectionConfiguration DataSourceConnectionConfiguration: Configuration information that's required to connect to a database.
DatabaseEngineType DataSourceDatabaseEngineType: The type of database engine that runs the database.
AclConfiguration DataSourceAclConfiguration: Information about the database column that provides information for user context filtering.
SqlConfiguration DataSourceSqlConfiguration: Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
VpcConfiguration DataSourceVpcConfiguration: Provides information for connecting to an Amazon VPC.

columnConfiguration DataSourceColumnConfiguration: Information about where the index should get the document information from the database.
connectionConfiguration DataSourceConnectionConfiguration: Configuration information that's required to connect to a database.
databaseEngineType DataSourceDatabaseEngineType: The type of database engine that runs the database.
aclConfiguration DataSourceAclConfiguration: Information about the database column that provides information for user context filtering.
sqlConfiguration DataSourceSqlConfiguration: Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
vpcConfiguration DataSourceVpcConfiguration: Provides information for connecting to an Amazon VPC.

columnConfiguration DataSourceColumnConfiguration: Information about where the index should get the document information from the database.
connectionConfiguration DataSourceConnectionConfiguration: Configuration information that's required to connect to a database.
databaseEngineType DataSourceDatabaseEngineType: The type of database engine that runs the database.
aclConfiguration DataSourceAclConfiguration: Information about the database column that provides information for user context filtering.
sqlConfiguration DataSourceSqlConfiguration: Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
vpcConfiguration DataSourceVpcConfiguration: Provides information for connecting to an Amazon VPC.

column_configuration DataSourceColumnConfiguration: Information about where the index should get the document information from the database.
connection_configuration DataSourceConnectionConfiguration: Configuration information that's required to connect to a database.
database_engine_type DataSourceDatabaseEngineType: The type of database engine that runs the database.
acl_configuration DataSourceAclConfiguration: Information about the database column that provides information for user context filtering.
sql_configuration DataSourceSqlConfiguration: Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
vpc_configuration DataSourceVpcConfiguration: Provides information for connecting to an Amazon VPC.

columnConfiguration Property Map: Information about where the index should get the document information from the database.
connectionConfiguration Property Map: Configuration information that's required to connect to a database.
databaseEngineType "RDS_AURORA_MYSQL" | "RDS_AURORA_POSTGRESQL" | "RDS_MYSQL" | "RDS_POSTGRESQL": The type of database engine that runs the database.
aclConfiguration Property Map: Information about the database column that provides information for user context filtering.
sqlConfiguration Property Map: Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
vpcConfiguration Property Map: Provides information for connecting to an Amazon VPC.

DataSourceDatabaseEngineType

DataSourceDocumentAttributeCondition

ConditionDocumentAttributeKey string

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

Operator Pulumi.AwsNative.Kendra.DataSourceConditionOperator

The condition operator.

For example, you can use 'Contains' to partially match a string.

ConditionOnValue Pulumi.AwsNative.Kendra.Inputs.DataSourceDocumentAttributeValue

The value used by the operator.

For example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value.

ConditionDocumentAttributeKey string

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

Operator DataSourceConditionOperator

The condition operator.

For example, you can use 'Contains' to partially match a string.

ConditionOnValue DataSourceDocumentAttributeValue

The value used by the operator.

For example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value.

conditionDocumentAttributeKey String

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

operator DataSourceConditionOperator

The condition operator.

For example, you can use 'Contains' to partially match a string.

conditionOnValue DataSourceDocumentAttributeValue

The value used by the operator.

For example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value.

conditionDocumentAttributeKey string

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

operator DataSourceConditionOperator

The condition operator.

For example, you can use 'Contains' to partially match a string.

conditionOnValue DataSourceDocumentAttributeValue

The value used by the operator.

For example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value.

condition_document_attribute_key str

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

operator DataSourceConditionOperator

The condition operator.

For example, you can use 'Contains' to partially match a string.

condition_on_value DataSourceDocumentAttributeValue

The value used by the operator.

For example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value.

conditionDocumentAttributeKey String

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

The condition operator.

For example, you can use 'Contains' to partially match a string.

conditionOnValue Property Map

The value used by the operator.

For example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value.

DataSourceDocumentAttributeTarget

TargetDocumentAttributeKey string
TargetDocumentAttributeValue Pulumi.AwsNative.Kendra.Inputs.DataSourceDocumentAttributeValue
TargetDocumentAttributeValueDeletion bool

TargetDocumentAttributeKey string
TargetDocumentAttributeValue DataSourceDocumentAttributeValue
TargetDocumentAttributeValueDeletion bool

targetDocumentAttributeKey String
targetDocumentAttributeValue DataSourceDocumentAttributeValue
targetDocumentAttributeValueDeletion Boolean

targetDocumentAttributeKey string
targetDocumentAttributeValue DataSourceDocumentAttributeValue
targetDocumentAttributeValueDeletion boolean

target_document_attribute_key str
target_document_attribute_value DataSourceDocumentAttributeValue
target_document_attribute_value_deletion bool

targetDocumentAttributeKey String
targetDocumentAttributeValue Property Map
targetDocumentAttributeValueDeletion Boolean

DataSourceDocumentAttributeValue

DateValue string

A date expressed as an ISO 8601 string.

It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

LongValue int

A long integer value.

StringListValue List<string>

A list of strings. The default maximum length or number of strings is 10.

StringValue string

A string, such as "department".

DateValue string

A date expressed as an ISO 8601 string.

LongValue int

A long integer value.

StringListValue []string

A list of strings. The default maximum length or number of strings is 10.

StringValue string

A string, such as "department".

dateValue String

A date expressed as an ISO 8601 string.

longValue Integer

A long integer value.

stringListValue List<String>

A list of strings. The default maximum length or number of strings is 10.

stringValue String

A string, such as "department".

dateValue string

A date expressed as an ISO 8601 string.

longValue number

A long integer value.

stringListValue string[]

A list of strings. The default maximum length or number of strings is 10.

stringValue string

A string, such as "department".

date_value str

A date expressed as an ISO 8601 string.

long_value int

A long integer value.

string_list_value Sequence[str]

A list of strings. The default maximum length or number of strings is 10.

string_value str

A string, such as "department".

dateValue String

A date expressed as an ISO 8601 string.

longValue Number

A long integer value.

stringListValue List<String>

A list of strings. The default maximum length or number of strings is 10.

stringValue String

A string, such as "department".

DataSourceDocumentsMetadataConfiguration

S3Prefix string: A prefix used to filter metadata configuration files in the AWS S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix to include only the desired metadata files.

S3Prefix string: A prefix used to filter metadata configuration files in the AWS S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix to include only the desired metadata files.

s3Prefix String: A prefix used to filter metadata configuration files in the AWS S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix to include only the desired metadata files.

s3Prefix string: A prefix used to filter metadata configuration files in the AWS S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix to include only the desired metadata files.

s3_prefix str: A prefix used to filter metadata configuration files in the AWS S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix to include only the desired metadata files.

s3Prefix String: A prefix used to filter metadata configuration files in the AWS S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix to include only the desired metadata files.

DataSourceGoogleDriveConfiguration

SecretArn string

The Amazon Resource Name (ARN) of a AWS Secrets Manager secret that contains the credentials required to connect to Google Drive. For more information, see Using a Google Workspace Drive data source .

ExcludeMimeTypes List<string>

A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.

For a list of MIME types, see Using a Google Workspace Drive data source .

ExcludeSharedDrives List<string>

A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.

ExcludeUserAccounts List<string>

A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.

ExclusionPatterns List<string>

A list of regular expression patterns to exclude certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

FieldMappings List<Pulumi.AwsNative.Kendra.Inputs.DataSourceToIndexFieldMapping>

Maps Google Drive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Google Drive fields. For more information, see Mapping data source fields . The Google Drive data source field names must exist in your Google Drive custom metadata.

InclusionPatterns List<string>

A list of regular expression patterns to include certain items in your Google Drive, including shared drives and users' My Drives. Items that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

SecretArn string

ExcludeMimeTypes []string

A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.

For a list of MIME types, see Using a Google Workspace Drive data source .

ExcludeSharedDrives []string

A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.

ExcludeUserAccounts []string

A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.

ExclusionPatterns []string

FieldMappings []DataSourceToIndexFieldMapping

InclusionPatterns []string

secretArn String

excludeMimeTypes List<String>

A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.

For a list of MIME types, see Using a Google Workspace Drive data source .

excludeSharedDrives List<String>

A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.

excludeUserAccounts List<String>

A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.

exclusionPatterns List<String>

fieldMappings List<DataSourceToIndexFieldMapping>

inclusionPatterns List<String>

secretArn string

excludeMimeTypes string[]

A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.

For a list of MIME types, see Using a Google Workspace Drive data source .

excludeSharedDrives string[]

A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.

excludeUserAccounts string[]

A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.

exclusionPatterns string[]

fieldMappings DataSourceToIndexFieldMapping[]

inclusionPatterns string[]

secret_arn str

exclude_mime_types Sequence[str]

A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.

For a list of MIME types, see Using a Google Workspace Drive data source .

exclude_shared_drives Sequence[str]

A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.

exclude_user_accounts Sequence[str]

A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.

exclusion_patterns Sequence[str]

field_mappings Sequence[DataSourceToIndexFieldMapping]

inclusion_patterns Sequence[str]

secretArn String

excludeMimeTypes List<String>

A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.

For a list of MIME types, see Using a Google Workspace Drive data source .

excludeSharedDrives List<String>

A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.

excludeUserAccounts List<String>

A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.

exclusionPatterns List<String>

fieldMappings List<Property Map>

inclusionPatterns List<String>

DataSourceHookConfiguration

LambdaArn string

The Amazon Resource Name (ARN) of an IAM role with permission to run a Lambda function during ingestion. For more information, see an IAM roles for Amazon Kendra .

S3Bucket string

Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions .

InvocationCondition Pulumi.AwsNative.Kendra.Inputs.DataSourceDocumentAttributeCondition

The condition used for when a Lambda function should be invoked.

For example, you can specify a condition that if there are empty date-time values, then Amazon Kendra should invoke a function that inserts the current date-time.

LambdaArn string

The Amazon Resource Name (ARN) of an IAM role with permission to run a Lambda function during ingestion. For more information, see an IAM roles for Amazon Kendra .

S3Bucket string

Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions .

InvocationCondition DataSourceDocumentAttributeCondition

The condition used for when a Lambda function should be invoked.

For example, you can specify a condition that if there are empty date-time values, then Amazon Kendra should invoke a function that inserts the current date-time.

lambdaArn String

The Amazon Resource Name (ARN) of an IAM role with permission to run a Lambda function during ingestion. For more information, see an IAM roles for Amazon Kendra .

s3Bucket String

Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions .

invocationCondition DataSourceDocumentAttributeCondition

The condition used for when a Lambda function should be invoked.

For example, you can specify a condition that if there are empty date-time values, then Amazon Kendra should invoke a function that inserts the current date-time.

lambdaArn string

The Amazon Resource Name (ARN) of an IAM role with permission to run a Lambda function during ingestion. For more information, see an IAM roles for Amazon Kendra .

s3Bucket string

Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions .

invocationCondition DataSourceDocumentAttributeCondition

The condition used for when a Lambda function should be invoked.

For example, you can specify a condition that if there are empty date-time values, then Amazon Kendra should invoke a function that inserts the current date-time.

lambda_arn str

The Amazon Resource Name (ARN) of an IAM role with permission to run a Lambda function during ingestion. For more information, see an IAM roles for Amazon Kendra .

s3_bucket str

Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions .

invocation_condition DataSourceDocumentAttributeCondition

The condition used for when a Lambda function should be invoked.

For example, you can specify a condition that if there are empty date-time values, then Amazon Kendra should invoke a function that inserts the current date-time.

lambdaArn String

The Amazon Resource Name (ARN) of an IAM role with permission to run a Lambda function during ingestion. For more information, see an IAM roles for Amazon Kendra .

s3Bucket String

Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions .

invocationCondition Property Map

The condition used for when a Lambda function should be invoked.

For example, you can specify a condition that if there are empty date-time values, then Amazon Kendra should invoke a function that inserts the current date-time.

DataSourceInlineCustomDocumentEnrichmentConfiguration

Condition Pulumi.AwsNative.Kendra.Inputs.DataSourceDocumentAttributeCondition
DocumentContentDeletion bool
Target Pulumi.AwsNative.Kendra.Inputs.DataSourceDocumentAttributeTarget

Condition DataSourceDocumentAttributeCondition
DocumentContentDeletion bool
Target DataSourceDocumentAttributeTarget

condition DataSourceDocumentAttributeCondition
documentContentDeletion Boolean
target DataSourceDocumentAttributeTarget

condition DataSourceDocumentAttributeCondition
documentContentDeletion boolean
target DataSourceDocumentAttributeTarget

condition DataSourceDocumentAttributeCondition
document_content_deletion bool
target DataSourceDocumentAttributeTarget

condition Property Map
documentContentDeletion Boolean
target Property Map

DataSourceOneDriveConfiguration

OneDriveUsers Pulumi.AwsNative.Kendra.Inputs.DataSourceOneDriveUsers

A list of user accounts whose documents should be indexed.

SecretArn string

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive. The user name should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.

TenantDomain string

The Azure Active Directory domain of the organization.

DisableLocalGroups bool

TRUE to disable local groups information.

ExclusionPatterns List<string>

A list of regular expression patterns to exclude certain documents in your OneDrive. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The pattern is applied to the file name.

FieldMappings List<Pulumi.AwsNative.Kendra.Inputs.DataSourceToIndexFieldMapping>

A list of DataSourceToIndexFieldMapping objects that map OneDrive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to OneDrive fields. For more information, see Mapping data source fields . The OneDrive data source field names must exist in your OneDrive custom metadata.

InclusionPatterns List<string>

A list of regular expression patterns to include certain documents in your OneDrive. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The pattern is applied to the file name.

OneDriveUsers DataSourceOneDriveUsers

A list of user accounts whose documents should be indexed.

SecretArn string

TenantDomain string

The Azure Active Directory domain of the organization.

DisableLocalGroups bool

TRUE to disable local groups information.

ExclusionPatterns []string

The pattern is applied to the file name.

FieldMappings []DataSourceToIndexFieldMapping

InclusionPatterns []string

The pattern is applied to the file name.

oneDriveUsers DataSourceOneDriveUsers

A list of user accounts whose documents should be indexed.

secretArn String

tenantDomain String

The Azure Active Directory domain of the organization.

disableLocalGroups Boolean

TRUE to disable local groups information.

exclusionPatterns List<String>

The pattern is applied to the file name.

fieldMappings List<DataSourceToIndexFieldMapping>

inclusionPatterns List<String>

The pattern is applied to the file name.

oneDriveUsers DataSourceOneDriveUsers

A list of user accounts whose documents should be indexed.

secretArn string

tenantDomain string

The Azure Active Directory domain of the organization.

disableLocalGroups boolean

TRUE to disable local groups information.

exclusionPatterns string[]

The pattern is applied to the file name.

fieldMappings DataSourceToIndexFieldMapping[]

inclusionPatterns string[]

The pattern is applied to the file name.

one_drive_users DataSourceOneDriveUsers

A list of user accounts whose documents should be indexed.

secret_arn str

tenant_domain str

The Azure Active Directory domain of the organization.

disable_local_groups bool

TRUE to disable local groups information.

exclusion_patterns Sequence[str]

The pattern is applied to the file name.

field_mappings Sequence[DataSourceToIndexFieldMapping]

inclusion_patterns Sequence[str]

The pattern is applied to the file name.

oneDriveUsers Property Map

A list of user accounts whose documents should be indexed.

secretArn String

tenantDomain String

The Azure Active Directory domain of the organization.

disableLocalGroups Boolean

TRUE to disable local groups information.

exclusionPatterns List<String>

The pattern is applied to the file name.

fieldMappings List<Property Map>

inclusionPatterns List<String>

The pattern is applied to the file name.

DataSourceOneDriveUsers

OneDriveUserList List<string>: A list of users whose documents should be indexed. Specify the user names in email format, for example, username@tenantdomain . If you need to index the documents of more than 10 users, use the OneDriveUserS3Path field to specify the location of a file containing a list of users.
OneDriveUserS3Path Pulumi.AwsNative.Kendra.Inputs.DataSourceS3Path: The S3 bucket location of a file containing a list of users whose documents should be indexed.

OneDriveUserList []string: A list of users whose documents should be indexed. Specify the user names in email format, for example, username@tenantdomain . If you need to index the documents of more than 10 users, use the OneDriveUserS3Path field to specify the location of a file containing a list of users.
OneDriveUserS3Path DataSourceS3Path: The S3 bucket location of a file containing a list of users whose documents should be indexed.

oneDriveUserList List<String>: A list of users whose documents should be indexed. Specify the user names in email format, for example, username@tenantdomain . If you need to index the documents of more than 10 users, use the OneDriveUserS3Path field to specify the location of a file containing a list of users.
oneDriveUserS3Path DataSourceS3Path: The S3 bucket location of a file containing a list of users whose documents should be indexed.

oneDriveUserList string[]: A list of users whose documents should be indexed. Specify the user names in email format, for example, username@tenantdomain . If you need to index the documents of more than 10 users, use the OneDriveUserS3Path field to specify the location of a file containing a list of users.
oneDriveUserS3Path DataSourceS3Path: The S3 bucket location of a file containing a list of users whose documents should be indexed.

one_drive_user_list Sequence[str]: A list of users whose documents should be indexed. Specify the user names in email format, for example, username@tenantdomain . If you need to index the documents of more than 10 users, use the OneDriveUserS3Path field to specify the location of a file containing a list of users.
one_drive_user_s3_path DataSourceS3Path: The S3 bucket location of a file containing a list of users whose documents should be indexed.

oneDriveUserList List<String>: A list of users whose documents should be indexed. Specify the user names in email format, for example, username@tenantdomain . If you need to index the documents of more than 10 users, use the OneDriveUserS3Path field to specify the location of a file containing a list of users.
oneDriveUserS3Path Property Map: The S3 bucket location of a file containing a list of users whose documents should be indexed.

DataSourceProxyConfiguration

Host string

The name of the website host you want to connect to via a web proxy server.

For example, the host name of https://a.example.com/page1.html is "a.example.com".

Port int

The port number of the website host you want to connect to via a web proxy server.

For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

Credentials string

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret. You create a secret to store your credentials in AWS Secrets Manager

The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.

Host string

The name of the website host you want to connect to via a web proxy server.

For example, the host name of https://a.example.com/page1.html is "a.example.com".

Port int

The port number of the website host you want to connect to via a web proxy server.

For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

Credentials string

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret. You create a secret to store your credentials in AWS Secrets Manager

host String

The name of the website host you want to connect to via a web proxy server.

For example, the host name of https://a.example.com/page1.html is "a.example.com".

port Integer

The port number of the website host you want to connect to via a web proxy server.

For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

credentials String

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret. You create a secret to store your credentials in AWS Secrets Manager

host string

The name of the website host you want to connect to via a web proxy server.

For example, the host name of https://a.example.com/page1.html is "a.example.com".

port number

The port number of the website host you want to connect to via a web proxy server.

For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

credentials string

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret. You create a secret to store your credentials in AWS Secrets Manager

host str

The name of the website host you want to connect to via a web proxy server.

For example, the host name of https://a.example.com/page1.html is "a.example.com".

port int

The port number of the website host you want to connect to via a web proxy server.

For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

credentials str

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret. You create a secret to store your credentials in AWS Secrets Manager

host String

The name of the website host you want to connect to via a web proxy server.

For example, the host name of https://a.example.com/page1.html is "a.example.com".

port Number

The port number of the website host you want to connect to via a web proxy server.

For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.

credentials String

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret. You create a secret to store your credentials in AWS Secrets Manager

DataSourceQueryIdentifiersEnclosingOption

DataSourceS3DataSourceConfiguration

BucketName string

The name of the bucket that contains the documents.

AccessControlListConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceAccessControlListConfiguration

Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources .

DocumentsMetadataConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceDocumentsMetadataConfiguration

Specifies document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.

ExclusionPatterns List<string>

A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to exclude from your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:

/myapp/config/* —All files inside config directory.
*/.png —All .png files in all directories.
*/.{png, ico, md} —All .png, .ico or .md files in all directories.
/myapp/src/**/.ts* —All .ts files inside src directory (and all its subdirectories).
*/!(.module).ts —All .ts files but not .module.ts
**.png , .jpg —All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
internal —All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.
**/internal —All internal-related files in a directory and its subdirectories.

For more examples, see Use of Exclude and Include Filters in the AWS CLI Command Reference.

InclusionPatterns List<string>

A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to include in your index. If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:

/myapp/config/* —All files inside config directory.
*/.png —All .png files in all directories.
*/.{png, ico, md} —All .png, .ico or .md files in all directories.
/myapp/src/**/.ts* —All .ts files inside src directory (and all its subdirectories).
*/!(.module).ts —All .ts files but not .module.ts
**.png , .jpg —All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
internal —All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.
**/internal —All internal-related files in a directory and its subdirectories.

For more examples, see Use of Exclude and Include Filters in the AWS CLI Command Reference.

InclusionPrefixes List<string>

A list of S3 prefixes for the documents that should be included in the index.

BucketName string

The name of the bucket that contains the documents.

AccessControlListConfiguration DataSourceAccessControlListConfiguration

Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources .

DocumentsMetadataConfiguration DataSourceDocumentsMetadataConfiguration

ExclusionPatterns []string

/myapp/config/* —All files inside config directory.
*/.png —All .png files in all directories.
*/.{png, ico, md} —All .png, .ico or .md files in all directories.
/myapp/src/**/.ts* —All .ts files inside src directory (and all its subdirectories).
*/!(.module).ts —All .ts files but not .module.ts
**.png , .jpg —All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
internal —All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.
**/internal —All internal-related files in a directory and its subdirectories.

For more examples, see Use of Exclude and Include Filters in the AWS CLI Command Reference.

InclusionPatterns []string

/myapp/config/* —All files inside config directory.
*/.png —All .png files in all directories.
*/.{png, ico, md} —All .png, .ico or .md files in all directories.
/myapp/src/**/.ts* —All .ts files inside src directory (and all its subdirectories).
*/!(.module).ts —All .ts files but not .module.ts
**.png , .jpg —All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
internal —All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.
**/internal —All internal-related files in a directory and its subdirectories.

For more examples, see Use of Exclude and Include Filters in the AWS CLI Command Reference.

InclusionPrefixes []string

A list of S3 prefixes for the documents that should be included in the index.

bucketName String

The name of the bucket that contains the documents.

accessControlListConfiguration DataSourceAccessControlListConfiguration

Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources .

documentsMetadataConfiguration DataSourceDocumentsMetadataConfiguration

exclusionPatterns List<String>

/myapp/config/* —All files inside config directory.
*/.png —All .png files in all directories.
*/.{png, ico, md} —All .png, .ico or .md files in all directories.
/myapp/src/**/.ts* —All .ts files inside src directory (and all its subdirectories).
*/!(.module).ts —All .ts files but not .module.ts
**.png , .jpg —All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
internal —All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.
**/internal —All internal-related files in a directory and its subdirectories.

For more examples, see Use of Exclude and Include Filters in the AWS CLI Command Reference.

inclusionPatterns List<String>

/myapp/config/* —All files inside config directory.
*/.png —All .png files in all directories.
*/.{png, ico, md} —All .png, .ico or .md files in all directories.
/myapp/src/**/.ts* —All .ts files inside src directory (and all its subdirectories).
*/!(.module).ts —All .ts files but not .module.ts
**.png , .jpg —All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
internal —All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.
**/internal —All internal-related files in a directory and its subdirectories.

For more examples, see Use of Exclude and Include Filters in the AWS CLI Command Reference.

inclusionPrefixes List<String>

A list of S3 prefixes for the documents that should be included in the index.

bucketName string

The name of the bucket that contains the documents.

accessControlListConfiguration DataSourceAccessControlListConfiguration

Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources .

documentsMetadataConfiguration DataSourceDocumentsMetadataConfiguration

exclusionPatterns string[]

/myapp/config/* —All files inside config directory.
*/.png —All .png files in all directories.
*/.{png, ico, md} —All .png, .ico or .md files in all directories.
/myapp/src/**/.ts* —All .ts files inside src directory (and all its subdirectories).
*/!(.module).ts —All .ts files but not .module.ts
**.png , .jpg —All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
internal —All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.
**/internal —All internal-related files in a directory and its subdirectories.

For more examples, see Use of Exclude and Include Filters in the AWS CLI Command Reference.

inclusionPatterns string[]

/myapp/config/* —All files inside config directory.
*/.png —All .png files in all directories.
*/.{png, ico, md} —All .png, .ico or .md files in all directories.
/myapp/src/**/.ts* —All .ts files inside src directory (and all its subdirectories).
*/!(.module).ts —All .ts files but not .module.ts
**.png , .jpg —All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
internal —All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.
**/internal —All internal-related files in a directory and its subdirectories.

For more examples, see Use of Exclude and Include Filters in the AWS CLI Command Reference.

inclusionPrefixes string[]

A list of S3 prefixes for the documents that should be included in the index.

bucket_name str

The name of the bucket that contains the documents.

access_control_list_configuration DataSourceAccessControlListConfiguration

Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources .

documents_metadata_configuration DataSourceDocumentsMetadataConfiguration

exclusion_patterns Sequence[str]

/myapp/config/* —All files inside config directory.
*/.png —All .png files in all directories.
*/.{png, ico, md} —All .png, .ico or .md files in all directories.
/myapp/src/**/.ts* —All .ts files inside src directory (and all its subdirectories).
*/!(.module).ts —All .ts files but not .module.ts
**.png , .jpg —All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
internal —All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.
**/internal —All internal-related files in a directory and its subdirectories.

For more examples, see Use of Exclude and Include Filters in the AWS CLI Command Reference.

inclusion_patterns Sequence[str]

/myapp/config/* —All files inside config directory.
*/.png —All .png files in all directories.
*/.{png, ico, md} —All .png, .ico or .md files in all directories.
/myapp/src/**/.ts* —All .ts files inside src directory (and all its subdirectories).
*/!(.module).ts —All .ts files but not .module.ts
**.png , .jpg —All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
internal —All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.
**/internal —All internal-related files in a directory and its subdirectories.

For more examples, see Use of Exclude and Include Filters in the AWS CLI Command Reference.

inclusion_prefixes Sequence[str]

A list of S3 prefixes for the documents that should be included in the index.

bucketName String

The name of the bucket that contains the documents.

accessControlListConfiguration Property Map

Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources .

documentsMetadataConfiguration Property Map

exclusionPatterns List<String>

/myapp/config/* —All files inside config directory.
*/.png —All .png files in all directories.
*/.{png, ico, md} —All .png, .ico or .md files in all directories.
/myapp/src/**/.ts* —All .ts files inside src directory (and all its subdirectories).
*/!(.module).ts —All .ts files but not .module.ts
**.png , .jpg —All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
internal —All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.
**/internal —All internal-related files in a directory and its subdirectories.

For more examples, see Use of Exclude and Include Filters in the AWS CLI Command Reference.

inclusionPatterns List<String>

/myapp/config/* —All files inside config directory.
*/.png —All .png files in all directories.
*/.{png, ico, md} —All .png, .ico or .md files in all directories.
/myapp/src/**/.ts* —All .ts files inside src directory (and all its subdirectories).
*/!(.module).ts —All .ts files but not .module.ts
**.png , .jpg —All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
internal —All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.
**/internal —All internal-related files in a directory and its subdirectories.

For more examples, see Use of Exclude and Include Filters in the AWS CLI Command Reference.

inclusionPrefixes List<String>

A list of S3 prefixes for the documents that should be included in the index.

DataSourceS3Path

Bucket string: The name of the S3 bucket that contains the file.
Key string: The name of the file.

Bucket string: The name of the S3 bucket that contains the file.
Key string: The name of the file.

bucket String: The name of the S3 bucket that contains the file.
key String: The name of the file.

bucket string: The name of the S3 bucket that contains the file.
key string: The name of the file.

bucket str: The name of the S3 bucket that contains the file.
key str: The name of the file.

bucket String: The name of the S3 bucket that contains the file.
key String: The name of the file.

DataSourceSalesforceChatterFeedConfiguration

DocumentDataFieldName string: The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the Body column.
DocumentTitleFieldName string: The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the Title column.
FieldMappings List<Pulumi.AwsNative.Kendra.Inputs.DataSourceToIndexFieldMapping>: Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
IncludeFilterTypes List<Pulumi.AwsNative.Kendra.DataSourceSalesforceChatterFeedIncludeFilterType>: Filters the documents in the feed based on status of the user. When you specify ACTIVE_USERS only documents from users who have an active account are indexed. When you specify STANDARD_USER only documents for Salesforce standard users are documented. You can specify both.

DocumentDataFieldName string: The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the Body column.
DocumentTitleFieldName string: The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the Title column.
FieldMappings []DataSourceToIndexFieldMapping: Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
IncludeFilterTypes []DataSourceSalesforceChatterFeedIncludeFilterType: Filters the documents in the feed based on status of the user. When you specify ACTIVE_USERS only documents from users who have an active account are indexed. When you specify STANDARD_USER only documents for Salesforce standard users are documented. You can specify both.

documentDataFieldName String: The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the Body column.
documentTitleFieldName String: The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the Title column.
fieldMappings List<DataSourceToIndexFieldMapping>: Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
includeFilterTypes List<DataSourceSalesforceChatterFeedIncludeFilterType>: Filters the documents in the feed based on status of the user. When you specify ACTIVE_USERS only documents from users who have an active account are indexed. When you specify STANDARD_USER only documents for Salesforce standard users are documented. You can specify both.

documentDataFieldName string: The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the Body column.
documentTitleFieldName string: The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the Title column.
fieldMappings DataSourceToIndexFieldMapping[]: Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
includeFilterTypes DataSourceSalesforceChatterFeedIncludeFilterType[]: Filters the documents in the feed based on status of the user. When you specify ACTIVE_USERS only documents from users who have an active account are indexed. When you specify STANDARD_USER only documents for Salesforce standard users are documented. You can specify both.

document_data_field_name str: The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the Body column.
document_title_field_name str: The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the Title column.
field_mappings Sequence[DataSourceToIndexFieldMapping]: Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
include_filter_types Sequence[DataSourceSalesforceChatterFeedIncludeFilterType]: Filters the documents in the feed based on status of the user. When you specify ACTIVE_USERS only documents from users who have an active account are indexed. When you specify STANDARD_USER only documents for Salesforce standard users are documented. You can specify both.

documentDataFieldName String: The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the Body column.
documentTitleFieldName String: The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the Title column.
fieldMappings List<Property Map>: Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
includeFilterTypes List<"ACTIVE_USER" | "STANDARD_USER">: Filters the documents in the feed based on status of the user. When you specify ACTIVE_USERS only documents from users who have an active account are indexed. When you specify STANDARD_USER only documents for Salesforce standard users are documented. You can specify both.

DataSourceSalesforceChatterFeedIncludeFilterType

DataSourceSalesforceConfiguration

SecretArn string

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:

authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
consumerKey - The application public key generated when you created your Salesforce application.
consumerSecret - The application private key generated when you created your Salesforce application.
password - The password associated with the user logging in to the Salesforce instance.
securityToken - The token associated with the user logging in to the Salesforce instance.
username - The user name of the user logging in to the Salesforce instance.

ServerUrl string

The instance URL for the Salesforce site that you want to index.

ChatterFeedConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceSalesforceChatterFeedConfiguration

Configuration information for Salesforce chatter feeds.

CrawlAttachments bool

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

ExcludeAttachmentFilePatterns List<string>

A list of regular expression patterns to exclude certain documents in your Salesforce. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The pattern is applied to the name of the attached file.

IncludeAttachmentFilePatterns List<string>

A list of regular expression patterns to include certain documents in your Salesforce. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The pattern is applied to the name of the attached file.

KnowledgeArticleConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceSalesforceKnowledgeArticleConfiguration

Configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.

StandardObjectAttachmentConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceSalesforceStandardObjectAttachmentConfiguration

Configuration information for processing attachments to Salesforce standard objects.

StandardObjectConfigurations List<Pulumi.AwsNative.Kendra.Inputs.DataSourceSalesforceStandardObjectConfiguration>

Configuration of the Salesforce standard objects that Amazon Kendra indexes.

SecretArn string

authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
consumerKey - The application public key generated when you created your Salesforce application.
consumerSecret - The application private key generated when you created your Salesforce application.
password - The password associated with the user logging in to the Salesforce instance.
securityToken - The token associated with the user logging in to the Salesforce instance.
username - The user name of the user logging in to the Salesforce instance.

ServerUrl string

The instance URL for the Salesforce site that you want to index.

ChatterFeedConfiguration DataSourceSalesforceChatterFeedConfiguration

Configuration information for Salesforce chatter feeds.

CrawlAttachments bool

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

ExcludeAttachmentFilePatterns []string

The pattern is applied to the name of the attached file.

IncludeAttachmentFilePatterns []string

The pattern is applied to the name of the attached file.

KnowledgeArticleConfiguration DataSourceSalesforceKnowledgeArticleConfiguration

StandardObjectAttachmentConfiguration DataSourceSalesforceStandardObjectAttachmentConfiguration

Configuration information for processing attachments to Salesforce standard objects.

StandardObjectConfigurations []DataSourceSalesforceStandardObjectConfiguration

Configuration of the Salesforce standard objects that Amazon Kendra indexes.

secretArn String

authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
consumerKey - The application public key generated when you created your Salesforce application.
consumerSecret - The application private key generated when you created your Salesforce application.
password - The password associated with the user logging in to the Salesforce instance.
securityToken - The token associated with the user logging in to the Salesforce instance.
username - The user name of the user logging in to the Salesforce instance.

serverUrl String

The instance URL for the Salesforce site that you want to index.

chatterFeedConfiguration DataSourceSalesforceChatterFeedConfiguration

Configuration information for Salesforce chatter feeds.

crawlAttachments Boolean

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

excludeAttachmentFilePatterns List<String>

The pattern is applied to the name of the attached file.

includeAttachmentFilePatterns List<String>

The pattern is applied to the name of the attached file.

knowledgeArticleConfiguration DataSourceSalesforceKnowledgeArticleConfiguration

standardObjectAttachmentConfiguration DataSourceSalesforceStandardObjectAttachmentConfiguration

Configuration information for processing attachments to Salesforce standard objects.

standardObjectConfigurations List<DataSourceSalesforceStandardObjectConfiguration>

Configuration of the Salesforce standard objects that Amazon Kendra indexes.

secretArn string

authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
consumerKey - The application public key generated when you created your Salesforce application.
consumerSecret - The application private key generated when you created your Salesforce application.
password - The password associated with the user logging in to the Salesforce instance.
securityToken - The token associated with the user logging in to the Salesforce instance.
username - The user name of the user logging in to the Salesforce instance.

serverUrl string

The instance URL for the Salesforce site that you want to index.

chatterFeedConfiguration DataSourceSalesforceChatterFeedConfiguration

Configuration information for Salesforce chatter feeds.

crawlAttachments boolean

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

excludeAttachmentFilePatterns string[]

The pattern is applied to the name of the attached file.

includeAttachmentFilePatterns string[]

The pattern is applied to the name of the attached file.

knowledgeArticleConfiguration DataSourceSalesforceKnowledgeArticleConfiguration

standardObjectAttachmentConfiguration DataSourceSalesforceStandardObjectAttachmentConfiguration

Configuration information for processing attachments to Salesforce standard objects.

standardObjectConfigurations DataSourceSalesforceStandardObjectConfiguration[]

Configuration of the Salesforce standard objects that Amazon Kendra indexes.

secret_arn str

authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
consumerKey - The application public key generated when you created your Salesforce application.
consumerSecret - The application private key generated when you created your Salesforce application.
password - The password associated with the user logging in to the Salesforce instance.
securityToken - The token associated with the user logging in to the Salesforce instance.
username - The user name of the user logging in to the Salesforce instance.

server_url str

The instance URL for the Salesforce site that you want to index.

chatter_feed_configuration DataSourceSalesforceChatterFeedConfiguration

Configuration information for Salesforce chatter feeds.

crawl_attachments bool

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

exclude_attachment_file_patterns Sequence[str]

The pattern is applied to the name of the attached file.

include_attachment_file_patterns Sequence[str]

The pattern is applied to the name of the attached file.

knowledge_article_configuration DataSourceSalesforceKnowledgeArticleConfiguration

standard_object_attachment_configuration DataSourceSalesforceStandardObjectAttachmentConfiguration

Configuration information for processing attachments to Salesforce standard objects.

standard_object_configurations Sequence[DataSourceSalesforceStandardObjectConfiguration]

Configuration of the Salesforce standard objects that Amazon Kendra indexes.

secretArn String

authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
consumerKey - The application public key generated when you created your Salesforce application.
consumerSecret - The application private key generated when you created your Salesforce application.
password - The password associated with the user logging in to the Salesforce instance.
securityToken - The token associated with the user logging in to the Salesforce instance.
username - The user name of the user logging in to the Salesforce instance.

serverUrl String

The instance URL for the Salesforce site that you want to index.

chatterFeedConfiguration Property Map

Configuration information for Salesforce chatter feeds.

crawlAttachments Boolean

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

excludeAttachmentFilePatterns List<String>

The pattern is applied to the name of the attached file.

includeAttachmentFilePatterns List<String>

The pattern is applied to the name of the attached file.

knowledgeArticleConfiguration Property Map

standardObjectAttachmentConfiguration Property Map

Configuration information for processing attachments to Salesforce standard objects.

standardObjectConfigurations List<Property Map>

Configuration of the Salesforce standard objects that Amazon Kendra indexes.

DataSourceSalesforceCustomKnowledgeArticleTypeConfiguration

DocumentDataFieldName string
Name string
DocumentTitleFieldName string
FieldMappings List<Pulumi.AwsNative.Kendra.Inputs.DataSourceToIndexFieldMapping>

DocumentDataFieldName string
Name string
DocumentTitleFieldName string
FieldMappings []DataSourceToIndexFieldMapping

documentDataFieldName String
name String
documentTitleFieldName String
fieldMappings List<DataSourceToIndexFieldMapping>

documentDataFieldName string
name string
documentTitleFieldName string
fieldMappings DataSourceToIndexFieldMapping[]

document_data_field_name str
name str
document_title_field_name str
field_mappings Sequence[DataSourceToIndexFieldMapping]

documentDataFieldName String
name String
documentTitleFieldName String
fieldMappings List<Property Map>

DataSourceSalesforceKnowledgeArticleConfiguration

IncludedStates List<Pulumi.AwsNative.Kendra.DataSourceSalesforceKnowledgeArticleState>: Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.
CustomKnowledgeArticleTypeConfigurations List<Pulumi.AwsNative.Kendra.Inputs.DataSourceSalesforceCustomKnowledgeArticleTypeConfiguration>: Configuration information for custom Salesforce knowledge articles.
StandardKnowledgeArticleTypeConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceSalesforceStandardKnowledgeArticleTypeConfiguration: Configuration information for standard Salesforce knowledge articles.

IncludedStates []DataSourceSalesforceKnowledgeArticleState: Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.
CustomKnowledgeArticleTypeConfigurations []DataSourceSalesforceCustomKnowledgeArticleTypeConfiguration: Configuration information for custom Salesforce knowledge articles.
StandardKnowledgeArticleTypeConfiguration DataSourceSalesforceStandardKnowledgeArticleTypeConfiguration: Configuration information for standard Salesforce knowledge articles.

includedStates List<DataSourceSalesforceKnowledgeArticleState>: Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.
customKnowledgeArticleTypeConfigurations List<DataSourceSalesforceCustomKnowledgeArticleTypeConfiguration>: Configuration information for custom Salesforce knowledge articles.
standardKnowledgeArticleTypeConfiguration DataSourceSalesforceStandardKnowledgeArticleTypeConfiguration: Configuration information for standard Salesforce knowledge articles.

includedStates DataSourceSalesforceKnowledgeArticleState[]: Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.
customKnowledgeArticleTypeConfigurations DataSourceSalesforceCustomKnowledgeArticleTypeConfiguration[]: Configuration information for custom Salesforce knowledge articles.
standardKnowledgeArticleTypeConfiguration DataSourceSalesforceStandardKnowledgeArticleTypeConfiguration: Configuration information for standard Salesforce knowledge articles.

included_states Sequence[DataSourceSalesforceKnowledgeArticleState]: Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.
custom_knowledge_article_type_configurations Sequence[DataSourceSalesforceCustomKnowledgeArticleTypeConfiguration]: Configuration information for custom Salesforce knowledge articles.
standard_knowledge_article_type_configuration DataSourceSalesforceStandardKnowledgeArticleTypeConfiguration: Configuration information for standard Salesforce knowledge articles.

includedStates List<"DRAFT" | "PUBLISHED" | "ARCHIVED">: Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.
customKnowledgeArticleTypeConfigurations List<Property Map>: Configuration information for custom Salesforce knowledge articles.
standardKnowledgeArticleTypeConfiguration Property Map: Configuration information for standard Salesforce knowledge articles.

DataSourceSalesforceKnowledgeArticleState

DataSourceSalesforceStandardKnowledgeArticleTypeConfiguration

DocumentDataFieldName string: The name of the field that contains the document data to index.
DocumentTitleFieldName string: The name of the field that contains the document title.
FieldMappings List<Pulumi.AwsNative.Kendra.Inputs.DataSourceToIndexFieldMapping>: Maps attributes or field names of the knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields . The Salesforce data source field names must exist in your Salesforce custom metadata.

DocumentDataFieldName string: The name of the field that contains the document data to index.
DocumentTitleFieldName string: The name of the field that contains the document title.
FieldMappings []DataSourceToIndexFieldMapping: Maps attributes or field names of the knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields . The Salesforce data source field names must exist in your Salesforce custom metadata.

documentDataFieldName String: The name of the field that contains the document data to index.
documentTitleFieldName String: The name of the field that contains the document title.
fieldMappings List<DataSourceToIndexFieldMapping>: Maps attributes or field names of the knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields . The Salesforce data source field names must exist in your Salesforce custom metadata.

documentDataFieldName string: The name of the field that contains the document data to index.
documentTitleFieldName string: The name of the field that contains the document title.
fieldMappings DataSourceToIndexFieldMapping[]: Maps attributes or field names of the knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields . The Salesforce data source field names must exist in your Salesforce custom metadata.

document_data_field_name str: The name of the field that contains the document data to index.
document_title_field_name str: The name of the field that contains the document title.
field_mappings Sequence[DataSourceToIndexFieldMapping]: Maps attributes or field names of the knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields . The Salesforce data source field names must exist in your Salesforce custom metadata.

documentDataFieldName String: The name of the field that contains the document data to index.
documentTitleFieldName String: The name of the field that contains the document title.
fieldMappings List<Property Map>: Maps attributes or field names of the knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields . The Salesforce data source field names must exist in your Salesforce custom metadata.

DataSourceSalesforceStandardObjectAttachmentConfiguration

DocumentTitleFieldName string: The name of the field used for the document title.
FieldMappings List<Pulumi.AwsNative.Kendra.Inputs.DataSourceToIndexFieldMapping>: One or more objects that map fields in attachments to Amazon Kendra index fields.

DocumentTitleFieldName string: The name of the field used for the document title.
FieldMappings []DataSourceToIndexFieldMapping: One or more objects that map fields in attachments to Amazon Kendra index fields.

documentTitleFieldName String: The name of the field used for the document title.
fieldMappings List<DataSourceToIndexFieldMapping>: One or more objects that map fields in attachments to Amazon Kendra index fields.

documentTitleFieldName string: The name of the field used for the document title.
fieldMappings DataSourceToIndexFieldMapping[]: One or more objects that map fields in attachments to Amazon Kendra index fields.

document_title_field_name str: The name of the field used for the document title.
field_mappings Sequence[DataSourceToIndexFieldMapping]: One or more objects that map fields in attachments to Amazon Kendra index fields.

documentTitleFieldName String: The name of the field used for the document title.
fieldMappings List<Property Map>: One or more objects that map fields in attachments to Amazon Kendra index fields.

DataSourceSalesforceStandardObjectConfiguration

DocumentDataFieldName string
Name Pulumi.AwsNative.Kendra.DataSourceSalesforceStandardObjectName
DocumentTitleFieldName string
FieldMappings List<Pulumi.AwsNative.Kendra.Inputs.DataSourceToIndexFieldMapping>

DocumentDataFieldName string
Name DataSourceSalesforceStandardObjectName
DocumentTitleFieldName string
FieldMappings []DataSourceToIndexFieldMapping

documentDataFieldName String
name DataSourceSalesforceStandardObjectName
documentTitleFieldName String
fieldMappings List<DataSourceToIndexFieldMapping>

documentDataFieldName string
name DataSourceSalesforceStandardObjectName
documentTitleFieldName string
fieldMappings DataSourceToIndexFieldMapping[]

document_data_field_name str
name DataSourceSalesforceStandardObjectName
document_title_field_name str
field_mappings Sequence[DataSourceToIndexFieldMapping]

documentDataFieldName String
name "ACCOUNT" | "CAMPAIGN" | "CASE" | "CONTACT" | "CONTRACT" | "DOCUMENT" | "GROUP" | "IDEA" | "LEAD" | "OPPORTUNITY" | "PARTNER" | "PRICEBOOK" | "PRODUCT" | "PROFILE" | "SOLUTION" | "TASK" | "USER"
documentTitleFieldName String
fieldMappings List<Property Map>

DataSourceSalesforceStandardObjectName

DataSourceServiceNowAuthenticationType

DataSourceServiceNowBuildVersionType

DataSourceServiceNowConfiguration

HostUrl string

The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.

SecretArn string

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance. You can also provide OAuth authentication credentials of user name, password, client ID, and client secret. For more information, see Using a ServiceNow data source .

ServiceNowBuildVersion Pulumi.AwsNative.Kendra.DataSourceServiceNowBuildVersionType

The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS .

AuthenticationType Pulumi.AwsNative.Kendra.DataSourceServiceNowAuthenticationType

The type of authentication used to connect to the ServiceNow instance. If you choose HTTP_BASIC , Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the SecretArn field. If you choose OAUTH2 , Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password.

When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source .

KnowledgeArticleConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceServiceNowKnowledgeArticleConfiguration

Configuration information for crawling knowledge articles in the ServiceNow site.

ServiceCatalogConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceServiceNowServiceCatalogConfiguration

Configuration information for crawling service catalogs in the ServiceNow site.

HostUrl string

The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.

SecretArn string

ServiceNowBuildVersion DataSourceServiceNowBuildVersionType

The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS .

AuthenticationType DataSourceServiceNowAuthenticationType

When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source .

KnowledgeArticleConfiguration DataSourceServiceNowKnowledgeArticleConfiguration

Configuration information for crawling knowledge articles in the ServiceNow site.

ServiceCatalogConfiguration DataSourceServiceNowServiceCatalogConfiguration

Configuration information for crawling service catalogs in the ServiceNow site.

hostUrl String

The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.

secretArn String

serviceNowBuildVersion DataSourceServiceNowBuildVersionType

The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS .

authenticationType DataSourceServiceNowAuthenticationType

When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source .

knowledgeArticleConfiguration DataSourceServiceNowKnowledgeArticleConfiguration

Configuration information for crawling knowledge articles in the ServiceNow site.

serviceCatalogConfiguration DataSourceServiceNowServiceCatalogConfiguration

Configuration information for crawling service catalogs in the ServiceNow site.

hostUrl string

The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.

secretArn string

serviceNowBuildVersion DataSourceServiceNowBuildVersionType

The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS .

authenticationType DataSourceServiceNowAuthenticationType

When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source .

knowledgeArticleConfiguration DataSourceServiceNowKnowledgeArticleConfiguration

Configuration information for crawling knowledge articles in the ServiceNow site.

serviceCatalogConfiguration DataSourceServiceNowServiceCatalogConfiguration

Configuration information for crawling service catalogs in the ServiceNow site.

host_url str

The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.

secret_arn str

service_now_build_version DataSourceServiceNowBuildVersionType

The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS .

authentication_type DataSourceServiceNowAuthenticationType

When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source .

knowledge_article_configuration DataSourceServiceNowKnowledgeArticleConfiguration

Configuration information for crawling knowledge articles in the ServiceNow site.

service_catalog_configuration DataSourceServiceNowServiceCatalogConfiguration

Configuration information for crawling service catalogs in the ServiceNow site.

hostUrl String

The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.

secretArn String

serviceNowBuildVersion "LONDON" | "OTHERS"

The identifier of the release that the ServiceNow host is running. If the host is not running the LONDON release, use OTHERS .

authenticationType "HTTP_BASIC" | "OAUTH2"

When you use OAUTH2 authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see Using a ServiceNow data source .

knowledgeArticleConfiguration Property Map

Configuration information for crawling knowledge articles in the ServiceNow site.

serviceCatalogConfiguration Property Map

Configuration information for crawling service catalogs in the ServiceNow site.

DataSourceServiceNowKnowledgeArticleConfiguration

DocumentDataFieldName string

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

CrawlAttachments bool

TRUE to index attachments to knowledge articles.

DocumentTitleFieldName string

The name of the ServiceNow field that is mapped to the index document title field.

ExcludeAttachmentFilePatterns List<string>

A list of regular expression patterns applied to exclude certain knowledge article attachments. Attachments that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

FieldMappings List<Pulumi.AwsNative.Kendra.Inputs.DataSourceToIndexFieldMapping>

Maps attributes or field names of knoweldge articles to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to ServiceNow fields. For more information, see Mapping data source fields . The ServiceNow data source field names must exist in your ServiceNow custom metadata.

FilterQuery string

A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.

The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query .

IncludeAttachmentFilePatterns List<string>

A list of regular expression patterns applied to include knowledge article attachments. Attachments that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

DocumentDataFieldName string

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

CrawlAttachments bool

TRUE to index attachments to knowledge articles.

DocumentTitleFieldName string

The name of the ServiceNow field that is mapped to the index document title field.

ExcludeAttachmentFilePatterns []string

FieldMappings []DataSourceToIndexFieldMapping

FilterQuery string

A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.

The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query .

IncludeAttachmentFilePatterns []string

documentDataFieldName String

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

crawlAttachments Boolean

TRUE to index attachments to knowledge articles.

documentTitleFieldName String

The name of the ServiceNow field that is mapped to the index document title field.

excludeAttachmentFilePatterns List<String>

fieldMappings List<DataSourceToIndexFieldMapping>

filterQuery String

A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.

The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query .

includeAttachmentFilePatterns List<String>

documentDataFieldName string

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

crawlAttachments boolean

TRUE to index attachments to knowledge articles.

documentTitleFieldName string

The name of the ServiceNow field that is mapped to the index document title field.

excludeAttachmentFilePatterns string[]

fieldMappings DataSourceToIndexFieldMapping[]

filterQuery string

A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.

The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query .

includeAttachmentFilePatterns string[]

document_data_field_name str

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

crawl_attachments bool

TRUE to index attachments to knowledge articles.

document_title_field_name str

The name of the ServiceNow field that is mapped to the index document title field.

exclude_attachment_file_patterns Sequence[str]

field_mappings Sequence[DataSourceToIndexFieldMapping]

filter_query str

A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.

The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query .

include_attachment_file_patterns Sequence[str]

documentDataFieldName String

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

crawlAttachments Boolean

TRUE to index attachments to knowledge articles.

documentTitleFieldName String

The name of the ServiceNow field that is mapped to the index document title field.

excludeAttachmentFilePatterns List<String>

fieldMappings List<Property Map>

filterQuery String

A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.

The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query .

includeAttachmentFilePatterns List<String>

DataSourceServiceNowServiceCatalogConfiguration

DocumentDataFieldName string

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

CrawlAttachments bool

TRUE to index attachments to service catalog items.

DocumentTitleFieldName string

The name of the ServiceNow field that is mapped to the index document title field.

ExcludeAttachmentFilePatterns List<string>

A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow. Item that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

The regex is applied to the file name of the attachment.

FieldMappings List<Pulumi.AwsNative.Kendra.Inputs.DataSourceToIndexFieldMapping>

Maps attributes or field names of catalogs to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to ServiceNow fields. For more information, see Mapping data source fields . The ServiceNow data source field names must exist in your ServiceNow custom metadata.

IncludeAttachmentFilePatterns List<string>

A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow. Item that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

The regex is applied to the file name of the attachment.

DocumentDataFieldName string

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

CrawlAttachments bool

TRUE to index attachments to service catalog items.

DocumentTitleFieldName string

The name of the ServiceNow field that is mapped to the index document title field.

ExcludeAttachmentFilePatterns []string

The regex is applied to the file name of the attachment.

FieldMappings []DataSourceToIndexFieldMapping

IncludeAttachmentFilePatterns []string

The regex is applied to the file name of the attachment.

documentDataFieldName String

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

crawlAttachments Boolean

TRUE to index attachments to service catalog items.

documentTitleFieldName String

The name of the ServiceNow field that is mapped to the index document title field.

excludeAttachmentFilePatterns List<String>

The regex is applied to the file name of the attachment.

fieldMappings List<DataSourceToIndexFieldMapping>

includeAttachmentFilePatterns List<String>

The regex is applied to the file name of the attachment.

documentDataFieldName string

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

crawlAttachments boolean

TRUE to index attachments to service catalog items.

documentTitleFieldName string

The name of the ServiceNow field that is mapped to the index document title field.

excludeAttachmentFilePatterns string[]

The regex is applied to the file name of the attachment.

fieldMappings DataSourceToIndexFieldMapping[]

includeAttachmentFilePatterns string[]

The regex is applied to the file name of the attachment.

document_data_field_name str

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

crawl_attachments bool

TRUE to index attachments to service catalog items.

document_title_field_name str

The name of the ServiceNow field that is mapped to the index document title field.

exclude_attachment_file_patterns Sequence[str]

The regex is applied to the file name of the attachment.

field_mappings Sequence[DataSourceToIndexFieldMapping]

include_attachment_file_patterns Sequence[str]

The regex is applied to the file name of the attachment.

documentDataFieldName String

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

crawlAttachments Boolean

TRUE to index attachments to service catalog items.

documentTitleFieldName String

The name of the ServiceNow field that is mapped to the index document title field.

excludeAttachmentFilePatterns List<String>

The regex is applied to the file name of the attachment.

fieldMappings List<Property Map>

includeAttachmentFilePatterns List<String>

The regex is applied to the file name of the attachment.

DataSourceSharePointConfiguration

SecretArn string

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. For more information, see Microsoft SharePoint .

SharePointVersion Pulumi.AwsNative.Kendra.DataSourceSharePointConfigurationSharePointVersion

The version of Microsoft SharePoint that you use.

Urls List<string>

The Microsoft SharePoint site URLs for the documents you want to index.

CrawlAttachments bool

TRUE to index document attachments.

DisableLocalGroups bool

TRUE to disable local groups information.

DocumentTitleFieldName string

The Microsoft SharePoint attribute field that contains the title of the document.

ExclusionPatterns List<string>

A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the display URL of the SharePoint document.

FieldMappings List<Pulumi.AwsNative.Kendra.Inputs.DataSourceToIndexFieldMapping>

A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes or fields to Amazon Kendra index fields. You must first create the index fields using the UpdateIndex operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields .

InclusionPatterns List<string>

A list of regular expression patterns to include certain documents in your SharePoint. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The regex applies to the display URL of the SharePoint document.

SslCertificateS3Path Pulumi.AwsNative.Kendra.Inputs.DataSourceS3Path

Information required to find a specific file in an Amazon S3 bucket.

UseChangeLog bool

TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.

VpcConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceVpcConfiguration

Provides information for connecting to an Amazon VPC.

SecretArn string

SharePointVersion DataSourceSharePointConfigurationSharePointVersion

The version of Microsoft SharePoint that you use.

Urls []string

The Microsoft SharePoint site URLs for the documents you want to index.

CrawlAttachments bool

TRUE to index document attachments.

DisableLocalGroups bool

TRUE to disable local groups information.

DocumentTitleFieldName string

The Microsoft SharePoint attribute field that contains the title of the document.

ExclusionPatterns []string

The regex is applied to the display URL of the SharePoint document.

FieldMappings []DataSourceToIndexFieldMapping

InclusionPatterns []string

The regex applies to the display URL of the SharePoint document.

SslCertificateS3Path DataSourceS3Path

Information required to find a specific file in an Amazon S3 bucket.

UseChangeLog bool

VpcConfiguration DataSourceVpcConfiguration

Provides information for connecting to an Amazon VPC.

secretArn String

sharePointVersion DataSourceSharePointConfigurationSharePointVersion

The version of Microsoft SharePoint that you use.

urls List<String>

The Microsoft SharePoint site URLs for the documents you want to index.

crawlAttachments Boolean

TRUE to index document attachments.

disableLocalGroups Boolean

TRUE to disable local groups information.

documentTitleFieldName String

The Microsoft SharePoint attribute field that contains the title of the document.

exclusionPatterns List<String>

The regex is applied to the display URL of the SharePoint document.

fieldMappings List<DataSourceToIndexFieldMapping>

inclusionPatterns List<String>

The regex applies to the display URL of the SharePoint document.

sslCertificateS3Path DataSourceS3Path

Information required to find a specific file in an Amazon S3 bucket.

useChangeLog Boolean

vpcConfiguration DataSourceVpcConfiguration

Provides information for connecting to an Amazon VPC.

secretArn string

sharePointVersion DataSourceSharePointConfigurationSharePointVersion

The version of Microsoft SharePoint that you use.

urls string[]

The Microsoft SharePoint site URLs for the documents you want to index.

crawlAttachments boolean

TRUE to index document attachments.

disableLocalGroups boolean

TRUE to disable local groups information.

documentTitleFieldName string

The Microsoft SharePoint attribute field that contains the title of the document.

exclusionPatterns string[]

The regex is applied to the display URL of the SharePoint document.

fieldMappings DataSourceToIndexFieldMapping[]

inclusionPatterns string[]

The regex applies to the display URL of the SharePoint document.

sslCertificateS3Path DataSourceS3Path

Information required to find a specific file in an Amazon S3 bucket.

useChangeLog boolean

vpcConfiguration DataSourceVpcConfiguration

Provides information for connecting to an Amazon VPC.

secret_arn str

share_point_version DataSourceSharePointConfigurationSharePointVersion

The version of Microsoft SharePoint that you use.

urls Sequence[str]

The Microsoft SharePoint site URLs for the documents you want to index.

crawl_attachments bool

TRUE to index document attachments.

disable_local_groups bool

TRUE to disable local groups information.

document_title_field_name str

The Microsoft SharePoint attribute field that contains the title of the document.

exclusion_patterns Sequence[str]

The regex is applied to the display URL of the SharePoint document.

field_mappings Sequence[DataSourceToIndexFieldMapping]

inclusion_patterns Sequence[str]

The regex applies to the display URL of the SharePoint document.

ssl_certificate_s3_path DataSourceS3Path

Information required to find a specific file in an Amazon S3 bucket.

use_change_log bool

vpc_configuration DataSourceVpcConfiguration

Provides information for connecting to an Amazon VPC.

secretArn String

sharePointVersion "SHAREPOINT_ONLINE" | "SHAREPOINT_2013" | "SHAREPOINT_2016"

The version of Microsoft SharePoint that you use.

urls List<String>

The Microsoft SharePoint site URLs for the documents you want to index.

crawlAttachments Boolean

TRUE to index document attachments.

disableLocalGroups Boolean

TRUE to disable local groups information.

documentTitleFieldName String

The Microsoft SharePoint attribute field that contains the title of the document.

exclusionPatterns List<String>

The regex is applied to the display URL of the SharePoint document.

fieldMappings List<Property Map>

inclusionPatterns List<String>

The regex applies to the display URL of the SharePoint document.

sslCertificateS3Path Property Map

Information required to find a specific file in an Amazon S3 bucket.

useChangeLog Boolean

vpcConfiguration Property Map

Provides information for connecting to an Amazon VPC.

DataSourceSharePointConfigurationSharePointVersion

DataSourceSqlConfiguration

QueryIdentifiersEnclosingOption Pulumi.AwsNative.Kendra.DataSourceQueryIdentifiersEnclosingOption

Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query. You can set the value to DOUBLE_QUOTES or NONE .

By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.

PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's case.

For MySQL databases, you must enable the ansi_quotes option when you set this field to DOUBLE_QUOTES .

QueryIdentifiersEnclosingOption DataSourceQueryIdentifiersEnclosingOption

Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query. You can set the value to DOUBLE_QUOTES or NONE .

By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.

For MySQL databases, you must enable the ansi_quotes option when you set this field to DOUBLE_QUOTES .

queryIdentifiersEnclosingOption DataSourceQueryIdentifiersEnclosingOption

Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query. You can set the value to DOUBLE_QUOTES or NONE .

By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.

For MySQL databases, you must enable the ansi_quotes option when you set this field to DOUBLE_QUOTES .

queryIdentifiersEnclosingOption DataSourceQueryIdentifiersEnclosingOption

Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query. You can set the value to DOUBLE_QUOTES or NONE .

By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.

For MySQL databases, you must enable the ansi_quotes option when you set this field to DOUBLE_QUOTES .

query_identifiers_enclosing_option DataSourceQueryIdentifiersEnclosingOption

Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query. You can set the value to DOUBLE_QUOTES or NONE .

By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.

For MySQL databases, you must enable the ansi_quotes option when you set this field to DOUBLE_QUOTES .

queryIdentifiersEnclosingOption "DOUBLE_QUOTES" | "NONE"

Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query. You can set the value to DOUBLE_QUOTES or NONE .

By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.

For MySQL databases, you must enable the ansi_quotes option when you set this field to DOUBLE_QUOTES .

DataSourceToIndexFieldMapping

DataSourceFieldName string
IndexFieldName string
DateFieldFormat string

DataSourceFieldName string
IndexFieldName string
DateFieldFormat string

dataSourceFieldName String
indexFieldName String
dateFieldFormat String

dataSourceFieldName string
indexFieldName string
dateFieldFormat string

data_source_field_name str
index_field_name str
date_field_format str

dataSourceFieldName String
indexFieldName String
dateFieldFormat String

DataSourceVpcConfiguration

SecurityGroupIds List<string>: A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.
SubnetIds List<string>: A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

SecurityGroupIds []string: A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.
SubnetIds []string: A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

securityGroupIds List<String>: A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.
subnetIds List<String>: A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

securityGroupIds string[]: A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.
subnetIds string[]: A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

security_group_ids Sequence[str]: A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.
subnet_ids Sequence[str]: A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

securityGroupIds List<String>: A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.
subnetIds List<String>: A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

DataSourceWebCrawlerAuthenticationConfiguration

BasicAuthentication List<Pulumi.AwsNative.Kendra.Inputs.DataSourceWebCrawlerBasicAuthentication>

The list of configuration information that's required to connect to and crawl a website host using basic authentication credentials.

The list includes the name and port number of the website host.

BasicAuthentication []DataSourceWebCrawlerBasicAuthentication

The list of configuration information that's required to connect to and crawl a website host using basic authentication credentials.

The list includes the name and port number of the website host.

basicAuthentication List<DataSourceWebCrawlerBasicAuthentication>

The list of configuration information that's required to connect to and crawl a website host using basic authentication credentials.

The list includes the name and port number of the website host.

basicAuthentication DataSourceWebCrawlerBasicAuthentication[]

The list of configuration information that's required to connect to and crawl a website host using basic authentication credentials.

The list includes the name and port number of the website host.

basic_authentication Sequence[DataSourceWebCrawlerBasicAuthentication]

The list of configuration information that's required to connect to and crawl a website host using basic authentication credentials.

The list includes the name and port number of the website host.

basicAuthentication List<Property Map>

The list of configuration information that's required to connect to and crawl a website host using basic authentication credentials.

The list includes the name and port number of the website host.

DataSourceWebCrawlerBasicAuthentication

Credentials string
Host string
Port int

Credentials string
Host string
Port int

credentials String
host String
port Integer

credentials string
host string
port number

credentials str
host str
port int

credentials String
host String
port Number

DataSourceWebCrawlerConfiguration

Urls Pulumi.AwsNative.Kendra.Inputs.DataSourceWebCrawlerUrls

Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.

You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.

You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.

When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own webpages, or webpages that you have authorization to index.

AuthenticationConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceWebCrawlerAuthenticationConfiguration

Configuration information required to connect to websites using authentication.

You can connect to websites using basic authentication of user name and password. You use a secret in AWS Secrets Manager to store your authentication credentials.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

CrawlDepth int

The 'depth' or number of levels from the seed level to crawl. For example, the seed URL page is depth 1 and any hyperlinks on this page that are also crawled are depth 2.

MaxContentSizePerPageInMegaBytes double

The maximum size (in MB) of a web page or attachment to crawl.

Files larger than this size (in MB) are skipped/not crawled.

The default maximum size of a web page or attachment is set to 50 MB.

MaxLinksPerPage int

The maximum number of URLs on a web page to include when crawling a website. This number is per web page.

As a website’s web pages are crawled, any URLs the web pages link to are also crawled. URLs on a web page are crawled in order of appearance.

The default maximum links per page is 100.

MaxUrlsPerMinuteCrawlRate int

The maximum number of URLs crawled per website host per minute.

A minimum of one URL is required.

The default maximum number of URLs crawled per website host per minute is 300.

ProxyConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceProxyConfiguration

Configuration information required to connect to your internal websites via a web proxy.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in AWS Secrets Manager .

UrlExclusionPatterns List<string>

A list of regular expression patterns to exclude certain URLs to crawl. URLs that match the patterns are excluded from the index. URLs that don't match the patterns are included in the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.

UrlInclusionPatterns List<string>

A list of regular expression patterns to include certain URLs to crawl. URLs that match the patterns are included in the index. URLs that don't match the patterns are excluded from the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.

Urls DataSourceWebCrawlerUrls

Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.

You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.

AuthenticationConfiguration DataSourceWebCrawlerAuthenticationConfiguration

Configuration information required to connect to websites using authentication.

You can connect to websites using basic authentication of user name and password. You use a secret in AWS Secrets Manager to store your authentication credentials.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

CrawlDepth int

The 'depth' or number of levels from the seed level to crawl. For example, the seed URL page is depth 1 and any hyperlinks on this page that are also crawled are depth 2.

MaxContentSizePerPageInMegaBytes float64

The maximum size (in MB) of a web page or attachment to crawl.

Files larger than this size (in MB) are skipped/not crawled.

The default maximum size of a web page or attachment is set to 50 MB.

MaxLinksPerPage int

The maximum number of URLs on a web page to include when crawling a website. This number is per web page.

As a website’s web pages are crawled, any URLs the web pages link to are also crawled. URLs on a web page are crawled in order of appearance.

The default maximum links per page is 100.

MaxUrlsPerMinuteCrawlRate int

The maximum number of URLs crawled per website host per minute.

A minimum of one URL is required.

The default maximum number of URLs crawled per website host per minute is 300.

ProxyConfiguration DataSourceProxyConfiguration

Configuration information required to connect to your internal websites via a web proxy.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in AWS Secrets Manager .

UrlExclusionPatterns []string

UrlInclusionPatterns []string

urls DataSourceWebCrawlerUrls

Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.

You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.

authenticationConfiguration DataSourceWebCrawlerAuthenticationConfiguration

Configuration information required to connect to websites using authentication.

You can connect to websites using basic authentication of user name and password. You use a secret in AWS Secrets Manager to store your authentication credentials.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

crawlDepth Integer

The 'depth' or number of levels from the seed level to crawl. For example, the seed URL page is depth 1 and any hyperlinks on this page that are also crawled are depth 2.

maxContentSizePerPageInMegaBytes Double

The maximum size (in MB) of a web page or attachment to crawl.

Files larger than this size (in MB) are skipped/not crawled.

The default maximum size of a web page or attachment is set to 50 MB.

maxLinksPerPage Integer

The maximum number of URLs on a web page to include when crawling a website. This number is per web page.

As a website’s web pages are crawled, any URLs the web pages link to are also crawled. URLs on a web page are crawled in order of appearance.

The default maximum links per page is 100.

maxUrlsPerMinuteCrawlRate Integer

The maximum number of URLs crawled per website host per minute.

A minimum of one URL is required.

The default maximum number of URLs crawled per website host per minute is 300.

proxyConfiguration DataSourceProxyConfiguration

Configuration information required to connect to your internal websites via a web proxy.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in AWS Secrets Manager .

urlExclusionPatterns List<String>

urlInclusionPatterns List<String>

urls DataSourceWebCrawlerUrls

Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.

You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.

authenticationConfiguration DataSourceWebCrawlerAuthenticationConfiguration

Configuration information required to connect to websites using authentication.

You can connect to websites using basic authentication of user name and password. You use a secret in AWS Secrets Manager to store your authentication credentials.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

crawlDepth number

The 'depth' or number of levels from the seed level to crawl. For example, the seed URL page is depth 1 and any hyperlinks on this page that are also crawled are depth 2.

maxContentSizePerPageInMegaBytes number

The maximum size (in MB) of a web page or attachment to crawl.

Files larger than this size (in MB) are skipped/not crawled.

The default maximum size of a web page or attachment is set to 50 MB.

maxLinksPerPage number

The maximum number of URLs on a web page to include when crawling a website. This number is per web page.

As a website’s web pages are crawled, any URLs the web pages link to are also crawled. URLs on a web page are crawled in order of appearance.

The default maximum links per page is 100.

maxUrlsPerMinuteCrawlRate number

The maximum number of URLs crawled per website host per minute.

A minimum of one URL is required.

The default maximum number of URLs crawled per website host per minute is 300.

proxyConfiguration DataSourceProxyConfiguration

Configuration information required to connect to your internal websites via a web proxy.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in AWS Secrets Manager .

urlExclusionPatterns string[]

urlInclusionPatterns string[]

urls DataSourceWebCrawlerUrls

Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.

You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.

authentication_configuration DataSourceWebCrawlerAuthenticationConfiguration

Configuration information required to connect to websites using authentication.

You can connect to websites using basic authentication of user name and password. You use a secret in AWS Secrets Manager to store your authentication credentials.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

crawl_depth int

The 'depth' or number of levels from the seed level to crawl. For example, the seed URL page is depth 1 and any hyperlinks on this page that are also crawled are depth 2.

max_content_size_per_page_in_mega_bytes float

The maximum size (in MB) of a web page or attachment to crawl.

Files larger than this size (in MB) are skipped/not crawled.

The default maximum size of a web page or attachment is set to 50 MB.

max_links_per_page int

The maximum number of URLs on a web page to include when crawling a website. This number is per web page.

As a website’s web pages are crawled, any URLs the web pages link to are also crawled. URLs on a web page are crawled in order of appearance.

The default maximum links per page is 100.

max_urls_per_minute_crawl_rate int

The maximum number of URLs crawled per website host per minute.

A minimum of one URL is required.

The default maximum number of URLs crawled per website host per minute is 300.

proxy_configuration DataSourceProxyConfiguration

Configuration information required to connect to your internal websites via a web proxy.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in AWS Secrets Manager .

url_exclusion_patterns Sequence[str]

url_inclusion_patterns Sequence[str]

urls Property Map

Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.

You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.

authenticationConfiguration Property Map

Configuration information required to connect to websites using authentication.

You can connect to websites using basic authentication of user name and password. You use a secret in AWS Secrets Manager to store your authentication credentials.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

crawlDepth Number

The 'depth' or number of levels from the seed level to crawl. For example, the seed URL page is depth 1 and any hyperlinks on this page that are also crawled are depth 2.

maxContentSizePerPageInMegaBytes Number

The maximum size (in MB) of a web page or attachment to crawl.

Files larger than this size (in MB) are skipped/not crawled.

The default maximum size of a web page or attachment is set to 50 MB.

maxLinksPerPage Number

The maximum number of URLs on a web page to include when crawling a website. This number is per web page.

As a website’s web pages are crawled, any URLs the web pages link to are also crawled. URLs on a web page are crawled in order of appearance.

The default maximum links per page is 100.

maxUrlsPerMinuteCrawlRate Number

The maximum number of URLs crawled per website host per minute.

A minimum of one URL is required.

The default maximum number of URLs crawled per website host per minute is 300.

proxyConfiguration Property Map

Configuration information required to connect to your internal websites via a web proxy.

You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in AWS Secrets Manager .

urlExclusionPatterns List<String>

urlInclusionPatterns List<String>

DataSourceWebCrawlerSeedUrlConfiguration

SeedUrls List<string>

The list of seed or starting point URLs of the websites you want to crawl.

The list can include a maximum of 100 seed URLs.

WebCrawlerMode Pulumi.AwsNative.Kendra.DataSourceWebCrawlerSeedUrlConfigurationWebCrawlerMode

You can choose one of the following modes:

HOST_ONLY —crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.
SUBDOMAINS —crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.
EVERYTHING —crawl the website host names with subdomains and other domains that the web pages link to.

The default mode is set to HOST_ONLY .

SeedUrls []string

The list of seed or starting point URLs of the websites you want to crawl.

The list can include a maximum of 100 seed URLs.

WebCrawlerMode DataSourceWebCrawlerSeedUrlConfigurationWebCrawlerMode

You can choose one of the following modes:

HOST_ONLY —crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.
SUBDOMAINS —crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.
EVERYTHING —crawl the website host names with subdomains and other domains that the web pages link to.

The default mode is set to HOST_ONLY .

seedUrls List<String>

The list of seed or starting point URLs of the websites you want to crawl.

The list can include a maximum of 100 seed URLs.

webCrawlerMode DataSourceWebCrawlerSeedUrlConfigurationWebCrawlerMode

You can choose one of the following modes:

HOST_ONLY —crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.
SUBDOMAINS —crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.
EVERYTHING —crawl the website host names with subdomains and other domains that the web pages link to.

The default mode is set to HOST_ONLY .

seedUrls string[]

The list of seed or starting point URLs of the websites you want to crawl.

The list can include a maximum of 100 seed URLs.

webCrawlerMode DataSourceWebCrawlerSeedUrlConfigurationWebCrawlerMode

You can choose one of the following modes:

HOST_ONLY —crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.
SUBDOMAINS —crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.
EVERYTHING —crawl the website host names with subdomains and other domains that the web pages link to.

The default mode is set to HOST_ONLY .

seed_urls Sequence[str]

The list of seed or starting point URLs of the websites you want to crawl.

The list can include a maximum of 100 seed URLs.

web_crawler_mode DataSourceWebCrawlerSeedUrlConfigurationWebCrawlerMode

You can choose one of the following modes:

HOST_ONLY —crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.
SUBDOMAINS —crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.
EVERYTHING —crawl the website host names with subdomains and other domains that the web pages link to.

The default mode is set to HOST_ONLY .

seedUrls List<String>

The list of seed or starting point URLs of the websites you want to crawl.

The list can include a maximum of 100 seed URLs.

webCrawlerMode "HOST_ONLY" | "SUBDOMAINS" | "EVERYTHING"

You can choose one of the following modes:

HOST_ONLY —crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.
SUBDOMAINS —crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.
EVERYTHING —crawl the website host names with subdomains and other domains that the web pages link to.

The default mode is set to HOST_ONLY .

DataSourceWebCrawlerSeedUrlConfigurationWebCrawlerMode

DataSourceWebCrawlerSiteMapsConfiguration

SiteMaps List<string>

The list of sitemap URLs of the websites you want to crawl.

The list can include a maximum of three sitemap URLs.

SiteMaps []string

The list of sitemap URLs of the websites you want to crawl.

The list can include a maximum of three sitemap URLs.

siteMaps List<String>

The list of sitemap URLs of the websites you want to crawl.

The list can include a maximum of three sitemap URLs.

siteMaps string[]

The list of sitemap URLs of the websites you want to crawl.

The list can include a maximum of three sitemap URLs.

site_maps Sequence[str]

The list of sitemap URLs of the websites you want to crawl.

The list can include a maximum of three sitemap URLs.

siteMaps List<String>

The list of sitemap URLs of the websites you want to crawl.

The list can include a maximum of three sitemap URLs.

DataSourceWebCrawlerUrls

SeedUrlConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceWebCrawlerSeedUrlConfiguration

Configuration of the seed or starting point URLs of the websites you want to crawl.

You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the web pages link to.

You can list up to 100 seed URLs.

SiteMapsConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceWebCrawlerSiteMapsConfiguration

Configuration of the sitemap URLs of the websites you want to crawl.

Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.

SeedUrlConfiguration DataSourceWebCrawlerSeedUrlConfiguration

Configuration of the seed or starting point URLs of the websites you want to crawl.

You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the web pages link to.

You can list up to 100 seed URLs.

SiteMapsConfiguration DataSourceWebCrawlerSiteMapsConfiguration

Configuration of the sitemap URLs of the websites you want to crawl.

Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.

seedUrlConfiguration DataSourceWebCrawlerSeedUrlConfiguration

Configuration of the seed or starting point URLs of the websites you want to crawl.

You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the web pages link to.

You can list up to 100 seed URLs.

siteMapsConfiguration DataSourceWebCrawlerSiteMapsConfiguration

Configuration of the sitemap URLs of the websites you want to crawl.

Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.

seedUrlConfiguration DataSourceWebCrawlerSeedUrlConfiguration

Configuration of the seed or starting point URLs of the websites you want to crawl.

You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the web pages link to.

You can list up to 100 seed URLs.

siteMapsConfiguration DataSourceWebCrawlerSiteMapsConfiguration

Configuration of the sitemap URLs of the websites you want to crawl.

Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.

seed_url_configuration DataSourceWebCrawlerSeedUrlConfiguration

Configuration of the seed or starting point URLs of the websites you want to crawl.

You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the web pages link to.

You can list up to 100 seed URLs.

site_maps_configuration DataSourceWebCrawlerSiteMapsConfiguration

Configuration of the sitemap URLs of the websites you want to crawl.

Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.

seedUrlConfiguration Property Map

Configuration of the seed or starting point URLs of the websites you want to crawl.

You can choose to crawl only the website host names, or the website host names with subdomains, or the website host names with subdomains and other domains that the web pages link to.

You can list up to 100 seed URLs.

siteMapsConfiguration Property Map

Configuration of the sitemap URLs of the websites you want to crawl.

Only URLs belonging to the same website host names are crawled. You can list up to three sitemap URLs.

DataSourceWorkDocsConfiguration

OrganizationId string

The identifier of the directory corresponding to your Amazon WorkDocs site repository.

You can find the organization ID in the AWS Directory Service by going to Active Directory , then Directories . Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the AWS Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.

CrawlComments bool

TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.

The default is set to FALSE .

ExclusionPatterns List<string>

A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

FieldMappings List<Pulumi.AwsNative.Kendra.Inputs.DataSourceToIndexFieldMapping>

A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields . The Amazon WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.

InclusionPatterns List<string>

A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

UseChangeLog bool

TRUE to use the Amazon WorkDocs change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Amazon WorkDocs.

OrganizationId string

The identifier of the directory corresponding to your Amazon WorkDocs site repository.

CrawlComments bool