notification_channels

Creates, updates, deletes or gets a notification_channel resource or lists notification_channels in a region

Overview

Name	notification_channels
Type	Resource
Description	This resource schema represents the NotificationChannel resource in the Amazon DevOps Guru.
Id	aws.devopsguru.notification_channels

Fields

Name	Datatype	Description
config	object	Information about notification channels you have configured with DevOps Guru.
id	string	The ID of a notification channel.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Config, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all notification_channels in a region.

SELECT
region,
config,
id
FROM aws.devopsguru.notification_channels
WHERE region = 'us-east-1';

Gets all properties from an individual notification_channel.

SELECT
region,
config,
id
FROM aws.devopsguru.notification_channels
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

Use the following StackQL query and manifest file to create a new notification_channel resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.devopsguru.notification_channels (
 Config,
 region
)
SELECT 
'{{ Config }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.devopsguru.notification_channels (
 Config,
 region
)
SELECT 
 '{{ Config }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: notification_channel
    props:
      - name: Config
        value:
          Sns:
            TopicArn: '{{ TopicArn }}'
          Filters:
            Severities:
              - '{{ Severities[0] }}'
            MessageTypes:
              - '{{ MessageTypes[0] }}'

DELETE example

/*+ delete */
DELETE FROM aws.devopsguru.notification_channels
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

To operate on the notification_channels resource, the following permissions are required:

Create

devops-guru:AddNotificationChannel,
devops-guru:ListNotificationChannels,
sns:Publish,
sns:GetTopicAttributes,
sns:SetTopicAttributes

List

devops-guru:ListNotificationChannels

Delete

devops-guru:RemoveNotificationChannel,
devops-guru:ListNotificationChannels

Read

devops-guru:ListNotificationChannels