AWS::SSMIncidents::ResponsePlan SsmAutomation

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "DocumentName" : String,
  "DocumentVersion" : String,
  "DynamicParameters" : [ DynamicSsmParameter, ... ],
  "Parameters" : [ SsmParameter, ... ],
  "RoleArn" : String,
  "TargetAccount" : String
}

YAML

  DocumentName: String
  DocumentVersion: String
  DynamicParameters: 
    - DynamicSsmParameter
  Parameters: 
    - SsmParameter
  RoleArn: String
  TargetAccount: String

Properties

DocumentName

The automation document's name.

Required: Yes

Type: String

Maximum: 128

Update requires: No interruption

DocumentVersion

The version of the runbook to use when running.

Required: No

Type: String

Maximum: 128

Update requires: No interruption

DynamicParameters

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

Required: No

Type: Array of DynamicSsmParameter

Maximum: 200

Update requires: No interruption

Parameters

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

Required: No

Type: Array of SsmParameter

Minimum: 1

Maximum: 200

Update requires: No interruption

RoleArn

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

Required: Yes

Type: String

Pattern: ^arn:aws(-(cn|us-gov))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$

Maximum: 1000

Update requires: No interruption

TargetAccount

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

Required: No

Type: String

Allowed values: IMPACTED_ACCOUNT | RESPONSE_PLAN_OWNER_ACCOUNT

Update requires: No interruption