CfnResponsePlanProps Struct
Properties for defining a CfnResponsePlan.
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 cfnResponsePlanProps: ssmincidents.CfnResponsePlanProps = {
incidentTemplate: {
impact: 123,
title: 'title',
// the properties below are optional
dedupeString: 'dedupeString',
incidentTags: [{
key: 'key',
value: 'value',
}],
notificationTargets: [{
snsTopicArn: 'snsTopicArn',
}],
summary: 'summary',
},
name: 'name',
// the properties below are optional
actions: [{
ssmAutomation: {
documentName: 'documentName',
roleArn: 'roleArn',
// the properties below are optional
documentVersion: 'documentVersion',
dynamicParameters: [{
key: 'key',
value: {
variable: 'variable',
},
}],
parameters: [{
key: 'key',
values: ['values'],
}],
targetAccount: 'targetAccount',
},
}],
chatChannel: {
chatbotSns: ['chatbotSns'],
},
displayName: 'displayName',
engagements: ['engagements'],
integrations: [{
pagerDutyConfiguration: {
name: 'name',
pagerDutyIncidentConfiguration: {
serviceId: 'serviceId',
},
secretId: 'secretId',
},
}],
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
actionsoptionalIResolvable | IResolvable | CfnResponsePlan.ActionProperty[]actionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ActionProperty]]]actionsoptionalIResolvableActionsoptionalIResolvableActionsoptionalinterface{}#The actions that the response plan starts at the beginning of an incident.
chatChanneloptionalIResolvable | CfnResponsePlan.ChatChannelPropertychat_channeloptionaltyping.Union[IResolvable, ChatChannelProperty]chatChanneloptionalIResolvableChatChanneloptionalIResolvableChatChanneloptionalinterface{}#The chat channel used for collaboration during an incident.
displayNameoptionalstringdisplay_nameoptionalstrdisplayNameoptionalStringDisplayNameoptionalstringDisplayNameoptional*string#The human readable name of the response plan.
engagementsoptionalstring[]engagementsoptionaltyping.List[str]engagementsoptionalList<String>Engagementsoptionalstring[]Engagementsoptional*[]*string#The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
incidentTemplateIResolvable | CfnResponsePlan.IncidentTemplatePropertyincident_templatetyping.Union[IResolvable, IncidentTemplateProperty]incidentTemplateIResolvableIncidentTemplateIResolvableIncidentTemplateinterface{}required#Details used to create an incident when using this response plan.
integrationsoptionalIResolvable | IResolvable | CfnResponsePlan.IntegrationProperty[]integrationsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, IntegrationProperty]]]integrationsoptionalIResolvableIntegrationsoptionalIResolvableIntegrationsoptionalinterface{}#Information about third-party services integrated into the response plan.
The name of the response plan.