AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Chatbot::MicrosoftTeamsChannelConfiguration

CfnMicrosoftTeamsChannelConfiguration

> AWS Chatbot is now . [Learn more](https://docs.aws.amazon.com//chatbot/latest/adminguide/service-rename.html) > > `Type` attribute values remain unchanged. The `AWS::Chatbot::MicrosoftTeamsChannelConfiguration` resource configures a Microsoft Teams channel to allow users to use with CloudFormation templates. This resource requires some setup to be done in the 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 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](https://docs.aws.amazon.com/chatbot/latest/adminguide/teams-setup.html#teams-client-setup) in the *in chat applications Administrator Guide* .

Import

import { CfnMicrosoftTeamsChannelConfiguration } from 'aws-cdk-lib/aws-chatbot';

Or use the module namespace:

import * as chatbot from 'aws-cdk-lib/aws-chatbot';
// chatbot.CfnMicrosoftTeamsChannelConfiguration

Properties

Configuration passed to the constructor as CfnMicrosoftTeamsChannelConfigurationProps.

configurationNameRequired
string

The name of the configuration.

iamRoleArnRequired
string

The ARN of the IAM role that defines the permissions for . This is a user-defined role that will assume. This is not the service-linked role. For more information, see [IAM Policies for in chat applications](https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html) .

teamIdRequired
string

The ID of the Microsoft Team authorized with . To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the 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](https://docs.aws.amazon.com/chatbot/latest/adminguide/teams-setup.html) in the *in chat applications Administrator Guide* .

teamsChannelIdRequired
string

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` .

teamsTenantIdRequired
string

The ID of the Microsoft Teams tenant. To get the tenant ID, you must perform the initial authorization flow with Microsoft Teams in the 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](https://docs.aws.amazon.com/chatbot/latest/adminguide/teams-setup.html) in the *in chat applications Administrator Guide* .

customizationResourceArnsOptional
string[]

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

guardrailPoliciesOptional
string[]

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.

loggingLevelOptional
string

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` .

Default: - "NONE"

snsTopicArnsOptional
string[]

The ARNs of the SNS topics that deliver notifications to .

tagsOptional
CfnTag[]

The tags to add to the configuration.

teamsChannelNameOptional
string

The name of the Microsoft Teams channel.

userRoleRequiredOptional
boolean | IResolvable

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

Default: - false

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-chatbot
CFN TypeAWS::Chatbot::MicrosoftTeamsChannelConfiguration
Properties12

External Links