aws-cdk-lib.aws_supportapp.CfnSlackChannelConfigurationProps

interface CfnSlackChannelConfigurationProps

LanguageType name
.NETAmazon.CDK.AWS.SupportApp.CfnSlackChannelConfigurationProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssupportapp#CfnSlackChannelConfigurationProps
Javasoftware.amazon.awscdk.services.supportapp.CfnSlackChannelConfigurationProps
Pythonaws_cdk.aws_supportapp.CfnSlackChannelConfigurationProps
TypeScript aws-cdk-lib » aws_supportapp » CfnSlackChannelConfigurationProps

Properties for defining a CfnSlackChannelConfiguration.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_supportapp as supportapp } from 'aws-cdk-lib';
const cfnSlackChannelConfigurationProps: supportapp.CfnSlackChannelConfigurationProps = {
  channelId: 'channelId',
  channelRoleArn: 'channelRoleArn',
  notifyOnCaseSeverity: 'notifyOnCaseSeverity',
  teamId: 'teamId',

  // the properties below are optional
  channelName: 'channelName',
  notifyOnAddCorrespondenceToCase: false,
  notifyOnCreateOrReopenCase: false,
  notifyOnResolveCase: false,
};

Properties

NameTypeDescription
channelIdstringThe channel ID in Slack.
channelRoleArnstringThe Amazon Resource Name (ARN) of the IAM role for this Slack channel configuration.
notifyOnCaseSeveritystringThe case severity for your support cases that you want to receive notifications.
teamIdstringThe team ID in Slack.
channelName?stringThe channel name in Slack.
notifyOnAddCorrespondenceToCase?boolean | IResolvableWhether to get notified when a correspondence is added to your support cases.
notifyOnCreateOrReopenCase?boolean | IResolvableWhether to get notified when your support cases are created or reopened.
notifyOnResolveCase?boolean | IResolvableWhether to get notified when your support cases are resolved.

channelId

Type: string

The channel ID in Slack.

This ID identifies a channel within a Slack workspace.


channelRoleArn

Type: string

The Amazon Resource Name (ARN) of the IAM role for this Slack channel configuration.

The AWS Support App uses this role to perform AWS Support and Service Quotas actions on your behalf.


notifyOnCaseSeverity

Type: string

The case severity for your support cases that you want to receive notifications.

You can specify none , all , or high .


teamId

Type: string

The team ID in Slack.

This ID uniquely identifies a Slack workspace.


channelName?

Type: string (optional)

The channel name in Slack.

This is the channel where you invite the AWS Support App .


notifyOnAddCorrespondenceToCase?

Type: boolean | IResolvable (optional)

Whether to get notified when a correspondence is added to your support cases.


notifyOnCreateOrReopenCase?

Type: boolean | IResolvable (optional)

Whether to get notified when your support cases are created or reopened.


notifyOnResolveCase?

Type: boolean | IResolvable (optional)

Whether to get notified when your support cases are resolved.