Package software.amazon.awscdk.services.supportapp

Class CfnSlackChannelConfiguration

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.supportapp.CfnSlackChannelConfiguration
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.865Z") @Stability(Stable) public class CfnSlackChannelConfiguration extends CfnResource implements IInspectable
A CloudFormation AWS::SupportApp::SlackChannelConfiguration.

You can use the AWS::SupportApp::SlackChannelConfiguration resource to specify your AWS account when you configure the AWS Support App . This resource includes the following information:

  • The Slack channel name and ID
  • The team ID in Slack
  • The Amazon Resource Name (ARN) of the AWS Identity and Access Management ( IAM ) role
  • Whether you want the AWS Support App to notify you when your support cases are created, updated, resolved, or reopened
  • The case severity that you want to get notified for

For more information, see the following topics in the AWS Support User Guide :

Example: 

 // 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.*;
 CfnSlackChannelConfiguration cfnSlackChannelConfiguration = CfnSlackChannelConfiguration.Builder.create(this, "MyCfnSlackChannelConfiguration")
         .channelId("channelId")
         .channelRoleArn("channelRoleArn")
         .notifyOnCaseSeverity("notifyOnCaseSeverity")
         .teamId("teamId")
         // the properties below are optional
         .channelName("channelName")
         .notifyOnAddCorrespondenceToCase(false)
         .notifyOnCreateOrReopenCase(false)
         .notifyOnResolveCase(false)
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSlackChannelConfiguration

      protected CfnSlackChannelConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSlackChannelConfiguration

      protected CfnSlackChannelConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSlackChannelConfiguration

      @Stability(Stable) public CfnSlackChannelConfiguration(@NotNull Construct scope, @NotNull String id, @NotNull CfnSlackChannelConfigurationProps props)
      Create a new AWS::SupportApp::SlackChannelConfiguration.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getChannelId

      @Stability(Stable) @NotNull public String getChannelId()
      The channel ID in Slack.

      This ID identifies a channel within a Slack workspace.

    • setChannelId

      @Stability(Stable) public void setChannelId(@NotNull String value)
      The channel ID in Slack.

      This ID identifies a channel within a Slack workspace.

    • getChannelRoleArn

      @Stability(Stable) @NotNull public String getChannelRoleArn()
      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.

    • setChannelRoleArn

      @Stability(Stable) public void setChannelRoleArn(@NotNull String value)
      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.

    • getNotifyOnCaseSeverity

      @Stability(Stable) @NotNull public String getNotifyOnCaseSeverity()
      The case severity for your support cases that you want to receive notifications.

      You can specify none , all , or high .

    • setNotifyOnCaseSeverity

      @Stability(Stable) public void setNotifyOnCaseSeverity(@NotNull String value)
      The case severity for your support cases that you want to receive notifications.

      You can specify none , all , or high .

    • getTeamId

      @Stability(Stable) @NotNull public String getTeamId()
      The team ID in Slack.

      This ID uniquely identifies a Slack workspace.

    • setTeamId

      @Stability(Stable) public void setTeamId(@NotNull String value)
      The team ID in Slack.

      This ID uniquely identifies a Slack workspace.

    • getChannelName

      @Stability(Stable) @Nullable public String getChannelName()
      The channel name in Slack.

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

    • setChannelName

      @Stability(Stable) public void setChannelName(@Nullable String value)
      The channel name in Slack.

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

    • getNotifyOnAddCorrespondenceToCase

      @Stability(Stable) @Nullable public Object getNotifyOnAddCorrespondenceToCase()
      Whether to get notified when a correspondence is added to your support cases.

    • setNotifyOnAddCorrespondenceToCase

      @Stability(Stable) public void setNotifyOnAddCorrespondenceToCase(@Nullable Boolean value)
      Whether to get notified when a correspondence is added to your support cases.

    • setNotifyOnAddCorrespondenceToCase

      @Stability(Stable) public void setNotifyOnAddCorrespondenceToCase(@Nullable IResolvable value)
      Whether to get notified when a correspondence is added to your support cases.

    • getNotifyOnCreateOrReopenCase

      @Stability(Stable) @Nullable public Object getNotifyOnCreateOrReopenCase()
      Whether to get notified when your support cases are created or reopened.

    • setNotifyOnCreateOrReopenCase

      @Stability(Stable) public void setNotifyOnCreateOrReopenCase(@Nullable Boolean value)
      Whether to get notified when your support cases are created or reopened.

    • setNotifyOnCreateOrReopenCase

      @Stability(Stable) public void setNotifyOnCreateOrReopenCase(@Nullable IResolvable value)
      Whether to get notified when your support cases are created or reopened.

    • getNotifyOnResolveCase

      @Stability(Stable) @Nullable public Object getNotifyOnResolveCase()
      Whether to get notified when your support cases are resolved.

    • setNotifyOnResolveCase

      @Stability(Stable) public void setNotifyOnResolveCase(@Nullable Boolean value)
      Whether to get notified when your support cases are resolved.

    • setNotifyOnResolveCase

      @Stability(Stable) public void setNotifyOnResolveCase(@Nullable IResolvable value)
      Whether to get notified when your support cases are resolved.