Class CfnMicrosoftTeamsChannelConfiguration
A CloudFormation AWS::Chatbot::MicrosoftTeamsChannelConfiguration
.
Inheritance
Inherited Members
Namespace: Amazon.CDK.AWS.Chatbot
Assembly: Amazon.CDK.AWS.Chatbot.dll
Syntax (csharp)
public class CfnMicrosoftTeamsChannelConfiguration : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnMicrosoftTeamsChannelConfiguration
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::Chatbot::MicrosoftTeamsChannelConfiguration
resource configures a Microsoft Teams channel to allow users to use AWS Chatbot with AWS CloudFormation templates.
This resource requires some setup to be done in the AWS Chatbot console. To provide the required Microsoft Teams team and tenant IDs, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console, then copy and paste the IDs from the console. For more details, see steps 1-4 in Setting Up AWS Chatbot with Microsoft Teams in the AWS Chatbot Administrator Guide .
CloudformationResource: AWS::Chatbot::MicrosoftTeamsChannelConfiguration
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 cfnMicrosoftTeamsChannelConfiguration = new CfnMicrosoftTeamsChannelConfiguration(this, "MyCfnMicrosoftTeamsChannelConfiguration", 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" },
UserRoleRequired = false
});
Synopsis
Constructors
CfnMicrosoftTeamsChannelConfiguration(Construct, String, ICfnMicrosoftTeamsChannelConfigurationProps) | Create a new |
CfnMicrosoftTeamsChannelConfiguration(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnMicrosoftTeamsChannelConfiguration(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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 . |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnMicrosoftTeamsChannelConfiguration(Construct, String, ICfnMicrosoftTeamsChannelConfigurationProps)
Create a new AWS::Chatbot::MicrosoftTeamsChannelConfiguration
.
public CfnMicrosoftTeamsChannelConfiguration(Construct scope, string id, ICfnMicrosoftTeamsChannelConfigurationProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnMicrosoftTeamsChannelConfigurationProps
- resource properties.
CfnMicrosoftTeamsChannelConfiguration(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnMicrosoftTeamsChannelConfiguration(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnMicrosoftTeamsChannelConfiguration(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnMicrosoftTeamsChannelConfiguration(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ConfigurationName
The name of the configuration.
public virtual string ConfigurationName { get; set; }
Property Value
System.String
Remarks
GuardrailPolicies
The list of IAM policy ARNs that are applied as channel guardrails.
public virtual string[] GuardrailPolicies { get; set; }
Property Value
System.String[]
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 AWS Chatbot .
public virtual 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 .
LoggingLevel
Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.
public virtual string LoggingLevel { get; set; }
Property Value
System.String
Remarks
Logging levels include ERROR
, INFO
, or NONE
.
SnsTopicArns
The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
public virtual string[] SnsTopicArns { get; set; }
Property Value
System.String[]
Remarks
TeamId
The ID of the Microsoft Team authorized with AWS Chatbot .
public virtual 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-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide .
TeamsChannelId
The ID of the Microsoft Teams channel.
public virtual 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
.
TeamsTenantId
The ID of the Microsoft Teams tenant.
public virtual 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 .
UserRoleRequired
Enables use of a user role requirement in your chat configuration.
public virtual object UserRoleRequired { get; set; }
Property Value
System.Object
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>