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	Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.
Id	aws.fms.notification_channels

Fields

Name	Datatype	Description
sns_role_name	string	A resource ARN.
sns_topic_arn	string	A resource ARN.
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	SnsRoleName, SnsTopicArn, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all notification_channels in a region.

SELECT
region,
sns_role_name,
sns_topic_arn
FROM aws.fms.notification_channels
WHERE region = 'us-east-1';

Gets all properties from an individual notification_channel.

SELECT
region,
sns_role_name,
sns_topic_arn
FROM aws.fms.notification_channels
WHERE region = 'us-east-1' AND data__Identifier = '<SnsTopicArn>';

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.fms.notification_channels (
 SnsRoleName,
 SnsTopicArn,
 region
)
SELECT 
'{{ SnsRoleName }}',
 '{{ SnsTopicArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.fms.notification_channels (
 SnsRoleName,
 SnsTopicArn,
 region
)
SELECT 
 '{{ SnsRoleName }}',
 '{{ SnsTopicArn }}',
 '{{ 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: SnsRoleName
        value: '{{ SnsRoleName }}'
      - name: SnsTopicArn
        value: null

DELETE example

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

Permissions

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

Create

fms:PutNotificationChannel,
iam:PassRole

Update

fms:PutNotificationChannel,
iam:PassRole

Read

fms:GetNotificationChannel

Delete

fms:DeleteNotificationChannel

List

fms:GetNotificationChannel