Class CfnResponsePlanPropsMixin.SsmAutomationProperty

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

Inheritance

object

CfnResponsePlanPropsMixin.SsmAutomationProperty

Implements

CfnResponsePlanPropsMixin.ISsmAutomationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.SSMIncidents.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnResponsePlanPropsMixin.SsmAutomationProperty : CfnResponsePlanPropsMixin.ISsmAutomationProperty

Syntax (vb)

Public Class CfnResponsePlanPropsMixin.SsmAutomationProperty Implements CfnResponsePlanPropsMixin.ISsmAutomationProperty

Remarks

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

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.Mixins.Preview.AWS.SSMIncidents.Mixins;

             var ssmAutomationProperty = new SsmAutomationProperty {
                 DocumentName = "documentName",
                 DocumentVersion = "documentVersion",
                 DynamicParameters = new [] { new DynamicSsmParameterProperty {
                     Key = "key",
                     Value = new DynamicSsmParameterValueProperty {
                         Variable = "variable"
                     }
                 } },
                 Parameters = new [] { new SsmParameterProperty {
                     Key = "key",
                     Values = new [] { "values" }
                 } },
                 RoleArn = "roleArn",
                 TargetAccount = "targetAccount"
             };

Synopsis

Constructors

SsmAutomationProperty()

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

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()

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

public SsmAutomationProperty()

Remarks

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

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.Mixins.Preview.AWS.SSMIncidents.Mixins;

             var ssmAutomationProperty = new SsmAutomationProperty {
                 DocumentName = "documentName",
                 DocumentVersion = "documentVersion",
                 DynamicParameters = new [] { new DynamicSsmParameterProperty {
                     Key = "key",
                     Value = new DynamicSsmParameterValueProperty {
                         Variable = "variable"
                     }
                 } },
                 Parameters = new [] { new SsmParameterProperty {
                     Key = "key",
                     Values = new [] { "values" }
                 } },
                 RoleArn = "roleArn",
                 TargetAccount = "targetAccount"
             };

Properties

DocumentName

The automation document's name.

public string? DocumentName { get; set; }

Property Value

string

Remarks

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

DocumentVersion

The version of the runbook to use when running.

public string? DocumentVersion { get; set; }

Property Value

string

Remarks

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

DynamicParameters

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

public object? DynamicParameters { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnResponsePlanPropsMixin.IDynamicSsmParameterProperty)[]

Parameters

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

public object? Parameters { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnResponsePlanPropsMixin.ISsmParameterProperty)[]

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

string

Remarks

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

TargetAccount

The account that the automation document will be run in.

public string? TargetAccount { get; set; }

Property Value

string

Remarks

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

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

Implements

CfnResponsePlanPropsMixin.ISsmAutomationProperty