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

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

Overview

Note:

When making an API call, you may pass SsmAutomation data as a hash:

{
  document_name: "SsmAutomationDocumentNameString", # required
  document_version: "SsmAutomationDocumentVersionString",
  dynamic_parameters: {
    "DynamicSsmParametersKeyString" => {
      variable: "INCIDENT_RECORD_ARN", # accepts INCIDENT_RECORD_ARN, INVOLVED_RESOURCES
    },
  },
  parameters: {
    "SsmParametersKeyString" => ["SsmParameterValuesMemberString"],
  },
  role_arn: "RoleArn", # required
  target_account: "RESPONSE_PLAN_OWNER_ACCOUNT", # accepts RESPONSE_PLAN_OWNER_ACCOUNT, IMPACTED_ACCOUNT
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_nameString

The automation document's name.

Returns:

  • (String)


1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1953

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

#document_versionString

The automation document's version to use when running.

Returns:

  • (String)


1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1953

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

#dynamic_parametersHash<String,Types::DynamicSsmParameterValue>

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

Returns:



1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1953

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

#parametersHash<String,Array<String>>

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

Returns:

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


1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1953

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

#role_arnString

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

Returns:

  • (String)


1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1953

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

#target_accountString

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

Returns:

  • (String)


1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1953

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