Class: AWSCDK::SSM::CfnMaintenanceWindowTask::NotificationConfigProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ssm/cfn_maintenance_window_task.rb

Overview

The NotificationConfig property type specifies configurations for sending notifications for a maintenance window task in AWS Systems Manager .

NotificationConfig is a property of the MaintenanceWindowRunCommandParameters property type.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(notification_arn:, notification_events: nil, notification_type: nil) ⇒ NotificationConfigProperty

Returns a new instance of NotificationConfigProperty.

Parameters:

  • notification_arn (String) —

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

  • notification_events (Array<String>, nil) (defaults to: nil) —

    The different events that you can receive notifications for.

  • notification_type (String, nil) (defaults to: nil) —

    The notification type.



1102
1103
1104
1105
1106
1107
1108
1109
 
# File 'ssm/cfn_maintenance_window_task.rb', line 1102

def initialize(notification_arn:, notification_events: nil, notification_type: nil)
  @notification_arn = notification_arn
  Jsii::Type.check_type(@notification_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "notificationArn")
  @notification_events = notification_events
  Jsii::Type.check_type(@notification_events, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "notificationEvents") unless @notification_events.nil?
  @notification_type = notification_type
  Jsii::Type.check_type(@notification_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "notificationType") unless @notification_type.nil?
end

Instance Attribute Details

#notification_arn ⇒ String (readonly)

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)

See Also:



1117
1118
1119
 
# File 'ssm/cfn_maintenance_window_task.rb', line 1117

def notification_arn
  @notification_arn
end

#notification_events ⇒ Array<String>? (readonly)

The different events that you can receive notifications for.

These events include the following: All (events), InProgress , Success , TimedOut , Cancelled , Failed . To learn more about these events, see Configuring Amazon SNS Notifications for AWS Systems Manager in the AWS Systems Manager User Guide .

Returns:

  • (Array<String>, nil)

See Also:



1124
1125
1126
 
# File 'ssm/cfn_maintenance_window_task.rb', line 1124

def notification_events
  @notification_events
end

#notification_type ⇒ String? (readonly)

The notification type.

  • 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, nil)

See Also:



1132
1133
1134
 
# File 'ssm/cfn_maintenance_window_task.rb', line 1132

def notification_type
  @notification_type
end

Class Method Details

.jsii_properties ⇒ Object 



1134
1135
1136
1137
1138
1139
1140
 
# File 'ssm/cfn_maintenance_window_task.rb', line 1134

def self.jsii_properties
  {
    :notification_arn => "notificationArn",
    :notification_events => "notificationEvents",
    :notification_type => "notificationType",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1142
1143
1144
1145
1146
1147
1148
1149
1150
 
# File 'ssm/cfn_maintenance_window_task.rb', line 1142

def to_jsii
  result = {}
  result.merge!({
    "notificationArn" => @notification_arn,
    "notificationEvents" => @notification_events,
    "notificationType" => @notification_type,
  })
  result.compact
end