interface SsmAutomationProperty
| Language | Type name |
|---|---|
.NET | Amazon.CDK.Mixins.Preview.AWS.SSMIncidents.Mixins.CfnResponsePlanPropsMixin.SsmAutomationProperty |
Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsssmincidents/mixins#CfnResponsePlanPropsMixin_SsmAutomationProperty |
Java | software.amazon.awscdk.mixins.preview.services.ssmincidents.mixins.CfnResponsePlanPropsMixin.SsmAutomationProperty |
Python | aws_cdk.mixins_preview.aws_ssmincidents.mixins.CfnResponsePlanPropsMixin.SsmAutomationProperty |
TypeScript | @aws-cdk/mixins-preview » aws_ssmincidents » mixins » CfnResponsePlanPropsMixin » SsmAutomationProperty |
The SsmAutomation property type specifies details about the Systems Manager Automation runbook that will be used as the 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 { mixins as ssmincidents_mixins } from '@aws-cdk/mixins-preview/aws-ssmincidents';
const ssmAutomationProperty: ssmincidents_mixins.CfnResponsePlanPropsMixin.SsmAutomationProperty = {
documentName: 'documentName',
documentVersion: 'documentVersion',
dynamicParameters: [{
key: 'key',
value: {
variable: 'variable',
},
}],
parameters: [{
key: 'key',
values: ['values'],
}],
roleArn: 'roleArn',
targetAccount: 'targetAccount',
};
Properties
| Name | Type | Description |
|---|---|---|
| document | string | The automation document's name. |
| document | string | The version of the runbook to use when running. |
| dynamic | IResolvable | (IResolvable | Dynamic)[] | The key-value pairs to resolve dynamic parameter values when processing a Systems Manager Automation runbook. |
| parameters? | IResolvable | (IResolvable | Ssm)[] | The key-value pair parameters to use when running the runbook. |
| role | string | The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands. |
| target | string | The account that the automation document will be run in. |
documentName?
Type:
string
(optional)
The automation document's name.
documentVersion?
Type:
string
(optional)
The version of the runbook to use when running.
dynamicParameters?
Type:
IResolvable | (IResolvable | Dynamic)[]
(optional)
The key-value pairs to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
parameters?
Type:
IResolvable | (IResolvable | Ssm)[]
(optional)
The key-value pair parameters to use when running the runbook.
roleArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
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.

.NET
Go
Java
Python
TypeScript