AWS Classic v5.41.0, May 15 23

aws.autoscaling.Notification

Explore with Pulumi AI

Provides an AutoScaling Group with Notification support, via SNS Topics. Each of the notifications map to a Notification Configuration inside Amazon Web Services, and are applied to each AutoScaling Group you supply.

Example Usage

Basic usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Sns.Topic("example");

    // arn is an exported attribute
    var bar = new Aws.AutoScaling.Group("bar");

    // ...
    var foo = new Aws.AutoScaling.Group("foo");

    // ...
    var exampleNotifications = new Aws.AutoScaling.Notification("exampleNotifications", new()
    {
        GroupNames = new[]
        {
            bar.Name,
            foo.Name,
        },
        Notifications = new[]
        {
            "autoscaling:EC2_INSTANCE_LAUNCH",
            "autoscaling:EC2_INSTANCE_TERMINATE",
            "autoscaling:EC2_INSTANCE_LAUNCH_ERROR",
            "autoscaling:EC2_INSTANCE_TERMINATE_ERROR",
        },
        TopicArn = example.Arn,
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/autoscaling"
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/sns"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := sns.NewTopic(ctx, "example", nil)
		if err != nil {
			return err
		}
		bar, err := autoscaling.NewGroup(ctx, "bar", nil)
		if err != nil {
			return err
		}
		foo, err := autoscaling.NewGroup(ctx, "foo", nil)
		if err != nil {
			return err
		}
		_, err = autoscaling.NewNotification(ctx, "exampleNotifications", &autoscaling.NotificationArgs{
			GroupNames: pulumi.StringArray{
				bar.Name,
				foo.Name,
			},
			Notifications: pulumi.StringArray{
				pulumi.String("autoscaling:EC2_INSTANCE_LAUNCH"),
				pulumi.String("autoscaling:EC2_INSTANCE_TERMINATE"),
				pulumi.String("autoscaling:EC2_INSTANCE_LAUNCH_ERROR"),
				pulumi.String("autoscaling:EC2_INSTANCE_TERMINATE_ERROR"),
			},
			TopicArn: example.Arn,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sns.Topic;
import com.pulumi.aws.autoscaling.Group;
import com.pulumi.aws.autoscaling.Notification;
import com.pulumi.aws.autoscaling.NotificationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Topic("example");

        var bar = new Group("bar");

        var foo = new Group("foo");

        var exampleNotifications = new Notification("exampleNotifications", NotificationArgs.builder()        
            .groupNames(            
                bar.name(),
                foo.name())
            .notifications(            
                "autoscaling:EC2_INSTANCE_LAUNCH",
                "autoscaling:EC2_INSTANCE_TERMINATE",
                "autoscaling:EC2_INSTANCE_LAUNCH_ERROR",
                "autoscaling:EC2_INSTANCE_TERMINATE_ERROR")
            .topicArn(example.arn())
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.sns.Topic("example")
# arn is an exported attribute
bar = aws.autoscaling.Group("bar")
# ...
foo = aws.autoscaling.Group("foo")
# ...
example_notifications = aws.autoscaling.Notification("exampleNotifications",
    group_names=[
        bar.name,
        foo.name,
    ],
    notifications=[
        "autoscaling:EC2_INSTANCE_LAUNCH",
        "autoscaling:EC2_INSTANCE_TERMINATE",
        "autoscaling:EC2_INSTANCE_LAUNCH_ERROR",
        "autoscaling:EC2_INSTANCE_TERMINATE_ERROR",
    ],
    topic_arn=example.arn)

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.sns.Topic("example", {});
// arn is an exported attribute
const bar = new aws.autoscaling.Group("bar", {});
// ...
const foo = new aws.autoscaling.Group("foo", {});
// ...
const exampleNotifications = new aws.autoscaling.Notification("exampleNotifications", {
    groupNames: [
        bar.name,
        foo.name,
    ],
    notifications: [
        "autoscaling:EC2_INSTANCE_LAUNCH",
        "autoscaling:EC2_INSTANCE_TERMINATE",
        "autoscaling:EC2_INSTANCE_LAUNCH_ERROR",
        "autoscaling:EC2_INSTANCE_TERMINATE_ERROR",
    ],
    topicArn: example.arn,
});

resources:
  exampleNotifications:
    type: aws:autoscaling:Notification
    properties:
      groupNames:
        - ${bar.name}
        - ${foo.name}
      notifications:
        - autoscaling:EC2_INSTANCE_LAUNCH
        - autoscaling:EC2_INSTANCE_TERMINATE
        - autoscaling:EC2_INSTANCE_LAUNCH_ERROR
        - autoscaling:EC2_INSTANCE_TERMINATE_ERROR
      topicArn: ${example.arn}
  example:
    type: aws:sns:Topic
  bar:
    type: aws:autoscaling:Group
  foo:
    type: aws:autoscaling:Group

Create Notification Resource

new Notification(name: string, args: NotificationArgs, opts?: CustomResourceOptions);

@overload
def Notification(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 group_names: Optional[Sequence[str]] = None,
                 notifications: Optional[Sequence[str]] = None,
                 topic_arn: Optional[str] = None)
@overload
def Notification(resource_name: str,
                 args: NotificationArgs,
                 opts: Optional[ResourceOptions] = None)

func NewNotification(ctx *Context, name string, args NotificationArgs, opts ...ResourceOption) (*Notification, error)

public Notification(string name, NotificationArgs args, CustomResourceOptions? opts = null)

public Notification(String name, NotificationArgs args)
public Notification(String name, NotificationArgs args, CustomResourceOptions options)

type: aws:autoscaling:Notification
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args NotificationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args NotificationArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args NotificationArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args NotificationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args NotificationArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Notification Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Notification resource accepts the following input properties:

GroupNames List<string>: List of AutoScaling Group Names
Notifications List<string>: List of Notification Types that trigger notifications. Acceptable values are documented in the AWS documentation here
TopicArn string: Topic ARN for notifications to be sent through

GroupNames []string: List of AutoScaling Group Names
Notifications []string: List of Notification Types that trigger notifications. Acceptable values are documented in the AWS documentation here
TopicArn string: Topic ARN for notifications to be sent through

groupNames List<String>: List of AutoScaling Group Names
notifications List<String>: List of Notification Types that trigger notifications. Acceptable values are documented in the AWS documentation here
topicArn String: Topic ARN for notifications to be sent through

groupNames string[]: List of AutoScaling Group Names
notifications NotificationType[]: List of Notification Types that trigger notifications. Acceptable values are documented in the AWS documentation here
topicArn string: Topic ARN for notifications to be sent through

group_names Sequence[str]: List of AutoScaling Group Names
notifications Sequence[str]: List of Notification Types that trigger notifications. Acceptable values are documented in the AWS documentation here
topic_arn str: Topic ARN for notifications to be sent through

groupNames List<String>: List of AutoScaling Group Names
notifications List<>: List of Notification Types that trigger notifications. Acceptable values are documented in the AWS documentation here
topicArn String: Topic ARN for notifications to be sent through

Outputs

All input properties are implicitly available as output properties. Additionally, the Notification resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing Notification Resource

Get an existing Notification resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: NotificationState, opts?: CustomResourceOptions): Notification

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        group_names: Optional[Sequence[str]] = None,
        notifications: Optional[Sequence[str]] = None,
        topic_arn: Optional[str] = None) -> Notification

func GetNotification(ctx *Context, name string, id IDInput, state *NotificationState, opts ...ResourceOption) (*Notification, error)

public static Notification Get(string name, Input<string> id, NotificationState? state, CustomResourceOptions? opts = null)

public static Notification get(String name, Output<String> id, NotificationState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

GroupNames List<string>: List of AutoScaling Group Names
Notifications List<string>: List of Notification Types that trigger notifications. Acceptable values are documented in the AWS documentation here
TopicArn string: Topic ARN for notifications to be sent through

GroupNames []string: List of AutoScaling Group Names
Notifications []string: List of Notification Types that trigger notifications. Acceptable values are documented in the AWS documentation here
TopicArn string: Topic ARN for notifications to be sent through

groupNames List<String>: List of AutoScaling Group Names
notifications List<String>: List of Notification Types that trigger notifications. Acceptable values are documented in the AWS documentation here
topicArn String: Topic ARN for notifications to be sent through

groupNames string[]: List of AutoScaling Group Names
notifications NotificationType[]: List of Notification Types that trigger notifications. Acceptable values are documented in the AWS documentation here
topicArn string: Topic ARN for notifications to be sent through

group_names Sequence[str]: List of AutoScaling Group Names
notifications Sequence[str]: List of Notification Types that trigger notifications. Acceptable values are documented in the AWS documentation here
topic_arn str: Topic ARN for notifications to be sent through

groupNames List<String>: List of AutoScaling Group Names
notifications List<>: List of Notification Types that trigger notifications. Acceptable values are documented in the AWS documentation here
topicArn String: Topic ARN for notifications to be sent through

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.