Skip to content
v2.278.0

CfnSlackChannelConfigurationProps Struct ​

Properties for defining a CfnSlackChannelConfiguration.

Example ​

ts
// 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,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_supportapp as supportapp

cfn_slack_channel_configuration_props = supportapp.CfnSlackChannelConfigurationProps(
    channel_id="channelId",
    channel_role_arn="channelRoleArn",
    notify_on_case_severity="notifyOnCaseSeverity",
    team_id="teamId",

    # the properties below are optional
    channel_name="channelName",
    notify_on_add_correspondence_to_case=False,
    notify_on_create_or_reopen_case=False,
    notify_on_resolve_case=False
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.supportapp.*;

CfnSlackChannelConfigurationProps cfnSlackChannelConfigurationProps = CfnSlackChannelConfigurationProps.builder()
        .channelId("channelId")
        .channelRoleArn("channelRoleArn")
        .notifyOnCaseSeverity("notifyOnCaseSeverity")
        .teamId("teamId")

        // the properties below are optional
        .channelName("channelName")
        .notifyOnAddCorrespondenceToCase(false)
        .notifyOnCreateOrReopenCase(false)
        .notifyOnResolveCase(false)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SupportApp;

var cfnSlackChannelConfigurationProps = new CfnSlackChannelConfigurationProps {
    ChannelId = "channelId",
    ChannelRoleArn = "channelRoleArn",
    NotifyOnCaseSeverity = "notifyOnCaseSeverity",
    TeamId = "teamId",

    // the properties below are optional
    ChannelName = "channelName",
    NotifyOnAddCorrespondenceToCase = false,
    NotifyOnCreateOrReopenCase = false,
    NotifyOnResolveCase = false
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnSlackChannelConfigurationProps := &CfnSlackChannelConfigurationProps{
	ChannelId: jsii.String("channelId"),
	ChannelRoleArn: jsii.String("channelRoleArn"),
	NotifyOnCaseSeverity: jsii.String("notifyOnCaseSeverity"),
	TeamId: jsii.String("teamId"),

	// the properties below are optional
	ChannelName: jsii.String("channelName"),
	NotifyOnAddCorrespondenceToCase: jsii.Boolean(false),
	NotifyOnCreateOrReopenCase: jsii.Boolean(false),
	NotifyOnResolveCase: jsii.Boolean(false),
}

Properties ​

channelIdstringchannel_idstrchannelIdStringChannelIdstringChannelId*string required #
The channel ID in Slack.

This ID identifies a channel within a Slack workspace.

channelNameoptionalstringchannel_nameoptionalstrchannelNameoptionalStringChannelNameoptionalstringChannelNameoptional*string #
The channel name in Slack.

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

channelRoleArnstring | IRoleRefchannel_role_arntyping.Union[str, IRoleRef]channelRoleArnStringChannelRoleArnstringChannelRoleArninterface{} required #
The Amazon Resource Name (ARN) of the IAM role for this Slack channel configuration.

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

notifyOnAddCorrespondenceToCaseoptionalboolean | IResolvablenotify_on_add_correspondence_to_caseoptionaltyping.Union[bool, IResolvable]notifyOnAddCorrespondenceToCaseoptionalBooleanNotifyOnAddCorrespondenceToCaseoptionalboolNotifyOnAddCorrespondenceToCaseoptionalinterface{} #
Whether to get notified when a correspondence is added to your support cases.
notifyOnCaseSeveritystringnotify_on_case_severitystrnotifyOnCaseSeverityStringNotifyOnCaseSeveritystringNotifyOnCaseSeverity*string required #
The case severity for your support cases that you want to receive notifications.

You can specify none , all , or high .

notifyOnCreateOrReopenCaseoptionalboolean | IResolvablenotify_on_create_or_reopen_caseoptionaltyping.Union[bool, IResolvable]notifyOnCreateOrReopenCaseoptionalBooleanNotifyOnCreateOrReopenCaseoptionalboolNotifyOnCreateOrReopenCaseoptionalinterface{} #
Whether to get notified when your support cases are created or reopened.
notifyOnResolveCaseoptionalboolean | IResolvablenotify_on_resolve_caseoptionaltyping.Union[bool, IResolvable]notifyOnResolveCaseoptionalBooleanNotifyOnResolveCaseoptionalboolNotifyOnResolveCaseoptionalinterface{} #
Whether to get notified when your support cases are resolved.
teamIdstringteam_idstrteamIdStringTeamIdstringTeamId*string required #
The team ID in Slack.

This ID uniquely identifies a Slack workspace.