1. Packages
  2. AWS
  3. API Docs
  4. ssmincidents
  5. ResponsePlan
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

aws.ssmincidents.ResponsePlan

Explore with Pulumi AI

Provides a resource to manage response plans in AWS Systems Manager Incident Manager.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ssmincidents.ResponsePlan("example", {
    name: "name",
    incidentTemplate: {
        title: "title",
        impact: 3,
    },
    tags: {
        key: "value",
    },
}, {
    dependsOn: [exampleAwsSsmincidentsReplicationSet],
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.ssmincidents.ResponsePlan("example",
    name="name",
    incident_template={
        "title": "title",
        "impact": 3,
    },
    tags={
        "key": "value",
    },
    opts = pulumi.ResourceOptions(depends_on=[example_aws_ssmincidents_replication_set]))
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ssmincidents"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssmincidents.NewResponsePlan(ctx, "example", &ssmincidents.ResponsePlanArgs{
			Name: pulumi.String("name"),
			IncidentTemplate: &ssmincidents.ResponsePlanIncidentTemplateArgs{
				Title:  pulumi.String("title"),
				Impact: pulumi.Int(3),
			},
			Tags: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleAwsSsmincidentsReplicationSet,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.SsmIncidents.ResponsePlan("example", new()
    {
        Name = "name",
        IncidentTemplate = new Aws.SsmIncidents.Inputs.ResponsePlanIncidentTemplateArgs
        {
            Title = "title",
            Impact = 3,
        },
        Tags = 
        {
            { "key", "value" },
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            exampleAwsSsmincidentsReplicationSet,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssmincidents.ResponsePlan;
import com.pulumi.aws.ssmincidents.ResponsePlanArgs;
import com.pulumi.aws.ssmincidents.inputs.ResponsePlanIncidentTemplateArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResponsePlan("example", ResponsePlanArgs.builder()
            .name("name")
            .incidentTemplate(ResponsePlanIncidentTemplateArgs.builder()
                .title("title")
                .impact("3")
                .build())
            .tags(Map.of("key", "value"))
            .build(), CustomResourceOptions.builder()
                .dependsOn(exampleAwsSsmincidentsReplicationSet)
                .build());

    }
}
Copy
resources:
  example:
    type: aws:ssmincidents:ResponsePlan
    properties:
      name: name
      incidentTemplate:
        title: title
        impact: '3'
      tags:
        key: value
    options:
      dependsOn:
        - ${exampleAwsSsmincidentsReplicationSet}
Copy

Usage With All Fields

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ssmincidents.ResponsePlan("example", {
    name: "name",
    incidentTemplate: {
        title: "title",
        impact: 3,
        dedupeString: "dedupe",
        incidentTags: {
            key: "value",
        },
        notificationTargets: [
            {
                snsTopicArn: example1.arn,
            },
            {
                snsTopicArn: example2.arn,
            },
        ],
        summary: "summary",
    },
    displayName: "display name",
    chatChannels: [topic.arn],
    engagements: ["arn:aws:ssm-contacts:us-east-2:111122223333:contact/test1"],
    action: {
        ssmAutomations: [{
            documentName: document1.name,
            roleArn: role1.arn,
            documentVersion: "version1",
            targetAccount: "RESPONSE_PLAN_OWNER_ACCOUNT",
            parameters: [
                {
                    name: "key",
                    values: [
                        "value1",
                        "value2",
                    ],
                },
                {
                    name: "foo",
                    values: ["bar"],
                },
            ],
            dynamicParameters: {
                someKey: "INVOLVED_RESOURCES",
                anotherKey: "INCIDENT_RECORD_ARN",
            },
        }],
    },
    integration: {
        pagerduties: [{
            name: "pagerdutyIntergration",
            serviceId: "example",
            secretId: "example",
        }],
    },
    tags: {
        key: "value",
    },
}, {
    dependsOn: [exampleAwsSsmincidentsReplicationSet],
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.ssmincidents.ResponsePlan("example",
    name="name",
    incident_template={
        "title": "title",
        "impact": 3,
        "dedupe_string": "dedupe",
        "incident_tags": {
            "key": "value",
        },
        "notification_targets": [
            {
                "sns_topic_arn": example1["arn"],
            },
            {
                "sns_topic_arn": example2["arn"],
            },
        ],
        "summary": "summary",
    },
    display_name="display name",
    chat_channels=[topic["arn"]],
    engagements=["arn:aws:ssm-contacts:us-east-2:111122223333:contact/test1"],
    action={
        "ssm_automations": [{
            "document_name": document1["name"],
            "role_arn": role1["arn"],
            "document_version": "version1",
            "target_account": "RESPONSE_PLAN_OWNER_ACCOUNT",
            "parameters": [
                {
                    "name": "key",
                    "values": [
                        "value1",
                        "value2",
                    ],
                },
                {
                    "name": "foo",
                    "values": ["bar"],
                },
            ],
            "dynamic_parameters": {
                "someKey": "INVOLVED_RESOURCES",
                "anotherKey": "INCIDENT_RECORD_ARN",
            },
        }],
    },
    integration={
        "pagerduties": [{
            "name": "pagerdutyIntergration",
            "service_id": "example",
            "secret_id": "example",
        }],
    },
    tags={
        "key": "value",
    },
    opts = pulumi.ResourceOptions(depends_on=[example_aws_ssmincidents_replication_set]))
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ssmincidents"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssmincidents.NewResponsePlan(ctx, "example", &ssmincidents.ResponsePlanArgs{
			Name: pulumi.String("name"),
			IncidentTemplate: &ssmincidents.ResponsePlanIncidentTemplateArgs{
				Title:        pulumi.String("title"),
				Impact:       pulumi.Int(3),
				DedupeString: pulumi.String("dedupe"),
				IncidentTags: pulumi.StringMap{
					"key": pulumi.String("value"),
				},
				NotificationTargets: ssmincidents.ResponsePlanIncidentTemplateNotificationTargetArray{
					&ssmincidents.ResponsePlanIncidentTemplateNotificationTargetArgs{
						SnsTopicArn: pulumi.Any(example1.Arn),
					},
					&ssmincidents.ResponsePlanIncidentTemplateNotificationTargetArgs{
						SnsTopicArn: pulumi.Any(example2.Arn),
					},
				},
				Summary: pulumi.String("summary"),
			},
			DisplayName: pulumi.String("display name"),
			ChatChannels: pulumi.StringArray{
				topic.Arn,
			},
			Engagements: pulumi.StringArray{
				pulumi.String("arn:aws:ssm-contacts:us-east-2:111122223333:contact/test1"),
			},
			Action: &ssmincidents.ResponsePlanActionArgs{
				SsmAutomations: ssmincidents.ResponsePlanActionSsmAutomationArray{
					&ssmincidents.ResponsePlanActionSsmAutomationArgs{
						DocumentName:    pulumi.Any(document1.Name),
						RoleArn:         pulumi.Any(role1.Arn),
						DocumentVersion: pulumi.String("version1"),
						TargetAccount:   pulumi.String("RESPONSE_PLAN_OWNER_ACCOUNT"),
						Parameters: ssmincidents.ResponsePlanActionSsmAutomationParameterArray{
							&ssmincidents.ResponsePlanActionSsmAutomationParameterArgs{
								Name: pulumi.String("key"),
								Values: pulumi.StringArray{
									pulumi.String("value1"),
									pulumi.String("value2"),
								},
							},
							&ssmincidents.ResponsePlanActionSsmAutomationParameterArgs{
								Name: pulumi.String("foo"),
								Values: pulumi.StringArray{
									pulumi.String("bar"),
								},
							},
						},
						DynamicParameters: pulumi.StringMap{
							"someKey":    pulumi.String("INVOLVED_RESOURCES"),
							"anotherKey": pulumi.String("INCIDENT_RECORD_ARN"),
						},
					},
				},
			},
			Integration: &ssmincidents.ResponsePlanIntegrationArgs{
				Pagerduties: ssmincidents.ResponsePlanIntegrationPagerdutyArray{
					&ssmincidents.ResponsePlanIntegrationPagerdutyArgs{
						Name:      pulumi.String("pagerdutyIntergration"),
						ServiceId: pulumi.String("example"),
						SecretId:  pulumi.String("example"),
					},
				},
			},
			Tags: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleAwsSsmincidentsReplicationSet,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.SsmIncidents.ResponsePlan("example", new()
    {
        Name = "name",
        IncidentTemplate = new Aws.SsmIncidents.Inputs.ResponsePlanIncidentTemplateArgs
        {
            Title = "title",
            Impact = 3,
            DedupeString = "dedupe",
            IncidentTags = 
            {
                { "key", "value" },
            },
            NotificationTargets = new[]
            {
                new Aws.SsmIncidents.Inputs.ResponsePlanIncidentTemplateNotificationTargetArgs
                {
                    SnsTopicArn = example1.Arn,
                },
                new Aws.SsmIncidents.Inputs.ResponsePlanIncidentTemplateNotificationTargetArgs
                {
                    SnsTopicArn = example2.Arn,
                },
            },
            Summary = "summary",
        },
        DisplayName = "display name",
        ChatChannels = new[]
        {
            topic.Arn,
        },
        Engagements = new[]
        {
            "arn:aws:ssm-contacts:us-east-2:111122223333:contact/test1",
        },
        Action = new Aws.SsmIncidents.Inputs.ResponsePlanActionArgs
        {
            SsmAutomations = new[]
            {
                new Aws.SsmIncidents.Inputs.ResponsePlanActionSsmAutomationArgs
                {
                    DocumentName = document1.Name,
                    RoleArn = role1.Arn,
                    DocumentVersion = "version1",
                    TargetAccount = "RESPONSE_PLAN_OWNER_ACCOUNT",
                    Parameters = new[]
                    {
                        new Aws.SsmIncidents.Inputs.ResponsePlanActionSsmAutomationParameterArgs
                        {
                            Name = "key",
                            Values = new[]
                            {
                                "value1",
                                "value2",
                            },
                        },
                        new Aws.SsmIncidents.Inputs.ResponsePlanActionSsmAutomationParameterArgs
                        {
                            Name = "foo",
                            Values = new[]
                            {
                                "bar",
                            },
                        },
                    },
                    DynamicParameters = 
                    {
                        { "someKey", "INVOLVED_RESOURCES" },
                        { "anotherKey", "INCIDENT_RECORD_ARN" },
                    },
                },
            },
        },
        Integration = new Aws.SsmIncidents.Inputs.ResponsePlanIntegrationArgs
        {
            Pagerduties = new[]
            {
                new Aws.SsmIncidents.Inputs.ResponsePlanIntegrationPagerdutyArgs
                {
                    Name = "pagerdutyIntergration",
                    ServiceId = "example",
                    SecretId = "example",
                },
            },
        },
        Tags = 
        {
            { "key", "value" },
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            exampleAwsSsmincidentsReplicationSet,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssmincidents.ResponsePlan;
import com.pulumi.aws.ssmincidents.ResponsePlanArgs;
import com.pulumi.aws.ssmincidents.inputs.ResponsePlanIncidentTemplateArgs;
import com.pulumi.aws.ssmincidents.inputs.ResponsePlanActionArgs;
import com.pulumi.aws.ssmincidents.inputs.ResponsePlanIntegrationArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResponsePlan("example", ResponsePlanArgs.builder()
            .name("name")
            .incidentTemplate(ResponsePlanIncidentTemplateArgs.builder()
                .title("title")
                .impact("3")
                .dedupeString("dedupe")
                .incidentTags(Map.of("key", "value"))
                .notificationTargets(                
                    ResponsePlanIncidentTemplateNotificationTargetArgs.builder()
                        .snsTopicArn(example1.arn())
                        .build(),
                    ResponsePlanIncidentTemplateNotificationTargetArgs.builder()
                        .snsTopicArn(example2.arn())
                        .build())
                .summary("summary")
                .build())
            .displayName("display name")
            .chatChannels(topic.arn())
            .engagements("arn:aws:ssm-contacts:us-east-2:111122223333:contact/test1")
            .action(ResponsePlanActionArgs.builder()
                .ssmAutomations(ResponsePlanActionSsmAutomationArgs.builder()
                    .documentName(document1.name())
                    .roleArn(role1.arn())
                    .documentVersion("version1")
                    .targetAccount("RESPONSE_PLAN_OWNER_ACCOUNT")
                    .parameters(                    
                        ResponsePlanActionSsmAutomationParameterArgs.builder()
                            .name("key")
                            .values(                            
                                "value1",
                                "value2")
                            .build(),
                        ResponsePlanActionSsmAutomationParameterArgs.builder()
                            .name("foo")
                            .values("bar")
                            .build())
                    .dynamicParameters(Map.ofEntries(
                        Map.entry("someKey", "INVOLVED_RESOURCES"),
                        Map.entry("anotherKey", "INCIDENT_RECORD_ARN")
                    ))
                    .build())
                .build())
            .integration(ResponsePlanIntegrationArgs.builder()
                .pagerduties(ResponsePlanIntegrationPagerdutyArgs.builder()
                    .name("pagerdutyIntergration")
                    .serviceId("example")
                    .secretId("example")
                    .build())
                .build())
            .tags(Map.of("key", "value"))
            .build(), CustomResourceOptions.builder()
                .dependsOn(exampleAwsSsmincidentsReplicationSet)
                .build());

    }
}
Copy
resources:
  example:
    type: aws:ssmincidents:ResponsePlan
    properties:
      name: name
      incidentTemplate:
        title: title
        impact: '3'
        dedupeString: dedupe
        incidentTags:
          key: value
        notificationTargets:
          - snsTopicArn: ${example1.arn}
          - snsTopicArn: ${example2.arn}
        summary: summary
      displayName: display name
      chatChannels:
        - ${topic.arn}
      engagements:
        - arn:aws:ssm-contacts:us-east-2:111122223333:contact/test1
      action:
        ssmAutomations:
          - documentName: ${document1.name}
            roleArn: ${role1.arn}
            documentVersion: version1
            targetAccount: RESPONSE_PLAN_OWNER_ACCOUNT
            parameters:
              - name: key
                values:
                  - value1
                  - value2
              - name: foo
                values:
                  - bar
            dynamicParameters:
              someKey: INVOLVED_RESOURCES
              anotherKey: INCIDENT_RECORD_ARN
      integration:
        pagerduties:
          - name: pagerdutyIntergration
            serviceId: example
            secretId: example
      tags:
        key: value
    options:
      dependsOn:
        - ${exampleAwsSsmincidentsReplicationSet}
Copy

Create ResponsePlan Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ResponsePlan(name: string, args: ResponsePlanArgs, opts?: CustomResourceOptions);
@overload
def ResponsePlan(resource_name: str,
                 args: ResponsePlanArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def ResponsePlan(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 incident_template: Optional[ResponsePlanIncidentTemplateArgs] = None,
                 action: Optional[ResponsePlanActionArgs] = None,
                 chat_channels: Optional[Sequence[str]] = None,
                 display_name: Optional[str] = None,
                 engagements: Optional[Sequence[str]] = None,
                 integration: Optional[ResponsePlanIntegrationArgs] = None,
                 name: Optional[str] = None,
                 tags: Optional[Mapping[str, str]] = None)
func NewResponsePlan(ctx *Context, name string, args ResponsePlanArgs, opts ...ResourceOption) (*ResponsePlan, error)
public ResponsePlan(string name, ResponsePlanArgs args, CustomResourceOptions? opts = null)
public ResponsePlan(String name, ResponsePlanArgs args)
public ResponsePlan(String name, ResponsePlanArgs args, CustomResourceOptions options)
type: aws:ssmincidents:ResponsePlan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ResponsePlanArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ResponsePlanArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ResponsePlanArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ResponsePlanArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ResponsePlanArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var responsePlanResource = new Aws.SsmIncidents.ResponsePlan("responsePlanResource", new()
{
    IncidentTemplate = new Aws.SsmIncidents.Inputs.ResponsePlanIncidentTemplateArgs
    {
        Impact = 0,
        Title = "string",
        DedupeString = "string",
        IncidentTags = 
        {
            { "string", "string" },
        },
        NotificationTargets = new[]
        {
            new Aws.SsmIncidents.Inputs.ResponsePlanIncidentTemplateNotificationTargetArgs
            {
                SnsTopicArn = "string",
            },
        },
        Summary = "string",
    },
    Action = new Aws.SsmIncidents.Inputs.ResponsePlanActionArgs
    {
        SsmAutomations = new[]
        {
            new Aws.SsmIncidents.Inputs.ResponsePlanActionSsmAutomationArgs
            {
                DocumentName = "string",
                RoleArn = "string",
                DocumentVersion = "string",
                DynamicParameters = 
                {
                    { "string", "string" },
                },
                Parameters = new[]
                {
                    new Aws.SsmIncidents.Inputs.ResponsePlanActionSsmAutomationParameterArgs
                    {
                        Name = "string",
                        Values = new[]
                        {
                            "string",
                        },
                    },
                },
                TargetAccount = "string",
            },
        },
    },
    ChatChannels = new[]
    {
        "string",
    },
    DisplayName = "string",
    Engagements = new[]
    {
        "string",
    },
    Integration = new Aws.SsmIncidents.Inputs.ResponsePlanIntegrationArgs
    {
        Pagerduties = new[]
        {
            new Aws.SsmIncidents.Inputs.ResponsePlanIntegrationPagerdutyArgs
            {
                Name = "string",
                SecretId = "string",
                ServiceId = "string",
            },
        },
    },
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := ssmincidents.NewResponsePlan(ctx, "responsePlanResource", &ssmincidents.ResponsePlanArgs{
	IncidentTemplate: &ssmincidents.ResponsePlanIncidentTemplateArgs{
		Impact:       pulumi.Int(0),
		Title:        pulumi.String("string"),
		DedupeString: pulumi.String("string"),
		IncidentTags: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		NotificationTargets: ssmincidents.ResponsePlanIncidentTemplateNotificationTargetArray{
			&ssmincidents.ResponsePlanIncidentTemplateNotificationTargetArgs{
				SnsTopicArn: pulumi.String("string"),
			},
		},
		Summary: pulumi.String("string"),
	},
	Action: &ssmincidents.ResponsePlanActionArgs{
		SsmAutomations: ssmincidents.ResponsePlanActionSsmAutomationArray{
			&ssmincidents.ResponsePlanActionSsmAutomationArgs{
				DocumentName:    pulumi.String("string"),
				RoleArn:         pulumi.String("string"),
				DocumentVersion: pulumi.String("string"),
				DynamicParameters: pulumi.StringMap{
					"string": pulumi.String("string"),
				},
				Parameters: ssmincidents.ResponsePlanActionSsmAutomationParameterArray{
					&ssmincidents.ResponsePlanActionSsmAutomationParameterArgs{
						Name: pulumi.String("string"),
						Values: pulumi.StringArray{
							pulumi.String("string"),
						},
					},
				},
				TargetAccount: pulumi.String("string"),
			},
		},
	},
	ChatChannels: pulumi.StringArray{
		pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	Engagements: pulumi.StringArray{
		pulumi.String("string"),
	},
	Integration: &ssmincidents.ResponsePlanIntegrationArgs{
		Pagerduties: ssmincidents.ResponsePlanIntegrationPagerdutyArray{
			&ssmincidents.ResponsePlanIntegrationPagerdutyArgs{
				Name:      pulumi.String("string"),
				SecretId:  pulumi.String("string"),
				ServiceId: pulumi.String("string"),
			},
		},
	},
	Name: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var responsePlanResource = new ResponsePlan("responsePlanResource", ResponsePlanArgs.builder()
    .incidentTemplate(ResponsePlanIncidentTemplateArgs.builder()
        .impact(0)
        .title("string")
        .dedupeString("string")
        .incidentTags(Map.of("string", "string"))
        .notificationTargets(ResponsePlanIncidentTemplateNotificationTargetArgs.builder()
            .snsTopicArn("string")
            .build())
        .summary("string")
        .build())
    .action(ResponsePlanActionArgs.builder()
        .ssmAutomations(ResponsePlanActionSsmAutomationArgs.builder()
            .documentName("string")
            .roleArn("string")
            .documentVersion("string")
            .dynamicParameters(Map.of("string", "string"))
            .parameters(ResponsePlanActionSsmAutomationParameterArgs.builder()
                .name("string")
                .values("string")
                .build())
            .targetAccount("string")
            .build())
        .build())
    .chatChannels("string")
    .displayName("string")
    .engagements("string")
    .integration(ResponsePlanIntegrationArgs.builder()
        .pagerduties(ResponsePlanIntegrationPagerdutyArgs.builder()
            .name("string")
            .secretId("string")
            .serviceId("string")
            .build())
        .build())
    .name("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
response_plan_resource = aws.ssmincidents.ResponsePlan("responsePlanResource",
    incident_template={
        "impact": 0,
        "title": "string",
        "dedupe_string": "string",
        "incident_tags": {
            "string": "string",
        },
        "notification_targets": [{
            "sns_topic_arn": "string",
        }],
        "summary": "string",
    },
    action={
        "ssm_automations": [{
            "document_name": "string",
            "role_arn": "string",
            "document_version": "string",
            "dynamic_parameters": {
                "string": "string",
            },
            "parameters": [{
                "name": "string",
                "values": ["string"],
            }],
            "target_account": "string",
        }],
    },
    chat_channels=["string"],
    display_name="string",
    engagements=["string"],
    integration={
        "pagerduties": [{
            "name": "string",
            "secret_id": "string",
            "service_id": "string",
        }],
    },
    name="string",
    tags={
        "string": "string",
    })
Copy
const responsePlanResource = new aws.ssmincidents.ResponsePlan("responsePlanResource", {
    incidentTemplate: {
        impact: 0,
        title: "string",
        dedupeString: "string",
        incidentTags: {
            string: "string",
        },
        notificationTargets: [{
            snsTopicArn: "string",
        }],
        summary: "string",
    },
    action: {
        ssmAutomations: [{
            documentName: "string",
            roleArn: "string",
            documentVersion: "string",
            dynamicParameters: {
                string: "string",
            },
            parameters: [{
                name: "string",
                values: ["string"],
            }],
            targetAccount: "string",
        }],
    },
    chatChannels: ["string"],
    displayName: "string",
    engagements: ["string"],
    integration: {
        pagerduties: [{
            name: "string",
            secretId: "string",
            serviceId: "string",
        }],
    },
    name: "string",
    tags: {
        string: "string",
    },
});
Copy
type: aws:ssmincidents:ResponsePlan
properties:
    action:
        ssmAutomations:
            - documentName: string
              documentVersion: string
              dynamicParameters:
                string: string
              parameters:
                - name: string
                  values:
                    - string
              roleArn: string
              targetAccount: string
    chatChannels:
        - string
    displayName: string
    engagements:
        - string
    incidentTemplate:
        dedupeString: string
        impact: 0
        incidentTags:
            string: string
        notificationTargets:
            - snsTopicArn: string
        summary: string
        title: string
    integration:
        pagerduties:
            - name: string
              secretId: string
              serviceId: string
    name: string
    tags:
        string: string
Copy

ResponsePlan Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ResponsePlan resource accepts the following input properties:

IncidentTemplate This property is required. ResponsePlanIncidentTemplate
Action ResponsePlanAction
ChatChannels List<string>
DisplayName string
Engagements List<string>
Integration ResponsePlanIntegration
Name Changes to this property will trigger replacement. string
The name of the response plan.
Tags Dictionary<string, string>
IncidentTemplate This property is required. ResponsePlanIncidentTemplateArgs
Action ResponsePlanActionArgs
ChatChannels []string
DisplayName string
Engagements []string
Integration ResponsePlanIntegrationArgs
Name Changes to this property will trigger replacement. string
The name of the response plan.
Tags map[string]string
incidentTemplate This property is required. ResponsePlanIncidentTemplate
action ResponsePlanAction
chatChannels List<String>
displayName String
engagements List<String>
integration ResponsePlanIntegration
name Changes to this property will trigger replacement. String
The name of the response plan.
tags Map<String,String>
incidentTemplate This property is required. ResponsePlanIncidentTemplate
action ResponsePlanAction
chatChannels string[]
displayName string
engagements string[]
integration ResponsePlanIntegration
name Changes to this property will trigger replacement. string
The name of the response plan.
tags {[key: string]: string}
incident_template This property is required. ResponsePlanIncidentTemplateArgs
action ResponsePlanActionArgs
chat_channels Sequence[str]
display_name str
engagements Sequence[str]
integration ResponsePlanIntegrationArgs
name Changes to this property will trigger replacement. str
The name of the response plan.
tags Mapping[str, str]
incidentTemplate This property is required. Property Map
action Property Map
chatChannels List<String>
displayName String
engagements List<String>
integration Property Map
name Changes to this property will trigger replacement. String
The name of the response plan.
tags Map<String>

Outputs

All input properties are implicitly available as output properties. Additionally, the ResponsePlan resource produces the following output properties:

Arn string
The ARN of the response plan.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
The ARN of the response plan.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The ARN of the response plan.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
The ARN of the response plan.
id string
The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
The ARN of the response plan.
id str
The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The ARN of the response plan.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up Existing ResponsePlan Resource

Get an existing ResponsePlan resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ResponsePlanState, opts?: CustomResourceOptions): ResponsePlan
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[ResponsePlanActionArgs] = None,
        arn: Optional[str] = None,
        chat_channels: Optional[Sequence[str]] = None,
        display_name: Optional[str] = None,
        engagements: Optional[Sequence[str]] = None,
        incident_template: Optional[ResponsePlanIncidentTemplateArgs] = None,
        integration: Optional[ResponsePlanIntegrationArgs] = None,
        name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> ResponsePlan
func GetResponsePlan(ctx *Context, name string, id IDInput, state *ResponsePlanState, opts ...ResourceOption) (*ResponsePlan, error)
public static ResponsePlan Get(string name, Input<string> id, ResponsePlanState? state, CustomResourceOptions? opts = null)
public static ResponsePlan get(String name, Output<String> id, ResponsePlanState state, CustomResourceOptions options)
resources:  _:    type: aws:ssmincidents:ResponsePlan    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Action ResponsePlanAction
Arn string
The ARN of the response plan.
ChatChannels List<string>
DisplayName string
Engagements List<string>
IncidentTemplate ResponsePlanIncidentTemplate
Integration ResponsePlanIntegration
Name Changes to this property will trigger replacement. string
The name of the response plan.
Tags Dictionary<string, string>
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Action ResponsePlanActionArgs
Arn string
The ARN of the response plan.
ChatChannels []string
DisplayName string
Engagements []string
IncidentTemplate ResponsePlanIncidentTemplateArgs
Integration ResponsePlanIntegrationArgs
Name Changes to this property will trigger replacement. string
The name of the response plan.
Tags map[string]string
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

action ResponsePlanAction
arn String
The ARN of the response plan.
chatChannels List<String>
displayName String
engagements List<String>
incidentTemplate ResponsePlanIncidentTemplate
integration ResponsePlanIntegration
name Changes to this property will trigger replacement. String
The name of the response plan.
tags Map<String,String>
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

action ResponsePlanAction
arn string
The ARN of the response plan.
chatChannels string[]
displayName string
engagements string[]
incidentTemplate ResponsePlanIncidentTemplate
integration ResponsePlanIntegration
name Changes to this property will trigger replacement. string
The name of the response plan.
tags {[key: string]: string}
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

action ResponsePlanActionArgs
arn str
The ARN of the response plan.
chat_channels Sequence[str]
display_name str
engagements Sequence[str]
incident_template ResponsePlanIncidentTemplateArgs
integration ResponsePlanIntegrationArgs
name Changes to this property will trigger replacement. str
The name of the response plan.
tags Mapping[str, str]
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

action Property Map
arn String
The ARN of the response plan.
chatChannels List<String>
displayName String
engagements List<String>
incidentTemplate Property Map
integration Property Map
name Changes to this property will trigger replacement. String
The name of the response plan.
tags Map<String>
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Supporting Types

ResponsePlanAction
, ResponsePlanActionArgs

SsmAutomations List<ResponsePlanActionSsmAutomation>
The Systems Manager automation document to start as the runbook at the beginning of the incident. The following values are supported:
SsmAutomations []ResponsePlanActionSsmAutomation
The Systems Manager automation document to start as the runbook at the beginning of the incident. The following values are supported:
ssmAutomations List<ResponsePlanActionSsmAutomation>
The Systems Manager automation document to start as the runbook at the beginning of the incident. The following values are supported:
ssmAutomations ResponsePlanActionSsmAutomation[]
The Systems Manager automation document to start as the runbook at the beginning of the incident. The following values are supported:
ssm_automations Sequence[ResponsePlanActionSsmAutomation]
The Systems Manager automation document to start as the runbook at the beginning of the incident. The following values are supported:
ssmAutomations List<Property Map>
The Systems Manager automation document to start as the runbook at the beginning of the incident. The following values are supported:

ResponsePlanActionSsmAutomation
, ResponsePlanActionSsmAutomationArgs

DocumentName This property is required. string
The automation document's name.
RoleArn This property is required. string
The Amazon Resource Name (ARN) of the role that the automation document assumes when it runs commands.
DocumentVersion string
The version of the automation document to use at runtime.
DynamicParameters Dictionary<string, string>
The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
Parameters List<ResponsePlanActionSsmAutomationParameter>
The key-value pair parameters to use when the automation document runs. The following values are supported:
TargetAccount string
The account that the automation document runs in. This can be in either the management account or an application account.
DocumentName This property is required. string
The automation document's name.
RoleArn This property is required. string
The Amazon Resource Name (ARN) of the role that the automation document assumes when it runs commands.
DocumentVersion string
The version of the automation document to use at runtime.
DynamicParameters map[string]string
The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
Parameters []ResponsePlanActionSsmAutomationParameter
The key-value pair parameters to use when the automation document runs. The following values are supported:
TargetAccount string
The account that the automation document runs in. This can be in either the management account or an application account.
documentName This property is required. String
The automation document's name.
roleArn This property is required. String
The Amazon Resource Name (ARN) of the role that the automation document assumes when it runs commands.
documentVersion String
The version of the automation document to use at runtime.
dynamicParameters Map<String,String>
The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
parameters List<ResponsePlanActionSsmAutomationParameter>
The key-value pair parameters to use when the automation document runs. The following values are supported:
targetAccount String
The account that the automation document runs in. This can be in either the management account or an application account.
documentName This property is required. string
The automation document's name.
roleArn This property is required. string
The Amazon Resource Name (ARN) of the role that the automation document assumes when it runs commands.
documentVersion string
The version of the automation document to use at runtime.
dynamicParameters {[key: string]: string}
The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
parameters ResponsePlanActionSsmAutomationParameter[]
The key-value pair parameters to use when the automation document runs. The following values are supported:
targetAccount string
The account that the automation document runs in. This can be in either the management account or an application account.
document_name This property is required. str
The automation document's name.
role_arn This property is required. str
The Amazon Resource Name (ARN) of the role that the automation document assumes when it runs commands.
document_version str
The version of the automation document to use at runtime.
dynamic_parameters Mapping[str, str]
The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
parameters Sequence[ResponsePlanActionSsmAutomationParameter]
The key-value pair parameters to use when the automation document runs. The following values are supported:
target_account str
The account that the automation document runs in. This can be in either the management account or an application account.
documentName This property is required. String
The automation document's name.
roleArn This property is required. String
The Amazon Resource Name (ARN) of the role that the automation document assumes when it runs commands.
documentVersion String
The version of the automation document to use at runtime.
dynamicParameters Map<String>
The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
parameters List<Property Map>
The key-value pair parameters to use when the automation document runs. The following values are supported:
targetAccount String
The account that the automation document runs in. This can be in either the management account or an application account.

ResponsePlanActionSsmAutomationParameter
, ResponsePlanActionSsmAutomationParameterArgs

Name This property is required. string
The name of the response plan.
Values This property is required. List<string>
The values for the associated parameter name.
Name This property is required. string
The name of the response plan.
Values This property is required. []string
The values for the associated parameter name.
name This property is required. String
The name of the response plan.
values This property is required. List<String>
The values for the associated parameter name.
name This property is required. string
The name of the response plan.
values This property is required. string[]
The values for the associated parameter name.
name This property is required. str
The name of the response plan.
values This property is required. Sequence[str]
The values for the associated parameter name.
name This property is required. String
The name of the response plan.
values This property is required. List<String>
The values for the associated parameter name.

ResponsePlanIncidentTemplate
, ResponsePlanIncidentTemplateArgs

Impact This property is required. int
The impact value of a generated incident. The following values are supported:
Title This property is required. string
The title of a generated incident.
DedupeString string
A string used to stop Incident Manager from creating multiple incident records for the same incident.
IncidentTags Dictionary<string, string>
The tags assigned to an incident template. When an incident starts, Incident Manager assigns the tags specified in the template to the incident.
NotificationTargets List<ResponsePlanIncidentTemplateNotificationTarget>
The Amazon Simple Notification Service (Amazon SNS) targets that this incident notifies when it is updated. The notification_target configuration block supports the following argument:
Summary string
The summary of an incident.
Impact This property is required. int
The impact value of a generated incident. The following values are supported:
Title This property is required. string
The title of a generated incident.
DedupeString string
A string used to stop Incident Manager from creating multiple incident records for the same incident.
IncidentTags map[string]string
The tags assigned to an incident template. When an incident starts, Incident Manager assigns the tags specified in the template to the incident.
NotificationTargets []ResponsePlanIncidentTemplateNotificationTarget
The Amazon Simple Notification Service (Amazon SNS) targets that this incident notifies when it is updated. The notification_target configuration block supports the following argument:
Summary string
The summary of an incident.
impact This property is required. Integer
The impact value of a generated incident. The following values are supported:
title This property is required. String
The title of a generated incident.
dedupeString String
A string used to stop Incident Manager from creating multiple incident records for the same incident.
incidentTags Map<String,String>
The tags assigned to an incident template. When an incident starts, Incident Manager assigns the tags specified in the template to the incident.
notificationTargets List<ResponsePlanIncidentTemplateNotificationTarget>
The Amazon Simple Notification Service (Amazon SNS) targets that this incident notifies when it is updated. The notification_target configuration block supports the following argument:
summary String
The summary of an incident.
impact This property is required. number
The impact value of a generated incident. The following values are supported:
title This property is required. string
The title of a generated incident.
dedupeString string
A string used to stop Incident Manager from creating multiple incident records for the same incident.
incidentTags {[key: string]: string}
The tags assigned to an incident template. When an incident starts, Incident Manager assigns the tags specified in the template to the incident.
notificationTargets ResponsePlanIncidentTemplateNotificationTarget[]
The Amazon Simple Notification Service (Amazon SNS) targets that this incident notifies when it is updated. The notification_target configuration block supports the following argument:
summary string
The summary of an incident.
impact This property is required. int
The impact value of a generated incident. The following values are supported:
title This property is required. str
The title of a generated incident.
dedupe_string str
A string used to stop Incident Manager from creating multiple incident records for the same incident.
incident_tags Mapping[str, str]
The tags assigned to an incident template. When an incident starts, Incident Manager assigns the tags specified in the template to the incident.
notification_targets Sequence[ResponsePlanIncidentTemplateNotificationTarget]
The Amazon Simple Notification Service (Amazon SNS) targets that this incident notifies when it is updated. The notification_target configuration block supports the following argument:
summary str
The summary of an incident.
impact This property is required. Number
The impact value of a generated incident. The following values are supported:
title This property is required. String
The title of a generated incident.
dedupeString String
A string used to stop Incident Manager from creating multiple incident records for the same incident.
incidentTags Map<String>
The tags assigned to an incident template. When an incident starts, Incident Manager assigns the tags specified in the template to the incident.
notificationTargets List<Property Map>
The Amazon Simple Notification Service (Amazon SNS) targets that this incident notifies when it is updated. The notification_target configuration block supports the following argument:
summary String
The summary of an incident.

ResponsePlanIncidentTemplateNotificationTarget
, ResponsePlanIncidentTemplateNotificationTargetArgs

SnsTopicArn This property is required. string

The ARN of the Amazon SNS topic.

The following arguments are optional:

SnsTopicArn This property is required. string

The ARN of the Amazon SNS topic.

The following arguments are optional:

snsTopicArn This property is required. String

The ARN of the Amazon SNS topic.

The following arguments are optional:

snsTopicArn This property is required. string

The ARN of the Amazon SNS topic.

The following arguments are optional:

sns_topic_arn This property is required. str

The ARN of the Amazon SNS topic.

The following arguments are optional:

snsTopicArn This property is required. String

The ARN of the Amazon SNS topic.

The following arguments are optional:

ResponsePlanIntegration
, ResponsePlanIntegrationArgs

Pagerduties List<ResponsePlanIntegrationPagerduty>
Details about the PagerDuty configuration for a response plan. The following values are supported:
Pagerduties []ResponsePlanIntegrationPagerduty
Details about the PagerDuty configuration for a response plan. The following values are supported:
pagerduties List<ResponsePlanIntegrationPagerduty>
Details about the PagerDuty configuration for a response plan. The following values are supported:
pagerduties ResponsePlanIntegrationPagerduty[]
Details about the PagerDuty configuration for a response plan. The following values are supported:
pagerduties Sequence[ResponsePlanIntegrationPagerduty]
Details about the PagerDuty configuration for a response plan. The following values are supported:
pagerduties List<Property Map>
Details about the PagerDuty configuration for a response plan. The following values are supported:

ResponsePlanIntegrationPagerduty
, ResponsePlanIntegrationPagerdutyArgs

Name This property is required. string
The name of the response plan.
SecretId This property is required. string

The ID of the AWS Secrets Manager secret that stores your PagerDuty key — either a General Access REST API Key or User Token REST API Key — and other user credentials.

For more information about the constraints for each field, see CreateResponsePlan in the AWS Systems Manager Incident Manager API Reference.

ServiceId This property is required. string
The ID of the PagerDuty service that the response plan associated with the incident at launch.
Name This property is required. string
The name of the response plan.
SecretId This property is required. string

The ID of the AWS Secrets Manager secret that stores your PagerDuty key — either a General Access REST API Key or User Token REST API Key — and other user credentials.

For more information about the constraints for each field, see CreateResponsePlan in the AWS Systems Manager Incident Manager API Reference.

ServiceId This property is required. string
The ID of the PagerDuty service that the response plan associated with the incident at launch.
name This property is required. String
The name of the response plan.
secretId This property is required. String

The ID of the AWS Secrets Manager secret that stores your PagerDuty key — either a General Access REST API Key or User Token REST API Key — and other user credentials.

For more information about the constraints for each field, see CreateResponsePlan in the AWS Systems Manager Incident Manager API Reference.

serviceId This property is required. String
The ID of the PagerDuty service that the response plan associated with the incident at launch.
name This property is required. string
The name of the response plan.
secretId This property is required. string

The ID of the AWS Secrets Manager secret that stores your PagerDuty key — either a General Access REST API Key or User Token REST API Key — and other user credentials.

For more information about the constraints for each field, see CreateResponsePlan in the AWS Systems Manager Incident Manager API Reference.

serviceId This property is required. string
The ID of the PagerDuty service that the response plan associated with the incident at launch.
name This property is required. str
The name of the response plan.
secret_id This property is required. str

The ID of the AWS Secrets Manager secret that stores your PagerDuty key — either a General Access REST API Key or User Token REST API Key — and other user credentials.

For more information about the constraints for each field, see CreateResponsePlan in the AWS Systems Manager Incident Manager API Reference.

service_id This property is required. str
The ID of the PagerDuty service that the response plan associated with the incident at launch.
name This property is required. String
The name of the response plan.
secretId This property is required. String

The ID of the AWS Secrets Manager secret that stores your PagerDuty key — either a General Access REST API Key or User Token REST API Key — and other user credentials.

For more information about the constraints for each field, see CreateResponsePlan in the AWS Systems Manager Incident Manager API Reference.

serviceId This property is required. String
The ID of the PagerDuty service that the response plan associated with the incident at launch.

Import

Using pulumi import, import an Incident Manager response plan using the response plan ARN. You can find the response plan ARN in the AWS Management Console. For example:

$ pulumi import aws:ssmincidents/responsePlan:ResponsePlan responsePlanName ARNValue
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.