Skip to content
v2.278.0

DynamicSsmParameterProperty Struct ​

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

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 String . 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 StringList . If assigned to a parameter of any other type, the runbook fails to run.

Example ​

ts
// 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 dynamicSsmParameterProperty: ssmincidents.CfnResponsePlan.DynamicSsmParameterProperty = {
  key: 'key',
  value: {
    variable: 'variable',
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ssmincidents as ssmincidents

dynamic_ssm_parameter_property = ssmincidents.CfnResponsePlan.DynamicSsmParameterProperty(
    key="key",
    value=ssmincidents.CfnResponsePlan.DynamicSsmParameterValueProperty(
        variable="variable"
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.ssmincidents.*;

DynamicSsmParameterProperty dynamicSsmParameterProperty = DynamicSsmParameterProperty.builder()
        .key("key")
        .value(DynamicSsmParameterValueProperty.builder()
                .variable("variable")
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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"
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

dynamicSsmParameterProperty := &DynamicSsmParameterProperty{
	Key: jsii.String("key"),
	Value: &DynamicSsmParameterValueProperty{
		Variable: jsii.String("variable"),
	},
}

Properties ​

keystringkeystrkeyStringKeystringKey*string required #
The key parameter to use when running the Systems Manager Automation runbook.
The dynamic parameter value.