notification_configurations

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

Overview

Name	notification_configurations
Type	Resource
Id	aws.autoscaling.notification_configurations

Fields

The following fields are returned by SELECT queries:

describe_notification_configurations

Name	Datatype	Description
auto_scaling_group_name	string	The name of the Auto Scaling group.
notification_type	string	One of the following event notification types: autoscaling:EC2_INSTANCE_LAUNCH autoscaling:EC2_INSTANCE_LAUNCH_ERROR autoscaling:EC2_INSTANCE_TERMINATE autoscaling:EC2_INSTANCE_TERMINATE_ERROR autoscaling:TEST_NOTIFICATION
topic_arn	string	The Amazon Resource Name (ARN) of the Amazon SNS topic.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_notification_configurations	select	region	AutoScalingGroupNames, NextToken, MaxRecords	Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
put_notification_configuration	replace	AutoScalingGroupName, TopicARN, NotificationTypes, region		Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address. This configuration overwrites any existing configuration. For more information, see Amazon SNS notification options for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call fails.
delete_notification_configuration	delete	AutoScalingGroupName, TopicARN, region		Deletes the specified notification.

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
AutoScalingGroupName	string	The name of the Auto Scaling group.
NotificationTypes	array	The type of event that causes the notification to be sent. To query the notification types supported by Amazon EC2 Auto Scaling, call the DescribeAutoScalingNotificationTypes API.
TopicARN	string	The Amazon Resource Name (ARN) of the Amazon SNS topic.
region	string	AWS region (default: us-east-1)
AutoScalingGroupNames	array	The name of the Auto Scaling group.
MaxRecords	integer	The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
NextToken	string	The token for the next set of items to return. (You received this token from a previous call.)

SELECT examples

describe_notification_configurations

Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.

SELECT
auto_scaling_group_name,
notification_type,
topic_arn
FROM aws.autoscaling.notification_configurations
WHERE region = '{{ region }}' -- required
AND AutoScalingGroupNames = '{{ AutoScalingGroupNames }}'
AND NextToken = '{{ NextToken }}'
AND MaxRecords = '{{ MaxRecords }}'
;

REPLACE examples

put_notification_configuration

Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address. This configuration overwrites any existing configuration. For more information, see Amazon SNS notification options for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call fails.

REPLACE aws.autoscaling.notification_configurations
SET 
-- No updatable properties
WHERE 
AutoScalingGroupName = '{{ AutoScalingGroupName }}' --required
AND TopicARN = '{{ TopicARN }}' --required
AND NotificationTypes = '{{ NotificationTypes }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_notification_configuration

Deletes the specified notification.

DELETE FROM aws.autoscaling.notification_configurations
WHERE AutoScalingGroupName = '{{ AutoScalingGroupName }}' --required
AND TopicARN = '{{ TopicARN }}' --required
AND region = '{{ region }}' --required
;