We recommend new projects start with resources from the AWS provider.
aws-native.kendra.DataSource
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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 string
- The unique name of the resource.
- args DataSourceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args DataSourceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DataSourceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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:
- Index
Id string - The identifier of the index you want to use with the data source connector.
- Type
Pulumi.
Aws Native. Kendra. Data Source Type - The type of the data source.
- Custom
Document Pulumi.Enrichment Configuration Aws Native. Kendra. Inputs. Data Source Custom Document Enrichment Configuration - Configuration information for altering document metadata and content during the document ingestion process.
- Data
Source Pulumi.Configuration Aws Native. Kendra. Inputs. Data Source Configuration 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 theType
parameter is set toCUSTOM
.The
Configuration
parameter is required for all other data sources.- Description string
- A description for the data source connector.
- Language
Code 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.
- Role
Arn string The Amazon Resource Name (ARN) of a role with permission to access the data source.
You can't specify the
RoleArn
parameter when theType
parameter is set toCUSTOM
.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.
- List<Pulumi.
Aws Native. Inputs. Tag> - Tags for labeling the data source
- Index
Id string - The identifier of the index you want to use with the data source connector.
- Type
Data
Source Type - The type of the data source.
- Custom
Document DataEnrichment Configuration Source Custom Document Enrichment Configuration Args - Configuration information for altering document metadata and content during the document ingestion process.
- Data
Source DataConfiguration Source Configuration Args 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 theType
parameter is set toCUSTOM
.The
Configuration
parameter is required for all other data sources.- Description string
- A description for the data source connector.
- Language
Code 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.
- Role
Arn string The Amazon Resource Name (ARN) of a role with permission to access the data source.
You can't specify the
RoleArn
parameter when theType
parameter is set toCUSTOM
.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.
- Tag
Args - Tags for labeling the data source
- index
Id String - The identifier of the index you want to use with the data source connector.
- type
Data
Source Type - The type of the data source.
- custom
Document DataEnrichment Configuration Source Custom Document Enrichment Configuration - Configuration information for altering document metadata and content during the document ingestion process.
- data
Source DataConfiguration Source Configuration 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 theType
parameter is set toCUSTOM
.The
Configuration
parameter is required for all other data sources.- description String
- A description for the data source connector.
- language
Code 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.
- role
Arn String The Amazon Resource Name (ARN) of a role with permission to access the data source.
You can't specify the
RoleArn
parameter when theType
parameter is set toCUSTOM
.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.
- List<Tag>
- Tags for labeling the data source
- index
Id string - The identifier of the index you want to use with the data source connector.
- type
Data
Source Type - The type of the data source.
- custom
Document DataEnrichment Configuration Source Custom Document Enrichment Configuration - Configuration information for altering document metadata and content during the document ingestion process.
- data
Source DataConfiguration Source Configuration 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 theType
parameter is set toCUSTOM
.The
Configuration
parameter is required for all other data sources.- description string
- A description for the data source connector.
- language
Code 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.
- role
Arn string The Amazon Resource Name (ARN) of a role with permission to access the data source.
You can't specify the
RoleArn
parameter when theType
parameter is set toCUSTOM
.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.
- Tag[]
- Tags for labeling the data source
- index_
id str - The identifier of the index you want to use with the data source connector.
- type
Data
Source Type - The type of the data source.
- custom_
document_ Dataenrichment_ configuration Source Custom Document Enrichment Configuration Args - Configuration information for altering document metadata and content during the document ingestion process.
- data_
source_ Dataconfiguration Source Configuration Args 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 theType
parameter is set toCUSTOM
.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 theType
parameter is set toCUSTOM
.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.
- Sequence[Tag
Args] - Tags for labeling the data source
- index
Id String - The identifier of the index you want to use with the data source connector.
- type "S3" | "SHAREPOINT" | "SALESFORCE" | "ONEDRIVE" | "SERVICENOW" | "DATABASE" | "CUSTOM" | "CONFLUENCE" | "GOOGLEDRIVE" | "WEBCRAWLER" | "WORKDOCS"
- The type of the data source.
- custom
Document Property MapEnrichment Configuration - Configuration information for altering document metadata and content during the document ingestion process.
- data
Source Property MapConfiguration 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 theType
parameter is set toCUSTOM
.The
Configuration
parameter is required for all other data sources.- description String
- A description for the data source connector.
- language
Code 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.
- role
Arn String The Amazon Resource Name (ARN) of a role with permission to access the data source.
You can't specify the
RoleArn
parameter when theType
parameter is set toCUSTOM
.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.
- 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
- Aws
Id 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
- Aws
Id 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
- aws
Id 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
- aws
Id 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
- aws
Id 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
- Key
Path string - Path to the AWS S3 bucket that contains the access control list files.
- Key
Path string - Path to the AWS S3 bucket that contains the access control list files.
- key
Path String - Path to the AWS S3 bucket that contains the access control list files.
- key
Path 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.
- key
Path String - Path to the AWS S3 bucket that contains the access control list files.
DataSourceAclConfiguration, DataSourceAclConfigurationArgs
- Allowed
Groups stringColumn Name - 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 stringColumn Name - 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 StringColumn Name - 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 stringColumn Name - 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_ strcolumn_ name - 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 StringColumn Name - 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
- Change
Detecting List<string>Columns - One to five columns that indicate when a document in the database has changed.
- Document
Data stringColumn Name - The column that contains the contents of the document.
- Document
Id stringColumn Name - The column that provides the document's identifier.
- Document
Title stringColumn Name - The column that contains the title of the document.
- Field
Mappings List<Pulumi.Aws Native. Kendra. Inputs. Data Source To Index Field Mapping> - 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 []stringColumns - One to five columns that indicate when a document in the database has changed.
- Document
Data stringColumn Name - The column that contains the contents of the document.
- Document
Id stringColumn Name - The column that provides the document's identifier.
- Document
Title stringColumn Name - The column that contains the title of the document.
- Field
Mappings []DataSource To Index Field Mapping - 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 List<String>Columns - One to five columns that indicate when a document in the database has changed.
- document
Data StringColumn Name - The column that contains the contents of the document.
- document
Id StringColumn Name - The column that provides the document's identifier.
- document
Title StringColumn Name - The column that contains the title of the document.
- field
Mappings List<DataSource To Index Field Mapping> - 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 string[]Columns - One to five columns that indicate when a document in the database has changed.
- document
Data stringColumn Name - The column that contains the contents of the document.
- document
Id stringColumn Name - The column that provides the document's identifier.
- document
Title stringColumn Name - The column that contains the title of the document.
- field
Mappings DataSource To Index Field Mapping[] - 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_ Sequence[str]columns - One to five columns that indicate when a document in the database has changed.
- document_
data_ strcolumn_ name - The column that contains the contents of the document.
- document_
id_ strcolumn_ name - The column that provides the document's identifier.
- document_
title_ strcolumn_ name - The column that contains the title of the document.
- field_
mappings Sequence[DataSource To Index Field Mapping] - 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 List<String>Columns - One to five columns that indicate when a document in the database has changed.
- document
Data StringColumn Name - The column that contains the contents of the document.
- document
Id StringColumn Name - The column that provides the document's identifier.
- document
Title StringColumn Name - The column that contains the title of the document.
- field
Mappings 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
- Greater
Than - GreaterThan
- Greater
Than Or Equals - GreaterThanOrEquals
- Less
Than - LessThan
- Less
Than Or Equals - LessThanOrEquals
- Equals
Value - Equals
- Not
Equals - NotEquals
- Contains
- Contains
- Not
Contains - NotContains
- Exists
- Exists
- Not
Exists - NotExists
- Begins
With - BeginsWith
- Data
Source Condition Operator Greater Than - GreaterThan
- Data
Source Condition Operator Greater Than Or Equals - GreaterThanOrEquals
- Data
Source Condition Operator Less Than - LessThan
- Data
Source Condition Operator Less Than Or Equals - LessThanOrEquals
- Data
Source Condition Operator Equals - Equals
- Data
Source Condition Operator Not Equals - NotEquals
- Data
Source Condition Operator Contains - Contains
- Data
Source Condition Operator Not Contains - NotContains
- Data
Source Condition Operator Exists - Exists
- Data
Source Condition Operator Not Exists - NotExists
- Data
Source Condition Operator Begins With - 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
- 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
- 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
- "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
DataSourceConfiguration, DataSourceConfigurationArgs
- Confluence
Configuration Pulumi.Aws Native. Kendra. Inputs. Data Source Confluence Configuration - Provides the configuration information to connect to Confluence as your data source.
- Database
Configuration Pulumi.Aws Native. Kendra. Inputs. Data Source Database Configuration - Provides the configuration information to connect to a database as your data source.
- Google
Drive Pulumi.Configuration Aws Native. Kendra. Inputs. Data Source Google Drive Configuration - Provides the configuration information to connect to Google Drive as your data source.
- One
Drive Pulumi.Configuration Aws Native. Kendra. Inputs. Data Source One Drive Configuration - Provides the configuration information to connect to Microsoft OneDrive as your data source.
- S3Configuration
Pulumi.
Aws Native. Kendra. Inputs. Data Source S3Data Source Configuration 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 Pulumi.Aws Native. Kendra. Inputs. Data Source Salesforce Configuration - Provides the configuration information to connect to Salesforce as your data source.
- Service
Now Pulumi.Configuration Aws Native. Kendra. Inputs. Data Source Service Now Configuration - Provides the configuration information to connect to ServiceNow as your data source.
- Pulumi.
Aws Native. Kendra. Inputs. Data Source Share Point Configuration - Provides the configuration information to connect to Microsoft SharePoint as your data source.
- Web
Crawler Pulumi.Configuration Aws Native. Kendra. Inputs. Data Source Web Crawler Configuration - Provides the configuration information required for Amazon Kendra Web Crawler.
- Work
Docs Pulumi.Configuration Aws Native. Kendra. Inputs. Data Source Work Docs Configuration - Provides the configuration information to connect to Amazon WorkDocs as your data source.
- Confluence
Configuration DataSource Confluence Configuration - Provides the configuration information to connect to Confluence as your data source.
- Database
Configuration DataSource Database Configuration - Provides the configuration information to connect to a database as your data source.
- Google
Drive DataConfiguration Source Google Drive Configuration - Provides the configuration information to connect to Google Drive as your data source.
- One
Drive DataConfiguration Source One Drive Configuration - Provides the configuration information to connect to Microsoft OneDrive as your data source.
- S3Configuration
Data
Source S3Data Source Configuration 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 DataSource Salesforce Configuration - Provides the configuration information to connect to Salesforce as your data source.
- Service
Now DataConfiguration Source Service Now Configuration - Provides the configuration information to connect to ServiceNow as your data source.
- Data
Source Share Point Configuration - Provides the configuration information to connect to Microsoft SharePoint as your data source.
- Web
Crawler DataConfiguration Source Web Crawler Configuration - Provides the configuration information required for Amazon Kendra Web Crawler.
- Work
Docs DataConfiguration Source Work Docs Configuration - Provides the configuration information to connect to Amazon WorkDocs as your data source.
- confluence
Configuration DataSource Confluence Configuration - Provides the configuration information to connect to Confluence as your data source.
- database
Configuration DataSource Database Configuration - Provides the configuration information to connect to a database as your data source.
- google
Drive DataConfiguration Source Google Drive Configuration - Provides the configuration information to connect to Google Drive as your data source.
- one
Drive DataConfiguration Source One Drive Configuration - Provides the configuration information to connect to Microsoft OneDrive as your data source.
- s3Configuration
Data
Source S3Data Source Configuration 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 DataSource Salesforce Configuration - Provides the configuration information to connect to Salesforce as your data source.
- service
Now DataConfiguration Source Service Now Configuration - Provides the configuration information to connect to ServiceNow as your data source.
- Data
Source Share Point Configuration - Provides the configuration information to connect to Microsoft SharePoint as your data source.
- web
Crawler DataConfiguration Source Web Crawler Configuration - Provides the configuration information required for Amazon Kendra Web Crawler.
- work
Docs DataConfiguration Source Work Docs Configuration - Provides the configuration information to connect to Amazon WorkDocs as your data source.
- confluence
Configuration DataSource Confluence Configuration - Provides the configuration information to connect to Confluence as your data source.
- database
Configuration DataSource Database Configuration - Provides the configuration information to connect to a database as your data source.
- google
Drive DataConfiguration Source Google Drive Configuration - Provides the configuration information to connect to Google Drive as your data source.
- one
Drive DataConfiguration Source One Drive Configuration - Provides the configuration information to connect to Microsoft OneDrive as your data source.
- s3Configuration
Data
Source S3Data Source Configuration 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 DataSource Salesforce Configuration - Provides the configuration information to connect to Salesforce as your data source.
- service
Now DataConfiguration Source Service Now Configuration - Provides the configuration information to connect to ServiceNow as your data source.
- Data
Source Share Point Configuration - Provides the configuration information to connect to Microsoft SharePoint as your data source.
- web
Crawler DataConfiguration Source Web Crawler Configuration - Provides the configuration information required for Amazon Kendra Web Crawler.
- work
Docs DataConfiguration Source Work Docs Configuration - Provides the configuration information to connect to Amazon WorkDocs as your data source.
- confluence_
configuration DataSource Confluence Configuration - Provides the configuration information to connect to Confluence as your data source.
- database_
configuration DataSource Database Configuration - Provides the configuration information to connect to a database as your data source.
- google_
drive_ Dataconfiguration Source Google Drive Configuration - Provides the configuration information to connect to Google Drive as your data source.
- one_
drive_ Dataconfiguration Source One Drive Configuration - Provides the configuration information to connect to Microsoft OneDrive as your data source.
- s3_
configuration DataSource S3Data Source Configuration 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 DataSource Salesforce Configuration - Provides the configuration information to connect to Salesforce as your data source.
- service_
now_ Dataconfiguration Source Service Now Configuration - Provides the configuration information to connect to ServiceNow as your data source.
- Data
Source Share Point Configuration - Provides the configuration information to connect to Microsoft SharePoint as your data source.
- web_
crawler_ Dataconfiguration Source Web Crawler Configuration - Provides the configuration information required for Amazon Kendra Web Crawler.
- work_
docs_ Dataconfiguration Source Work Docs Configuration - Provides the configuration information to connect to Amazon WorkDocs as your data source.
- confluence
Configuration Property Map - Provides the configuration information to connect to Confluence as your data source.
- database
Configuration Property Map - Provides the configuration information to connect to a database as your data source.
- google
Drive Property MapConfiguration - Provides the configuration information to connect to Google Drive as your data source.
- one
Drive Property MapConfiguration - 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.
- salesforce
Configuration Property Map - Provides the configuration information to connect to Salesforce as your data source.
- service
Now Property MapConfiguration - Provides the configuration information to connect to ServiceNow as your data source.
- Property Map
- Provides the configuration information to connect to Microsoft SharePoint as your data source.
- web
Crawler Property MapConfiguration - Provides the configuration information required for Amazon Kendra Web Crawler.
- work
Docs Property MapConfiguration - Provides the configuration information to connect to Amazon WorkDocs as your data source.
DataSourceConfluenceAttachmentConfiguration, DataSourceConfluenceAttachmentConfigurationArgs
- Attachment
Field List<Pulumi.Mappings Aws Native. Kendra. Inputs. Data Source Confluence Attachment To Index Field Mapping> 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.
- Attachment
Field []DataMappings Source Confluence Attachment To Index Field Mapping 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.
- attachment
Field List<DataMappings Source Confluence Attachment To Index Field Mapping> 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 Boolean TRUE
to index attachments of pages and blogs in Confluence.
- attachment
Field DataMappings Source Confluence Attachment To Index Field Mapping[] 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 boolean TRUE
to index attachments of pages and blogs in Confluence.
- attachment_
field_ Sequence[Datamappings Source Confluence Attachment To Index Field Mapping] 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.
- attachment
Field List<Property Map>Mappings 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 Boolean TRUE
to index attachments of pages and blogs in Confluence.
DataSourceConfluenceAttachmentFieldName, DataSourceConfluenceAttachmentFieldNameArgs
- 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
- Data
Source Confluence Attachment Field Name Author - AUTHOR
- Data
Source Confluence Attachment Field Name Content Type - CONTENT_TYPE
- Data
Source Confluence Attachment Field Name Created Date - CREATED_DATE
- Data
Source Confluence Attachment Field Name Display Url - DISPLAY_URL
- Data
Source Confluence Attachment Field Name File Size - FILE_SIZE
- Data
Source Confluence Attachment Field Name Item Type - ITEM_TYPE
- Data
Source Confluence Attachment Field Name Parent Id - PARENT_ID
- Data
Source Confluence Attachment Field Name Space Key - SPACE_KEY
- Data
Source Confluence Attachment Field Name Space Name - SPACE_NAME
- Data
Source Confluence Attachment Field Name Url - URL
- Data
Source Confluence Attachment Field Name 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
- 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
DataSourceConfluenceBlogConfiguration, DataSourceConfluenceBlogConfigurationArgs
- Blog
Field List<Pulumi.Mappings Aws Native. Kendra. Inputs. Data Source Confluence Blog To Index Field Mapping> 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 []DataMappings Source Confluence Blog To Index Field Mapping 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 List<DataMappings Source Confluence Blog To Index Field Mapping> 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 DataMappings Source Confluence Blog To Index Field Mapping[] 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_ Sequence[Datamappings Source Confluence Blog To Index Field Mapping] 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 List<Property Map>Mappings 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
- 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
- Data
Source Confluence Blog Field Name Author - AUTHOR
- Data
Source Confluence Blog Field Name Display Url - DISPLAY_URL
- Data
Source Confluence Blog Field Name Item Type - ITEM_TYPE
- Data
Source Confluence Blog Field Name Labels - LABELS
- Data
Source Confluence Blog Field Name Publish Date - PUBLISH_DATE
- Data
Source Confluence Blog Field Name Space Key - SPACE_KEY
- Data
Source Confluence Blog Field Name Space Name - SPACE_NAME
- Data
Source Confluence Blog Field Name Url - URL
- Data
Source Confluence Blog Field Name 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
- 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
DataSourceConfluenceConfiguration, DataSourceConfluenceConfigurationArgs
- Secret
Arn 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 .
- Server
Url string - The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/ . You can also use an IP address, for example, https://192.168.1.113/ .
- Version
Pulumi.
Aws Native. Kendra. Data Source Confluence Version - The version or the type of Confluence installation to connect to.
- Attachment
Configuration Pulumi.Aws Native. Kendra. Inputs. Data Source Confluence Attachment Configuration - Configuration information for indexing attachments to Confluence blogs and pages.
- Blog
Configuration Pulumi.Aws Native. Kendra. Inputs. Data Source Confluence Blog Configuration - Configuration information for indexing Confluence blogs.
- Exclusion
Patterns 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.
- Inclusion
Patterns 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.
- Page
Configuration Pulumi.Aws Native. Kendra. Inputs. Data Source Confluence Page Configuration - Configuration information for indexing Confluence pages.
- Space
Configuration Pulumi.Aws Native. Kendra. Inputs. Data Source Confluence Space Configuration - Configuration information for indexing Confluence spaces.
- Vpc
Configuration Pulumi.Aws Native. Kendra. Inputs. Data Source Vpc Configuration - Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC .
- Secret
Arn 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 .
- Server
Url 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
Data
Source Confluence Version - The version or the type of Confluence installation to connect to.
- Attachment
Configuration DataSource Confluence Attachment Configuration - Configuration information for indexing attachments to Confluence blogs and pages.
- Blog
Configuration DataSource Confluence Blog Configuration - Configuration information for indexing Confluence blogs.
- Exclusion
Patterns []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.
- Inclusion
Patterns []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.
- Page
Configuration DataSource Confluence Page Configuration - Configuration information for indexing Confluence pages.
- Space
Configuration DataSource Confluence Space Configuration - Configuration information for indexing Confluence spaces.
- Vpc
Configuration DataSource Vpc Configuration - Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC .
- secret
Arn 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 .
- server
Url 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
Data
Source Confluence Version - The version or the type of Confluence installation to connect to.
- attachment
Configuration DataSource Confluence Attachment Configuration - Configuration information for indexing attachments to Confluence blogs and pages.
- blog
Configuration DataSource Confluence Blog Configuration - Configuration information for indexing Confluence blogs.
- exclusion
Patterns 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.
- inclusion
Patterns 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.
- page
Configuration DataSource Confluence Page Configuration - Configuration information for indexing Confluence pages.
- space
Configuration DataSource Confluence Space Configuration - Configuration information for indexing Confluence spaces.
- vpc
Configuration DataSource Vpc Configuration - Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC .
- secret
Arn 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 .
- server
Url 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
Data
Source Confluence Version - The version or the type of Confluence installation to connect to.
- attachment
Configuration DataSource Confluence Attachment Configuration - Configuration information for indexing attachments to Confluence blogs and pages.
- blog
Configuration DataSource Confluence Blog Configuration - Configuration information for indexing Confluence blogs.
- exclusion
Patterns 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.
- inclusion
Patterns 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.
- page
Configuration DataSource Confluence Page Configuration - Configuration information for indexing Confluence pages.
- space
Configuration DataSource Confluence Space Configuration - Configuration information for indexing Confluence spaces.
- vpc
Configuration DataSource Vpc Configuration - Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC .
- secret_
arn 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 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
Data
Source Confluence Version - The version or the type of Confluence installation to connect to.
- attachment_
configuration DataSource Confluence Attachment Configuration - Configuration information for indexing attachments to Confluence blogs and pages.
- blog_
configuration DataSource Confluence Blog Configuration - 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 DataSource Confluence Page Configuration - Configuration information for indexing Confluence pages.
- space_
configuration DataSource Confluence Space Configuration - Configuration information for indexing Confluence spaces.
- vpc_
configuration DataSource Vpc Configuration - Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC .
- secret
Arn 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 .
- server
Url String - The URL of your Confluence instance. Use the full URL of the server. For example, https://server.example.com:port/ . You can also use an IP address, for example, https://192.168.1.113/ .
- version "CLOUD" | "SERVER"
- The version or the type of Confluence installation to connect to.
- attachment
Configuration Property Map - Configuration information for indexing attachments to Confluence blogs and pages.
- blog
Configuration Property Map - Configuration information for indexing Confluence blogs.
- exclusion
Patterns 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.
- inclusion
Patterns 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.
- page
Configuration Property Map - Configuration information for indexing Confluence pages.
- space
Configuration Property Map - Configuration information for indexing Confluence spaces.
- vpc
Configuration Property Map - Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC .
DataSourceConfluencePageConfiguration, DataSourceConfluencePageConfigurationArgs
- Page
Field List<Pulumi.Mappings Aws Native. Kendra. Inputs. Data Source Confluence Page To Index Field Mapping> 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 []DataMappings Source Confluence Page To Index Field Mapping 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 List<DataMappings Source Confluence Page To Index Field Mapping> 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 DataMappings Source Confluence Page To Index Field Mapping[] 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_ Sequence[Datamappings Source Confluence Page To Index Field Mapping] 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 List<Property Map>Mappings 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
- 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
- Data
Source Confluence Page Field Name Author - AUTHOR
- Data
Source Confluence Page Field Name Content Status - CONTENT_STATUS
- Data
Source Confluence Page Field Name Created Date - CREATED_DATE
- Data
Source Confluence Page Field Name Display Url - DISPLAY_URL
- Data
Source Confluence Page Field Name Item Type - ITEM_TYPE
- Data
Source Confluence Page Field Name Labels - LABELS
- Data
Source Confluence Page Field Name Modified Date - MODIFIED_DATE
- Data
Source Confluence Page Field Name Parent Id - PARENT_ID
- Data
Source Confluence Page Field Name Space Key - SPACE_KEY
- Data
Source Confluence Page Field Name Space Name - SPACE_NAME
- Data
Source Confluence Page Field Name Url - URL
- Data
Source Confluence Page Field Name 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
- 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
DataSourceConfluenceSpaceConfiguration, DataSourceConfluenceSpaceConfigurationArgs
- Crawl
Archived boolSpaces TRUE
to index archived spaces.- Crawl
Personal boolSpaces 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 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 theIncludeSpaces
list, the space is excluded. - Include
Spaces 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 theExcludeSpaces
list, the space is excluded. - Space
Field List<Pulumi.Mappings Aws Native. Kendra. Inputs. Data Source Confluence Space To Index Field Mapping> 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 boolSpaces TRUE
to index archived spaces.- Crawl
Personal boolSpaces 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 []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 theIncludeSpaces
list, the space is excluded. - Include
Spaces []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 theExcludeSpaces
list, the space is excluded. - Space
Field []DataMappings Source Confluence Space To Index Field Mapping 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 BooleanSpaces TRUE
to index archived spaces.- crawl
Personal BooleanSpaces 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 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 theIncludeSpaces
list, the space is excluded. - include
Spaces 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 theExcludeSpaces
list, the space is excluded. - space
Field List<DataMappings Source Confluence Space To Index Field Mapping> 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 booleanSpaces TRUE
to index archived spaces.- crawl
Personal booleanSpaces 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 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 theIncludeSpaces
list, the space is excluded. - include
Spaces 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 theExcludeSpaces
list, the space is excluded. - space
Field DataMappings Source Confluence Space To Index Field Mapping[] 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_ boolspaces TRUE
to index archived spaces.- crawl_
personal_ boolspaces 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 theIncludeSpaces
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 theExcludeSpaces
list, the space is excluded. - space_
field_ Sequence[Datamappings Source Confluence Space To Index Field Mapping] 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 BooleanSpaces TRUE
to index archived spaces.- crawl
Personal BooleanSpaces 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 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 theIncludeSpaces
list, the space is excluded. - include
Spaces 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 theExcludeSpaces
list, the space is excluded. - space
Field List<Property Map>Mappings 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
- Display
Url - DISPLAY_URL
- Item
Type - ITEM_TYPE
- Space
Key - SPACE_KEY
- Url
- URL
- Data
Source Confluence Space Field Name Display Url - DISPLAY_URL
- Data
Source Confluence Space Field Name Item Type - ITEM_TYPE
- Data
Source Confluence Space Field Name Space Key - SPACE_KEY
- Data
Source Confluence Space Field Name 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
- 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
DataSourceConfluenceVersion, DataSourceConfluenceVersionArgs
- Cloud
- CLOUD
- Server
- SERVER
- Data
Source Confluence Version Cloud - CLOUD
- Data
Source Confluence Version Server - SERVER
- Cloud
- CLOUD
- Server
- SERVER
- Cloud
- CLOUD
- Server
- SERVER
- CLOUD
- CLOUD
- SERVER
- SERVER
- "CLOUD"
- CLOUD
- "SERVER"
- SERVER
DataSourceConnectionConfiguration, DataSourceConnectionConfigurationArgs
- Database
Host string - 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 string - The name of the database containing the document data.
- Database
Port int - The port that the database uses for connections.
- Secret
Arn 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.
- Table
Name string - The name of the table that contains the document data.
- Database
Host string - 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 string - The name of the database containing the document data.
- Database
Port int - The port that the database uses for connections.
- Secret
Arn 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.
- Table
Name string - The name of the table that contains the document data.
- database
Host String - 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 String - The name of the database containing the document data.
- database
Port Integer - The port that the database uses for connections.
- secret
Arn 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.
- table
Name String - The name of the table that contains the document data.
- database
Host string - 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 string - The name of the database containing the document data.
- database
Port number - The port that the database uses for connections.
- secret
Arn 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.
- table
Name string - The name of the table that contains the document data.
- database_
host str - The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.
- database_
name str - The name of the database containing the document data.
- database_
port int - The port that the database uses for connections.
- secret_
arn str - The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that stores the credentials. The credentials should be a user-password pair. For more information, see Using a Database Data Source . For more information about AWS Secrets Manager , see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
- table_
name str - The name of the table that contains the document data.
- database
Host String - 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 String - The name of the database containing the document data.
- database
Port Number - The port that the database uses for connections.
- secret
Arn 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.
- table
Name String - The name of the table that contains the document data.
DataSourceCustomDocumentEnrichmentConfiguration, DataSourceCustomDocumentEnrichmentConfigurationArgs
- Inline
Configurations List<Pulumi.Aws Native. Kendra. Inputs. Data Source Inline Custom Document Enrichment Configuration> - Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
- Post
Extraction Pulumi.Hook Configuration Aws Native. Kendra. Inputs. Data Source Hook Configuration - 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 Pulumi.Hook Configuration Aws Native. Kendra. Inputs. Data Source Hook Configuration - 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 string - The Amazon Resource Name (ARN) of an IAM role with permission to run
PreExtractionHookConfiguration
andPostExtractionHookConfiguration
for altering document metadata and content during the document ingestion process. For more information, see an IAM roles for Amazon Kendra .
- Inline
Configurations []DataSource Inline Custom Document Enrichment Configuration - Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
- Post
Extraction DataHook Configuration Source Hook Configuration - 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 DataHook Configuration Source Hook Configuration - 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 string - The Amazon Resource Name (ARN) of an IAM role with permission to run
PreExtractionHookConfiguration
andPostExtractionHookConfiguration
for altering document metadata and content during the document ingestion process. For more information, see an IAM roles for Amazon Kendra .
- inline
Configurations List<DataSource Inline Custom Document Enrichment Configuration> - Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
- post
Extraction DataHook Configuration Source Hook Configuration - 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 DataHook Configuration Source Hook Configuration - 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 String - The Amazon Resource Name (ARN) of an IAM role with permission to run
PreExtractionHookConfiguration
andPostExtractionHookConfiguration
for altering document metadata and content during the document ingestion process. For more information, see an IAM roles for Amazon Kendra .
- inline
Configurations DataSource Inline Custom Document Enrichment Configuration[] - Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
- post
Extraction DataHook Configuration Source Hook Configuration - 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 DataHook Configuration Source Hook Configuration - 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 string - The Amazon Resource Name (ARN) of an IAM role with permission to run
PreExtractionHookConfiguration
andPostExtractionHookConfiguration
for altering document metadata and content during the document ingestion process. For more information, see an IAM roles for Amazon Kendra .
- inline_
configurations Sequence[DataSource Inline Custom Document Enrichment Configuration] - Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
- post_
extraction_ Datahook_ configuration Source Hook Configuration - 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_ Datahook_ configuration Source Hook Configuration - 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
andPostExtractionHookConfiguration
for altering document metadata and content during the document ingestion process. For more information, see an IAM roles for Amazon Kendra .
- inline
Configurations List<Property Map> - Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
- post
Extraction Property MapHook Configuration - 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 Property MapHook Configuration - 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 String - The Amazon Resource Name (ARN) of an IAM role with permission to run
PreExtractionHookConfiguration
andPostExtractionHookConfiguration
for altering document metadata and content during the document ingestion process. For more information, see an IAM roles for Amazon Kendra .
DataSourceDatabaseConfiguration, DataSourceDatabaseConfigurationArgs
- Column
Configuration Pulumi.Aws Native. Kendra. Inputs. Data Source Column Configuration - Information about where the index should get the document information from the database.
- Connection
Configuration Pulumi.Aws Native. Kendra. Inputs. Data Source Connection Configuration - Configuration information that's required to connect to a database.
- Database
Engine Pulumi.Type Aws Native. Kendra. Data Source Database Engine Type - The type of database engine that runs the database.
- Acl
Configuration Pulumi.Aws Native. Kendra. Inputs. Data Source Acl Configuration - Information about the database column that provides information for user context filtering.
- Sql
Configuration Pulumi.Aws Native. Kendra. Inputs. Data Source Sql Configuration - Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
- Vpc
Configuration Pulumi.Aws Native. Kendra. Inputs. Data Source Vpc Configuration - Provides information for connecting to an Amazon VPC.
- Column
Configuration DataSource Column Configuration - Information about where the index should get the document information from the database.
- Connection
Configuration DataSource Connection Configuration - Configuration information that's required to connect to a database.
- Database
Engine DataType Source Database Engine Type - The type of database engine that runs the database.
- Acl
Configuration DataSource Acl Configuration - Information about the database column that provides information for user context filtering.
- Sql
Configuration DataSource Sql Configuration - Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
- Vpc
Configuration DataSource Vpc Configuration - Provides information for connecting to an Amazon VPC.
- column
Configuration DataSource Column Configuration - Information about where the index should get the document information from the database.
- connection
Configuration DataSource Connection Configuration - Configuration information that's required to connect to a database.
- database
Engine DataType Source Database Engine Type - The type of database engine that runs the database.
- acl
Configuration DataSource Acl Configuration - Information about the database column that provides information for user context filtering.
- sql
Configuration DataSource Sql Configuration - Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
- vpc
Configuration DataSource Vpc Configuration - Provides information for connecting to an Amazon VPC.
- column
Configuration DataSource Column Configuration - Information about where the index should get the document information from the database.
- connection
Configuration DataSource Connection Configuration - Configuration information that's required to connect to a database.
- database
Engine DataType Source Database Engine Type - The type of database engine that runs the database.
- acl
Configuration DataSource Acl Configuration - Information about the database column that provides information for user context filtering.
- sql
Configuration DataSource Sql Configuration - Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
- vpc
Configuration DataSource Vpc Configuration - Provides information for connecting to an Amazon VPC.
- column_
configuration DataSource Column Configuration - Information about where the index should get the document information from the database.
- connection_
configuration DataSource Connection Configuration - Configuration information that's required to connect to a database.
- database_
engine_ Datatype Source Database Engine Type - The type of database engine that runs the database.
- acl_
configuration DataSource Acl Configuration - Information about the database column that provides information for user context filtering.
- sql_
configuration DataSource Sql Configuration - Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
- vpc_
configuration DataSource Vpc Configuration - Provides information for connecting to an Amazon VPC.
- column
Configuration Property Map - Information about where the index should get the document information from the database.
- connection
Configuration Property Map - Configuration information that's required to connect to a database.
- database
Engine "RDS_AURORA_MYSQL" | "RDS_AURORA_POSTGRESQL" | "RDS_MYSQL" | "RDS_POSTGRESQL"Type - The type of database engine that runs the database.
- acl
Configuration Property Map - Information about the database column that provides information for user context filtering.
- sql
Configuration Property Map - Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
- vpc
Configuration Property Map - Provides information for connecting to an Amazon VPC.
DataSourceDatabaseEngineType, DataSourceDatabaseEngineTypeArgs
- Rds
Aurora Mysql - RDS_AURORA_MYSQL
- Rds
Aurora Postgresql - RDS_AURORA_POSTGRESQL
- Rds
Mysql - RDS_MYSQL
- Rds
Postgresql - RDS_POSTGRESQL
- Data
Source Database Engine Type Rds Aurora Mysql - RDS_AURORA_MYSQL
- Data
Source Database Engine Type Rds Aurora Postgresql - RDS_AURORA_POSTGRESQL
- Data
Source Database Engine Type Rds Mysql - RDS_MYSQL
- Data
Source Database Engine Type Rds Postgresql - 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
- 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
- Condition
Document stringAttribute Key The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Kendra currently does not support
_document_body
as an attribute key used for the condition.- Operator
Pulumi.
Aws Native. Kendra. Data Source Condition Operator The condition operator.
For example, you can use 'Contains' to partially match a string.
- Condition
On Pulumi.Value Aws Native. Kendra. Inputs. Data Source Document Attribute Value 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 stringAttribute Key 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
Data
Source Condition Operator The condition operator.
For example, you can use 'Contains' to partially match a string.
- Condition
On DataValue Source Document Attribute Value 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 StringAttribute Key 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
Data
Source Condition Operator The condition operator.
For example, you can use 'Contains' to partially match a string.
- condition
On DataValue Source Document Attribute Value 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 stringAttribute Key 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
Data
Source Condition Operator The condition operator.
For example, you can use 'Contains' to partially match a string.
- condition
On DataValue Source Document Attribute Value 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_ strattribute_ key 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
Data
Source Condition Operator The condition operator.
For example, you can use 'Contains' to partially match a string.
- condition_
on_ Datavalue Source Document Attribute Value 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 StringAttribute Key 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
"Greater
Than" | "Greater Than Or Equals" | "Less Than" | "Less Than Or Equals" | "Equals" | "Not Equals" | "Contains" | "Not Contains" | "Exists" | "Not Exists" | "Begins With" The condition operator.
For example, you can use 'Contains' to partially match a string.
- condition
On Property MapValue 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
- Date
Value 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.
- Long
Value int - A long integer value.
- String
List List<string>Value - A list of strings. The default maximum length or number of strings is 10.
- String
Value string - A string, such as "department".
- Date
Value 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.
- Long
Value int - A long integer value.
- String
List []stringValue - A list of strings. The default maximum length or number of strings is 10.
- String
Value string - A string, such as "department".
- date
Value 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.
- long
Value Integer - A long integer value.
- string
List List<String>Value - A list of strings. The default maximum length or number of strings is 10.
- string
Value String - A string, such as "department".
- date
Value 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.
- long
Value number - A long integer value.
- string
List string[]Value - A list of strings. The default maximum length or number of strings is 10.
- string
Value 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_ Sequence[str]value - A list of strings. The default maximum length or number of strings is 10.
- string_
value str - A string, such as "department".
- date
Value 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.
- long
Value Number - A long integer value.
- string
List List<String>Value - A list of strings. The default maximum length or number of strings is 10.
- string
Value 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
- Secret
Arn 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 .
- Exclude
Mime List<string>Types 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 .
- 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.
- Exclude
User List<string>Accounts - 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 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.
- Field
Mappings List<Pulumi.Aws Native. Kendra. Inputs. Data Source To Index Field Mapping> - 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 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.
- Secret
Arn 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 .
- Exclude
Mime []stringTypes 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 .
- []string
- 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 []stringAccounts - 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 []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.
- Field
Mappings []DataSource To Index Field Mapping - 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 []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 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 .
- exclude
Mime List<String>Types 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 .
- 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.
- exclude
User List<String>Accounts - 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 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.
- field
Mappings List<DataSource To Index Field Mapping> - 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 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.
- secret
Arn 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 .
- exclude
Mime string[]Types 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 .
- string[]
- 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 string[]Accounts - 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 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.
- field
Mappings DataSource To Index Field Mapping[] - 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 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 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_ Sequence[str]types 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 .
- 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_ Sequence[str]accounts - 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[DataSource To Index Field Mapping] - 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.
- secret
Arn 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 .
- exclude
Mime List<String>Types 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 .
- 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.
- exclude
User List<String>Accounts - 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 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.
- field
Mappings 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. - inclusion
Patterns 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
- Lambda
Arn string - The Amazon Resource Name (ARN) of an IAM role with permission to run a Lambda function during ingestion. For more information, see an IAM roles for Amazon Kendra .
- S3Bucket string
- Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions .
- Invocation
Condition Pulumi.Aws Native. Kendra. Inputs. Data Source Document Attribute Condition 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 string - The Amazon Resource Name (ARN) of an IAM role with permission to run a Lambda function during ingestion. For more information, see an IAM roles for Amazon Kendra .
- S3Bucket string
- Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions .
- Invocation
Condition DataSource Document Attribute Condition 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 String - The Amazon Resource Name (ARN) of an IAM role with permission to run a Lambda function during ingestion. For more information, see an IAM roles for Amazon Kendra .
- s3Bucket String
- Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions .
- invocation
Condition DataSource Document Attribute Condition 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 string - The Amazon Resource Name (ARN) of an IAM role with permission to run a Lambda function during ingestion. For more information, see an IAM roles for Amazon Kendra .
- s3Bucket string
- Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions .
- invocation
Condition DataSource Document Attribute Condition The condition used for when a Lambda function should be invoked.
For example, you can specify a condition that if there are empty date-time values, then Amazon Kendra should invoke a function that inserts the current date-time.
- lambda_
arn str - The Amazon Resource Name (ARN) of an IAM role with permission to run a Lambda function during ingestion. For more information, see an IAM roles for Amazon Kendra .
- s3_
bucket str - Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions .
- invocation_
condition DataSource Document Attribute Condition 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 String - The Amazon Resource Name (ARN) of an IAM role with permission to run a Lambda function during ingestion. For more information, see an IAM roles for Amazon Kendra .
- s3Bucket String
- Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions .
- invocation
Condition 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
- One
Drive Pulumi.Users Aws Native. Kendra. Inputs. Data Source One Drive Users - A list of user accounts whose documents should be indexed.
- Secret
Arn 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.
- Tenant
Domain string - The Azure Active Directory domain of the organization.
- Disable
Local boolGroups TRUE
to disable local groups information.- Exclusion
Patterns 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.
- Field
Mappings List<Pulumi.Aws Native. Kendra. Inputs. Data Source To Index Field Mapping> - 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 theUpdateIndex
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 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.
- One
Drive DataUsers Source One Drive Users - A list of user accounts whose documents should be indexed.
- Secret
Arn 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.
- Tenant
Domain string - The Azure Active Directory domain of the organization.
- Disable
Local boolGroups TRUE
to disable local groups information.- Exclusion
Patterns []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.
- Field
Mappings []DataSource To Index Field Mapping - 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 theUpdateIndex
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 []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 DataUsers Source One Drive Users - A list of user accounts whose documents should be indexed.
- secret
Arn 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.
- tenant
Domain String - The Azure Active Directory domain of the organization.
- disable
Local BooleanGroups TRUE
to disable local groups information.- exclusion
Patterns 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.
- field
Mappings List<DataSource To Index Field Mapping> - 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 theUpdateIndex
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 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.
- one
Drive DataUsers Source One Drive Users - A list of user accounts whose documents should be indexed.
- secret
Arn 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.
- tenant
Domain string - The Azure Active Directory domain of the organization.
- disable
Local booleanGroups TRUE
to disable local groups information.- exclusion
Patterns 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.
- field
Mappings DataSource To Index Field Mapping[] - 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 theUpdateIndex
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 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_ Datausers Source One Drive Users - A list of user accounts whose documents should be indexed.
- secret_
arn 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 str - The Azure Active Directory domain of the organization.
- disable_
local_ boolgroups 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[DataSource To Index Field Mapping] - 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 theUpdateIndex
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.
- one
Drive Property MapUsers - A list of user accounts whose documents should be indexed.
- secret
Arn 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.
- tenant
Domain String - The Azure Active Directory domain of the organization.
- disable
Local BooleanGroups TRUE
to disable local groups information.- exclusion
Patterns 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.
- field
Mappings 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 theUpdateIndex
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 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
- One
Drive List<string>User List - 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 theOneDriveUserS3Path
field to specify the location of a file containing a list of users. - One
Drive Pulumi.User S3Path Aws Native. Kendra. Inputs. Data Source S3Path - The S3 bucket location of a file containing a list of users whose documents should be indexed.
- One
Drive []stringUser List - 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 theOneDriveUserS3Path
field to specify the location of a file containing a list of users. - One
Drive DataUser S3Path Source S3Path - The S3 bucket location of a file containing a list of users whose documents should be indexed.
- one
Drive List<String>User List - 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 theOneDriveUserS3Path
field to specify the location of a file containing a list of users. - one
Drive DataUser S3Path Source S3Path - The S3 bucket location of a file containing a list of users whose documents should be indexed.
- one
Drive string[]User List - 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 theOneDriveUserS3Path
field to specify the location of a file containing a list of users. - one
Drive DataUser S3Path Source S3Path - The S3 bucket location of a file containing a list of users whose documents should be indexed.
- one_
drive_ Sequence[str]user_ list - 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 theOneDriveUserS3Path
field to specify the location of a file containing a list of users. - one_
drive_ Datauser_ s3_ path Source S3Path - The S3 bucket location of a file containing a list of users whose documents should be indexed.
- one
Drive List<String>User List - 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 theOneDriveUserS3Path
field to specify the location of a file containing a list of users. - one
Drive Property MapUser S3Path - The S3 bucket location of a file containing a list of users whose documents should be indexed.
DataSourceProxyConfiguration, DataSourceProxyConfigurationArgs
- Host string
The name of the website host you want to connect to via a web proxy server.
For example, the host name of https://a.example.com/page1.html is "a.example.com".
- Port int
The port number of the website host you want to connect to via a web proxy server.
For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
- Credentials string
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret. You create a secret to store your credentials in AWS Secrets Manager
The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.
- Host string
The name of the website host you want to connect to via a web proxy server.
For example, the host name of https://a.example.com/page1.html is "a.example.com".
- Port int
The port number of the website host you want to connect to via a web proxy server.
For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
- Credentials string
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret. You create a secret to store your credentials in AWS Secrets Manager
The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.
- host String
The name of the website host you want to connect to via a web proxy server.
For example, the host name of https://a.example.com/page1.html is "a.example.com".
- port 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 string
The name of the website host you want to connect to via a web proxy server.
For example, the host name of https://a.example.com/page1.html is "a.example.com".
- port number
The port number of the website host you want to connect to via a web proxy server.
For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
- credentials string
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret. You create a secret to store your credentials in AWS Secrets Manager
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 str
The name of the website host you want to connect to via a web proxy server.
For example, the host name of https://a.example.com/page1.html is "a.example.com".
- port int
The port number of the website host you want to connect to via a web proxy server.
For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
- credentials str
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret. You create a secret to store your credentials in AWS Secrets Manager
The credentials are optional. You use a secret if web proxy credentials are required to connect to a website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores your credentials.
- host String
The name of the website host you want to connect to via a web proxy server.
For example, the host name of https://a.example.com/page1.html is "a.example.com".
- port 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
- Double
Quotes - DOUBLE_QUOTES
- None
- NONE
- Data
Source Query Identifiers Enclosing Option Double Quotes - DOUBLE_QUOTES
- Data
Source Query Identifiers Enclosing Option None - NONE
- Double
Quotes - DOUBLE_QUOTES
- None
- NONE
- Double
Quotes - DOUBLE_QUOTES
- None
- NONE
- DOUBLE_QUOTES
- DOUBLE_QUOTES
- NONE
- NONE
- "DOUBLE_QUOTES"
- DOUBLE_QUOTES
- "NONE"
- NONE
DataSourceS3DataSourceConfiguration, DataSourceS3DataSourceConfigurationArgs
- Bucket
Name string - The name of the bucket that contains the documents.
- Access
Control Pulumi.List Configuration Aws Native. Kendra. Inputs. Data Source Access Control List Configuration - 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 Pulumi.Configuration Aws Native. Kendra. Inputs. Data Source Documents Metadata Configuration - 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 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.
- Inclusion
Patterns 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.
- Inclusion
Prefixes List<string> - A list of S3 prefixes for the documents that should be included in the index.
- Bucket
Name string - The name of the bucket that contains the documents.
- Access
Control DataList Configuration Source Access Control List Configuration - 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 DataConfiguration Source Documents Metadata Configuration - 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 []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.
- Inclusion
Patterns []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.
- Inclusion
Prefixes []string - A list of S3 prefixes for the documents that should be included in the index.
- bucket
Name String - The name of the bucket that contains the documents.
- access
Control DataList Configuration Source Access Control List Configuration - 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 DataConfiguration Source Documents Metadata Configuration - 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 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.
- inclusion
Patterns 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.
- inclusion
Prefixes List<String> - A list of S3 prefixes for the documents that should be included in the index.
- bucket
Name string - The name of the bucket that contains the documents.
- access
Control DataList Configuration Source Access Control List Configuration - 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 DataConfiguration Source Documents Metadata Configuration - 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 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.
- inclusion
Patterns 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.
- inclusion
Prefixes string[] - A list of S3 prefixes for the documents that should be included in the index.
- bucket_
name str - The name of the bucket that contains the documents.
- access_
control_ Datalist_ configuration Source Access Control List Configuration - 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_ Dataconfiguration Source Documents Metadata Configuration - 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.
- bucket
Name String - The name of the bucket that contains the documents.
- access
Control Property MapList Configuration - 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 Property MapConfiguration - 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 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.
- inclusion
Patterns 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.
- inclusion
Prefixes List<String> - A list of S3 prefixes for the documents that should be included in the index.
DataSourceS3Path, DataSourceS3PathArgs
DataSourceSalesforceChatterFeedConfiguration, DataSourceSalesforceChatterFeedConfigurationArgs
- Document
Data stringField Name - The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the
Body
column. - Document
Title stringField Name - 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 List<Pulumi.Aws Native. Kendra. Inputs. Data Source To Index Field Mapping> - Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
- Include
Filter List<Pulumi.Types Aws Native. Kendra. Data Source Salesforce Chatter Feed Include Filter Type> - 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 specifySTANDARD_USER
only documents for Salesforce standard users are documented. You can specify both.
- Document
Data stringField Name - The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the
Body
column. - Document
Title stringField Name - 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 []DataSource To Index Field Mapping - Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
- Include
Filter []DataTypes Source Salesforce Chatter Feed Include Filter Type - 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 specifySTANDARD_USER
only documents for Salesforce standard users are documented. You can specify both.
- document
Data StringField Name - The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the
Body
column. - document
Title StringField Name - 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 List<DataSource To Index Field Mapping> - Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
- include
Filter List<DataTypes Source Salesforce Chatter Feed Include Filter Type> - 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 specifySTANDARD_USER
only documents for Salesforce standard users are documented. You can specify both.
- document
Data stringField Name - The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the
Body
column. - document
Title stringField Name - 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 DataSource To Index Field Mapping[] - Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
- include
Filter DataTypes Source Salesforce Chatter Feed Include Filter Type[] - 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 specifySTANDARD_USER
only documents for Salesforce standard users are documented. You can specify both.
- document_
data_ strfield_ name - The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the
Body
column. - document_
title_ strfield_ name - 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[DataSource To Index Field Mapping] - Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
- include_
filter_ Sequence[Datatypes Source Salesforce Chatter Feed Include Filter Type] - 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 specifySTANDARD_USER
only documents for Salesforce standard users are documented. You can specify both.
- document
Data StringField Name - The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the
Body
column. - document
Title StringField Name - 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 List<Property Map> - Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
- include
Filter List<"ACTIVE_USER" | "STANDARD_USER">Types - 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 specifySTANDARD_USER
only documents for Salesforce standard users are documented. You can specify both.
DataSourceSalesforceChatterFeedIncludeFilterType, DataSourceSalesforceChatterFeedIncludeFilterTypeArgs
- Active
User - ACTIVE_USER
- Standard
User - STANDARD_USER
- Data
Source Salesforce Chatter Feed Include Filter Type Active User - ACTIVE_USER
- Data
Source Salesforce Chatter Feed Include Filter Type Standard User - STANDARD_USER
- Active
User - ACTIVE_USER
- Standard
User - STANDARD_USER
- Active
User - ACTIVE_USER
- Standard
User - STANDARD_USER
- ACTIVE_USER
- ACTIVE_USER
- STANDARD_USER
- STANDARD_USER
- "ACTIVE_USER"
- ACTIVE_USER
- "STANDARD_USER"
- STANDARD_USER
DataSourceSalesforceConfiguration, DataSourceSalesforceConfigurationArgs
- Secret
Arn 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.
- Server
Url string - The instance URL for the Salesforce site that you want to index.
- Chatter
Feed Pulumi.Configuration Aws Native. Kendra. Inputs. Data Source Salesforce Chatter Feed Configuration - Configuration information for Salesforce chatter feeds.
- Crawl
Attachments bool - Indicates whether Amazon Kendra should index attachments to Salesforce objects.
- Exclude
Attachment List<string>File Patterns 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 List<string>File Patterns 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 Pulumi.Configuration Aws Native. Kendra. Inputs. Data Source Salesforce Knowledge Article Configuration - 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 Pulumi.Attachment Configuration Aws Native. Kendra. Inputs. Data Source Salesforce Standard Object Attachment Configuration - Configuration information for processing attachments to Salesforce standard objects.
- Standard
Object List<Pulumi.Configurations Aws Native. Kendra. Inputs. Data Source Salesforce Standard Object Configuration> - Configuration of the Salesforce standard objects that Amazon Kendra indexes.
- Secret
Arn 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.
- Server
Url string - The instance URL for the Salesforce site that you want to index.
- Chatter
Feed DataConfiguration Source Salesforce Chatter Feed Configuration - Configuration information for Salesforce chatter feeds.
- Crawl
Attachments bool - Indicates whether Amazon Kendra should index attachments to Salesforce objects.
- Exclude
Attachment []stringFile Patterns 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 []stringFile Patterns 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 DataConfiguration Source Salesforce Knowledge Article Configuration - 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 DataAttachment Configuration Source Salesforce Standard Object Attachment Configuration - Configuration information for processing attachments to Salesforce standard objects.
- Standard
Object []DataConfigurations Source Salesforce Standard Object Configuration - Configuration of the Salesforce standard objects that Amazon Kendra indexes.
- secret
Arn 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.
- server
Url String - The instance URL for the Salesforce site that you want to index.
- chatter
Feed DataConfiguration Source Salesforce Chatter Feed Configuration - Configuration information for Salesforce chatter feeds.
- crawl
Attachments Boolean - Indicates whether Amazon Kendra should index attachments to Salesforce objects.
- exclude
Attachment List<String>File Patterns 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 List<String>File Patterns 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 DataConfiguration Source Salesforce Knowledge Article Configuration - 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 DataAttachment Configuration Source Salesforce Standard Object Attachment Configuration - Configuration information for processing attachments to Salesforce standard objects.
- standard
Object List<DataConfigurations Source Salesforce Standard Object Configuration> - Configuration of the Salesforce standard objects that Amazon Kendra indexes.
- secret
Arn 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.
- server
Url string - The instance URL for the Salesforce site that you want to index.
- chatter
Feed DataConfiguration Source Salesforce Chatter Feed Configuration - Configuration information for Salesforce chatter feeds.
- crawl
Attachments boolean - Indicates whether Amazon Kendra should index attachments to Salesforce objects.
- exclude
Attachment string[]File Patterns 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 string[]File Patterns 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 DataConfiguration Source Salesforce Knowledge Article Configuration - 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 DataAttachment Configuration Source Salesforce Standard Object Attachment Configuration - Configuration information for processing attachments to Salesforce standard objects.
- standard
Object DataConfigurations Source Salesforce Standard Object Configuration[] - Configuration of the Salesforce standard objects that Amazon Kendra indexes.
- secret_
arn 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 str - The instance URL for the Salesforce site that you want to index.
- chatter_
feed_ Dataconfiguration Source Salesforce Chatter Feed Configuration - Configuration information for Salesforce chatter feeds.
- crawl_
attachments bool - Indicates whether Amazon Kendra should index attachments to Salesforce objects.
- exclude_
attachment_ Sequence[str]file_ patterns 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_ Sequence[str]file_ patterns 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_ Dataconfiguration Source Salesforce Knowledge Article Configuration - 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_ Dataattachment_ configuration Source Salesforce Standard Object Attachment Configuration - Configuration information for processing attachments to Salesforce standard objects.
- standard_
object_ Sequence[Dataconfigurations Source Salesforce Standard Object Configuration] - Configuration of the Salesforce standard objects that Amazon Kendra indexes.
- secret
Arn 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.
- server
Url String - The instance URL for the Salesforce site that you want to index.
- chatter
Feed Property MapConfiguration - Configuration information for Salesforce chatter feeds.
- crawl
Attachments Boolean - Indicates whether Amazon Kendra should index attachments to Salesforce objects.
- exclude
Attachment List<String>File Patterns 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 List<String>File Patterns 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 Property MapConfiguration - 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 Property MapAttachment Configuration - Configuration information for processing attachments to Salesforce standard objects.
- standard
Object List<Property Map>Configurations - Configuration of the Salesforce standard objects that Amazon Kendra indexes.
DataSourceSalesforceCustomKnowledgeArticleTypeConfiguration, DataSourceSalesforceCustomKnowledgeArticleTypeConfigurationArgs
- document
Data StringField Name - name String
- document
Title StringField Name - field
Mappings List<Property Map>
DataSourceSalesforceKnowledgeArticleConfiguration, DataSourceSalesforceKnowledgeArticleConfigurationArgs
- Included
States List<Pulumi.Aws Native. Kendra. Data Source Salesforce Knowledge Article State> - Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.
- Custom
Knowledge List<Pulumi.Article Type Configurations Aws Native. Kendra. Inputs. Data Source Salesforce Custom Knowledge Article Type Configuration> - Configuration information for custom Salesforce knowledge articles.
- Standard
Knowledge Pulumi.Article Type Configuration Aws Native. Kendra. Inputs. Data Source Salesforce Standard Knowledge Article Type Configuration - Configuration information for standard Salesforce knowledge articles.
- Included
States []DataSource Salesforce Knowledge Article State - Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.
- Custom
Knowledge []DataArticle Type Configurations Source Salesforce Custom Knowledge Article Type Configuration - Configuration information for custom Salesforce knowledge articles.
- Standard
Knowledge DataArticle Type Configuration Source Salesforce Standard Knowledge Article Type Configuration - Configuration information for standard Salesforce knowledge articles.
- included
States List<DataSource Salesforce Knowledge Article State> - Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.
- custom
Knowledge List<DataArticle Type Configurations Source Salesforce Custom Knowledge Article Type Configuration> - Configuration information for custom Salesforce knowledge articles.
- standard
Knowledge DataArticle Type Configuration Source Salesforce Standard Knowledge Article Type Configuration - Configuration information for standard Salesforce knowledge articles.
- included
States DataSource Salesforce Knowledge Article State[] - Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.
- custom
Knowledge DataArticle Type Configurations Source Salesforce Custom Knowledge Article Type Configuration[] - Configuration information for custom Salesforce knowledge articles.
- standard
Knowledge DataArticle Type Configuration Source Salesforce Standard Knowledge Article Type Configuration - Configuration information for standard Salesforce knowledge articles.
- included_
states Sequence[DataSource Salesforce Knowledge Article State] - Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.
- custom_
knowledge_ Sequence[Dataarticle_ type_ configurations Source Salesforce Custom Knowledge Article Type Configuration] - Configuration information for custom Salesforce knowledge articles.
- standard_
knowledge_ Dataarticle_ type_ configuration Source Salesforce Standard Knowledge Article Type Configuration - Configuration information for standard Salesforce knowledge articles.
- included
States 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.
- custom
Knowledge List<Property Map>Article Type Configurations - Configuration information for custom Salesforce knowledge articles.
- standard
Knowledge Property MapArticle Type Configuration - Configuration information for standard Salesforce knowledge articles.
DataSourceSalesforceKnowledgeArticleState, DataSourceSalesforceKnowledgeArticleStateArgs
- Draft
- DRAFT
- Published
- PUBLISHED
- Archived
- ARCHIVED
- Data
Source Salesforce Knowledge Article State Draft - DRAFT
- Data
Source Salesforce Knowledge Article State Published - PUBLISHED
- Data
Source Salesforce Knowledge Article State Archived - 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
- Document
Data stringField Name - The name of the field that contains the document data to index.
- Document
Title stringField Name - The name of the field that contains the document title.
- Field
Mappings List<Pulumi.Aws Native. Kendra. Inputs. Data Source To Index Field Mapping> - 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 stringField Name - The name of the field that contains the document data to index.
- Document
Title stringField Name - The name of the field that contains the document title.
- Field
Mappings []DataSource To Index Field Mapping - 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 StringField Name - The name of the field that contains the document data to index.
- document
Title StringField Name - The name of the field that contains the document title.
- field
Mappings List<DataSource To Index Field Mapping> - 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 stringField Name - The name of the field that contains the document data to index.
- document
Title stringField Name - The name of the field that contains the document title.
- field
Mappings DataSource To Index Field Mapping[] - 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_ strfield_ name - The name of the field that contains the document data to index.
- document_
title_ strfield_ name - The name of the field that contains the document title.
- field_
mappings Sequence[DataSource To Index Field Mapping] - 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 StringField Name - The name of the field that contains the document data to index.
- document
Title StringField Name - The name of the field that contains the document title.
- field
Mappings 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
- Document
Title stringField Name - The name of the field used for the document title.
- Field
Mappings List<Pulumi.Aws Native. Kendra. Inputs. Data Source To Index Field Mapping> - One or more objects that map fields in attachments to Amazon Kendra index fields.
- Document
Title stringField Name - The name of the field used for the document title.
- Field
Mappings []DataSource To Index Field Mapping - One or more objects that map fields in attachments to Amazon Kendra index fields.
- document
Title StringField Name - The name of the field used for the document title.
- field
Mappings List<DataSource To Index Field Mapping> - One or more objects that map fields in attachments to Amazon Kendra index fields.
- document
Title stringField Name - The name of the field used for the document title.
- field
Mappings DataSource To Index Field Mapping[] - One or more objects that map fields in attachments to Amazon Kendra index fields.
- document_
title_ strfield_ name - The name of the field used for the document title.
- field_
mappings Sequence[DataSource To Index Field Mapping] - One or more objects that map fields in attachments to Amazon Kendra index fields.
- document
Title StringField Name - The name of the field used for the document title.
- field
Mappings 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
- Data
Source Salesforce Standard Object Name Account - ACCOUNT
- Data
Source Salesforce Standard Object Name Campaign - CAMPAIGN
- Data
Source Salesforce Standard Object Name Case - CASE
- Data
Source Salesforce Standard Object Name Contact - CONTACT
- Data
Source Salesforce Standard Object Name Contract - CONTRACT
- Data
Source Salesforce Standard Object Name Document - DOCUMENT
- Data
Source Salesforce Standard Object Name Group - GROUP
- Data
Source Salesforce Standard Object Name Idea - IDEA
- Data
Source Salesforce Standard Object Name Lead - LEAD
- Data
Source Salesforce Standard Object Name Opportunity - OPPORTUNITY
- Data
Source Salesforce Standard Object Name Partner - PARTNER
- Data
Source Salesforce Standard Object Name Pricebook - PRICEBOOK
- Data
Source Salesforce Standard Object Name Product - PRODUCT
- Data
Source Salesforce Standard Object Name Profile - PROFILE
- Data
Source Salesforce Standard Object Name Solution - SOLUTION
- Data
Source Salesforce Standard Object Name Task - TASK
- Data
Source Salesforce Standard Object Name 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
- "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
- Http
Basic - HTTP_BASIC
- Oauth2
- OAUTH2
- Data
Source Service Now Authentication Type Http Basic - HTTP_BASIC
- Data
Source Service Now Authentication Type Oauth2 - OAUTH2
- Http
Basic - HTTP_BASIC
- Oauth2
- OAUTH2
- Http
Basic - HTTP_BASIC
- Oauth2
- OAUTH2
- HTTP_BASIC
- HTTP_BASIC
- OAUTH2
- OAUTH2
- "HTTP_BASIC"
- HTTP_BASIC
- "OAUTH2"
- OAUTH2
DataSourceServiceNowBuildVersionType, DataSourceServiceNowBuildVersionTypeArgs
- London
- LONDON
- Others
- OTHERS
- Data
Source Service Now Build Version Type London - LONDON
- Data
Source Service Now Build Version Type Others - OTHERS
- London
- LONDON
- Others
- OTHERS
- London
- LONDON
- Others
- OTHERS
- LONDON
- LONDON
- OTHERS
- OTHERS
- "LONDON"
- LONDON
- "OTHERS"
- OTHERS
DataSourceServiceNowConfiguration, DataSourceServiceNowConfigurationArgs
- Host
Url string - The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
- Secret
Arn 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 .
- Service
Now Pulumi.Build Version Aws Native. Kendra. Data Source Service Now Build Version Type - The identifier of the release that the ServiceNow host is running. If the host is not running the
LONDON
release, useOTHERS
. - Authentication
Type Pulumi.Aws Native. Kendra. Data Source Service Now Authentication Type 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 theSecretArn
field. If you chooseOAUTH2
, 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 Pulumi.Configuration Aws Native. Kendra. Inputs. Data Source Service Now Knowledge Article Configuration - Configuration information for crawling knowledge articles in the ServiceNow site.
- Service
Catalog Pulumi.Configuration Aws Native. Kendra. Inputs. Data Source Service Now Service Catalog Configuration - Configuration information for crawling service catalogs in the ServiceNow site.
- Host
Url string - The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
- Secret
Arn 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 .
- Service
Now DataBuild Version Source Service Now Build Version Type - The identifier of the release that the ServiceNow host is running. If the host is not running the
LONDON
release, useOTHERS
. - Authentication
Type DataSource Service Now Authentication Type 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 theSecretArn
field. If you chooseOAUTH2
, 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 DataConfiguration Source Service Now Knowledge Article Configuration - Configuration information for crawling knowledge articles in the ServiceNow site.
- Service
Catalog DataConfiguration Source Service Now Service Catalog Configuration - Configuration information for crawling service catalogs in the ServiceNow site.
- host
Url String - The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
- secret
Arn 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 .
- service
Now DataBuild Version Source Service Now Build Version Type - The identifier of the release that the ServiceNow host is running. If the host is not running the
LONDON
release, useOTHERS
. - authentication
Type DataSource Service Now Authentication Type 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 theSecretArn
field. If you chooseOAUTH2
, 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 DataConfiguration Source Service Now Knowledge Article Configuration - Configuration information for crawling knowledge articles in the ServiceNow site.
- service
Catalog DataConfiguration Source Service Now Service Catalog Configuration - Configuration information for crawling service catalogs in the ServiceNow site.
- host
Url string - The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
- secret
Arn 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 .
- service
Now DataBuild Version Source Service Now Build Version Type - The identifier of the release that the ServiceNow host is running. If the host is not running the
LONDON
release, useOTHERS
. - authentication
Type DataSource Service Now Authentication Type 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 theSecretArn
field. If you chooseOAUTH2
, 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 DataConfiguration Source Service Now Knowledge Article Configuration - Configuration information for crawling knowledge articles in the ServiceNow site.
- service
Catalog DataConfiguration Source Service Now Service Catalog Configuration - Configuration information for crawling service catalogs in the ServiceNow site.
- host_
url str - The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
- secret_
arn str - 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_ Databuild_ version Source Service Now Build Version Type - The identifier of the release that the ServiceNow host is running. If the host is not running the
LONDON
release, useOTHERS
. - authentication_
type DataSource Service Now Authentication Type 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 theSecretArn
field. If you chooseOAUTH2
, 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_ Dataconfiguration Source Service Now Knowledge Article Configuration - Configuration information for crawling knowledge articles in the ServiceNow site.
- service_
catalog_ Dataconfiguration Source Service Now Service Catalog Configuration - Configuration information for crawling service catalogs in the ServiceNow site.
- host
Url String - The ServiceNow instance that the data source connects to. The host endpoint should look like the following: {instance}.service-now.com.
- secret
Arn 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 .
- service
Now "LONDON" | "OTHERS"Build Version - The identifier of the release that the ServiceNow host is running. If the host is not running the
LONDON
release, useOTHERS
. - authentication
Type "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 theSecretArn
field. If you chooseOAUTH2
, 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 Property MapConfiguration - Configuration information for crawling knowledge articles in the ServiceNow site.
- service
Catalog Property MapConfiguration - Configuration information for crawling service catalogs in the ServiceNow site.
DataSourceServiceNowKnowledgeArticleConfiguration, DataSourceServiceNowKnowledgeArticleConfigurationArgs
- Document
Data stringField Name - 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 stringField Name - The name of the ServiceNow field that is mapped to the index document title field.
- Exclude
Attachment List<string>File Patterns - 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 List<Pulumi.Aws Native. Kendra. Inputs. Data Source To Index Field Mapping> - 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 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 .
- Include
Attachment List<string>File Patterns - 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 stringField Name - 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 stringField Name - The name of the ServiceNow field that is mapped to the index document title field.
- Exclude
Attachment []stringFile Patterns - 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 []DataSource To Index Field Mapping - 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 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 .
- Include
Attachment []stringFile Patterns - 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 StringField Name - The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
- crawl
Attachments Boolean TRUE
to index attachments to knowledge articles.- document
Title StringField Name - The name of the ServiceNow field that is mapped to the index document title field.
- exclude
Attachment List<String>File Patterns - 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 List<DataSource To Index Field Mapping> - 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 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 .
- include
Attachment List<String>File Patterns - 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 stringField Name - The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
- crawl
Attachments boolean TRUE
to index attachments to knowledge articles.- document
Title stringField Name - The name of the ServiceNow field that is mapped to the index document title field.
- exclude
Attachment string[]File Patterns - 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 DataSource To Index Field Mapping[] - 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 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 .
- include
Attachment string[]File Patterns - 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_ strfield_ name - 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_ strfield_ name - The name of the ServiceNow field that is mapped to the index document title field.
- exclude_
attachment_ Sequence[str]file_ patterns - 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[DataSource To Index Field Mapping] - 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_ Sequence[str]file_ patterns - 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 StringField Name - The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
- crawl
Attachments Boolean TRUE
to index attachments to knowledge articles.- document
Title StringField Name - The name of the ServiceNow field that is mapped to the index document title field.
- exclude
Attachment List<String>File Patterns - 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 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. - filter
Query 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 .
- include
Attachment List<String>File Patterns - 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
- Document
Data stringField Name - 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 stringField Name - The name of the ServiceNow field that is mapped to the index document title field.
- Exclude
Attachment List<string>File Patterns 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 List<Pulumi.Aws Native. Kendra. Inputs. Data Source To Index Field Mapping> - 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 List<string>File Patterns 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 stringField Name - 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 stringField Name - The name of the ServiceNow field that is mapped to the index document title field.
- Exclude
Attachment []stringFile Patterns 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 []DataSource To Index Field Mapping - 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 []stringFile Patterns 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 StringField Name - The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
- crawl
Attachments Boolean TRUE
to index attachments to service catalog items.- document
Title StringField Name - The name of the ServiceNow field that is mapped to the index document title field.
- exclude
Attachment List<String>File Patterns 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 List<DataSource To Index Field Mapping> - 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 List<String>File Patterns 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 stringField Name - The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
- crawl
Attachments boolean TRUE
to index attachments to service catalog items.- document
Title stringField Name - The name of the ServiceNow field that is mapped to the index document title field.
- exclude
Attachment string[]File Patterns 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 DataSource To Index Field Mapping[] - 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 string[]File Patterns 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_ strfield_ name - 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_ strfield_ name - The name of the ServiceNow field that is mapped to the index document title field.
- exclude_
attachment_ Sequence[str]file_ patterns 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[DataSource To Index Field Mapping] - 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_ Sequence[str]file_ patterns 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 StringField Name - The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
- crawl
Attachments Boolean TRUE
to index attachments to service catalog items.- document
Title StringField Name - The name of the ServiceNow field that is mapped to the index document title field.
- exclude
Attachment List<String>File Patterns 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 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. - include
Attachment List<String>File Patterns 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
- Secret
Arn 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 .
- Pulumi.
Aws Native. Kendra. Data Source Share Point Configuration Share Point Version - The version of Microsoft SharePoint that you use.
- Urls List<string>
- The Microsoft SharePoint site URLs for the documents you want to index.
- Crawl
Attachments bool TRUE
to index document attachments.- Disable
Local boolGroups TRUE
to disable local groups information.- Document
Title stringField Name - The Microsoft SharePoint attribute field that contains the title of the document.
- Exclusion
Patterns 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.
- Field
Mappings List<Pulumi.Aws Native. Kendra. Inputs. Data Source To Index Field Mapping> - 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 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.
- Ssl
Certificate Pulumi.S3Path Aws Native. Kendra. Inputs. Data Source S3Path - Information required to find a specific file in an Amazon S3 bucket.
- Use
Change boolLog 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 Pulumi.Aws Native. Kendra. Inputs. Data Source Vpc Configuration - Provides information for connecting to an Amazon VPC.
- Secret
Arn 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 .
- Data
Source Share Point Configuration Share Point Version - The version of Microsoft SharePoint that you use.
- Urls []string
- The Microsoft SharePoint site URLs for the documents you want to index.
- Crawl
Attachments bool TRUE
to index document attachments.- Disable
Local boolGroups TRUE
to disable local groups information.- Document
Title stringField Name - The Microsoft SharePoint attribute field that contains the title of the document.
- Exclusion
Patterns []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.
- Field
Mappings []DataSource To Index Field Mapping - 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 []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.
- Ssl
Certificate DataS3Path Source S3Path - Information required to find a specific file in an Amazon S3 bucket.
- Use
Change boolLog 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 DataSource Vpc Configuration - Provides information for connecting to an Amazon VPC.
- secret
Arn 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 .
- Data
Source Share Point Configuration Share Point Version - The version of Microsoft SharePoint that you use.
- urls List<String>
- The Microsoft SharePoint site URLs for the documents you want to index.
- crawl
Attachments Boolean TRUE
to index document attachments.- disable
Local BooleanGroups TRUE
to disable local groups information.- document
Title StringField Name - The Microsoft SharePoint attribute field that contains the title of the document.
- exclusion
Patterns 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.
- field
Mappings List<DataSource To Index Field Mapping> - 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 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.
- ssl
Certificate DataS3Path Source S3Path - Information required to find a specific file in an Amazon S3 bucket.
- use
Change BooleanLog 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 DataSource Vpc Configuration - Provides information for connecting to an Amazon VPC.
- secret
Arn 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 .
- Data
Source Share Point Configuration Share Point Version - The version of Microsoft SharePoint that you use.
- urls string[]
- The Microsoft SharePoint site URLs for the documents you want to index.
- crawl
Attachments boolean TRUE
to index document attachments.- disable
Local booleanGroups TRUE
to disable local groups information.- document
Title stringField Name - The Microsoft SharePoint attribute field that contains the title of the document.
- exclusion
Patterns 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.
- field
Mappings DataSource To Index Field Mapping[] - 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 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.
- ssl
Certificate DataS3Path Source S3Path - Information required to find a specific file in an Amazon S3 bucket.
- use
Change booleanLog 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 DataSource Vpc Configuration - Provides information for connecting to an Amazon VPC.
- secret_
arn 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 .
- Data
Source Share Point Configuration Share Point Version - The version of Microsoft SharePoint that you use.
- urls Sequence[str]
- The Microsoft SharePoint site URLs for the documents you want to index.
- crawl_
attachments bool TRUE
to index document attachments.- disable_
local_ boolgroups TRUE
to disable local groups information.- document_
title_ strfield_ name - 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[DataSource To Index Field Mapping] - 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_ Datas3_ path Source S3Path - Information required to find a specific file in an Amazon S3 bucket.
- use_
change_ boollog 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 DataSource Vpc Configuration - Provides information for connecting to an Amazon VPC.
- secret
Arn 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 .
- "SHAREPOINT_ONLINE" | "SHAREPOINT_2013" | "SHAREPOINT_2016"
- The version of Microsoft SharePoint that you use.
- urls List<String>
- The Microsoft SharePoint site URLs for the documents you want to index.
- crawl
Attachments Boolean TRUE
to index document attachments.- disable
Local BooleanGroups TRUE
to disable local groups information.- document
Title StringField Name - The Microsoft SharePoint attribute field that contains the title of the document.
- exclusion
Patterns 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.
- field
Mappings 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 . - inclusion
Patterns 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.
- ssl
Certificate Property MapS3Path - Information required to find a specific file in an Amazon S3 bucket.
- use
Change BooleanLog 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 Property Map - Provides information for connecting to an Amazon VPC.
DataSourceSharePointConfigurationSharePointVersion, DataSourceSharePointConfigurationSharePointVersionArgs
- Sharepoint
Online - SHAREPOINT_ONLINE
- Sharepoint2013
- SHAREPOINT_2013
- Sharepoint2016
- SHAREPOINT_2016
- Data
Source Share Point Configuration Share Point Version Sharepoint Online - SHAREPOINT_ONLINE
- Data
Source Share Point Configuration Share Point Version Sharepoint2013 - SHAREPOINT_2013
- Data
Source Share Point Configuration Share Point Version Sharepoint2016 - SHAREPOINT_2016
- Sharepoint
Online - SHAREPOINT_ONLINE
- Sharepoint2013
- SHAREPOINT_2013
- Sharepoint2016
- SHAREPOINT_2016
- Sharepoint
Online - 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
- Query
Identifiers Pulumi.Enclosing Option Aws Native. Kendra. Data Source Query Identifiers Enclosing Option 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
orNONE
.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 DataEnclosing Option Source Query Identifiers Enclosing Option 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
orNONE
.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 DataEnclosing Option Source Query Identifiers Enclosing Option 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
orNONE
.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 DataEnclosing Option Source Query Identifiers Enclosing Option 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
orNONE
.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_ Dataenclosing_ option Source Query Identifiers Enclosing Option 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
orNONE
.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 "DOUBLE_QUOTES" | "NONE"Enclosing Option 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
orNONE
.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
- Data
Source stringField Name - Index
Field stringName - Date
Field stringFormat
- Data
Source stringField Name - Index
Field stringName - Date
Field stringFormat
- data
Source StringField Name - index
Field StringName - date
Field StringFormat
- data
Source stringField Name - index
Field stringName - date
Field stringFormat
- data
Source StringField Name - index
Field StringName - date
Field StringFormat
DataSourceType, DataSourceTypeArgs
- S3
- S3
- Sharepoint
- SHAREPOINT
- Salesforce
- SALESFORCE
- Onedrive
- ONEDRIVE
- Servicenow
- SERVICENOW
- Database
- DATABASE
- Custom
- CUSTOM
- Confluence
- CONFLUENCE
- Googledrive
- GOOGLEDRIVE
- Webcrawler
- WEBCRAWLER
- Workdocs
- WORKDOCS
- Data
Source Type S3 - S3
- Data
Source Type Sharepoint - SHAREPOINT
- Data
Source Type Salesforce - SALESFORCE
- Data
Source Type Onedrive - ONEDRIVE
- Data
Source Type Servicenow - SERVICENOW
- Data
Source Type Database - DATABASE
- Data
Source Type Custom - CUSTOM
- Data
Source Type Confluence - CONFLUENCE
- Data
Source Type Googledrive - GOOGLEDRIVE
- Data
Source Type Webcrawler - WEBCRAWLER
- Data
Source Type 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
- "S3"
- S3
- "SHAREPOINT"
- SHAREPOINT
- "SALESFORCE"
- SALESFORCE
- "ONEDRIVE"
- ONEDRIVE
- "SERVICENOW"
- SERVICENOW
- "DATABASE"
- DATABASE
- "CUSTOM"
- CUSTOM
- "CONFLUENCE"
- CONFLUENCE
- "GOOGLEDRIVE"
- GOOGLEDRIVE
- "WEBCRAWLER"
- WEBCRAWLER
- "WORKDOCS"
- WORKDOCS
DataSourceVpcConfiguration, DataSourceVpcConfigurationArgs
- Security
Group List<string>Ids - 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 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.
- Security
Group []stringIds - 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 []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 List<String>Ids - 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 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.
- security
Group string[]Ids - 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 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_ Sequence[str]ids - A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.
- subnet_
ids Sequence[str] - A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
- security
Group List<String>Ids - 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 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
- Basic
Authentication List<Pulumi.Aws Native. Kendra. Inputs. Data Source Web Crawler Basic Authentication> 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 []DataSource Web Crawler Basic Authentication 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 List<DataSource Web Crawler Basic Authentication> 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 DataSource Web Crawler Basic Authentication[] 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[DataSource Web Crawler Basic Authentication] 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 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 string
- Host string
- Port int
- Credentials string
- Host string
- Port int
- credentials String
- host String
- port Integer
- credentials string
- host string
- port number
- credentials str
- host str
- port int
- credentials String
- host String
- port Number
DataSourceWebCrawlerConfiguration, DataSourceWebCrawlerConfigurationArgs
- Urls
Pulumi.
Aws Native. Kendra. Inputs. Data Source Web Crawler Urls 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 Pulumi.Aws Native. Kendra. Inputs. Data Source Web Crawler Authentication Configuration 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 doubleSize Per Page In Mega Bytes 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 intPer Page 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 intPer Minute Crawl Rate 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 Pulumi.Aws Native. Kendra. Inputs. Data Source Proxy Configuration 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 List<string>Patterns - 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 List<string>Patterns - 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
Data
Source Web Crawler Urls 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 DataSource Web Crawler Authentication Configuration 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 float64Size Per Page In Mega Bytes 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 intPer Page 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 intPer Minute Crawl Rate 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 DataSource Proxy Configuration 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 []stringPatterns - 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 []stringPatterns - 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
Data
Source Web Crawler Urls 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 DataSource Web Crawler Authentication Configuration 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 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.
- max
Content DoubleSize Per Page In Mega Bytes 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 IntegerPer Page 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 IntegerPer Minute Crawl Rate 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 DataSource Proxy Configuration 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 List<String>Patterns - 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 List<String>Patterns - 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
Data
Source Web Crawler Urls 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 DataSource Web Crawler Authentication Configuration 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 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.
- max
Content numberSize Per Page In Mega Bytes 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 numberPer Page 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 numberPer Minute Crawl Rate 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 DataSource Proxy Configuration 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 string[]Patterns - 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 string[]Patterns - 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
Data
Source Web Crawler Urls 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 DataSource Web Crawler Authentication Configuration 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_ floatsize_ per_ page_ in_ mega_ bytes 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_ intper_ page 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_ intper_ minute_ crawl_ rate 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 DataSource Proxy Configuration 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_ Sequence[str]patterns - 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_ Sequence[str]patterns - 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 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.
- authentication
Configuration 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.
- crawl
Depth 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.
- max
Content NumberSize Per Page In Mega Bytes 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 NumberPer Page 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 NumberPer Minute Crawl Rate 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 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 .
- url
Exclusion List<String>Patterns - 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 List<String>Patterns - 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
- Seed
Urls 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.
- Web
Crawler Pulumi.Mode Aws Native. Kendra. Data Source Web Crawler Seed Url Configuration Web Crawler Mode 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 []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.
- Web
Crawler DataMode Source Web Crawler Seed Url Configuration Web Crawler Mode 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 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.
- web
Crawler DataMode Source Web Crawler Seed Url Configuration Web Crawler Mode 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 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.
- web
Crawler DataMode Source Web Crawler Seed Url Configuration Web Crawler Mode You can choose one of the following modes:
HOST_ONLY
—crawl only the website host names. For example, if the seed URL is "abc.example.com", then only URLs with host name "abc.example.com" are crawled.SUBDOMAINS
—crawl the website host names with subdomains. For example, if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com" are also crawled.EVERYTHING
—crawl the website host names with subdomains and other domains that the web pages link to.
The default mode is set to
HOST_ONLY
.
- seed_
urls Sequence[str] The list of seed or starting point URLs of the websites you want to crawl.
The list can include a maximum of 100 seed URLs.
- web_
crawler_ Datamode Source Web Crawler Seed Url Configuration Web Crawler Mode 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 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.
- web
Crawler "HOST_ONLY" | "SUBDOMAINS" | "EVERYTHING"Mode 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
- Host
Only - HOST_ONLY
- Subdomains
- SUBDOMAINS
- Everything
- EVERYTHING
- Data
Source Web Crawler Seed Url Configuration Web Crawler Mode Host Only - HOST_ONLY
- Data
Source Web Crawler Seed Url Configuration Web Crawler Mode Subdomains - SUBDOMAINS
- Data
Source Web Crawler Seed Url Configuration Web Crawler Mode Everything - EVERYTHING
- Host
Only - HOST_ONLY
- Subdomains
- SUBDOMAINS
- Everything
- EVERYTHING
- Host
Only - HOST_ONLY
- Subdomains
- SUBDOMAINS
- Everything
- EVERYTHING
- HOST_ONLY
- HOST_ONLY
- SUBDOMAINS
- SUBDOMAINS
- EVERYTHING
- EVERYTHING
- "HOST_ONLY"
- HOST_ONLY
- "SUBDOMAINS"
- SUBDOMAINS
- "EVERYTHING"
- EVERYTHING
DataSourceWebCrawlerSiteMapsConfiguration, DataSourceWebCrawlerSiteMapsConfigurationArgs
- Site
Maps List<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 []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 List<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 string[] The list of sitemap URLs of the websites you want to crawl.
The list can include a maximum of three sitemap URLs.
- site_
maps Sequence[str] The list of sitemap URLs of the websites you want to crawl.
The list can include a maximum of three sitemap URLs.
- site
Maps 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
- Seed
Url Pulumi.Configuration Aws Native. Kendra. Inputs. Data Source Web Crawler Seed Url Configuration 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 Pulumi.Configuration Aws Native. Kendra. Inputs. Data Source Web Crawler Site Maps Configuration 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 DataConfiguration Source Web Crawler Seed Url Configuration 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 DataConfiguration Source Web Crawler Site Maps Configuration 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 DataConfiguration Source Web Crawler Seed Url Configuration 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 DataConfiguration Source Web Crawler Site Maps Configuration 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 DataConfiguration Source Web Crawler Seed Url Configuration 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 DataConfiguration Source Web Crawler Site Maps Configuration 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_ Dataconfiguration Source Web Crawler Seed Url Configuration 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_ Dataconfiguration Source Web Crawler Site Maps Configuration 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 Property MapConfiguration 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 Property MapConfiguration 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
- Organization
Id 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.
- 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 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.
- Field
Mappings List<Pulumi.Aws Native. Kendra. Inputs. Data Source To Index Field Mapping> - 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 theUpdateIndex
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 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.
- Use
Change boolLog 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 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.
- 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 []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.
- Field
Mappings []DataSource To Index Field Mapping - 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 theUpdateIndex
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 []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.
- Use
Change boolLog 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 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.
- crawl
Comments 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
.- exclusion
Patterns 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.
- field
Mappings List<DataSource To Index Field Mapping> - 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 theUpdateIndex
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 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.
- use
Change BooleanLog 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 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.
- crawl
Comments 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
.- exclusion
Patterns 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.
- field
Mappings DataSource To Index Field Mapping[] - 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 theUpdateIndex
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 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.
- use
Change booleanLog 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 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[DataSource To Index Field Mapping] - 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 theUpdateIndex
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_ boollog 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 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.
- crawl
Comments 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
.- exclusion
Patterns 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.
- field
Mappings 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 theUpdateIndex
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 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.
- use
Change BooleanLog 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
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.