notification_configurations

Creates, updates, deletes or gets a notification_configuration resource or lists notification_configurations in a region

Overview

Name	notification_configurations
Type	Resource
Description	Resource Type definition for AWS::Notifications::NotificationConfiguration
Id	awscc.notifications.notification_configurations

Fields

get (all properties)

Name	Datatype	Description
aggregation_duration	string
arn	string
creation_time	string
description	string
name	string
status	string
▶tags	array	A list of tags that are attached to the role.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

For more information, see AWS::Notifications::NotificationConfiguration.

Methods

Name	Resource	Accessible by	Required Params
create_resource	notification_configurations	INSERT	Description, Name, region
delete_resource	notification_configurations	DELETE	Identifier, region
update_resource	notification_configurations	UPDATE	Identifier, PatchDocument, region
list_resources	notification_configurations_list_only	SELECT	region
get_resource	notification_configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual notification_configuration.

SELECT
  region,
  aggregation_duration,
  arn,
  creation_time,
  description,
  name,
  status,
  tags
FROM awscc.notifications.notification_configurations
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all notification_configurations in a region.

SELECT
  region,
  arn
FROM awscc.notifications.notification_configurations_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.notifications.notification_configurations (
  Description,
  Name,
  region
)
SELECT
  '{{ description }}',
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.notifications.notification_configurations (
  AggregationDuration,
  Description,
  Name,
  Tags,
  region
)
SELECT
  '{{ aggregation_duration }}',
  '{{ description }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: notification_configuration
    props:
      - name: aggregation_duration
        value: '{{ aggregation_duration }}'
      - name: description
        value: '{{ description }}'
      - name: name
        value: '{{ name }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.notifications.notification_configurations
SET PatchDocument = string('{{ {
    "AggregationDuration": aggregation_duration,
    "Description": description,
    "Name": name
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.notifications.notification_configurations
WHERE
  Identifier = '{{ arn }}' AND
  region = 'us-east-1';

Permissions

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

Create

notifications:CreateNotificationConfiguration,
notifications:GetNotificationConfiguration,
notifications:UpdateNotificationConfiguration,
notifications:TagResource,
notifications:UntagResource,
notifications:ListTagsForResource,
iam:CreateServiceLinkedRole

Read

notifications:GetNotificationConfiguration,
notifications:ListTagsForResource,
notifications:TagResource,
notifications:UntagResource

Update

notifications:CreateNotificationConfiguration,
notifications:GetNotificationConfiguration,
notifications:UpdateNotificationConfiguration,
notifications:TagResource,
notifications:UntagResource,
notifications:ListTagsForResource

Delete

notifications:DeleteNotificationConfiguration

List

notifications:ListNotificationConfigurations,
notifications:ListTagsForResource