Class: AWSCDK::SSMIncidents::CfnResponsePlan::SSMAutomationProperty

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

Overview

The SsmAutomation property type specifies details about the Systems Manager Automation runbook that will be used as the runbook during an incident.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document_name:, role_arn:, document_version: nil, dynamic_parameters: nil, parameters: nil, target_account: nil) ⇒ SSMAutomationProperty

Returns a new instance of SSMAutomationProperty.

Parameters:



1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'ssm_incidents/cfn_response_plan.rb', line 1021

def initialize(document_name:, role_arn:, document_version: nil, dynamic_parameters: nil, parameters: nil, target_account: nil)
  @document_name = document_name
  Jsii::Type.check_type(@document_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "documentName")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @document_version = document_version
  Jsii::Type.check_type(@document_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "documentVersion") unless @document_version.nil?
  @dynamic_parameters = dynamic_parameters
  Jsii::Type.check_type(@dynamic_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3NtaW5jaWRlbnRzLkNmblJlc3BvbnNlUGxhbi5EeW5hbWljU3NtUGFyYW1ldGVyUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "dynamicParameters") unless @dynamic_parameters.nil?
  @parameters = parameters
  Jsii::Type.check_type(@parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3NtaW5jaWRlbnRzLkNmblJlc3BvbnNlUGxhbi5Tc21QYXJhbWV0ZXJQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "parameters") unless @parameters.nil?
  @target_account = 
  Jsii::Type.check_type(@target_account, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "targetAccount") unless @target_account.nil?
end

Instance Attribute Details

#document_name ⇒ String (readonly)

The automation document's name.

Returns:

  • (String)

See Also:



1040
1041
1042
 
# File 'ssm_incidents/cfn_response_plan.rb', line 1040

def document_name
  @document_name
end

#document_version ⇒ String? (readonly)

The version of the runbook to use when running.

Returns:

  • (String, nil)

See Also:



1050
1051
1052
 
# File 'ssm_incidents/cfn_response_plan.rb', line 1050

def document_version
  @document_version
end

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

The key-value pairs to resolve dynamic parameter values when processing a Systems Manager Automation runbook.

Returns:

See Also:



1055
1056
1057
 
# File 'ssm_incidents/cfn_response_plan.rb', line 1055

def dynamic_parameters
  @dynamic_parameters
end

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

The key-value pair parameters to use when running the runbook.

Returns:

See Also:



1060
1061
1062
 
# File 'ssm_incidents/cfn_response_plan.rb', line 1060

def parameters
  @parameters
end

#role_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.

Returns:

  • (String)

See Also:



1045
1046
1047
 
# File 'ssm_incidents/cfn_response_plan.rb', line 1045

def role_arn
  @role_arn
end

#target_account ⇒ String? (readonly)

The account that the automation document will be run in.

This can be in either the management account or an application account.

Returns:

  • (String, nil)

See Also:



1067
1068
1069
 
# File 'ssm_incidents/cfn_response_plan.rb', line 1067

def 
  @target_account
end

Class Method Details

.jsii_properties ⇒ Object 



1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
 
# File 'ssm_incidents/cfn_response_plan.rb', line 1069

def self.jsii_properties
  {
    :document_name => "documentName",
    :role_arn => "roleArn",
    :document_version => "documentVersion",
    :dynamic_parameters => "dynamicParameters",
    :parameters => "parameters",
    :target_account => "targetAccount",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
 
# File 'ssm_incidents/cfn_response_plan.rb', line 1080

def to_jsii
  result = {}
  result.merge!({
    "documentName" => @document_name,
    "roleArn" => @role_arn,
    "documentVersion" => @document_version,
    "dynamicParameters" => @dynamic_parameters,
    "parameters" => @parameters,
    "targetAccount" => @target_account,
  })
  result.compact
end