Package software.amazon.awscdk.services.supportapp

Class CfnSlackChannelConfiguration

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.supportapp.CfnSlackChannelConfiguration
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-09-19T18:12:08.906Z") @Stability(Stable) public class CfnSlackChannelConfiguration extends CfnResource implements IInspectable
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();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnSlackChannelConfigurationProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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.

    • setChannelId

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

    • getChannelRoleArn

      @Stability(Stable) @NotNull public String getChannelRoleArn()
      The Amazon Resource Name (ARN) of the IAM role for this Slack channel configuration.

    • setChannelRoleArn

      @Stability(Stable) public void setChannelRoleArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the IAM role for this Slack channel configuration.

    • getNotifyOnCaseSeverity

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

    • setNotifyOnCaseSeverity

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

    • getTeamId

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

    • setTeamId

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

    • getChannelName

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

    • setChannelName

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

    • 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.