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

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	notification_channels	INSERT	SnsRoleName, SnsTopicArn, region
delete_resource	notification_channels	DELETE	Identifier, region
update_resource	notification_channels	UPDATE	Identifier, PatchDocument, 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,
  sns_role_name,
  sns_topic_arn
FROM awscc.fms.notification_channels
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ sns_topic_arn }}';

list (identifiers only)

Lists all notification_channels in a region.

SELECT
  region,
  sns_topic_arn
FROM awscc.fms.notification_channels_list_only
WHERE
  region = '{{ region }}';

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.fms.notification_channels (
  SnsRoleName,
  SnsTopicArn,
  region
)
SELECT
  '{{ sns_role_name }}',
  '{{ sns_topic_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.fms.notification_channels (
  SnsRoleName,
  SnsTopicArn,
  region
)
SELECT
  '{{ sns_role_name }}',
  '{{ sns_topic_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: notification_channel
  props:
    - name: sns_role_name
      value: '{{ sns_role_name }}'
    - name: sns_topic_arn
      value: null

UPDATE example

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

/*+ update */
UPDATE awscc.fms.notification_channels
SET PatchDocument = string('{{ {
    "SnsRoleName": sns_role_name,
    "SnsTopicArn": sns_topic_arn
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ sns_topic_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.fms.notification_channels
WHERE
  Identifier = '{{ sns_topic_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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