You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SSM::Types::NotificationConfig

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing NotificationConfig as input to an Aws::Client method, you can use a vanilla Hash:

{
  notification_arn: "NotificationArn",
  notification_events: ["All"], # accepts All, InProgress, Success, TimedOut, Cancelled, Failed
  notification_type: "Command", # accepts Command, Invocation
}

Configurations for sending notifications.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#notification_arn ⇒ String

An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.

Returns:

  • (String) —

    An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic.

#notification_events ⇒ Array<String>

The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see Monitoring Systems Manager status changes using Amazon SNS notifications in the AWS Systems Manager User Guide.

Returns:

  • (Array<String>) —

    The different events for which you can receive notifications.

#notification_type ⇒ String

Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.

Possible values:

  • Command
  • Invocation

Returns:

  • (String) —

    Command: Receive notification when the status of a command changes.