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	awscc.devopsguru.notification_channels

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
id	string	The ID of a notification channel.
region	string	AWS region.

For more information, see AWS::DevOpsGuru::NotificationChannel.

Methods

Name	Resource	Accessible by	Required Params
create_resource	notification_channels	INSERT	Config, region
delete_resource	notification_channels	DELETE	Identifier, region
list_resources	notification_channels_list_only	SELECT	region
get_resource	notification_channels	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual notification_channel.

SELECT
  region,
  config,
  id
FROM awscc.devopsguru.notification_channels
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all notification_channels in a region.

SELECT
  region,
  id
FROM awscc.devopsguru.notification_channels_list_only
WHERE
  region = 'us-east-1';

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 awscc.devopsguru.notification_channels (
  Config,
  region
)
SELECT
  '{{ config }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.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:
            topic_arn: '{{ topic_arn }}'
          filters:
            severities:
              - '{{ severities[0] }}'
            message_types:
              - '{{ message_types[0] }}'

DELETE example

/*+ delete */
DELETE FROM awscc.devopsguru.notification_channels
WHERE
  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