Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. arcregionswitch
  5. getPlan

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.32.0 published on Wednesday, Aug 13, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.arcregionswitch.getPlan

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.32.0 published on Wednesday, Aug 13, 2025 by Pulumi
pulumi/pulumi-aws-native

    Represents a plan that specifies Regions, IAM roles, and workflows of logic required to perform the desired change to your multi-Region application

    Using getPlan

    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 getPlan(args: GetPlanArgs, opts?: InvokeOptions): Promise<GetPlanResult>
function getPlanOutput(args: GetPlanOutputArgs, opts?: InvokeOptions): Output<GetPlanResult>
    def get_plan(arn: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetPlanResult
def get_plan_output(arn: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetPlanResult]
    func LookupPlan(ctx *Context, args *LookupPlanArgs, opts ...InvokeOption) (*LookupPlanResult, error)
func LookupPlanOutput(ctx *Context, args *LookupPlanOutputArgs, opts ...InvokeOption) LookupPlanResultOutput

    > Note: This function is named LookupPlan in the Go SDK.

    public static class GetPlan 
{
    public static Task<GetPlanResult> InvokeAsync(GetPlanArgs args, InvokeOptions? opts = null)
    public static Output<GetPlanResult> Invoke(GetPlanInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPlanResult> getPlan(GetPlanArgs args, InvokeOptions options)
public static Output<GetPlanResult> getPlan(GetPlanArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:arcregionswitch:getPlan
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    The Amazon Resource Name (ARN) of the plan.
    Arn string
    The Amazon Resource Name (ARN) of the plan.
    arn String
    The Amazon Resource Name (ARN) of the plan.
    arn string
    The Amazon Resource Name (ARN) of the plan.
    arn str
    The Amazon Resource Name (ARN) of the plan.
    arn String
    The Amazon Resource Name (ARN) of the plan.

    getPlan Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the plan.
    AssociatedAlarms Dictionary<string, Pulumi.AwsNative.ArcRegionSwitch.Outputs.PlanAssociatedAlarm>
    The associated application health alarms for a plan.
    Description string
    The description for a plan.
    ExecutionRole string
    The execution role for a plan.
    HealthChecksForPlan Dictionary<string, ImmutableArray<Pulumi.AwsNative.ArcRegionSwitch.Outputs.PlanHealthCheckState>>
    Represents a Region switch plan. A plan defines the steps required to shift traffic from one AWS Region to another.
    Owner string
    The owner of a plan.
    RecoveryTimeObjectiveMinutes double
    The recovery time objective for a plan.
    Route53HealthChecks Pulumi.AwsNative.ArcRegionSwitch.Outputs.Route53HealthChecksProperties
    Tags Dictionary<string, string>
    Triggers List<Pulumi.AwsNative.ArcRegionSwitch.Outputs.PlanTrigger>
    The triggers for a plan.
    Version string
    The version for the plan.
    Workflows List<Pulumi.AwsNative.ArcRegionSwitch.Outputs.PlanWorkflow>
    The workflows for a plan.
    Arn string
    The Amazon Resource Name (ARN) of the plan.
    AssociatedAlarms map[string]PlanAssociatedAlarm
    The associated application health alarms for a plan.
    Description string
    The description for a plan.
    ExecutionRole string
    The execution role for a plan.
    HealthChecksForPlan map[string][]PlanHealthCheckState
    Represents a Region switch plan. A plan defines the steps required to shift traffic from one AWS Region to another.
    Owner string
    The owner of a plan.
    RecoveryTimeObjectiveMinutes float64
    The recovery time objective for a plan.
    Route53HealthChecks Route53HealthChecksProperties
    Tags map[string]string
    Triggers []PlanTrigger
    The triggers for a plan.
    Version string
    The version for the plan.
    Workflows []PlanWorkflow
    The workflows for a plan.
    arn String
    The Amazon Resource Name (ARN) of the plan.
    associatedAlarms Map<String,PlanAssociatedAlarm>
    The associated application health alarms for a plan.
    description String
    The description for a plan.
    executionRole String
    The execution role for a plan.
    healthChecksForPlan Map<String,List<PlanHealthCheckState>>
    Represents a Region switch plan. A plan defines the steps required to shift traffic from one AWS Region to another.
    owner String
    The owner of a plan.
    recoveryTimeObjectiveMinutes Double
    The recovery time objective for a plan.
    route53HealthChecks Route53HealthChecksProperties
    tags Map<String,String>
    triggers List<PlanTrigger>
    The triggers for a plan.
    version String
    The version for the plan.
    workflows List<PlanWorkflow>
    The workflows for a plan.
    arn string
    The Amazon Resource Name (ARN) of the plan.
    associatedAlarms {[key: string]: PlanAssociatedAlarm}
    The associated application health alarms for a plan.
    description string
    The description for a plan.
    executionRole string
    The execution role for a plan.
    healthChecksForPlan {[key: string]: PlanHealthCheckState[]}
    Represents a Region switch plan. A plan defines the steps required to shift traffic from one AWS Region to another.
    owner string
    The owner of a plan.
    recoveryTimeObjectiveMinutes number
    The recovery time objective for a plan.
    route53HealthChecks Route53HealthChecksProperties
    tags {[key: string]: string}
    triggers PlanTrigger[]
    The triggers for a plan.
    version string
    The version for the plan.
    workflows PlanWorkflow[]
    The workflows for a plan.
    arn str
    The Amazon Resource Name (ARN) of the plan.
    associated_alarms Mapping[str, PlanAssociatedAlarm]
    The associated application health alarms for a plan.
    description str
    The description for a plan.
    execution_role str
    The execution role for a plan.
    health_checks_for_plan Mapping[str, Sequence[PlanHealthCheckState]]
    Represents a Region switch plan. A plan defines the steps required to shift traffic from one AWS Region to another.
    owner str
    The owner of a plan.
    recovery_time_objective_minutes float
    The recovery time objective for a plan.
    route53_health_checks Route53HealthChecksProperties
    tags Mapping[str, str]
    triggers Sequence[PlanTrigger]
    The triggers for a plan.
    version str
    The version for the plan.
    workflows Sequence[PlanWorkflow]
    The workflows for a plan.
    arn String
    The Amazon Resource Name (ARN) of the plan.
    associatedAlarms Map<Property Map>
    The associated application health alarms for a plan.
    description String
    The description for a plan.
    executionRole String
    The execution role for a plan.
    healthChecksForPlan Map<List<Property Map>>
    Represents a Region switch plan. A plan defines the steps required to shift traffic from one AWS Region to another.
    owner String
    The owner of a plan.
    recoveryTimeObjectiveMinutes Number
    The recovery time objective for a plan.
    route53HealthChecks Property Map
    tags Map<String>
    triggers List<Property Map>
    The triggers for a plan.
    version String
    The version for the plan.
    workflows List<Property Map>
    The workflows for a plan.

    Supporting Types

    PlanAlarmCondition

    PlanAlarmType

    PlanArcRoutingControlConfiguration

    RegionAndRoutingControls Dictionary<string, object>
    CrossAccountRole string
    ExternalId string
    TimeoutMinutes double
    RegionAndRoutingControls map[string]interface{}
    CrossAccountRole string
    ExternalId string
    TimeoutMinutes float64

    PlanAsg

    Arn string
    CrossAccountRole string
    ExternalId string
    Arn string
    CrossAccountRole string
    ExternalId string
    arn String
    crossAccountRole String
    externalId String
    arn string
    crossAccountRole string
    externalId string
    arn String
    crossAccountRole String
    externalId String

    PlanAssociatedAlarm

    AlarmType Pulumi.AwsNative.ArcRegionSwitch.PlanAlarmType
    The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.
    ResourceIdentifier string
    The resource identifier for alarms that you associate with a plan.
    CrossAccountRole string
    The cross account role for the configuration.
    ExternalId string
    The external ID (secret key) for the configuration.
    AlarmType PlanAlarmType
    The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.
    ResourceIdentifier string
    The resource identifier for alarms that you associate with a plan.
    CrossAccountRole string
    The cross account role for the configuration.
    ExternalId string
    The external ID (secret key) for the configuration.
    alarmType PlanAlarmType
    The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.
    resourceIdentifier String
    The resource identifier for alarms that you associate with a plan.
    crossAccountRole String
    The cross account role for the configuration.
    externalId String
    The external ID (secret key) for the configuration.
    alarmType PlanAlarmType
    The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.
    resourceIdentifier string
    The resource identifier for alarms that you associate with a plan.
    crossAccountRole string
    The cross account role for the configuration.
    externalId string
    The external ID (secret key) for the configuration.
    alarm_type PlanAlarmType
    The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.
    resource_identifier str
    The resource identifier for alarms that you associate with a plan.
    cross_account_role str
    The cross account role for the configuration.
    external_id str
    The external ID (secret key) for the configuration.
    alarmType "applicationHealth" | "trigger"
    The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.
    resourceIdentifier String
    The resource identifier for alarms that you associate with a plan.
    crossAccountRole String
    The cross account role for the configuration.
    externalId String
    The external ID (secret key) for the configuration.

    PlanCustomActionLambdaConfiguration

    PlanEc2AsgCapacityIncreaseConfiguration

    PlanEc2Ungraceful

    PlanEcsCapacityIncreaseConfiguration

    PlanEcsUngraceful

    PlanEksCluster

    PlanEksResourceScalingConfiguration

    PlanEksResourceScalingUngraceful

    PlanExecutionApprovalConfiguration

    PlanExecutionBlockConfiguration0Properties

    PlanExecutionBlockConfiguration1Properties

    PlanExecutionBlockConfiguration2Properties

    PlanExecutionBlockConfiguration3Properties

    PlanExecutionBlockConfiguration4Properties

    PlanExecutionBlockConfiguration5Properties

    PlanExecutionBlockConfiguration6Properties

    PlanExecutionBlockConfiguration7Properties

    PlanExecutionBlockConfiguration8Properties

    PlanExecutionBlockConfiguration9Properties

    PlanExecutionBlockType

    PlanGlobalAuroraConfiguration

    PlanGlobalAuroraUngraceful

    PlanGlobalAuroraUngracefulBehavior

    PlanHealthCheckState

    HealthCheckId string
    Region string
    HealthCheckId string
    Region string
    healthCheckId String
    region String
    healthCheckId string
    region string
    healthCheckId String
    region String

    PlanKubernetesResourceType

    ApiVersion string
    Kind string
    ApiVersion string
    Kind string
    apiVersion String
    kind String
    apiVersion string
    kind string
    apiVersion String
    kind String

    PlanLambdaUngraceful

    Behavior object
    Behavior interface{}
    behavior Object

    PlanLambdas

    Arn string
    CrossAccountRole string
    ExternalId string
    Arn string
    CrossAccountRole string
    ExternalId string
    arn String
    crossAccountRole String
    externalId String
    arn string
    crossAccountRole string
    externalId string
    arn String
    crossAccountRole String
    externalId String

    PlanParallelExecutionBlockConfiguration

    PlanRegionSwitchPlanConfiguration

    Arn string
    CrossAccountRole string
    ExternalId string
    Arn string
    CrossAccountRole string
    ExternalId string
    arn String
    crossAccountRole String
    externalId String
    arn string
    crossAccountRole string
    externalId string
    arn String
    crossAccountRole String
    externalId String

    PlanRegionToRunIn

    PlanRoute53HealthCheckConfiguration

    PlanRoute53ResourceRecordSet

    PlanService

    PlanStep

    ExecutionBlockConfiguration Pulumi.AwsNative.ArcRegionSwitch.Inputs.PlanExecutionBlockConfiguration0Properties | Pulumi.AwsNative.ArcRegionSwitch.Inputs.PlanExecutionBlockConfiguration1Properties | Pulumi.AwsNative.ArcRegionSwitch.Inputs.PlanExecutionBlockConfiguration2Properties | Pulumi.AwsNative.ArcRegionSwitch.Inputs.PlanExecutionBlockConfiguration3Properties | Pulumi.AwsNative.ArcRegionSwitch.Inputs.PlanExecutionBlockConfiguration4Properties | Pulumi.AwsNative.ArcRegionSwitch.Inputs.PlanExecutionBlockConfiguration5Properties | Pulumi.AwsNative.ArcRegionSwitch.Inputs.PlanExecutionBlockConfiguration6Properties | Pulumi.AwsNative.ArcRegionSwitch.Inputs.PlanExecutionBlockConfiguration7Properties | Pulumi.AwsNative.ArcRegionSwitch.Inputs.PlanExecutionBlockConfiguration8Properties | Pulumi.AwsNative.ArcRegionSwitch.Inputs.PlanExecutionBlockConfiguration9Properties
    The configuration for an execution block in a workflow.
    ExecutionBlockType Pulumi.AwsNative.ArcRegionSwitch.PlanExecutionBlockType
    The type of an execution block in a workflow.
    Name string
    The name of a step in a workflow.
    Description string
    The description of a step in a workflow.

    PlanTrigger

    Action Pulumi.AwsNative.ArcRegionSwitch.PlanWorkflowTargetAction
    The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.
    Conditions List<Pulumi.AwsNative.ArcRegionSwitch.Inputs.PlanTriggerCondition>
    The conditions that must be met for the trigger to fire.
    MinDelayMinutesBetweenExecutions double
    The minimum time, in minutes, that must elapse between automatic executions of the plan.
    TargetRegion string
    The AWS Region for a trigger.
    Description string
    The description for a trigger.
    Action PlanWorkflowTargetAction
    The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.
    Conditions []PlanTriggerCondition
    The conditions that must be met for the trigger to fire.
    MinDelayMinutesBetweenExecutions float64
    The minimum time, in minutes, that must elapse between automatic executions of the plan.
    TargetRegion string
    The AWS Region for a trigger.
    Description string
    The description for a trigger.
    action PlanWorkflowTargetAction
    The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.
    conditions List<PlanTriggerCondition>
    The conditions that must be met for the trigger to fire.
    minDelayMinutesBetweenExecutions Double
    The minimum time, in minutes, that must elapse between automatic executions of the plan.
    targetRegion String
    The AWS Region for a trigger.
    description String
    The description for a trigger.
    action PlanWorkflowTargetAction
    The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.
    conditions PlanTriggerCondition[]
    The conditions that must be met for the trigger to fire.
    minDelayMinutesBetweenExecutions number
    The minimum time, in minutes, that must elapse between automatic executions of the plan.
    targetRegion string
    The AWS Region for a trigger.
    description string
    The description for a trigger.
    action PlanWorkflowTargetAction
    The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.
    conditions Sequence[PlanTriggerCondition]
    The conditions that must be met for the trigger to fire.
    min_delay_minutes_between_executions float
    The minimum time, in minutes, that must elapse between automatic executions of the plan.
    target_region str
    The AWS Region for a trigger.
    description str
    The description for a trigger.
    action "activate" | "deactivate"
    The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.
    conditions List<Property Map>
    The conditions that must be met for the trigger to fire.
    minDelayMinutesBetweenExecutions Number
    The minimum time, in minutes, that must elapse between automatic executions of the plan.
    targetRegion String
    The AWS Region for a trigger.
    description String
    The description for a trigger.

    PlanTriggerCondition

    AssociatedAlarmName string
    The name of the CloudWatch alarm associated with the condition.
    Condition Pulumi.AwsNative.ArcRegionSwitch.PlanAlarmCondition
    The condition that must be met. Valid values include ALARM and OK.
    AssociatedAlarmName string
    The name of the CloudWatch alarm associated with the condition.
    Condition PlanAlarmCondition
    The condition that must be met. Valid values include ALARM and OK.
    associatedAlarmName String
    The name of the CloudWatch alarm associated with the condition.
    condition PlanAlarmCondition
    The condition that must be met. Valid values include ALARM and OK.
    associatedAlarmName string
    The name of the CloudWatch alarm associated with the condition.
    condition PlanAlarmCondition
    The condition that must be met. Valid values include ALARM and OK.
    associated_alarm_name str
    The name of the CloudWatch alarm associated with the condition.
    condition PlanAlarmCondition
    The condition that must be met. Valid values include ALARM and OK.
    associatedAlarmName String
    The name of the CloudWatch alarm associated with the condition.
    condition "red" | "green"
    The condition that must be met. Valid values include ALARM and OK.

    PlanWorkflow

    WorkflowTargetAction Pulumi.AwsNative.ArcRegionSwitch.PlanWorkflowTargetAction
    The action that the workflow performs. Valid values include ACTIVATE and DEACTIVATE.
    Steps List<Pulumi.AwsNative.ArcRegionSwitch.Inputs.PlanStep>
    The steps that make up the workflow.
    WorkflowDescription string
    The description of the workflow.
    WorkflowTargetRegion string
    The AWS Region that the workflow targets.
    WorkflowTargetAction PlanWorkflowTargetAction
    The action that the workflow performs. Valid values include ACTIVATE and DEACTIVATE.
    Steps []PlanStep
    The steps that make up the workflow.
    WorkflowDescription string
    The description of the workflow.
    WorkflowTargetRegion string
    The AWS Region that the workflow targets.
    workflowTargetAction PlanWorkflowTargetAction
    The action that the workflow performs. Valid values include ACTIVATE and DEACTIVATE.
    steps List<PlanStep>
    The steps that make up the workflow.
    workflowDescription String
    The description of the workflow.
    workflowTargetRegion String
    The AWS Region that the workflow targets.
    workflowTargetAction PlanWorkflowTargetAction
    The action that the workflow performs. Valid values include ACTIVATE and DEACTIVATE.
    steps PlanStep[]
    The steps that make up the workflow.
    workflowDescription string
    The description of the workflow.
    workflowTargetRegion string
    The AWS Region that the workflow targets.
    workflow_target_action PlanWorkflowTargetAction
    The action that the workflow performs. Valid values include ACTIVATE and DEACTIVATE.
    steps Sequence[PlanStep]
    The steps that make up the workflow.
    workflow_description str
    The description of the workflow.
    workflow_target_region str
    The AWS Region that the workflow targets.
    workflowTargetAction "activate" | "deactivate"
    The action that the workflow performs. Valid values include ACTIVATE and DEACTIVATE.
    steps List<Property Map>
    The steps that make up the workflow.
    workflowDescription String
    The description of the workflow.
    workflowTargetRegion String
    The AWS Region that the workflow targets.

    PlanWorkflowTargetAction

    Route53HealthChecksProperties

    HealthCheckIds List<string>
    HostedZoneIds List<string>
    RecordNames List<string>
    Regions List<string>
    HealthCheckIds []string
    HostedZoneIds []string
    RecordNames []string
    Regions []string
    healthCheckIds List<String>
    hostedZoneIds List<String>
    recordNames List<String>
    regions List<String>
    healthCheckIds string[]
    hostedZoneIds string[]
    recordNames string[]
    regions string[]
    health_check_ids Sequence[str]
    hosted_zone_ids Sequence[str]
    record_names Sequence[str]
    regions Sequence[str]
    healthCheckIds List<String>
    hostedZoneIds List<String>
    recordNames List<String>
    regions List<String>

    Package Details

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

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.32.0 published on Wednesday, Aug 13, 2025 by Pulumi
    pulumi/pulumi-aws-native