interface DynamicSsmParameterProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.SSMIncidents.CfnResponsePlan.DynamicSsmParameterProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsssmincidents#CfnResponsePlan_DynamicSsmParameterProperty |
![]() | software.amazon.awscdk.services.ssmincidents.CfnResponsePlan.DynamicSsmParameterProperty |
![]() | aws_cdk.aws_ssmincidents.CfnResponsePlan.DynamicSsmParameterProperty |
![]() | aws-cdk-lib » aws_ssmincidents » CfnResponsePlan » DynamicSsmParameterProperty |
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
// 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',
},
};
Properties
Name | Type | Description |
---|---|---|
key | string | The key parameter to use when running the Systems Manager Automation runbook. |
value | IResolvable | Dynamic | The dynamic parameter value. |
key
Type:
string
The key parameter to use when running the Systems Manager Automation runbook.
value
Type:
IResolvable
|
Dynamic
The dynamic parameter value.