Class: AWSCDK::SSMIncidents::CfnResponsePlan::IncidentTemplateProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ssm_incidents/cfn_response_plan.rb

Overview

The IncidentTemplate property type specifies details used to create an incident when using this response plan.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(impact:, title:, dedupe_string: nil, incident_tags: nil, notification_targets: nil, summary: nil) ⇒ IncidentTemplateProperty

Returns a new instance of IncidentTemplateProperty.

Parameters:

  • impact (Numeric) —

    Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.

  • title (String) —

    The title of the incident is a brief and easily recognizable.

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

    Used to create only one incident record for an incident.

  • incident_tags (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::CfnTag>, nil) (defaults to: nil) —

    Tags to assign to the template.

  • notification_targets (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::SSMIncidents::CfnResponsePlan::NotificationTargetItemProperty>, nil) (defaults to: nil) —

    The Amazon Simple Notification Service ( Amazon ) targets that uses to notify the chat channel of updates to an incident.

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

    The summary describes what has happened during the incident.



775
776
777
778
779
780
781
782
783
784
785
786
787
788
 
# File 'ssm_incidents/cfn_response_plan.rb', line 775

def initialize(impact:, title:, dedupe_string: nil, incident_tags: nil, notification_targets: nil, summary: nil)
  @impact = impact
  Jsii::Type.check_type(@impact, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "impact")
  @title = title
  Jsii::Type.check_type(@title, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "title")
  @dedupe_string = dedupe_string
  Jsii::Type.check_type(@dedupe_string, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dedupeString") unless @dedupe_string.nil?
  @incident_tags = incident_tags
  Jsii::Type.check_type(@incident_tags, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5UYWcifV19fSwia2luZCI6ImFycmF5In19XX19")), "incidentTags") unless @incident_tags.nil?
  @notification_targets = notification_targets
  Jsii::Type.check_type(@notification_targets, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3NtaW5jaWRlbnRzLkNmblJlc3BvbnNlUGxhbi5Ob3RpZmljYXRpb25UYXJnZXRJdGVtUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "notificationTargets") unless @notification_targets.nil?
  @summary = summary
  Jsii::Type.check_type(@summary, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "summary") unless @summary.nil?
end

Instance Attribute Details

#dedupe_string ⇒ String? (readonly)

Used to create only one incident record for an incident.

Returns:

  • (String, nil)

See Also:



811
812
813
 
# File 'ssm_incidents/cfn_response_plan.rb', line 811

def dedupe_string
  @dedupe_string
end

#impact ⇒ Numeric (readonly)

Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.

Possible impacts: - 1 - Critical impact, this typically relates to full application failure that impacts many to all customers.

  • 2 - High impact, partial application failure with impact to many customers.
  • 3 - Medium impact, the application is providing reduced service to customers.
  • 4 - Low impact, customer might aren't impacted by the problem yet.
  • 5 - No impact, customers aren't currently impacted but urgent action is needed to avoid impact.

Returns:

  • (Numeric)

See Also:



801
802
803
 
# File 'ssm_incidents/cfn_response_plan.rb', line 801

def impact
  @impact
end

#incident_tags ⇒ AWSCDK::IResolvable, ... (readonly)

Tags to assign to the template.

When the StartIncident API action is called, Incident Manager assigns the tags specified in the template to the incident.

Returns:

See Also:



818
819
820
 
# File 'ssm_incidents/cfn_response_plan.rb', line 818

def incident_tags
  @incident_tags
end

#notification_targets ⇒ AWSCDK::IResolvable, ... (readonly)

The Amazon Simple Notification Service ( Amazon ) targets that uses to notify the chat channel of updates to an incident.

You can also make updates to the incident through the chat channel using the Amazon topics.

Returns:

See Also:



825
826
827
 
# File 'ssm_incidents/cfn_response_plan.rb', line 825

def notification_targets
  @notification_targets
end

#summary ⇒ String? (readonly)

The summary describes what has happened during the incident.

Returns:

  • (String, nil)

See Also:



830
831
832
 
# File 'ssm_incidents/cfn_response_plan.rb', line 830

def summary
  @summary
end

#title ⇒ String (readonly)

The title of the incident is a brief and easily recognizable.

Returns:

  • (String)

See Also:



806
807
808
 
# File 'ssm_incidents/cfn_response_plan.rb', line 806

def title
  @title
end

Class Method Details

.jsii_properties ⇒ Object 



832
833
834
835
836
837
838
839
840
841
 
# File 'ssm_incidents/cfn_response_plan.rb', line 832

def self.jsii_properties
  {
    :impact => "impact",
    :title => "title",
    :dedupe_string => "dedupeString",
    :incident_tags => "incidentTags",
    :notification_targets => "notificationTargets",
    :summary => "summary",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



843
844
845
846
847
848
849
850
851
852
853
854
 
# File 'ssm_incidents/cfn_response_plan.rb', line 843

def to_jsii
  result = {}
  result.merge!({
    "impact" => @impact,
    "title" => @title,
    "dedupeString" => @dedupe_string,
    "incidentTags" => @incident_tags,
    "notificationTargets" => @notification_targets,
    "summary" => @summary,
  })
  result.compact
end