interface CfnMicrosoftTeamsChannelConfigurationProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Chatbot.CfnMicrosoftTeamsChannelConfigurationProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awschatbot#CfnMicrosoftTeamsChannelConfigurationProps |
Java | software.amazon.awscdk.services.chatbot.CfnMicrosoftTeamsChannelConfigurationProps |
Python | aws_cdk.aws_chatbot.CfnMicrosoftTeamsChannelConfigurationProps |
TypeScript | aws-cdk-lib » aws_chatbot » CfnMicrosoftTeamsChannelConfigurationProps |
Properties for defining a CfnMicrosoftTeamsChannelConfiguration
.
Example
// 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
guardrailPolicies: ['guardrailPolicies'],
loggingLevel: 'loggingLevel',
snsTopicArns: ['snsTopicArns'],
tags: [{
key: 'key',
value: 'value',
}],
userRoleRequired: false,
};
Properties
Name | Type | Description |
---|---|---|
configuration | string | The name of the configuration. |
iam | string | The ARN of the IAM role that defines the permissions for AWS Chatbot . |
team | string | The ID of the Microsoft Team authorized with AWS Chatbot . |
teams | string | The ID of the Microsoft Teams channel. |
teams | string | The ID of the Microsoft Teams tenant. |
guardrail | string[] | The list of IAM policy ARNs that are applied as channel guardrails. |
logging | string | Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs. |
sns | string[] | The ARNs of the SNS topics that deliver notifications to AWS Chatbot . |
tags? | Cfn [] | The tags to add to the configuration. |
user | boolean | IResolvable | Enables use of a user role requirement in your chat configuration. |
configurationName
Type:
string
The name of the configuration.
iamRoleArn
Type:
string
The ARN of the IAM role that defines the permissions for AWS Chatbot .
This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot .
teamId
Type:
string
The ID of the Microsoft Team authorized with AWS Chatbot .
To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-3 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide .
teamsChannelId
Type:
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
.
teamsTenantId
Type:
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 AWS Chatbot console. Then you can copy and paste the tenant ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide .
guardrailPolicies?
Type:
string[]
(optional)
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.
loggingLevel?
Type:
string
(optional, default: "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
.
snsTopicArns?
Type:
string[]
(optional)
The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
tags?
Type:
Cfn
[]
(optional)
The tags to add to the configuration.
userRoleRequired?
Type:
boolean |
IResolvable
(optional, default: false)
Enables use of a user role requirement in your chat configuration.