interface CfnResponsePlanProps

Language	Type name
.NET	Amazon.CDK.AWS.SSMIncidents.CfnResponsePlanProps
Java	software.amazon.awscdk.services.ssmincidents.CfnResponsePlanProps
Python	aws_cdk.aws_ssmincidents.CfnResponsePlanProps
TypeScript	@aws-cdk/aws-ssmincidents » CfnResponsePlanProps

Properties for defining a CfnResponsePlan.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ssmincidents from '@aws-cdk/aws-ssmincidents';
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

Name	Type	Description
incidentTemplate	IResolvable | IncidentTemplateProperty	Details used to create an incident when using this response plan.
name	string	The name of the response plan.
actions?	IResolvable | IResolvable | ActionProperty[]	The actions that the response plan starts at the beginning of an incident.
chatChannel?	IResolvable | ChatChannelProperty	The AWS Chatbot chat channel used for collaboration during an incident.
displayName?	string	The human readable name of the response plan.
engagements?	string[]	The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
integrations?	IResolvable | IResolvable | IntegrationProperty[]	Information about third-party services integrated into the response plan.
tags?	CfnTag[]	An array of key-value pairs to apply to this resource.

---

incidentTemplate

Type: IResolvable | IncidentTemplateProperty

Details used to create an incident when using this response plan.

---

name

Type: string

The name of the response plan.

---

actions?

Type: IResolvable | IResolvable | ActionProperty[] (optional)

The actions that the response plan starts at the beginning of an incident.

---

chatChannel?

Type: IResolvable | ChatChannelProperty (optional)

The AWS Chatbot chat channel used for collaboration during an incident.

---

displayName?

Type: string (optional)

The human readable name of the response plan.

---

engagements?

Type: string[] (optional)

The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.

---

integrations?

Type: IResolvable | IResolvable | IntegrationProperty[] (optional)

Information about third-party services integrated into the response plan.

---

tags?

Type: CfnTag[] (optional)

An array of key-value pairs to apply to this resource.

For more information, see Tag .