1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. kendra
  5. DataSource

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.kendra.DataSource

Explore with Pulumi AI

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Kendra DataSource

Create DataSource Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DataSource(name: string, args: DataSourceArgs, opts?: CustomResourceOptions);
@overload
def DataSource(resource_name: str,
               args: DataSourceArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def DataSource(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               index_id: Optional[str] = None,
               type: Optional[DataSourceType] = None,
               custom_document_enrichment_configuration: Optional[DataSourceCustomDocumentEnrichmentConfigurationArgs] = None,
               data_source_configuration: Optional[DataSourceConfigurationArgs] = None,
               description: Optional[str] = None,
               language_code: Optional[str] = None,
               name: Optional[str] = None,
               role_arn: Optional[str] = None,
               schedule: Optional[str] = None,
               tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewDataSource(ctx *Context, name string, args DataSourceArgs, opts ...ResourceOption) (*DataSource, error)
public DataSource(string name, DataSourceArgs args, CustomResourceOptions? opts = null)
public DataSource(String name, DataSourceArgs args)
public DataSource(String name, DataSourceArgs args, CustomResourceOptions options)
type: aws-native:kendra:DataSource
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DataSourceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DataSourceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DataSourceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DataSourceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DataSourceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DataSource Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DataSource resource accepts the following input properties:

IndexId This property is required. string
The identifier of the index you want to use with the data source connector.
Type This property is required. Pulumi.AwsNative.Kendra.DataSourceType
The type of the data source.
CustomDocumentEnrichmentConfiguration Pulumi.AwsNative.Kendra.Inputs.DataSourceCustomDocumentEnrichmentConfiguration
Configuration information for altering document metadata and content during the document ingestion process.
DataSourceConfiguration Pulumi.AwsNative.Kendra.Inputs.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.
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.Inputs.Tag>
Tags for labeling the data source
IndexId This property is required. string
The identifier of the index you want to use with the data source connector.
Type This property is required. DataSourceType
The type of the data source.
CustomDocumentEnrichmentConfiguration DataSourceCustomDocumentEnrichmentConfigurationArgs
Configuration information for altering document metadata and content during the document ingestion process.
DataSourceConfiguration DataSourceConfigurationArgs

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.
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 TagArgs
Tags for labeling the data source
indexId This property is required. String
The identifier of the index you want to use with the data source connector.
type This property is required. DataSourceType
The type of the data source.
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.
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<Tag>
Tags for labeling the data source
indexId This property is required. string
The identifier of the index you want to use with the data source connector.
type This property is required. DataSourceType
The type of the data source.
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.
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 Tag[]
Tags for labeling the data source
index_id This property is required. str
The identifier of the index you want to use with the data source connector.
type This property is required. DataSourceType
The type of the data source.
custom_document_enrichment_configuration DataSourceCustomDocumentEnrichmentConfigurationArgs
Configuration information for altering document metadata and content during the document ingestion process.
data_source_configuration DataSourceConfigurationArgs

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.
language_code str
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 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[TagArgs]
Tags for labeling the data source
indexId This property is required. String
The identifier of the index you want to use with the data source connector.
type This property is required. "S3" | "SHAREPOINT" | "SALESFORCE" | "ONEDRIVE" | "SERVICENOW" | "DATABASE" | "CUSTOM" | "CONFLUENCE" | "GOOGLEDRIVE" | "WEBCRAWLER" | "WORKDOCS"
The type of the data source.
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.
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<Property Map>
Tags for labeling the data source

Outputs

All input properties are implicitly available as output properties. Additionally, the DataSource resource produces the following output properties:

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

AwsId string

The identifier for the data source. For example:

b8cae438-6787-4091-8897-684a652bbb0a .

Id string
The provider-assigned unique ID for this managed resource.
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

AwsId string

The identifier for the data source. For example:

b8cae438-6787-4091-8897-684a652bbb0a .

Id string
The provider-assigned unique ID for this managed resource.
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

awsId String

The identifier for the data source. For example:

b8cae438-6787-4091-8897-684a652bbb0a .

id String
The provider-assigned unique ID for this managed resource.
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

awsId string

The identifier for the data source. For example:

b8cae438-6787-4091-8897-684a652bbb0a .

id string
The provider-assigned unique ID for this managed resource.
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

aws_id str

The identifier for the data source. For example:

b8cae438-6787-4091-8897-684a652bbb0a .

id str
The provider-assigned unique ID for this managed resource.
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

awsId String

The identifier for the data source. For example:

b8cae438-6787-4091-8897-684a652bbb0a .

id String
The provider-assigned unique ID for this managed resource.

Supporting Types

DataSourceAccessControlListConfiguration
, DataSourceAccessControlListConfigurationArgs

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
, DataSourceAclConfigurationArgs

AllowedGroupsColumnName This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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
, DataSourceColumnConfigurationArgs

ChangeDetectingColumns This property is required. List<string>
One to five columns that indicate when a document in the database has changed.
DocumentDataColumnName This property is required. string
The column that contains the contents of the document.
DocumentIdColumnName This property is required. 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 This property is required. []string
One to five columns that indicate when a document in the database has changed.
DocumentDataColumnName This property is required. string
The column that contains the contents of the document.
DocumentIdColumnName This property is required. 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 This property is required. List<String>
One to five columns that indicate when a document in the database has changed.
documentDataColumnName This property is required. String
The column that contains the contents of the document.
documentIdColumnName This property is required. 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 This property is required. string[]
One to five columns that indicate when a document in the database has changed.
documentDataColumnName This property is required. string
The column that contains the contents of the document.
documentIdColumnName This property is required. 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 This property is required. Sequence[str]
One to five columns that indicate when a document in the database has changed.
document_data_column_name This property is required. str
The column that contains the contents of the document.
document_id_column_name This property is required. 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 This property is required. List<String>
One to five columns that indicate when a document in the database has changed.
documentDataColumnName This property is required. String
The column that contains the contents of the document.
documentIdColumnName This property is required. 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
, DataSourceConditionOperatorArgs

GreaterThan
GreaterThan
GreaterThanOrEquals
GreaterThanOrEquals
LessThan
LessThan
LessThanOrEquals
LessThanOrEquals
EqualsValue
Equals
NotEquals
NotEquals
Contains
Contains
NotContains
NotContains
Exists
Exists
NotExists
NotExists
BeginsWith
BeginsWith
DataSourceConditionOperatorGreaterThan
GreaterThan
DataSourceConditionOperatorGreaterThanOrEquals
GreaterThanOrEquals
DataSourceConditionOperatorLessThan
LessThan
DataSourceConditionOperatorLessThanOrEquals
LessThanOrEquals
DataSourceConditionOperatorEquals
Equals
DataSourceConditionOperatorNotEquals
NotEquals
DataSourceConditionOperatorContains
Contains
DataSourceConditionOperatorNotContains
NotContains
DataSourceConditionOperatorExists
Exists
DataSourceConditionOperatorNotExists
NotExists
DataSourceConditionOperatorBeginsWith
BeginsWith
GreaterThan
GreaterThan
GreaterThanOrEquals
GreaterThanOrEquals
LessThan
LessThan
LessThanOrEquals
LessThanOrEquals
Equals
Equals
NotEquals
NotEquals
Contains
Contains
NotContains
NotContains
Exists
Exists
NotExists
NotExists
BeginsWith
BeginsWith
GreaterThan
GreaterThan
GreaterThanOrEquals
GreaterThanOrEquals
LessThan
LessThan
LessThanOrEquals
LessThanOrEquals
Equals
Equals
NotEquals
NotEquals
Contains
Contains
NotContains
NotContains
Exists
Exists
NotExists
NotExists
BeginsWith
BeginsWith
GREATER_THAN
GreaterThan
GREATER_THAN_OR_EQUALS
GreaterThanOrEquals
LESS_THAN
LessThan
LESS_THAN_OR_EQUALS
LessThanOrEquals
EQUALS
Equals
NOT_EQUALS
NotEquals
CONTAINS
Contains
NOT_CONTAINS
NotContains
EXISTS
Exists
NOT_EXISTS
NotExists
BEGINS_WITH
BeginsWith
"GreaterThan"
GreaterThan
"GreaterThanOrEquals"
GreaterThanOrEquals
"LessThan"
LessThan
"LessThanOrEquals"
LessThanOrEquals
"Equals"
Equals
"NotEquals"
NotEquals
"Contains"
Contains
"NotContains"
NotContains
"Exists"
Exists
"NotExists"
NotExists
"BeginsWith"
BeginsWith

DataSourceConfiguration
, DataSourceConfigurationArgs

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
, DataSourceConfluenceAttachmentConfigurationArgs

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

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 List<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 Boolean
TRUE to index attachments of pages and blogs in Confluence.
attachmentFieldMappings 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 boolean
TRUE to index attachments of pages and blogs in Confluence.
attachment_field_mappings Sequence[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.

crawl_attachments bool
TRUE to index attachments of pages and blogs in Confluence.
attachmentFieldMappings List<Property Map>

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 Boolean
TRUE to index attachments of pages and blogs in Confluence.

DataSourceConfluenceAttachmentFieldName
, DataSourceConfluenceAttachmentFieldNameArgs

Author
AUTHOR
ContentType
CONTENT_TYPE
CreatedDate
CREATED_DATE
DisplayUrl
DISPLAY_URL
FileSize
FILE_SIZE
ItemType
ITEM_TYPE
ParentId
PARENT_ID
SpaceKey
SPACE_KEY
SpaceName
SPACE_NAME
Url
URL
Version
VERSION
DataSourceConfluenceAttachmentFieldNameAuthor
AUTHOR
DataSourceConfluenceAttachmentFieldNameContentType
CONTENT_TYPE
DataSourceConfluenceAttachmentFieldNameCreatedDate
CREATED_DATE
DataSourceConfluenceAttachmentFieldNameDisplayUrl
DISPLAY_URL
DataSourceConfluenceAttachmentFieldNameFileSize
FILE_SIZE
DataSourceConfluenceAttachmentFieldNameItemType
ITEM_TYPE
DataSourceConfluenceAttachmentFieldNameParentId
PARENT_ID
DataSourceConfluenceAttachmentFieldNameSpaceKey
SPACE_KEY
DataSourceConfluenceAttachmentFieldNameSpaceName
SPACE_NAME
DataSourceConfluenceAttachmentFieldNameUrl
URL
DataSourceConfluenceAttachmentFieldNameVersion
VERSION
Author
AUTHOR
ContentType
CONTENT_TYPE
CreatedDate
CREATED_DATE
DisplayUrl
DISPLAY_URL
FileSize
FILE_SIZE
ItemType
ITEM_TYPE
ParentId
PARENT_ID
SpaceKey
SPACE_KEY
SpaceName
SPACE_NAME
Url
URL
Version
VERSION
Author
AUTHOR
ContentType
CONTENT_TYPE
CreatedDate
CREATED_DATE
DisplayUrl
DISPLAY_URL
FileSize
FILE_SIZE
ItemType
ITEM_TYPE
ParentId
PARENT_ID
SpaceKey
SPACE_KEY
SpaceName
SPACE_NAME
Url
URL
Version
VERSION
AUTHOR
AUTHOR
CONTENT_TYPE
CONTENT_TYPE
CREATED_DATE
CREATED_DATE
DISPLAY_URL
DISPLAY_URL
FILE_SIZE
FILE_SIZE
ITEM_TYPE
ITEM_TYPE
PARENT_ID
PARENT_ID
SPACE_KEY
SPACE_KEY
SPACE_NAME
SPACE_NAME
URL
URL
VERSION
VERSION
"AUTHOR"
AUTHOR
"CONTENT_TYPE"
CONTENT_TYPE
"CREATED_DATE"
CREATED_DATE
"DISPLAY_URL"
DISPLAY_URL
"FILE_SIZE"
FILE_SIZE
"ITEM_TYPE"
ITEM_TYPE
"PARENT_ID"
PARENT_ID
"SPACE_KEY"
SPACE_KEY
"SPACE_NAME"
SPACE_NAME
"URL"
URL
"VERSION"
VERSION

DataSourceConfluenceAttachmentToIndexFieldMapping
, DataSourceConfluenceAttachmentToIndexFieldMappingArgs

DataSourceFieldName This property is required. DataSourceConfluenceAttachmentFieldName
IndexFieldName This property is required. string
DateFieldFormat string
dataSourceFieldName This property is required. DataSourceConfluenceAttachmentFieldName
indexFieldName This property is required. String
dateFieldFormat String
dataSourceFieldName This property is required. DataSourceConfluenceAttachmentFieldName
indexFieldName This property is required. string
dateFieldFormat string
data_source_field_name This property is required. DataSourceConfluenceAttachmentFieldName
index_field_name This property is required. str
date_field_format str

DataSourceConfluenceBlogConfiguration
, DataSourceConfluenceBlogConfigurationArgs

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

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 List<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[]

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.

blog_field_mappings Sequence[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 List<Property Map>

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.

DataSourceConfluenceBlogFieldName
, DataSourceConfluenceBlogFieldNameArgs

Author
AUTHOR
DisplayUrl
DISPLAY_URL
ItemType
ITEM_TYPE
Labels
LABELS
PublishDate
PUBLISH_DATE
SpaceKey
SPACE_KEY
SpaceName
SPACE_NAME
Url
URL
Version
VERSION
DataSourceConfluenceBlogFieldNameAuthor
AUTHOR
DataSourceConfluenceBlogFieldNameDisplayUrl
DISPLAY_URL
DataSourceConfluenceBlogFieldNameItemType
ITEM_TYPE
DataSourceConfluenceBlogFieldNameLabels
LABELS
DataSourceConfluenceBlogFieldNamePublishDate
PUBLISH_DATE
DataSourceConfluenceBlogFieldNameSpaceKey
SPACE_KEY
DataSourceConfluenceBlogFieldNameSpaceName
SPACE_NAME
DataSourceConfluenceBlogFieldNameUrl
URL
DataSourceConfluenceBlogFieldNameVersion
VERSION
Author
AUTHOR
DisplayUrl
DISPLAY_URL
ItemType
ITEM_TYPE
Labels
LABELS
PublishDate
PUBLISH_DATE
SpaceKey
SPACE_KEY
SpaceName
SPACE_NAME
Url
URL
Version
VERSION
Author
AUTHOR
DisplayUrl
DISPLAY_URL
ItemType
ITEM_TYPE
Labels
LABELS
PublishDate
PUBLISH_DATE
SpaceKey
SPACE_KEY
SpaceName
SPACE_NAME
Url
URL
Version
VERSION
AUTHOR
AUTHOR
DISPLAY_URL
DISPLAY_URL
ITEM_TYPE
ITEM_TYPE
LABELS
LABELS
PUBLISH_DATE
PUBLISH_DATE
SPACE_KEY
SPACE_KEY
SPACE_NAME
SPACE_NAME
URL
URL
VERSION
VERSION
"AUTHOR"
AUTHOR
"DISPLAY_URL"
DISPLAY_URL
"ITEM_TYPE"
ITEM_TYPE
"LABELS"
LABELS
"PUBLISH_DATE"
PUBLISH_DATE
"SPACE_KEY"
SPACE_KEY
"SPACE_NAME"
SPACE_NAME
"URL"
URL
"VERSION"
VERSION

DataSourceConfluenceBlogToIndexFieldMapping
, DataSourceConfluenceBlogToIndexFieldMappingArgs

DataSourceFieldName This property is required. DataSourceConfluenceBlogFieldName
IndexFieldName This property is required. string
DateFieldFormat string
dataSourceFieldName This property is required. DataSourceConfluenceBlogFieldName
indexFieldName This property is required. String
dateFieldFormat String
dataSourceFieldName This property is required. DataSourceConfluenceBlogFieldName
indexFieldName This property is required. string
dateFieldFormat string
data_source_field_name This property is required. DataSourceConfluenceBlogFieldName
index_field_name This property is required. str
date_field_format str

DataSourceConfluenceConfiguration
, DataSourceConfluenceConfigurationArgs

SecretArn This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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
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 []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 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 This property is required. 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 This property is required. 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 This property is required. 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>
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 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 This property is required. 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 This property is required. 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 This property is required. 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[]
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 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 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 This property is required. str

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 .

server_url This property is required. 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 This property is required. 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]
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.
inclusion_patterns Sequence[str]
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.
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 This property is required. 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 This property is required. 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 This property is required. "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>
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 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
, DataSourceConfluencePageConfigurationArgs

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

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 List<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[]

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.

page_field_mappings Sequence[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 List<Property Map>

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.

DataSourceConfluencePageFieldName
, DataSourceConfluencePageFieldNameArgs

Author
AUTHOR
ContentStatus
CONTENT_STATUS
CreatedDate
CREATED_DATE
DisplayUrl
DISPLAY_URL
ItemType
ITEM_TYPE
Labels
LABELS
ModifiedDate
MODIFIED_DATE
ParentId
PARENT_ID
SpaceKey
SPACE_KEY
SpaceName
SPACE_NAME
Url
URL
Version
VERSION
DataSourceConfluencePageFieldNameAuthor
AUTHOR
DataSourceConfluencePageFieldNameContentStatus
CONTENT_STATUS
DataSourceConfluencePageFieldNameCreatedDate
CREATED_DATE
DataSourceConfluencePageFieldNameDisplayUrl
DISPLAY_URL
DataSourceConfluencePageFieldNameItemType
ITEM_TYPE
DataSourceConfluencePageFieldNameLabels
LABELS
DataSourceConfluencePageFieldNameModifiedDate
MODIFIED_DATE
DataSourceConfluencePageFieldNameParentId
PARENT_ID
DataSourceConfluencePageFieldNameSpaceKey
SPACE_KEY
DataSourceConfluencePageFieldNameSpaceName
SPACE_NAME
DataSourceConfluencePageFieldNameUrl
URL
DataSourceConfluencePageFieldNameVersion
VERSION
Author
AUTHOR
ContentStatus
CONTENT_STATUS
CreatedDate
CREATED_DATE
DisplayUrl
DISPLAY_URL
ItemType
ITEM_TYPE
Labels
LABELS
ModifiedDate
MODIFIED_DATE
ParentId
PARENT_ID
SpaceKey
SPACE_KEY
SpaceName
SPACE_NAME
Url
URL
Version
VERSION
Author
AUTHOR
ContentStatus
CONTENT_STATUS
CreatedDate
CREATED_DATE
DisplayUrl
DISPLAY_URL
ItemType
ITEM_TYPE
Labels
LABELS
ModifiedDate
MODIFIED_DATE
ParentId
PARENT_ID
SpaceKey
SPACE_KEY
SpaceName
SPACE_NAME
Url
URL
Version
VERSION
AUTHOR
AUTHOR
CONTENT_STATUS
CONTENT_STATUS
CREATED_DATE
CREATED_DATE
DISPLAY_URL
DISPLAY_URL
ITEM_TYPE
ITEM_TYPE
LABELS
LABELS
MODIFIED_DATE
MODIFIED_DATE
PARENT_ID
PARENT_ID
SPACE_KEY
SPACE_KEY
SPACE_NAME
SPACE_NAME
URL
URL
VERSION
VERSION
"AUTHOR"
AUTHOR
"CONTENT_STATUS"
CONTENT_STATUS
"CREATED_DATE"
CREATED_DATE
"DISPLAY_URL"
DISPLAY_URL
"ITEM_TYPE"
ITEM_TYPE
"LABELS"
LABELS
"MODIFIED_DATE"
MODIFIED_DATE
"PARENT_ID"
PARENT_ID
"SPACE_KEY"
SPACE_KEY
"SPACE_NAME"
SPACE_NAME
"URL"
URL
"VERSION"
VERSION

DataSourceConfluencePageToIndexFieldMapping
, DataSourceConfluencePageToIndexFieldMappingArgs

DataSourceFieldName This property is required. DataSourceConfluencePageFieldName
IndexFieldName This property is required. string
DateFieldFormat string
dataSourceFieldName This property is required. DataSourceConfluencePageFieldName
indexFieldName This property is required. String
dateFieldFormat String
dataSourceFieldName This property is required. DataSourceConfluencePageFieldName
indexFieldName This property is required. string
dateFieldFormat string
data_source_field_name This property is required. DataSourceConfluencePageFieldName
index_field_name This property is required. str
date_field_format str

DataSourceConfluenceSpaceConfiguration
, DataSourceConfluenceSpaceConfigurationArgs

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
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 []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 []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 []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 Boolean
TRUE to index archived spaces.
crawlPersonalSpaces Boolean
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<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 boolean
TRUE to index archived spaces.
crawlPersonalSpaces boolean
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 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 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 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.

crawl_archived_spaces bool
TRUE to index archived spaces.
crawl_personal_spaces 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 .
exclude_spaces Sequence[str]
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.
include_spaces Sequence[str]
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.
space_field_mappings Sequence[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 Boolean
TRUE to index archived spaces.
crawlPersonalSpaces Boolean
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<Property Map>

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.

DataSourceConfluenceSpaceFieldName
, DataSourceConfluenceSpaceFieldNameArgs

DisplayUrl
DISPLAY_URL
ItemType
ITEM_TYPE
SpaceKey
SPACE_KEY
Url
URL
DataSourceConfluenceSpaceFieldNameDisplayUrl
DISPLAY_URL
DataSourceConfluenceSpaceFieldNameItemType
ITEM_TYPE
DataSourceConfluenceSpaceFieldNameSpaceKey
SPACE_KEY
DataSourceConfluenceSpaceFieldNameUrl
URL
DisplayUrl
DISPLAY_URL
ItemType
ITEM_TYPE
SpaceKey
SPACE_KEY
Url
URL
DisplayUrl
DISPLAY_URL
ItemType
ITEM_TYPE
SpaceKey
SPACE_KEY
Url
URL
DISPLAY_URL
DISPLAY_URL
ITEM_TYPE
ITEM_TYPE
SPACE_KEY
SPACE_KEY
URL
URL
"DISPLAY_URL"
DISPLAY_URL
"ITEM_TYPE"
ITEM_TYPE
"SPACE_KEY"
SPACE_KEY
"URL"
URL

DataSourceConfluenceSpaceToIndexFieldMapping
, DataSourceConfluenceSpaceToIndexFieldMappingArgs

DataSourceFieldName This property is required. DataSourceConfluenceSpaceFieldName
IndexFieldName This property is required. string
DateFieldFormat string
dataSourceFieldName This property is required. DataSourceConfluenceSpaceFieldName
indexFieldName This property is required. String
dateFieldFormat String
dataSourceFieldName This property is required. DataSourceConfluenceSpaceFieldName
indexFieldName This property is required. string
dateFieldFormat string
data_source_field_name This property is required. DataSourceConfluenceSpaceFieldName
index_field_name This property is required. str
date_field_format str
dataSourceFieldName This property is required. "DISPLAY_URL" | "ITEM_TYPE" | "SPACE_KEY" | "URL"
indexFieldName This property is required. String
dateFieldFormat String

DataSourceConfluenceVersion
, DataSourceConfluenceVersionArgs

Cloud
CLOUD
Server
SERVER
DataSourceConfluenceVersionCloud
CLOUD
DataSourceConfluenceVersionServer
SERVER
Cloud
CLOUD
Server
SERVER
Cloud
CLOUD
Server
SERVER
CLOUD
CLOUD
SERVER
SERVER
"CLOUD"
CLOUD
"SERVER"
SERVER

DataSourceConnectionConfiguration
, DataSourceConnectionConfigurationArgs

DatabaseHost This property is required. 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 This property is required. string
The name of the database containing the document data.
DatabasePort This property is required. int
The port that the database uses for connections.
SecretArn This property is required. 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 This property is required. string
The name of the table that contains the document data.
DatabaseHost This property is required. 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 This property is required. string
The name of the database containing the document data.
DatabasePort This property is required. int
The port that the database uses for connections.
SecretArn This property is required. 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 This property is required. string
The name of the table that contains the document data.
databaseHost This property is required. 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 This property is required. String
The name of the database containing the document data.
databasePort This property is required. Integer
The port that the database uses for connections.
secretArn This property is required. 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 This property is required. String
The name of the table that contains the document data.
databaseHost This property is required. 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 This property is required. string
The name of the database containing the document data.
databasePort This property is required. number
The port that the database uses for connections.
secretArn This property is required. 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 This property is required. string
The name of the table that contains the document data.
database_host This property is required. 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 This property is required. str
The name of the database containing the document data.
database_port This property is required. int
The port that the database uses for connections.
secret_arn This property is required. 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 This property is required. str
The name of the table that contains the document data.
databaseHost This property is required. 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 This property is required. String
The name of the database containing the document data.
databasePort This property is required. Number
The port that the database uses for connections.
secretArn This property is required. 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 This property is required. String
The name of the table that contains the document data.

DataSourceCustomDocumentEnrichmentConfiguration
, DataSourceCustomDocumentEnrichmentConfigurationArgs

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
, DataSourceDatabaseConfigurationArgs

ColumnConfiguration This property is required. Pulumi.AwsNative.Kendra.Inputs.DataSourceColumnConfiguration
Information about where the index should get the document information from the database.
ConnectionConfiguration This property is required. Pulumi.AwsNative.Kendra.Inputs.DataSourceConnectionConfiguration
Configuration information that's required to connect to a database.
DatabaseEngineType This property is required. 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 This property is required. DataSourceColumnConfiguration
Information about where the index should get the document information from the database.
ConnectionConfiguration This property is required. DataSourceConnectionConfiguration
Configuration information that's required to connect to a database.
DatabaseEngineType This property is required. 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 This property is required. DataSourceColumnConfiguration
Information about where the index should get the document information from the database.
connectionConfiguration This property is required. DataSourceConnectionConfiguration
Configuration information that's required to connect to a database.
databaseEngineType This property is required. 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 This property is required. DataSourceColumnConfiguration
Information about where the index should get the document information from the database.
connectionConfiguration This property is required. DataSourceConnectionConfiguration
Configuration information that's required to connect to a database.
databaseEngineType This property is required. 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 This property is required. DataSourceColumnConfiguration
Information about where the index should get the document information from the database.
connection_configuration This property is required. DataSourceConnectionConfiguration
Configuration information that's required to connect to a database.
database_engine_type This property is required. 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 This property is required. Property Map
Information about where the index should get the document information from the database.
connectionConfiguration This property is required. Property Map
Configuration information that's required to connect to a database.
databaseEngineType This property is required. "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
, DataSourceDatabaseEngineTypeArgs

RdsAuroraMysql
RDS_AURORA_MYSQL
RdsAuroraPostgresql
RDS_AURORA_POSTGRESQL
RdsMysql
RDS_MYSQL
RdsPostgresql
RDS_POSTGRESQL
DataSourceDatabaseEngineTypeRdsAuroraMysql
RDS_AURORA_MYSQL
DataSourceDatabaseEngineTypeRdsAuroraPostgresql
RDS_AURORA_POSTGRESQL
DataSourceDatabaseEngineTypeRdsMysql
RDS_MYSQL
DataSourceDatabaseEngineTypeRdsPostgresql
RDS_POSTGRESQL
RdsAuroraMysql
RDS_AURORA_MYSQL
RdsAuroraPostgresql
RDS_AURORA_POSTGRESQL
RdsMysql
RDS_MYSQL
RdsPostgresql
RDS_POSTGRESQL
RdsAuroraMysql
RDS_AURORA_MYSQL
RdsAuroraPostgresql
RDS_AURORA_POSTGRESQL
RdsMysql
RDS_MYSQL
RdsPostgresql
RDS_POSTGRESQL
RDS_AURORA_MYSQL
RDS_AURORA_MYSQL
RDS_AURORA_POSTGRESQL
RDS_AURORA_POSTGRESQL
RDS_MYSQL
RDS_MYSQL
RDS_POSTGRESQL
RDS_POSTGRESQL
"RDS_AURORA_MYSQL"
RDS_AURORA_MYSQL
"RDS_AURORA_POSTGRESQL"
RDS_AURORA_POSTGRESQL
"RDS_MYSQL"
RDS_MYSQL
"RDS_POSTGRESQL"
RDS_POSTGRESQL

DataSourceDocumentAttributeCondition
, DataSourceDocumentAttributeConditionArgs

ConditionDocumentAttributeKey This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. "GreaterThan" | "GreaterThanOrEquals" | "LessThan" | "LessThanOrEquals" | "Equals" | "NotEquals" | "Contains" | "NotContains" | "Exists" | "NotExists" | "BeginsWith"

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
, DataSourceDocumentAttributeTargetArgs

DataSourceDocumentAttributeValue
, DataSourceDocumentAttributeValueArgs

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.

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 []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.

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

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

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.

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.

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 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
, DataSourceDocumentsMetadataConfigurationArgs

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
, DataSourceGoogleDriveConfigurationArgs

SecretArn This property is required. 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 This property is required. 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 []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
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 []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 []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 This property is required. 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<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 This property is required. 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 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[]
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 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 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.
secret_arn This property is required. str
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 .
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]
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.
field_mappings Sequence[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.
inclusion_patterns Sequence[str]
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 This property is required. 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<Property Map>
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.

DataSourceHookConfiguration
, DataSourceHookConfigurationArgs

LambdaArn This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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
, DataSourceInlineCustomDocumentEnrichmentConfigurationArgs

DataSourceOneDriveConfiguration
, DataSourceOneDriveConfigurationArgs

OneDriveUsers This property is required. Pulumi.AwsNative.Kendra.Inputs.DataSourceOneDriveUsers
A list of user accounts whose documents should be indexed.
SecretArn This property is required. 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 This property is required. 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 This property is required. DataSourceOneDriveUsers
A list of user accounts whose documents should be indexed.
SecretArn This property is required. 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 This property is required. string
The Azure Active Directory domain of the organization.
DisableLocalGroups bool
TRUE to disable local groups information.
ExclusionPatterns []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 []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 []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 This property is required. DataSourceOneDriveUsers
A list of user accounts whose documents should be indexed.
secretArn This property is required. 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 This property is required. String
The Azure Active Directory domain of the organization.
disableLocalGroups Boolean
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<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 This property is required. DataSourceOneDriveUsers
A list of user accounts whose documents should be indexed.
secretArn This property is required. 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 This property is required. string
The Azure Active Directory domain of the organization.
disableLocalGroups boolean
TRUE to disable local groups information.
exclusionPatterns 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 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 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.

one_drive_users This property is required. DataSourceOneDriveUsers
A list of user accounts whose documents should be indexed.
secret_arn This property is required. str
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.
tenant_domain This property is required. str
The Azure Active Directory domain of the organization.
disable_local_groups bool
TRUE to disable local groups information.
exclusion_patterns Sequence[str]

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.

field_mappings Sequence[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.
inclusion_patterns Sequence[str]

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 This property is required. Property Map
A list of user accounts whose documents should be indexed.
secretArn This property is required. 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 This property is required. String
The Azure Active Directory domain of the organization.
disableLocalGroups Boolean
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<Property Map>
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.

DataSourceOneDriveUsers
, DataSourceOneDriveUsersArgs

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
, DataSourceProxyConfigurationArgs

Host This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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

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 This property is required. 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 This property is required. 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

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 This property is required. 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 This property is required. 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

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 This property is required. 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 This property is required. 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

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.

DataSourceQueryIdentifiersEnclosingOption
, DataSourceQueryIdentifiersEnclosingOptionArgs

DoubleQuotes
DOUBLE_QUOTES
None
NONE
DataSourceQueryIdentifiersEnclosingOptionDoubleQuotes
DOUBLE_QUOTES
DataSourceQueryIdentifiersEnclosingOptionNone
NONE
DoubleQuotes
DOUBLE_QUOTES
None
NONE
DoubleQuotes
DOUBLE_QUOTES
None
NONE
DOUBLE_QUOTES
DOUBLE_QUOTES
NONE
NONE
"DOUBLE_QUOTES"
DOUBLE_QUOTES
"NONE"
NONE

DataSourceS3DataSourceConfiguration
, DataSourceS3DataSourceConfigurationArgs

BucketName This property is required. 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 This property is required. 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
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 []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 []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 []string
A list of S3 prefixes for the documents that should be included in the index.
bucketName This property is required. 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
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 This property is required. 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
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 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 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 string[]
A list of S3 prefixes for the documents that should be included in the index.
bucket_name This property is required. 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
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.
exclusion_patterns Sequence[str]

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.

inclusion_patterns Sequence[str]

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.

inclusion_prefixes Sequence[str]
A list of S3 prefixes for the documents that should be included in the index.
bucketName This property is required. 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
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.

DataSourceS3Path
, DataSourceS3PathArgs

Bucket This property is required. string
The name of the S3 bucket that contains the file.
Key This property is required. string
The name of the file.
Bucket This property is required. string
The name of the S3 bucket that contains the file.
Key This property is required. string
The name of the file.
bucket This property is required. String
The name of the S3 bucket that contains the file.
key This property is required. String
The name of the file.
bucket This property is required. string
The name of the S3 bucket that contains the file.
key This property is required. string
The name of the file.
bucket This property is required. str
The name of the S3 bucket that contains the file.
key This property is required. str
The name of the file.
bucket This property is required. String
The name of the S3 bucket that contains the file.
key This property is required. String
The name of the file.

DataSourceSalesforceChatterFeedConfiguration
, DataSourceSalesforceChatterFeedConfigurationArgs

DocumentDataFieldName This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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
, DataSourceSalesforceChatterFeedIncludeFilterTypeArgs

ActiveUser
ACTIVE_USER
StandardUser
STANDARD_USER
DataSourceSalesforceChatterFeedIncludeFilterTypeActiveUser
ACTIVE_USER
DataSourceSalesforceChatterFeedIncludeFilterTypeStandardUser
STANDARD_USER
ActiveUser
ACTIVE_USER
StandardUser
STANDARD_USER
ActiveUser
ACTIVE_USER
StandardUser
STANDARD_USER
ACTIVE_USER
ACTIVE_USER
STANDARD_USER
STANDARD_USER
"ACTIVE_USER"
ACTIVE_USER
"STANDARD_USER"
STANDARD_USER

DataSourceSalesforceConfiguration
, DataSourceSalesforceConfigurationArgs

SecretArn This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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

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 []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 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 DataSourceSalesforceStandardObjectAttachmentConfiguration
Configuration information for processing attachments to Salesforce standard objects.
StandardObjectConfigurations []DataSourceSalesforceStandardObjectConfiguration
Configuration of the Salesforce standard objects that Amazon Kendra indexes.
secretArn This property is required. 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 This property is required. 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>

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 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 DataSourceSalesforceStandardObjectAttachmentConfiguration
Configuration information for processing attachments to Salesforce standard objects.
standardObjectConfigurations List<DataSourceSalesforceStandardObjectConfiguration>
Configuration of the Salesforce standard objects that Amazon Kendra indexes.
secretArn This property is required. 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 This property is required. 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[]

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 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 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 DataSourceSalesforceStandardObjectAttachmentConfiguration
Configuration information for processing attachments to Salesforce standard objects.
standardObjectConfigurations DataSourceSalesforceStandardObjectConfiguration[]
Configuration of the Salesforce standard objects that Amazon Kendra indexes.
secret_arn This property is required. str
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.
server_url This property is required. 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]

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.

include_attachment_file_patterns Sequence[str]

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.

knowledge_article_configuration 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.
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 This property is required. 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 This property is required. 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>

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 Property Map
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 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
, DataSourceSalesforceCustomKnowledgeArticleTypeConfigurationArgs

DocumentDataFieldName This property is required. string
Name This property is required. string
DocumentTitleFieldName string
FieldMappings []DataSourceToIndexFieldMapping
documentDataFieldName This property is required. String
name This property is required. String
documentTitleFieldName String
fieldMappings List<DataSourceToIndexFieldMapping>
documentDataFieldName This property is required. string
name This property is required. string
documentTitleFieldName string
fieldMappings DataSourceToIndexFieldMapping[]
documentDataFieldName This property is required. String
name This property is required. String
documentTitleFieldName String
fieldMappings List<Property Map>

DataSourceSalesforceKnowledgeArticleConfiguration
, DataSourceSalesforceKnowledgeArticleConfigurationArgs

IncludedStates This property is required. 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 This property is required. []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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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
, DataSourceSalesforceKnowledgeArticleStateArgs

Draft
DRAFT
Published
PUBLISHED
Archived
ARCHIVED
DataSourceSalesforceKnowledgeArticleStateDraft
DRAFT
DataSourceSalesforceKnowledgeArticleStatePublished
PUBLISHED
DataSourceSalesforceKnowledgeArticleStateArchived
ARCHIVED
Draft
DRAFT
Published
PUBLISHED
Archived
ARCHIVED
Draft
DRAFT
Published
PUBLISHED
Archived
ARCHIVED
DRAFT
DRAFT
PUBLISHED
PUBLISHED
ARCHIVED
ARCHIVED
"DRAFT"
DRAFT
"PUBLISHED"
PUBLISHED
"ARCHIVED"
ARCHIVED

DataSourceSalesforceStandardKnowledgeArticleTypeConfiguration
, DataSourceSalesforceStandardKnowledgeArticleTypeConfigurationArgs

DocumentDataFieldName This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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
, DataSourceSalesforceStandardObjectAttachmentConfigurationArgs

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
, DataSourceSalesforceStandardObjectConfigurationArgs

DataSourceSalesforceStandardObjectName
, DataSourceSalesforceStandardObjectNameArgs

Account
ACCOUNT
Campaign
CAMPAIGN
Case
CASE
Contact
CONTACT
Contract
CONTRACT
Document
DOCUMENT
Group
GROUP
Idea
IDEA
Lead
LEAD
Opportunity
OPPORTUNITY
Partner
PARTNER
Pricebook
PRICEBOOK
Product
PRODUCT
Profile
PROFILE
Solution
SOLUTION
Task
TASK
User
USER
DataSourceSalesforceStandardObjectNameAccount
ACCOUNT
DataSourceSalesforceStandardObjectNameCampaign
CAMPAIGN
DataSourceSalesforceStandardObjectNameCase
CASE
DataSourceSalesforceStandardObjectNameContact
CONTACT
DataSourceSalesforceStandardObjectNameContract
CONTRACT
DataSourceSalesforceStandardObjectNameDocument
DOCUMENT
DataSourceSalesforceStandardObjectNameGroup
GROUP
DataSourceSalesforceStandardObjectNameIdea
IDEA
DataSourceSalesforceStandardObjectNameLead
LEAD
DataSourceSalesforceStandardObjectNameOpportunity
OPPORTUNITY
DataSourceSalesforceStandardObjectNamePartner
PARTNER
DataSourceSalesforceStandardObjectNamePricebook
PRICEBOOK
DataSourceSalesforceStandardObjectNameProduct
PRODUCT
DataSourceSalesforceStandardObjectNameProfile
PROFILE
DataSourceSalesforceStandardObjectNameSolution
SOLUTION
DataSourceSalesforceStandardObjectNameTask
TASK
DataSourceSalesforceStandardObjectNameUser
USER
Account
ACCOUNT
Campaign
CAMPAIGN
Case
CASE
Contact
CONTACT
Contract
CONTRACT
Document
DOCUMENT
Group
GROUP
Idea
IDEA
Lead
LEAD
Opportunity
OPPORTUNITY
Partner
PARTNER
Pricebook
PRICEBOOK
Product
PRODUCT
Profile
PROFILE
Solution
SOLUTION
Task
TASK
User
USER
Account
ACCOUNT
Campaign
CAMPAIGN
Case
CASE
Contact
CONTACT
Contract
CONTRACT
Document
DOCUMENT
Group
GROUP
Idea
IDEA
Lead
LEAD
Opportunity
OPPORTUNITY
Partner
PARTNER
Pricebook
PRICEBOOK
Product
PRODUCT
Profile
PROFILE
Solution
SOLUTION
Task
TASK
User
USER
ACCOUNT
ACCOUNT
CAMPAIGN
CAMPAIGN
CASE
CASE
CONTACT
CONTACT
CONTRACT
CONTRACT
DOCUMENT
DOCUMENT
GROUP
GROUP
IDEA
IDEA
LEAD
LEAD
OPPORTUNITY
OPPORTUNITY
PARTNER
PARTNER
PRICEBOOK
PRICEBOOK
PRODUCT
PRODUCT
PROFILE
PROFILE
SOLUTION
SOLUTION
TASK
TASK
USER
USER
"ACCOUNT"
ACCOUNT
"CAMPAIGN"
CAMPAIGN
"CASE"
CASE
"CONTACT"
CONTACT
"CONTRACT"
CONTRACT
"DOCUMENT"
DOCUMENT
"GROUP"
GROUP
"IDEA"
IDEA
"LEAD"
LEAD
"OPPORTUNITY"
OPPORTUNITY
"PARTNER"
PARTNER
"PRICEBOOK"
PRICEBOOK
"PRODUCT"
PRODUCT
"PROFILE"
PROFILE
"SOLUTION"
SOLUTION
"TASK"
TASK
"USER"
USER

DataSourceServiceNowAuthenticationType
, DataSourceServiceNowAuthenticationTypeArgs

HttpBasic
HTTP_BASIC
Oauth2
OAUTH2
DataSourceServiceNowAuthenticationTypeHttpBasic
HTTP_BASIC
DataSourceServiceNowAuthenticationTypeOauth2
OAUTH2
HttpBasic
HTTP_BASIC
Oauth2
OAUTH2
HttpBasic
HTTP_BASIC
Oauth2
OAUTH2
HTTP_BASIC
HTTP_BASIC
OAUTH2
OAUTH2
"HTTP_BASIC"
HTTP_BASIC
"OAUTH2"
OAUTH2

DataSourceServiceNowBuildVersionType
, DataSourceServiceNowBuildVersionTypeArgs

London
LONDON
Others
OTHERS
DataSourceServiceNowBuildVersionTypeLondon
LONDON
DataSourceServiceNowBuildVersionTypeOthers
OTHERS
London
LONDON
Others
OTHERS
London
LONDON
Others
OTHERS
LONDON
LONDON
OTHERS
OTHERS
"LONDON"
LONDON
"OTHERS"
OTHERS

DataSourceServiceNowConfiguration
, DataSourceServiceNowConfigurationArgs

HostUrl This property is required. string
The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
SecretArn This property is required. 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 This property is required. 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 This property is required. string
The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
SecretArn This property is required. 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 This property is required. 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

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 DataSourceServiceNowKnowledgeArticleConfiguration
Configuration information for crawling knowledge articles in the ServiceNow site.
ServiceCatalogConfiguration DataSourceServiceNowServiceCatalogConfiguration
Configuration information for crawling service catalogs in the ServiceNow site.
hostUrl This property is required. String
The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
secretArn This property is required. 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 This property is required. 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

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 DataSourceServiceNowKnowledgeArticleConfiguration
Configuration information for crawling knowledge articles in the ServiceNow site.
serviceCatalogConfiguration DataSourceServiceNowServiceCatalogConfiguration
Configuration information for crawling service catalogs in the ServiceNow site.
hostUrl This property is required. string
The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
secretArn This property is required. 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 This property is required. 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

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 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 This property is required. str
The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
secret_arn This property is required. str
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 .
service_now_build_version This property is required. 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

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 .

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 This property is required. String
The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
secretArn This property is required. 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 This property is required. "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"

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 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
, DataSourceServiceNowKnowledgeArticleConfigurationArgs

DocumentDataFieldName This property is required. 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 This property is required. 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
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 []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 []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 This property is required. 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>
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<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 This property is required. 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[]
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 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 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.
document_data_field_name This property is required. 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]
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.
field_mappings Sequence[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.
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]
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 This property is required. 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>
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<Property Map>
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.

DataSourceServiceNowServiceCatalogConfiguration
, DataSourceServiceNowServiceCatalogConfigurationArgs

DocumentDataFieldName This property is required. 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 This property is required. 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

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 []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 []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 This property is required. 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>

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<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 This property is required. 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[]

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

document_data_field_name This property is required. 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]

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.

field_mappings Sequence[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.
include_attachment_file_patterns Sequence[str]

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 This property is required. 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>

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<Property Map>
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.

DataSourceSharePointConfiguration
, DataSourceSharePointConfigurationArgs

SecretArn This property is required. 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 This property is required. Pulumi.AwsNative.Kendra.DataSourceSharePointConfigurationSharePointVersion
The version of Microsoft SharePoint that you use.
Urls This property is required. 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 This property is required. 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 This property is required. DataSourceSharePointConfigurationSharePointVersion
The version of Microsoft SharePoint that you use.
Urls This property is required. []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

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 []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 []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 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 DataSourceVpcConfiguration
Provides information for connecting to an Amazon VPC.
secretArn This property is required. 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 This property is required. DataSourceSharePointConfigurationSharePointVersion
The version of Microsoft SharePoint that you use.
urls This property is required. 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>

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<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 DataSourceS3Path
Information required to find a specific file in an Amazon S3 bucket.
useChangeLog Boolean
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 DataSourceVpcConfiguration
Provides information for connecting to an Amazon VPC.
secretArn This property is required. 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 This property is required. DataSourceSharePointConfigurationSharePointVersion
The version of Microsoft SharePoint that you use.
urls This property is required. 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[]

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 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 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 DataSourceS3Path
Information required to find a specific file in an Amazon S3 bucket.
useChangeLog boolean
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 DataSourceVpcConfiguration
Provides information for connecting to an Amazon VPC.
secret_arn This property is required. str
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 .
share_point_version This property is required. DataSourceSharePointConfigurationSharePointVersion
The version of Microsoft SharePoint that you use.
urls This property is required. 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]

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.

field_mappings Sequence[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 .
inclusion_patterns Sequence[str]

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.

ssl_certificate_s3_path DataSourceS3Path
Information required to find a specific file in an Amazon S3 bucket.
use_change_log 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.
vpc_configuration DataSourceVpcConfiguration
Provides information for connecting to an Amazon VPC.
secretArn This property is required. 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 This property is required. "SHAREPOINT_ONLINE" | "SHAREPOINT_2013" | "SHAREPOINT_2016"
The version of Microsoft SharePoint that you use.
urls This property is required. 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>

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<Property Map>
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 Property Map
Information required to find a specific file in an Amazon S3 bucket.
useChangeLog Boolean
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 Property Map
Provides information for connecting to an Amazon VPC.

DataSourceSharePointConfigurationSharePointVersion
, DataSourceSharePointConfigurationSharePointVersionArgs

SharepointOnline
SHAREPOINT_ONLINE
Sharepoint2013
SHAREPOINT_2013
Sharepoint2016
SHAREPOINT_2016
DataSourceSharePointConfigurationSharePointVersionSharepointOnline
SHAREPOINT_ONLINE
DataSourceSharePointConfigurationSharePointVersionSharepoint2013
SHAREPOINT_2013
DataSourceSharePointConfigurationSharePointVersionSharepoint2016
SHAREPOINT_2016
SharepointOnline
SHAREPOINT_ONLINE
Sharepoint2013
SHAREPOINT_2013
Sharepoint2016
SHAREPOINT_2016
SharepointOnline
SHAREPOINT_ONLINE
Sharepoint2013
SHAREPOINT_2013
Sharepoint2016
SHAREPOINT_2016
SHAREPOINT_ONLINE
SHAREPOINT_ONLINE
SHAREPOINT2013
SHAREPOINT_2013
SHAREPOINT2016
SHAREPOINT_2016
"SHAREPOINT_ONLINE"
SHAREPOINT_ONLINE
"SHAREPOINT_2013"
SHAREPOINT_2013
"SHAREPOINT_2016"
SHAREPOINT_2016

DataSourceSqlConfiguration
, DataSourceSqlConfigurationArgs

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.

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.

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.

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 .

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.

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

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 .

DataSourceToIndexFieldMapping
, DataSourceToIndexFieldMappingArgs

DataSourceFieldName This property is required. string
IndexFieldName This property is required. string
DateFieldFormat string
DataSourceFieldName This property is required. string
IndexFieldName This property is required. string
DateFieldFormat string
dataSourceFieldName This property is required. String
indexFieldName This property is required. String
dateFieldFormat String
dataSourceFieldName This property is required. string
indexFieldName This property is required. string
dateFieldFormat string
data_source_field_name This property is required. str
index_field_name This property is required. str
date_field_format str
dataSourceFieldName This property is required. String
indexFieldName This property is required. String
dateFieldFormat String

DataSourceType
, DataSourceTypeArgs

S3
S3
Sharepoint
SHAREPOINT
Salesforce
SALESFORCE
Onedrive
ONEDRIVE
Servicenow
SERVICENOW
Database
DATABASE
Custom
CUSTOM
Confluence
CONFLUENCE
Googledrive
GOOGLEDRIVE
Webcrawler
WEBCRAWLER
Workdocs
WORKDOCS
DataSourceTypeS3
S3
DataSourceTypeSharepoint
SHAREPOINT
DataSourceTypeSalesforce
SALESFORCE
DataSourceTypeOnedrive
ONEDRIVE
DataSourceTypeServicenow
SERVICENOW
DataSourceTypeDatabase
DATABASE
DataSourceTypeCustom
CUSTOM
DataSourceTypeConfluence
CONFLUENCE
DataSourceTypeGoogledrive
GOOGLEDRIVE
DataSourceTypeWebcrawler
WEBCRAWLER
DataSourceTypeWorkdocs
WORKDOCS
S3
S3
Sharepoint
SHAREPOINT
Salesforce
SALESFORCE
Onedrive
ONEDRIVE
Servicenow
SERVICENOW
Database
DATABASE
Custom
CUSTOM
Confluence
CONFLUENCE
Googledrive
GOOGLEDRIVE
Webcrawler
WEBCRAWLER
Workdocs
WORKDOCS
S3
S3
Sharepoint
SHAREPOINT
Salesforce
SALESFORCE
Onedrive
ONEDRIVE
Servicenow
SERVICENOW
Database
DATABASE
Custom
CUSTOM
Confluence
CONFLUENCE
Googledrive
GOOGLEDRIVE
Webcrawler
WEBCRAWLER
Workdocs
WORKDOCS
S3
S3
SHAREPOINT
SHAREPOINT
SALESFORCE
SALESFORCE
ONEDRIVE
ONEDRIVE
SERVICENOW
SERVICENOW
DATABASE
DATABASE
CUSTOM
CUSTOM
CONFLUENCE
CONFLUENCE
GOOGLEDRIVE
GOOGLEDRIVE
WEBCRAWLER
WEBCRAWLER
WORKDOCS
WORKDOCS
"S3"
S3
"SHAREPOINT"
SHAREPOINT
"SALESFORCE"
SALESFORCE
"ONEDRIVE"
ONEDRIVE
"SERVICENOW"
SERVICENOW
"DATABASE"
DATABASE
"CUSTOM"
CUSTOM
"CONFLUENCE"
CONFLUENCE
"GOOGLEDRIVE"
GOOGLEDRIVE
"WEBCRAWLER"
WEBCRAWLER
"WORKDOCS"
WORKDOCS

DataSourceVpcConfiguration
, DataSourceVpcConfigurationArgs

SecurityGroupIds This property is required. 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 This property is required. 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 This property is required. []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 This property is required. []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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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
, DataSourceWebCrawlerAuthenticationConfigurationArgs

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
, DataSourceWebCrawlerBasicAuthenticationArgs

Credentials This property is required. string
Host This property is required. string
Port This property is required. int
Credentials This property is required. string
Host This property is required. string
Port This property is required. int
credentials This property is required. String
host This property is required. String
port This property is required. Integer
credentials This property is required. string
host This property is required. string
port This property is required. number
credentials This property is required. str
host This property is required. str
port This property is required. int
credentials This property is required. String
host This property is required. String
port This property is required. Number

DataSourceWebCrawlerConfiguration
, DataSourceWebCrawlerConfigurationArgs

Urls This property is required. 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 This property is required. 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 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
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 []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 This property is required. 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 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>
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 This property is required. 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 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[]
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 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 This property is required. 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.

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]
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.
url_inclusion_patterns Sequence[str]
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 This property is required. 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.

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

DataSourceWebCrawlerSeedUrlConfiguration
, DataSourceWebCrawlerSeedUrlConfigurationArgs

SeedUrls This property is required. 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 This property is required. []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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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
, DataSourceWebCrawlerSeedUrlConfigurationWebCrawlerModeArgs

HostOnly
HOST_ONLY
Subdomains
SUBDOMAINS
Everything
EVERYTHING
DataSourceWebCrawlerSeedUrlConfigurationWebCrawlerModeHostOnly
HOST_ONLY
DataSourceWebCrawlerSeedUrlConfigurationWebCrawlerModeSubdomains
SUBDOMAINS
DataSourceWebCrawlerSeedUrlConfigurationWebCrawlerModeEverything
EVERYTHING
HostOnly
HOST_ONLY
Subdomains
SUBDOMAINS
Everything
EVERYTHING
HostOnly
HOST_ONLY
Subdomains
SUBDOMAINS
Everything
EVERYTHING
HOST_ONLY
HOST_ONLY
SUBDOMAINS
SUBDOMAINS
EVERYTHING
EVERYTHING
"HOST_ONLY"
HOST_ONLY
"SUBDOMAINS"
SUBDOMAINS
"EVERYTHING"
EVERYTHING

DataSourceWebCrawlerSiteMapsConfiguration
, DataSourceWebCrawlerSiteMapsConfigurationArgs

SiteMaps This property is required. 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 This property is required. []string

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

The list can include a maximum of three sitemap URLs.

siteMaps This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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
, DataSourceWebCrawlerUrlsArgs

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
, DataSourceWorkDocsConfigurationArgs

OrganizationId This property is required. 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 This property is required. 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 []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 []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 []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 This property is required. 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 Boolean

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<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 Boolean
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 This property is required. 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 boolean

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 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 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 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 boolean
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.
organization_id This property is required. str

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.

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

exclusion_patterns Sequence[str]
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.
field_mappings Sequence[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.
inclusion_patterns Sequence[str]
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.
use_change_log 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 This property is required. 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 Boolean

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<Property Map>
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 Boolean
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.

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi