Class CfnMicrosoftTeamsChannelConfigurationProps

Properties for defining a CfnMicrosoftTeamsChannelConfiguration.

Inheritance

System.Object

CfnMicrosoftTeamsChannelConfigurationProps

Implements

ICfnMicrosoftTeamsChannelConfigurationProps

Namespace: Amazon.CDK.AWS.Chatbot

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnMicrosoftTeamsChannelConfigurationProps : Object, ICfnMicrosoftTeamsChannelConfigurationProps

Syntax (vb)

Public Class CfnMicrosoftTeamsChannelConfigurationProps
    Inherits Object
    Implements ICfnMicrosoftTeamsChannelConfigurationProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html

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
    GuardrailPolicies = new [] { "guardrailPolicies" },
    LoggingLevel = "loggingLevel",
    SnsTopicArns = new [] { "snsTopicArns" },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    UserRoleRequired = false
};

Synopsis

Constructors

CfnMicrosoftTeamsChannelConfigurationProps()

Properties

ConfigurationName	The name of the configuration.
GuardrailPolicies	The list of IAM policy ARNs that are applied as channel guardrails.
IamRoleArn	The ARN of the IAM role that defines the permissions for AWS Chatbot .
LoggingLevel	Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.
SnsTopicArns	The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
Tags	The tags to add to the configuration.
TeamId	The ID of the Microsoft Team authorized with AWS Chatbot .
TeamsChannelId	The ID of the Microsoft Teams channel.
TeamsTenantId	The ID of the Microsoft Teams tenant.
UserRoleRequired	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.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#cfn-chatbot-microsoftteamschannelconfiguration-configurationname

GuardrailPolicies

The list of IAM policy ARNs that are applied as channel guardrails.

public string[] GuardrailPolicies { get; set; }

Property Value

System.String[]

Remarks

The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#cfn-chatbot-microsoftteamschannelconfiguration-guardrailpolicies

IamRoleArn

The ARN of the IAM role that defines the permissions for AWS Chatbot .

public string IamRoleArn { get; set; }

Property Value

System.String

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#cfn-chatbot-microsoftteamschannelconfiguration-iamrolearn

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

Remarks

Logging levels include ERROR , INFO , or NONE .

Default: - "NONE"

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#cfn-chatbot-microsoftteamschannelconfiguration-logginglevel

SnsTopicArns

The ARNs of the SNS topics that deliver notifications to AWS Chatbot .

public string[] SnsTopicArns { get; set; }

Property Value

System.String[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#cfn-chatbot-microsoftteamschannelconfiguration-snstopicarns

Tags

The tags to add to the configuration.

public ICfnTag[] Tags { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#cfn-chatbot-microsoftteamschannelconfiguration-tags

TeamId

The ID of the Microsoft Team authorized with AWS Chatbot .

public string TeamId { get; set; }

Property Value

System.String

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#cfn-chatbot-microsoftteamschannelconfiguration-teamid

TeamsChannelId

The ID of the Microsoft Teams channel.

public string TeamsChannelId { get; set; }

Property Value

System.String

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#cfn-chatbot-microsoftteamschannelconfiguration-teamschannelid

TeamsTenantId

The ID of the Microsoft Teams tenant.

public string TeamsTenantId { get; set; }

Property Value

System.String

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#cfn-chatbot-microsoftteamschannelconfiguration-teamstenantid

UserRoleRequired

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

public object UserRoleRequired { get; set; }

Property Value

System.Object

Remarks

Default: - false

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-microsoftteamschannelconfiguration.html#cfn-chatbot-microsoftteamschannelconfiguration-userrolerequired

Implements

ICfnMicrosoftTeamsChannelConfigurationProps