Class: AWSCDK::SSMIncidents::CfnResponsePlanProps

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

Overview

Properties for defining a CfnResponsePlan.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incident_template:, name:, actions: nil, chat_channel: nil, display_name: nil, engagements: nil, integrations: nil, tags: nil) ⇒ CfnResponsePlanProps

Returns a new instance of CfnResponsePlanProps.

Parameters:



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'ssm_incidents/cfn_response_plan_props.rb', line 17

def initialize(incident_template:, name:, actions: nil, chat_channel: nil, display_name: nil, engagements: nil, integrations: nil, tags: nil)
  @incident_template = incident_template.is_a?(Hash) ? ::AWSCDK::SSMIncidents::CfnResponsePlan::IncidentTemplateProperty.new(**incident_template.transform_keys(&:to_sym)) : incident_template
  Jsii::Type.check_type(@incident_template, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zc21pbmNpZGVudHMuQ2ZuUmVzcG9uc2VQbGFuLkluY2lkZW50VGVtcGxhdGVQcm9wZXJ0eSJ9XX19")), "incidentTemplate")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @actions = actions
  Jsii::Type.check_type(@actions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3NtaW5jaWRlbnRzLkNmblJlc3BvbnNlUGxhbi5BY3Rpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "actions") unless @actions.nil?
  @chat_channel = chat_channel.is_a?(Hash) ? ::AWSCDK::SSMIncidents::CfnResponsePlan::ChatChannelProperty.new(**chat_channel.transform_keys(&:to_sym)) : chat_channel
  Jsii::Type.check_type(@chat_channel, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zc21pbmNpZGVudHMuQ2ZuUmVzcG9uc2VQbGFuLkNoYXRDaGFubmVsUHJvcGVydHkifV19fQ==")), "chatChannel") unless @chat_channel.nil?
  @display_name = display_name
  Jsii::Type.check_type(@display_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "displayName") unless @display_name.nil?
  @engagements = engagements
  Jsii::Type.check_type(@engagements, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "engagements") unless @engagements.nil?
  @integrations = integrations
  Jsii::Type.check_type(@integrations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3NtaW5jaWRlbnRzLkNmblJlc3BvbnNlUGxhbi5JbnRlZ3JhdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "integrations") unless @integrations.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

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

The actions that the response plan starts at the beginning of an incident.

Returns:

See Also:



50
51
52
 
# File 'ssm_incidents/cfn_response_plan_props.rb', line 50

def actions
  @actions
end

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

The chat channel used for collaboration during an incident.

Returns:

See Also:



55
56
57
 
# File 'ssm_incidents/cfn_response_plan_props.rb', line 55

def chat_channel
  @chat_channel
end

#display_name ⇒ String? (readonly)

The human readable name of the response plan.

Returns:

  • (String, nil)

See Also:



60
61
62
 
# File 'ssm_incidents/cfn_response_plan_props.rb', line 60

def display_name
  @display_name
end

#engagements ⇒ Array<String>? (readonly)

The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.

Returns:

  • (Array<String>, nil)

See Also:



65
66
67
 
# File 'ssm_incidents/cfn_response_plan_props.rb', line 65

def engagements
  @engagements
end

#incident_template ⇒ AWSCDK::IResolvable, AWSCDK::SSMIncidents::CfnResponsePlan::IncidentTemplateProperty (readonly)

Details used to create an incident when using this response plan.

Returns:

See Also:



40
41
42
 
# File 'ssm_incidents/cfn_response_plan_props.rb', line 40

def incident_template
  @incident_template
end

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

Information about third-party services integrated into the response plan.

Returns:

See Also:



70
71
72
 
# File 'ssm_incidents/cfn_response_plan_props.rb', line 70

def integrations
  @integrations
end

#name ⇒ String (readonly)

The name of the response plan.

Returns:

  • (String)

See Also:



45
46
47
 
# File 'ssm_incidents/cfn_response_plan_props.rb', line 45

def name
  @name
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Returns:

See Also:



77
78
79
 
# File 'ssm_incidents/cfn_response_plan_props.rb', line 77

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'ssm_incidents/cfn_response_plan_props.rb', line 79

def self.jsii_properties
  {
    :incident_template => "incidentTemplate",
    :name => "name",
    :actions => "actions",
    :chat_channel => "chatChannel",
    :display_name => "displayName",
    :engagements => "engagements",
    :integrations => "integrations",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'ssm_incidents/cfn_response_plan_props.rb', line 92

def to_jsii
  result = {}
  result.merge!({
    "incidentTemplate" => @incident_template,
    "name" => @name,
    "actions" => @actions,
    "chatChannel" => @chat_channel,
    "displayName" => @display_name,
    "engagements" => @engagements,
    "integrations" => @integrations,
    "tags" => @tags,
  })
  result.compact
end