Connecting Amazon Q Business to SharePoint (Online) using AWS CloudFormation
You use the AWS::QBusiness::DataSource resource to connect a data source to
your Amazon Q application.
Use the configuration property to provide a JSON or YAML schema with the necessary
configuration details specific to your data source connector.
To learn more about AWS CloudFormation, see What is AWS CloudFormation? in the AWS CloudFormation User Guide.
Topics
SharePoint (Online) configuration properties
The following provides information about important configuration properties required in the schema.
| Configuration | Description | Type | Required |
|---|---|---|---|
|
Configuration information for the endpoint for the data source. |
This property has a sub-property called
|
Yes |
|
The endpoint information for the data source. |
This property has the following sub-properties.
|
Yes |
|
The tenant id of your SharePoint (Online) account. |
OAuth2 series required |
Yes |
|
The domain of your SharePoint (Online) account. |
|
Yes |
|
The host URLs of your SharePoint (Online) account. |
Specify the URL in the pattern |
Yes |
|
Additional properties to connect with your repository endpoint. |
This property has the following sub-properties.
|
Yes |
|
The name of the Amazon S3 bucket that stores your Azure AD self-signed X.509 certificate. |
Azure AD App-Only auth required |
No |
|
The name of the SSL certificate stored in your Amazon S3 bucket. |
Azure AD App-Only auth required |
No |
|
The type of authentication you are using: OAuth2,
OAuth2Certificate, OAuth2App, or Basic. |
|
Yes |
|
The SharePoint version you are using: Online. |
Azure AD App-Only auth required |
Yes |
|
Configuration information for the content of the data source. For example, configuring specific types of content and field mappings. |
This property has the following sub-properties.
|
Yes |
|
A list of objects that map the attributes or field names of your SharePoint (Online) pages and assets to Amazon Q index field names. |
These properties have the following sub-properties.
|
No |
|
The field name of your SharePoint (Online) events, pages, files, links, attachments, or comments. |
|
Yes |
|
The field type of your SharePoint (Online) events, pages, files, links, attachments, or comments. |
The allowed values are |
Yes |
|
The data source field name of your SharePoint (Online) events, pages, files, links, attachments, or comments. |
|
Yes |
|
The date format of your SharePoint (Online) events, pages, files, links, attachments, or comments. |
Specify the date format in the form |
No |
|
Additional configuration options for your content in your data source. |
This property has the following sub-properties:
|
Yes |
|
A list of regular expression patterns to include/exclude specific files in your SharePoint (Online) data source. Files that match the patterns are included in the index. File 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. |
|
No |
|
Input TRUE to index. |
|
No |
|
Specify the maximum single file size limit in MBs that Amazon Q will crawl. Amazon Q will crawl only the files within the size limit you define. The default file size is 50MB. The maximum file size should be greater than 0MB and less than or equal to 50MB. |
|
No |
|
We recommend that you use SHAREPOINTV2 as your data source
type |
Valid values are |
Yes |
|
NoteAmazon Q Business crawls identity information from your data source by default to ensure responses are generated only from documents end users have access to. For more information, see Identity crawler. |
|
Yes |
|
Specify whether Amazon Q should update your index by syncing all documents or only new, modified, and deleted documents. |
You can choose between the following options:
|
Yes |
|
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key-value pairs required to connect to your SharePoint. If you use basic authentication, provide the username and password. If you use OAuth 2.0 authentication, provide the username, password, client ID, and client secret. |
The minimum length is 20 and the maximum length is 2,048 characters. If you use basic authentication (authType should be Basic) or Azure
AD App-only authentication (authType should be
OAuth2Certificate), the secret must contain a JSON structure with the
following keys: If you use OAuth2 authentication ( authType should be
OAuth) or Sharepoint App-Only authentication (authType
should be OAuth2App) the secret must contain a JSON structure with the
following keys:
|
Yes |
|
The version of this template that's currently supported. |
|
No |
SharePoint (Online) JSON schema for using the configuration property with AWS CloudFormation
The following is the SharePoint (Online) JSON schema and examples for the configuration property for AWS CloudFormation.
Topics
SharePoint (Online) JSON schema for using the configuration property with AWS CloudFormation
The following is the SharePoint (Online) JSON schema for the configuration property for AWS CloudFormation
{ "type": "object", "properties": { "type": { "type": "string", "enum": ["SHAREPOINTV2", "SHAREPOINT"] }, "syncMode": { "type": "string", "enum": ["FULL_CRAWL", "FORCED_FULL_CRAWL", "CHANGE_LOG"] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 }, "enableIdentityCrawler": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "tenantId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "domain": { "type": "string" }, "siteUrls": { "type": "array", "items": { "type": "string", "pattern": "https://.*" } }, "repositoryAdditionalProperties": { "type": "object", "properties": { "s3bucketName": { "type": "string" }, "s3certificateName": { "type": "string" }, "authType": { "type": "string", "enum": [ "OAuth2", "OAuth2Certificate", "OAuth2App", "OAuth2_RefreshToken", "Basic" ] }, "version": { "type": "string", "enum": ["Online"] }, "enableDeletionProtection": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ], "default": false }, "deletionProtectionThreshold": { "type": "string", "default": "15" } }, "required": ["authType", "version"] } }, "required": ["siteUrls", "domain", "repositoryAdditionalProperties"] } }, "required": ["repositoryEndpointMetadata"] }, "repositoryConfigurations": { "type": "object", "properties": { "event": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": ["fieldMappings"] }, "page": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "DATE", "LONG"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": ["fieldMappings"] }, "file": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "DATE", "LONG"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": ["fieldMappings"] }, "link": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": ["fieldMappings"] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": ["fieldMappings"] }, "comment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": ["fieldMappings"] } } }, "additionalProperties": { "type": "object", "properties": { "eventTitleFilterRegEx": { "type": "array", "items": { "type": "string" } }, "pageTitleFilterRegEx": { "type": "array", "items": { "type": "string" } }, "linkTitleFilterRegEx": { "type": "array", "items": { "type": "string" } }, "inclusionFilePath": { "type": "array", "items": { "type": "string" } }, "exclusionFilePath": { "type": "array", "items": { "type": "string" } }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionOneNoteSectionNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionOneNoteSectionNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionOneNotePageNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionOneNotePageNamePatterns": { "type": "array", "items": { "type": "string" } }, "crawlFiles": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "crawlPages": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "crawlEvents": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "crawlComments": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "crawlLinks": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "crawlAttachments": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "crawlListData": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "crawlAcl": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "aclConfiguration": { "type": "string", "enum": [ "ACLWithLDAPEmailFmt", "ACLWithManualEmailFmt", "ACLWithUsernameFmt" ] }, "emailDomain": { "type": "string" }, "isCrawlLocalGroupMapping": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "isCrawlAdGroupMapping": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": ["true", "false"] } ] }, "maxFileSizeInMegaBytes": { "type": "string" } }, "required": [] }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] } }, "required": [ "type", "syncMode", "secretArn", "enableIdentityCrawler", "connectionConfiguration", "repositoryConfigurations", "additionalProperties" ] }
SharePoint (Online) JSON schema example for using the configuration property with AWS CloudFormation
The following is the SharePoint (Online) JSON schema example for the configuration property for AWS CloudFormation
{ "AWSTemplateFormatVersion": "2010-09-09", "Description": "CloudFormation SHAREPOINT Data Source Template", "Resources": { "DataSourceSharePoint": { "Type": "AWS::QBusiness::DataSource", "Properties": { "ApplicationId": "app12345-1234-1234-1234-123456789012", "IndexId": "indx1234-1234-1234-1234-123456789012", "DisplayName": "MySharePointDataSource", "RoleArn": "arn:aws:iam::123456789012:role/qbusiness-data-source-role", "Configuration": { "type": "SHAREPOINTV2", "syncMode": "FULL_CRAWL", "secretArn": "arn:aws:secretsmanager:us-west-2:123456789012:secret:my-sharepoint-secret", "enableIdentityCrawler": "true", "connectionConfiguration": { "repositoryEndpointMetadata": { "tenantId": "1234567a-890b-1234-567c-123456789012", "domain": "example.sharepoint.com", "siteUrls": ["https://example.sharepoint.com/sites/mysite"], "repositoryAdditionalProperties": { "s3bucketName": "my-bucket", "s3certificateName": "my-certificate", "authType": "OAuth2", "version": "Online", "enableDeletionProtection": "false", "deletionProtectionThreshold": "15" } } }, "repositoryConfigurations": { "event": { "fieldMappings": [ { "indexFieldName": "event_id", "indexFieldType": "STRING", "dataSourceFieldName": "id", "dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'" } ] }, "page": { "fieldMappings": [ { "indexFieldName": "page_id", "indexFieldType": "STRING", "dataSourceFieldName": "id", "dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'" } ] } }, "additionalProperties": { "eventTitleFilterRegEx": ["^.*$"], "pageTitleFilterRegEx": ["^.*$"], "linkTitleFilterRegEx": ["^.*$"], "inclusionFilePath": ["documents/"], "exclusionFilePath": ["drafts/"], "inclusionFileTypePatterns": ["*.docx"], "exclusionFileTypePatterns": ["*.tmp"], "inclusionFileNamePatterns": ["*report*"], "exclusionFileNamePatterns": ["*draft*"], "enableDeletionProtection": "false", "maxFileSizeInMegaBytes": "50" } } } } } }
SharePoint (Online) YAML schema for using the configuration property with AWS CloudFormation
The following is the SharePoint (Online) YAML schema and examples for the configuration property for AWS CloudFormation:
Topics
SharePoint (Online) YAML schema for using the configuration property with AWS CloudFormation
The following is the SharePoint (Online) YAML schema for the configuration property for AWS CloudFormation.
$schema: http://json-schema.org/draft-04/schema# type: object properties: type: type: string enum: - SHAREPOINTV2 - SHAREPOINT syncMode: type: string enum: - FULL_CRAWL - FORCED_FULL_CRAWL - CHANGE_LOG secretArn: type: string minLength: 20 maxLength: 2048 enableIdentityCrawler: anyOf: - type: boolean - type: string enum: - true - false connectionConfiguration: type: object properties: repositoryEndpointMetadata: type: object properties: tenantId: type: string pattern: "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" minLength: 36 maxLength: 36 domain: type: string siteUrls: type: array items: type: string pattern: "https://.*" repositoryAdditionalProperties: type: object properties: s3bucketName: type: string s3certificateName: type: string authType: type: string enum: - OAuth2 - OAuth2Certificate - OAuth2App - OAuth2_RefreshToken - Basic version: type: string enum: - Online enableDeletionProtection: anyOf: - type: boolean - type: string enum: - true - false default: false deletionProtectionThreshold: type: string default: "15" required: - authType - version required: - siteUrls - domain - repositoryAdditionalProperties required: - repositoryEndpointMetadata repositoryConfigurations: type: object properties: event: type: object properties: fieldMappings: type: array items: type: object properties: indexFieldName: type: string indexFieldType: type: string enum: - STRING - STRING_LIST - DATE dataSourceFieldName: type: string dateFieldFormat: type: string pattern: "yyyy-MM-dd'T'HH:mm:ss'Z'" required: - indexFieldName - indexFieldType - dataSourceFieldName required: - fieldMappings page: type: object properties: fieldMappings: type: array items: type: object properties: indexFieldName: type: string indexFieldType: type: string enum: - STRING - DATE - LONG dataSourceFieldName: type: string dateFieldFormat: type: string pattern: "yyyy-MM-dd'T'HH:mm:ss'Z'" required: - indexFieldName - indexFieldType - dataSourceFieldName required: - fieldMappings file: type: object properties: fieldMappings: type: array items: type: object properties: indexFieldName: type: string indexFieldType: type: string enum: - STRING - DATE - LONG dataSourceFieldName: type: string dateFieldFormat: type: string pattern: "yyyy-MM-dd'T'HH:mm:ss'Z'" required: - indexFieldName - indexFieldType - dataSourceFieldName required: - fieldMappings link: type: object properties: fieldMappings: type: array items: type: object properties: indexFieldName: type: string indexFieldType: type: string enum: - STRING - STRING_LIST - DATE dataSourceFieldName: type: string dateFieldFormat: type: string pattern: "yyyy-MM-dd'T'HH:mm:ss'Z'" required: - indexFieldName - indexFieldType - dataSourceFieldName required: - fieldMappings attachment: type: object properties: fieldMappings: type: array items: type: object properties: indexFieldName: type: string indexFieldType: type: string enum: - STRING - STRING_LIST - DATE dataSourceFieldName: type: string dateFieldFormat: type: string pattern: "yyyy-MM-dd'T'HH:mm:ss'Z'" required: - indexFieldName - indexFieldType - dataSourceFieldName required: - fieldMappings comment: type: object properties: fieldMappings: type: array items: type: object properties: indexFieldName: type: string indexFieldType: type: string enum: - STRING - STRING_LIST - DATE dataSourceFieldName: type: string dateFieldFormat: type: string pattern: "yyyy-MM-dd'T'HH:mm:ss'Z'" required: - indexFieldName - indexFieldType - dataSourceFieldName required: - fieldMappings required: [] additionalProperties: type: object properties: eventTitleFilterRegEx: type: array items: type: string pageTitleFilterRegEx: type: array items: type: string linkTitleFilterRegEx: type: array items: type: string inclusionFilePath: type: array items: type: string exclusionFilePath: type: array items: type: string inclusionFileTypePatterns: type: array items: type: string exclusionFileTypePatterns: type: array items: type: string inclusionFileNamePatterns: type: array items: type: string exclusionFileNamePatterns: type: array items: type: string inclusionOneNoteSectionNamePatterns: type: array items: type: string exclusionOneNoteSectionNamePatterns: type: array items: type: string inclusionOneNotePageNamePatterns: type: array items: type: string exclusionOneNotePageNamePatterns: type: array items: type: string crawlFiles: anyOf: - type: boolean - type: string enum: - true - false crawlPages: anyOf: - type: boolean - type: string enum: - true - false crawlEvents: anyOf: - type: boolean - type: string enum: - true - false crawlComments: anyOf: - type: boolean - type: string enum: - true - false crawlLinks: anyOf: - type: boolean - type: string enum: - true - false crawlAttachments: anyOf: - type: boolean - type: string enum: - true - false crawlListData: anyOf: - type: boolean - type: string enum: - true - false crawlAcl: anyOf: - type: boolean - type: string enum: - true - false aclConfiguration: type: string enum: - ACLWithLDAPEmailFmt - ACLWithManualEmailFmt - ACLWithUsernameFmt emailDomain: type: string isCrawlLocalGroupMapping: anyOf: - type: boolean - type: string enum: - true - false isCrawlAdGroupMapping: anyOf: - type: boolean - type: string enum: - true - false maxFileSizeInMegaBytes: type: string required: [] version: type: string anyOf: - pattern: 1.0.0 required: - type - syncMode - secretArn - enableIdentityCrawler - connectionConfiguration - repositoryConfigurations - additionalProperties
SharePoint (Online) YAML schema example for using the configuration property with AWS CloudFormation
The following is the SharePoint (Online) YAML example for the Configuration property for AWS CloudFormation:
AWSTemplateFormatVersion: "2010-09-09" Description: CloudFormation SHAREPOINT Data Source Template Resources: DataSourceSharePoint: Type: AWS::QBusiness::DataSource Properties: ApplicationId: app12345-1234-1234-1234-123456789012 IndexId: indx1234-1234-1234-1234-123456789012 DisplayName: MySharePointDataSource RoleArn: arn:aws:iam::123456789012:role/qbusiness-data-source-role Configuration: type: SHAREPOINTV2 syncMode: FULL_CRAWL secretArn: arn:aws:secretsmanager:us-west-2:123456789012:secret:my-sharepoint-secret enableIdentityCrawler: "true" connectionConfiguration: repositoryEndpointMetadata: tenantId: 1234567a-890b-1234-567c-123456789012 domain: example.sharepoint.com siteUrls: - https://example.sharepoint.com/sites/mysite repositoryAdditionalProperties: s3bucketName: my-bucket s3certificateName: my-certificate authType: OAuth2 version: Online enableDeletionProtection: "false" deletionProtectionThreshold: "15" repositoryConfigurations: event: fieldMappings: - indexFieldName: event_id indexFieldType: STRING dataSourceFieldName: id dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z' page: fieldMappings: - indexFieldName: page_id indexFieldType: STRING dataSourceFieldName: id dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z' additionalProperties: eventTitleFilterRegEx: - "^.*$" pageTitleFilterRegEx: - "^.*$" linkTitleFilterRegEx: - "^.*$" inclusionFilePath: - documents/ exclusionFilePath: - drafts/ inclusionFileTypePatterns: - "*.docx" exclusionFileTypePatterns: - "*.tmp" inclusionFileNamePatterns: - "*report*" exclusionFileNamePatterns: - "*draft*" enableDeletionProtection: "false" maxFileSizeInMegaBytes: "50"
