Class: AWSCDK::SSMIncidents::CfnResponsePlan::DynamicSSMParameterProperty

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

Overview

When you add a runbook to a response plan, you can specify the parameters for the runbook to use at runtime.

Response plans support parameters with both static and dynamic values. For static values, you enter the value when you define the parameter in the response plan. For dynamic values, the system determines the correct parameter value by collecting information from the incident. Incident Manager supports the following dynamic parameters:

Incident ARN

When Incident Manager creates an incident, the system captures the Amazon Resource Name (ARN) of the corresponding incident record and enters it for this parameter in the runbook.

This value can only be assigned to parameters of type String . If assigned to a parameter of any other type, the runbook fails to run.

Involved resources

When Incident Manager creates an incident, the system captures the ARNs of the resources involved in the incident. These resource ARNs are then assigned to this parameter in the runbook.

This value can only be assigned to parameters of type StringList . If assigned to a parameter of any other type, the runbook fails to run.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(key:, value:) ⇒ DynamicSSMParameterProperty

Returns a new instance of DynamicSSMParameterProperty.

Parameters:



693
694
695
696
697
698
 
# File 'ssm_incidents/cfn_response_plan.rb', line 693

def initialize(key:, value:)
  @key = key
  Jsii::Type.check_type(@key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  @value = value.is_a?(Hash) ? ::AWSCDK::SSMIncidents::CfnResponsePlan::DynamicSSMParameterValueProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zc21pbmNpZGVudHMuQ2ZuUmVzcG9uc2VQbGFuLkR5bmFtaWNTc21QYXJhbWV0ZXJWYWx1ZVByb3BlcnR5In1dfX0=")), "value")
end

Instance Attribute Details

#key ⇒ String (readonly)

The key parameter to use when running the Systems Manager Automation runbook.

Returns:

  • (String)

See Also:



704
705
706
 
# File 'ssm_incidents/cfn_response_plan.rb', line 704

def key
  @key
end

#value ⇒ AWSCDK::IResolvable, AWSCDK::SSMIncidents::CfnResponsePlan::DynamicSSMParameterValueProperty (readonly)

The dynamic parameter value.

Returns:

See Also:



709
710
711
 
# File 'ssm_incidents/cfn_response_plan.rb', line 709

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object 



711
712
713
714
715
716
 
# File 'ssm_incidents/cfn_response_plan.rb', line 711

def self.jsii_properties
  {
    :key => "key",
    :value => "value",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



718
719
720
721
722
723
724
725
 
# File 'ssm_incidents/cfn_response_plan.rb', line 718

def to_jsii
  result = {}
  result.merge!({
    "key" => @key,
    "value" => @value,
  })
  result.compact
end