1. Packages
  2. AWS Native
  3. API Docs
  4. ssmincidents
  5. getResponsePlan

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.ssmincidents.getResponsePlan

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

    Resource type definition for AWS::SSMIncidents::ResponsePlan

    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,
                          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)
    // Output-based functions aren't available in Java yet
    
    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 []ResponsePlanAction
    The list of actions.
    Arn string
    The ARN of the response plan.
    ChatChannel ResponsePlanChatChannel
    DisplayName string
    The display name of the response plan.
    Engagements []string
    The list of engagements to use.
    IncidentTemplate ResponsePlanIncidentTemplate
    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
    displayName String
    The display name of the response plan.
    engagements List<String>
    The list of engagements to use.
    incidentTemplate ResponsePlanIncidentTemplate
    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
    displayName string
    The display name of the response plan.
    engagements string[]
    The list of engagements to use.
    incidentTemplate ResponsePlanIncidentTemplate
    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
    display_name str
    The display name of the response plan.
    engagements Sequence[str]
    The list of engagements to use.
    incident_template ResponsePlanIncidentTemplate
    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
    displayName String
    The display name of the response plan.
    engagements List<String>
    The list of engagements to use.
    incidentTemplate Property Map
    integrations List<Property Map>
    The list of integrations.
    tags List<Property Map>
    The tags to apply to the response plan.

    Supporting Types

    ResponsePlanAction

    ResponsePlanChatChannel

    ChatbotSns List<string>
    ChatbotSns []string
    chatbotSns List<String>
    chatbotSns string[]
    chatbot_sns Sequence[str]
    chatbotSns List<String>

    ResponsePlanDynamicSsmParameter

    ResponsePlanDynamicSsmParameterValue

    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

    ResponsePlanNotificationTargetItem

    ResponsePlanPagerDutyConfiguration

    Name string
    The name of the pagerDuty configuration.
    PagerDutyIncidentConfiguration Pulumi.AwsNative.SsmIncidents.Inputs.ResponsePlanPagerDutyIncidentConfiguration
    SecretId string
    The AWS secrets manager secretId storing the pagerDuty token.
    Name string
    The name of the pagerDuty configuration.
    PagerDutyIncidentConfiguration ResponsePlanPagerDutyIncidentConfiguration
    SecretId string
    The AWS secrets manager secretId storing the pagerDuty token.
    name String
    The name of the pagerDuty configuration.
    pagerDutyIncidentConfiguration ResponsePlanPagerDutyIncidentConfiguration
    secretId String
    The AWS secrets manager secretId storing the pagerDuty token.
    name string
    The name of the pagerDuty configuration.
    pagerDutyIncidentConfiguration ResponsePlanPagerDutyIncidentConfiguration
    secretId string
    The AWS secrets manager secretId storing the pagerDuty token.
    name str
    The name of the pagerDuty configuration.
    pager_duty_incident_configuration ResponsePlanPagerDutyIncidentConfiguration
    secret_id str
    The AWS secrets manager secretId storing the pagerDuty token.
    name String
    The name of the pagerDuty configuration.
    pagerDutyIncidentConfiguration Property Map
    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
    Values List<string>
    Key string
    Values []string
    key String
    values List<String>
    key string
    values string[]
    key str
    values Sequence[str]
    key String
    values List<String>

    ResponsePlanTag

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    ResponsePlanVariableType

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi