autoscaling_put_notification_configuration: Configures an Auto Scaling group to send notifications when...

Description Usage Arguments Value Request syntax Examples

View source: R/autoscaling_operations.R

Description

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 Getting Amazon SNS notifications when your Auto Scaling group scales 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.

Usage

1
2
autoscaling_put_notification_configuration(AutoScalingGroupName,
  TopicARN, NotificationTypes)

Arguments

AutoScalingGroupName

[required] The name of the Auto Scaling group.

TopicARN

[required] The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.

NotificationTypes

[required] The type of event that causes the notification to be sent. To query the notification types supported by Amazon EC2 Auto Scaling, call the describe_auto_scaling_notification_types API.

Value

An empty list.

Request syntax

1
2
3
4
5
6
7
svc$put_notification_configuration(
  AutoScalingGroupName = "string",
  TopicARN = "string",
  NotificationTypes = list(
    "string"
  )
)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
## Not run: 
# This example adds the specified notification to the specified Auto
# Scaling group.
svc$put_notification_configuration(
  AutoScalingGroupName = "my-auto-scaling-group",
  NotificationTypes = list(
    "autoscaling:TEST_NOTIFICATION"
  ),
  TopicARN = "arn:aws:sns:us-west-2:123456789012:my-sns-topic"
)

## End(Not run)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.