Class CfnResponsePlan.SsmAutomationProperty
The SsmAutomation
property type specifies details about the Systems Manager Automation runbook that will be used as the runbook during an incident.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.SSMIncidents
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SsmAutomationProperty : Object, CfnResponsePlan.ISsmAutomationProperty
Syntax (vb)
Public Class SsmAutomationProperty
Inherits Object
Implements CfnResponsePlan.ISsmAutomationProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SSMIncidents;
var ssmAutomationProperty = new SsmAutomationProperty {
DocumentName = "documentName",
RoleArn = "roleArn",
// the properties below are optional
DocumentVersion = "documentVersion",
DynamicParameters = new [] { new DynamicSsmParameterProperty {
Key = "key",
Value = new DynamicSsmParameterValueProperty {
Variable = "variable"
}
} },
Parameters = new [] { new SsmParameterProperty {
Key = "key",
Values = new [] { "values" }
} },
TargetAccount = "targetAccount"
};
Synopsis
Constructors
SsmAutomationProperty() |
Properties
DocumentName | The automation document's name. |
DocumentVersion | The version of the runbook to use when running. |
DynamicParameters | The key-value pairs to resolve dynamic parameter values when processing a Systems Manager Automation runbook. |
Parameters | The key-value pair parameters to use when running the runbook. |
RoleArn | The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands. |
TargetAccount | The account that the automation document will be run in. |
Constructors
SsmAutomationProperty()
public SsmAutomationProperty()
Properties
DocumentName
The automation document's name.
public string DocumentName { get; set; }
Property Value
System.String
Remarks
DocumentVersion
The version of the runbook to use when running.
public string DocumentVersion { get; set; }
Property Value
System.String
Remarks
DynamicParameters
The key-value pairs to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
public object DynamicParameters { get; set; }
Property Value
System.Object
Remarks
Parameters
The key-value pair parameters to use when running the runbook.
public object Parameters { get; set; }
Property Value
System.Object
Remarks
RoleArn
The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
public string RoleArn { get; set; }
Property Value
System.String
Remarks
TargetAccount
The account that the automation document will be run in.
public string TargetAccount { get; set; }
Property Value
System.String
Remarks
This can be in either the management account or an application account.