aws-cdk-lib.aws_ssmincidents.CfnResponsePlan.SsmAutomationProperty

interface SsmAutomationProperty

LanguageType name
.NETAmazon.CDK.AWS.SSMIncidents.CfnResponsePlan.SsmAutomationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsssmincidents#CfnResponsePlan_SsmAutomationProperty
Javasoftware.amazon.awscdk.services.ssmincidents.CfnResponsePlan.SsmAutomationProperty
Pythonaws_cdk.aws_ssmincidents.CfnResponsePlan.SsmAutomationProperty
TypeScript aws-cdk-lib » aws_ssmincidents » CfnResponsePlan » SsmAutomationProperty

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

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

NameTypeDescription
documentNamestringThe automation document's name.
roleArnstringThe Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
documentVersion?stringThe automation document's version 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 automation document.
targetAccount?stringThe account that the automation document will be run in.

documentName

Type: string

The automation document's name.


roleArn

Type: string

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


documentVersion?

Type: string (optional)

The automation document's version to use when running.


dynamicParameters?

Type: IResolvable | IResolvable | DynamicSsmParameterProperty[] (optional)

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


parameters?

Type: IResolvable | IResolvable | SsmParameterProperty[] (optional)

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


targetAccount?

Type: string (optional)

The account that the automation document will be run in.

This can be in either the management account or an application account.