Class CfnMicrosoftTeamsChannelConfigurationProps
Properties for defining a CfnMicrosoftTeamsChannelConfiguration.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Chatbot
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnMicrosoftTeamsChannelConfigurationProps : Object, ICfnMicrosoftTeamsChannelConfigurationPropsSyntax (vb)
Public Class CfnMicrosoftTeamsChannelConfigurationProps
Inherits Object
Implements ICfnMicrosoftTeamsChannelConfigurationPropsRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Chatbot;
var cfnMicrosoftTeamsChannelConfigurationProps = new CfnMicrosoftTeamsChannelConfigurationProps {
ConfigurationName = "configurationName",
IamRoleArn = "iamRoleArn",
TeamId = "teamId",
TeamsChannelId = "teamsChannelId",
TeamsTenantId = "teamsTenantId",
// the properties below are optional
CustomizationResourceArns = new [] { "customizationResourceArns" },
GuardrailPolicies = new [] { "guardrailPolicies" },
LoggingLevel = "loggingLevel",
SnsTopicArns = new [] { "snsTopicArns" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
UserRoleRequired = false
};Synopsis
Constructors
| Cfn |
Properties
| Configuration |
The name of the configuration. |
| Customization |
Links a list of resource ARNs (for example, custom action ARNs) to a Microsoft Teams channel configuration for . |
| Guardrail |
The list of IAM policy ARNs that are applied as channel guardrails. |
| Iam |
The ARN of the IAM role that defines the permissions for . |
| Logging |
Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs. |
| Sns |
The ARNs of the SNS topics that deliver notifications to . |
| Tags | The tags to add to the configuration. |
| Team |
The ID of the Microsoft Team authorized with . |
| Teams |
The ID of the Microsoft Teams channel. |
| Teams |
The ID of the Microsoft Teams tenant. |
| User |
Enables use of a user role requirement in your chat configuration. |
Constructors
CfnMicrosoftTeamsChannelConfigurationProps()
public CfnMicrosoftTeamsChannelConfigurationProps()Properties
ConfigurationName
The name of the configuration.
public string ConfigurationName { get; set; }Property Value
System.
Remarks
CustomizationResourceArns
Links a list of resource ARNs (for example, custom action ARNs) to a Microsoft Teams channel configuration for .
public string[] CustomizationResourceArns { get; set; }Property Value
System.
Remarks
GuardrailPolicies
The list of IAM policy ARNs that are applied as channel guardrails.
public string[] GuardrailPolicies { get; set; }Property Value
System.
Remarks
The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.
IamRoleArn
The ARN of the IAM role that defines the permissions for .
public string IamRoleArn { get; set; }Property Value
System.
Remarks
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 .
LoggingLevel
Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.
public string LoggingLevel { get; set; }Property Value
System.
Remarks
Logging levels include ERROR , INFO , or NONE .
Default: - "NONE"
SnsTopicArns
The ARNs of the SNS topics that deliver notifications to .
public string[] SnsTopicArns { get; set; }Property Value
System.
Remarks
Tags
The tags to add to the configuration.
public ICfnTag[] Tags { get; set; }Property Value
ICfn
Remarks
TeamId
The ID of the Microsoft Team authorized with .
public string TeamId { get; set; }Property Value
System.
Remarks
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 .
TeamsChannelId
The ID of the Microsoft Teams channel.
public string TeamsChannelId { get; set; }Property Value
System.
Remarks
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
The ID of the Microsoft Teams tenant.
public string TeamsTenantId { get; set; }Property Value
System.
Remarks
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 .
UserRoleRequired
Enables use of a user role requirement in your chat configuration.
public object UserRoleRequired { get; set; }Property Value
System.