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 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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::DevOpsGuru::NotificationChannel", "Properties" : { "Config" :
NotificationChannelConfig
} }
YAML
Type: AWS::DevOpsGuru::NotificationChannel Properties: Config:
NotificationChannelConfig
Properties
Config
-
A
NotificationChannelConfig
object that contains information about configured notification channels.Required: Yes
Type: NotificationChannelConfig
Update requires: Replacement
Return values
Ref
When the logical ID of this resource is provided to the Ref
intrinsic function,
Ref
returns Amazon Resource Name (ARN) of the NotificationChannel
.
For more information about using the Ref
function, see
Ref.
Fn::GetAtt
Fn::GetAtt
returns a value for a specified attribute of this type. The following are the available
attributes and sample return values. For more information about using Fn::GetAtt
, see
Fn::GetAtt.
Id
-
The ID of the notification channel.
Examples
Create one notification channel with filters
JSON
{ "Resources": { "MyNotificationChannel": { "Type": "AWS::DevOpsGuru::NotificationChannel", "Properties": { "Config": { "Filters": { "MessageTypes": ["NEW_INSIGHT", "CLOSED_INSIGHT", "SEVERITY_UPGRADED"], "Severities": ["MEDIUM", "HIGH"] } "Sns": { "TopicArn": "arn:aws:sns:us-east-1:123456789012:DefaultNotificationChannel" } } } } } }
YAML
Resources: MyNotificationChannel: Type: AWS::DevOpsGuru::NotificationChannel Properties: Config: Filters: MessageTypes: - NEW_INSIGHT - CLOSED_INSIGHT - SEVERITY_UPGRADED Severities: - MEDIUM - HIGH Sns: TopicArn: arn:aws:sns:us-east-1:123456789012:DefaultNotificationChannel
Create two notification channels
JSON
{ "Resources": { "MyNotificationChannel1": { "Type": "AWS::DevOpsGuru::NotificationChannel", "Properties": { "Config": { "Sns": { "TopicArn": "arn:aws:sns:us-east-1:123456789012:DefaultNotificationChannel" } } } }, "MyNotificationChannel2": { "Type": "AWS::DevOpsGuru::NotificationChannel", "Properties": { "Config": { "Sns": { "TopicArn": "arn:aws:sns:us-east-1:123456789012:DefaultNotificationChannel2" } } } } } }
YAML
Resources: MyNotificationChannel1: Type: AWS::DevOpsGuru::NotificationChannel Properties: Config: Sns: TopicArn: arn:aws:sns:us-east-1:123456789012:DefaultNotificationChannel MyNotificationChannel2: Type: AWS::DevOpsGuru::NotificationChannel Properties: Config: Sns: TopicArn: arn:aws:sns:us-east-1:123456789012:DefaultNotificationChannel2