Package software.amazon.awscdk.services.chatbot

Class CfnMicrosoftTeamsChannelConfiguration

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.chatbot.CfnMicrosoftTeamsChannelConfiguration
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:38.207Z") @Stability(Stable) public class CfnMicrosoftTeamsChannelConfiguration extends CfnResource implements IInspectable
A CloudFormation AWS::Chatbot::MicrosoftTeamsChannelConfiguration.

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 .

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
         .guardrailPolicies(List.of("guardrailPolicies"))
         .loggingLevel("loggingLevel")
         .snsTopicArns(List.of("snsTopicArns"))
         .userRoleRequired(false)
         .build();

  • 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 Construct scope, @NotNull String id, @NotNull CfnMicrosoftTeamsChannelConfigurationProps props)
      Create a new AWS::Chatbot::MicrosoftTeamsChannelConfiguration.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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()

    • getCfnProperties

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

    • 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 AWS Chatbot .

      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 .

    • setIamRoleArn

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

      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 .

    • getTeamId

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

      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 .

    • setTeamId

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

      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 .

    • getTeamsChannelId

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

      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 .

    • setTeamsChannelId

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

      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 .

    • getTeamsTenantId

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

      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 .

    • setTeamsTenantId

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

      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 .

    • getGuardrailPolicies

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

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

    • setGuardrailPolicies

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

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

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

      Logging levels include ERROR , INFO , or NONE .

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

      Logging levels include ERROR , INFO , or NONE .

    • getSnsTopicArns

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

    • setSnsTopicArns

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

    • getUserRoleRequired

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

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