@propulsionworks/cloudformation 0.0.2 → 0.1.0

package/out/exports/resources.generated/aws-kendra-datasource.d.ts

@@ -0,0 +1,1780 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type KendraDataSource = ResourceDefinitionWithAttributes<"AWS::Kendra::DataSource", KendraDataSourceProps, KendraDataSourceAttribs>;
+/**
+ * Creates a data source connector that you want to use with an Amazon Kendra index.
+ *
+ * You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.
+ *
+ * > `CreateDataSource` does *not* support connectors which [require a `TemplateConfiguration` object](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html) for connecting to Amazon Kendra .
+ */
+export type KendraDataSourceProps = {
+    /**
+     * Configuration information for altering document metadata and content during the document ingestion process.
+     */
+    CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration | undefined;
+    /**
+     * Configuration information for an Amazon Kendra data source. The contents of the configuration depend on the type of data source. You can only specify one type of data source in the configuration.
+     *
+     * You can't specify the `Configuration` parameter when the `Type` parameter is set to `CUSTOM` .
+     *
+     * The `Configuration` parameter is required for all other data sources.
+     */
+    DataSourceConfiguration?: DataSourceConfiguration | undefined;
+    /**
+     * A description for the data source connector.
+     */
+    Description?: string | undefined;
+    /**
+     * The identifier of the index you want to use with the data source connector.
+     */
+    IndexId: 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](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html) .
+     */
+    LanguageCode?: string | undefined;
+    /**
+     * The name of the data source.
+     */
+    Name: string;
+    /**
+     * The Amazon Resource Name (ARN) of a role with permission to access the data source.
+     *
+     * You can't specify the `RoleArn` parameter when the `Type` parameter is set to `CUSTOM` .
+     *
+     * The `RoleArn` parameter is required for all other data sources.
+     */
+    RoleArn?: string | undefined;
+    /**
+     * 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.
+     */
+    Schedule?: string | undefined;
+    /**
+     * An array of key-value pairs to apply to this resource
+     *
+     * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * The type of the data source.
+     */
+    Type: Type;
+};
+export type KendraDataSourceAttribs = {
+    /**
+     * 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`
+     */
+    Arn: string;
+    /**
+     * The identifier for the data source. For example:
+     *
+     * `b8cae438-6787-4091-8897-684a652bbb0a` .
+     */
+    Id: string;
+};
+/**
+ * Specifies access control list files for the documents in a data source.
+ */
+export type AccessControlListConfiguration = {
+    /**
+     * Path to the AWS S3 bucket that contains the access control list files.
+     */
+    KeyPath?: string | undefined;
+};
+/**
+ * Provides information about the column that should be used for filtering the query response by groups.
+ */
+export type AclConfiguration = {
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html) operation.
+     */
+    AllowedGroupsColumnName: string;
+};
+/**
+ * Provides information about how Amazon Kendra should use the columns of a database in an index.
+ */
+export type ColumnConfiguration = {
+    /**
+     * One to five columns that indicate when a document in the database has changed.
+     */
+    ChangeDetectingColumns: string[];
+    /**
+     * The column that contains the contents of the document.
+     */
+    DocumentDataColumnName: string;
+    /**
+     * The column that provides the document's identifier.
+     */
+    DocumentIdColumnName: string;
+    /**
+     * The column that contains the title of the document.
+     */
+    DocumentTitleColumnName?: string | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateIndex.html) operation.
+     */
+    FieldMappings?: DataSourceToIndexFieldMapping[] | undefined;
+};
+export type ConditionOperator = "GreaterThan" | "GreaterThanOrEquals" | "LessThan" | "LessThanOrEquals" | "Equals" | "NotEquals" | "Contains" | "NotContains" | "Exists" | "NotExists" | "BeginsWith";
+/**
+ * Configuration of attachment settings for the Confluence data source. Attachment settings are optional, if you don't specify settings attachments, Amazon Kendra won't index them.
+ */
+export type ConfluenceAttachmentConfiguration = {
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . 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.
+     */
+    AttachmentFieldMappings?: ConfluenceAttachmentToIndexFieldMapping[] | undefined;
+    /**
+     * `TRUE` to index attachments of pages and blogs in Confluence.
+     */
+    CrawlAttachments?: boolean | undefined;
+};
+export type ConfluenceAttachmentFieldName = "AUTHOR" | "CONTENT_TYPE" | "CREATED_DATE" | "DISPLAY_URL" | "FILE_SIZE" | "ITEM_TYPE" | "PARENT_ID" | "SPACE_KEY" | "SPACE_NAME" | "URL" | "VERSION";
+/**
+ * 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](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The Confuence data source field names must exist in your Confluence custom metadata.
+ */
+export type ConfluenceAttachmentToIndexFieldMapping = {
+    /**
+     * The name of the field in the data source.
+     *
+     * You must first create the index field using the `UpdateIndex` API.
+     */
+    DataSourceFieldName: ConfluenceAttachmentFieldName;
+    /**
+     * The format for date fields in the data source. If the field specified in `DataSourceFieldName` is a date field you must specify the date format. If the field is not a date field, an exception is thrown.
+     */
+    DateFieldFormat?: string | undefined;
+    /**
+     * The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
+     */
+    IndexFieldName: string;
+};
+/**
+ * Configuration of blog settings for the Confluence data source. Blogs are always indexed unless filtered from the index by the `ExclusionPatterns` or `InclusionPatterns` fields in the `ConfluenceConfiguration` object.
+ */
+export type ConfluenceBlogConfiguration = {
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The Confluence data source field names must exist in your Confluence custom metadata.
+     *
+     * If you specify the `BlogFieldMappings` parameter, you must specify at least one field mapping.
+     */
+    BlogFieldMappings?: ConfluenceBlogToIndexFieldMapping[] | undefined;
+};
+export type ConfluenceBlogFieldName = "AUTHOR" | "DISPLAY_URL" | "ITEM_TYPE" | "LABELS" | "PUBLISH_DATE" | "SPACE_KEY" | "SPACE_NAME" | "URL" | "VERSION";
+/**
+ * Maps attributes or field names of Confluence blog 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](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The Confluence data source field names must exist in your Confluence custom metadata.
+ */
+export type ConfluenceBlogToIndexFieldMapping = {
+    /**
+     * The name of the field in the data source.
+     */
+    DataSourceFieldName: ConfluenceBlogFieldName;
+    /**
+     * The format for date fields in the data source. If the field specified in `DataSourceFieldName` is a date field you must specify the date format. If the field is not a date field, an exception is thrown.
+     */
+    DateFieldFormat?: string | undefined;
+    /**
+     * The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
+     */
+    IndexFieldName: string;
+};
+/**
+ * Provides the configuration information to connect to Confluence as your data source.
+ */
+export type ConfluenceConfiguration = {
+    /**
+     * Configuration information for indexing attachments to Confluence blogs and pages.
+     */
+    AttachmentConfiguration?: ConfluenceAttachmentConfiguration | undefined;
+    /**
+     * Configuration information for indexing Confluence blogs.
+     */
+    BlogConfiguration?: ConfluenceBlogConfiguration | undefined;
+    /**
+     * 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.
+     */
+    ExclusionPatterns?: string[] | undefined;
+    /**
+     * 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.
+     */
+    InclusionPatterns?: string[] | undefined;
+    /**
+     * Configuration information for indexing Confluence pages.
+     */
+    PageConfiguration?: ConfluencePageConfiguration | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html) .
+     */
+    SecretArn: 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/* .
+     */
+    ServerUrl: string;
+    /**
+     * Configuration information for indexing Confluence spaces.
+     */
+    SpaceConfiguration?: ConfluenceSpaceConfiguration | undefined;
+    /**
+     * The version or the type of Confluence installation to connect to.
+     */
+    Version: ConfluenceVersion;
+    /**
+     * Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see [Configuring a VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html) .
+     */
+    VpcConfiguration?: DataSourceVpcConfiguration | undefined;
+};
+/**
+ * Configuration of the page settings for the Confluence data source.
+ */
+export type ConfluencePageConfiguration = {
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The Confluence data source field names must exist in your Confluence custom metadata.
+     *
+     * If you specify the `PageFieldMappings` parameter, you must specify at least one field mapping.
+     */
+    PageFieldMappings?: ConfluencePageToIndexFieldMapping[] | undefined;
+};
+export type ConfluencePageFieldName = "AUTHOR" | "CONTENT_STATUS" | "CREATED_DATE" | "DISPLAY_URL" | "ITEM_TYPE" | "LABELS" | "MODIFIED_DATE" | "PARENT_ID" | "SPACE_KEY" | "SPACE_NAME" | "URL" | "VERSION";
+/**
+ * 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](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The Confluence data source field names must exist in your Confluence custom metadata.
+ */
+export type ConfluencePageToIndexFieldMapping = {
+    /**
+     * The name of the field in the data source.
+     */
+    DataSourceFieldName: ConfluencePageFieldName;
+    /**
+     * The format for date fields in the data source. If the field specified in `DataSourceFieldName` is a date field you must specify the date format. If the field is not a date field, an exception is thrown.
+     */
+    DateFieldFormat?: string | undefined;
+    /**
+     * The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
+     */
+    IndexFieldName: string;
+};
+/**
+ * Configuration information for indexing Confluence spaces.
+ */
+export type ConfluenceSpaceConfiguration = {
+    /**
+     * `TRUE` to index archived spaces.
+     */
+    CrawlArchivedSpaces?: boolean | undefined;
+    /**
+     * `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](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html) .
+     */
+    CrawlPersonalSpaces?: boolean | undefined;
+    /**
+     * A list of space keys of Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the `ExcludeSpaces` and the `IncludeSpaces` list, the space is excluded.
+     */
+    ExcludeSpaces?: string[] | undefined;
+    /**
+     * A list of space keys for Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the `IncludeSpaces` and the `ExcludeSpaces` list, the space is excluded.
+     */
+    IncludeSpaces?: string[] | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . 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.
+     */
+    SpaceFieldMappings?: ConfluenceSpaceToIndexFieldMapping[] | undefined;
+};
+export type ConfluenceSpaceFieldName = "DISPLAY_URL" | "ITEM_TYPE" | "SPACE_KEY" | "URL";
+/**
+ * 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](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The Confluence data source field names must exist in your Confluence custom metadata.
+ */
+export type ConfluenceSpaceToIndexFieldMapping = {
+    /**
+     * The name of the field in the data source.
+     */
+    DataSourceFieldName: ConfluenceSpaceFieldName;
+    /**
+     * The format for date fields in the data source. If the field specified in `DataSourceFieldName` is a date field you must specify the date format. If the field is not a date field, an exception is thrown.
+     */
+    DateFieldFormat?: string | undefined;
+    /**
+     * The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.
+     */
+    IndexFieldName: string;
+};
+export type ConfluenceVersion = "CLOUD" | "SERVER";
+/**
+ * Provides the configuration information that's required to connect to a database.
+ */
+export type ConnectionConfiguration = {
+    /**
+     * The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.
+     */
+    DatabaseHost: string;
+    /**
+     * The name of the database containing the document data.
+     */
+    DatabaseName: string;
+    /**
+     * The port that the database uses for connections.
+     */
+    DatabasePort: number;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html) . For more information about AWS Secrets Manager , see [What Is AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) in the *AWS Secrets Manager* user guide.
+     */
+    SecretArn: string;
+    /**
+     * The name of the table that contains the document data.
+     */
+    TableName: string;
+};
+/**
+ * Provides the configuration information for altering document metadata and content during the document ingestion process.
+ *
+ * For more information, see [Customizing document metadata during the ingestion process](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html) .
+ */
+export type CustomDocumentEnrichmentConfiguration = {
+    /**
+     * Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
+     */
+    InlineConfigurations?: InlineCustomDocumentEnrichmentConfiguration[] | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation) .
+     */
+    PostExtractionHookConfiguration?: HookConfiguration | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation) .
+     */
+    PreExtractionHookConfiguration?: HookConfiguration | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of an IAM role with permission to run `PreExtractionHookConfiguration` and `PostExtractionHookConfiguration` for altering document metadata and content during the document ingestion process. For more information, see [an IAM roles for Amazon Kendra](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html) .
+     */
+    RoleArn?: string | undefined;
+};
+/**
+ * Provides the configuration information for an Amazon Kendra data source.
+ */
+export type DataSourceConfiguration = {
+    /**
+     * Provides the configuration information to connect to Confluence as your data source.
+     */
+    ConfluenceConfiguration?: ConfluenceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to a database as your data source.
+     */
+    DatabaseConfiguration?: DatabaseConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Google Drive as your data source.
+     */
+    GoogleDriveConfiguration?: GoogleDriveConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Microsoft OneDrive as your data source.
+     */
+    OneDriveConfiguration?: OneDriveConfiguration | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) 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.
+     */
+    S3Configuration: S3DataSourceConfiguration;
+    /**
+     * Provides the configuration information to connect to Salesforce as your data source.
+     */
+    SalesforceConfiguration?: SalesforceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to ServiceNow as your data source.
+     */
+    ServiceNowConfiguration?: ServiceNowConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Microsoft SharePoint as your data source.
+     */
+    SharePointConfiguration?: SharePointConfiguration | undefined;
+    /**
+     * Provides the configuration information required for Amazon Kendra Web Crawler.
+     */
+    WebCrawlerConfiguration?: WebCrawlerConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Amazon WorkDocs as your data source.
+     */
+    WorkDocsConfiguration?: WorkDocsConfiguration | undefined;
+} | {
+    /**
+     * Provides the configuration information to connect to Confluence as your data source.
+     */
+    ConfluenceConfiguration?: ConfluenceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to a database as your data source.
+     */
+    DatabaseConfiguration?: DatabaseConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Google Drive as your data source.
+     */
+    GoogleDriveConfiguration?: GoogleDriveConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Microsoft OneDrive as your data source.
+     */
+    OneDriveConfiguration?: OneDriveConfiguration | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) 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.
+     */
+    S3Configuration?: S3DataSourceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Salesforce as your data source.
+     */
+    SalesforceConfiguration?: SalesforceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to ServiceNow as your data source.
+     */
+    ServiceNowConfiguration?: ServiceNowConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Microsoft SharePoint as your data source.
+     */
+    SharePointConfiguration: SharePointConfiguration;
+    /**
+     * Provides the configuration information required for Amazon Kendra Web Crawler.
+     */
+    WebCrawlerConfiguration?: WebCrawlerConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Amazon WorkDocs as your data source.
+     */
+    WorkDocsConfiguration?: WorkDocsConfiguration | undefined;
+} | {
+    /**
+     * Provides the configuration information to connect to Confluence as your data source.
+     */
+    ConfluenceConfiguration?: ConfluenceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to a database as your data source.
+     */
+    DatabaseConfiguration?: DatabaseConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Google Drive as your data source.
+     */
+    GoogleDriveConfiguration?: GoogleDriveConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Microsoft OneDrive as your data source.
+     */
+    OneDriveConfiguration?: OneDriveConfiguration | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) 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.
+     */
+    S3Configuration?: S3DataSourceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Salesforce as your data source.
+     */
+    SalesforceConfiguration: SalesforceConfiguration;
+    /**
+     * Provides the configuration information to connect to ServiceNow as your data source.
+     */
+    ServiceNowConfiguration?: ServiceNowConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Microsoft SharePoint as your data source.
+     */
+    SharePointConfiguration?: SharePointConfiguration | undefined;
+    /**
+     * Provides the configuration information required for Amazon Kendra Web Crawler.
+     */
+    WebCrawlerConfiguration?: WebCrawlerConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Amazon WorkDocs as your data source.
+     */
+    WorkDocsConfiguration?: WorkDocsConfiguration | undefined;
+} | {
+    /**
+     * Provides the configuration information to connect to Confluence as your data source.
+     */
+    ConfluenceConfiguration?: ConfluenceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to a database as your data source.
+     */
+    DatabaseConfiguration?: DatabaseConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Google Drive as your data source.
+     */
+    GoogleDriveConfiguration?: GoogleDriveConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Microsoft OneDrive as your data source.
+     */
+    OneDriveConfiguration: OneDriveConfiguration;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) 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.
+     */
+    S3Configuration?: S3DataSourceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Salesforce as your data source.
+     */
+    SalesforceConfiguration?: SalesforceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to ServiceNow as your data source.
+     */
+    ServiceNowConfiguration?: ServiceNowConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Microsoft SharePoint as your data source.
+     */
+    SharePointConfiguration?: SharePointConfiguration | undefined;
+    /**
+     * Provides the configuration information required for Amazon Kendra Web Crawler.
+     */
+    WebCrawlerConfiguration?: WebCrawlerConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Amazon WorkDocs as your data source.
+     */
+    WorkDocsConfiguration?: WorkDocsConfiguration | undefined;
+} | {
+    /**
+     * Provides the configuration information to connect to Confluence as your data source.
+     */
+    ConfluenceConfiguration?: ConfluenceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to a database as your data source.
+     */
+    DatabaseConfiguration?: DatabaseConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Google Drive as your data source.
+     */
+    GoogleDriveConfiguration?: GoogleDriveConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Microsoft OneDrive as your data source.
+     */
+    OneDriveConfiguration?: OneDriveConfiguration | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) 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.
+     */
+    S3Configuration?: S3DataSourceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Salesforce as your data source.
+     */
+    SalesforceConfiguration?: SalesforceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to ServiceNow as your data source.
+     */
+    ServiceNowConfiguration: ServiceNowConfiguration;
+    /**
+     * Provides the configuration information to connect to Microsoft SharePoint as your data source.
+     */
+    SharePointConfiguration?: SharePointConfiguration | undefined;
+    /**
+     * Provides the configuration information required for Amazon Kendra Web Crawler.
+     */
+    WebCrawlerConfiguration?: WebCrawlerConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Amazon WorkDocs as your data source.
+     */
+    WorkDocsConfiguration?: WorkDocsConfiguration | undefined;
+} | {
+    /**
+     * Provides the configuration information to connect to Confluence as your data source.
+     */
+    ConfluenceConfiguration?: ConfluenceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to a database as your data source.
+     */
+    DatabaseConfiguration: DatabaseConfiguration;
+    /**
+     * Provides the configuration information to connect to Google Drive as your data source.
+     */
+    GoogleDriveConfiguration?: GoogleDriveConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Microsoft OneDrive as your data source.
+     */
+    OneDriveConfiguration?: OneDriveConfiguration | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) 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.
+     */
+    S3Configuration?: S3DataSourceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Salesforce as your data source.
+     */
+    SalesforceConfiguration?: SalesforceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to ServiceNow as your data source.
+     */
+    ServiceNowConfiguration?: ServiceNowConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Microsoft SharePoint as your data source.
+     */
+    SharePointConfiguration?: SharePointConfiguration | undefined;
+    /**
+     * Provides the configuration information required for Amazon Kendra Web Crawler.
+     */
+    WebCrawlerConfiguration?: WebCrawlerConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Amazon WorkDocs as your data source.
+     */
+    WorkDocsConfiguration?: WorkDocsConfiguration | undefined;
+} | {
+    /**
+     * Provides the configuration information to connect to Confluence as your data source.
+     */
+    ConfluenceConfiguration: ConfluenceConfiguration;
+    /**
+     * Provides the configuration information to connect to a database as your data source.
+     */
+    DatabaseConfiguration?: DatabaseConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Google Drive as your data source.
+     */
+    GoogleDriveConfiguration?: GoogleDriveConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Microsoft OneDrive as your data source.
+     */
+    OneDriveConfiguration?: OneDriveConfiguration | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) 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.
+     */
+    S3Configuration?: S3DataSourceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Salesforce as your data source.
+     */
+    SalesforceConfiguration?: SalesforceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to ServiceNow as your data source.
+     */
+    ServiceNowConfiguration?: ServiceNowConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Microsoft SharePoint as your data source.
+     */
+    SharePointConfiguration?: SharePointConfiguration | undefined;
+    /**
+     * Provides the configuration information required for Amazon Kendra Web Crawler.
+     */
+    WebCrawlerConfiguration?: WebCrawlerConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Amazon WorkDocs as your data source.
+     */
+    WorkDocsConfiguration?: WorkDocsConfiguration | undefined;
+} | {
+    /**
+     * Provides the configuration information to connect to Confluence as your data source.
+     */
+    ConfluenceConfiguration?: ConfluenceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to a database as your data source.
+     */
+    DatabaseConfiguration?: DatabaseConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Google Drive as your data source.
+     */
+    GoogleDriveConfiguration: GoogleDriveConfiguration;
+    /**
+     * Provides the configuration information to connect to Microsoft OneDrive as your data source.
+     */
+    OneDriveConfiguration?: OneDriveConfiguration | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) 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.
+     */
+    S3Configuration?: S3DataSourceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Salesforce as your data source.
+     */
+    SalesforceConfiguration?: SalesforceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to ServiceNow as your data source.
+     */
+    ServiceNowConfiguration?: ServiceNowConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Microsoft SharePoint as your data source.
+     */
+    SharePointConfiguration?: SharePointConfiguration | undefined;
+    /**
+     * Provides the configuration information required for Amazon Kendra Web Crawler.
+     */
+    WebCrawlerConfiguration?: WebCrawlerConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Amazon WorkDocs as your data source.
+     */
+    WorkDocsConfiguration?: WorkDocsConfiguration | undefined;
+} | {
+    /**
+     * Provides the configuration information to connect to Confluence as your data source.
+     */
+    ConfluenceConfiguration?: ConfluenceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to a database as your data source.
+     */
+    DatabaseConfiguration?: DatabaseConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Google Drive as your data source.
+     */
+    GoogleDriveConfiguration?: GoogleDriveConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Microsoft OneDrive as your data source.
+     */
+    OneDriveConfiguration?: OneDriveConfiguration | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) 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.
+     */
+    S3Configuration?: S3DataSourceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Salesforce as your data source.
+     */
+    SalesforceConfiguration?: SalesforceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to ServiceNow as your data source.
+     */
+    ServiceNowConfiguration?: ServiceNowConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Microsoft SharePoint as your data source.
+     */
+    SharePointConfiguration?: SharePointConfiguration | undefined;
+    /**
+     * Provides the configuration information required for Amazon Kendra Web Crawler.
+     */
+    WebCrawlerConfiguration: WebCrawlerConfiguration;
+    /**
+     * Provides the configuration information to connect to Amazon WorkDocs as your data source.
+     */
+    WorkDocsConfiguration?: WorkDocsConfiguration | undefined;
+} | {
+    /**
+     * Provides the configuration information to connect to Confluence as your data source.
+     */
+    ConfluenceConfiguration?: ConfluenceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to a database as your data source.
+     */
+    DatabaseConfiguration?: DatabaseConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Google Drive as your data source.
+     */
+    GoogleDriveConfiguration?: GoogleDriveConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Microsoft OneDrive as your data source.
+     */
+    OneDriveConfiguration?: OneDriveConfiguration | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) 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.
+     */
+    S3Configuration?: S3DataSourceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Salesforce as your data source.
+     */
+    SalesforceConfiguration?: SalesforceConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to ServiceNow as your data source.
+     */
+    ServiceNowConfiguration?: ServiceNowConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Microsoft SharePoint as your data source.
+     */
+    SharePointConfiguration?: SharePointConfiguration | undefined;
+    /**
+     * Provides the configuration information required for Amazon Kendra Web Crawler.
+     */
+    WebCrawlerConfiguration?: WebCrawlerConfiguration | undefined;
+    /**
+     * Provides the configuration information to connect to Amazon WorkDocs as your data source.
+     */
+    WorkDocsConfiguration: WorkDocsConfiguration;
+};
+/**
+ * Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the [UpdateIndex](https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateIndex.html) operation.
+ */
+export type DataSourceToIndexFieldMapping = {
+    /**
+     * The name of the field in the data source. You must first create the index field using the `UpdateIndex` API.
+     */
+    DataSourceFieldName: string;
+    /**
+     * The format for date fields in the data source. If the field specified in `DataSourceFieldName` is a date field, you must specify the date format. If the field is not a date field, an exception is thrown.
+     */
+    DateFieldFormat?: string | undefined;
+    /**
+     * The name of the index field to map to the data source field. The index field type must match the data source field type.
+     */
+    IndexFieldName: string;
+};
+/**
+ * Provides the configuration information to connect to an Amazon VPC.
+ */
+export type DataSourceVpcConfiguration = {
+    /**
+     * A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.
+     */
+    SecurityGroupIds: 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.
+     */
+    SubnetIds: string[];
+};
+/**
+ * Provides the configuration information to an [Amazon Kendra supported database](https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html) .
+ */
+export type DatabaseConfiguration = {
+    /**
+     * Information about the database column that provides information for user context filtering.
+     */
+    AclConfiguration?: AclConfiguration | undefined;
+    /**
+     * Information about where the index should get the document information from the database.
+     */
+    ColumnConfiguration: ColumnConfiguration;
+    /**
+     * Configuration information that's required to connect to a database.
+     */
+    ConnectionConfiguration: ConnectionConfiguration;
+    /**
+     * The type of database engine that runs the database.
+     */
+    DatabaseEngineType: DatabaseEngineType;
+    /**
+     * Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
+     */
+    SqlConfiguration?: SqlConfiguration | undefined;
+    /**
+     * Provides information for connecting to an Amazon VPC.
+     */
+    VpcConfiguration?: DataSourceVpcConfiguration | undefined;
+};
+export type DatabaseEngineType = "RDS_AURORA_MYSQL" | "RDS_AURORA_POSTGRESQL" | "RDS_MYSQL" | "RDS_POSTGRESQL";
+/**
+ * The condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra. You use this with [DocumentAttributeTarget to apply the condition](https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeTarget.html) .
+ *
+ * For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.
+ *
+ * Amazon Kendra cannot create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using `DocumentAttributeTarget` . Amazon Kendra then will map your newly created metadata field to your index field.
+ */
+export type DocumentAttributeCondition = {
+    /**
+     * 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.
+     */
+    ConditionDocumentAttributeKey: string;
+    /**
+     * 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.
+     */
+    ConditionOnValue?: DocumentAttributeValue | undefined;
+    /**
+     * The condition operator.
+     *
+     * For example, you can use 'Contains' to partially match a string.
+     */
+    Operator: ConditionOperator;
+};
+/**
+ * The target document attribute or metadata field you want to alter when ingesting documents into Amazon Kendra.
+ *
+ * For example, you can delete customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID'. You set the target key as 'Customer_ID' and the deletion flag to `TRUE` . This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.
+ *
+ * Amazon Kendra cannot create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using `DocumentAttributeTarget` . Amazon Kendra then will map your newly created metadata field to your index field.
+ *
+ * You can also use this with [DocumentAttributeCondition](https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeCondition.html) .
+ */
+export type DocumentAttributeTarget = {
+    /**
+     * The identifier of the target document attribute or metadata field.
+     *
+     * For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
+     */
+    TargetDocumentAttributeKey: string;
+    /**
+     * The target value you want to create for the target attribute.
+     *
+     * For example, 'Finance' could be the target value for the target attribute key 'Department'.
+     */
+    TargetDocumentAttributeValue?: DocumentAttributeValue | undefined;
+    /**
+     * `TRUE` to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to `TRUE` . To create a target value ( `TargetDocumentAttributeValue` ), set this to `FALSE` .
+     */
+    TargetDocumentAttributeValueDeletion?: boolean | undefined;
+};
+/**
+ * The value of a document attribute. You can only provide one value for a document attribute.
+ */
+export type DocumentAttributeValue = {
+    /**
+     * 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.
+     */
+    DateValue?: string | undefined;
+    /**
+     * A long integer value.
+     */
+    LongValue?: number | undefined;
+    /**
+     * A list of strings. The default maximum length or number of strings is 10.
+     */
+    StringListValue?: string[] | undefined;
+    /**
+     * A string, such as "department".
+     * @minLength 1
+     * @maxLength 2048
+     */
+    StringValue?: string | undefined;
+};
+/**
+ * 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.
+ */
+export type DocumentsMetadataConfiguration = {
+    /**
+     * 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 | undefined;
+};
+/**
+ * Provides the configuration information to connect to Google Drive as your data source.
+ */
+export type GoogleDriveConfiguration = {
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html) .
+     */
+    ExcludeMimeTypes?: string[] | undefined;
+    /**
+     * A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.
+     */
+    ExcludeSharedDrives?: string[] | undefined;
+    /**
+     * 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.
+     */
+    ExcludeUserAccounts?: string[] | undefined;
+    /**
+     * 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.
+     */
+    ExclusionPatterns?: string[] | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The Google Drive data source field names must exist in your Google Drive custom metadata.
+     */
+    FieldMappings?: DataSourceToIndexFieldMapping[] | undefined;
+    /**
+     * 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.
+     */
+    InclusionPatterns?: string[] | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html) .
+     */
+    SecretArn: string;
+};
+/**
+ * Provides the configuration information for invoking a Lambda function in AWS Lambda to alter document metadata and content when ingesting documents into Amazon Kendra. You can configure your Lambda function using [PreExtractionHookConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_CustomDocumentEnrichmentConfiguration.html) if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Kendra structured documents, you must configure your Lambda function using [PostExtractionHookConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_CustomDocumentEnrichmentConfiguration.html) . You can only invoke one Lambda function. However, this function can invoke other functions it requires.
+ *
+ * For more information, see [Customizing document metadata during the ingestion process](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html) .
+ */
+export type HookConfiguration = {
+    /**
+     * 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.
+     */
+    InvocationCondition?: DocumentAttributeCondition | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html) .
+     */
+    LambdaArn: 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](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#cde-data-contracts-lambda) .
+     */
+    S3Bucket: string;
+};
+/**
+ * Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Kendra. To apply advanced logic, to go beyond what you can do with basic logic, see [HookConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_HookConfiguration.html) .
+ *
+ * For more information, see [Customizing document metadata during the ingestion process](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html) .
+ */
+export type InlineCustomDocumentEnrichmentConfiguration = {
+    /**
+     * Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra.
+     */
+    Condition?: DocumentAttributeCondition | undefined;
+    /**
+     * `TRUE` to delete content if the condition used for the target attribute is met.
+     */
+    DocumentContentDeletion?: boolean | undefined;
+    /**
+     * Configuration of the target document attribute or metadata field when ingesting documents into Amazon Kendra. You can also include a value.
+     */
+    Target?: DocumentAttributeTarget | undefined;
+};
+/**
+ * Provides the configuration information to connect to OneDrive as your data source.
+ */
+export type OneDriveConfiguration = {
+    /**
+     * `TRUE` to disable local groups information.
+     */
+    DisableLocalGroups?: boolean | undefined;
+    /**
+     * 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.
+     */
+    ExclusionPatterns?: string[] | undefined;
+    /**
+     * A list of `DataSourceToIndexFieldMapping` objects that map OneDrive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to OneDrive fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The OneDrive data source field names must exist in your OneDrive custom metadata.
+     */
+    FieldMappings?: DataSourceToIndexFieldMapping[] | undefined;
+    /**
+     * 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.
+     */
+    InclusionPatterns?: string[] | undefined;
+    /**
+     * A list of user accounts whose documents should be indexed.
+     */
+    OneDriveUsers: OneDriveUsers;
+    /**
+     * 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.
+     */
+    SecretArn: string;
+    /**
+     * The Azure Active Directory domain of the organization.
+     */
+    TenantDomain: string;
+};
+/**
+ * User accounts whose documents should be indexed.
+ */
+export type OneDriveUsers = {
+    /**
+     * A list of users whose documents should be indexed. Specify the user names in email format, for example, `username@tenantdomain` . If you need to index the documents of more than 10 users, use the `OneDriveUserS3Path` field to specify the location of a file containing a list of users.
+     */
+    OneDriveUserList: string[];
+    /**
+     * The S3 bucket location of a file containing a list of users whose documents should be indexed.
+     */
+    OneDriveUserS3Path?: S3Path | undefined;
+} | {
+    /**
+     * A list of users whose documents should be indexed. Specify the user names in email format, for example, `username@tenantdomain` . If you need to index the documents of more than 10 users, use the `OneDriveUserS3Path` field to specify the location of a file containing a list of users.
+     */
+    OneDriveUserList?: string[] | undefined;
+    /**
+     * The S3 bucket location of a file containing a list of users whose documents should be indexed.
+     */
+    OneDriveUserS3Path: S3Path;
+};
+/**
+ * Provides the configuration information for a web proxy to connect to website hosts.
+ */
+export type ProxyConfiguration = {
+    /**
+     * The Amazon Resource Name (ARN) of an AWS Secrets Manager secret. You create a secret to store your credentials in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html)
+     *
+     * 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.
+     */
+    Credentials?: string | undefined;
+    /**
+     * 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".
+     * @minLength 1
+     * @maxLength 253
+     * @pattern ([^\s]*)
+     */
+    Host: string;
+    /**
+     * 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.
+     * @min 1
+     * @max 65535
+     */
+    Port: number;
+};
+export type QueryIdentifiersEnclosingOption = "DOUBLE_QUOTES" | "NONE";
+/**
+ * Provides the configuration information to connect to an Amazon S3 bucket.
+ */
+export type S3DataSourceConfiguration = {
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html) .
+     */
+    AccessControlListConfiguration?: AccessControlListConfiguration | undefined;
+    /**
+     * The name of the bucket that contains the documents.
+     */
+    BucketName: string;
+    /**
+     * 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.
+     */
+    DocumentsMetadataConfiguration?: DocumentsMetadataConfiguration | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters) in the AWS CLI Command Reference.
+     */
+    ExclusionPatterns?: string[] | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters) in the AWS CLI Command Reference.
+     */
+    InclusionPatterns?: string[] | undefined;
+    /**
+     * A list of S3 prefixes for the documents that should be included in the index.
+     */
+    InclusionPrefixes?: string[] | undefined;
+};
+/**
+ * Information required to find a specific file in an Amazon S3 bucket.
+ */
+export type S3Path = {
+    /**
+     * The name of the S3 bucket that contains the file.
+     */
+    Bucket: string;
+    /**
+     * The name of the file.
+     */
+    Key: string;
+};
+/**
+ * The configuration information for syncing a Salesforce chatter feed. The contents of the object comes from the Salesforce FeedItem table.
+ */
+export type SalesforceChatterFeedConfiguration = {
+    /**
+     * The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the `Body` column.
+     */
+    DocumentDataFieldName: string;
+    /**
+     * The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the `Title` column.
+     */
+    DocumentTitleFieldName?: string | undefined;
+    /**
+     * Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
+     */
+    FieldMappings?: DataSourceToIndexFieldMapping[] | undefined;
+    /**
+     * Filters the documents in the feed based on status of the user. When you specify `ACTIVE_USERS` only documents from users who have an active account are indexed. When you specify `STANDARD_USER` only documents for Salesforce standard users are documented. You can specify both.
+     */
+    IncludeFilterTypes?: SalesforceChatterFeedIncludeFilterType[] | undefined;
+};
+export type SalesforceChatterFeedIncludeFilterType = "ACTIVE_USER" | "STANDARD_USER";
+/**
+ * Provides the configuration information to connect to Salesforce as your data source.
+ */
+export type SalesforceConfiguration = {
+    /**
+     * Configuration information for Salesforce chatter feeds.
+     */
+    ChatterFeedConfiguration?: SalesforceChatterFeedConfiguration | undefined;
+    /**
+     * Indicates whether Amazon Kendra should index attachments to Salesforce objects.
+     */
+    CrawlAttachments?: boolean | undefined;
+    /**
+     * 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.
+     */
+    ExcludeAttachmentFilePatterns?: string[] | undefined;
+    /**
+     * 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.
+     */
+    IncludeAttachmentFilePatterns?: string[] | undefined;
+    /**
+     * 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.
+     */
+    KnowledgeArticleConfiguration?: SalesforceKnowledgeArticleConfiguration | undefined;
+    /**
+     * 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.
+     */
+    SecretArn: string;
+    /**
+     * The instance URL for the Salesforce site that you want to index.
+     */
+    ServerUrl: string;
+    /**
+     * Configuration information for processing attachments to Salesforce standard objects.
+     */
+    StandardObjectAttachmentConfiguration?: SalesforceStandardObjectAttachmentConfiguration | undefined;
+    /**
+     * Configuration of the Salesforce standard objects that Amazon Kendra indexes.
+     */
+    StandardObjectConfigurations?: SalesforceStandardObjectConfiguration[] | undefined;
+};
+/**
+ * Provides the configuration information for indexing Salesforce custom articles.
+ */
+export type SalesforceCustomKnowledgeArticleTypeConfiguration = {
+    /**
+     * The name of the field in the custom knowledge article that contains the document data to index.
+     */
+    DocumentDataFieldName: string;
+    /**
+     * The name of the field in the custom knowledge article that contains the document title.
+     */
+    DocumentTitleFieldName?: string | undefined;
+    /**
+     * Maps attributes or field names of the custom 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](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The Salesforce data source field names must exist in your Salesforce custom metadata.
+     */
+    FieldMappings?: DataSourceToIndexFieldMapping[] | undefined;
+    /**
+     * The name of the configuration.
+     */
+    Name: string;
+};
+/**
+ * Provides the 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
+ */
+export type SalesforceKnowledgeArticleConfiguration = {
+    /**
+     * Configuration information for custom Salesforce knowledge articles.
+     */
+    CustomKnowledgeArticleTypeConfigurations?: SalesforceCustomKnowledgeArticleTypeConfiguration[] | undefined;
+    /**
+     * Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.
+     */
+    IncludedStates: SalesforceKnowledgeArticleState[];
+    /**
+     * Configuration information for standard Salesforce knowledge articles.
+     */
+    StandardKnowledgeArticleTypeConfiguration?: SalesforceStandardKnowledgeArticleTypeConfiguration | undefined;
+};
+export type SalesforceKnowledgeArticleState = "DRAFT" | "PUBLISHED" | "ARCHIVED";
+/**
+ * Provides the configuration information for standard Salesforce knowledge articles.
+ */
+export type SalesforceStandardKnowledgeArticleTypeConfiguration = {
+    /**
+     * The name of the field that contains the document data to index.
+     */
+    DocumentDataFieldName: string;
+    /**
+     * The name of the field that contains the document title.
+     */
+    DocumentTitleFieldName?: string | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The Salesforce data source field names must exist in your Salesforce custom metadata.
+     */
+    FieldMappings?: DataSourceToIndexFieldMapping[] | undefined;
+};
+/**
+ * Provides the configuration information for processing attachments to Salesforce standard objects.
+ */
+export type SalesforceStandardObjectAttachmentConfiguration = {
+    /**
+     * The name of the field used for the document title.
+     */
+    DocumentTitleFieldName?: string | undefined;
+    /**
+     * One or more objects that map fields in attachments to Amazon Kendra index fields.
+     */
+    FieldMappings?: DataSourceToIndexFieldMapping[] | undefined;
+};
+/**
+ * Specifies configuration information for indexing a single standard object.
+ */
+export type SalesforceStandardObjectConfiguration = {
+    /**
+     * The name of the field in the standard object table that contains the document contents.
+     */
+    DocumentDataFieldName: string;
+    /**
+     * The name of the field in the standard object table that contains the document title.
+     */
+    DocumentTitleFieldName?: string | undefined;
+    /**
+     * Maps attributes or field names of the standard object 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](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The Salesforce data source field names must exist in your Salesforce custom metadata.
+     */
+    FieldMappings?: DataSourceToIndexFieldMapping[] | undefined;
+    /**
+     * The name of the standard object.
+     */
+    Name: SalesforceStandardObjectName;
+};
+export type SalesforceStandardObjectName = "ACCOUNT" | "CAMPAIGN" | "CASE" | "CONTACT" | "CONTRACT" | "DOCUMENT" | "GROUP" | "IDEA" | "LEAD" | "OPPORTUNITY" | "PARTNER" | "PRICEBOOK" | "PRODUCT" | "PROFILE" | "SOLUTION" | "TASK" | "USER";
+export type ServiceNowAuthenticationType = "HTTP_BASIC" | "OAUTH2";
+export type ServiceNowBuildVersionType = "LONDON" | "OTHERS";
+/**
+ * Provides the configuration information to connect to ServiceNow as your data source.
+ */
+export type ServiceNowConfiguration = {
+    /**
+     * The type of authentication used to connect to the ServiceNow instance. If you choose `HTTP_BASIC` , Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the `SecretArn` field. If you choose `OAUTH2` , Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password.
+     *
+     * When you use `OAUTH2` authentication, you must generate a token and a client secret using the ServiceNow console. For more information, see [Using a ServiceNow data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html) .
+     */
+    AuthenticationType?: ServiceNowAuthenticationType | undefined;
+    /**
+     * The ServiceNow instance that the data source connects to. The host endpoint should look like the following: *{instance}.service-now.com.*
+     */
+    HostUrl: string;
+    /**
+     * Configuration information for crawling knowledge articles in the ServiceNow site.
+     */
+    KnowledgeArticleConfiguration?: ServiceNowKnowledgeArticleConfiguration | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html) .
+     */
+    SecretArn: string;
+    /**
+     * Configuration information for crawling service catalogs in the ServiceNow site.
+     */
+    ServiceCatalogConfiguration?: ServiceNowServiceCatalogConfiguration | undefined;
+    /**
+     * The identifier of the release that the ServiceNow host is running. If the host is not running the `LONDON` release, use `OTHERS` .
+     */
+    ServiceNowBuildVersion: ServiceNowBuildVersionType;
+};
+/**
+ * Provides the configuration information for crawling knowledge articles in the ServiceNow site.
+ */
+export type ServiceNowKnowledgeArticleConfiguration = {
+    /**
+     * `TRUE` to index attachments to knowledge articles.
+     */
+    CrawlAttachments?: boolean | undefined;
+    /**
+     * The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
+     */
+    DocumentDataFieldName: string;
+    /**
+     * The name of the ServiceNow field that is mapped to the index document title field.
+     */
+    DocumentTitleFieldName?: string | undefined;
+    /**
+     * 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.
+     */
+    ExcludeAttachmentFilePatterns?: string[] | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The ServiceNow data source field names must exist in your ServiceNow custom metadata.
+     */
+    FieldMappings?: DataSourceToIndexFieldMapping[] | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/dg/servicenow-query.html) .
+     */
+    FilterQuery?: string | undefined;
+    /**
+     * 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.
+     */
+    IncludeAttachmentFilePatterns?: string[] | undefined;
+};
+/**
+ * Provides the configuration information for crawling service catalog items in the ServiceNow site
+ */
+export type ServiceNowServiceCatalogConfiguration = {
+    /**
+     * `TRUE` to index attachments to service catalog items.
+     */
+    CrawlAttachments?: boolean | undefined;
+    /**
+     * The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
+     */
+    DocumentDataFieldName: string;
+    /**
+     * The name of the ServiceNow field that is mapped to the index document title field.
+     */
+    DocumentTitleFieldName?: string | undefined;
+    /**
+     * 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.
+     */
+    ExcludeAttachmentFilePatterns?: string[] | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The ServiceNow data source field names must exist in your ServiceNow custom metadata.
+     */
+    FieldMappings?: DataSourceToIndexFieldMapping[] | undefined;
+    /**
+     * 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.
+     */
+    IncludeAttachmentFilePatterns?: string[] | undefined;
+};
+/**
+ * Provides the configuration information to connect to Microsoft SharePoint as your data source.
+ */
+export type SharePointConfiguration = {
+    /**
+     * `TRUE` to index document attachments.
+     */
+    CrawlAttachments?: boolean | undefined;
+    /**
+     * `TRUE` to disable local groups information.
+     */
+    DisableLocalGroups?: boolean | undefined;
+    /**
+     * The Microsoft SharePoint attribute field that contains the title of the document.
+     */
+    DocumentTitleFieldName?: string | undefined;
+    /**
+     * 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.
+     */
+    ExclusionPatterns?: string[] | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateIndex.html) operation before you map SharePoint attributes. For more information, see [Mapping Data Source Fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) .
+     */
+    FieldMappings?: DataSourceToIndexFieldMapping[] | undefined;
+    /**
+     * 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.
+     */
+    InclusionPatterns?: string[] | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html) .
+     */
+    SecretArn: string;
+    /**
+     * The version of Microsoft SharePoint that you use.
+     */
+    SharePointVersion: "SHAREPOINT_ONLINE" | "SHAREPOINT_2013" | "SHAREPOINT_2016";
+    /**
+     * Information required to find a specific file in an Amazon S3 bucket.
+     */
+    SslCertificateS3Path?: S3Path | undefined;
+    /**
+     * The Microsoft SharePoint site URLs for the documents you want to index.
+     */
+    Urls: string[];
+    /**
+     * `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.
+     */
+    UseChangeLog?: boolean | undefined;
+    /**
+     * Provides information for connecting to an Amazon VPC.
+     */
+    VpcConfiguration?: DataSourceVpcConfiguration | undefined;
+};
+/**
+ * Provides information that configures Amazon Kendra to use a SQL database.
+ */
+export type SqlConfiguration = {
+    /**
+     * Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query. You can set the value to `DOUBLE_QUOTES` or `NONE` .
+     *
+     * By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.
+     *
+     * PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's case.
+     *
+     * For MySQL databases, you must enable the ansi_quotes option when you set this field to `DOUBLE_QUOTES` .
+     */
+    QueryIdentifiersEnclosingOption?: QueryIdentifiersEnclosingOption | undefined;
+};
+/**
+ * Data source type
+ */
+export type Type = "S3" | "SHAREPOINT" | "SALESFORCE" | "ONEDRIVE" | "SERVICENOW" | "DATABASE" | "CUSTOM" | "CONFLUENCE" | "GOOGLEDRIVE" | "WEBCRAWLER" | "WORKDOCS";
+/**
+ * Provides the configuration information to connect to websites that require user authentication.
+ */
+export type WebCrawlerAuthenticationConfiguration = {
+    /**
+     * The list of configuration information that's required to connect to and crawl a website host using basic authentication credentials.
+     *
+     * The list includes the name and port number of the website host.
+     */
+    BasicAuthentication?: WebCrawlerBasicAuthentication[] | undefined;
+};
+/**
+ * Provides the configuration information to connect to websites that require basic user authentication.
+ */
+export type WebCrawlerBasicAuthentication = {
+    /**
+     * The Amazon Resource Name (ARN) of an AWS Secrets Manager secret. You create a secret to store your credentials in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html)
+     *
+     * You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.
+     */
+    Credentials: string;
+    /**
+     * The name of the website host you want to connect to using authentication credentials.
+     *
+     * For example, the host name of https://a.example.com/page1.html is "a.example.com".
+     * @minLength 1
+     * @maxLength 253
+     * @pattern ([^\s]*)
+     */
+    Host: string;
+    /**
+     * The port number of the website host you want to connect to using authentication credentials.
+     *
+     * For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
+     * @min 1
+     * @max 65535
+     */
+    Port: number;
+};
+/**
+ * Provides the configuration information required for Amazon Kendra Web Crawler.
+ */
+export type WebCrawlerConfiguration = {
+    /**
+     * 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](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) 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.
+     */
+    AuthenticationConfiguration?: WebCrawlerAuthenticationConfiguration | undefined;
+    /**
+     * 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.
+     * @min 1
+     * @max 10
+     */
+    CrawlDepth?: number | undefined;
+    /**
+     * 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.
+     * @min 0
+     * @max 50
+     */
+    MaxContentSizePerPageInMegaBytes?: number | undefined;
+    /**
+     * 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.
+     * @min 1
+     * @max 1000
+     */
+    MaxLinksPerPage?: number | undefined;
+    /**
+     * 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.
+     * @min 1
+     * @max 300
+     */
+    MaxUrlsPerMinuteCrawlRate?: number | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) .
+     */
+    ProxyConfiguration?: ProxyConfiguration | undefined;
+    /**
+     * 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.
+     */
+    UrlExclusionPatterns?: string[] | undefined;
+    /**
+     * 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.
+     */
+    UrlInclusionPatterns?: string[] | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/aup/) 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.*
+     */
+    Urls: WebCrawlerUrls;
+};
+/**
+ * Provides the configuration information of the seed or starting point URLs to crawl.
+ *
+ * *When selecting websites to index, you must adhere to the [Amazon Acceptable Use Policy](https://docs.aws.amazon.com/aup/) and all other Amazon terms. Remember that you must only use the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.*
+ */
+export type WebCrawlerSeedUrlConfiguration = {
+    /**
+     * 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.
+     */
+    SeedUrls: string[];
+    /**
+     * 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` .
+     */
+    WebCrawlerMode?: "HOST_ONLY" | "SUBDOMAINS" | "EVERYTHING" | undefined;
+};
+/**
+ * Provides the configuration information of the sitemap URLs to crawl.
+ *
+ * *When selecting websites to index, you must adhere to the [Amazon Acceptable Use Policy](https://docs.aws.amazon.com/aup/) and all other Amazon terms. Remember that you must only use the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.*
+ */
+export type WebCrawlerSiteMapsConfiguration = {
+    /**
+     * The list of sitemap URLs of the websites you want to crawl.
+     *
+     * The list can include a maximum of three sitemap URLs.
+     */
+    SiteMaps: string[];
+};
+/**
+ * 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](https://docs.aws.amazon.com/aup/) and all other Amazon terms. Remember that you must only use the Amazon Kendra web crawler to index your own webpages, or webpages that you have authorization to index.*
+ */
+export type WebCrawlerUrls = {
+    /**
+     * 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.
+     */
+    SeedUrlConfiguration?: WebCrawlerSeedUrlConfiguration | undefined;
+    /**
+     * 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.
+     */
+    SiteMapsConfiguration?: WebCrawlerSiteMapsConfiguration | undefined;
+};
+/**
+ * Provides the configuration information to connect to Amazon WorkDocs as your data source.
+ *
+ * Amazon WorkDocs connector is available in Oregon, North Virginia, Sydney, Singapore and Ireland regions.
+ */
+export type WorkDocsConfiguration = {
+    /**
+     * `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` .
+     */
+    CrawlComments?: boolean | undefined;
+    /**
+     * 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.
+     */
+    ExclusionPatterns?: string[] | undefined;
+    /**
+     * A list of `DataSourceToIndexFieldMapping` objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Amazon WorkDocs fields. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html) . The Amazon WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.
+     */
+    FieldMappings?: DataSourceToIndexFieldMapping[] | undefined;
+    /**
+     * 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.
+     */
+    InclusionPatterns?: string[] | undefined;
+    /**
+     * The identifier of the directory corresponding to your Amazon WorkDocs site repository.
+     *
+     * You can find the organization ID in the [AWS Directory Service](https://docs.aws.amazon.com/directoryservicev2/) 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.
+     * @minLength 12
+     * @maxLength 12
+     * @pattern d-[0-9a-fA-F]{10}
+     */
+    OrganizationId: string;
+    /**
+     * `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.
+     */
+    UseChangeLog?: boolean | undefined;
+};
+//# sourceMappingURL=aws-kendra-datasource.d.ts.map