AWS CDK Reference

Appearance

v2.274.0

CfnMicrosoftTeamsChannelConfigurationProps Struct ​

Properties for defining a CfnMicrosoftTeamsChannelConfiguration.

Source
Generated code
Type last changed
v2.185.0 · 19 Mar 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_chatbot as chatbot } from 'aws-cdk-lib';
const cfnMicrosoftTeamsChannelConfigurationProps: chatbot.CfnMicrosoftTeamsChannelConfigurationProps = {
  configurationName: 'configurationName',
  iamRoleArn: 'iamRoleArn',
  teamId: 'teamId',
  teamsChannelId: 'teamsChannelId',
  teamsTenantId: 'teamsTenantId',

  // the properties below are optional
  customizationResourceArns: ['customizationResourceArns'],
  guardrailPolicies: ['guardrailPolicies'],
  loggingLevel: 'loggingLevel',
  snsTopicArns: ['snsTopicArns'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  teamsChannelName: 'teamsChannelName',
  userRoleRequired: false,
};

Properties ​

configurationNamestringconfiguration_namestrconfigurationNameStringConfigurationNamestringConfigurationName*stringrequired#
The name of the configuration.
customizationResourceArnsoptionalstring[]customization_resource_arnsoptionaltyping.List[str]customizationResourceArnsoptionalList<String>CustomizationResourceArnsoptionalstring[]CustomizationResourceArnsoptional*[]*string#
Links a list of resource ARNs (for example, custom action ARNs) to a Microsoft Teams channel configuration for .
guardrailPoliciesoptionalstring[]guardrail_policiesoptionaltyping.List[str]guardrailPoliciesoptionalList<String>GuardrailPoliciesoptionalstring[]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.

iamRoleArnstringiam_role_arnstriamRoleArnStringIamRoleArnstringIamRoleArn*stringrequired#
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 .

loggingLeveloptionalstringlogging_leveloptionalstrloggingLeveloptionalStringLoggingLeveloptionalstringLoggingLeveloptional*string= "NONE"#
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 .

snsTopicArnsoptionalstring[]sns_topic_arnsoptionaltyping.List[str]snsTopicArnsoptionalList<String>SnsTopicArnsoptionalstring[]SnsTopicArnsoptional*[]*string#
The ARNs of the SNS topics that deliver notifications to .
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags to add to the configuration.
teamIdstringteam_idstrteamIdStringTeamIdstringTeamId*stringrequired#
The ID of the Microsoft Team authorized with .
notes

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 in the in chat applications Administrator Guide .

teamsChannelIdstringteams_channel_idstrteamsChannelIdStringTeamsChannelIdstringTeamsChannelId*stringrequired#
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 .

teamsChannelNameoptionalstringteams_channel_nameoptionalstrteamsChannelNameoptionalStringTeamsChannelNameoptionalstringTeamsChannelNameoptional*string#
The name of the Microsoft Teams channel.
teamsTenantIdstringteams_tenant_idstrteamsTenantIdStringTeamsTenantIdstringTeamsTenantId*stringrequired#
The ID of the Microsoft Teams tenant.
notes

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 in the in chat applications Administrator Guide .

userRoleRequiredoptionalboolean | IResolvableuser_role_requiredoptionaltyping.Union[bool, IResolvable]userRoleRequiredoptionalBooleanUserRoleRequiredoptionalboolUserRoleRequiredoptionalinterface{}= false#
Enables use of a user role requirement in your chat configuration.