Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. ssmincidents
  5. getResponsePlan
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.ssmincidents.getResponsePlan

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

    Use this data source to manage a response plan in AWS Systems Manager Incident Manager.

    Example Usage

    Basic Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  example:
    type: aws:ssmincidents:ResponsePlan
    properties:
      arn: exampleARN

    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.

    function getResponsePlan(args: GetResponsePlanArgs, opts?: InvokeOptions): Promise<GetResponsePlanResult>
function getResponsePlanOutput(args: GetResponsePlanOutputArgs, opts?: InvokeOptions): Output<GetResponsePlanResult>
    def get_response_plan(arn: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None,
                      opts: Optional[InvokeOptions] = None) -> GetResponsePlanResult
def get_response_plan_output(arn: Optional[pulumi.Input[str]] = None,
                      tags: Optional[pulumi.Input[Mapping[str, 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)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws:ssmincidents/getResponsePlan:getResponsePlan
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    The Amazon Resource Name (ARN) of the response plan.
    Tags Dictionary<string, string>
    The tags applied to the response plan.
    Arn string
    The Amazon Resource Name (ARN) of the response plan.
    Tags map[string]string
    The tags applied to the response plan.
    arn String
    The Amazon Resource Name (ARN) of the response plan.
    tags Map<String,String>
    The tags applied to the response plan.
    arn string
    The Amazon Resource Name (ARN) of the response plan.
    tags {[key: string]: string}
    The tags applied to the response plan.
    arn str
    The Amazon Resource Name (ARN) of the response plan.
    tags Mapping[str, str]
    The tags applied to the response plan.
    arn String
    The Amazon Resource Name (ARN) of the response plan.
    tags Map<String>
    The tags applied to the response plan.

    getResponsePlan Result

    The following output properties are available:

    Actions List<GetResponsePlanAction>
    (Optional) The actions that the response plan starts at the beginning of an incident.
    Arn string
    ChatChannels List<string>
    The Chatbot chat channel used for collaboration during an incident.
    DisplayName string
    The long format of the response plan name. This field can contain spaces.
    Engagements List<string>
    The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
    Id string
    The provider-assigned unique ID for this managed resource.
    IncidentTemplates List<GetResponsePlanIncidentTemplate>
    Integrations List<GetResponsePlanIntegration>
    Information about third-party services integrated into the response plan. The following values are supported:
    Name string
    The name of the PagerDuty configuration.
    Tags Dictionary<string, string>
    The tags applied to the response plan.
    Actions []GetResponsePlanAction
    (Optional) The actions that the response plan starts at the beginning of an incident.
    Arn string
    ChatChannels []string
    The Chatbot chat channel used for collaboration during an incident.
    DisplayName string
    The long format of the response plan name. This field can contain spaces.
    Engagements []string
    The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
    Id string
    The provider-assigned unique ID for this managed resource.
    IncidentTemplates []GetResponsePlanIncidentTemplate
    Integrations []GetResponsePlanIntegration
    Information about third-party services integrated into the response plan. The following values are supported:
    Name string
    The name of the PagerDuty configuration.
    Tags map[string]string
    The tags applied to the response plan.
    actions List<GetResponsePlanAction>
    (Optional) The actions that the response plan starts at the beginning of an incident.
    arn String
    chatChannels List<String>
    The Chatbot chat channel used for collaboration during an incident.
    displayName String
    The long format of the response plan name. This field can contain spaces.
    engagements List<String>
    The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
    id String
    The provider-assigned unique ID for this managed resource.
    incidentTemplates List<GetResponsePlanIncidentTemplate>
    integrations List<GetResponsePlanIntegration>
    Information about third-party services integrated into the response plan. The following values are supported:
    name String
    The name of the PagerDuty configuration.
    tags Map<String,String>
    The tags applied to the response plan.
    actions GetResponsePlanAction[]
    (Optional) The actions that the response plan starts at the beginning of an incident.
    arn string
    chatChannels string[]
    The Chatbot chat channel used for collaboration during an incident.
    displayName string
    The long format of the response plan name. This field can contain spaces.
    engagements string[]
    The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
    id string
    The provider-assigned unique ID for this managed resource.
    incidentTemplates GetResponsePlanIncidentTemplate[]
    integrations GetResponsePlanIntegration[]
    Information about third-party services integrated into the response plan. The following values are supported:
    name string
    The name of the PagerDuty configuration.
    tags {[key: string]: string}
    The tags applied to the response plan.
    actions Sequence[GetResponsePlanAction]
    (Optional) The actions that the response plan starts at the beginning of an incident.
    arn str
    chat_channels Sequence[str]
    The Chatbot chat channel used for collaboration during an incident.
    display_name str
    The long format of the response plan name. This field can contain spaces.
    engagements Sequence[str]
    The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
    id str
    The provider-assigned unique ID for this managed resource.
    incident_templates Sequence[GetResponsePlanIncidentTemplate]
    integrations Sequence[GetResponsePlanIntegration]
    Information about third-party services integrated into the response plan. The following values are supported:
    name str
    The name of the PagerDuty configuration.
    tags Mapping[str, str]
    The tags applied to the response plan.
    actions List<Property Map>
    (Optional) The actions that the response plan starts at the beginning of an incident.
    arn String
    chatChannels List<String>
    The Chatbot chat channel used for collaboration during an incident.
    displayName String
    The long format of the response plan name. This field can contain spaces.
    engagements List<String>
    The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
    id String
    The provider-assigned unique ID for this managed resource.
    incidentTemplates List<Property Map>
    integrations List<Property Map>
    Information about third-party services integrated into the response plan. The following values are supported:
    name String
    The name of the PagerDuty configuration.
    tags Map<String>
    The tags applied to the response plan.

    Supporting Types

    GetResponsePlanAction

    SsmAutomations List<GetResponsePlanActionSsmAutomation>
    The Systems Manager automation document to start as the runbook at the beginning of the incident. The following values are supported:
    SsmAutomations []GetResponsePlanActionSsmAutomation
    The Systems Manager automation document to start as the runbook at the beginning of the incident. The following values are supported:
    ssmAutomations List<GetResponsePlanActionSsmAutomation>
    The Systems Manager automation document to start as the runbook at the beginning of the incident. The following values are supported:
    ssmAutomations GetResponsePlanActionSsmAutomation[]
    The Systems Manager automation document to start as the runbook at the beginning of the incident. The following values are supported:
    ssm_automations Sequence[GetResponsePlanActionSsmAutomation]
    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:

    GetResponsePlanActionSsmAutomation

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

    GetResponsePlanActionSsmAutomationParameter

    Name string
    The name of the PagerDuty configuration.
    Values List<string>
    The values for the associated parameter name.
    Name string
    The name of the PagerDuty configuration.
    Values []string
    The values for the associated parameter name.
    name String
    The name of the PagerDuty configuration.
    values List<String>
    The values for the associated parameter name.
    name string
    The name of the PagerDuty configuration.
    values string[]
    The values for the associated parameter name.
    name str
    The name of the PagerDuty configuration.
    values Sequence[str]
    The values for the associated parameter name.
    name String
    The name of the PagerDuty configuration.
    values List<String>
    The values for the associated parameter name.

    GetResponsePlanIncidentTemplate

    DedupeString string
    A string used to stop Incident Manager from creating multiple incident records for the same incident.
    Impact int
    The impact value of a generated incident. The following values are supported:
    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<GetResponsePlanIncidentTemplateNotificationTarget>
    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.
    Title 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.
    Impact int
    The impact value of a generated incident. The following values are supported:
    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 []GetResponsePlanIncidentTemplateNotificationTarget
    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.
    Title 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.
    impact Integer
    The impact value of a generated incident. The following values are supported:
    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<GetResponsePlanIncidentTemplateNotificationTarget>
    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.
    title 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.
    impact number
    The impact value of a generated incident. The following values are supported:
    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 GetResponsePlanIncidentTemplateNotificationTarget[]
    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.
    title string
    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.
    impact int
    The impact value of a generated incident. The following values are supported:
    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[GetResponsePlanIncidentTemplateNotificationTarget]
    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.
    title str
    The title of a generated incident.
    dedupeString String
    A string used to stop Incident Manager from creating multiple incident records for the same incident.
    impact Number
    The impact value of a generated incident. The following values are supported:
    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.
    title String
    The title of a generated incident.

    GetResponsePlanIncidentTemplateNotificationTarget

    SnsTopicArn string
    The ARN of the Amazon SNS topic.
    SnsTopicArn string
    The ARN of the Amazon SNS topic.
    snsTopicArn String
    The ARN of the Amazon SNS topic.
    snsTopicArn string
    The ARN of the Amazon SNS topic.
    sns_topic_arn str
    The ARN of the Amazon SNS topic.
    snsTopicArn String
    The ARN of the Amazon SNS topic.

    GetResponsePlanIntegration

    Pagerduties List<GetResponsePlanIntegrationPagerduty>
    Details about the PagerDuty configuration for a response plan. The following values are supported:
    Pagerduties []GetResponsePlanIntegrationPagerduty
    Details about the PagerDuty configuration for a response plan. The following values are supported:
    pagerduties List<GetResponsePlanIntegrationPagerduty>
    Details about the PagerDuty configuration for a response plan. The following values are supported:
    pagerduties GetResponsePlanIntegrationPagerduty[]
    Details about the PagerDuty configuration for a response plan. The following values are supported:
    pagerduties Sequence[GetResponsePlanIntegrationPagerduty]
    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:

    GetResponsePlanIntegrationPagerduty

    Name string
    The name of the PagerDuty configuration.
    SecretId 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.
    ServiceId string
    The ID of the PagerDuty service that the response plan associates with an incident when it launches.
    Name string
    The name of the PagerDuty configuration.
    SecretId 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.
    ServiceId string
    The ID of the PagerDuty service that the response plan associates with an incident when it launches.
    name String
    The name of the PagerDuty configuration.
    secretId 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.
    serviceId String
    The ID of the PagerDuty service that the response plan associates with an incident when it launches.
    name string
    The name of the PagerDuty configuration.
    secretId 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.
    serviceId string
    The ID of the PagerDuty service that the response plan associates with an incident when it launches.
    name str
    The name of the PagerDuty configuration.
    secret_id 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.
    service_id str
    The ID of the PagerDuty service that the response plan associates with an incident when it launches.
    name String
    The name of the PagerDuty configuration.
    secretId 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.
    serviceId String
    The ID of the PagerDuty service that the response plan associates with an incident when it launches.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws