Package software.amazon.awscdk.services.devopsguru

Class CfnNotificationChannel

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.devopsguru.CfnNotificationChannel
All Implemented Interfaces:
IInspectable, INotificationChannelRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:18.248Z") @Stability(Stable) public class CfnNotificationChannel extends CfnResource implements IInspectable, INotificationChannelRef
Adds a notification channel to DevOps Guru.

A notification channel is used to notify you about important DevOps Guru events, such as when an insight is generated.

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to send it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for Amazon SNS topics .

If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for AWS KMS–encrypted Amazon SNS topics .

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.devopsguru.*;
 CfnNotificationChannel cfnNotificationChannel = CfnNotificationChannel.Builder.create(this, "MyCfnNotificationChannel")
         .config(NotificationChannelConfigProperty.builder()
                 .filters(NotificationFilterConfigProperty.builder()
                         .messageTypes(List.of("messageTypes"))
                         .severities(List.of("severities"))
                         .build())
                 .sns(SnsChannelConfigProperty.builder()
                         .topicArn("topicArn")
                         .build())
                 .build())
         .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

    • CfnNotificationChannel

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

    • CfnNotificationChannel

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

    • CfnNotificationChannel

      @Stability(Stable) public CfnNotificationChannel(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnNotificationChannelProps props)
      Create a new AWS::DevOpsGuru::NotificationChannel.

      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

    • isCfnNotificationChannel

      @Stability(Stable) @NotNull public static Boolean isCfnNotificationChannel(@NotNull Object x)
      Checks whether the given object is a CfnNotificationChannel.

      Parameters:
      x - This parameter is required.

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

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the notification channel.

    • getCfnProperties

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

    • getNotificationChannelRef

      @Stability(Stable) @NotNull public NotificationChannelReference getNotificationChannelRef()
      A reference to a NotificationChannel resource.
      Specified by:
      getNotificationChannelRef in interface INotificationChannelRef

    • getConfig

      @Stability(Stable) @NotNull public Object getConfig()
      A NotificationChannelConfig object that contains information about configured notification channels.

      Returns union: either IResolvable or CfnNotificationChannel.NotificationChannelConfigProperty

    • setConfig

      @Stability(Stable) public void setConfig(@NotNull IResolvable value)
      A NotificationChannelConfig object that contains information about configured notification channels.

    • setConfig

      @Stability(Stable) public void setConfig(@NotNull CfnNotificationChannel.NotificationChannelConfigProperty value)
      A NotificationChannelConfig object that contains information about configured notification channels.