Package software.amazon.awscdk.services.chatbot

Class CfnMicrosoftTeamsChannelConfiguration

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.chatbot.CfnMicrosoftTeamsChannelConfiguration
All Implemented Interfaces:
IInspectable, ITaggableV2, IMicrosoftTeamsChannelConfigurationRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:33.947Z") @Stability(Stable) public class CfnMicrosoftTeamsChannelConfiguration extends CfnResource implements IInspectable, IMicrosoftTeamsChannelConfigurationRef, ITaggableV2

AWS Chatbot is now . Learn more > > Type attribute values remain unchanged.

The AWS::Chatbot::MicrosoftTeamsChannelConfiguration resource configures a Microsoft Teams channel to allow users to use with AWS CloudFormation templates.

This resource requires some setup to be done in the in chat applications console. To provide the required Microsoft Teams team and tenant IDs, you must perform the initial authorization flow with Microsoft Teams in the in chat applications console, then copy and paste the IDs from the console. For more details, see steps 1-3 in Get started with Microsoft Teams in the in chat applications Administrator Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.chatbot.*;
 CfnMicrosoftTeamsChannelConfiguration cfnMicrosoftTeamsChannelConfiguration = CfnMicrosoftTeamsChannelConfiguration.Builder.create(this, "MyCfnMicrosoftTeamsChannelConfiguration")
         .configurationName("configurationName")
         .iamRoleArn("iamRoleArn")
         .teamId("teamId")
         .teamsChannelId("teamsChannelId")
         .teamsTenantId("teamsTenantId")
         // the properties below are optional
         .customizationResourceArns(List.of("customizationResourceArns"))
         .guardrailPolicies(List.of("guardrailPolicies"))
         .loggingLevel("loggingLevel")
         .snsTopicArns(List.of("snsTopicArns"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .teamsChannelName("teamsChannelName")
         .userRoleRequired(false)
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnMicrosoftTeamsChannelConfiguration

      protected CfnMicrosoftTeamsChannelConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnMicrosoftTeamsChannelConfiguration

      protected CfnMicrosoftTeamsChannelConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnMicrosoftTeamsChannelConfiguration

      @Stability(Stable) public CfnMicrosoftTeamsChannelConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMicrosoftTeamsChannelConfigurationProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the resource.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getMicrosoftTeamsChannelConfigurationRef

      @Stability(Stable) @NotNull public MicrosoftTeamsChannelConfigurationReference getMicrosoftTeamsChannelConfigurationRef()
      A reference to a MicrosoftTeamsChannelConfiguration resource.
      Specified by:
      getMicrosoftTeamsChannelConfigurationRef in interface IMicrosoftTeamsChannelConfigurationRef

    • getConfigurationName

      @Stability(Stable) @NotNull public String getConfigurationName()
      The name of the configuration.

    • setConfigurationName

      @Stability(Stable) public void setConfigurationName(@NotNull String value)
      The name of the configuration.

    • getIamRoleArn

      @Stability(Stable) @NotNull public String getIamRoleArn()
      The ARN of the IAM role that defines the permissions for .

    • setIamRoleArn

      @Stability(Stable) public void setIamRoleArn(@NotNull String value)
      The ARN of the IAM role that defines the permissions for .

    • getTeamId

      @Stability(Stable) @NotNull public String getTeamId()
      The ID of the Microsoft Team authorized with .

    • setTeamId

      @Stability(Stable) public void setTeamId(@NotNull String value)
      The ID of the Microsoft Team authorized with .

    • getTeamsChannelId

      @Stability(Stable) @NotNull public String getTeamsChannelId()
      The ID of the Microsoft Teams channel.

    • setTeamsChannelId

      @Stability(Stable) public void setTeamsChannelId(@NotNull String value)
      The ID of the Microsoft Teams channel.

    • getTeamsTenantId

      @Stability(Stable) @NotNull public String getTeamsTenantId()
      The ID of the Microsoft Teams tenant.

    • setTeamsTenantId

      @Stability(Stable) public void setTeamsTenantId(@NotNull String value)
      The ID of the Microsoft Teams tenant.

    • getCustomizationResourceArns

      @Stability(Stable) @Nullable public List<String> getCustomizationResourceArns()
      Links a list of resource ARNs (for example, custom action ARNs) to a Microsoft Teams channel configuration for .

    • setCustomizationResourceArns

      @Stability(Stable) public void setCustomizationResourceArns(@Nullable List<String> value)
      Links a list of resource ARNs (for example, custom action ARNs) to a Microsoft Teams channel configuration for .

    • getGuardrailPolicies

      @Stability(Stable) @Nullable public List<String> getGuardrailPolicies()
      The list of IAM policy ARNs that are applied as channel guardrails.

    • setGuardrailPolicies

      @Stability(Stable) public void setGuardrailPolicies(@Nullable List<String> value)
      The list of IAM policy ARNs that are applied as channel guardrails.

    • getLoggingLevel

      @Stability(Stable) @Nullable public String getLoggingLevel()
      Specifies the logging level for this configuration.

      This property affects the log entries pushed to Amazon CloudWatch Logs.

    • setLoggingLevel

      @Stability(Stable) public void setLoggingLevel(@Nullable String value)
      Specifies the logging level for this configuration.

      This property affects the log entries pushed to Amazon CloudWatch Logs.

    • getSnsTopicArns

      @Stability(Stable) @Nullable public List<String> getSnsTopicArns()
      The ARNs of the SNS topics that deliver notifications to .

    • setSnsTopicArns

      @Stability(Stable) public void setSnsTopicArns(@Nullable List<String> value)
      The ARNs of the SNS topics that deliver notifications to .

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags to add to the configuration.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags to add to the configuration.

    • getTeamsChannelName

      @Stability(Stable) @Nullable public String getTeamsChannelName()
      The name of the Microsoft Teams channel.

    • setTeamsChannelName

      @Stability(Stable) public void setTeamsChannelName(@Nullable String value)
      The name of the Microsoft Teams channel.

    • getUserRoleRequired

      @Stability(Stable) @Nullable public Object getUserRoleRequired()
      Enables use of a user role requirement in your chat configuration.

      Returns union: either Boolean or IResolvable

    • setUserRoleRequired

      @Stability(Stable) public void setUserRoleRequired(@Nullable Boolean value)
      Enables use of a user role requirement in your chat configuration.

    • setUserRoleRequired

      @Stability(Stable) public void setUserRoleRequired(@Nullable IResolvable value)
      Enables use of a user role requirement in your chat configuration.