CfnSlackChannelConfigurationProps
- class aws_cdk.aws_supportapp.CfnSlackChannelConfigurationProps(*, channel_id, channel_role_arn, notify_on_case_severity, team_id, channel_name=None, notify_on_add_correspondence_to_case=None, notify_on_create_or_reopen_case=None, notify_on_resolve_case=None)
Bases:
object
Properties for defining a
CfnSlackChannelConfiguration
.- Parameters:
channel_id (
str
) – The channel ID in Slack. This ID identifies a channel within a Slack workspace.channel_role_arn (
str
) – 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.notify_on_case_severity (
str
) – The case severity for your support cases that you want to receive notifications. You can specifynone
,all
, orhigh
.team_id (
str
) – The team ID in Slack. This ID uniquely identifies a Slack workspace.channel_name (
Optional
[str
]) – The channel name in Slack. This is the channel where you invite the AWS Support App .notify_on_add_correspondence_to_case (
Union
[bool
,IResolvable
,None
]) – Whether to get notified when a correspondence is added to your support cases.notify_on_create_or_reopen_case (
Union
[bool
,IResolvable
,None
]) – Whether to get notified when your support cases are created or reopened.notify_on_resolve_case (
Union
[bool
,IResolvable
,None
]) – Whether to get notified when your support cases are resolved.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.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 )
Attributes
- channel_id
The channel ID in Slack.
This ID identifies a channel within a Slack workspace.
- channel_name
The channel name in Slack.
This is the channel where you invite the AWS Support App .
- channel_role_arn
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.
- notify_on_add_correspondence_to_case
Whether to get notified when a correspondence is added to your support cases.
- notify_on_case_severity
The case severity for your support cases that you want to receive notifications.
You can specify
none
,all
, orhigh
.
- notify_on_create_or_reopen_case
Whether to get notified when your support cases are created or reopened.
- notify_on_resolve_case
Whether to get notified when your support cases are resolved.
- team_id
The team ID in Slack.
This ID uniquely identifies a Slack workspace.