Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-ssmincidents-responseplan.json
Parent schema serverless-framework-configuration
Type: object

Resource type definition for AWS::SSMIncidents::ResponsePlan. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ssm-incidents.git

Properties

Name string | Aws_CF_FunctionString required

The name of the response plan.

IncidentTemplate object required

The incident template configuration.

6 nested properties
Impact integer required

The impact value.

min=1max=5
Title string | Aws_CF_FunctionString required

The title string.

DedupeString string | Aws_CF_FunctionString

The deduplication string.

NotificationTargets NotificationTargetItem[]

The list of notification targets.

Default:
[]
maxItems=10
Summary string | Aws_CF_FunctionString

The summary string.

IncidentTags Tag[]

Tags that get applied to incidents created by the StartIncident API action.

Default:
[]
maxItems=50uniqueItems=true
DisplayName string | Aws_CF_FunctionString

The display name of the response plan.

ChatChannel object

The chat channel configuration.

1 nested properties
ChatbotSns SnsArn[]
Default:
[]
uniqueItems=true
Engagements SSMContact[]

The list of engagements to use.

Default:
[]
maxItems=5uniqueItems=true
Actions Action[]

The list of actions.

Default:
[]
maxItems=1uniqueItems=true
Integrations Integration[]

The list of integrations.

Default:
[]
maxItems=1uniqueItems=true
Tags Tag[]

The tags to apply to the response plan.

Default:
[]
maxItems=50uniqueItems=true

Definitions

SSMContact string | Aws_CF_FunctionString

The ARN of the contact.

SnsArn string | Aws_CF_FunctionString

The ARN of the Chatbot SNS topic.

NotificationTargetItem object

A notification target.

SnsTopicArn string | Aws_CF_FunctionString

The ARN of the Chatbot SNS topic.

Action object

The automation configuration to launch.

SsmAutomation object

The configuration to use when starting the SSM automation document.

6 nested properties
RoleArn string | Aws_CF_FunctionString required

The role ARN to use when starting the SSM automation document.

DocumentName string | Aws_CF_FunctionString required

The document name to use when starting the SSM automation document.

DocumentVersion string | Aws_CF_FunctionString

The version of the document to use when starting the SSM automation document.

TargetAccount string | Aws_CF_FunctionString

The account type to use when starting the SSM automation document.

Parameters SsmParameter[]

The parameters to set when starting the SSM automation document.

Default:
[]
minItems=1maxItems=200uniqueItems=true
DynamicParameters DynamicSsmParameter[]

The parameters with dynamic values to set when starting the SSM automation document.

Default:
[]
maxItems=200uniqueItems=true
SsmAutomation object

The configuration to use when starting the SSM automation document.

RoleArn string | Aws_CF_FunctionString required

The role ARN to use when starting the SSM automation document.

DocumentName string | Aws_CF_FunctionString required

The document name to use when starting the SSM automation document.

DocumentVersion string | Aws_CF_FunctionString

The version of the document to use when starting the SSM automation document.

TargetAccount string | Aws_CF_FunctionString

The account type to use when starting the SSM automation document.

Parameters SsmParameter[]

The parameters to set when starting the SSM automation document.

Default:
[]
minItems=1maxItems=200uniqueItems=true
DynamicParameters DynamicSsmParameter[]

The parameters with dynamic values to set when starting the SSM automation document.

Default:
[]
maxItems=200uniqueItems=true
SsmParameter object

A parameter to set when starting the SSM automation document.

Key string | Aws_CF_FunctionString required
Values SsmParameterValue[] required
maxItems=10uniqueItems=true
SsmParameterValue string | Aws_CF_FunctionString

A value of the parameter to set when starting the SSM automation document.

DynamicSsmParameter object

A parameter with a dynamic value to set when starting the SSM automation document.

Key string | Aws_CF_FunctionString required
Value object required

Value of the dynamic parameter to set when starting the SSM automation document.

1 nested properties
Variable string | Aws_CF_FunctionString

The variable types used as dynamic parameter value when starting the SSM automation document.

DynamicSsmParameterValue object

Value of the dynamic parameter to set when starting the SSM automation document.

Variable string | Aws_CF_FunctionString

The variable types used as dynamic parameter value when starting the SSM automation document.

VariableType string | Aws_CF_FunctionString

The variable types used as dynamic parameter value when starting the SSM automation document.

Integration object
PagerDutyConfiguration object

The pagerDuty configuration to use when starting the incident.

3 nested properties
Name string | Aws_CF_FunctionString required

The name of the pagerDuty configuration.

SecretId string | Aws_CF_FunctionString required

The AWS secrets manager secretId storing the pagerDuty token.

PagerDutyIncidentConfiguration object required

The pagerDuty incident configuration.

1 nested properties
ServiceId string | Aws_CF_FunctionString required

The pagerDuty serviceId.

PagerDutyConfiguration object

The pagerDuty configuration to use when starting the incident.

Name string | Aws_CF_FunctionString required

The name of the pagerDuty configuration.

SecretId string | Aws_CF_FunctionString required

The AWS secrets manager secretId storing the pagerDuty token.

PagerDutyIncidentConfiguration object required

The pagerDuty incident configuration.

1 nested properties
ServiceId string | Aws_CF_FunctionString required

The pagerDuty serviceId.

PagerDutyIncidentConfiguration object

The pagerDuty incident configuration.

ServiceId string | Aws_CF_FunctionString required

The pagerDuty serviceId.

Tag object

A key-value pair to tag a resource.

Key string | Aws_CF_FunctionString required
Value string | Aws_CF_FunctionString required
IncidentTemplate object

The incident template configuration.

Impact integer required

The impact value.

min=1max=5
Title string | Aws_CF_FunctionString required

The title string.

DedupeString string | Aws_CF_FunctionString

The deduplication string.

NotificationTargets NotificationTargetItem[]

The list of notification targets.

Default:
[]
maxItems=10
Summary string | Aws_CF_FunctionString

The summary string.

IncidentTags Tag[]

Tags that get applied to incidents created by the StartIncident API action.

Default:
[]
maxItems=50uniqueItems=true
ChatbotSns SnsArn[]
ChatChannel object

The chat channel configuration.

ChatbotSns SnsArn[]
Default:
[]
uniqueItems=true