AWS::Chatbot::MicrosoftTeamsChannelConfiguration - AWS CloudFormation
SyntaxPropertiesReturn valuesRemarks

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Chatbot::MicrosoftTeamsChannelConfiguration

Note

AWS Chatbot is now Amazon Q Developer. Learn more

Type attribute values remain unchanged.

The AWS::Chatbot::MicrosoftTeamsChannelConfiguration resource configures a Microsoft Teams channel to allow users to use Amazon Q Developer with AWS CloudFormation templates.

This resource requires some setup to be done in the Amazon Q Developer in chat applications console. To provide the required Microsoft Teams team and tenant IDs, you must perform the initial authorization flow with Microsoft Teams in the Amazon Q Developer in chat applications console, then copy and paste the IDs from the console. For more details, see steps 1-3 in Get started with Microsoft Teams in the Amazon Q Developer in chat applications Administrator Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Chatbot::MicrosoftTeamsChannelConfiguration",
  "Properties" : {
      "ConfigurationName" : String,
      "CustomizationResourceArns" : [ String, ... ],
      "GuardrailPolicies" : [ String, ... ],
      "IamRoleArn" : String,
      "LoggingLevel" : String,
      "SnsTopicArns" : [ String, ... ],
      "Tags" : [ Tag, ... ],
      "TeamId" : String,
      "TeamsChannelId" : String,
      "TeamsChannelName" : String,
      "TeamsTenantId" : String,
      "UserRoleRequired" : Boolean
    }
}

YAML

Type: AWS::Chatbot::MicrosoftTeamsChannelConfiguration
Properties:
  ConfigurationName: String
  CustomizationResourceArns: 
    - String
  GuardrailPolicies: 
    - String
  IamRoleArn: String
  LoggingLevel: String
  SnsTopicArns: 
    - String
  Tags: 
    - Tag
  TeamId: String
  TeamsChannelId: String
  TeamsChannelName: String
  TeamsTenantId: String
  UserRoleRequired: Boolean

Properties

ConfigurationName

The name of the configuration.

Required: Yes

Type: String

Pattern: ^[A-Za-z0-9-_]+$

Minimum: 1

Maximum: 128

Update requires: Replacement

CustomizationResourceArns

Links a list of resource ARNs (for example, custom action ARNs) to a Microsoft Teams channel configuration for Amazon Q Developer.

Required: No

Type: Array of String

Update requires: No interruption

GuardrailPolicies

The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.

Required: No

Type: Array of String

Update requires: No interruption

IamRoleArn

The ARN of the IAM role that defines the permissions for Amazon Q Developer.

This is a user-defined role that Amazon Q Developer will assume. This is not the service-linked role. For more information, see IAM Policies for Amazon Q Developer in chat applications.

Required: Yes

Type: String

Pattern: ^arn:(aws[a-zA-Z-]*)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$

Update requires: No interruption

LoggingLevel

Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.

Logging levels include ERROR, INFO, or NONE.

Required: No

Type: String

Pattern: ^(ERROR|INFO|NONE)$

Update requires: No interruption

SnsTopicArns

The ARNs of the SNS topics that deliver notifications to Amazon Q Developer.

Required: No

Type: Array of String

Update requires: No interruption

Tags

The tags to add to the configuration.

Required: No

Type: Array of Tag

Update requires: No interruption

TeamId

The ID of the Microsoft Team authorized with Amazon Q Developer.

To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the Amazon Q Developer in chat applications console. Then you can copy and paste the team ID from the console. For more details, see steps 1-3 in Tutorial: Get started with Microsoft Teams in the Amazon Q Developer in chat applications Administrator Guide.

Required: Yes

Type: String

Pattern: ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$

Minimum: 36

Maximum: 36

Update requires: Replacement

TeamsChannelId

The ID of the Microsoft Teams channel.

To get the channel ID, open Microsoft Teams, right click on the channel name in the left pane, then choose Copy. An example of the channel ID syntax is: 19%3ab6ef35dc342d56ba5654e6fc6d25a071%40thread.tacv2.

Required: Yes

Type: String

Pattern: ^([a-zA-Z0-9-_=+/.,])*%3[aA]([a-zA-Z0-9-_=+/.,])*%40([a-zA-Z0-9-_=+/.,])*$

Minimum: 1

Maximum: 256

Update requires: No interruption

TeamsChannelName

Property description not available.

Required: No

Type: String

Pattern: ^(.*)$

Minimum: 1

Maximum: 256

Update requires: No interruption

TeamsTenantId

The ID of the Microsoft Teams tenant.

To get the tenant ID, you must perform the initial authorization flow with Microsoft Teams in the Amazon Q Developer in chat applications console. Then you can copy and paste the tenant ID from the console. For more details, see steps 1-3 in Tutorial: Get started with Microsoft Teams in the Amazon Q Developer in chat applications Administrator Guide.

Required: Yes

Type: String

Pattern: ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$

Minimum: 36

Maximum: 36

Update requires: Replacement

UserRoleRequired

Enables use of a user role requirement in your chat configuration.

Required: No

Type: Boolean

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the configuration created.

Fn::GetAtt

Arn

The ARN of the resource.

Remarks

Common troubleshooting scenarios:

  • I don't have a teams, tenant, or channel ID.

    If you don't have one or any of the aforementioned IDs, you must perform the initial authorization flow in the Amazon Q Developer in chat applications console. Then you will be able to copy and paste the IDs from the console. For more details, see steps 1-3 in Tutorial: Get started with Microsoft Teams in the Amazon Q Developer in chat applications Administrator Guide.

  • I have already done the initial authorization for my workspace. Do I need to do it again?

    No, you can use your existing workspace. You must log into the Amazon Q Developer in chat applications console to get the workspace ID.