interface SsmAutomationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.SSMIncidents.CfnResponsePlan.SsmAutomationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsssmincidents#CfnResponsePlan_SsmAutomationProperty`
Java	`software.amazon.awscdk.services.ssmincidents.CfnResponsePlan.SsmAutomationProperty`
Python	`aws_cdk.aws_ssmincidents.CfnResponsePlan.SsmAutomationProperty`
TypeScript	`aws-cdk-lib` » `aws_ssmincidents` » `CfnResponsePlan` » `SsmAutomationProperty`

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmautomation.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ssmincidents as ssmincidents } from 'aws-cdk-lib';
const ssmAutomationProperty: ssmincidents.CfnResponsePlan.SsmAutomationProperty = {
  documentName: 'documentName',
  roleArn: 'roleArn',

  // the properties below are optional
  documentVersion: 'documentVersion',
  dynamicParameters: [{
    key: 'key',
    value: {
      variable: 'variable',
    },
  }],
  parameters: [{
    key: 'key',
    values: ['values'],
  }],
  targetAccount: 'targetAccount',
};

Properties

Name	Type	Description
documentName	`string`	The automation document's name.
roleArn	`string`	The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
documentVersion?	`string`	The version of the runbook to use when running.
dynamicParameters?	`IResolvable` `\|` `IResolvable` `\|` `DynamicSsmParameterProperty[]`	The key-value pairs to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
parameters?	`IResolvable` `\|` `IResolvable` `\|` `SsmParameterProperty[]`	The key-value pair parameters to use when running the runbook.
targetAccount?	`string`	The account that the automation document will be run in.