Class CfnMicrosoftTeamsChannelConfiguration
The AWS::Chatbot::MicrosoftTeamsChannelConfiguration
resource configures a Microsoft Teams channel to allow users to use AWS Chatbot with AWS CloudFormation templates.
Inheritance
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Chatbot
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnMicrosoftTeamsChannelConfiguration : CfnResource, IInspectable
Syntax (vb)
Public Class CfnMicrosoftTeamsChannelConfiguration
Inherits CfnResource
Implements IInspectable
Remarks
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 Configure a Microsoft Teams client 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(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 |
CfnMicrosoftTeamsChannelConfiguration(Construct, String, ICfnMicrosoftTeamsChannelConfigurationProps) |
Properties
AttrArn | Amazon Resource Name (ARN) of the configuration. |
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. |
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(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
CfnMicrosoftTeamsChannelConfiguration(Construct, String, ICfnMicrosoftTeamsChannelConfigurationProps)
public CfnMicrosoftTeamsChannelConfiguration(Construct scope, string id, ICfnMicrosoftTeamsChannelConfigurationProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnMicrosoftTeamsChannelConfigurationProps
Resource properties.
Properties
AttrArn
Amazon Resource Name (ARN) of the configuration.
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
GuardrailPolicies
The list of IAM policy ARNs that are applied as channel guardrails.
public virtual string[] GuardrailPolicies { get; set; }
Property Value
System.String[]
IamRoleArn
The ARN of the IAM role that defines the permissions for AWS Chatbot .
public virtual string IamRoleArn { get; set; }
Property Value
System.String
LoggingLevel
Specifies the logging level for this configuration.
public virtual string LoggingLevel { get; set; }
Property Value
System.String
Remarks
This property affects the log entries pushed to Amazon CloudWatch Logs.
SnsTopicArns
The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
public virtual string[] SnsTopicArns { get; set; }
Property Value
System.String[]
TeamId
The ID of the Microsoft Team authorized with AWS Chatbot .
public virtual string TeamId { get; set; }
Property Value
System.String
TeamsChannelId
The ID of the Microsoft Teams channel.
public virtual string TeamsChannelId { get; set; }
Property Value
System.String
TeamsTenantId
The ID of the Microsoft Teams tenant.
public virtual string TeamsTenantId { get; set; }
Property Value
System.String
UserRoleRequired
Enables use of a user role requirement in your chat configuration.
public virtual object UserRoleRequired { get; set; }
Property Value
System.Object
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>