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

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.

Instance Attribute Summary collapse

Instance Attribute Details

#notification_arnString

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

Returns:

  • (String)


7427
7428
7429
7430
7431
7432
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7427

class NotificationConfig < Struct.new(
  :notification_arn,
  :notification_events,
  :notification_type)
  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 Setting Up Events and Notifications in the Amazon EC2 Systems Manager User Guide.

Returns:

  • (Array<String>)


7427
7428
7429
7430
7431
7432
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7427

class NotificationConfig < Struct.new(
  :notification_arn,
  :notification_events,
  :notification_type)
  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)


7427
7428
7429
7430
7431
7432
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7427

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