This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::DevOpsGuru::NotificationChannel
<a name="aws-resource-devopsguru-notificationchannel"></a>

 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](https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html).

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](https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html).

## Syntax
<a name="aws-resource-devopsguru-notificationchannel-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-devopsguru-notificationchannel-syntax.json"></a>

```
{
  "Type" : "AWS::DevOpsGuru::NotificationChannel",
  "Properties" : {
      "[Config](#cfn-devopsguru-notificationchannel-config)" : NotificationChannelConfig
    }
}
```

### YAML
<a name="aws-resource-devopsguru-notificationchannel-syntax.yaml"></a>

```
Type: AWS::DevOpsGuru::NotificationChannel
Properties:
  [Config](#cfn-devopsguru-notificationchannel-config): 
    NotificationChannelConfig
```

## Properties
<a name="aws-resource-devopsguru-notificationchannel-properties"></a>

`Config`  <a name="cfn-devopsguru-notificationchannel-config"></a>
 A `NotificationChannelConfig` object that contains information about configured notification channels.   
*Required*: Yes  
*Type*: [NotificationChannelConfig](aws-properties-devopsguru-notificationchannel-notificationchannelconfig.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-devopsguru-notificationchannel-return-values"></a>

### Ref
<a name="aws-resource-devopsguru-notificationchannel-return-values-ref"></a>

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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). 

### Fn::GetAtt
<a name="aws-resource-devopsguru-notificationchannel-return-values-fn--getatt"></a>

