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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/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)


12325
12326
12327
12328
12329
12330
12331
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12325

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. 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>)


12325
12326
12327
12328
12329
12330
12331
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12325

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

#notification_typeString

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)


12325
12326
12327
12328
12329
12330
12331
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12325

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