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
Microsoft Teams configuration
properties
The following provides information about important configuration properties required in the schema.
| Configuration | Description | Type | Required |
|---|---|---|---|
|
Configuration information for endpoint for the data source. |
This property has the following sub-property:
|
Yes |
|
The endpoint information for the data source. |
This property has the following sub-property:
|
Yes |
|
The Microsoft 365 tenant ID. You can find your tenant ID in the Properties of your Azure Active Directory Portal. |
The string must be 36 characters long and in in the pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ |
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 Microsoft Teams content to Amazon Q index field names. |
These properties have the following sub-properties: |
No |
|
The field name of your Microsoft Teams assets. |
|
Yes |
|
The field type of your Microsoft Teams assets. |
The allowed values are |
Yes |
|
The data source field name of your Microsoft Teams assets. |
|
Yes |
|
The date format of your Microsoft Teams assets. |
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 |
|
Specify true to crawl access control information from documents. NoteAmazon Q Business crawls ACL information by default to ensure responses are generated only from documents your end users have access to. See Authorization for more details. |
|
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 |
|
Specify the field to use for UserId for ACL crawling. |
|
No |
|
Specify true to index this content in your
Microsoft Teams data source. |
|
No |
|
A list of regular expression patterns to include specific content in your Microsoft Teams data source. Content that matches the patterns are included in the index. Content that doesn't match the patterns are excluded from the index. If any content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence, and the content isn't included in the index. |
|
No |
|
A list of regular expression patterns to exclude specific content in your Microsoft Teams data source. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns are included in the index. If any content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence, and the content isn't included in the index. |
|
No |
|
You can choose to configure a startCalendarDateTime and
endCalendarDateTime parameters so that the Microsoft Teams connector
crawls content based on a specific date range. |
Specify the date in the form
|
No |
|
Specifies what type of payment model to use with your Teams data source. Model A payment models are restricted to licensing and payment models that require security compliance. Model B payment models are suitable for licensing and payment models that don't require security compliance. |
Valid values are |
No |
|
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 Microsoft Teams. |
The secret must contain a JSON structure with the following keys: |
Yes |
|
The type of data source. Specify MSTEAMS as your data source
type. |
|
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. |
|
No |
|
The version of this template that's currently supported. |
|
No |
Microsoft Teams JSON schema for using the
configuration property with AWS CloudFormation
The following is the Microsoft Teams JSON schema and examples for the configuration property for AWS CloudFormation.
Topics
Microsoft Teams JSON schema for using the configuration property with AWS CloudFormation
The following is the Microsoft Teams JSON schema for the configuration property for AWS CloudFormation
{
"type": "object",
"properties": {
"type": {
"type": "string",
"pattern": "MSTEAMS"
},
"syncMode": {
"type": "string",
"enum": ["FORCED_FULL_CRAWL", "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
}
},
"required": ["tenantId"]
}
},
"required": ["repositoryEndpointMetadata"]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"chatMessage": {
"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"]
},
"chatAttachment": {
"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"]
},
"channelPost": {
"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"]
},
"channelWiki": {
"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"]
},
"channelAttachment": {
"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"]
},
"meetingChat": {
"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"]
},
"meetingFile": {
"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"]
},
"meetingNote": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": ["fieldMappings"]
},
"calendarMeeting": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "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": {
"isCrawlAcl": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": ["true", "false"]
}
]
},
"maxFileSizeInMegaBytes": {
"type": "string"
},
"fieldForUserId": {
"type": "string"
},
"paymentModel": {
"type": "string",
"enum": ["A", "B", "Evaluation Mode"]
},
"inclusionTeamNameFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionTeamNameFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionChannelNameFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionChannelNameFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionUserEmailFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"isCrawlChatMessage": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": ["true", "false"]
}
]
},
"isCrawlChatAttachment": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": ["true", "false"]
}
]
},
"isCrawlChannelPost": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": ["true", "false"]
}
]
},
"isCrawlChannelAttachment": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": ["true", "false"]
}
]
},
"isCrawlChannelWiki": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": ["true", "false"]
}
]
},
"isCrawlCalendarMeeting": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": ["true", "false"]
}
]
},
"isCrawlMeetingChat": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": ["true", "false"]
}
]
},
"isCrawlMeetingFile": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": ["true", "false"]
}
]
},
"isCrawlMeetingNote": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": ["true", "false"]
}
]
},
"startCalendarDateTime": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
},
{
"type": "string",
"pattern": ""
}
]
},
"endCalendarDateTime": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
},
{
"type": "string",
"pattern": ""
}
]
},
"enableDeletionProtection": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": ["true", "false"]
}
],
"default": false
},
"deletionProtectionThreshold": {
"type": "string",
"default": "15"
}
},
"required": []
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"type",
"syncMode",
"secretArn",
"connectionConfiguration",
"repositoryConfigurations",
"additionalProperties"
]
}
}Microsoft Teams JSON schema example for using the configuration property with AWS CloudFormation
The following is the Microsoft Teams JSON schema example for the configuration property for AWS CloudFormation
{
"AWSTemplateFormatVersion": "2010-09-09",
"Description": "CloudFormation MSTEAMS Data Source Template",
"Resources": {
"DataSourceMSTeams": {
"Type": "AWS::QBusiness::DataSource",
"Properties": {
"ApplicationId": "app12345-1234-1234-1234-123456789012",
"IndexId": "indx1234-1234-1234-1234-123456789012",
"DisplayName": "MyMSTeamsDataSource",
"RoleArn": "arn:aws:iam::123456789012:role/qbusiness-data-source-role",
"Configuration": {
"type": "MSTEAMS",
"syncMode": "FULL_CRAWL",
"secretArn": "arn:aws:secretsmanager:us-west-2:123456789012:secret:my-teams-secret",
"enableIdentityCrawler": "true",
"connectionConfiguration": {
"repositoryEndpointMetadata": {
"tenantId": "123e4567-e89b-12d3-a456-426614174000"
}
},
"repositoryConfigurations": {
"chatMessage": {
"fieldMappings": [
{
"indexFieldName": "message_id",
"indexFieldType": "STRING",
"dataSourceFieldName": "id",
"dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
]
},
"chatAttachment": {
"fieldMappings": [
{
"indexFieldName": "attachment_id",
"indexFieldType": "STRING",
"dataSourceFieldName": "id",
"dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
]
},
"channelPost": {
"fieldMappings": [
{
"indexFieldName": "post_id",
"indexFieldType": "STRING",
"dataSourceFieldName": "id",
"dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
]
},
"channelWiki": {
"fieldMappings": [
{
"indexFieldName": "wiki_id",
"indexFieldType": "STRING",
"dataSourceFieldName": "id",
"dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
]
},
"channelAttachment": {
"fieldMappings": [
{
"indexFieldName": "attachment_id",
"indexFieldType": "STRING",
"dataSourceFieldName": "id",
"dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
]
},
"meetingChat": {
"fieldMappings": [
{
"indexFieldName": "meeting_chat_id",
"indexFieldType": "STRING",
"dataSourceFieldName": "id",
"dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
]
},
"meetingFile": {
"fieldMappings": [
{
"indexFieldName": "meeting_file_id",
"indexFieldType": "STRING",
"dataSourceFieldName": "id",
"dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
]
},
"meetingNote": {
"fieldMappings": [
{
"indexFieldName": "meeting_note_id",
"indexFieldType": "STRING",
"dataSourceFieldName": "id",
"dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
]
},
"calendarMeeting": {
"fieldMappings": [
{
"indexFieldName": "calendar_meeting_id",
"indexFieldType": "STRING",
"dataSourceFieldName": "id",
"dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
]
}
},
"additionalProperties": {
"isCrawlAcl": "true",
"maxFileSizeInMegaBytes": "50",
"fieldForUserId": "user_id",
"paymentModel": "A",
"inclusionTeamNameFilter": ["TeamA", "TeamB"],
"exclusionTeamNameFilter": ["TeamC"],
"inclusionChannelNameFilter": ["Channel1", "Channel2"],
"exclusionChannelNameFilter": ["Channel3"],
"inclusionFileNamePatterns": ["*.docx", "*.pdf"],
"exclusionFileNamePatterns": ["*.tmp"],
"inclusionFileTypePatterns": ["image/png", "image/jpeg"],
"exclusionFileTypePatterns": ["application/octet-stream"],
"inclusionUserEmailFilter": ["user@example.com"],
"isCrawlChatMessage": "true",
"isCrawlChatAttachment": "true",
"isCrawlChannelPost": "true",
"isCrawlChannelAttachment": "true",
"isCrawlChannelWiki": "true",
"isCrawlCalendarMeeting": "true",
"isCrawlMeetingChat": "true",
"isCrawlMeetingFile": "true",
"isCrawlMeetingNote": "true",
"startCalendarDateTime": "2023-01-01T00:00:00Z",
"endCalendarDateTime": "2023-12-31T23:59:59Z",
"enableDeletionProtection": "false",
"deletionProtectionThreshold": "15"
}
}
}
}
}
}Microsoft Teams YAML schema for using the
configuration property with AWS CloudFormation
The following is the Microsoft Teams YAML schema and examples for the configuration property for AWS CloudFormation:
Topics
Microsoft Teams YAML schema for using the configuration property with AWS CloudFormation
The following is the Microsoft Teams YAML schema for the configuration property for AWS CloudFormation.
type: object
properties:
type:
type: string
pattern: MSTEAMS
syncMode:
type: string
enum:
- FORCED_FULL_CRAWL
- 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
required:
- tenantId
required:
- repositoryEndpointMetadata
repositoryConfigurations:
type: object
properties:
chatMessage:
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
chatAttachment:
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
channelPost:
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
channelWiki:
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
channelAttachment:
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
meetingChat:
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
meetingFile:
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
meetingNote:
type: object
properties:
fieldMappings:
type: array
items:
type: object
properties:
indexFieldName:
type: string
indexFieldType:
type: string
enum:
- STRING
- DATE
dataSourceFieldName:
type: string
dateFieldFormat:
type: string
pattern: "yyyy-MM-dd'T'HH:mm:ss'Z'"
required:
- indexFieldName
- indexFieldType
- dataSourceFieldName
required:
- fieldMappings
calendarMeeting:
type: object
properties:
fieldMappings:
type: array
items:
type: object
properties:
indexFieldName:
type: string
indexFieldType:
type: string
enum:
- STRING
- 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:
isCrawlAcl:
anyOf:
- type: boolean
- type: string
enum:
- "true"
- "false"
maxFileSizeInMegaBytes:
type: string
fieldForUserId:
type: string
paymentModel:
type: string
enum:
- A
- B
- Evaluation Mode
inclusionTeamNameFilter:
type: array
items:
type: string
exclusionTeamNameFilter:
type: array
items:
type: string
inclusionChannelNameFilter:
type: array
items:
type: string
exclusionChannelNameFilter:
type: array
items:
type: string
inclusionFileNamePatterns:
type: array
items:
type: string
exclusionFileNamePatterns:
type: array
items:
type: string
inclusionFileTypePatterns:
type: array
items:
type: string
exclusionFileTypePatterns:
type: array
items:
type: string
inclusionUserEmailFilter:
type: array
items:
type: string
isCrawlChatMessage:
anyOf:
- type: boolean
- type: string
enum:
- "true"
- "false"
isCrawlChatAttachment:
anyOf:
- type: boolean
- type: string
enum:
- "true"
- "false"
isCrawlChannelPost:
anyOf:
- type: boolean
- type: string
enum:
- "true"
- "false"
isCrawlChannelAttachment:
anyOf:
- type: boolean
- type: string
enum:
- "true"
- "false"
isCrawlChannelWiki:
anyOf:
- type: boolean
- type: string
enum:
- "true"
- "false"
isCrawlCalendarMeeting:
anyOf:
- type: boolean
- type: string
enum:
- "true"
- "false"
isCrawlMeetingChat:
anyOf:
- type: boolean
- type: string
enum:
- "true"
- "false"
isCrawlMeetingFile:
anyOf:
- type: boolean
- type: string
enum:
- "true"
- "false"
isCrawlMeetingNote:
anyOf:
- type: boolean
- type: string
enum:
- "true"
- "false"
startCalendarDateTime:
anyOf:
- type: string
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
- type: string
pattern: ""
endCalendarDateTime:
anyOf:
- type: string
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
- type: string
pattern: ""
enableDeletionProtection:
anyOf:
- type: boolean
- type: string
enum:
- "true"
- "false"
default: false
deletionProtectionThreshold:
type: string
default: "15"
required: []
version:
type: string
anyOf:
- pattern: "1.0.0"
required:
- connectionConfiguration
- repositoryConfigurations
- syncMode
- additionalProperties
- secretArn
- typeMicrosoft Teams YAML schema example for using the configuration property with AWS CloudFormation
The following is the Microsoft Teams YAML example for the Configuration property for AWS CloudFormation:
AWSTemplateFormatVersion: "2010-09-09"
Description: CloudFormation MSTEAMS Data Source Template
Resources:
DataSourceMSTeams:
Type: AWS::QBusiness::DataSource
Properties:
ApplicationId: app12345-1234-1234-1234-123456789012
IndexId: indx1234-1234-1234-1234-123456789012
DisplayName: MyMSTeamsDataSource
RoleArn: arn:aws:iam::123456789012:role/qbusiness-data-source-role
Configuration:
type: MSTEAMS
syncMode: FULL_CRAWL
secretArn: arn:aws:secretsmanager:us-west-2:123456789012:secret:my-teams-secret
enableIdentityCrawler: "true"
connectionConfiguration:
repositoryEndpointMetadata:
tenantId: 123e4567-e89b-12d3-a456-426614174000
repositoryConfigurations:
chatMessage:
fieldMappings:
- indexFieldName: message_id
indexFieldType: STRING
dataSourceFieldName: id
dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z'
chatAttachment:
fieldMappings:
- indexFieldName: attachment_id
indexFieldType: STRING
dataSourceFieldName: id
dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z'
channelPost:
fieldMappings:
- indexFieldName: post_id
indexFieldType: STRING
dataSourceFieldName: id
dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z'
channelWiki:
fieldMappings:
- indexFieldName: wiki_id
indexFieldType: STRING
dataSourceFieldName: id
dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z'
channelAttachment:
fieldMappings:
- indexFieldName: attachment_id
indexFieldType: STRING
dataSourceFieldName: id
dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z'
meetingChat:
fieldMappings:
- indexFieldName: meeting_chat_id
indexFieldType: STRING
dataSourceFieldName: id
dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z'
meetingFile:
fieldMappings:
- indexFieldName: meeting_file_id
indexFieldType: STRING
dataSourceFieldName: id
dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z'
meetingNote:
fieldMappings:
- indexFieldName: meeting_note_id
indexFieldType: STRING
dataSourceFieldName: id
dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z'
calendarMeeting:
fieldMappings:
- indexFieldName: calendar_meeting_id
indexFieldType: STRING
dataSourceFieldName: id
dateFieldFormat: yyyy-MM-dd'T'HH:mm:ss'Z'
additionalProperties:
isCrawlAcl: "true"
maxFileSizeInMegaBytes: "50"
fieldForUserId: user_id
paymentModel: A
inclusionTeamNameFilter:
- TeamA
- TeamB
exclusionTeamNameFilter:
- TeamC
inclusionChannelNameFilter:
- Channel1
- Channel2
exclusionChannelNameFilter:
- Channel3
inclusionFileNamePatterns:
- "*.docx"
- "*.pdf"
exclusionFileNamePatterns:
- "*.tmp"
inclusionFileTypePatterns:
- image/png
- image/jpeg
exclusionFileTypePatterns:
- application/octet-stream
inclusionUserEmailFilter:
- user@example.com
isCrawlChatMessage: "true"
isCrawlChatAttachment: "true"
isCrawlChannelPost: "true"
isCrawlChannelAttachment: "true"
isCrawlChannelWiki: "true"
isCrawlCalendarMeeting: "true"
isCrawlMeetingChat: "true"
isCrawlMeetingFile: "true"
isCrawlMeetingNote: "true"
startCalendarDateTime: "2023-01-01T00:00:00Z"
endCalendarDateTime: "2023-12-31T23:59:59Z"
enableDeletionProtection: "false"
deletionProtectionThreshold: "15"