interface CfnSlackChannelConfigurationProps

Language	Type name
.NET	`Amazon.CDK.AWS.Chatbot.CfnSlackChannelConfigurationProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awschatbot#CfnSlackChannelConfigurationProps`
Java	`software.amazon.awscdk.services.chatbot.CfnSlackChannelConfigurationProps`
Python	`aws_cdk.aws_chatbot.CfnSlackChannelConfigurationProps`
TypeScript	`aws-cdk-lib` » `aws_chatbot` » `CfnSlackChannelConfigurationProps`

Properties for defining a CfnSlackChannelConfiguration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_chatbot as chatbot } from 'aws-cdk-lib';
const cfnSlackChannelConfigurationProps: chatbot.CfnSlackChannelConfigurationProps = {
  configurationName: 'configurationName',
  iamRoleArn: 'iamRoleArn',
  slackChannelId: 'slackChannelId',
  slackWorkspaceId: 'slackWorkspaceId',

  // the properties below are optional
  guardrailPolicies: ['guardrailPolicies'],
  loggingLevel: 'loggingLevel',
  snsTopicArns: ['snsTopicArns'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  userRoleRequired: false,
};

Properties

Name	Type	Description
configurationName	`string`	The name of the configuration.
iamRoleArn	`string`	The ARN of the IAM role that defines the permissions for AWS Chatbot .
slackChannelId	`string`	The ID of the Slack channel.
slackWorkspaceId	`string`	The ID of the Slack workspace authorized with AWS Chatbot .
guardrailPolicies?	`string[]`	The list of IAM policy ARNs that are applied as channel guardrails.
loggingLevel?	`string`	Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.
snsTopicArns?	`string[]`	The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
tags?	`CfnTag[]`	The tags to add to the configuration.
userRoleRequired?	`boolean \|` `IResolvable`	Enables use of a user role requirement in your chat configuration.

configurationName

Type: string

The name of the configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-configurationname

iamRoleArn

Type: string

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-iamrolearn

slackChannelId

Type: string

The ID of the Slack channel.

To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the character string at the end of the URL. For example, ABCBBLZZZ .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-slackchannelid

slackWorkspaceId

Type: string

The ID of the Slack workspace authorized with AWS Chatbot .

To get the workspace ID, you must perform the initial authorization flow with Slack in the AWS Chatbot console. Then you can copy and paste the workspace ID from the console. For more details, see steps 1-3 in Tutorial: Get started with Slack in the AWS Chatbot User Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-slackworkspaceid