API.md

API Reference

Classes

Name	Description
MSTeamsIncomingWebhookConfiguration	No description
SlackChannelConfiguration	No description

Structs

Name	Description
MSTeamsIncomingWebhookConfigurationProps	No description
SlackChannelConfigurationProps	No description

Interfaces

Name	Description
ISlackChannelConfiguration	No description

Enums

Name	Description
AccountLabelMode	No description
LoggingLevel	No description

class MSTeamsIncomingWebhookConfiguration

Implements: IConstruct, IConstruct, IConstruct, IDependable Extends: Construct

Initializer

new MSTeamsIncomingWebhookConfiguration(scope: Construct, id: string, props: MSTeamsIncomingWebhookConfigurationProps)

• scope (Construct) No description
• id (string) No description
• props (MSTeamsIncomingWebhookConfigurationProps) No description
  • url (string) The url of the incoming webhook for a channel.
  • accountLabelMode (AccountLabelMode) No description Default: ACCOUNT_LABEL_MODE.ID_AND_ALIAS
  • notificationTopics (Array<ITopic>) The SNS topics that deliver notifications to MS Teams. Optional
  • themeColor (string) Specifies a custom brand color for the card. Default: #CEDB56

Properties

Name	Type	Description
incomingWebhook	IFunction

Methods

addEventSource(snsEventSource)

addEventSource(snsEventSource: SnsEventSource): void

• snsEventSource (SnsEventSource) No description

class SlackChannelConfiguration

Implements: IConstruct, IConstruct, IConstruct, IDependable Extends: Construct

Initializer

new SlackChannelConfiguration(scope: Construct, id: string, props: SlackChannelConfigurationProps)

• scope (Construct) No description
• id (string) No description
• props (SlackChannelConfigurationProps) No description
  • configurationName (string) The name of the configuration.
  • slackChannelId (string) The ID of the Slack channel.
  • slackWorkspaceId (string) The ID of the Slack workspace authorized with AWS Chatbot.
  • loggingLevel (LoggingLevel) Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs. Default: NONE
  • notificationTopics (Array<ITopic>) The SNS topics that deliver notifications to AWS Chatbot. Optional
  • role (IRole) The iam role that defines the permissions for AWS Chatbot. Optional

Properties

Name	Type	Description
configurationArn	string
role	IRole

Methods

addLambdaInvokeCommandPermissions(lambda?)

Allows Lambda-invoke commands in supported clients.

addLambdaInvokeCommandPermissions(lambda?: IFunction): void

• lambda (IFunction) No description

addNotificationPermissions()

Allows AWS Chatbot to retreive metric graphs from Amazon Cloudwatch.

addNotificationPermissions(): void

addReadOnlyCommandPermissions()

addReadOnlyCommandPermissions(): void

addSupportCommandPermissions()

Allows calling AWS Support APIs in supportzed clients.

addSupportCommandPermissions(): void

addToRolePolicy(statement)

Adds a statement to the IAM role assumed by the instance.

addToRolePolicy(statement: PolicyStatement): void

• statement (PolicyStatement) No description

interface ISlackChannelConfiguration

Properties

Name	Type	Description
configurationArn	string

struct MSTeamsIncomingWebhookConfigurationProps

Name	Type	Description
url	string	The url of the incoming webhook for a channel.
accountLabelMode?	AccountLabelMode	Default: ACCOUNT_LABEL_MODE.ID_AND_ALIAS
notificationTopics?	Array<ITopic>	The SNS topics that deliver notifications to MS Teams. Optional
themeColor?	string	Specifies a custom brand color for the card. Default: #CEDB56

struct SlackChannelConfigurationProps

Name	Type	Description
configurationName	string	The name of the configuration.
slackChannelId	string	The ID of the Slack channel.
slackWorkspaceId	string	The ID of the Slack workspace authorized with AWS Chatbot.
loggingLevel?	LoggingLevel	Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs. Default: NONE
notificationTopics?	Array<ITopic>	The SNS topics that deliver notifications to AWS Chatbot. Optional
role?	IRole	The iam role that defines the permissions for AWS Chatbot. Optional

enum AccountLabelMode

Name	Description
ID
ALIAS
ID_AND_ALIAS

enum LoggingLevel

Name	Description
ERROR
INFO
NONE