`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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html). 

#### 
<a name="aws-resource-devopsguru-notificationchannel-return-values-fn--getatt-fn--getatt"></a>

`Id`  <a name="Id-fn::getatt"></a>
The ID of the notification channel. 

## Examples
<a name="aws-resource-devopsguru-notificationchannel--examples"></a>

**Topics**
+ [Create one notification channel with filters](#aws-resource-devopsguru-notificationchannel--examples--Create_one_notification_channel_with_filters)
+ [Create two notification channels](#aws-resource-devopsguru-notificationchannel--examples--Create_two_notification_channels)

### Create one notification channel with filters
<a name="aws-resource-devopsguru-notificationchannel--examples--Create_one_notification_channel_with_filters"></a>

#### JSON
<a name="aws-resource-devopsguru-notificationchannel--examples--Create_one_notification_channel_with_filters--json"></a>

```
{
  "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
<a name="aws-resource-devopsguru-notificationchannel--examples--Create_one_notification_channel_with_filters--yaml"></a>

```
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
<a name="aws-resource-devopsguru-notificationchannel--examples--Create_two_notification_channels"></a>

#### JSON
<a name="aws-resource-devopsguru-notificationchannel--examples--Create_two_notification_channels--json"></a>

```
{
  "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
<a name="aws-resource-devopsguru-notificationchannel--examples--Create_two_notification_channels--yaml"></a>

```
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
```

# AWS::DevOpsGuru::NotificationChannel NotificationChannelConfig
<a name="aws-properties-devopsguru-notificationchannel-notificationchannelconfig"></a>

 Information about notification channels you have configured with DevOps Guru. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).

## Syntax
<a name="aws-properties-devopsguru-notificationchannel-notificationchannelconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-devopsguru-notificationchannel-notificationchannelconfig-syntax.json"></a>

```
{
  "[Filters](#cfn-devopsguru-notificationchannel-notificationchannelconfig-filters)" : NotificationFilterConfig,
  "[Sns](#cfn-devopsguru-notificationchannel-notificationchannelconfig-sns)" : SnsChannelConfig
}
```

### YAML
<a name="aws-properties-devopsguru-notificationchannel-notificationchannelconfig-syntax.yaml"></a>

```
  [Filters](#cfn-devopsguru-notificationchannel-notificationchannelconfig-filters): 
    NotificationFilterConfig
  [Sns](#cfn-devopsguru-notificationchannel-notificationchannelconfig-sns): 
    SnsChannelConfig
```

## Properties
<a name="aws-properties-devopsguru-notificationchannel-notificationchannelconfig-properties"></a>

`Filters`  <a name="cfn-devopsguru-notificationchannel-notificationchannelconfig-filters"></a>
 The filter configurations for the Amazon SNS notification topic you use with DevOps Guru. If you do not provide filter configurations, the default configurations are to receive notifications for all message types of `High` or `Medium` severity.   
*Required*: No  
*Type*: [NotificationFilterConfig](aws-properties-devopsguru-notificationchannel-notificationfilterconfig.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Sns`  <a name="cfn-devopsguru-notificationchannel-notificationchannelconfig-sns"></a>
 Information about a notification channel configured in DevOps Guru to send notifications when insights are created.   
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](https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html).  
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](https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html).  
*Required*: No  
*Type*: [SnsChannelConfig](aws-properties-devopsguru-notificationchannel-snschannelconfig.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::DevOpsGuru::NotificationChannel NotificationFilterConfig
<a name="aws-properties-devopsguru-notificationchannel-notificationfilterconfig"></a>

 The filter configurations for the Amazon SNS notification topic you use with DevOps Guru. You can choose to specify which events or message types to receive notifications for. You can also choose to specify which severity levels to receive notifications for. 

## Syntax
<a name="aws-properties-devopsguru-notificationchannel-notificationfilterconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-devopsguru-notificationchannel-notificationfilterconfig-syntax.json"></a>

```
{
  "[MessageTypes](#cfn-devopsguru-notificationchannel-notificationfilterconfig-messagetypes)" : [ String, ... ],
  "[Severities](#cfn-devopsguru-notificationchannel-notificationfilterconfig-severities)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-devopsguru-notificationchannel-notificationfilterconfig-syntax.yaml"></a>

```
  [MessageTypes](#cfn-devopsguru-notificationchannel-notificationfilterconfig-messagetypes): 
    - String
  [Severities](#cfn-devopsguru-notificationchannel-notificationfilterconfig-severities): 
    - String
```

## Properties
<a name="aws-properties-devopsguru-notificationchannel-notificationfilterconfig-properties"></a>

`MessageTypes`  <a name="cfn-devopsguru-notificationchannel-notificationfilterconfig-messagetypes"></a>
 The events that you want to receive notifications for. For example, you can choose to receive notifications only when the severity level is upgraded or a new insight is created.   
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `5`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Severities`  <a name="cfn-devopsguru-notificationchannel-notificationfilterconfig-severities"></a>
 The severity levels that you want to receive notifications for. For example, you can choose to receive notifications only for insights with `HIGH` and `MEDIUM` severity levels. For more information, see [Understanding insight severities](https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities).   
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `3`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::DevOpsGuru::NotificationChannel SnsChannelConfig
<a name="aws-properties-devopsguru-notificationchannel-snschannelconfig"></a>

 Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic. 

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](https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html).

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](https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html).

## Syntax
<a name="aws-properties-devopsguru-notificationchannel-snschannelconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-devopsguru-notificationchannel-snschannelconfig-syntax.json"></a>

```
{
  "[TopicArn](#cfn-devopsguru-notificationchannel-snschannelconfig-topicarn)" : String
}
```

### YAML
<a name="aws-properties-devopsguru-notificationchannel-snschannelconfig-syntax.yaml"></a>

```
  [TopicArn](#cfn-devopsguru-notificationchannel-snschannelconfig-topicarn): String
```

## Properties
<a name="aws-properties-devopsguru-notificationchannel-snschannelconfig-properties"></a>

`TopicArn`  <a name="cfn-devopsguru-notificationchannel-snschannelconfig-topicarn"></a>
 The Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.   
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws[a-z0-9-]*:sns:[a-z0-9-]+:\d{12}:[^:]+$`  
*Minimum*: `36`  
*Maximum*: `1024`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)