AWS::SSMIncidents::ResponsePlan SsmAutomation

The SsmAutomation property type specifies details about the Systems Manager automation document that will be used as a 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 }

Properties

DocumentName

The automation document's name.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$

Update requires: No interruption

DocumentVersion

The automation document's version to use when running.

Required: No

Type: String

Minimum: 0

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: List of DynamicSsmParameter

Update requires: No interruption

Parameters

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

Required: No

Type: List of SsmParameter

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

Minimum: 0

Maximum: 1000

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

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