AWS Cloud Control v1.26.0, Mar 12 25

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

aws-native.ssmincidents.getResponsePlan

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

Using getResponsePlan

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getResponsePlan(args: GetResponsePlanArgs, opts?: InvokeOptions): Promise<GetResponsePlanResult>
function getResponsePlanOutput(args: GetResponsePlanOutputArgs, opts?: InvokeOptions): Output<GetResponsePlanResult>

def get_response_plan(arn: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetResponsePlanResult
def get_response_plan_output(arn: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetResponsePlanResult]

func LookupResponsePlan(ctx *Context, args *LookupResponsePlanArgs, opts ...InvokeOption) (*LookupResponsePlanResult, error)
func LookupResponsePlanOutput(ctx *Context, args *LookupResponsePlanOutputArgs, opts ...InvokeOption) LookupResponsePlanResultOutput

> Note: This function is named LookupResponsePlan in the Go SDK.

public static class GetResponsePlan 
{
    public static Task<GetResponsePlanResult> InvokeAsync(GetResponsePlanArgs args, InvokeOptions? opts = null)
    public static Output<GetResponsePlanResult> Invoke(GetResponsePlanInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetResponsePlanResult> getResponsePlan(GetResponsePlanArgs args, InvokeOptions options)
public static Output<GetResponsePlanResult> getResponsePlan(GetResponsePlanArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:ssmincidents:getResponsePlan
  arguments:
    # arguments dictionary

The following arguments are supported:

Arn string: The ARN of the response plan.

Arn string: The ARN of the response plan.

arn String: The ARN of the response plan.

arn string: The ARN of the response plan.

arn str: The ARN of the response plan.

arn String: The ARN of the response plan.

getResponsePlan Result

The following output properties are available:

Actions List<Pulumi.AwsNative.SsmIncidents.Outputs.ResponsePlanAction>: The list of actions.
Arn string: The ARN of the response plan.
ChatChannel Pulumi.AwsNative.SsmIncidents.Outputs.ResponsePlanChatChannel: The AWS Chatbot chat channel used for collaboration during an incident.
DisplayName string: The display name of the response plan.
Engagements List<string>: The list of engagements to use.
IncidentTemplate Pulumi.AwsNative.SsmIncidents.Outputs.ResponsePlanIncidentTemplate: Details used to create an incident when using this response plan.
Integrations List<Pulumi.AwsNative.SsmIncidents.Outputs.ResponsePlanIntegration>: The list of integrations.
Tags List<Pulumi.AwsNative.Outputs.Tag>: The tags to apply to the response plan.

Actions []ResponsePlanAction: The list of actions.
Arn string: The ARN of the response plan.
ChatChannel ResponsePlanChatChannel: The AWS Chatbot chat channel used for collaboration during an incident.
DisplayName string: The display name of the response plan.
Engagements []string: The list of engagements to use.
IncidentTemplate ResponsePlanIncidentTemplate: Details used to create an incident when using this response plan.
Integrations []ResponsePlanIntegration: The list of integrations.
Tags Tag: The tags to apply to the response plan.

actions List<ResponsePlanAction>: The list of actions.
arn String: The ARN of the response plan.
chatChannel ResponsePlanChatChannel: The AWS Chatbot chat channel used for collaboration during an incident.
displayName String: The display name of the response plan.
engagements List<String>: The list of engagements to use.
incidentTemplate ResponsePlanIncidentTemplate: Details used to create an incident when using this response plan.
integrations List<ResponsePlanIntegration>: The list of integrations.
tags List<Tag>: The tags to apply to the response plan.

actions ResponsePlanAction[]: The list of actions.
arn string: The ARN of the response plan.
chatChannel ResponsePlanChatChannel: The AWS Chatbot chat channel used for collaboration during an incident.
displayName string: The display name of the response plan.
engagements string[]: The list of engagements to use.
incidentTemplate ResponsePlanIncidentTemplate: Details used to create an incident when using this response plan.
integrations ResponsePlanIntegration[]: The list of integrations.
tags Tag[]: The tags to apply to the response plan.

actions Sequence[ResponsePlanAction]: The list of actions.
arn str: The ARN of the response plan.
chat_channel ResponsePlanChatChannel: The AWS Chatbot chat channel used for collaboration during an incident.
display_name str: The display name of the response plan.
engagements Sequence[str]: The list of engagements to use.
incident_template ResponsePlanIncidentTemplate: Details used to create an incident when using this response plan.
integrations Sequence[ResponsePlanIntegration]: The list of integrations.
tags Sequence[root_Tag]: The tags to apply to the response plan.

actions List<Property Map>: The list of actions.
arn String: The ARN of the response plan.
chatChannel Property Map: The AWS Chatbot chat channel used for collaboration during an incident.
displayName String: The display name of the response plan.
engagements List<String>: The list of engagements to use.
incidentTemplate Property Map: Details used to create an incident when using this response plan.
integrations List<Property Map>: The list of integrations.
tags List<Property Map>: The tags to apply to the response plan.

Supporting Types

ResponsePlanAction

SsmAutomation Pulumi.AwsNative.SsmIncidents.Inputs.ResponsePlanSsmAutomation: Details about the Systems Manager automation document that will be used as a runbook during an incident.

SsmAutomation ResponsePlanSsmAutomation: Details about the Systems Manager automation document that will be used as a runbook during an incident.

ssmAutomation ResponsePlanSsmAutomation: Details about the Systems Manager automation document that will be used as a runbook during an incident.

ssmAutomation ResponsePlanSsmAutomation: Details about the Systems Manager automation document that will be used as a runbook during an incident.

ssm_automation ResponsePlanSsmAutomation: Details about the Systems Manager automation document that will be used as a runbook during an incident.

ssmAutomation Property Map: Details about the Systems Manager automation document that will be used as a runbook during an incident.

ResponsePlanChatChannel

ChatbotSns List<string>: The Amazon SNS targets that AWS Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by using the Amazon SNS topics

ChatbotSns []string: The Amazon SNS targets that AWS Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by using the Amazon SNS topics

chatbotSns List<String>: The Amazon SNS targets that AWS Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by using the Amazon SNS topics

chatbotSns string[]: The Amazon SNS targets that AWS Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by using the Amazon SNS topics

chatbot_sns Sequence[str]: The Amazon SNS targets that AWS Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by using the Amazon SNS topics

chatbotSns List<String>: The Amazon SNS targets that AWS Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by using the Amazon SNS topics

ResponsePlanDynamicSsmParameter

Key string: The key parameter to use when running the Systems Manager Automation runbook.
Value Pulumi.AwsNative.SsmIncidents.Inputs.ResponsePlanDynamicSsmParameterValue: The dynamic parameter value.

Key string: The key parameter to use when running the Systems Manager Automation runbook.
Value ResponsePlanDynamicSsmParameterValue: The dynamic parameter value.

key String: The key parameter to use when running the Systems Manager Automation runbook.
value ResponsePlanDynamicSsmParameterValue: The dynamic parameter value.

key string: The key parameter to use when running the Systems Manager Automation runbook.
value ResponsePlanDynamicSsmParameterValue: The dynamic parameter value.

key str: The key parameter to use when running the Systems Manager Automation runbook.
value ResponsePlanDynamicSsmParameterValue: The dynamic parameter value.

key String: The key parameter to use when running the Systems Manager Automation runbook.
value Property Map: The dynamic parameter value.

ResponsePlanDynamicSsmParameterValue

Variable Pulumi.AwsNative.SsmIncidents.ResponsePlanVariableType: Variable dynamic parameters. A parameter value is determined when an incident is created.

Variable ResponsePlanVariableType: Variable dynamic parameters. A parameter value is determined when an incident is created.

variable ResponsePlanVariableType: Variable dynamic parameters. A parameter value is determined when an incident is created.

variable ResponsePlanVariableType: Variable dynamic parameters. A parameter value is determined when an incident is created.

variable ResponsePlanVariableType: Variable dynamic parameters. A parameter value is determined when an incident is created.

variable "INCIDENT_RECORD_ARN" | "INVOLVED_RESOURCES": Variable dynamic parameters. A parameter value is determined when an incident is created.

ResponsePlanIncidentTemplate

Impact int: The impact value.
Title string: The title string.
DedupeString string: The deduplication string.
IncidentTags List<Pulumi.AwsNative.SsmIncidents.Inputs.ResponsePlanTag>: Tags that get applied to incidents created by the StartIncident API action.
NotificationTargets List<Pulumi.AwsNative.SsmIncidents.Inputs.ResponsePlanNotificationTargetItem>: The list of notification targets.
Summary string: The summary string.

Impact int: The impact value.
Title string: The title string.
DedupeString string: The deduplication string.
IncidentTags []ResponsePlanTag: Tags that get applied to incidents created by the StartIncident API action.
NotificationTargets []ResponsePlanNotificationTargetItem: The list of notification targets.
Summary string: The summary string.

impact Integer: The impact value.
title String: The title string.
dedupeString String: The deduplication string.
incidentTags List<ResponsePlanTag>: Tags that get applied to incidents created by the StartIncident API action.
notificationTargets List<ResponsePlanNotificationTargetItem>: The list of notification targets.
summary String: The summary string.

impact number: The impact value.
title string: The title string.
dedupeString string: The deduplication string.
incidentTags ResponsePlanTag[]: Tags that get applied to incidents created by the StartIncident API action.
notificationTargets ResponsePlanNotificationTargetItem[]: The list of notification targets.
summary string: The summary string.

impact int: The impact value.
title str: The title string.
dedupe_string str: The deduplication string.
incident_tags Sequence[ResponsePlanTag]: Tags that get applied to incidents created by the StartIncident API action.
notification_targets Sequence[ResponsePlanNotificationTargetItem]: The list of notification targets.
summary str: The summary string.

impact Number: The impact value.
title String: The title string.
dedupeString String: The deduplication string.
incidentTags List<Property Map>: Tags that get applied to incidents created by the StartIncident API action.
notificationTargets List<Property Map>: The list of notification targets.
summary String: The summary string.

ResponsePlanIntegration

PagerDutyConfiguration Pulumi.AwsNative.SsmIncidents.Inputs.ResponsePlanPagerDutyConfiguration: Information about the PagerDuty service where the response plan creates an incident.

PagerDutyConfiguration ResponsePlanPagerDutyConfiguration: Information about the PagerDuty service where the response plan creates an incident.

pagerDutyConfiguration ResponsePlanPagerDutyConfiguration: Information about the PagerDuty service where the response plan creates an incident.

pagerDutyConfiguration ResponsePlanPagerDutyConfiguration: Information about the PagerDuty service where the response plan creates an incident.

pager_duty_configuration ResponsePlanPagerDutyConfiguration: Information about the PagerDuty service where the response plan creates an incident.

pagerDutyConfiguration Property Map: Information about the PagerDuty service where the response plan creates an incident.

ResponsePlanNotificationTargetItem

SnsTopicArn string: The Amazon Resource Name (ARN) of the Amazon SNS topic.

SnsTopicArn string: The Amazon Resource Name (ARN) of the Amazon SNS topic.

snsTopicArn String: The Amazon Resource Name (ARN) of the Amazon SNS topic.

snsTopicArn string: The Amazon Resource Name (ARN) of the Amazon SNS topic.

sns_topic_arn str: The Amazon Resource Name (ARN) of the Amazon SNS topic.

snsTopicArn String: The Amazon Resource Name (ARN) of the Amazon SNS topic.

ResponsePlanPagerDutyConfiguration

Name string: The name of the pagerDuty configuration.
PagerDutyIncidentConfiguration Pulumi.AwsNative.SsmIncidents.Inputs.ResponsePlanPagerDutyIncidentConfiguration: Details about the PagerDuty service associated with the configuration.
SecretId string: The AWS secrets manager secretId storing the pagerDuty token.

Name string: The name of the pagerDuty configuration.
PagerDutyIncidentConfiguration ResponsePlanPagerDutyIncidentConfiguration: Details about the PagerDuty service associated with the configuration.
SecretId string: The AWS secrets manager secretId storing the pagerDuty token.

name String: The name of the pagerDuty configuration.
pagerDutyIncidentConfiguration ResponsePlanPagerDutyIncidentConfiguration: Details about the PagerDuty service associated with the configuration.
secretId String: The AWS secrets manager secretId storing the pagerDuty token.

name string: The name of the pagerDuty configuration.
pagerDutyIncidentConfiguration ResponsePlanPagerDutyIncidentConfiguration: Details about the PagerDuty service associated with the configuration.
secretId string: The AWS secrets manager secretId storing the pagerDuty token.

name str: The name of the pagerDuty configuration.
pager_duty_incident_configuration ResponsePlanPagerDutyIncidentConfiguration: Details about the PagerDuty service associated with the configuration.
secret_id str: The AWS secrets manager secretId storing the pagerDuty token.

name String: The name of the pagerDuty configuration.
pagerDutyIncidentConfiguration Property Map: Details about the PagerDuty service associated with the configuration.
secretId String: The AWS secrets manager secretId storing the pagerDuty token.

ResponsePlanPagerDutyIncidentConfiguration

ServiceId string: The pagerDuty serviceId.

ServiceId string: The pagerDuty serviceId.

serviceId String: The pagerDuty serviceId.

serviceId string: The pagerDuty serviceId.

service_id str: The pagerDuty serviceId.

serviceId String: The pagerDuty serviceId.

ResponsePlanSsmAutomation

DocumentName string: The document name to use when starting the SSM automation document.
RoleArn string: The role ARN to use when starting the SSM automation document.
DocumentVersion string: The version of the document to use when starting the SSM automation document.
DynamicParameters List<Pulumi.AwsNative.SsmIncidents.Inputs.ResponsePlanDynamicSsmParameter>: The parameters with dynamic values to set when starting the SSM automation document.
Parameters List<Pulumi.AwsNative.SsmIncidents.Inputs.ResponsePlanSsmParameter>: The parameters to set when starting the SSM automation document.
TargetAccount Pulumi.AwsNative.SsmIncidents.ResponsePlanSsmAutomationTargetAccount: The account type to use when starting the SSM automation document.

DocumentName string: The document name to use when starting the SSM automation document.
RoleArn string: The role ARN to use when starting the SSM automation document.
DocumentVersion string: The version of the document to use when starting the SSM automation document.
DynamicParameters []ResponsePlanDynamicSsmParameter: The parameters with dynamic values to set when starting the SSM automation document.
Parameters []ResponsePlanSsmParameter: The parameters to set when starting the SSM automation document.
TargetAccount ResponsePlanSsmAutomationTargetAccount: The account type to use when starting the SSM automation document.

documentName String: The document name to use when starting the SSM automation document.
roleArn String: The role ARN to use when starting the SSM automation document.
documentVersion String: The version of the document to use when starting the SSM automation document.
dynamicParameters List<ResponsePlanDynamicSsmParameter>: The parameters with dynamic values to set when starting the SSM automation document.
parameters List<ResponsePlanSsmParameter>: The parameters to set when starting the SSM automation document.
targetAccount ResponsePlanSsmAutomationTargetAccount: The account type to use when starting the SSM automation document.

documentName string: The document name to use when starting the SSM automation document.
roleArn string: The role ARN to use when starting the SSM automation document.
documentVersion string: The version of the document to use when starting the SSM automation document.
dynamicParameters ResponsePlanDynamicSsmParameter[]: The parameters with dynamic values to set when starting the SSM automation document.
parameters ResponsePlanSsmParameter[]: The parameters to set when starting the SSM automation document.
targetAccount ResponsePlanSsmAutomationTargetAccount: The account type to use when starting the SSM automation document.

document_name str: The document name to use when starting the SSM automation document.
role_arn str: The role ARN to use when starting the SSM automation document.
document_version str: The version of the document to use when starting the SSM automation document.
dynamic_parameters Sequence[ResponsePlanDynamicSsmParameter]: The parameters with dynamic values to set when starting the SSM automation document.
parameters Sequence[ResponsePlanSsmParameter]: The parameters to set when starting the SSM automation document.
target_account ResponsePlanSsmAutomationTargetAccount: The account type to use when starting the SSM automation document.

documentName String: The document name to use when starting the SSM automation document.
roleArn String: The role ARN to use when starting the SSM automation document.
documentVersion String: The version of the document to use when starting the SSM automation document.
dynamicParameters List<Property Map>: The parameters with dynamic values to set when starting the SSM automation document.
parameters List<Property Map>: The parameters to set when starting the SSM automation document.
targetAccount "IMPACTED_ACCOUNT" | "RESPONSE_PLAN_OWNER_ACCOUNT": The account type to use when starting the SSM automation document.

ResponsePlanSsmAutomationTargetAccount

ResponsePlanSsmParameter

Key string: The key parameter to use when running the Automation runbook.
Values List<string>: The value parameter to use when running the Automation runbook.

Key string: The key parameter to use when running the Automation runbook.
Values []string: The value parameter to use when running the Automation runbook.

key String: The key parameter to use when running the Automation runbook.
values List<String>: The value parameter to use when running the Automation runbook.

key string: The key parameter to use when running the Automation runbook.
values string[]: The value parameter to use when running the Automation runbook.

key str: The key parameter to use when running the Automation runbook.
values Sequence[str]: The value parameter to use when running the Automation runbook.

key String: The key parameter to use when running the Automation runbook.
values List<String>: The value parameter to use when running the Automation runbook.

ResponsePlanTag

Key string: The tag key.
Value string: The tag value.

Key string: The tag key.
Value string: The tag value.

key String: The tag key.
value String: The tag value.

key string: The tag key.
value string: The tag value.

key str: The tag key.
value str: The tag value.

key String: The tag key.
value String: The tag value.

ResponsePlanVariableType

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

pulumi/pulumi-aws-native

aws-native.ssmincidents.getResponsePlan

On this page

On this page

Using getResponsePlan

getResponsePlan Result

Supporting Types

ResponsePlanAction

ResponsePlanChatChannel

ResponsePlanDynamicSsmParameter

ResponsePlanDynamicSsmParameterValue

ResponsePlanIncidentTemplate

ResponsePlanIntegration

ResponsePlanNotificationTargetItem

ResponsePlanPagerDutyConfiguration

ResponsePlanPagerDutyIncidentConfiguration

ResponsePlanSsmAutomation

ResponsePlanSsmAutomationTargetAccount

ResponsePlanSsmParameter

ResponsePlanTag

ResponsePlanVariableType

Tag

Package Details

On this page

On this page