Class Plan


  • public class Plan
    extends com.pulumi.resources.CustomResource
    Resource for managing an AWS SSM Contact Plan. ## Example Usage ### Basic Usage
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.ssmcontacts.Plan;
     import com.pulumi.aws.ssmcontacts.PlanArgs;
     import com.pulumi.aws.ssmcontacts.inputs.PlanStageArgs;
     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 Plan("example", PlanArgs.builder()
                 .stages(PlanStageArgs.builder()
                     .durationInMinutes(1)
                     .build())
                 .contactId("arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias")
                 .build());
     
         }
     }
     
     
    ### Usage with SSM Contact
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.ssmcontacts.Contact;
     import com.pulumi.aws.ssmcontacts.ContactArgs;
     import com.pulumi.aws.ssmcontacts.Plan;
     import com.pulumi.aws.ssmcontacts.PlanArgs;
     import com.pulumi.aws.ssmcontacts.inputs.PlanStageArgs;
     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 contact = new Contact("contact", ContactArgs.builder()
                 .alias("alias")
                 .type("PERSONAL")
                 .build());
     
             var plan = new Plan("plan", PlanArgs.builder()
                 .stages(PlanStageArgs.builder()
                     .durationInMinutes(1)
                     .build())
                 .contactId(contact.arn())
                 .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.ssmcontacts.Contact;
     import com.pulumi.aws.ssmcontacts.ContactArgs;
     import com.pulumi.aws.ssmcontacts.Plan;
     import com.pulumi.aws.ssmcontacts.PlanArgs;
     import com.pulumi.aws.ssmcontacts.inputs.PlanStageArgs;
     import com.pulumi.aws.ssmcontacts.inputs.PlanStageTargetArgs;
     import com.pulumi.aws.ssmcontacts.inputs.PlanStageTargetContactTargetInfoArgs;
     import com.pulumi.aws.ssmcontacts.inputs.PlanStageTargetChannelTargetInfoArgs;
     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 escalationPlan = new Contact("escalationPlan", ContactArgs.builder()
                 .alias("escalation-plan-alias")
                 .type("ESCALATION")
                 .build());
     
             var contactOne = new Contact("contactOne", ContactArgs.builder()
                 .alias("alias")
                 .type("PERSONAL")
                 .build());
     
             var contactTwo = new Contact("contactTwo", ContactArgs.builder()
                 .alias("alias")
                 .type("PERSONAL")
                 .build());
     
             var test = new Plan("test", PlanArgs.builder()
                 .stages(PlanStageArgs.builder()
                     .targets(                
                         PlanStageTargetArgs.builder()
                             .contactTargetInfo(PlanStageTargetContactTargetInfoArgs.builder()
                                 .isEssential(false)
                                 .contactId(contactOne.arn())
                                 .build())
                             .build(),
                         PlanStageTargetArgs.builder()
                             .contactTargetInfo(PlanStageTargetContactTargetInfoArgs.builder()
                                 .isEssential(true)
                                 .contactId(contactTwo.arn())
                                 .build())
                             .build(),
                         PlanStageTargetArgs.builder()
                             .channelTargetInfo(PlanStageTargetChannelTargetInfoArgs.builder()
                                 .retryIntervalInMinutes(2)
                                 .contactChannelId(channel.arn())
                                 .build())
                             .build())
                     .durationInMinutes(0)
                     .build())
                 .contactId(escalationPlan.arn())
                 .build());
     
         }
     }
     
     
    ## Import Using `pulumi import`, import SSM Contact Plan using the Contact ARN. For example: ```sh $ pulumi import aws:ssmcontacts/plan:Plan example {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
    • Constructor Summary

      Constructors 
      Constructor Description
      Plan​(java.lang.String name)  
      Plan​(java.lang.String name, PlanArgs args)  
      Plan​(java.lang.String name, PlanArgs args, com.pulumi.resources.CustomResourceOptions options)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> contactId()  
      static Plan get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, PlanState 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<java.lang.String> region()  
      com.pulumi.core.Output<java.util.List<PlanStage>> stages()  
      • 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

      • Plan

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

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

        public Plan​(java.lang.String name,
                    PlanArgs 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

      • contactId

        public com.pulumi.core.Output<java.lang.String> contactId()
        Returns:
        The ARN of the contact or escalation 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.
      • stages

        public com.pulumi.core.Output<java.util.List<PlanStage>> stages()
        Returns:
        One or more configuration blocks for specifying a list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods. See Stage below for more details.
      • get

        public static Plan get​(java.lang.String name,
                               com.pulumi.core.Output<java.lang.String> id,
                               @Nullable
                               PlanState 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.