Package com.pulumi.aws.arcregionswitch

Class Plan

  • public class Plan
extends com.pulumi.resources.CustomResource
    Resource for managing an Amazon ARC Region Switch 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.iam.Role;
 import com.pulumi.aws.iam.RoleArgs;
 import com.pulumi.aws.arcregionswitch.Plan;
 import com.pulumi.aws.arcregionswitch.PlanArgs;
 import com.pulumi.aws.arcregionswitch.inputs.PlanWorkflowArgs;
 import com.pulumi.aws.arcregionswitch.inputs.PlanWorkflowStepArgs;
 import com.pulumi.aws.arcregionswitch.inputs.PlanWorkflowStepExecutionApprovalConfigArgs;
 import static com.pulumi.codegen.internal.Serialization.*;
 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 Role("example", RoleArgs.builder()
             .name("arc-region-switch-role")
             .assumeRolePolicy(serializeJson(
                 jsonObject(
                     jsonProperty("Version", "2012-10-17"),
                     jsonProperty("Statement", jsonArray(jsonObject(
                         jsonProperty("Action", "sts:AssumeRole"),
                         jsonProperty("Effect", "Allow"),
                         jsonProperty("Principal", jsonObject(
                             jsonProperty("Service", "arc-region-switch.amazonaws.com")
                         ))
                     )))
                 )))
             .build());
 
         var examplePlan = new Plan("examplePlan", PlanArgs.builder()
             .workflows(            
                 PlanWorkflowArgs.builder()
                     .steps(PlanWorkflowStepArgs.builder()
                         .executionApprovalConfigs(PlanWorkflowStepExecutionApprovalConfigArgs.builder()
                             .approvalRole(example.arn())
                             .timeoutMinutes(60)
                             .build())
                         .name("manual-approval")
                         .executionBlockType("ManualApproval")
                         .build())
                     .workflowTargetAction("activate")
                     .workflowTargetRegion("us-west-2")
                     .build(),
                 PlanWorkflowArgs.builder()
                     .steps(PlanWorkflowStepArgs.builder()
                         .executionApprovalConfigs(PlanWorkflowStepExecutionApprovalConfigArgs.builder()
                             .approvalRole(example.arn())
                             .timeoutMinutes(60)
                             .build())
                         .name("manual-approval")
                         .executionBlockType("ManualApproval")
                         .build())
                     .workflowTargetAction("deactivate")
                     .workflowTargetRegion("us-east-1")
                     .build())
             .name("example-plan")
             .executionRole(example.arn())
             .recoveryApproach("activePassive")
             .regions(            
                 "us-east-1",
                 "us-west-2")
             .primaryRegion("us-east-1")
             .build());
 
     }
 }
    ### Complex Usage with Multiple Step Types 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.arcregionswitch.Plan;
 import com.pulumi.aws.arcregionswitch.PlanArgs;
 import com.pulumi.aws.arcregionswitch.inputs.PlanAssociatedAlarmArgs;
 import com.pulumi.aws.arcregionswitch.inputs.PlanTriggerArgs;
 import com.pulumi.aws.arcregionswitch.inputs.PlanTriggerConditionArgs;
 import com.pulumi.aws.arcregionswitch.inputs.PlanWorkflowArgs;
 import com.pulumi.aws.arcregionswitch.inputs.PlanWorkflowStepArgs;
 import com.pulumi.aws.arcregionswitch.inputs.PlanWorkflowStepCustomActionLambdaConfigArgs;
 import com.pulumi.aws.arcregionswitch.inputs.PlanWorkflowStepCustomActionLambdaConfigLambdaArgs;
 import com.pulumi.aws.arcregionswitch.inputs.PlanWorkflowStepParallelConfigArgs;
 import com.pulumi.aws.arcregionswitch.inputs.PlanWorkflowStepParallelConfigStepArgs;
 import com.pulumi.aws.arcregionswitch.inputs.PlanWorkflowStepParallelConfigStepEc2AsgCapacityIncreaseConfigArgs;
 import com.pulumi.aws.arcregionswitch.inputs.PlanWorkflowStepParallelConfigStepEc2AsgCapacityIncreaseConfigAsgArgs;
 import com.pulumi.aws.arcregionswitch.inputs.PlanWorkflowStepParallelConfigStepEcsCapacityIncreaseConfigArgs;
 import com.pulumi.aws.arcregionswitch.inputs.PlanWorkflowStepParallelConfigStepEcsCapacityIncreaseConfigServiceArgs;
 import com.pulumi.aws.arcregionswitch.inputs.PlanWorkflowStepRoute53HealthCheckConfigArgs;
 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 complex = new Plan("complex", PlanArgs.builder()
             .associatedAlarms(PlanAssociatedAlarmArgs.builder()
                 .name("application-health-alarm")
                 .alarmType("applicationHealth")
                 .resourceIdentifier("arn:aws:cloudwatch:us-east-1:123456789012:alarm:MyAlarm")
                 .build())
             .triggers(PlanTriggerArgs.builder()
                 .conditions(PlanTriggerConditionArgs.builder()
                     .associatedAlarmName("application-health-alarm")
                     .condition("red")
                     .build())
                 .action("activate")
                 .targetRegion("us-west-2")
                 .minDelayMinutesBetweenExecutions(30)
                 .build())
             .workflows(            
                 PlanWorkflowArgs.builder()
                     .steps(                    
                         PlanWorkflowStepArgs.builder()
                             .customActionLambdaConfigs(PlanWorkflowStepCustomActionLambdaConfigArgs.builder()
                                 .lambdas(PlanWorkflowStepCustomActionLambdaConfigLambdaArgs.builder()
                                     .arn(example.arn())
                                     .build())
                                 .regionToRun("activatingRegion")
                                 .retryIntervalMinutes(5.0)
                                 .timeoutMinutes(30)
                                 .build())
                             .name("lambda-step")
                             .executionBlockType("CustomActionLambda")
                             .build(),
                         PlanWorkflowStepArgs.builder()
                             .parallelConfigs(PlanWorkflowStepParallelConfigArgs.builder()
                                 .steps(                                
                                     PlanWorkflowStepParallelConfigStepArgs.builder()
                                         .ec2AsgCapacityIncreaseConfigs(PlanWorkflowStepParallelConfigStepEc2AsgCapacityIncreaseConfigArgs.builder()
                                             .asgs(PlanWorkflowStepParallelConfigStepEc2AsgCapacityIncreaseConfigAsgArgs.builder()
                                                 .arn(exampleAwsAutoscalingGroup.arn())
                                                 .build())
                                             .targetPercent(150)
                                             .build())
                                         .name("asg-scaling")
                                         .executionBlockType("EC2AutoScaling")
                                         .build(),
                                     PlanWorkflowStepParallelConfigStepArgs.builder()
                                         .ecsCapacityIncreaseConfigs(PlanWorkflowStepParallelConfigStepEcsCapacityIncreaseConfigArgs.builder()
                                             .services(PlanWorkflowStepParallelConfigStepEcsCapacityIncreaseConfigServiceArgs.builder()
                                                 .clusterArn(exampleAwsEcsCluster.arn())
                                                 .serviceArn(exampleAwsEcsService.arn())
                                                 .build())
                                             .targetPercent(200)
                                             .build())
                                         .name("ecs-scaling")
                                         .executionBlockType("ECSServiceScaling")
                                         .build())
                                 .build())
                             .name("parallel-step")
                             .executionBlockType("Parallel")
                             .build())
                     .workflowTargetAction("activate")
                     .workflowTargetRegion("us-west-2")
                     .build(),
                 PlanWorkflowArgs.builder()
                     .steps(PlanWorkflowStepArgs.builder()
                         .route53HealthCheckConfigs(PlanWorkflowStepRoute53HealthCheckConfigArgs.builder()
                             .hostedZoneId(exampleAwsRoute53Zone.zoneId())
                             .recordName("api.example.com")
                             .build())
                         .name("route53-health-check")
                         .executionBlockType("Route53HealthCheck")
                         .build())
                     .workflowTargetAction("deactivate")
                     .workflowTargetRegion("us-east-1")
                     .build())
             .name("complex-plan")
             .executionRole(exampleAwsIamRole.arn())
             .recoveryApproach("activeActive")
             .regions(            
                 "us-east-1",
                 "us-west-2")
             .description("Complex plan with multiple execution block types")
             .recoveryTimeObjectiveMinutes(60)
             .tags(Map.of("Environment", "production"))
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required - `arn` (String) ARN of the ARC Region Switch Plan. Using `pulumi import`, import Application Recovery Controller Region Switch Plan using the `arn`. For example: ```sh $ pulumi import aws:arcregionswitch/plan:Plan example arn:aws:arcregionswitch:us-east-1:123456789012:plan/example-plan ```

    • 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> arn()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<PlanAssociatedAlarm>>> associatedAlarms()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.lang.String> executionRole()  
      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> name()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> primaryRegion()  
      com.pulumi.core.Output<java.lang.String> recoveryApproach()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> recoveryTimeObjectiveMinutes()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> regions()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<PlanReportConfiguration>>> reportConfigurations()  
      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()  
      com.pulumi.core.Output<java.util.Optional<PlanTimeouts>> timeouts()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<PlanTrigger>>> triggers()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<PlanWorkflow>>> workflows()  

      • 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

      • arn

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

      • associatedAlarms

        public com.pulumi.core.Output<java.util.Optional<java.util.List<PlanAssociatedAlarm>>> associatedAlarms()
        Returns:
        CloudWatch alarms associated with the plan. See `associatedAlarms` Block for details.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of the plan.

      • executionRole

        public com.pulumi.core.Output<java.lang.String> executionRole()
        Returns:
        ARN of the IAM role that ARC Region Switch will assume to execute the plan.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the plan. Must be unique within the account.

      • primaryRegion

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> primaryRegion()
        Returns:
        Primary region for the plan.

      • recoveryApproach

        public com.pulumi.core.Output<java.lang.String> recoveryApproach()
        Returns:
        Recovery approach for the plan. Valid values: `activeActive`, `activePassive`.

      • recoveryTimeObjectiveMinutes

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> recoveryTimeObjectiveMinutes()
        Returns:
        Recovery time objective in minutes.

      • 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.

      • regions

        public com.pulumi.core.Output<java.util.List<java.lang.String>> regions()
        Returns:
        List of AWS regions involved in the plan. Must contain at least 2 regions.

      • reportConfigurations

        public com.pulumi.core.Output<java.util.Optional<java.util.List<PlanReportConfiguration>>> reportConfigurations()
        Returns:
        Configuration for automated execution reports. See `reportConfiguration` Block for details.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

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

      • timeouts

        public com.pulumi.core.Output<java.util.Optional<PlanTimeouts>> timeouts()

      • triggers

        public com.pulumi.core.Output<java.util.Optional<java.util.List<PlanTrigger>>> triggers()
        Returns:
        Triggers that can initiate the plan execution. See `triggers` Block for details.

      • workflows

        public com.pulumi.core.Output<java.util.Optional<java.util.List<PlanWorkflow>>> workflows()
        Returns:
        Workflows that define the steps to execute. See `workflow` Block for details. The following arguments are optional:

      • 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.