notification_channels

Creates, updates, deletes, gets or lists a notification_channels resource.

Overview

Name	notification_channels
Type	Resource
Id	aws.fms.notification_channels

Fields

The following fields are returned by SELECT queries:

get_notification_channel

Name	Datatype	Description
sns_role_name	string	The IAM role that is used by Firewall Manager to record activity to SNS. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$</code>)
sns_topic_arn	string	The SNS topic that records Firewall Manager activity. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_notification_channel	select	region		Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.
put_notification_channel	replace	region, SnsTopicArn, SnsRoleName		Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs. To perform this action outside of the console, you must first configure the SNS topic's access policy to allow the SnsRoleName to publish SNS logs. If the SnsRoleName provided is a role other than the AWSServiceRoleForFMS service-linked role, this role must have a trust relationship configured to allow the Firewall Manager service principal fms.amazonaws.com to assume this role. For information about configuring an SNS access policy, see Service roles for Firewall Manager in the Firewall Manager Developer Guide.
delete_notification_channel	delete	region		Deletes an Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_notification_channel

Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.

SELECT
sns_role_name,
sns_topic_arn
FROM aws.fms.notification_channels
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_notification_channel

Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs. To perform this action outside of the console, you must first configure the SNS topic's access policy to allow the SnsRoleName to publish SNS logs. If the SnsRoleName provided is a role other than the AWSServiceRoleForFMS service-linked role, this role must have a trust relationship configured to allow the Firewall Manager service principal fms.amazonaws.com to assume this role. For information about configuring an SNS access policy, see Service roles for Firewall Manager in the Firewall Manager Developer Guide.

REPLACE aws.fms.notification_channels
SET 
SnsTopicArn = '{{ SnsTopicArn }}',
SnsRoleName = '{{ SnsRoleName }}'
WHERE 
region = '{{ region }}' --required
AND SnsTopicArn = '{{ SnsTopicArn }}' --required
AND SnsRoleName = '{{ SnsRoleName }}' --required;

DELETE examples

delete_notification_channel

Deletes an Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.

DELETE FROM aws.fms.notification_channels
WHERE region = '{{ region }}' --required
;