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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.910Z")
 @Stability(value=Stable)
public class CfnNotificationChannel
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DevOpsGuru::NotificationChannel`.

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 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 cross account Amazon SNS topics .

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account 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()
                 .sns(SnsChannelConfigProperty.builder()
                         .topicArn("topicArn")
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnNotificationChannel.Builder A fluent builder for CfnNotificationChannel.
static interface	CfnNotificationChannel.NotificationChannelConfigProperty Information about notification channels you have configured with DevOps Guru.
static interface	CfnNotificationChannel.SnsChannelConfigProperty Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnNotificationChannel(software.constructs.Construct scope, String id, CfnNotificationChannelProps props) Create a new `AWS::DevOpsGuru::NotificationChannel`.
protected	CfnNotificationChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnNotificationChannel(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrId() The ID of the notification channel.
protected Map<String,Object>	getCfnProperties()
Object	getConfig() A `NotificationChannelConfig` object that contains information about configured notification channels.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setConfig(CfnNotificationChannel.NotificationChannelConfigProperty value) A `NotificationChannelConfig` object that contains information about configured notification channels.
void	setConfig(IResolvable value) A `NotificationChannelConfig` object that contains information about configured notification channels.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnNotificationChannel

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

CfnNotificationChannel

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

CfnNotificationChannel

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrId()

The ID of the notification channel.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConfig

@Stability(value=Stable)
 @NotNull
public Object getConfig()

A `NotificationChannelConfig` object that contains information about configured notification channels.

setConfig

@Stability(value=Stable)
public void setConfig(@NotNull
                                               CfnNotificationChannel.NotificationChannelConfigProperty value)

A `NotificationChannelConfig` object that contains information about configured notification channels.

setConfig

@Stability(value=Stable)
public void setConfig(@NotNull
                                               IResolvable value)

A `NotificationChannelConfig` object that contains information about configured notification channels.