Package com.pulumi.aws.ssmincidents

Class ResponsePlan

  • public class ResponsePlan
extends com.pulumi.resources.CustomResource
    Provides a resource to manage response plans in AWS Systems Manager Incident Manager. > NOTE: A response plan implicitly depends on a replication set. If you configured your replication set in Pulumi, we recommend you add it to the `dependsOn` argument for the ResponsePlan Resource. ## Example Usage ### Basic Usage 
     
 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.ArrayList;
 import java.util.Arrays;
 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()
             .incidentTemplate(ResponsePlanIncidentTemplateArgs.builder()
                 .title("title")
                 .impact(3)
                 .build())
             .name("name")
             .tags(Map.of("key", "value"))
             .build(), CustomResourceOptions.builder()
                 .dependsOn(exampleAwsSsmincidentsReplicationSet)
                 .build());
 
     }
 }
    ### Usage With All Fields 
     
 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.ResponsePlanIncidentTemplateNotificationTargetArgs;
 import com.pulumi.aws.ssmincidents.inputs.ResponsePlanActionArgs;
 import com.pulumi.aws.ssmincidents.inputs.ResponsePlanActionSsmAutomationArgs;
 import com.pulumi.aws.ssmincidents.inputs.ResponsePlanActionSsmAutomationParameterArgs;
 import com.pulumi.aws.ssmincidents.inputs.ResponsePlanIntegrationArgs;
 import com.pulumi.aws.ssmincidents.inputs.ResponsePlanIntegrationPagerdutyArgs;
 import com.pulumi.resources.CustomResourceOptions;
 import java.util.ArrayList;
 import java.util.Arrays;
 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()
             .incidentTemplate(ResponsePlanIncidentTemplateArgs.builder()
                 .notificationTargets(                
                     ResponsePlanIncidentTemplateNotificationTargetArgs.builder()
                         .snsTopicArn(example1.arn())
                         .build(),
                     ResponsePlanIncidentTemplateNotificationTargetArgs.builder()
                         .snsTopicArn(example2.arn())
                         .build())
                 .title("title")
                 .impact(3)
                 .dedupeString("dedupe")
                 .incidentTags(Map.of("key", "value"))
                 .summary("summary")
                 .build())
             .action(ResponsePlanActionArgs.builder()
                 .ssmAutomations(ResponsePlanActionSsmAutomationArgs.builder()
                     .parameters(                    
                         ResponsePlanActionSsmAutomationParameterArgs.builder()
                             .name("key")
                             .values(                            
                                 "value1",
                                 "value2")
                             .build(),
                         ResponsePlanActionSsmAutomationParameterArgs.builder()
                             .name("foo")
                             .values("bar")
                             .build())
                     .documentName(document1.name())
                     .roleArn(role1.arn())
                     .documentVersion("version1")
                     .targetAccount("RESPONSE_PLAN_OWNER_ACCOUNT")
                     .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())
             .name("name")
             .displayName("display name")
             .chatChannels(topic.arn())
             .engagements("arn:aws:ssm-contacts:us-east-2:111122223333:contact/test1")
             .tags(Map.of("key", "value"))
             .build(), CustomResourceOptions.builder()
                 .dependsOn(exampleAwsSsmincidentsReplicationSet)
                 .build());
 
     }
 }
    ## 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: ```sh $ pulumi import aws:ssmincidents/responsePlan:ResponsePlan responsePlanName ARNValue ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<ResponsePlanAction>> action()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> chatChannels()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> displayName()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> engagements()  
      static ResponsePlan get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ResponsePlanState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<ResponsePlanIncidentTemplate> incidentTemplate()  
      com.pulumi.core.Output<java.util.Optional<ResponsePlanIntegration>> integration()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ResponsePlan

        public ResponsePlan​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • ResponsePlan

        public ResponsePlan​(java.lang.String name,
                    ResponsePlanArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • ResponsePlan

        public ResponsePlan​(java.lang.String name,
                    ResponsePlanArgs args,
                    @Nullable
                    com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • action

        public com.pulumi.core.Output<java.util.Optional<ResponsePlanAction>> action()
        Returns:
        The actions that the response plan starts at the beginning of an incident.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        The ARN of the response plan.

      • chatChannels

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> chatChannels()
        Returns:
        The Chatbot chat channel used for collaboration during an incident.

      • displayName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> displayName()
        Returns:
        The long format of the response plan name. This field can contain spaces.

      • engagements

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> engagements()
        Returns:
        ARN for the contacts and escalation plans that the response plan engages during an incident.

      • incidentTemplate

        public com.pulumi.core.Output<ResponsePlanIncidentTemplate> incidentTemplate()
        Returns:
        The `incidentTemplate` configuration block is required and supports the following arguments:

      • integration

        public com.pulumi.core.Output<java.util.Optional<ResponsePlanIntegration>> integration()
        Returns:
        Information about third-party services integrated into the response plan. The following values are supported:

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name of the response plan.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        The tags applied to the response plan.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

        public static ResponsePlan get​(java.lang.String name,
                               com.pulumi.core.Output<java.lang.String> id,
                               @Nullable
                               ResponsePlanState state,
                               @Nullable
                               com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.