AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::SSMIncidents::Types::CreateResponsePlanInput

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 CreateResponsePlanInput data as a hash:

{
  actions: [
    {
      ssm_automation: {
        document_name: "SsmAutomationDocumentNameString", # required
        document_version: "SsmAutomationDocumentVersionString",
        parameters: {
          "SsmParametersKeyString" => ["SsmParameterValuesMemberString"],
        },
        role_arn: "RoleArn", # required
        target_account: "RESPONSE_PLAN_OWNER_ACCOUNT", # accepts RESPONSE_PLAN_OWNER_ACCOUNT, IMPACTED_ACCOUNT
      },
    },
  ],
  chat_channel: {
    chatbot_sns: ["SnsArn"],
    empty: {
    },
  },
  client_token: "ClientToken",
  display_name: "ResponsePlanDisplayName",
  engagements: ["SsmContactsArn"],
  incident_template: { # required
    dedupe_string: "DedupeString",
    impact: 1, # required
    notification_targets: [
      {
        sns_topic_arn: "Arn",
      },
    ],
    summary: "IncidentSummary",
    title: "IncidentTitle", # required
  },
  name: "ResponsePlanName", # required
  tags: {
    "TagKey" => "TagValue",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actionsArray<Types::Action>

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

Returns:



350
351
352
353
354
355
356
357
358
359
360
361
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 350

class CreateResponsePlanInput < Struct.new(
  :actions,
  :chat_channel,
  :client_token,
  :display_name,
  :engagements,
  :incident_template,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#chat_channelTypes::ChatChannel

The AWS Chatbot chat channel used for collaboration during an incident.

Returns:



350
351
352
353
354
355
356
357
358
359
360
361
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 350

class CreateResponsePlanInput < Struct.new(
  :actions,
  :chat_channel,
  :client_token,
  :display_name,
  :engagements,
  :incident_template,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_tokenString

A token ensuring that the action is called only once with the specified details.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


350
351
352
353
354
355
356
357
358
359
360
361
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 350

class CreateResponsePlanInput < Struct.new(
  :actions,
  :chat_channel,
  :client_token,
  :display_name,
  :engagements,
  :incident_template,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#display_nameString

The long format of the response plan name. This field can contain spaces.

Returns:

  • (String)


350
351
352
353
354
355
356
357
358
359
360
361
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 350

class CreateResponsePlanInput < Struct.new(
  :actions,
  :chat_channel,
  :client_token,
  :display_name,
  :engagements,
  :incident_template,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#engagementsArray<String>

The contacts and escalation plans that the response plan engages during an incident.

Returns:

  • (Array<String>)


350
351
352
353
354
355
356
357
358
359
360
361
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 350

class CreateResponsePlanInput < Struct.new(
  :actions,
  :chat_channel,
  :client_token,
  :display_name,
  :engagements,
  :incident_template,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#incident_templateTypes::IncidentTemplate

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



350
351
352
353
354
355
356
357
358
359
360
361
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 350

class CreateResponsePlanInput < Struct.new(
  :actions,
  :chat_channel,
  :client_token,
  :display_name,
  :engagements,
  :incident_template,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The short format name of the response plan. Can't include spaces.

Returns:

  • (String)


350
351
352
353
354
355
356
357
358
359
360
361
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 350

class CreateResponsePlanInput < Struct.new(
  :actions,
  :chat_channel,
  :client_token,
  :display_name,
  :engagements,
  :incident_template,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

A list of tags that you are adding to the response plan.

Returns:

  • (Hash<String,String>)


350
351
352
353
354
355
356
357
358
359
360
361
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 350

class CreateResponsePlanInput < Struct.new(
  :actions,
  :chat_channel,
  :client_token,
  :display_name,
  :engagements,
  :incident_template,
  :name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end