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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass NotificationConfig data as a hash:

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

Configurations for sending notifications.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#notification_arnString

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)

13877
13878
13879
13880
13881
13882
13883
# File 'lib/aws-sdk-ssm/types.rb', line 13877

class NotificationConfig < Struct.new(
  :notification_arn,
  :notification_events,
  :notification_type)
  SENSITIVE = []
  include Aws::Structure
end

#notification_eventsArray<String>

The different events for which you can receive notifications. To learn more about these events, see [Monitoring Systems Manager status changes using Amazon SNS notifications] in the *Amazon Web Services Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html

Returns:

  • (Array<String>)

13877
13878
13879
13880
13881
13882
13883
# File 'lib/aws-sdk-ssm/types.rb', line 13877

class NotificationConfig < Struct.new(
  :notification_arn,
  :notification_events,
  :notification_type)
  SENSITIVE = []
  include Aws::Structure
end

#notification_typeString

The type of notification.

  • `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.

Returns:

  • (String)

13877
13878
13879
13880
13881
13882
13883
# File 'lib/aws-sdk-ssm/types.rb', line 13877

class NotificationConfig < Struct.new(
  :notification_arn,
  :notification_events,
  :notification_type)
  SENSITIVE = []
  include Aws::Structure
end