Package software.amazon.awscdk.services.chatbot

Interface CfnMicrosoftTeamsChannelConfigurationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMicrosoftTeamsChannelConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-31T18:44:09.899Z")
@Stability(Stable)
public interface CfnMicrosoftTeamsChannelConfigurationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnMicrosoftTeamsChannelConfiguration`.

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.*;
 CfnMicrosoftTeamsChannelConfigurationProps cfnMicrosoftTeamsChannelConfigurationProps = CfnMicrosoftTeamsChannelConfigurationProps.builder()
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnMicrosoftTeamsChannelConfigurationProps.Builder	A builder for CfnMicrosoftTeamsChannelConfigurationProps
static final class	CfnMicrosoftTeamsChannelConfigurationProps.Jsii$Proxy	An implementation for CfnMicrosoftTeamsChannelConfigurationProps

Method Summary

Modifier and Type	Method	Description
static CfnMicrosoftTeamsChannelConfigurationProps.Builder	builder()
String	getConfigurationName()	The name of the configuration.
default List<String>	getGuardrailPolicies()	The list of IAM policy ARNs that are applied as channel guardrails.
String	getIamRoleArn()	The ARN of the IAM role that defines the permissions for AWS Chatbot .
default String	getLoggingLevel()	Specifies the logging level for this configuration.
default List<String>	getSnsTopicArns()	The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
String	getTeamId()	The ID of the Microsoft Team authorized with AWS Chatbot .
String	getTeamsChannelId()	The ID of the Microsoft Teams channel.
String	getTeamsTenantId()	The ID of the Microsoft Teams tenant.
default Object	getUserRoleRequired()	Enables use of a user role requirement in your chat configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConfigurationName

@Stability(Stable)
@NotNull
String getConfigurationName()

The name of the configuration.

getIamRoleArn

@Stability(Stable)
@NotNull
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 .

getTeamId

@Stability(Stable)
@NotNull
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 .

getTeamsChannelId

@Stability(Stable)
@NotNull
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 .

getTeamsTenantId

@Stability(Stable)
@NotNull
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 .

getGuardrailPolicies

@Stability(Stable)
@Nullable
default 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.

getLoggingLevel

@Stability(Stable)
@Nullable
default 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 .

getSnsTopicArns

@Stability(Stable)
@Nullable
default List<String> getSnsTopicArns()

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

getUserRoleRequired

@Stability(Stable)
@Nullable
default Object getUserRoleRequired()

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

builder

@Stability(Stable)
static CfnMicrosoftTeamsChannelConfigurationProps.Builder builder()

Returns:

a CfnMicrosoftTeamsChannelConfigurationProps.Builder of CfnMicrosoftTeamsChannelConfigurationProps