Class CfnResponsePlan.DynamicSsmParameterProperty

When you add a runbook to a response plan, you can specify the parameters for the runbook to use at runtime.

Inheritance

object

CfnResponsePlan.DynamicSsmParameterProperty

Implements

CfnResponsePlan.IDynamicSsmParameterProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.SSMIncidents

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnResponsePlan.DynamicSsmParameterProperty : CfnResponsePlan.IDynamicSsmParameterProperty

Syntax (vb)

Public Class CfnResponsePlan.DynamicSsmParameterProperty Implements CfnResponsePlan.IDynamicSsmParameterProperty

Remarks

Response plans support parameters with both static and dynamic values. For static values, you enter the value when you define the parameter in the response plan. For dynamic values, the system determines the correct parameter value by collecting information from the incident. Incident Manager supports the following dynamic parameters:

Incident ARN

When Incident Manager creates an incident, the system captures the Amazon Resource Name (ARN) of the corresponding incident record and enters it for this parameter in the runbook.

This value can only be assigned to parameters of type <code>String</code> . If assigned to a parameter of any other type, the runbook fails to run.

Involved resources

When Incident Manager creates an incident, the system captures the ARNs of the resources involved in the incident. These resource ARNs are then assigned to this parameter in the runbook.

This value can only be assigned to parameters of type <code>StringList</code> . If assigned to a parameter of any other type, the runbook fails to run.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-dynamicssmparameter.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.AWS.SSMIncidents;

             var dynamicSsmParameterProperty = new DynamicSsmParameterProperty {
                 Key = "key",
                 Value = new DynamicSsmParameterValueProperty {
                     Variable = "variable"
                 }
             };

Synopsis

Constructors

DynamicSsmParameterProperty()

When you add a runbook to a response plan, you can specify the parameters for the runbook to use at runtime.

Properties

Key	The key parameter to use when running the Systems Manager Automation runbook.
Value	The dynamic parameter value.

Constructors

DynamicSsmParameterProperty()

When you add a runbook to a response plan, you can specify the parameters for the runbook to use at runtime.

public DynamicSsmParameterProperty()

Remarks

Incident ARN

When Incident Manager creates an incident, the system captures the Amazon Resource Name (ARN) of the corresponding incident record and enters it for this parameter in the runbook.

This value can only be assigned to parameters of type <code>String</code> . If assigned to a parameter of any other type, the runbook fails to run.

Involved resources

When Incident Manager creates an incident, the system captures the ARNs of the resources involved in the incident. These resource ARNs are then assigned to this parameter in the runbook.

This value can only be assigned to parameters of type <code>StringList</code> . If assigned to a parameter of any other type, the runbook fails to run.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-dynamicssmparameter.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.AWS.SSMIncidents;

             var dynamicSsmParameterProperty = new DynamicSsmParameterProperty {
                 Key = "key",
                 Value = new DynamicSsmParameterValueProperty {
                     Variable = "variable"
                 }
             };

Properties

Key

The key parameter to use when running the Systems Manager Automation runbook.

public string Key { get; set; }

Property Value

string

Remarks

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

Value

The dynamic parameter value.

public object Value { get; set; }