@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)", date="2022-06-22T23:27:50.024Z") public class CfnNotificationChannel extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnNotificationChannel(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrId()
The ID of the notification channel.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getConfig()
A `NotificationChannelConfig` object that contains information about configured notification channels.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnNotificationChannel(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnNotificationChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnNotificationChannel(Construct scope, java.lang.String id, CfnNotificationChannelProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrId()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.Object getConfig()
public void setConfig(CfnNotificationChannel.NotificationChannelConfigProperty value)
public void setConfig(IResolvable value)