Class: Aws::SSMIncidents::Types::SsmAutomation

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssmincidents/types.rb

Overview

Details about the Systems Manager automation document that will be used as a runbook during an incident.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_name ⇒ String

The automation document’s name.

Returns:

  • (String) 


2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
 
# File 'lib/aws-sdk-ssmincidents/types.rb', line 2117

class SsmAutomation < Struct.new(
  :document_name,
  :document_version,
  :dynamic_parameters,
  :parameters,
  :role_arn,
  :target_account)
  SENSITIVE = []
  include Aws::Structure
end

#document_version ⇒ String

The automation document’s version to use when running.

Returns:

  • (String) 


2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
 
# File 'lib/aws-sdk-ssmincidents/types.rb', line 2117

class SsmAutomation < Struct.new(
  :document_name,
  :document_version,
  :dynamic_parameters,
  :parameters,
  :role_arn,
  :target_account)
  SENSITIVE = []
  include Aws::Structure
end

#dynamic_parameters ⇒ Hash<String,Types::DynamicSsmParameterValue>

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

Returns:



2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
 
# File 'lib/aws-sdk-ssmincidents/types.rb', line 2117

class SsmAutomation < Struct.new(
  :document_name,
  :document_version,
  :dynamic_parameters,
  :parameters,
  :role_arn,
  :target_account)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Hash<String,Array<String>>

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

Returns:

  • (Hash<String,Array<String>>) 


2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
 
# File 'lib/aws-sdk-ssmincidents/types.rb', line 2117

class SsmAutomation < Struct.new(
  :document_name,
  :document_version,
  :dynamic_parameters,
  :parameters,
  :role_arn,
  :target_account)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

  • (String) 


2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
 
# File 'lib/aws-sdk-ssmincidents/types.rb', line 2117

class SsmAutomation < Struct.new(
  :document_name,
  :document_version,
  :dynamic_parameters,
  :parameters,
  :role_arn,
  :target_account)
  SENSITIVE = []
  include Aws::Structure
end

#target_account ⇒ String

The account that the automation document will be run in. This can be in either the management account or an application account.

Returns:

  • (String) 


2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
 
# File 'lib/aws-sdk-ssmincidents/types.rb', line 2117

class SsmAutomation < Struct.new(
  :document_name,
  :document_version,
  :dynamic_parameters,
  :parameters,
  :role_arn,
  :target_account)
  SENSITIVE = []
  include Aws::Structure
end