Skip to content
v2.278.0

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',
  }],
};
python
from aws_cdk import CfnTag, CfnTag
# 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

cfn_response_plan_props = ssmincidents.CfnResponsePlanProps(
    incident_template=ssmincidents.CfnResponsePlan.IncidentTemplateProperty(
        impact=123,
        title="title",

        # the properties below are optional
        dedupe_string="dedupeString",
        incident_tags=[CfnTag(
            key="key",
            value="value"
        )],
        notification_targets=[ssmincidents.CfnResponsePlan.NotificationTargetItemProperty(
            sns_topic_arn="snsTopicArn"
        )],
        summary="summary"
    ),
    name="name",

    # the properties below are optional
    actions=[ssmincidents.CfnResponsePlan.ActionProperty(
        ssm_automation=ssmincidents.CfnResponsePlan.SsmAutomationProperty(
            document_name="documentName",
            role_arn="roleArn",

            # the properties below are optional
            document_version="documentVersion",
            dynamic_parameters=[ssmincidents.CfnResponsePlan.DynamicSsmParameterProperty(
                key="key",
                value=ssmincidents.CfnResponsePlan.DynamicSsmParameterValueProperty(
                    variable="variable"
                )
            )],
            parameters=[ssmincidents.CfnResponsePlan.SsmParameterProperty(
                key="key",
                values=["values"]
            )],
            target_account="targetAccount"
        )
    )],
    chat_channel=ssmincidents.CfnResponsePlan.ChatChannelProperty(
        chatbot_sns=["chatbotSns"]
    ),
    display_name="displayName",
    engagements=["engagements"],
    integrations=[ssmincidents.CfnResponsePlan.IntegrationProperty(
        pager_duty_configuration=ssmincidents.CfnResponsePlan.PagerDutyConfigurationProperty(
            name="name",
            pager_duty_incident_configuration=ssmincidents.CfnResponsePlan.PagerDutyIncidentConfigurationProperty(
                service_id="serviceId"
            ),
            secret_id="secretId"
        )
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
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.*;

CfnResponsePlanProps cfnResponsePlanProps = CfnResponsePlanProps.builder()
        .incidentTemplate(IncidentTemplateProperty.builder()
                .impact(123)
                .title("title")

                // the properties below are optional
                .dedupeString("dedupeString")
                .incidentTags(List.of(CfnTag.builder()
                        .key("key")
                        .value("value")
                        .build()))
                .notificationTargets(List.of(NotificationTargetItemProperty.builder()
                        .snsTopicArn("snsTopicArn")
                        .build()))
                .summary("summary")
                .build())
        .name("name")

        // the properties below are optional
        .actions(List.of(ActionProperty.builder()
                .ssmAutomation(SsmAutomationProperty.builder()
                        .documentName("documentName")
                        .roleArn("roleArn")

                        // the properties below are optional
                        .documentVersion("documentVersion")
                        .dynamicParameters(List.of(DynamicSsmParameterProperty.builder()
                                .key("key")
                                .value(DynamicSsmParameterValueProperty.builder()
                                        .variable("variable")
                                        .build())
                                .build()))
                        .parameters(List.of(SsmParameterProperty.builder()
                                .key("key")
                                .values(List.of("values"))
                                .build()))
                        .targetAccount("targetAccount")
                        .build())
                .build()))
        .chatChannel(ChatChannelProperty.builder()
                .chatbotSns(List.of("chatbotSns"))
                .build())
        .displayName("displayName")
        .engagements(List.of("engagements"))
        .integrations(List.of(IntegrationProperty.builder()
                .pagerDutyConfiguration(PagerDutyConfigurationProperty.builder()
                        .name("name")
                        .pagerDutyIncidentConfiguration(PagerDutyIncidentConfigurationProperty.builder()
                                .serviceId("serviceId")
                                .build())
                        .secretId("secretId")
                        .build())
                .build()))
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .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 cfnResponsePlanProps = new CfnResponsePlanProps {
    IncidentTemplate = new IncidentTemplateProperty {
        Impact = 123,
        Title = "title",

        // the properties below are optional
        DedupeString = "dedupeString",
        IncidentTags = new [] { new CfnTag {
            Key = "key",
            Value = "value"
        } },
        NotificationTargets = new [] { new NotificationTargetItemProperty {
            SnsTopicArn = "snsTopicArn"
        } },
        Summary = "summary"
    },
    Name = "name",

    // the properties below are optional
    Actions = new [] { new ActionProperty {
        SsmAutomation = new SsmAutomationProperty {
            DocumentName = "documentName",
            RoleArn = "roleArn",

            // the properties below are optional
            DocumentVersion = "documentVersion",
            DynamicParameters = new [] { new DynamicSsmParameterProperty {
                Key = "key",
                Value = new DynamicSsmParameterValueProperty {
                    Variable = "variable"
                }
            } },
            Parameters = new [] { new SsmParameterProperty {
                Key = "key",
                Values = new [] { "values" }
            } },
            TargetAccount = "targetAccount"
        }
    } },
    ChatChannel = new ChatChannelProperty {
        ChatbotSns = new [] { "chatbotSns" }
    },
    DisplayName = "displayName",
    Engagements = new [] { "engagements" },
    Integrations = new [] { new IntegrationProperty {
        PagerDutyConfiguration = new PagerDutyConfigurationProperty {
            Name = "name",
            PagerDutyIncidentConfiguration = new PagerDutyIncidentConfigurationProperty {
                ServiceId = "serviceId"
            },
            SecretId = "secretId"
        }
    } },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
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"

cfnResponsePlanProps := &CfnResponsePlanProps{
	IncidentTemplate: &IncidentTemplateProperty{
		Impact: jsii.Number(123),
		Title: jsii.String("title"),

		// the properties below are optional
		DedupeString: jsii.String("dedupeString"),
		IncidentTags: []interface{}{
			&CfnTag{
				Key: jsii.String("key"),
				Value: jsii.String("value"),
			},
		},
		NotificationTargets: []interface{}{
			&NotificationTargetItemProperty{
				SnsTopicArn: jsii.String("snsTopicArn"),
			},
		},
		Summary: jsii.String("summary"),
	},
	Name: jsii.String("name"),

	// the properties below are optional
	Actions: []interface{}{
		&ActionProperty{
			SsmAutomation: &SsmAutomationProperty{
				DocumentName: jsii.String("documentName"),
				RoleArn: jsii.String("roleArn"),

				// the properties below are optional
				DocumentVersion: jsii.String("documentVersion"),
				DynamicParameters: []interface{}{
					&DynamicSsmParameterProperty{
						Key: jsii.String("key"),
						Value: &DynamicSsmParameterValueProperty{
							Variable: jsii.String("variable"),
						},
					},
				},
				Parameters: []interface{}{
					&SsmParameterProperty{
						Key: jsii.String("key"),
						Values: []*string{
							jsii.String("values"),
						},
					},
				},
				TargetAccount: jsii.String("targetAccount"),
			},
		},
	},
	ChatChannel: &ChatChannelProperty{
		ChatbotSns: []*string{
			jsii.String("chatbotSns"),
		},
	},
	DisplayName: jsii.String("displayName"),
	Engagements: []*string{
		jsii.String("engagements"),
	},
	Integrations: []interface{}{
		&IntegrationProperty{
			PagerDutyConfiguration: &PagerDutyConfigurationProperty{
				Name: jsii.String("name"),
				PagerDutyIncidentConfiguration: &PagerDutyIncidentConfigurationProperty{
					ServiceId: jsii.String("serviceId"),
				},
				SecretId: jsii.String("secretId"),
			},
		},
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("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.
namestringnamestrnameStringNamestringName*string required #
The name of the response plan.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #
An array of key-value pairs to apply to this resource.

For more information, see Tag .