AWS Native is in preview. AWS Classic is fully supported.
aws-native.ssmincidents.ResponsePlan
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
Resource type definition for AWS::SSMIncidents::ResponsePlan
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,
actions: Optional[Sequence[ResponsePlanActionArgs]] = None,
chat_channel: Optional[ResponsePlanChatChannelArgs] = None,
display_name: Optional[str] = None,
engagements: Optional[Sequence[str]] = None,
integrations: Optional[Sequence[ResponsePlanIntegrationArgs]] = None,
name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native:ssmincidents:ResponsePlan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ResponsePlanArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args ResponsePlanArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ResponsePlanArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ResponsePlanArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const responsePlanResource = new aws_native.ssmincidents.ResponsePlan("responsePlanResource", {
incidentTemplate: {
impact: 0,
title: "string",
dedupeString: "string",
incidentTags: [{
key: "string",
value: "string",
}],
notificationTargets: [{
snsTopicArn: "string",
}],
summary: "string",
},
actions: [{
ssmAutomation: {
documentName: "string",
roleArn: "string",
documentVersion: "string",
dynamicParameters: [{
key: "string",
value: {
variable: aws_native.ssmincidents.ResponsePlanVariableType.IncidentRecordArn,
},
}],
parameters: [{
key: "string",
values: ["string"],
}],
targetAccount: aws_native.ssmincidents.ResponsePlanSsmAutomationTargetAccount.ImpactedAccount,
},
}],
chatChannel: {
chatbotSns: ["string"],
},
displayName: "string",
engagements: ["string"],
integrations: [{
pagerDutyConfiguration: {
name: "string",
pagerDutyIncidentConfiguration: {
serviceId: "string",
},
secretId: "string",
},
}],
name: "string",
tags: [{
key: "string",
value: "string",
}],
});
Coming soon!
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
The ResponsePlan resource accepts the following input properties:
- Incident
Template Pulumi.Aws Native. Ssm Incidents. Inputs. Response Plan Incident Template - Actions
List<Pulumi.
Aws Native. Ssm Incidents. Inputs. Response Plan Action> - The list of actions.
- Chat
Channel Pulumi.Aws Native. Ssm Incidents. Inputs. Response Plan Chat Channel - Display
Name string - The display name of the response plan.
- Engagements List<string>
- The list of engagements to use.
- Integrations
List<Pulumi.
Aws Native. Ssm Incidents. Inputs. Response Plan Integration> - The list of integrations.
- Name string
- The name of the response plan.
- List<Pulumi.
Aws Native. Inputs. Tag> - The tags to apply to the response plan.
- Incident
Template ResponsePlan Incident Template Args - Actions
[]Response
Plan Action Args - The list of actions.
- Chat
Channel ResponsePlan Chat Channel Args - Display
Name string - The display name of the response plan.
- Engagements []string
- The list of engagements to use.
- Integrations
[]Response
Plan Integration Args - The list of integrations.
- Name string
- The name of the response plan.
- Tag
Args - The tags to apply to the response plan.
- incident
Template ResponsePlan Incident Template - actions
List<Response
Plan Action> - The list of actions.
- chat
Channel ResponsePlan Chat Channel - display
Name String - The display name of the response plan.
- engagements List<String>
- The list of engagements to use.
- integrations
List<Response
Plan Integration> - The list of integrations.
- name String
- The name of the response plan.
- List<Tag>
- The tags to apply to the response plan.
- incident
Template ResponsePlan Incident Template - actions
Response
Plan Action[] - The list of actions.
- chat
Channel ResponsePlan Chat Channel - display
Name string - The display name of the response plan.
- engagements string[]
- The list of engagements to use.
- integrations
Response
Plan Integration[] - The list of integrations.
- name string
- The name of the response plan.
- Tag[]
- The tags to apply to the response plan.
- incident_
template ResponsePlan Incident Template Args - actions
Sequence[Response
Plan Action Args] - The list of actions.
- chat_
channel ResponsePlan Chat Channel Args - display_
name str - The display name of the response plan.
- engagements Sequence[str]
- The list of engagements to use.
- integrations
Sequence[Response
Plan Integration Args] - The list of integrations.
- name str
- The name of the response plan.
- Sequence[Tag
Args] - The tags to apply to the response plan.
- incident
Template Property Map - actions List<Property Map>
- The list of actions.
- chat
Channel Property Map - display
Name String - The display name of the response plan.
- engagements List<String>
- The list of engagements to use.
- integrations List<Property Map>
- The list of integrations.
- name String
- The name of the response plan.
- List<Property Map>
- The tags to apply to the response plan.
Outputs
All input properties are implicitly available as output properties. Additionally, the ResponsePlan resource produces the following output properties:
Supporting Types
ResponsePlanAction, ResponsePlanActionArgs
ResponsePlanChatChannel, ResponsePlanChatChannelArgs
- Chatbot
Sns List<string>
- Chatbot
Sns []string
- chatbot
Sns List<String>
- chatbot
Sns string[]
- chatbot_
sns Sequence[str]
- chatbot
Sns List<String>
ResponsePlanDynamicSsmParameter, ResponsePlanDynamicSsmParameterArgs
- key String
- value Property Map
ResponsePlanDynamicSsmParameterValue, ResponsePlanDynamicSsmParameterValueArgs
ResponsePlanIncidentTemplate, ResponsePlanIncidentTemplateArgs
- Impact int
- The impact value.
- Title string
- The title string.
- Dedupe
String string - The deduplication string.
- List<Pulumi.
Aws Native. Ssm Incidents. Inputs. Response Plan Tag> - Tags that get applied to incidents created by the StartIncident API action.
- Notification
Targets List<Pulumi.Aws Native. Ssm Incidents. Inputs. Response Plan Notification Target Item> - The list of notification targets.
- Summary string
- The summary string.
- Impact int
- The impact value.
- Title string
- The title string.
- Dedupe
String string - The deduplication string.
- []Response
Plan Tag - Tags that get applied to incidents created by the StartIncident API action.
- Notification
Targets []ResponsePlan Notification Target Item - The list of notification targets.
- Summary string
- The summary string.
- impact Integer
- The impact value.
- title String
- The title string.
- dedupe
String String - The deduplication string.
- List<Response
Plan Tag> - Tags that get applied to incidents created by the StartIncident API action.
- notification
Targets List<ResponsePlan Notification Target Item> - The list of notification targets.
- summary String
- The summary string.
- impact number
- The impact value.
- title string
- The title string.
- dedupe
String string - The deduplication string.
- Response
Plan Tag[] - Tags that get applied to incidents created by the StartIncident API action.
- notification
Targets ResponsePlan Notification Target Item[] - 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.
- Sequence[Response
Plan Tag] - Tags that get applied to incidents created by the StartIncident API action.
- notification_
targets Sequence[ResponsePlan Notification Target Item] - The list of notification targets.
- summary str
- The summary string.
- impact Number
- The impact value.
- title String
- The title string.
- dedupe
String String - The deduplication string.
- List<Property Map>
- Tags that get applied to incidents created by the StartIncident API action.
- notification
Targets List<Property Map> - The list of notification targets.
- summary String
- The summary string.
ResponsePlanIntegration, ResponsePlanIntegrationArgs
ResponsePlanNotificationTargetItem, ResponsePlanNotificationTargetItemArgs
- Sns
Topic stringArn
- Sns
Topic stringArn
- sns
Topic StringArn
- sns
Topic stringArn
- sns_
topic_ strarn
- sns
Topic StringArn
ResponsePlanPagerDutyConfiguration, ResponsePlanPagerDutyConfigurationArgs
- Name string
- The name of the pagerDuty configuration.
- Pager
Duty Pulumi.Incident Configuration Aws Native. Ssm Incidents. Inputs. Response Plan Pager Duty Incident Configuration - Secret
Id string - The AWS secrets manager secretId storing the pagerDuty token.
- Name string
- The name of the pagerDuty configuration.
- Pager
Duty ResponseIncident Configuration Plan Pager Duty Incident Configuration - Secret
Id string - The AWS secrets manager secretId storing the pagerDuty token.
- name String
- The name of the pagerDuty configuration.
- pager
Duty ResponseIncident Configuration Plan Pager Duty Incident Configuration - secret
Id String - The AWS secrets manager secretId storing the pagerDuty token.
- name string
- The name of the pagerDuty configuration.
- pager
Duty ResponseIncident Configuration Plan Pager Duty Incident Configuration - secret
Id string - The AWS secrets manager secretId storing the pagerDuty token.
- name str
- The name of the pagerDuty configuration.
- pager_
duty_ Responseincident_ configuration Plan Pager Duty Incident Configuration - secret_
id str - The AWS secrets manager secretId storing the pagerDuty token.
- name String
- The name of the pagerDuty configuration.
- pager
Duty Property MapIncident Configuration - secret
Id String - The AWS secrets manager secretId storing the pagerDuty token.
ResponsePlanPagerDutyIncidentConfiguration, ResponsePlanPagerDutyIncidentConfigurationArgs
- Service
Id string - The pagerDuty serviceId.
- Service
Id string - The pagerDuty serviceId.
- service
Id String - The pagerDuty serviceId.
- service
Id string - The pagerDuty serviceId.
- service_
id str - The pagerDuty serviceId.
- service
Id String - The pagerDuty serviceId.
ResponsePlanSsmAutomation, ResponsePlanSsmAutomationArgs
- Document
Name string - The document name to use when starting the SSM automation document.
- Role
Arn string - The role ARN to use when starting the SSM automation document.
- Document
Version string - The version of the document to use when starting the SSM automation document.
- Dynamic
Parameters List<Pulumi.Aws Native. Ssm Incidents. Inputs. Response Plan Dynamic Ssm Parameter> - The parameters with dynamic values to set when starting the SSM automation document.
- Parameters
List<Pulumi.
Aws Native. Ssm Incidents. Inputs. Response Plan Ssm Parameter> - The parameters to set when starting the SSM automation document.
- Target
Account Pulumi.Aws Native. Ssm Incidents. Response Plan Ssm Automation Target Account - The account type to use when starting the SSM automation document.
- Document
Name string - The document name to use when starting the SSM automation document.
- Role
Arn string - The role ARN to use when starting the SSM automation document.
- Document
Version string - The version of the document to use when starting the SSM automation document.
- Dynamic
Parameters []ResponsePlan Dynamic Ssm Parameter - The parameters with dynamic values to set when starting the SSM automation document.
- Parameters
[]Response
Plan Ssm Parameter - The parameters to set when starting the SSM automation document.
- Target
Account ResponsePlan Ssm Automation Target Account - The account type to use when starting the SSM automation document.
- document
Name String - The document name to use when starting the SSM automation document.
- role
Arn String - The role ARN to use when starting the SSM automation document.
- document
Version String - The version of the document to use when starting the SSM automation document.
- dynamic
Parameters List<ResponsePlan Dynamic Ssm Parameter> - The parameters with dynamic values to set when starting the SSM automation document.
- parameters
List<Response
Plan Ssm Parameter> - The parameters to set when starting the SSM automation document.
- target
Account ResponsePlan Ssm Automation Target Account - The account type to use when starting the SSM automation document.
- document
Name string - The document name to use when starting the SSM automation document.
- role
Arn string - The role ARN to use when starting the SSM automation document.
- document
Version string - The version of the document to use when starting the SSM automation document.
- dynamic
Parameters ResponsePlan Dynamic Ssm Parameter[] - The parameters with dynamic values to set when starting the SSM automation document.
- parameters
Response
Plan Ssm Parameter[] - The parameters to set when starting the SSM automation document.
- target
Account ResponsePlan Ssm Automation Target Account - 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[ResponsePlan Dynamic Ssm Parameter] - The parameters with dynamic values to set when starting the SSM automation document.
- parameters
Sequence[Response
Plan Ssm Parameter] - The parameters to set when starting the SSM automation document.
- target_
account ResponsePlan Ssm Automation Target Account - The account type to use when starting the SSM automation document.
- document
Name String - The document name to use when starting the SSM automation document.
- role
Arn String - The role ARN to use when starting the SSM automation document.
- document
Version String - The version of the document to use when starting the SSM automation document.
- dynamic
Parameters 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.
- target
Account "IMPACTED_ACCOUNT" | "RESPONSE_PLAN_OWNER_ACCOUNT" - The account type to use when starting the SSM automation document.
ResponsePlanSsmAutomationTargetAccount, ResponsePlanSsmAutomationTargetAccountArgs
- Impacted
Account - IMPACTED_ACCOUNT
- Response
Plan Owner Account - RESPONSE_PLAN_OWNER_ACCOUNT
- Response
Plan Ssm Automation Target Account Impacted Account - IMPACTED_ACCOUNT
- Response
Plan Ssm Automation Target Account Response Plan Owner Account - RESPONSE_PLAN_OWNER_ACCOUNT
- Impacted
Account - IMPACTED_ACCOUNT
- Response
Plan Owner Account - RESPONSE_PLAN_OWNER_ACCOUNT
- Impacted
Account - IMPACTED_ACCOUNT
- Response
Plan Owner Account - RESPONSE_PLAN_OWNER_ACCOUNT
- IMPACTED_ACCOUNT
- IMPACTED_ACCOUNT
- RESPONSE_PLAN_OWNER_ACCOUNT
- RESPONSE_PLAN_OWNER_ACCOUNT
- "IMPACTED_ACCOUNT"
- IMPACTED_ACCOUNT
- "RESPONSE_PLAN_OWNER_ACCOUNT"
- RESPONSE_PLAN_OWNER_ACCOUNT
ResponsePlanSsmParameter, ResponsePlanSsmParameterArgs
ResponsePlanTag, ResponsePlanTagArgs
ResponsePlanVariableType, ResponsePlanVariableTypeArgs
- Incident
Record Arn - INCIDENT_RECORD_ARN
- Involved
Resources - INVOLVED_RESOURCES
- Response
Plan Variable Type Incident Record Arn - INCIDENT_RECORD_ARN
- Response
Plan Variable Type Involved Resources - INVOLVED_RESOURCES
- Incident
Record Arn - INCIDENT_RECORD_ARN
- Involved
Resources - INVOLVED_RESOURCES
- Incident
Record Arn - INCIDENT_RECORD_ARN
- Involved
Resources - INVOLVED_RESOURCES
- INCIDENT_RECORD_ARN
- INCIDENT_RECORD_ARN
- INVOLVED_RESOURCES
- INVOLVED_RESOURCES
- "INCIDENT_RECORD_ARN"
- INCIDENT_RECORD_ARN
- "INVOLVED_RESOURCES"
- INVOLVED_RESOURCES
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.